elastic-rails 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ccf947047bcebb5042dddebb851e017da2f9a5b
-  data.tar.gz: 459d2dd8391984dc5824cd1e7b5465c5d950b615
+  metadata.gz: a12b5aa58fd03c89b2da12c996b19994bb3a3c1a
+  data.tar.gz: d1e4d3dee93fd0d9fd92c700b4367b415225a142
 SHA512:
-  metadata.gz: 9faed007e581dfb072a6f39c789e04911c026e2bcaa77bf3024e57407f6100eed2d9302bf46171cd5bb17d09b6a9d8ab87b224fec7ca77dab5bbc4d30b8d1ea5
-  data.tar.gz: 9bcd9d07542c303efa0df810924f5629a43ba217326a2fd4600d0a0eb88bf07f3328d3f9cd097093662f99dc54324e354c7c0aa4c828a0d2ec69b1a80e49990b
+  metadata.gz: cf802900bc06db2cf8c4457c2839580d255c61fbefe4a616e8323699708ee20231be44220eb5149996501b88d5d0675cbecfccae050f8293e68821a0c5258b60
+  data.tar.gz: 3879b379633548e1d7d7d18b1500dd5e8e73feaf31858c892e056a1c38a03aaabcb150c37bba2534df28795f03044d2a987086040228c5f9890369ccb9f96607

data/README.md

@@ -1,8 +1,15 @@
-# Elastic
+# Elastic Rails
 
-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/elastic`. To experiment with that code, run `bin/console` for an interactive prompt.
+Elasticsearch + Ruby on Rails made easy.
 
-TODO: Delete this and the text above, and describe your gem
+## Features
+
+* Easy setup
+* Chainable query DSL
+* Easy to use results
+* Seamless rails integration
+* Multiple enviroment support
+* Zero downtime index migrations
 
 ## Installation
 
@@ -20,25 +27,45 @@ Or install it yourself as:
 
     $ gem install elastic-rails
 
-Finally execute the initialization script:
+Finally execute the initialization script to generate configuration files:
 
     $ rails g es:init
 
-## Usage
+## Usage overview
+
+[For detailed usage reference check out the GUIDE]
 
-Start by creating an index over a model (You can also index non-activerecord objects)
+Suppose that you already have a model called `Bike`, start by creating an index for it:
 
     rails g es:index Bike
 
-This will generate a new index definition file in `app/indices`
+This will generate a new index definition file in `app/indices/bike_index.rb`
 
-Add some fields to the index
+Add some fields to the index:
 
-TODO
+```ruby
+class BikeIndex < ElasticType
+  # field types are extracted from the target model
+  fields :brand_id, :model, :year, :price
+
+  # you can also explicitly set the field type
+  field :category, type: :term
+  field :description, type: :string
+  field :created_at, type: :time
+
+  # you can also have nested documents, the following will require a nested PartIndex to be defined.
+  nested :parts
+
+  # you can override fields or create new ones
+  def year
+    object.batch.year
+  end
+end
+```
 
 Every time you create or change and index you will neeed to synchronize the Elasticsearch index mappings:
 
-     rake es:migrate
+     rake es:remap
 
 If you already have some data that needs to be indexed then run the reindex task:
 
@@ -52,35 +79,63 @@ some_bike.index_later # this will queue a reindexing job on the record
 BikeIndex.import([bike_1, bike_2, bike_3]) # this will perform a bulk insertion
 ```
 
-After some data has been added you can start searching:
+You can also setup automatic indexation/unindexation for a given model:
 
 ```ruby
-BikeIndex.must(brand: 'Trek', size: 'M').should(year: { gte: 2015 }).avg(:price)
-
-BikeIndex.must(origin: 'China').segment(:brand).each { |brand, bikes|   }
+class Bike < ActiveRecord::Base
+  index on: :save
+end
 ```
 
-migrate: remaps if necessary
-
-reindex: attempts to rotate if index already exist
-
-TODO: Write usage instructions here
-
-## Missing Features
-
-These are some features that will be added in the future:
+After some data has been added you can start quering:
 
