blueprinter 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6e7d939f775eceed008783088ae2e73481798aaf
-  data.tar.gz: 9c013582657eef9da0e37533e933058253803109
+SHA256:
+  metadata.gz: 2924df0d9994662334f417cc9cda5b05863152bad025bb7193e19f95ec6d448b
+  data.tar.gz: 8eb870216b6535ed26793b97d2b3cc0aaeec224894dbbf4e0582e9369a70a7e7
 SHA512:
-  metadata.gz: 7f1947a5d7d6155aabe3fa0a2388f3e24bd2c447d78d1bd3b6ce1d639831b4eff95047851dff5226854fce1eaa0a6e0f99bfbd7b1467f0a6cc450ee11af4b61a
-  data.tar.gz: bf51f3e711eb499beaf4bc343a03dcd7401159487528d22211502ea388dbb60498fc50b9de9ec51df23e3eaa6319fd018658d6be699766d6f960eb7252120605
+  metadata.gz: ff5834c72d06aca41d2f2cf6d309015af5dea83ea66d008da8f5de980162676e0131612a6dfa2a93e5bd14f6deb82c39d8f96e468181bb57b30219f668a45128
+  data.tar.gz: f716a6124b91d751c0f9bbdfd248f0b4ccedcd98548ed1572173d1166cfb2d912691f927e707499f0c113d1b62330340ce5f64198251899c404e0e83ff2de428

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 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:
+
+```
+field(:first_name, serializer: CustomSerializer)
+```
+
+Please rename that to:
+
+```
+field(:first_name, extractor: CustomExtractor)
+```
+
+* [ENHANCEMENT] Renamed Serializer classes to Extractor. See #72.
+* [ENHANCEMENT] Updated README. See #66, #65
+
 ## 0.2.0  - 2018/01/22
 
 Breaking Changes. To upgrade, ensure that any associated objects have a blueprint. For example:

data/README.md

@@ -1,13 +1,15 @@
 [![CircleCI](https://circleci.com/gh/procore/blueprinter.svg?style=svg)](https://circleci.com/gh/procore/blueprinter)
 [![Gem Version](https://badge.fury.io/rb/blueprinter.svg)](https://badge.fury.io/rb/blueprinter)
 
+<img src="blueprinter_logo.svg" width="25%">
+
 # Blueprinter
 Blueprinter is a JSON Object Presenter for Ruby that takes business objects and breaks them down into simple hashes and serializes them to JSON. It can be used in Rails in place of other serializers (like JBuilder or ActiveModelSerializers). It is designed to be simple, direct, and performant.
 
 It heavily relies on the idea of `views` which, similar to Rails views, are ways of predefining output for data in different contexts.
 
 ## Documentation
-!TODO Link to the docs
+Docs can be found [here](http://www.rubydoc.info/gems/blueprinter).
 
 ## Usage
 ### Basic
@@ -95,7 +97,7 @@ end
 
 Usage:
 ```ruby
-puts UserBlueprint.render(user, view: :extended)
+puts UserBlueprint.render(user, view: :normal)
 ```
 
 Output:
@@ -212,7 +214,7 @@ Ensure that you have the `Oj` gem installed in your Gemfile if you haven't alrea
 gem 'oj'
 ```
 
-## Documentation
+## How to Document
 
 We use [Yard](https://yardoc.org/) for documentation. Here are the following
 documentation rules:

data/lib/blueprinter/base.rb

@@ -1,11 +1,11 @@
 require_relative 'blueprinter_error'
 require_relative 'helpers/active_record_helpers'
-require_relative 'serializer'
-require_relative 'serializers/association_serializer'
-require_relative 'serializers/auto_serializer'
-require_relative 'serializers/block_serializer'
-require_relative 'serializers/hash_serializer'
-require_relative 'serializers/public_send_serializer'
+require_relative 'extractor'
+require_relative 'extractors/association_extractor'
+require_relative 'extractors/auto_extractor'
+require_relative 'extractors/block_extractor'
+require_relative 'extractors/hash_extractor'
+require_relative 'extractors/public_send_extractor'
 require_relative 'field'
 require_relative 'view'
 require_relative 'view_collection'
@@ -24,10 +24,10 @@ module Blueprinter
     #   want to set for serialization.
     # @param name [Symbol] to rename the identifier key in the JSON
     #   output. Defaults to method given.
-    # @param serializer [AssociationSerializer,AutoSerializer,BlockSerializer,HashSerializer,PublicSendSerializer]
-    #   Kind of serializer to use.
-    #   Either define your own or use Blueprinter's premade serializers.
-    #   Defaults to AutoSerializer
+    # @param extractor [AssociationExtractor,AutoExtractor,BlockExtractor,HashExtractor,PublicSendExtractor]
+    #   Kind of extractor to use.
+    #   Either define your own or use Blueprinter's premade extractors.
+    #   Defaults to AutoExtractor
     #
     # @example Specifying a uuid as an identifier.
     #   class UserBlueprint < Blueprinter::Base
@@ -36,8 +36,8 @@ module Blueprinter
     #   end
     #
     # @return [Field] A Field object
-    def self.identifier(method, name: method, serializer: AutoSerializer)
-      view_collection[:identifier] << Field.new(method, name, serializer)
+    def self.identifier(method, name: method, extractor: AutoExtractor)
+      view_collection[:identifier] << Field.new(method, name, extractor)
     end
 
     # Specify a field or method name to be included for serialization.
@@ -46,10 +46,10 @@ module Blueprinter
     # @param method [Symbol] the field or method name you want to include for
     #   serialization.
     # @param options [Hash] options to overide defaults.
-    # @option options [AssociationSerializer,BlockSerializer,HashSerializer,PublicSendSerializer] :serializer
-    #   Kind of serializer to use.
-    #   Either define your own or use Blueprinter's premade serializers. The
-    #   Default serializer is AutoSerializer
+    # @option options [AssociationExtractor,BlockExtractor,HashExtractor,PublicSendExtractor] :extractor
+    #   Kind of extractor to use.
+    #   Either define your own or use Blueprinter's premade extractors. The
+    #   Default extractor is AutoExtractor
     # @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.
@@ -71,13 +71,13 @@ module Blueprinter
     # @return [Field] A Field object
     def self.field(method, options = {}, &block)
       options = if block_given?
-        {name: method, serializer: BlockSerializer, block: {method => block}}
+        {name: method, extractor: BlockExtractor, block: {method => block}}
       else
-        {name: method, serializer: AutoSerializer}
+        {name: method, extractor: AutoExtractor}
       end.merge(options)
       current_view << Field.new(method,
                                 options[:name],
-                                options[:serializer],
+                                options[:extractor],
                                 options)
     end
 
@@ -106,7 +106,7 @@ module Blueprinter
       name = options.delete(:name) || method
       current_view << Field.new(method,
                                        name,
-                                       AssociationSerializer,
+                                       AssociationExtractor,
                                        options.merge(association: true))
     end
 
@@ -172,7 +172,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, AutoSerializer)
+        current_view << Field.new(field_name, field_name, AutoExtractor)
       end
     end
 
@@ -249,7 +249,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|
-        hash[field.name] = field.serialize(object, local_options)
+        hash[field.name] = field.extract(object, local_options)
       end
     end
     private_class_method :object_to_hash

data/lib/blueprinter/extractor.rb

@@ -0,0 +1,15 @@
+# @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
+
+    def self.extract(field_name, object, local_options, options={})
+      self.new.extract(field_name, object, local_options, options)
+    end
+  end
+end

data/lib/blueprinter/extractors/association_extractor.rb

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

data/lib/blueprinter/extractors/auto_extractor.rb

@@ -0,0 +1,8 @@
+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 = {})
+    end
+  end
+end

data/lib/blueprinter/extractors/block_extractor.rb

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

data/lib/blueprinter/extractors/hash_extractor.rb

@@ -0,0 +1,7 @@
+module Blueprinter
+  class HashExtractor < Extractor
+    def extract(field_name, object, local_options, options = {})
+      object[field_name] || object[field_name.to_s]
+    end
+  end
+end

data/lib/blueprinter/extractors/public_send_extractor.rb

@@ -0,0 +1,7 @@
+module Blueprinter
+  class PublicSendExtractor < Extractor
+    def extract(field_name, object, local_options, options = {})
+      object.public_send(field_name)
+    end
+  end
+end

data/lib/blueprinter/field.rb

@@ -1,14 +1,14 @@
 # @api private
 class Blueprinter::Field
-  attr_reader :method, :name, :serializer, :options
-  def initialize(method, name, serializer, options = {})
+  attr_reader :method, :name, :extractor, :options
+  def initialize(method, name, extractor, options = {})
     @method = method
     @name = name
-    @serializer = serializer
+    @extractor = extractor
     @options = options
   end
 
-  def serialize(object, local_options)
-    serializer.serialize(method, object, local_options, options)
+  def extract(object, local_options)
+    extractor.extract(method, object, local_options, options)
   end
 end

data/lib/blueprinter/version.rb

@@ -1,3 +1,3 @@
 module Blueprinter
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Adam Hess
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-22 00:00:00.000000000 Z
+date: 2018-04-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -113,14 +127,14 @@ files:
 - lib/blueprinter/base.rb
 - lib/blueprinter/blueprinter_error.rb
 - lib/blueprinter/configuration.rb
+- lib/blueprinter/extractor.rb
+- lib/blueprinter/extractors/association_extractor.rb
+- lib/blueprinter/extractors/auto_extractor.rb
+- lib/blueprinter/extractors/block_extractor.rb
+- lib/blueprinter/extractors/hash_extractor.rb
+- lib/blueprinter/extractors/public_send_extractor.rb
 - lib/blueprinter/field.rb
 - lib/blueprinter/helpers/active_record_helpers.rb
-- lib/blueprinter/serializer.rb
-- lib/blueprinter/serializers/association_serializer.rb
-- lib/blueprinter/serializers/auto_serializer.rb
-- lib/blueprinter/serializers/block_serializer.rb
-- lib/blueprinter/serializers/hash_serializer.rb
-- lib/blueprinter/serializers/public_send_serializer.rb
 - lib/blueprinter/version.rb
 - lib/blueprinter/view.rb
 - lib/blueprinter/view_collection.rb
@@ -145,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Simple Fast Declarative Serialization Library

data/lib/blueprinter/serializer.rb

@@ -1,13 +0,0 @@
-# @api private
-class Blueprinter::Serializer
-  def initialize
-  end
-
-  def serialize(field_name, object, local_options, options={})
-    fail NotImplementedError, "A serializer must implement #serialize"
-  end
-
-  def self.serialize(field_name, object, local_options, options={})
-    self.new.serialize(field_name, object, local_options, options)
-  end
-end

data/lib/blueprinter/serializers/association_serializer.rb

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

data/lib/blueprinter/serializers/auto_serializer.rb

@@ -1,8 +0,0 @@
-module Blueprinter
-  class AutoSerializer < Blueprinter::Serializer
-    def serialize(field_name, object, local_options, options = {})
-      serializer = object.is_a?(Hash) ? HashSerializer : PublicSendSerializer
-      serializer.serialize(field_name, object, local_options, options = {})
-    end
-  end
-end

data/lib/blueprinter/serializers/block_serializer.rb

@@ -1,5 +0,0 @@
-class Blueprinter::BlockSerializer < Blueprinter::Serializer
-  def serialize(field_name, object, local_options, options = {})
-    options[:block][field_name].call(object, local_options)
-  end
-end

data/lib/blueprinter/serializers/hash_serializer.rb

@@ -1,5 +0,0 @@
-class Blueprinter::HashSerializer < Blueprinter::Serializer
-  def serialize(field_name, object, local_options, options = {})
-    object[field_name] || object[field_name.to_s]
-  end
-end

data/lib/blueprinter/serializers/public_send_serializer.rb

@@ -1,5 +0,0 @@
-class Blueprinter::PublicSendSerializer < Blueprinter::Serializer
-  def serialize(field_name, object, local_options, options = {})
-    object.public_send(field_name)
-  end
-end