Ignore empty blank options on fields

.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-29 12:10:01 UTC using RuboCop version 1.11.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,7 +41,19 @@ Lint/MissingSuper:
     - 'lib/chewy/type/adapter/object.rb'
     - 'lib/chewy/type/adapter/orm.rb'
 
-# Offense count: 36
+# Offense count: 3
+Lint/SymbolConversion:
+  Exclude:
+    - 'spec/chewy/fields/base_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+
+Lint/RedundantDirGlobSort:
+  Exclude:
+    - 'lib/chewy/search/parameters.rb'
+
+# Offense count: 35
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 41
@@ -57,15 +68,15 @@ Metrics/ClassLength:
 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 +100,7 @@ Style/DocumentDynamicEvalDefinition:
     - 'lib/chewy/type/crutch.rb'
     - 'lib/chewy/type/witchcraft.rb'
 
-# Offense count: 63
+# Offense count: 58
 Style/Documentation:
   Enabled: false
 
@@ -99,7 +110,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 +124,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 +136,27 @@ Style/IfUnlessModifier:
     - 'lib/chewy/type/witchcraft.rb'
     - 'spec/support/active_record.rb'
 
-# Offense count: 64
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/RedundantBegin:
+  Exclude:
+    - 'lib/chewy/config.rb'
+    - 'lib/chewy/type/syncer.rb'
+    - 'lib/chewy/search/request.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantFreeze:
+  Exclude:
+    - 'lib/chewy/type/syncer.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/SlicingWithRange:
+  Exclude:
+    - 'lib/chewy/type/witchcraft.rb'
+
+# 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 flag for field method ([@Vitalina-Vakulchyk][]):
+    * true by default for 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)
+    * [geo_point type](#geo_point-type)
   * [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 `.empty?` 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
+```
+
+#### geo_point type
+
+By default `ignore_blank` is `true` for geo_point type.
 
 ### Journaling
 

lib/chewy/fields/base.rb

@@ -40,6 +40,8 @@ def mappings_hash
       def compose(*objects)
         result = evaluate(objects)
 
+        return {} if field_with_ignore_blank_flag?(result) || geo_point_field_without_ignore_blank_flag?(result)
+
         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 field_with_ignore_blank_flag?(result)
+        @options[:ignore_blank] == true && result.blank?
+      end
+
+      def geo_point_field_without_ignore_blank_flag?(result)
+        @options[:ignore_blank] != false && @options[:type] && @options[:type].to_sym == :geo_point && result.blank?
+      end
+
       def evaluate(objects)
         object = objects.first