+```ruby
+# List bikes of brand Trek or Cannondale, preferably 2015 or later models:
+BikeIndex
+  .must(brand: ['Trek', 'Cannondale'])
+  .should(year: { gte: 2015 })
+  .to_a
+
+# List bikes of brand Trek, preferably 2015 or 2016, give higher score to 2016 models:
+BikeIndex
+  .must(brand: ['Trek', 'Cannondale'])
+  .should(year: 2015)
+  .boost(2.0) { should(year: 2016) }
+  .to_a
+
+# More score manipulation:
+BikeIndex
+  .coord_similarity(false) # disable coord similarity (no score normalization)
+  .boost(0.0) { must(brand: ['Trek', 'Cannondale']) } # no score
+  .boost(fixed: 1.0) { should(year: 2015) } # fixed score
+  .boost(fixed: 2.0) { should(year: 2016) }
+  .each_with_score { |bike, score| puts "#{bike.name} got score: #{score}" }
+
+# Get average bike price by year and category, for bikes newer than 2014
+BikeIndex
+  .must(year: { gte: 2014 })
+  .segment(:year)
+  .segment(:category)
+  .average(:price)
+  .each { |keys, price| puts "#{keys[:year]}/#{keys[:category]} => #{price}" }
+
+# Search bikes ids that have shimano parts:
+BikeIndex.must(parts: { brand: 'shimano' }).ids
+```
 
-## Development
+## Missing features
 
-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.
+The following are some features that we plan to implement in the future:
 
-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).
+* Highlighting support
+* Suggesters support
+* Geo fields and queries support
+* Custom analizers support
+* More queries types support (multi-match, common-terms, wildcard, fuzzy, etc)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/elastic. 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.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/platanus/elastic-rails. 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
 

data/lib/elastic/configuration.rb

@@ -9,11 +9,12 @@ module Elastic
       whiny_indices: false,
       api_client: nil, # set by method
       logger: nil, # set by method
-      time_zone: nil # set by method
+      time_zone: nil, # set by method
+      disable_indexing: false
     }
 
     attr_accessor :host, :port, :api_client, :index, :page_size, :coord_similarity, :logger,
-      :import_batch_size, :whiny_indices, :time_zone
+      :import_batch_size, :whiny_indices, :time_zone, :disable_indexing
 
     def initialize
       assign_attributes DEFAULTS

data/lib/elastic/core/connector.rb

@@ -12,6 +12,8 @@ module Elastic::Core
     end
 
     def status
+      return :ready if Elastic.config.disable_indexing
+
       actual_name = resolve_actual_index_name
       return :not_available if actual_name.nil?
       return :not_synchronized unless mapping_synchronized? actual_name
@@ -49,6 +51,8 @@ module Elastic::Core
     end
 
     def index(_document)
+      return if Elastic.config.disable_indexing
+
       # TODO: validate document type
       operations = write_indices.map do |write_index|
         { 'index' => _document.merge('_index' => write_index) }
@@ -58,6 +62,8 @@ module Elastic::Core
     end
 
     def bulk_index(_documents)
+      return if Elastic.config.disable_indexing
+
       # TODO: validate documents type
       body = _documents.map { |doc| { 'index' => doc } }
 
@@ -72,6 +78,8 @@ module Elastic::Core
       raise ArgumentError, 'document must provide an id' unless _document['_id']
       raise ArgumentError, 'document must provide a type' unless _document['_type']
 
+      return if Elastic.config.disable_indexing
+
       write_index, rolling_index = write_indices
 
       operations = [{ 'delete' => _document.merge('_index' => write_index) }]

data/lib/elastic/railties/rspec.rb

@@ -1,6 +1,11 @@
 RSpec.configure do |config|
-  config.before(:example, elasticsearch: true) do
-    Elastic.drop
-    Elastic.migrate
+  config.before(:example) do |example|
+    if example.metadata[:elasticsearch]
+      Elastic.drop
+      Elastic.migrate
+      Elastic.config.disable_indexing = false
+    else
+      Elastic.config.disable_indexing = true
+    end
   end
 end

data/lib/elastic/version.rb

@@ -1,3 +1,3 @@
 module Elastic
-  VERSION = "0.8.1"
+  VERSION = "0.8.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-rails
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Ignacio Baixas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2016-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch