elastics 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4414829781480b6aaf6c1fa14bf0450a0e164906
-  data.tar.gz: c63d19ed109fae4244b4c9427814c4ffa1f10de6
+  metadata.gz: 4aec32b4215bd40d80c3d367f2166a0b91a278b9
+  data.tar.gz: ccae5ce2bf5904bd2605f152f4b02e1556449035
 SHA512:
-  metadata.gz: 43f6b27708081b51906e6768edb32cd54243974582c0beae93a2030f3b605d62e8f5c4a245c9b5dc8fa6a7de0e0590756404bfb748961ad66e513dc99bcb7bda
-  data.tar.gz: c02fc34b15851945a8b5da43e93326062c903383dca4a7a8e21134c8d199f92a1918bebcb2f71e32f9c08046c3e8520e97765c5045b3d52682788be9dd97c321
+  metadata.gz: 4327171fbed3358386552e0a516b55e10c13aa47efea873e80fdc122a409862a73564a744ec49e2f7889c5be6e71e4c1d8a937aba1a48e2b915d0fe5f07cedba
+  data.tar.gz: cf810f168e30abb9167ff719c653f9e604764eb845734a0c16fa15146db3e4c558d6206258d83d394c2fe999297c7a029c0d2515a5de0c5a7e3338141510634c

data/README.md

@@ -101,8 +101,15 @@ end
 User.elastics # Elastics::Client instance
 User.elastics_params # hash with index & type values for the model
 User.request_elastics(params) # performs request merging params with elastics_params
-User.search_elastics(data)
+
+search = User.search_elastics(data)
 # Returns Elastics::ActiveRecord::SearchResult object with some useful methods
+search.relation # User.where(id: found_ids)
+search.collection # Array of users sorted as in elastics response
+
+# Set scope applied to relation:
+search = Project.search_elastics(data, scope: ->(s) { s.includes(:user) })
+search.collection.first.user # eagger-loaded
 
 # Indexing on create/update can be skipped with skip_elastics
 User.skip_elastics { users.each { |x| x.update_attributes(smth: 'not indexed') } }
@@ -136,6 +143,8 @@ production:
     index_prefix: app_
 ```
 
+YAML is passed througn ERB before parsing.
+
 #### Create mappings & import data
 ```
 $ rake elastics:migrate elastics:reindex

data/elastics.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'httpclient', '~> 2.4.0'
+  spec.add_runtime_dependency 'httpclient', '~> 2.4'
 
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/elastics.rb

@@ -8,9 +8,11 @@ module Elastics
   autoload :Instrumentation,  'elastics/instrumentation'
   autoload :Model,            'elastics/model'
   autoload :QueryHelper,      'elastics/query_helper'
+  autoload :SearchQuery,      'elastics/search_query'
   autoload :Result,           'elastics/result'
   autoload :Tasks,            'elastics/tasks'
   autoload :VersionManager,   'elastics/version_manager'
+  autoload :RSpec,            'elastics/rspec'
 end
 
 require 'elastics/railtie' if defined?(Rails)

data/lib/elastics/active_record.rb

@@ -38,7 +38,10 @@ module Elastics
     private
       def install_elastics_hooks(hooks)
         if hooks.include?(:update)
-          after_commit :index_elastics, on: [:create, :update], unless: :skip_elastics?
+          after_commit :index_elastics,
+            on:     [:create, :update],
+            unless: :skip_elastics?,
+            if:     -> { previous_changes.any? }
         end
         if hooks.include?(:destroy)
           after_commit :delete_elastics, on: [:destroy], unless: :skip_elastics?

data/lib/elastics/active_record/helper_methods.rb

@@ -21,8 +21,10 @@ module Elastics
 
         # Finds items by ids and returns array in the order in which ids were given.
         # Every missing record is replaced with `nil` in the result.
-        def find_all_ordered(ids)
-          items_by_id = where(id: ids).index_by(&:id)
+        # If `conditions_present` is `true` it doesn't add where clause.
+        def find_all_ordered(ids, conditions_present = false)
+          relation = conditions_present ? where(id: ids) : self
+          items_by_id = relation.index_by(&:id)
           ids.map { |i| items_by_id[i] }
         end
 

data/lib/elastics/active_record/search_result.rb

@@ -1,8 +1,12 @@
 module Elastics
   module ActiveRecord
     class SearchResult < Result::Search
+      # It expects `:model` option with a model-class.
+      # Optionally pass `scope` option with a lambda which takes and modifies
+      # relation.
       def initialize(response, options = {})
         @model = options[:model]
+        @scope = options[:scope]
         super response, options
       end
 
@@ -12,11 +16,14 @@ module Elastics
       end
 
       def collection
-        @collection ||= @model.find_all_ordered ids_to_find
+        @collection ||= relation.find_all_ordered(ids_to_find, true)
       end
 
       def relation
-        @model.where(id: ids_to_find)
+        @relation ||= begin
+          result = @model.where(id: ids_to_find)
+          @scope ? @scope.call(result) : result
+        end
       end
     end
   end

data/lib/elastics/client.rb

@@ -26,11 +26,11 @@ module Elastics
     end
 
     def debug!(dev = STDOUT)
-      @client.debug_dev = dev
+      client.debug_dev = dev
     end
 
     def debug_off!
-      @client.debug_dev = nil
+      client.debug_dev = nil
     end
 
     def set_index(index, type = nil)

data/lib/elastics/model/schema.rb

@@ -13,11 +13,12 @@ module Elastics
       end
 
       def reset_elastics_index_name
-        @elastics_index_name = if superclass.respond_to?(:elastics_index_name)
-          superclass.elastics_index_name
-        else
-          compute_elastics_index_name
-        end
+        @elastics_index_name =
+          if respond_to?(:superclass) && superclass.respond_to?(:elastics_index_name)
+            superclass.elastics_index_name
+          else
+            compute_elastics_index_name
+          end
       end
 
       def compute_elastics_index_name

data/lib/elastics/query_helper.rb

@@ -24,7 +24,7 @@ module Elastics
     # for specified field.
     def terms_query(field, val, options = {})
       if val.is_a?(Array)
-        {terms: {field => val}.merge(options)}
+        {terms: {field => val}.merge!(options)}
       else
         {term: {field => val}}
       end

data/lib/elastics/rspec.rb

@@ -0,0 +1,38 @@
+module Elastics
+  module RSpec
+    module_function
+
+    # Adds around filter to perform elastics specific helper actions.
+    #
+    #     - Enables autorefresh for each example,
+    #     - Executes `clear_elastics` before each example,
+    #     - Performs migration (once, for first occured example).
+    #
+    # Filter is applied only to tagged examples (`:elastics` by default).
+    #
+    #     RSpec.configure do |config|
+    #       Elastics::RSpec.configure(config)
+    #     end
+    def configure(config, tag = :elastics)
+      migrated = false
+      error = nil
+      config.around tag => true do |ex|
+        if migrated
+          raise error if error
+          Model.list.each(&:clear_elastics)
+        else
+          begin
+            Tasks.drop_indices
+            Tasks.migrate
+          rescue Error => e
+            error = e
+            raise e
+          ensure
+            migrated = true
+          end
+        end
+        AutoRefresh.enable! { ex.run }
+      end
+    end
+  end
+end

data/lib/elastics/search_query.rb

@@ -0,0 +1,99 @@
+module Elastics
+  # Helpers to build search query.
+  #
+  #     class Query
+  #       include Elastics::SearchQuery
+  #
+  #       # implement any of:
+  #       #   query, phrase_query, query_filters, post_filter, aggregations
+  #
+  #       def phrase_query
+  #         {bool: {should: [
+  #           {multi_match: {
+  #             # ...
+  #           }}
+  #         ]}}
+  #         # or just
+  #         {math: {message: params[:query_string]}}
+  #       end
+  #
+  #       def query_filters
+  #         [
+  #           {term: {published: true}},
+  #           terms_array_query(:tag, params[:tags], execution: :and),
+  #           some_complex_filter,
+  #         ]
+  #       end
+  #
+  #       def aggregations
+  #         {
+  #           tag: {terms: {
+  #             field:      :tag,
+  #             size:       10,
+  #             shard_size: 10,
+  #           }},
+  #         }
+  #       end
+  #     end
+  #
+  #     result = Model.search_elastics Query.new(params).as_json
+  module SearchQuery
+    include Elastics::QueryHelper
+
+    attr_reader :params
+
+    def initialize(params)
+      @params = params
+    end
+
+    def as_json
+      page = params[:page] || 1
+      per_page = params[:per_page] || 10
+      result = {
+        from:         (page - 1) * per_page,
+        size:         per_page,
+        fields:       [],
+        query:        query,
+        sort:         sort,
+      }
+      post_filter = self.post_filter
+      result[:post_filter] = post_filter if post_filter
+      aggregations = self.aggregations
+      result[:aggregations] = aggregations if aggregations
+      result
+    end
+
+    # Builds query from phrase_query & query_filters.
+    def query
+      normalize_query(phrase_query, query_filters.compact)
+    end
+
+    def phrase_query
+    end
+
+    def query_filters
+      []
+    end
+
+    def post_filter
+    end
+
+    def aggregations
+    end
+
+    # Takes `params[:sort]` and returns it compatible with elastics.
+    # Wraps scalars into array, hashes are converted into arrays,
+    # array are passed as is.
+    #
+    #     {name: :asc, _score: :desc} => [{name: :asc}, {_score: :desc}]
+    #     :created_at => [:created_at]
+    def sort
+      val = params[:sort]
+      case val
+      when Hash   then val.map { |x| Hash[[x]] }
+      when Array  then val
+      else val ? [val] : []
+      end
+    end
+  end
+end

data/lib/elastics/tasks.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+require 'erb'
 require 'active_support'
 require 'active_support/core_ext'
 
@@ -23,7 +25,21 @@ module Elastics
     extend self
 
     def log(*args)
-      puts(*args)
+      puts(*args) if verbose
+      Rails.logger.info { "Elastics: #{args.join ' '}" } if defined?(Rails)
+    end
+
+    attr_accessor :verbose
+
+    def suppress_messages
+      verbose_was, self.verbose = verbose, false
+      yield
+    ensure
+      self.verbose = verbose_was
+    end
+
+    def load_yaml(file)
+      YAML.load(ERB.new(File.read(file)).result)
     end
 
     private

data/lib/elastics/tasks/indices.rb

@@ -11,12 +11,54 @@ module Elastics
         @indices_paths ||= base_paths.map { |x| File.join x, 'indices' }
       end
 
+      # Merges settings from single files and dirs.
       def indices_settings
-        @indices_settings ||= indices_paths.map { |path| Dir["#{path}/*.yml"] }.
+        @indices_settings ||= indices_from_files.merge!(indices_from_dirs)
+      end
+
+      # Reads indices settings from single yml file.
+      # Setting can be given specific for env or one for all envs.
+      #
+      #     tweet:
+      #       development:
+      #         settings:
+      #           number_of_shards: 5
+      #       production:
+      #         settings:
+      #           number_of_shards: 10
+      #
+      #     user:
+      #       settings:
+      #         number_of_shards: 5
+      def indices_from_files
+        indices_paths.each_with_object({}) do |path, hash|
+          file = "#{path}.yml"
+          next unless File.exists?(file)
+          load_yaml(file).each do |name, data|
+            hash[name] = data[Rails.env] || data
+          end
+        end
+      end
+
+      # Reads indices settings from separate files. Index name is taken from
+      # file name, setting can be given specific for env or one for all envs.
+      #
+      #     development:
+      #       settings:
+      #         number_of_shards: 5
+      #     production:
+      #       settings:
+      #         number_of_shards: 10
+      #
+      #     # or
+      #     settings:
+      #       number_of_shards: 1
+      def indices_from_dirs
+        indices_paths.map { |path| Dir["#{path}/*.yml"] }.
           flatten.sort.
           each_with_object({}) do |file, hash|
             name = File.basename file, '.yml'
-            data = YAML.load_file(file)
+            data = load_yaml(file)
             hash[name] = data[Rails.env] || data
           end
       end
@@ -76,10 +118,14 @@ module Elastics
         new_versions = {}
         post_aliases options do |index|
           new_versions[index] = version_manager.next_version index
-          [
-            alias_action(:remove, index, :current),
-            alias_action(:add, index, :next),
-          ]
+          if client.index_exists?(versioned_index_name(index, :current))
+            [
+              alias_action(:remove, index, :current),
+              alias_action(:add, index, :next),
+            ]
+          else
+            alias_action(:add, index, :next)
+          end
         end
         drop_indices(options.merge version: :current) if options.fetch(:drop, true)
         new_versions.each do |index, version|

data/lib/elastics/tasks/mappings.rb

@@ -21,12 +21,43 @@ module Elastics
         end
       end
 
+      # Merges mappings from single files and dirs.
       def mappings
-        @mappings ||= mappings_paths.map { |path| Dir["#{path}/*.yml"] }.
+        @mappings ||= mappings_from_files.merge!(mappings_from_dirs)
+      end
+
+      # Reads mappings from single yml file.
+      #
+      #  user:
+      #    dynamic: false
+      #    properties:
+      #      name: string
+      #  tweet:
+      #    properties:
+      #      content: string
+      #      user_id: integer
+      def mappings_from_files
+        mappings_paths.each_with_object({}) do |path, hash|
+          file = "#{path}.yml"
+          next unless File.exists?(file)
+          load_yaml(file).each do |name, data|
+            hash[name] = fix_mapping(name, data)
+          end
+        end
+      end
+
+      # Reads mappings from separate files. Type name is taken from file name.
+      #
+      #  # user.yml
+      #  dynamic: false
+      #  properties:
+      #    name: string
+      def mappings_from_dirs
+        mappings_paths.map { |path| Dir["#{path}/*.yml"] }.
           flatten.sort.
           each_with_object({}) do |file, hash|
             name = File.basename file, '.yml'
-            hash[name] = fix_mapping(name, YAML.load_file(file))
+            hash[name] = fix_mapping(name, load_yaml(file))
           end
       end
 

data/lib/elastics/version.rb

@@ -1,5 +1,5 @@
 module Elastics
-  VERSION = '0.5.0'
+  VERSION = '0.6.1'.freeze
 
   def self.gem_version
     Gem::Version.new VERSION

data/lib/tasks/elastics.rake

@@ -10,6 +10,7 @@ namespace 'elastics' do
       types:    ENV['types'] && ENV['types'].split(',').map(&:strip),
       indices:  args.extras.empty? ? nil : args.extras
     }
+    Elastics::Tasks.verbose = ENV.fetch('VERBOSE', 'true') == 'true'
   end
 
   desc 'Drop administrative index'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastics
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Max Melentiev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-14 00:00:00.000000000 Z
+date: 2017-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +131,8 @@ files:
 - lib/elastics/railtie.rb
 - lib/elastics/result.rb
 - lib/elastics/result/search.rb
+- lib/elastics/rspec.rb
+- lib/elastics/search_query.rb
 - lib/elastics/tasks.rb
 - lib/elastics/tasks/config.rb
 - lib/elastics/tasks/indices.rb
@@ -166,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: ElasticSearch client with ActiveRecord integration
@@ -178,4 +180,3 @@ test_files:
 - spec/lib/elastics/instrumentation_spec.rb
 - spec/lib/elastics/model/schema_spec.rb
 - spec/spec_helper.rb
-has_rdoc: