blueprinter 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1a0e758e71974ab97aac018c58a8fb143cedcbb0cbdfc60c62fb06050defecd
-  data.tar.gz: 455ff66f83def7e8aad7bb35df752580e664499ac3cb872c6354cacc9b881f9e
+  metadata.gz: 7305adc0699ba1c10026b7dbfc2de138d85b7e05f19de91d70fd10069bf274b1
+  data.tar.gz: a15a1d19a578a472c3cc91228070ff32441137e57b241571578e72ba89a5f892
 SHA512:
-  metadata.gz: f1a697280e9f1da3ab3c59053449c965fc4785c077c6b336291451adc6dbdfa13876989c93ace254ae2545ec9cb0ff4cc5c7d9f64211d34d77a6539217b2c178
-  data.tar.gz: 8bc59b0805ea6bda87dd948677f8a375c321fc7d0a880882d13e4a34d5b6a844dc6c3916bd9b2913b58c3b349844f8dc86357bdf7a879c35764137c8dff65f9d
+  metadata.gz: f93a3442dd563f3f929e8d1964a320823819a2ef8bc4aa292751caa35bd33c2dfe74716e49f38bf856d594ebe12251fa4ca0f9ecde01ea7fe2a564f3c9e2a375
+  data.tar.gz: 3ffea695ddd219bd1ec1721853c9a519159d883c31259545440511b8700b82dddc1b9e55595cd886c808f2b09aacf9e47f41e6b65efd7f8034b512c3576d0061

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.7.0  - 2018/10/17
+
+* [FEATURE] Allow associations to be defined with a block. Please see pr #106. Thanks to @hugopeixoto.
+* [FEATURE] Inherit view definition when using inheritance. Please see pr #105. Thanks to @hugopeixoto.
+
+
 ## 0.6.0  - 2018/06/05
 
 * [FEATURE] Add `date_time` format as an option to `field`. Please see pr #68. Thanks to @njbbaer.

data/README.md

@@ -41,6 +41,30 @@ And the output would look like:
 }
 ```
 
+### Renaming
+
+You can rename the resulting JSON keys in both fields and associations by using the `name` option.
+
+```ruby
+class UserBlueprint < Blueprinter::Base
+  identifier :uuid
+
+  field :email, name: :login
+
+  association :user_projects, name: :projects
+end
+```
+
+This will result in JSON that looks something like this:
+
+```json
+{
+  "uuid": "92a5c732-2874-41e4-98fc-4123cd6cfa86",
+  "login": "my@email.com",
+  "projects": []
+}
+```
+
 ### Views
 You may define different outputs by utilizing views:
 ```ruby
@@ -162,6 +186,44 @@ Output:
 }
 ```
 
+#### Defining an association directly in the Blueprint
+
+You can also pass a block to an association:
+
+```ruby
+class ProjectBlueprint < Blueprinter::Base
+  identifier :uuid
+  field :name
+end
+
+class UserBlueprint < Blueprinter::Base
+  identifier :uuid
+
+  association :projects, blueprint: ProjectBlueprint do |user|
+    user.projects + user.company.projects
+  end
+end
+```
+
+Usage:
+
+```ruby
+puts UserBlueprint.render(user)
+```
+
+Output:
+
+```json
+{
+  "uuid": "733f0758-8f21-4719-875f-262c3ec743af",
+  "projects": [
+    {"uuid": "b426a1e6-ac41-45ab-bfef-970b9a0b4289", "name": "query-console"},
+    {"uuid": "5bd84d6c-4fd2-4e36-ae31-c137e39be542", "name": "blueprinter"},
+    {"uuid": "785f5cd4-7d8d-4779-a6dd-ec5eab440eff", "name": "uncontrollable"}
+  ]
+}
+```
+
 ### Passing additional properties to `render`
 
 `render` takes an options hash which you can pass additional properties, allowing you to utilize those additional properties in the `field` block. For example:
@@ -190,6 +252,18 @@ Output:
 }
 ```
 
+### Conditional field
+
+`field` supports `:if` and `:unless` options argument that can be used to serialize the field conditionally.
+
+```ruby
+class UserBlueprint < Blueprinter::Base
+  identifier :uuid
+  field :last_name, if: ->(user, options) { user.first_name != options[:first_name] }
+  field :age, unless: ->(user, _options) { user.age < 18 }
+end
+```
+
 ### 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.
 
@@ -267,5 +341,8 @@ We use Yard for documentation. Here are the following documentation rules:
 - Document all public methods we expect to be utilized by the end developers.
 - Methods that are not set to private due to ruby visibility rule limitations should be marked with `@api private`.
 
+### Releasing a New Version
+To release a new version, change the version number in `version.rb`, and update the `CHANGELOG.md`. Finally, maintainers need to run `bundle exec rake release`, which will automatically create a git tag for the version, push git commits and tags to Github, and push the `.gem` file to rubygems.org.
+
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -18,7 +18,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
 end
 
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = '--pattern spec/**/*_spec.rb'
+  t.rspec_opts = '--pattern spec/**/*_spec.rb --warnings'
 end
 
 Rake::TestTask.new(:benchmarks) do |t|

data/lib/blueprinter.rb

@@ -1,4 +1,3 @@
-require_relative 'blueprinter/configuration'
 require_relative 'blueprinter/base'
 
 module Blueprinter

data/lib/blueprinter/base.rb

@@ -1,5 +1,5 @@
 require_relative 'blueprinter_error'
-require_relative 'helpers/active_record_helpers'
+require_relative 'configuration'
 require_relative 'extractor'
 require_relative 'extractors/association_extractor'
 require_relative 'extractors/auto_extractor'
@@ -7,6 +7,7 @@ require_relative 'extractors/block_extractor'
 require_relative 'extractors/hash_extractor'
 require_relative 'extractors/public_send_extractor'
 require_relative 'field'
+require_relative 'helpers/active_record_helpers'
 require_relative 'view'
 require_relative 'view_collection'
 
@@ -36,10 +37,14 @@ module Blueprinter
     #   end
     #
     # @return [Field] A Field object
-    def self.identifier(method, name: method, extractor: AutoExtractor)
+    def self.identifier(method, name: method, extractor: AutoExtractor.new)
       view_collection[:identifier] << Field.new(method, name, extractor, self)
     end
 
+    def self.inherited(subclass)
+      subclass.send(:view_collection).inherit(view_collection)
+    end
+
     # Specify a field or method name to be included for serialization.
     # Takes a required method and an option.
     #
@@ -92,9 +97,9 @@ module Blueprinter
     # @return [Field] A Field object
     def self.field(method, options = {}, &block)
       options = if block_given?
-        {name: method, extractor: BlockExtractor, block: {method => block}}
+        {name: method, extractor: BlockExtractor.new, block: block}
       else
-        {name: method, extractor: AutoExtractor}
+        {name: method, extractor: AutoExtractor.new}
       end.merge(options)
       current_view << Field.new(method,
                                 options[:name],
@@ -114,6 +119,8 @@ module Blueprinter
     #   JSON output.
     # @option options [Symbol] :view Specify the view to use or fall back to
     #   to the :default view.
+    # @yield [Object] The object passed to `render` is also passed to the
+    #   block.
     #
     # @example Specifying an association
     #   class UserBlueprint < Blueprinter::Base
@@ -122,15 +129,29 @@ module Blueprinter
     #     # code
     #   end
     #
+    # @example Passing a block to be evaluated as the value.
+    #   class UserBlueprint < Blueprinter::Base
+    #     association :vehicles, blueprint: VehiclesBlueprint do |user|
+    #       user.vehicles + user.company.vehicles
+    #     end
+    #   end
+    #
     # @return [Field] A Field object
-    def self.association(method, options = {})
+    def self.association(method, options = {}, &block)
       raise BlueprinterError, 'blueprint required' unless options[:blueprint]
       name = options.delete(:name) || method
+
+      options = if block_given?
+        options.merge(extractor: BlockExtractor.new, block: block)
+      else
+        options.merge(extractor: AutoExtractor.new)
+      end
+
       current_view << Field.new(method,
-                                       name,
-                                       AssociationExtractor,
-                                       self,
-                                       options.merge(association: true))
+                                name,
+                                AssociationExtractor.new,
+                                self,
+                                options.merge(association: true))
     end
 
     # Generates a JSON formatted String.
@@ -215,7 +236,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, self)
+        field(field_name)
       end
     end
 

data/lib/blueprinter/extractor.rb

@@ -1,9 +1,6 @@
 # @api private
 module Blueprinter
   class Extractor
-    def initialize
-    end
-
     def extract(field_name, object, local_options, options={})
       fail NotImplementedError, "An Extractor must implement #extract"
     end

data/lib/blueprinter/extractors/association_extractor.rb

@@ -1,8 +1,8 @@
 module Blueprinter
   class AssociationExtractor < Extractor
     def extract(association_name, object, local_options, options={})
-      value = object.public_send(association_name)
-      return (value || options[:default]) if value.nil?
+      value = options[:extractor].extract(association_name, object, local_options, options)
+      return options[:default] if value.nil?
       view = options[:view] || :default
       options[:blueprint].prepare(value, view_name: view, local_options: local_options)
     end

data/lib/blueprinter/extractors/auto_extractor.rb

@@ -1,7 +1,12 @@
 module Blueprinter
   class AutoExtractor < Extractor
+    def initialize
+      @hash_extractor = HashExtractor.new
+      @public_send_extractor = PublicSendExtractor.new
+    end
+
     def extract(field_name, object, local_options, options = {})
-      extractor = object.is_a?(Hash) ? HashExtractor : PublicSendExtractor
+      extractor = object.is_a?(Hash) ? @hash_extractor : @public_send_extractor
       extraction = extractor.extract(field_name, object, local_options, options)
       options.key?(:datetime_format) ? format_datetime(extraction, options[:datetime_format]) : extraction
     end

data/lib/blueprinter/extractors/block_extractor.rb

@@ -1,7 +1,7 @@
 module Blueprinter
   class BlockExtractor < Extractor
     def extract(field_name, object, local_options, options = {})
-      options[:block][field_name].call(object, local_options)
+      options[:block].call(object, local_options)
     end
   end
 end

data/lib/blueprinter/field.rb

@@ -21,13 +21,13 @@ class Blueprinter::Field
   private
 
   def if_callable
-    return @if_callable unless @if_callable.nil?
-    @if_callable ||= callable_from(:if)
+    return @if_callable if defined?(@if_callable)
+    @if_callable = callable_from(:if)
   end
 
   def unless_callable
-    return @unless_callable unless @unless_callable.nil?
-    @unless_callable ||= callable_from(:unless)
+    return @unless_callable if defined?(@unless_callable)
+    @unless_callable = callable_from(:unless)
   end
 
   def callable_from(option_name)

data/lib/blueprinter/version.rb

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

data/lib/blueprinter/view.rb

@@ -10,6 +10,20 @@ module Blueprinter
       @excluded_field_names = excluded_view_names
     end
 
+    def inherit(view)
+      view.fields.values.each do |field|
+        self << field
+      end
+
+      view.included_view_names.each do |view_name|
+        include_view(view_name)
+      end
+
+      view.excluded_field_names.each do |field_name|
+        exclude_field(field_name)
+      end
+    end
+
     def include_view(view_name)
       included_view_names << view_name
     end
@@ -19,10 +33,6 @@ module Blueprinter
     end
 
     def <<(field)
-      if fields.has_key?(field.name)
-        raise BlueprinterError,
-          "Field #{field.name} already defined on #{name}"
-      end
       fields[field.name] = field
     end
   end

data/lib/blueprinter/view_collection.rb

@@ -9,6 +9,12 @@ module Blueprinter
       }
     end
 
+    def inherit(view_collection)
+      view_collection.views.each do |view_name, view|
+        self[view_name].inherit(view)
+      end
+    end
+
     def has_view?(view_name)
       views.has_key? view_name
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Adam Hess
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-05 00:00:00.000000000 Z
+date: 2018-10-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -54,7 +68,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -159,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Simple Fast Declarative Serialization Library