blueprinter 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 280eafa98bef71d08595d4f39aaf02738a2b2b57
-  data.tar.gz: 4e7e99f14c98f8f4912677dcecf3638333099079
+  metadata.gz: 90196d2f88f21663e58a83d29f17e086b01ff4b4
+  data.tar.gz: d5773b0408dd8d11aede3f3970e618d43bc36990
 SHA512:
-  metadata.gz: f79abb1b26088f23bb17cf984d9cc9549cb852454dfdf040d708cd538fae4433afdb122ad0fcd10f1294bb0ed7c32c833f8e465ed23124ceb0f8df9aa54232f1
-  data.tar.gz: 583bc6a0050501552f935ccf8fbc6819889e0912a8f64c4d51efc3ce44d8a8ad610348efab6bd3c8a24bcf088a0a77cb5e91e9825a583424005978302bd9e831
+  metadata.gz: efec9cf0d62ecd854144535b84cf421cfd34191b30aa8896bbd34753e75a172a056fefe6940ab94791d750f12e48838edb4a8a3e9dfb64fdfa10897877f9c2be
+  data.tar.gz: bb09550e791977703ec91448bab4da25781852b228f7c97feca16fde2a2c3273731bfac4c4906a83e95a278908347405a9d8f1fb5f346cd0997cffcbbb808d88

data/CHANGELOG.md

@@ -1,23 +1,27 @@
+## 0.11.0  - 2019/1/15
+
+* 🚀 [FEATURE] Enables the setting of a global `:if`/`:unless` proc in the Blueprinter Configuration that will be used to evaluate the conditional render of all fields. [#127](https://github.com/procore/blueprinter/pull/127). Thanks to [@mcclayton](https://github.com/mcclayton).
+
 ## 0.10.0  - 2018/12/20
 
-* [FEATURE] Association Blueprints can be dynamically evaluated using a proc. [#122](https://github.com/procore/blueprinter/pull/122). Thanks to [@ritikesh](https://github.com/ritikesh).
+* 🚀 [FEATURE] Association Blueprints can be dynamically evaluated using a proc. [#122](https://github.com/procore/blueprinter/pull/122). Thanks to [@ritikesh](https://github.com/ritikesh).
 
 ## 0.9.0  - 2018/11/29
 
-* [FEATURE] Added a `render_as_json` API. Similar to `render_as_hash` but returns a JSONified hash. Please see pr [#119](https://github.com/procore/blueprinter/pull/119). Thanks to [@ritikesh](https://github.com/ritikesh).
-* [FEATURE] Sorting of fields in the response is now configurable to sort by definition or by name(asc only). Please see pr [#119](https://github.com/procore/blueprinter/pull/119). Thanks to [@ritikesh](https://github.com/ritikesh).
-* [ENHANCEMENT] Updated readme for above features and some existing undocumented features like `exclude fields`, `render_as_hash`. Please see pr [#119](https://github.com/procore/blueprinter/pull/119). Thanks to [@ritikesh](https://github.com/ritikesh).
+* 🚀 [FEATURE] Added a `render_as_json` API. Similar to `render_as_hash` but returns a JSONified hash. Please see pr [#119](https://github.com/procore/blueprinter/pull/119). Thanks to [@ritikesh](https://github.com/ritikesh).
+* 🚀 [FEATURE] Sorting of fields in the response is now configurable to sort by definition or by name(asc only). Please see pr [#119](https://github.com/procore/blueprinter/pull/119). Thanks to [@ritikesh](https://github.com/ritikesh).
+* 💅 [ENHANCEMENT] Updated readme for above features and some existing undocumented features like `exclude fields`, `render_as_hash`. Please see pr [#119](https://github.com/procore/blueprinter/pull/119). Thanks to [@ritikesh](https://github.com/ritikesh).
 
 ## 0.8.0  - 2018/11/19
 
-* [FEATURE] Extend Support for other JSON encoders like yajl-ruby. Please see pr [#118](https://github.com/procore/blueprinter/pull/118). Thanks to [@ritikesh](https://github.com/ritikesh).
-* [BUGFIX] Do not raise error on null date with `date_format` option. Please see pr [#117](https://github.com/procore/blueprinter/pull/117). Thanks to [@tpltn](https://github.com/tpltn).
-* [FEATURE] Add `default` option to `field`s which will be used as the serialized value instead of `null` when the field evaluates to null. Please see pr [#115](https://github.com/procore/blueprinter/pull/115). Thanks to [@mcclayton](https://github.com/mcclayton).
-* [BUGFIX] Made Base.associations completely private since they are not used outside of the Blueprinter base. Please see pr [#112](https://github.com/procore/blueprinter/pull/112). Thanks to [@philipqnguyen](https://github.com/philipqnguyen).
-* [BUGFIX] Fix issue where entire Blueprinter module was marked api private. Please see pr [#111](https://github.com/procore/blueprinter/pull/111). Thanks to [@philipqnguyen](https://github.com/philipqnguyen).
-* [FEATURE] Allow identifiers to be defined with a block. Please see pr [#110](https://github.com/procore/blueprinter/pull/110). Thanks to [@hugopeixoto](https://github.com/hugopeixoto).
-* [ENHANCEMENT] Update docs regarding the args yielded to blocks. Please see pr [#108](https://github.com/procore/blueprinter/pull/108). Thanks to [@philipqnguyen](https://github.com/philipqnguyen).
-* [ENHANCEMENT] Use `field` method in fields. Please see pr [#107](https://github.com/procore/blueprinter/pull/107). Thanks to [@hugopeixoto](https://github.com/hugopeixoto).
+* 🚀 [FEATURE] Extend Support for other JSON encoders like yajl-ruby. Please see pr [#118](https://github.com/procore/blueprinter/pull/118). Thanks to [@ritikesh](https://github.com/ritikesh).
+* 🐛 [BUGFIX] Do not raise error on null date with `date_format` option. Please see pr [#117](https://github.com/procore/blueprinter/pull/117). Thanks to [@tpltn](https://github.com/tpltn).
+* 🚀 [FEATURE] Add `default` option to `field`s which will be used as the serialized value instead of `null` when the field evaluates to null. Please see pr [#115](https://github.com/procore/blueprinter/pull/115). Thanks to [@mcclayton](https://github.com/mcclayton).
+* 🐛 [BUGFIX] Made Base.associations completely private since they are not used outside of the Blueprinter base. Please see pr [#112](https://github.com/procore/blueprinter/pull/112). Thanks to [@philipqnguyen](https://github.com/philipqnguyen).
+* 🐛 [BUGFIX] Fix issue where entire Blueprinter module was marked api private. Please see pr [#111](https://github.com/procore/blueprinter/pull/111). Thanks to [@philipqnguyen](https://github.com/philipqnguyen).
+* 🚀 [FEATURE] Allow identifiers to be defined with a block. Please see pr [#110](https://github.com/procore/blueprinter/pull/110). Thanks to [@hugopeixoto](https://github.com/hugopeixoto).
+* 💅 [ENHANCEMENT] Update docs regarding the args yielded to blocks. Please see pr [#108](https://github.com/procore/blueprinter/pull/108). Thanks to [@philipqnguyen](https://github.com/philipqnguyen).
+* 💅 [ENHANCEMENT] Use `field` method in fields. Please see pr [#107](https://github.com/procore/blueprinter/pull/107). Thanks to [@hugopeixoto](https://github.com/hugopeixoto).
 
 ## 0.7.0  - 2018/10/17
 
@@ -26,23 +30,23 @@
 
 ## 0.6.0  - 2018/06/05
 
-* [FEATURE] Add `date_time` format as an option to `field`. Please see pr #68. Thanks to [@njbbaer](https://github.com/njbbaer).
-* [FEATURE] Add conditional field support `:unless` and `:if` as an option to `field`. Please see pr [#86](https://github.com/procore/blueprinter/pull/86). Thanks to [@ojab](https://github.com/ojab).
-* [BUGFIX] Fix case where miscellaneous options were not being passed through the `AutoExtractor`. See pr [#83](https://github.com/procore/blueprinter/pull/83).
+* 🚀 [FEATURE] Add `date_time` format as an option to `field`. Please see pr #68. Thanks to [@njbbaer](https://github.com/njbbaer).
+* 🚀 [FEATURE] Add conditional field support `:unless` and `:if` as an option to `field`. Please see pr [#86](https://github.com/procore/blueprinter/pull/86). Thanks to [@ojab](https://github.com/ojab).
+* 🐛 [BUGFIX] Fix case where miscellaneous options were not being passed through the `AutoExtractor`. See pr [#83](https://github.com/procore/blueprinter/pull/83).
 
 ## 0.5.0  - 2018/05/15
 
-* [FEATURE] Add `default` option to `association` which will be used as the serialized value instead of `null` when the association evaluates to null.
+* 🚀 [FEATURE] Add `default` option to `association` which will be used as the serialized value instead of `null` when the association evaluates to null.
 See PR [#78](https://github.com/procore/blueprinter/pull/78) by [@vinaya-procore](https://github.com/vinaya-procore).
 
 ## 0.4.0  - 2018/05/02
 
-* [FEATURE] Add `render_as_hash` which will output a hash instead of
+* 🚀 [FEATURE] Add `render_as_hash` which will output a hash instead of
 a JSON String. See PR [#76](https://github.com/procore/blueprinter/pull/76) by [@amayer171](https://github.com/amayer171) and Issue [#73](https://github.com/procore/blueprinter/issues/73).
 
 ## 0.3.0  - 2018/04/05
 
-Sort of a breaking Change. Serializer classes has been renamed to Extractor. To upgrade, if you passed in a specific serializer to `field` or `identifier` such as:
+💥 [BREAKING] Sort of a breaking Change. Serializer classes has been renamed to Extractor. To upgrade, if you passed in a specific serializer to `field` or `identifier` such as:
 
 ```
 field(:first_name, serializer: CustomSerializer)
@@ -54,19 +58,19 @@ Please rename that to:
 field(:first_name, extractor: CustomExtractor)
 ```
 
-* [ENHANCEMENT] Renamed Serializer classes to Extractor. See #72.
-* [ENHANCEMENT] Updated README. See pr [#66](https://github.com/procore/blueprinter/pull/66), [#65](https://github.com/procore/blueprinter/pull/65)
+* 💅 [ENHANCEMENT] Renamed Serializer classes to Extractor. See #72.
+* 💅 [ENHANCEMENT] Updated README. See pr [#66](https://github.com/procore/blueprinter/pull/66), [#65](https://github.com/procore/blueprinter/pull/65)
 
 ## 0.2.0  - 2018/01/22
 
-Breaking Changes. To upgrade, ensure that any associated objects have a blueprint. For example:
+💥 [BREAKING] Breaking Changes. To upgrade, ensure that any associated objects have a blueprint. For example:
 ```
 association :comments, blueprint: CommentsBlueprint
 ```
 
-* [BUGFIX] Remove Optimizer class. See [#61](https://github.com/procore/blueprinter/pull/61).
-* [BUGFIX] Require associated objects to have a Blueprint, so that objects will always serialize properly. See [#60](https://github.com/procore/blueprinter/pull/60).
+* 🐛 [BUGFIX] Remove Optimizer class. See [#61](https://github.com/procore/blueprinter/pull/61).
+* 🐛 [BUGFIX] Require associated objects to have a Blueprint, so that objects will always serialize properly. See [#60](https://github.com/procore/blueprinter/pull/60).
 
 ## 0.1.0  - 2018/01/17
 
-* [FEATURE] Initial release of Blueprinter
+* 🚀 [FEATURE] Initial release of Blueprinter

data/README.md

@@ -201,7 +201,7 @@ end
 
 class Project < ActiveRecord::Base
   has_many :tasks, as: :taskable
-  
+
   def blueprint
     ProjectBlueprint
   end
@@ -374,10 +374,19 @@ Output:
 }
 ```
 
-### Conditional field
+### Conditional fields
 
-`field` supports `:if` and `:unless` options argument that can be used to serialize the field conditionally.
+Both the `field` and the global Blueprinter Configuration supports `:if` and `:unless` options that can be used to serialize fields conditionally.
 
+#### Global Config Setting
+```ruby
+Blueprinter.configure do |config|
+  config.if = ->(obj, _options) { obj.is_a?(Foo) }
+  config.unless = ->(obj, _options) { obj.is_a?(Bar) }
+end
+```
+
+#### Field-level Setting
 ```ruby
 class UserBlueprint < Blueprinter::Base
   identifier :uuid
@@ -386,6 +395,8 @@ class UserBlueprint < Blueprinter::Base
 end
 ```
 
+The field-level setting overrides the global config setting (for the field) if both are set.
+
 ### Custom formatting for dates and times
 To define a custom format for a Date or DateTime field, include the option `datetime_format` with the associated `strptime` format.
 

data/lib/blueprinter/configuration.rb

@@ -1,16 +1,24 @@
 module Blueprinter
   class Configuration
-    attr_accessor :generator, :method, :sort_fields_by
+    attr_accessor :generator, :if, :method, :sort_fields_by, :unless
+
+    VALID_CALLABLES = %i(if unless).freeze
 
     def initialize
       @generator = JSON
+      @if = nil
       @method = :generate
       @sort_fields_by = :name_asc
+      @unless = nil
     end
 
     def jsonify(blob)
       generator.public_send(method, blob)
     end
+
+    def valid_callable?(callable_name)
+      VALID_CALLABLES.include?(callable_name)
+    end
   end
 
   def self.configuration

data/lib/blueprinter/field.rb

@@ -30,15 +30,23 @@ class Blueprinter::Field
     @unless_callable = callable_from(:unless)
   end
 
-  def callable_from(option_name)
-    return false unless options.key?(option_name)
+  def callable_from(condition)
+    config = Blueprinter.configuration
+
+    # 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
+
+    return false unless tmp
 
-    tmp = options.fetch(option_name)
     case tmp
     when Proc then tmp
     when Symbol then blueprint.method(tmp)
     else
-      raise ArgumentError, "#{tmp.class} is passed to :#{option_name}"
+      raise ArgumentError, "#{tmp.class} is passed to :#{condition}"
     end
   end
 end

data/lib/blueprinter/version.rb

@@ -1,3 +1,3 @@
 module Blueprinter
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Adam Hess
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-14 00:00:00.000000000 Z
+date: 2019-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot