blueprinter 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1df67b25b05137cc97ddd5e8c0db7430086d3ea9dddd7ab2164944dba191fddc
-  data.tar.gz: d1e9a05b61be95ef8a4d627fb6908db38975d6f321cf325a13bb93a7402a03b8
+  metadata.gz: a3d1968ce7648f29d301d61dd92a016b0a6ca65a515ad7ee196a4b6958634d3d
+  data.tar.gz: b8abfa3db3801439ff6405ec695863913081cdb0c339f983279cfad75812d867
 SHA512:
-  metadata.gz: 4f2c771da50005f7a8d886bf1318f5d00069b76d1c96b78dc3ef14162272278ecddec09e6735d73a8946be7c8229ae2bc96f158a1978e53b1f99d1763b04509b
-  data.tar.gz: ed2a05555940425a7847028f85084f0a4fe3a2c063ea480d9e179931f792900ababe0f0d0230050441da87c9bcb3137b1151f9c393838123e80365873ff86dc8
+  metadata.gz: 41f969a27e181dd1a6e7534223eb5419e7a5c279c97a4f2da4e775c0ec05b4cfac30aa2a102891331b29ef4b644424fefece493abf90b743cca9b9ebbaff1390
+  data.tar.gz: 187e6c5af1f43aab7b5043cb86dc3bea9dd705397eaae0888747a429ea7a4d903a6631eb35940a43960c7070b9a8297ecf236795ddaad4ecacae09b59c1735d4

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.15.0  - 2019/04/1
+* 🚀 [FEATURE] Add ability to pass in `datetime_format` field option as either a string representing the strptime format, or a Proc which takes in the Date or DateTime object and returns the formatted date. [#145](https://github.com/procore/blueprinter/pull/145). Thanks to [@mcclayton](https://github.com/mcclayton).
+
 ## 0.14.0  - 2019/04/01
 * 🚀 [FEATURE] Added a global `datetime_format` option. [#135](https://github.com/procore/blueprinter/pull/143). Thanks to [@ritikesh](https://github.com/ritikesh).
 

data/README.md

@@ -148,7 +148,7 @@ puts UserBlueprint.render(user, view: :normal, root: :user)
 
 Output:
 ```json
-{ 
+{
   "user": {
     "uuid": "733f0758-8f21-4719-875f-262c3ec743af",
     "first_name": "John",
@@ -182,7 +182,7 @@ puts json
 
 Output:
 ```json
-{ 
+{
   "user": {
     "uuid": "733f0758-8f21-4719-875f-262c3ec743af",
     "first_name": "John",
@@ -197,7 +197,7 @@ Output:
   }
 }
 ```
-Note: For meta attributes, a [root](#root) is mandatory.
+_NOTE:_ For meta attributes, a [root](#root) is mandatory.
 
 ### Exclude fields
 You can specifically choose to exclude certain fields for specific views
@@ -324,7 +324,7 @@ class TaskBlueprint < Blueprinter::Base
   end
 end
 ```
-Note: `taskable.blueprint` should return a valid Blueprint class. Currently, `has_many` is not supported because of the very nature of polymorphic associations.
+_NOTE:_ `taskable.blueprint` should return a valid Blueprint class. Currently, `has_many` is not supported because of the very nature of polymorphic associations.
 
 ### Defining a field directly in the Blueprint
 
@@ -503,12 +503,26 @@ class UserBlueprint < Blueprinter::Base
 end
 ```
 
-The field-level setting overrides the global config setting (for the field) if both are set.
+_NOTE:_ 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.
+To define a custom format for a Date or DateTime field, include the option `datetime_format`.
+This global or field-level option can be either a string representing the associated `strptime` format,
+or a Proc which receives the original Date/DateTime object and returns the formatted value.
+When using a Proc, it is the Proc's responsibility to handle any errors in formatting.
 
-Usage:
+
+#### Global Config Setting
+If a global datetime_format is set (either as a string format or a Proc), this option will be
+invoked and used to format all fields that respond to `strptime`.
+```ruby
+Blueprinter.configure do |config|
+  config.datetime_format = ->(datetime) { datetime.nil? ? datetime : datetime.strftime("%s").to_i }
+end
+```
+
+#### Field-level Setting
+Usage (String Option):
 ```ruby
 class UserBlueprint < Blueprinter::Base
   identifier :name
@@ -524,6 +538,24 @@ Output:
 }
 ```
 
+Usage (Proc Option):
+```ruby
+class UserBlueprint < Blueprinter::Base
+  identifier :name
+  field :birthday, datetime_format: ->(datetime) { datetime.nil? ? datetime : datetime.strftime("%s").to_i }
+end
+```
+
+Output:
+```json
+{
+  "name": "John Doe",
+  "birthday": 762739200
+}
+```
+
+_NOTE:_ The field-level setting overrides the global config setting (for the field) if both are set.
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -603,7 +635,7 @@ Blueprinter.configure do |config|
 end
 ```
 
-Note: You should be doing this only if you aren't using `yajl-ruby` through the JSON API by requiring `yajl/json_gem`. More details [here](https://github.com/brianmario/yajl-ruby#json-gem-compatibility-api). In this case, `JSON.generate` is patched to use `Yajl::Encoder.encode` internally.
+_NOTE:_ You should be doing this only if you aren't using `yajl-ruby` through the JSON API by requiring `yajl/json_gem`. More details [here](https://github.com/brianmario/yajl-ruby#json-gem-compatibility-api). In this case, `JSON.generate` is patched to use `Yajl::Encoder.encode` internally.
 
 ## How to Document
 

data/lib/blueprinter/base.rb

@@ -71,8 +71,11 @@ module Blueprinter
     # @option options [Symbol] :name Use this to rename the method. Useful if
     #   if you want your JSON key named differently in the output than your
     #   object's field or method name.
-    # @option options [String] :datetime_format Format Date or DateTime object
-    #   with given strftime formatting
+    # @option options [String,Proc] :datetime_format Format Date or DateTime object
+    #   If the option provided is a String, the object will be formatted with given strftime
+    #   formatting.
+    #   If this option is a Proc, the object will be formatted by calling the provided Proc
+    #   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 }).
@@ -171,7 +174,7 @@ module Blueprinter
     # @option options [Symbol|String] :root Defaults to nil.
     #   Render the json/hash with a root key if provided.
     # @option options [Any] :meta Defaults to nil.
-    #   Render the json/hash with a meta attribute with provided value 
+    #   Render the json/hash with a meta attribute with provided value
     #   if both root and meta keys are provided in the options hash.
     #
     # @example Generating JSON with an extended view
@@ -196,7 +199,7 @@ module Blueprinter
     # @option options [Symbol|String] :root Defaults to nil.
     #   Render the json/hash with a root key if provided.
     # @option options [Any] :meta Defaults to nil.
-    #   Render the json/hash with a meta attribute with provided value 
+    #   Render the json/hash with a meta attribute with provided value
     #   if both root and meta keys are provided in the options hash.
     #
     # @example Generating a hash with an extended view
@@ -221,7 +224,7 @@ module Blueprinter
     # @option options [Symbol|String] :root Defaults to nil.
     #   Render the json/hash with a root key if provided.
     # @option options [Any] :meta Defaults to nil.
-    #   Render the json/hash with a meta attribute with provided value 
+    #   Render the json/hash with a meta attribute with provided value
     #   if both root and meta keys are provided in the options hash.
     #
     # @example Generating a hash with an extended view

data/lib/blueprinter/extractors/auto_extractor.rb

@@ -9,7 +9,6 @@ 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
     end

data/lib/blueprinter/formatters/date_time_formatter.rb

@@ -1,13 +1,15 @@
 module Blueprinter
   class DateTimeFormatter
+    InvalidDateTimeFormatterError = Class.new(BlueprinterError)
+
     def format(value, options)
       return value if value.nil?
-      
+
       field_format = options[:datetime_format]
       if value.respond_to?(:strftime)
         value = format_datetime(value, field_format)
       elsif field_format
-        raise BlueprinterError, 'Cannot format invalid DateTime object'
+        raise InvalidDateTimeFormatterError, 'Cannot format invalid DateTime object'
       end
       value
     end
@@ -16,7 +18,14 @@ module Blueprinter
 
     def format_datetime(value, field_format)
       format = field_format || Blueprinter.configuration.datetime_format
-      format.nil? ? value : value.strftime(format)
+
+      case format
+      when NilClass then value
+      when Proc then format.call(value)
+      when String then value.strftime(format)
+      else
+        raise InvalidDateTimeFormatterError, 'Cannot format DateTime object with invalid formatter: #{format.class}'
+      end
     end
   end
 end

data/lib/blueprinter/version.rb

@@ -1,3 +1,3 @@
 module Blueprinter
-  VERSION = '0.14.0'
+  VERSION = '0.15.0'
 end

metadata

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