Ignore empty blank options on fields

.rubocop.yml

@@ -2,6 +2,7 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   NewCops: enable
+  TargetRubyVersion: 2.7
 
 Layout/AccessModifierIndentation:
   EnforcedStyle: outdent

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-03-11 12:44:08 UTC using RuboCop version 1.11.0.
+# on 2021-03-31 08:06:34 UTC using RuboCop version 1.12.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -13,16 +13,15 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'chewy.gemspec'
 
-# Offense count: 3
+# Offense count: 2
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: enums
 Lint/ConstantDefinitionInBlock:
   Exclude:
-    - 'lib/chewy.rb'
     - 'lib/chewy/rspec/update_index.rb'
     - 'spec/chewy/config_spec.rb'
 
-# Offense count: 12
+# Offense count: 10
 # Configuration parameters: AllowComments, AllowEmptyLambdas.
 Lint/EmptyBlock:
   Exclude:
@@ -42,30 +41,30 @@ Lint/MissingSuper:
     - 'lib/chewy/type/adapter/object.rb'
     - 'lib/chewy/type/adapter/orm.rb'
 
-# Offense count: 36
+# Offense count: 35
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 41
 
 # Offense count: 4
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 269
+  Max: 267
 
 # Offense count: 13
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
   Max: 12
 
-# Offense count: 44
+# Offense count: 43
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Max: 29
 
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 174
+  Max: 158
 
 # Offense count: 18
 # Configuration parameters: IgnoredMethods.
@@ -89,7 +88,8 @@ Style/DocumentDynamicEvalDefinition:
     - 'lib/chewy/type/crutch.rb'
     - 'lib/chewy/type/witchcraft.rb'
 
-# Offense count: 63
+# Offense count: 58
+# Configuration parameters: AllowedConstants.
 Style/Documentation:
   Enabled: false
 
@@ -99,7 +99,7 @@ Style/EvalWithLocation:
   Exclude:
     - 'spec/chewy/index_spec.rb'
 
-# Offense count: 208
+# Offense count: 191
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: always, always_true, never
@@ -113,7 +113,7 @@ Style/GuardClause:
     - 'lib/chewy.rb'
     - 'spec/support/active_record.rb'
 
-# Offense count: 12
+# Offense count: 10
 # Cop supports --auto-correct.
 Style/IfUnlessModifier:
   Exclude:
@@ -125,7 +125,7 @@ Style/IfUnlessModifier:
     - 'lib/chewy/type/witchcraft.rb'
     - 'spec/support/active_record.rb'
 
-# Offense count: 64
+# Offense count: 53
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https

CHANGELOG.md

@@ -6,6 +6,10 @@
 
 ### Changes
 
+  * [#778](https://github.com/toptal/chewy/pull/778): Add `ignore_blank` option to `field` method ([@Vitalina-Vakulchyk][]):
+    * `true` by default for the `geo_point` type
+    * `false` by default for other types
+
   * [#776](https://github.com/toptal/chewy/pull/776): **(Breaking)** Removal of unnecessary features and integrations ([@Vitalina-Vakulchyk][]):
     * `aws-sdk-sqs` / `shoryuken`
     * `mongoid`

README.md

@@ -32,6 +32,8 @@ Chewy is an ODM (Object Document Mapper), built on top of the [the official Elas
   * [Witchcraft™ technology](#witchcraft-technology)
   * [Raw Import](#raw-import)
   * [Index creation during import](#index-creation-during-import)
+  * [Skip record fields during import](#skip-record-fields-during-import)
+    * [Default values for different types](#default-values-for-different-types)
   * [Journaling](#journaling)
   * [Types access](#types-access)
   * [Index manipulation](#index-manipulation)
@@ -660,6 +662,25 @@ By default, when you perform import Chewy checks whether an index exists and cre
 You can turn off this feature to decrease Elasticsearch hits count.
 To do so you need to set `skip_index_creation_on_import` parameter to `false` in your `config/chewy.yml`
 
+### Skip record fields during import
+
+You can use `ignore_blank: true` to skip fields that return `true` for the `.blank?` method:
+
+```ruby
+define_type Country do
+  field :id
+  field :cities, ignore_blank: true do
+    field :id
+    field :name
+    field :surname, ignore_blank: true
+    field :description
+  end
+end
+```
+
+#### Default values for different types
+
+By default `ignore_blank` is false on every type except `geo_point`.
 
 ### Journaling
 

lib/chewy/fields/base.rb

@@ -40,6 +40,8 @@ def mappings_hash
       def compose(*objects)
         result = evaluate(objects)
 
+        return {} if result.blank? && ignore_blank?
+
         if children.present? && !multi_field?
           result = if result.respond_to?(:to_ary)
             result.to_ary.map { |item| compose_children(item, *objects) }
@@ -53,6 +55,14 @@ def compose(*objects)
 
     private
 
+      def geo_point?
+        @options[:type].to_s == 'geo_point'
+      end
+
+      def ignore_blank?
+        @options.fetch(:ignore_blank) { geo_point? }
+      end
+
       def evaluate(objects)
         object = objects.first
 

lib/chewy/search/request.rb

@@ -988,11 +988,9 @@ def reset
       def perform(additional = {})
         request_body = render.merge(additional)
         ActiveSupport::Notifications.instrument 'search_query.chewy', notification_payload(request: request_body) do
-          begin
-            Chewy.client.search(request_body)
-          rescue Elasticsearch::Transport::Transport::Errors::NotFound
-            {}
-          end
+          Chewy.client.search(request_body)
+        rescue Elasticsearch::Transport::Transport::Errors::NotFound
+          {}
         end
       end
 

lib/chewy/type/syncer.rb

@@ -127,12 +127,10 @@ def missing_ids
       def outdated_ids
         return [] if source_data.blank? || index_data.blank? || !@type.supports_outdated_sync?
 
-        @outdated_ids ||= begin
-          if @parallel
-            parallel_outdated_ids
-          else
-            linear_outdated_ids
-          end
+        @outdated_ids ||= if @parallel
+          parallel_outdated_ids
+        else
+          linear_outdated_ids
         end
       end
 
@@ -147,19 +145,17 @@ def index_data
       end
 
       def source_and_index_data
-        @source_and_index_data ||= begin
-          if @parallel
-            ::ActiveRecord::Base.connection.close if defined?(::ActiveRecord::Base)
-            result = ::Parallel.map(%i[source index], @parallel, &SOURCE_OR_INDEX_DATA_WORKER.curry[self, @type])
-            ::ActiveRecord::Base.connection.reconnect! if defined?(::ActiveRecord::Base)
-            if result.first.keys.first == :source
-              [result.first.values.first, result.second.values.first]
-            else
-              [result.second.values.first, result.first.values.first]
-            end
+        @source_and_index_data ||= if @parallel
+          ::ActiveRecord::Base.connection.close if defined?(::ActiveRecord::Base)
+          result = ::Parallel.map(%i[source index], @parallel, &SOURCE_OR_INDEX_DATA_WORKER.curry[self, @type])
+          ::ActiveRecord::Base.connection.reconnect! if defined?(::ActiveRecord::Base)
+          if result.first.keys.first == :source
+            [result.first.values.first, result.second.values.first]
           else
-            [fetch_source_data, fetch_index_data]
+            [result.second.values.first, result.first.values.first]
           end
+        else
+          [fetch_source_data, fetch_index_data]
         end
       end
 

lib/chewy/type/witchcraft.rb

@@ -223,7 +223,7 @@ def replace_lvar(node, old_variable, new_variable)
         def replace_send(node, variable)
           if node.is_a?(Parser::AST::Node)
             if node.type == :send && node.children[0].nil?
-              node.updated(nil, [Parser::AST::Node.new(:lvar, [variable]), *node.children[1..-1]])
+              node.updated(nil, [Parser::AST::Node.new(:lvar, [variable]), *node.children[1..]])
             else
               node.updated(nil, node.children.map { |child| replace_send(child, variable) })
             end