blueprinter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f69da973430bcbb6be951377ccc7707e2d53228a
-  data.tar.gz: 818f307324662a8871d6abc6353cfbf52367cb33
+  metadata.gz: 6e7d939f775eceed008783088ae2e73481798aaf
+  data.tar.gz: 9c013582657eef9da0e37533e933058253803109
 SHA512:
-  metadata.gz: a8ee5758ecba43bb06423d4fbe01ebfcabb918c2980775b75e494f75350e90b8348fd20685b6c0c083d47196b0ec75f99757020d6a9e82af7699964231b6f0dc
-  data.tar.gz: 63d4da14d7b9d1144068961c163ef2d6b9a04adbf3e21db33a57e68779d7c580f9c5491571c2154a453bd2c41ee76326dacc5f9f13c990f701a423709aaf74af
+  metadata.gz: 7f1947a5d7d6155aabe3fa0a2388f3e24bd2c447d78d1bd3b6ce1d639831b4eff95047851dff5226854fce1eaa0a6e0f99bfbd7b1467f0a6cc450ee11af4b61a
+  data.tar.gz: bf51f3e711eb499beaf4bc343a03dcd7401159487528d22211502ea388dbb60498fc50b9de9ec51df23e3eaa6319fd018658d6be699766d6f960eb7252120605

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 0.2.0  - 2018/01/22
+
+Breaking Changes. To upgrade, ensure that any associated objects have a blueprint. For example:
+```
+association :comments, blueprint: CommentsBlueprint
+```
+
+* [BUGFIX] Remove Optimizer class. See #61.
+* [BUGFIX] Require associated objects to have a Blueprint, so that objects will always serialize properly. See #60.
+
+## 0.1.0  - 2018/01/17
+
+* [FEATURE] Initial release of Blueprinter

data/README.md

@@ -1,4 +1,5 @@
 [![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)
 
 # 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.
@@ -76,13 +77,18 @@ Output:
 ### Associations
 You may include associated objects. Say for example, a user has projects:
 ```ruby
+class ProjectBlueprint < Blueprinter::Base
+  identifier :uuid
+  field :name
+end
+
 class UserBlueprint < Blueprinter::Base
   identifier :uuid
   field :email, name: :login
 
   view :normal do
     fields :first_name, :last_name
-    association :projects
+    association :projects, blueprint: ProjectBlueprint
   end
 end
 ```

data/lib/blueprinter/base.rb

@@ -9,7 +9,6 @@ require_relative 'serializers/public_send_serializer'
 require_relative 'field'
 require_relative 'view'
 require_relative 'view_collection'
-require_relative 'optimizer'
 
 module Blueprinter
   class Base
@@ -87,6 +86,8 @@ module Blueprinter
     #
     # @param method [Symbol] the association name
     # @param options [Hash] options to overide defaults.
+    # @option options [Symbol] :blueprint Required. Use this to specify the
+    #   blueprint to use for the associated object.
     # @option options [Symbol] :name Use this to rename the association in the
     #   JSON output.
     # @option options [Symbol] :view Specify the view to use or fall back to
@@ -95,12 +96,13 @@ module Blueprinter
     # @example Specifying an association
     #   class UserBlueprint < Blueprinter::Base
     #     # code
-    #     association :vehicles, view: :extended
+    #     association :vehicles, view: :extended, blueprint: VehiclesBlueprint
     #     # code
     #   end
     #
     # @return [Field] A Field object
     def self.association(method, options = {})
+      raise BlueprinterError, 'blueprint required' unless options[:blueprint]
       name = options.delete(:name) || method
       current_view << Field.new(method,
                                        name,
@@ -141,8 +143,7 @@ module Blueprinter
         raise BlueprinterError, "View '#{view_name}' is not defined"
       end
       fields = view_collection.fields_for(view_name)
-      prepared_object = Optimizer.optimize(object, fields: fields)
-      prepared_object = include_associations(prepared_object, view_name: view_name)
+      prepared_object = include_associations(object, view_name: view_name)
       if array_like?(object)
         prepared_object.map do |obj|
           object_to_hash(obj,

data/lib/blueprinter/serializers/association_serializer.rb

@@ -1,10 +1,8 @@
 class Blueprinter::AssociationSerializer < Blueprinter::Serializer
   def serialize(association_name, object, local_options, options={})
-    if options[:blueprint]
-      view = options[:view] || :default
-      options[:blueprint].prepare(object.public_send(association_name), view_name: view, local_options: local_options)
-    else
-      object.public_send(association_name)
-    end
+    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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Hess
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-17 00:00:00.000000000 Z
+date: 2018-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -105,6 +105,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -114,7 +115,6 @@ files:
 - lib/blueprinter/configuration.rb
 - lib/blueprinter/field.rb
 - lib/blueprinter/helpers/active_record_helpers.rb
-- lib/blueprinter/optimizer.rb
 - lib/blueprinter/serializer.rb
 - lib/blueprinter/serializers/association_serializer.rb
 - lib/blueprinter/serializers/auto_serializer.rb
@@ -124,7 +124,6 @@ files:
 - lib/blueprinter/version.rb
 - lib/blueprinter/view.rb
 - lib/blueprinter/view_collection.rb
-- lib/rabbit_painter.rb
 - lib/tasks/blueprinter_tasks.rake
 homepage: https://github.com/procore/blueprinter
 licenses:
@@ -146,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Simple Fast Declarative Serialization Library

data/lib/blueprinter/optimizer.rb

@@ -1,30 +0,0 @@
-module Blueprinter
-  # @api private
-  class Optimizer
-    include ActiveRecordHelpers
-    class << self
-      def optimize(object, fields:)
-        return object unless active_record_relation?(object)
-        select_columns = (active_record_attributes_for(object) &
-                         fields.map(&:method)) +
-                         required_lookup_attributes_for(object)
-        object.select(*select_columns)
-      end
-
-      private
-
-      def active_record_attributes_for(object)
-        object.klass.column_names.map(&:to_sym)
-      end
-
-      def required_lookup_attributes_for(object)
-        # TODO: We may not need all four of these
-        lookup_values = (object.includes_values +
-                         object.preload_values +
-                         object.joins_values +
-                         object.eager_load_values).uniq
-        lookup_values.map {|value| object.reflections[value.to_s].foreign_key}
-      end
-    end
-  end
-end

data/lib/rabbit_painter.rb

@@ -1,14 +0,0 @@
-=begin
-module RabbitPainter
-  def self.included(base)
-    base.extend ClassMethods
-  end
-
-  module ClassMethods
-    attr_reader :serializer
-    def self.serializer(klass)
-      @serializer = klass
-    end
-  end
-end
-=end