blueprinter 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72efd8dd2ec9f959aa0a4ab79db6aca9a8654ea7a66474524fdfb49277fbd315
-  data.tar.gz: b04bc7182d997999f0bf30babe1abb5ad9bd8f35206cc0648f00cae4026d6900
+  metadata.gz: b1a0e758e71974ab97aac018c58a8fb143cedcbb0cbdfc60c62fb06050defecd
+  data.tar.gz: 455ff66f83def7e8aad7bb35df752580e664499ac3cb872c6354cacc9b881f9e
 SHA512:
-  metadata.gz: af5cd971e59e741c3edf95a5778f2462c679769bf4e95ba37f725fd8508f765bc296d5fd0412c8cbb1cbee41b213bd5f7a0c2b46f3c3b9ec63fb02c82acfac7b
-  data.tar.gz: 418d5b106f804d9e11dede74cc89cf03c9734a0b15ef31a5cf8554b2ba0fd9e7e3515db3e3b15f2fee2e21c484c962cae03967bcd55990e9a5690fc04f50bdc2
+  metadata.gz: f1a697280e9f1da3ab3c59053449c965fc4785c077c6b336291451adc6dbdfa13876989c93ace254ae2545ec9cb0ff4cc5c7d9f64211d34d77a6539217b2c178
+  data.tar.gz: 8bc59b0805ea6bda87dd948677f8a375c321fc7d0a880882d13e4a34d5b6a844dc6c3916bd9b2913b58c3b349844f8dc86357bdf7a879c35764137c8dff65f9d

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.6.0  - 2018/06/05
+
+* [FEATURE] Add `date_time` format as an option to `field`. Please see pr #68. Thanks to @njbbaer.
+* [FEATURE] Add conditional field support `:unless` and `:if` as an option to `field`. Please see pr #86. Thanks to @ojab.
+* [BUGFIX] Fix case where miscellaneous options were not being passed through the `AutoExtractor`. See pr #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.

data/README.md

@@ -42,7 +42,7 @@ And the output would look like:
 ```
 
 ### Views
-You may define different ouputs by utilizing views:
+You may define different outputs by utilizing views:
 ```ruby
 class UserBlueprint < Blueprinter::Base
   identifier :uuid
@@ -190,6 +190,25 @@ Output:
 }
 ```
 
+### 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.
+
+Usage:
+```ruby
+class UserBlueprint < Blueprinter::Base
+  identifier :name
+  field :birthday, datetime_format: "%m/%d/%Y"
+end
+```
+
+Output:
+```json
+{
+  "name": "John Doe",
+  "birthday": "03/04/1994"
+}
+```
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/lib/blueprinter/base.rb

@@ -37,7 +37,7 @@ module Blueprinter
     #
     # @return [Field] A Field object
     def self.identifier(method, name: method, extractor: AutoExtractor)
-      view_collection[:identifier] << Field.new(method, name, extractor)
+      view_collection[:identifier] << Field.new(method, name, extractor, self)
     end
 
     # Specify a field or method name to be included for serialization.
@@ -53,6 +53,16 @@ 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 [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 }).
+    #   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 }).
+    #   The method, proc or string should return or evaluate to a true or false value.
     # @yield [Object] The object passed to `render` is also passed to the
     #   block.
     #
@@ -68,6 +78,17 @@ module Blueprinter
     #     # other code
     #   end
     #
+    # @example Passing an if proc and unless method..
+    #   class UserBlueprint < Blueprinter::Base
+    #     def skip_first_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] }
+    #     # other code
+    #   end
+    #
     # @return [Field] A Field object
     def self.field(method, options = {}, &block)
       options = if block_given?
@@ -78,6 +99,7 @@ module Blueprinter
       current_view << Field.new(method,
                                 options[:name],
                                 options[:extractor],
+                                self,
                                 options)
     end
 
@@ -107,6 +129,7 @@ module Blueprinter
       current_view << Field.new(method,
                                        name,
                                        AssociationExtractor,
+                                       self,
                                        options.merge(association: true))
     end
 
@@ -163,7 +186,6 @@ module Blueprinter
       unless view_collection.has_view? view_name
         raise BlueprinterError, "View '#{view_name}' is not defined"
       end
-      fields = view_collection.fields_for(view_name)
       prepared_object = include_associations(object, view_name: view_name)
       if array_like?(object)
         prepared_object.map do |obj|
@@ -193,7 +215,7 @@ module Blueprinter
     # @return [Array<Symbol>] an array of field names
     def self.fields(*field_names)
       field_names.each do |field_name|
-        current_view << Field.new(field_name, field_name, AutoExtractor)
+        current_view << Field.new(field_name, field_name, AutoExtractor, self)
       end
     end
 
@@ -270,6 +292,7 @@ module Blueprinter
 
     def self.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)
         hash[field.name] = field.extract(object, local_options)
       end
     end

data/lib/blueprinter/extractors/auto_extractor.rb

@@ -2,7 +2,16 @@ module Blueprinter
   class AutoExtractor < Extractor
     def extract(field_name, object, local_options, options = {})
       extractor = object.is_a?(Hash) ? HashExtractor : PublicSendExtractor
-      extractor.extract(field_name, object, local_options, options = {})
+      extraction = extractor.extract(field_name, object, local_options, options)
+      options.key?(:datetime_format) ? format_datetime(extraction, options[:datetime_format]) : extraction
+    end
+
+    private
+
+    def format_datetime(datetime, format)
+      datetime.strftime(format)
+    rescue NoMethodError
+      raise BlueprinterError, 'Cannot format invalid DateTime object'
     end
   end
 end

data/lib/blueprinter/field.rb

@@ -1,14 +1,44 @@
 # @api private
 class Blueprinter::Field
-  attr_reader :method, :name, :extractor, :options
-  def initialize(method, name, extractor, options = {})
+  attr_reader :method, :name, :extractor, :options, :blueprint
+  def initialize(method, name, extractor, blueprint, options = {})
     @method = method
     @name = name
     @extractor = extractor
+    @blueprint = blueprint
     @options = options
   end
 
   def extract(object, local_options)
     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)
+  end
+
+  private
+
+  def if_callable
+    return @if_callable unless @if_callable.nil?
+    @if_callable ||= callable_from(:if)
+  end
+
+  def unless_callable
+    return @unless_callable unless @unless_callable.nil?
+    @unless_callable ||= callable_from(:unless)
+  end
+
+  def callable_from(option_name)
+    return false unless options.key?(option_name)
+
+    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}"
+    end
+  end
 end

data/lib/blueprinter/version.rb

@@ -1,3 +1,3 @@
 module Blueprinter
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Adam Hess
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-15 00:00:00.000000000 Z
+date: 2018-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri