Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soartec-lab/active-es
gem for abstract use of Elasticsearch
https://github.com/soartec-lab/active-es
ruby rubygems rubyonrails
Last synced: 2 days ago
JSON representation
gem for abstract use of Elasticsearch
- Host: GitHub
- URL: https://github.com/soartec-lab/active-es
- Owner: soartec-lab
- License: mit
- Created: 2019-01-05T15:53:26.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-13T14:21:18.000Z (almost 6 years ago)
- Last Synced: 2024-12-18T19:48:43.945Z (6 days ago)
- Topics: ruby, rubygems, rubyonrails
- Language: Ruby
- Size: 70.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ActiveEs
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/active_es`. To experiment with that code, run `bin/console` for an interactive prompt.
TODO: Delete this and the text above, and describe your gem
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'active-es'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install active-es
## Usage
### STEP1
#### Setting Config
Create config/searchengine.yml
See: spec/dummy/config/searchengine.yml
### STEP2
#### Inherit `ActiveEs::Base`
```
class Content < ActiveEs::Base
end
```
### STEP3
#### Define the property of model.
format is `property :field_name, type: 'detatype', options... `
To check the specifiable detatype, execute the following command on rails console.
```
$ bundle exec rails console
$ > ActiveEs::Schema::Definition::FieldDetaTypes
```
FYI: spec/dummy/app/models/content.rb
```
class Content < ActiveEs::Base
property :title, type: 'text', analyzer: 'kuromoji'
property :description, type: 'text', analyzer: "kuromoji"
property :number, type: 'integer'
property :rank, type: 'integer'
end
```
## dummy app
```
$ bundle exec rails runner spec/dummy/db/seeds.rb
$ bundle exec rails console
$ => Content.all
$ => [#,
#,
#,
#,
#,
#]
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
# FYI
https://github.com/elastic/elasticsearch-ruby
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_es. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the ActiveEs project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/active_es/blob/master/CODE_OF_CONDUCT.md).