blueprinter 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f9861d74164769103ef0e80689c8685cc1ba1fee08ef296b5dd3c383dec6403
-  data.tar.gz: bb5a57d899eae1e5d3cf1bd4deef908ea7e34988d5bfd1284e75e8835a5208bb
+  metadata.gz: 58305ea0b747a19614cf18bacb3a531de6c64e6ccf4f01abc22dc47c3a378ecc
+  data.tar.gz: b48d6d62205280be48ec415bc5b67af3ae5a5ee7afe3581a707064fa46f5986f
 SHA512:
-  metadata.gz: d40d6f6934605ae6e261af6ddf06161c303f3db1abc816bbdd6fa233a68c9fc9f643e8043f582f4240a0d9498646aba2ce3411dcc22dc8b17b9b6e121b970bcd
-  data.tar.gz: e69239f8a8578eee50c6a54ff6e6b733e1c052e60bff7871a1fa3df975f8fe20e30c0589b75e207267c98cf6e709d18a333b84ab24c2b9bf72df5b966296b830
+  metadata.gz: f101686b41f0c201d3bf0414f7aa1529450ca79ffed19e272875c48ba617bf0a9933876510715f3a65d016af3f4ed7ebeb179a932489dfe7c074a0a3465fba3a
+  data.tar.gz: 3b4dcc7ce851136b62cb3fe534fa38746da07c834d25b19a56927dfabe01f0be4a1e3e5ba95434fce80cc43c566244854b08eb0b6fbb7f14cb1dce33d8a2b18f

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.18.0  - 2019/05/29
+
+* ⚠️ [DEPRECATION] :if/:unless procs with two arguments are now deprecated. *These procs now take in three arguments (field_name, obj, options) instead of just (obj, options).*
+  In order to be compliant with the the next major release, all conditional :if/:unless procs must be augmented to take in three arguments instead of two. i.e. `(obj, options)` to `(field_name, obj, options)`.
+
 ## 0.17.0  - 2019/05/23
 * 🐛 [BUGFIX] Fixing view: :identifier including non-identifier fields. [#154](https://github.com/procore/blueprinter/pull/154). Thanks to [@AllPurposeName](https://github.com/AllPurposeName).
 

data/README.md

@@ -581,8 +581,8 @@ Both the `field` and the global Blueprinter Configuration supports `:if` and `:u
 #### Global Config Setting
 ```ruby
 Blueprinter.configure do |config|
-  config.if = ->(obj, _options) { obj.is_a?(Foo) }
-  config.unless = ->(obj, _options) { obj.is_a?(Bar) }
+  config.if = ->(field_name, obj, _options) { !obj[field_name].nil? }
+  config.unless = ->(field_name, obj, _options) { obj[field_name].nil? }
 end
 ```
 

data/lib/blueprinter/base.rb

@@ -78,11 +78,11 @@ module Blueprinter
     #   on the Date/DateTime object.
     # @option options [Symbol,Proc] :if Specifies a method, proc or string to
     #   call to determine if the field should be included (e.g.
-    #   `if: :include_first_name?, or if: Proc.new { |user, options| options[:current_user] == user }).
+    #   `if: :include_first_name?, or if: Proc.new { |_field_name, user, options| options[:current_user] == user }).
     #   The method, proc or string should return or evaluate to a true or false value.
     # @option options [Symbol,Proc] :unless Specifies a method, proc or string
     #   to call to determine if the field should be included (e.g.
-    #   `unless: :include_first_name?, or unless: Proc.new { |user, options| options[:current_user] != user }).
+    #   `unless: :include_first_name?, or unless: Proc.new { |_field_name, user, options| options[:current_user] != user }).
     #   The method, proc or string should return or evaluate to a true or false value.
     # @yield [object, options] The object and the options passed to render are
     #   also yielded to the block.
@@ -101,14 +101,14 @@ module Blueprinter
     #     # other code
     #   end
     #
-    # @example Passing an if proc and unless method..
+    # @example Passing an if proc and unless method.
     #   class UserBlueprint < Blueprinter::Base
-    #     def skip_first_name?(user, options)
+    #     def skip_first_name?(_field_name, user, options)
     #       user.first_name == options[:first_name]
     #     end
     #
     #     field :first_name, unless: :skip_first_name?
-    #     field :last_name, if: ->(user, options) { user.first_name != options[:first_name] }
+    #     field :last_name, if: ->(_field_name, user, options) { user.first_name != options[:first_name] }
     #     # other code
     #   end
     #
@@ -316,15 +316,15 @@ module Blueprinter
     def self.exclude(field_name)
       current_view.exclude_field(field_name)
     end
-    
+
     # When mixing multiple views under a single view, some fields may required to be excluded from
     # current view
-    # 
+    #
     # @param [Array<Symbol>] the fields to exclude from the current view.
     #
     # @example Excluding mutiple fields from being included into the current view.
     #   view :normal do
-    #     fields :name,:address,:position, 
+    #     fields :name,:address,:position,
     #           :company, :contact
     #   end
     #   view :special do
@@ -335,7 +335,7 @@ module Blueprinter
     #   => [:name, :company, :contact, :birthday, :joining_anniversary]
     #
     # @return [Array<Symbol>] an array of field names
-    
+
     def self.excludes(*field_names)
       current_view.exclude_fields(field_names)
     end

data/lib/blueprinter/field.rb

@@ -13,9 +13,9 @@ class Blueprinter::Field
     extractor.extract(method, object, local_options, options)
   end
 
-  def skip?(object, local_options)
-    return true if if_callable && !if_callable.call(object, local_options)
-    unless_callable && unless_callable.call(object, local_options)
+  def skip?(field_name, object, local_options)
+    return true if if_callable && !if_callable.call(field_name, object, local_options)
+    unless_callable && unless_callable.call(field_name, object, local_options)
   end
 
   private
@@ -31,6 +31,17 @@ class Blueprinter::Field
   end
 
   def callable_from(condition)
+    callable = old_callable_from(condition)
+
+    if callable && callable.arity == 2
+      warn "[DEPRECATION] Blueprinter :#{condition} conditions now expects 3 arguments instead of 2."
+      ->(_field_name, obj, options) { callable.call(obj, options) }
+    else
+      callable
+    end
+  end
+
+  def old_callable_from(condition)
     config = Blueprinter.configuration
 
     # Use field-level callable, or when not defined, try global callable

data/lib/blueprinter/helpers/base_helpers.rb

@@ -38,14 +38,14 @@ module Blueprinter
         ret = { root => data }
         meta ? ret.merge!(meta: meta) : ret
       end
-      
+
       def inherited(subclass)
         subclass.send(:view_collection).inherit(view_collection)
       end
 
       def object_to_hash(object, view_name:, local_options:)
         view_collection.fields_for(view_name).each_with_object({}) do |field, hash|
-          next if field.skip?(object, local_options)
+          next if field.skip?(field.name, object, local_options)
           hash[field.name] = field.extract(object, local_options)
         end
       end

data/lib/blueprinter/version.rb

@@ -1,3 +1,3 @@
 module Blueprinter
-  VERSION = '0.17.0'
+  VERSION = '0.18.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Adam Hess
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2019-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot