chewy 0.8.4 → 0.9.0

data/lib/chewy/errors.rb

@@ -12,7 +12,7 @@ module Chewy
   end
 
   class UndefinedUpdateStrategy < Error
-    def initialize type
+    def initialize(_type)
       super <<-MESSAGE
 Index update strategy is undefined in current context.
 Please wrap your code with `Chewy.strategy(:strategy_name) block.`
@@ -24,11 +24,11 @@ Please wrap your code with `Chewy.strategy(:strategy_name) block.`
   end
 
   class ImportFailed < Error
-    def initialize type, errors
+    def initialize(type, import_errors)
       message = "Import failed for `#{type}` with:\n"
-      errors.each do |action, errors|
+      import_errors.each do |action, action_errors|
         message << "    #{action.to_s.humanize} errors:\n"
-        errors.each do |error, documents|
+        action_errors.each do |error, documents|
           message << "      `#{error}`\n"
           message << "        on #{documents.count} documents: #{documents}\n"
         end

data/lib/chewy/fields/base.rb

@@ -5,7 +5,8 @@ module Chewy
       attr_accessor :parent
 
       def initialize(name, options = {})
-        @name, @options = name.to_sym, options.deep_symbolize_keys
+        @name = name.to_sym
+        @options = options.deep_symbolize_keys
         @value = @options.delete(:value)
         @children = []
       end
@@ -15,23 +16,25 @@ module Chewy
       end
 
       def object_field?
-        (children.present? && options[:type].blank?) || ['object', 'nested'].include?(options[:type].to_s)
+        (children.present? && options[:type].blank?) || %w(object nested).include?(options[:type].to_s)
       end
 
       def mappings_hash
-        mapping = children.present? ? {
-          (multi_field? ? :fields : :properties) => children.map(&:mappings_hash).inject(:merge)
-        } : {}
+        mapping = if children.present?
+          { (multi_field? ? :fields : :properties) => children.map(&:mappings_hash).inject(:merge) }
+        else
+          {}
+        end
         mapping.reverse_merge!(options)
         mapping.reverse_merge!(type: (children.present? ? 'object' : 'string'))
-        {name => mapping}
+        { name => mapping }
       end
 
       def compose(object, *parent_objects)
         objects = ([object] + parent_objects.flatten).uniq
 
         result = if value && value.is_a?(Proc)
-          if value.arity == 0
+          if value.arity.zero?
             object.instance_exec(&value)
           elsif value.arity < 0
             value.call(*object)
@@ -39,7 +42,7 @@ module Chewy
             value.call(*objects.first(value.arity))
           end
         elsif object.is_a?(Hash)
-          if object.has_key?(name)
+          if object.key?(name)
             object[name]
           else
             object[name.to_s]
@@ -48,13 +51,15 @@ module Chewy
           object.send(name)
         end
 
-        result = if result.respond_to?(:to_ary)
-          result.to_ary.map { |item| compose_children(item, *objects) }
-        else
-          compose_children(result, *objects)
-        end if children.present? && !multi_field?
+        if children.present? && !multi_field?
+          result = if result.respond_to?(:to_ary)
+            result.to_ary.map { |item| compose_children(item, *objects) }
+          else
+            compose_children(result, *objects)
+          end
+        end
 
-        {name => result.as_json(root: false)}
+        { name => result }
       end
 
     private

data/lib/chewy/fields/root.rb

@@ -12,11 +12,15 @@ module Chewy
         @id = @options.delete(:id) || options.delete(:_id)
         @parent = @options.delete(:parent) || options.delete(:_parent)
         @parent_id = @options.delete(:parent_id)
-        @value ||= ->(_) { _ }
+        @value ||= ->(val) { val }
         @dynamic_templates = []
         @options.delete(:type)
       end
 
+      def compose(*args)
+        super.as_json
+      end
+
       def mappings_hash
         mappings = super
         mappings[name].delete(:type)
@@ -30,11 +34,11 @@ module Chewy
         mappings
       end
 
-      def dynamic_template *args
+      def dynamic_template(*args)
         options = args.extract_options!.deep_symbolize_keys
         if args.first
           template_name = :"template_#{dynamic_templates.count.next}"
-          template = {template_name => {mapping: options}}
+          template = { template_name => { mapping: options } }
 
           template[template_name][:match_mapping_type] = args.second.to_s if args.second.present?
 
@@ -52,15 +56,13 @@ module Chewy
       end
 
       def compose_parent(object)
-        if parent_id
-          parent_id.arity == 0 ? object.instance_exec(&parent_id) : parent_id.call(object)
-        end
+        return unless parent_id
+        parent_id.arity.zero? ? object.instance_exec(&parent_id) : parent_id.call(object)
       end
 
       def compose_id(object)
-        if id
-          id.arity == 0 ? object.instance_exec(&id) : id.call(object)
-        end
+        return unless id
+        id.arity.zero? ? object.instance_exec(&id) : id.call(object)
       end
     end
   end

data/lib/chewy/index.rb

@@ -29,21 +29,25 @@ module Chewy
     #   UsersIndex.index_name # => 'dudes'
     #
     def self.index_name(suggest = nil)
+      raise UndefinedIndex unless _index_name(suggest)
+      @index_name ||= build_index_name(_index_name, prefix: default_prefix)
+    end
+
+    def self._index_name(suggest = nil)
       if suggest
-        @index_name = build_index_name(suggest, prefix: default_prefix)
-      else
-        @index_name ||= begin
-          build_index_name(
-            name.sub(/Index\Z/, '').demodulize.underscore,
-            prefix: default_prefix
-          ) if name
-        end
+        @_index_name = suggest
+      elsif name
+        @_index_name ||= name.sub(/Index\Z/, '').demodulize.underscore
       end
-      @index_name or raise UndefinedIndex
+      @_index_name
     end
 
-    # Prefix to use
-    #
+    def self.derivable_index_name
+      @_derivable_index_name ||= name.sub(/Index\Z/, '').underscore
+    end
+
+    # Setups or returns pure Elasticsearch index name
+    # without any prefixes/suffixes
     def self.default_prefix
       Chewy.configuration[:prefix]
     end
@@ -86,14 +90,13 @@ module Chewy
       type_class = Chewy.create_type(self, target, options, &block)
       self.type_hash = type_hash.merge(type_class.type_name => type_class)
 
-      unless respond_to?(type_class.type_name)
-        class_eval <<-METHOD, __FILE__, __LINE__ + 1
-          def self.#{type_class.type_name}
-            ActiveSupport::Deprecation.warn("`#{self}.#{type_class.type_name}` accessor is deprecated and will be removed soon. Use `#{type_class}` directly instead.")
-            type_hash['#{type_class.type_name}']
-          end
-        METHOD
-      end
+      return if respond_to?(type_class.type_name)
+      class_eval <<-METHOD, __FILE__, __LINE__ + 1
+        def self.#{type_class.type_name}
+          ActiveSupport::Deprecation.warn("`#{self}.#{type_class.type_name}` accessor is deprecated and will be removed soon. Use `#{type_class}` directly instead.")
+          type_hash['#{type_class.type_name}']
+        end
+      METHOD
     end
 
     # Types method has double usage.
@@ -107,9 +110,9 @@ module Chewy
     #   UsersIndex.filters { name =~ 'ro' }.types(:admin, :manager)
     #   UsersIndex.types(:admin, :manager).filters { name =~ 'ro' } # the same as the first example
     #
-    def self.types *args
+    def self.types(*args)
       if args.present?
-        all.types *args
+        all.types(*args)
       else
         type_hash.values
       end
@@ -123,6 +126,14 @@ module Chewy
       type_hash.keys
     end
 
+    # Returns named type:
+    #
+    #    UserIndex.type('admin') # => UsersIndex::Admin
+    #
+    def self.type(type_name)
+      type_hash.fetch(type_name) { raise UndefinedType, "Unknown type in #{name}: #{type_name}" }
+    end
+
     # Used as a part of index definition DSL. Defines settings:
     #
     #   class UsersIndex < Chewy::Index
@@ -152,11 +163,13 @@ module Chewy
       public_methods - Chewy::Index.public_methods - type_names.map(&:to_sym)
     end
 
-  private
+    def self.journal?
+      types.any?(&:journal?)
+    end
 
-    def self.build_index_name *args
+    def self.build_index_name(*args)
       options = args.extract_options!
-      [options[:prefix], args.first || index_name, options[:suffix]].reject(&:blank?).join(?_)
+      [options[:prefix], args.first || index_name, options[:suffix]].reject(&:blank?).join('_')
     end
 
     def self.settings_hash
@@ -165,7 +178,7 @@ module Chewy
 
     def self.mappings_hash
       mappings = types.map(&:mappings_hash).inject(:merge)
-      mappings.present? ? {mappings: mappings} : {}
+      mappings.present? ? { mappings: mappings } : {}
     end
 
     def self.index_params

data/lib/chewy/index/actions.rb

@@ -9,7 +9,7 @@ module Chewy
       module ClassMethods
         # Checks index existance. Returns true or false
         #
-        #   UsersIndex.exist? #=> true
+        #   UsersIndex.exists? #=> true
         #
         def exists?
           client.indices.exists(index: index_name)
@@ -30,8 +30,8 @@ module Chewy
         # Suffixed index names might be used for zero-downtime mapping change, for example.
         # Description: (http://www.elasticsearch.org/blog/changing-mapping-with-zero-downtime/).
         #
-        def create *args
-          create! *args
+        def create(*args)
+          create!(*args)
         rescue Elasticsearch::Transport::Transport::Errors::BadRequest
           false
         end
@@ -52,13 +52,13 @@ module Chewy
         # Suffixed index names might be used for zero-downtime mapping change, for example.
         # Description: (http://www.elasticsearch.org/blog/changing-mapping-with-zero-downtime/).
         #
-        def create! *args
+        def create!(*args)
           options = args.extract_options!.reverse_merge!(alias: true)
           name = build_index_name(suffix: args.first)
 
           if Chewy::Runtime.version >= 1.1
             body = index_params
-            body.merge!(aliases: {index_name => {}}) if options[:alias] && name != index_name
+            body[:aliases] = { index_name => {} } if options[:alias] && name != index_name
             result = client.indices.create(index: name, body: body)
           else
             result = client.indices.create(index: name, body: index_params)
@@ -77,7 +77,7 @@ module Chewy
         #
         #   UsersIndex.delete '01-2014' # deletes `users_01-2014` index
         #
-        def delete suffix = nil
+        def delete(suffix = nil)
           result = client.indices.delete index: build_index_name(suffix: suffix)
           Chewy.wait_for_status if result
           result
@@ -96,7 +96,7 @@ module Chewy
         #
         #   UsersIndex.delete '01-2014' # deletes `users_01-2014` index
         #
-        def delete! suffix = nil
+        def delete!(suffix = nil)
           # es-ruby >= 1.0.10 handles Elasticsearch::Transport::Transport::Errors::NotFound
           # by itself, so it is raised here
           delete(suffix) or raise Elasticsearch::Transport::Transport::Errors::NotFound
@@ -108,7 +108,7 @@ module Chewy
         #   UsersIndex.purge # deletes and creates `users` index
         #   UsersIndex.purge '01-2014' # deletes `users` and `users_01-2014` indexes, creates `users_01-2014`
         #
-        def purge suffix = nil
+        def purge(suffix = nil)
           delete if suffix.present?
           delete suffix
           create suffix
@@ -121,7 +121,7 @@ module Chewy
         #   UsersIndex.purge! # deletes and creates `users` index
         #   UsersIndex.purge! '01-2014' # deletes `users` and `users_01-2014` indexes, creates `users_01-2014`
         #
-        def purge! suffix = nil
+        def purge!(suffix = nil)
           delete if suffix.present? && exists?
           delete suffix
           create! suffix
@@ -158,23 +158,23 @@ module Chewy
         # zero-downtime index resetting (described here:
         # http://www.elasticsearch.org/blog/changing-mapping-with-zero-downtime/).
         #
-        #   UsersIndex.reset! Time.now.to_i
+        #   UsersIndex.reset! Time.now.to_i, journal: true
         #
-        def reset! suffix = nil
+        def reset!(suffix = nil, journal: false)
           if suffix.present? && (indexes = self.indexes).present?
             create! suffix, alias: false
-            result = import suffix: suffix
-            client.indices.update_aliases body: {actions: [
+            result = import suffix: suffix, journal: journal
+            client.indices.update_aliases body: { actions: [
               *indexes.map do |index|
-                {remove: {index: index, alias: index_name}}
+                { remove: { index: index, alias: index_name } }
               end,
-              {add: {index: build_index_name(suffix: suffix), alias: index_name}}
-            ]}
+              { add: { index: build_index_name(suffix: suffix), alias: index_name } }
+            ] }
             client.indices.delete index: indexes if indexes.present?
             result
           else
             purge! suffix
-            import
+            import journal: journal
           end
         end
       end

data/lib/chewy/index/settings.rb

@@ -1,6 +1,5 @@
 module Chewy
   class Index
-
     # Stores ElasticSearch index settings and resolves `analysis`
     # hash. At first, you need to store some analyzers or other
     # analysis options to the corresponding repository:
@@ -37,7 +36,7 @@ module Chewy
             .deep_merge((settings[:index] || {}).deep_symbolize_keys)
         end
 
-        settings.present? ? {settings: settings} : {}
+        settings.present? ? { settings: settings } : {}
       end
 
     private
@@ -51,7 +50,7 @@ module Chewy
           result.merge!(type => resolved) if resolved.present?
         end
 
-        options.merge!(analyzer: analyzer) if analyzer.present?
+        options[:analyzer] = analyzer if analyzer.present?
         options
       end
 
@@ -67,7 +66,7 @@ module Chewy
             else
               name_or_hash = name_or_hash.to_sym
               resolved = repository[name_or_hash]
-              resolved ? {name_or_hash => resolved} : {}
+              resolved ? { name_or_hash => resolved } : {}
             end
             result.merge!(options)
           end

data/lib/chewy/journal.rb

@@ -0,0 +1,107 @@
+require 'chewy/journal/entry'
+require 'chewy/journal/query'
+require 'chewy/journal/apply'
+require 'chewy/journal/clean'
+
+module Chewy
+  class Journal
+    JOURNAL_MAPPING = {
+      journal: {
+        properties: {
+          index_name: { type: 'string', index: 'not_analyzed' },
+          type_name: { type: 'string', index: 'not_analyzed' },
+          action: { type: 'string', index: 'not_analyzed' },
+          object_ids: { type: 'string', index: 'not_analyzed' },
+          created_at: { type: 'date' }
+        }
+      }
+    }.freeze
+
+    def initialize(index)
+      @records = []
+      @index = index
+    end
+
+    def add(action_objects)
+      @records +=
+        action_objects.map do |action, objects|
+          {
+            index_name: @index.derivable_index_name,
+            type_name: @index.type_name,
+            action: action,
+            object_ids: identify(objects),
+            created_at: Time.now.to_i
+          }
+        end
+    end
+
+    def bulk_body
+      @records.map do |record|
+        {
+          create: {
+            _index: self.class.index_name,
+            _type: self.class.type_name,
+            data: record
+          }
+        }
+      end
+    end
+
+    def any_records?
+      @records.any?
+    end
+
+  private
+
+    def identify(objects)
+      @index.adapter.identify(objects)
+    end
+
+    class << self
+      def exists?
+        Chewy.client.indices.exists? index: index_name
+      end
+
+      def index_name
+        [
+          Chewy.configuration[:prefix],
+          Chewy.configuration[:journal_name] || 'chewy_journal'
+        ].reject(&:blank?).join('_')
+      end
+
+      def type_name
+        JOURNAL_MAPPING.keys.first
+      end
+
+      def create
+        return if exists?
+        Chewy.client.indices.create index: index_name, body: { settings: { index: Chewy.configuration[:index] }, mappings: JOURNAL_MAPPING }
+        Chewy.wait_for_status
+      end
+
+      def delete!
+        delete or raise Elasticsearch::Transport::Transport::Errors::NotFound
+      end
+
+      def delete
+        result = Chewy.client.indices.delete index: index_name
+        Chewy.wait_for_status if result
+        result
+      rescue Elasticsearch::Transport::Transport::Errors::NotFound
+        false
+      end
+
+      def apply_changes_from(*args)
+        Apply.since(*args)
+      end
+
+      def entries_from(*args)
+        Entry.since(*args)
+      end
+
+      def clean_until(*args)
+        Clean.until(*args)
+      end
+    end
+  end
+end