blueprinter 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf9b763f4f3719ba9e005676312f09f21165d8bc53ede0ee5ac0d171fcbae828
-  data.tar.gz: 2984aa6879ecafa6e15e49a95edc0b3fdad19d0f3ef0cdb51c484a7785b05303
+  metadata.gz: c8c9a52221d1a5473708cc7391865c25400d9e34440a1c0c52d76f2e7c811997
+  data.tar.gz: 380008b99bfd079c13d3c8ce019e4160b92141c20c639b233adaa6ef1ccfc9e5
 SHA512:
-  metadata.gz: 8141264e23abc76304a7dc22527880e22c82b1dbb796e4b4f9f5cbd6bd3a0b95c029aa83f3d68b557c530904b0131b19338fde99b00693374b95f529d6424027
-  data.tar.gz: 74c36b42fdb6655084572d94c7cb8ac610855c587604c3aae4c093590fb0254641de043a1b58d25ed2c963db42209d85444fdcdd8370189d766228136804b37d
+  metadata.gz: 225d6b77da9cf47411b014372234e7091d52d6a8ce0d358cc01d6f4a9eb188eafab70a50295a9e9ba3b15863d91cc35a3e3dcdcf501221ca8c959c785420e064
+  data.tar.gz: 0f407b0d11bcce8176c8e31f15e16f497431ffffe637ffe35e03779e91335902d70ef778546f55913b18885a261a9472fadc81b62caef490e64eb02d07900f5f

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.21.0  - 2019/12/19
+* 🚀 [FEATURE] Ability to specify `default_if` field/association option for more control on when the default value is applied. [191](https://github.com/procore/blueprinter/pull/191). Thanks to [@mcclayton](https://github.com/mcclayton).
+
 ## 0.20.0  - 2019/10/15
 * 🚀 [FEATURE] Ability to include multiple views in a single method call with `include_views`. [184](https://github.com/procore/blueprinter/pull/184). Thanks to [@narendranvelmurugan](https://github.com/narendranvelmurugan).
 
@@ -42,7 +45,7 @@
 
 ## 0.12.1  - 2019/1/24
 
-* 🐛 [BUGFIX] Fix boolean `false` values getting serialized as `null`. Please see PR [#132](https://github.com/procore/blueprinter/pull/132).
+* 🐛 [BUGFIX] Fix boolean `false` values getting serialized as `null`. Please see PR [#132](https://github.com/procore/blueprinter/pull/132). Thanks to [@samsongz](https://github.com/samsongz).
 
 ## 0.12.0  - 2019/1/16
 

data/README.md

@@ -374,7 +374,7 @@ Blueprinter.configure do |config|
 end
 ```
 
-#### Field-level/Associaion-level Setting
+#### Field-level/Association-level Setting
 ```ruby
 class UserBlueprint < Blueprinter::Base
   identifier :uuid
@@ -390,6 +390,41 @@ end
 </details>
 
 
+<details>
+<summary>default_if</summary>
+
+---
+
+Sometimes, you may want certain "empty" values to pass through to the default value.
+Blueprinter provides the ability to treat the following empty types as the default value (or `nil` if no default provided).
+
+#### Blueprinter::EMPTY_COLLECTION
+An empty array or empty active record collection.
+
+#### Blueprinter::EMPTY_HASH
+An empty hash.
+
+#### Blueprinter::EMPTY_STRING
+An empty string or symbol.
+
+#### Field-level/Association-level Setting
+```ruby
+class UserBlueprint < Blueprinter::Base
+  identifier :uuid
+
+  view :normal do
+    # If first_name is an empty string, it will become "N/A"
+    field :first_name, default_if: Blueprinter::EmptyString, default: "N/A"
+    # If the projects association collection is empty, it will become nil
+    association :projects, blueprint: ProjectBlueprint, default_if: Blueprinter::EmptyCollection
+  end
+end
+```
+
+---
+</details>
+
+
 <details>
 <summary>Supporting Dynamic Blueprints For Associations</summary>
 

data/lib/blueprinter/base.rb

@@ -1,5 +1,6 @@
 require_relative 'blueprinter_error'
 require_relative 'configuration'
+require_relative 'empty_types'
 require_relative 'extractor'
 require_relative 'extractors/association_extractor'
 require_relative 'extractors/auto_extractor'
@@ -8,6 +9,7 @@ require_relative 'extractors/hash_extractor'
 require_relative 'extractors/public_send_extractor'
 require_relative 'formatters/date_time_formatter'
 require_relative 'field'
+require_relative 'helpers/type_helpers'
 require_relative 'helpers/base_helpers'
 require_relative 'view'
 require_relative 'view_collection'
@@ -252,6 +254,7 @@ module Blueprinter
       unless view_collection.has_view? view_name
         raise BlueprinterError, "View '#{view_name}' is not defined"
       end
+
       data = prepare_data(object, view_name, local_options)
       prepend_root_and_meta(data, root, meta)
     end
@@ -283,9 +286,9 @@ module Blueprinter
     # @param class name [Class] which implements the method transform to include for
     #   serialization.
     #
-    #    
+    #
     # @example Specifying a DynamicFieldTransformer transformer for including dynamic fields to be serialized.
-    #   class User 
+    #   class User
     #     def custom_columns
     #       self.dynamic_fields # which is an array of some columns
     #     end
@@ -297,7 +300,7 @@ module Blueprinter
     #
     #   class UserBlueprint < Blueprinter::Base
     #     fields :first_name, :last_name
-    #     transform DynamicFieldTransformer  
+    #     transform DynamicFieldTransformer
     #     # other code
     #   end
     #
@@ -346,9 +349,9 @@ module Blueprinter
     #     view :normal do
     #       fields :first_name, :last_name
     #     end
-    #     view :special do 
+    #     view :special do
     #       fields :birthday, :company
-    #     end 
+    #     end
     #     view :extended do
     #       include_views :normal, :special # include fields specified from above.
     #       field :description
@@ -360,8 +363,8 @@ module Blueprinter
 
 
     def self.include_views(*view_names)
-        current_view.include_views(view_names)
-    end 
+      current_view.include_views(view_names)
+    end
 
 
     # Exclude a field that was mixed into the current view.

data/lib/blueprinter/empty_types.rb

@@ -0,0 +1,25 @@
+require_relative 'helpers/type_helpers'
+
+module Blueprinter
+  EMPTY_COLLECTION = "empty_collection".freeze
+  EMPTY_HASH = "empty_hash".freeze
+  EMPTY_STRING = "empty_string".freeze
+
+  module EmptyTypes
+    include TypeHelpers
+    private
+
+    def use_default_value?(value, empty_type)
+      case empty_type
+      when Blueprinter::EMPTY_COLLECTION
+        array_like?(value) && value.empty?
+      when Blueprinter::EMPTY_HASH
+        value.is_a?(Hash) && value.empty?
+      when Blueprinter::EMPTY_STRING
+        value.to_s == ""
+      else
+        value.nil?
+      end
+    end
+  end
+end

data/lib/blueprinter/extractor.rb

@@ -1,6 +1,6 @@
 module Blueprinter
   class Extractor
-    def extract(field_name, object, local_options, options={})
+    def extract(_field_name, _object, _local_options, _options={})
       fail NotImplementedError, "An Extractor must implement #extract"
     end
 

data/lib/blueprinter/extractors/association_extractor.rb

@@ -1,14 +1,16 @@
 module Blueprinter
   # @api private
   class AssociationExtractor < Extractor
+    include EmptyTypes
+
     def initialize
       @extractor = AutoExtractor.new
     end
 
     def extract(association_name, object, local_options, options={})
-      options_without_default = options.reject { |k,_| k == :default }
+      options_without_default = options.reject { |k,_| k == :default || k == :default_if }
       value = @extractor.extract(association_name, object, local_options, options_without_default)
-      return default_value(options) if value.nil?
+      return default_value(options) if use_default_value?(value, options[:default_if])
       view = options[:view] || :default
       blueprint = association_blueprint(options[:blueprint], value)
       blueprint.prepare(value, view_name: view, local_options: local_options)

data/lib/blueprinter/extractors/auto_extractor.rb

@@ -1,6 +1,8 @@
 module Blueprinter
   # @api private
   class AutoExtractor < Extractor
+    include EmptyTypes
+
     def initialize
       @hash_extractor = HashExtractor.new
       @public_send_extractor = PublicSendExtractor.new
@@ -11,7 +13,7 @@ module Blueprinter
     def extract(field_name, object, local_options, options = {})
       extraction = extractor(object, options).extract(field_name, object, local_options, options)
       value = @datetime_formatter.format(extraction, options)
-      value.nil? ? default_value(options) : value
+      use_default_value?(value, options[:default_if]) ? default_value(options) : value
     end
 
     private

data/lib/blueprinter/field.rb

@@ -46,10 +46,10 @@ class Blueprinter::Field
 
     # Use field-level callable, or when not defined, try global callable
     tmp = if options.key?(condition)
-      options.fetch(condition)
-    elsif config.valid_callable?(condition)
-      config.public_send(condition)
-    end
+            options.fetch(condition)
+          elsif config.valid_callable?(condition)
+            config.public_send(condition)
+          end
 
     return false unless tmp
 

data/lib/blueprinter/helpers/base_helpers.rb

@@ -5,12 +5,9 @@ module Blueprinter
     end
 
     module SingletonMethods
-      private
-      def active_record_relation?(object)
-        !!(defined?(ActiveRecord::Relation) &&
-          object.is_a?(ActiveRecord::Relation))
-      end
+      include TypeHelpers
 
+      private
       def prepare_for_render(object, options)
         view_name = options.delete(:view) || :default
         root = options.delete(:root)
@@ -77,10 +74,6 @@ module Blueprinter
         @view_collection ||= ViewCollection.new
       end
 
-      def array_like?(object)
-        object.is_a?(Array) || active_record_relation?(object)
-      end
-
       def associations(view_name = :default)
         view_collection.fields_for(view_name).select { |f| f.options[:association] }
       end

data/lib/blueprinter/helpers/type_helpers.rb

@@ -0,0 +1,13 @@
+module Blueprinter
+  module TypeHelpers
+    private
+    def active_record_relation?(object)
+      !!(defined?(ActiveRecord::Relation) &&
+        object.is_a?(ActiveRecord::Relation))
+    end
+
+    def array_like?(object)
+      object.is_a?(Array) || active_record_relation?(object)
+    end
+  end
+end

data/lib/blueprinter/transformer.rb

@@ -1,12 +1,12 @@
 module Blueprinter
   # @api private
   class Transformer
-    def transform(result_hash,primary_obj, options={})
+    def transform(_result_hash, _primary_obj, _options = {})
       fail NotImplementedError, "A Transformer must implement #transform"
     end
 
-    def self.transform(result_hash,primary_obj, options={})
-      self.new.transform(result_hash,primary_obj, options)
+    def self.transform(result_hash, primary_obj, options = {})
+      self.new.transform(result_hash, primary_obj, options)
     end
   end
 end

data/lib/blueprinter/version.rb

@@ -1,3 +1,3 @@
 module Blueprinter
-  VERSION = '0.20.0'
+  VERSION = '0.21.0'.freeze
 end

data/lib/blueprinter/view.rb

@@ -23,7 +23,7 @@ module Blueprinter
       view.excluded_field_names.each do |field_name|
         exclude_field(field_name)
       end
-      
+
       view.transformers.each do |transformer|
         self.add_transformer(transformer)
       end
@@ -37,12 +37,12 @@ module Blueprinter
       view_names.each do |view_name|
         included_view_names << view_name
       end
-    end 
+    end
 
     def exclude_field(field_name)
       excluded_field_names << field_name
     end
-    
+
     def exclude_fields(field_names)
       field_names.each do |field_name|
         excluded_field_names << field_name

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Adam Hess
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-16 00:00:00.000000000 Z
+date: 2019-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot
@@ -169,6 +169,7 @@ files:
 - lib/blueprinter/base.rb
 - lib/blueprinter/blueprinter_error.rb
 - lib/blueprinter/configuration.rb
+- lib/blueprinter/empty_types.rb
 - lib/blueprinter/extractor.rb
 - lib/blueprinter/extractors/association_extractor.rb
 - lib/blueprinter/extractors/auto_extractor.rb
@@ -178,6 +179,7 @@ files:
 - lib/blueprinter/field.rb
 - lib/blueprinter/formatters/date_time_formatter.rb
 - lib/blueprinter/helpers/base_helpers.rb
+- lib/blueprinter/helpers/type_helpers.rb
 - lib/blueprinter/transformer.rb
 - lib/blueprinter/version.rb
 - lib/blueprinter/view.rb