knuckles 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac7f83df75c4e52ee59dc85ff6d6d98c863f5963
-  data.tar.gz: e1ff17c2903f39eac251ee3bbaaa56ab1adfc1e5
+  metadata.gz: 69ff93727664c8cb7f6c22d52542521b400f7421
+  data.tar.gz: 88f1ad40c4d32591dfcc6b9d3e8c093d1c14a80a
 SHA512:
-  metadata.gz: d49c80cd7f0e4b2cefc1861188b84bf9ccd752975d6714d068c8a97798a8e95e615a6192762afe721a6461f9ec23105d66d46651b1cd809fa7c3d6abb577eb8d
-  data.tar.gz: 9e7bd47dd8b17edba6e3e88fa367bca797654b876fc8a4fb2f87f25189bbb503a3c72e8cca288c301ec6c0876e94a5a693ded4ca8a51031bb90e1649b5e80ec3
+  metadata.gz: 5bff88dba2e59d125dfa1c61ee050f191f690e1f1a12f704729e1f8e29b76bfe7a444e4bc550cd4a09d3777156114a10b8dc319f6594e92e83ca013ea17255aa
+  data.tar.gz: e51e57e0df18ccaef4304ee9f78a47ee0472063be046592b883cf2e6f732ba68cc9803f2f9636ff09ad9e9b48006603fa1c36fb25203405e6d3f2b8144e50844

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## v0.4.0 - 2016-05-11
+
+* Added: `Knuckles::Active::Hydrator`, a hydrator specifically designed to work
+  with `ActiveRecord`. It converts a relation of minimally loaded `ActiveRecord`
+  models into fully loaded models ready for serialization.
+* Added: A compatibility layer within the `Renderer` stage to ease in the
+  transition from `ActiveModelSerializers`. Both `Knuckles::View` or `AMS`
+  instances now work when passed as the `view` option.
+
 ## v0.3.0 - 2016-04-07
 
 * Added: Tons of documentation.

data/lib/knuckles/active/hydrator.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Knuckles
+  module Active
+    # The active hydrator converts minimal objects in a prepared collection
+    # into fully "hydrated" versions of the same record. For example, the
+    # initial `model` may only have the `id` and `updated_at` timestamp
+    # selected, which is ideal for fetching from the cache. If the object
+    # wasn't in the cache then all of the fields are needed for a complete
+    # rendering, so the hydration call will use the passed relation to fetch
+    # the full model and any associations.
+    #
+    # This `Hydrator` module is specifically designed to work with
+    # `ActiveRecord` relations. The initial objects can be anything that
+    # responds to `id`, but the relation should be an `ActiveRecord` relation.
+    module Hydrator
+      extend self
+
+      # Convert all uncached objects into their full representation.
+      #
+      # @param [Enumerable] prepared The prepared collection for processing
+      # @option [#Relation] :relation An ActiveRecord::Relation, used to
+      #   hydrate uncached objects
+      #
+      # @example Hydrating missing objects
+      #
+      #   prepared = [Post.new(1), Post.new(2)]
+      #   relation = Post.all.preload(:author, :comments)
+      #
+      #   Knuckles::Active::Hydrator.call(prepared, relation: relation) #=>
+      #     # [{object: #Post<1>, cached?: false, ...
+      #
+      def call(prepared, options)
+        mapping = id_object_mapping(prepared)
+
+        if mapping.any?
+          relation = relation_without_pagination(options)
+
+          relation.where(id: mapping.keys).each do |hydrated|
+            mapping[hydrated.id][:object] = hydrated
+          end
+        end
+
+        prepared
+      end
+
+      private
+
+      def relation_without_pagination(options)
+        options.fetch(:relation).offset(false).limit(false)
+      end
+
+      def id_object_mapping(objects)
+        objects.each_with_object({}) do |hash, memo|
+          next if hash[:cached?]
+
+          memo[hash[:object].id] = hash
+        end
+      end
+    end
+  end
+end

data/lib/knuckles/stages/renderer.rb

@@ -18,9 +18,10 @@ module Knuckles
       private
 
       def do_render(object, view, options)
-        view.relations(object, options).merge!(
-          view.root => [view.data(object, options)]
-        )
+        case view
+        when Knuckles::View then view.render(object, options)
+        else view.new(object, options).as_json
+        end
       end
     end
   end

data/lib/knuckles/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knuckles
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0"
 end

data/lib/knuckles/view.rb

@@ -43,6 +43,23 @@ module Knuckles
     def root
     end
 
+    # Convenience for combining the results of data and relations
+    # into a single object.
+    #
+    # @param [Object] _object The object for serializing.
+    # @param [Hash] _options The options to be used during serialization, i.e.
+    #   `:scope`
+    #
+    # @return [Hash] A hash representing the serialized object and relations.
+    #
+    # @example Rendering an object
+    #
+    #   TagView.render(tag) #=> {tags: [{id: 1, name: "Alpha"}]}
+    #
+    def render(object, options = {})
+      relations(object, options).merge!(root => [data(object, options)])
+    end
+
     # Serialize an object into a hash. This simply returns an empty hash by
     # default, it must be overridden by submodules.
     #

data/lib/knuckles.rb

@@ -31,9 +31,22 @@ require "json"
 module Knuckles
   autoload :Keygen, "knuckles/keygen"
   autoload :Pipeline, "knuckles/pipeline"
-  autoload :Stages, "knuckles/stages"
   autoload :View, "knuckles/view"
 
+  module Active
+    autoload :Hydrator, "knuckles/active/hydrator"
+  end
+
+  module Stages
+    autoload :Combiner, "knuckles/stages/combiner"
+    autoload :Dumper, "knuckles/stages/dumper"
+    autoload :Enhancer, "knuckles/stages/enhancer"
+    autoload :Fetcher, "knuckles/stages/fetcher"
+    autoload :Hydrator, "knuckles/stages/hydrator"
+    autoload :Renderer, "knuckles/stages/renderer"
+    autoload :Writer, "knuckles/stages/writer"
+  end
+
   extend self
 
   attr_writer :cache, :keygen, :notifications, :serializer

data/spec/knuckles/active/hydrator_spec.rb

@@ -0,0 +1,43 @@
+RSpec.describe Knuckles::Active::Hydrator do
+  class FakeRelation
+    attr_reader :objects
+
+    def initialize(objects)
+      @objects = objects
+    end
+
+    def offset(_bool)
+      self
+    end
+
+    def limit(_bool)
+      self
+    end
+
+    def where(id:)
+      objects.select { |object| id.include?(object.id) }
+    end
+  end
+
+  describe ".call" do
+    it "is a no-op if all objects are cached" do
+      prepared = prepare([Tag.new(1, "alpha")])
+
+      prepared.each { |prep| prep[:cached?] = true }
+
+      expect(Knuckles::Active::Hydrator.call(prepared, {})).to eq(prepared)
+    end
+
+    it "replaces all objects using the results of a query" do
+      prepared = prepare([Tag.new(1, nil), Tag.new(2, nil)])
+      relation = FakeRelation.new([Tag.new(1, "alpha"), Tag.new(2, "beta")])
+
+      results = Knuckles::Active::Hydrator.call(prepared, relation: relation)
+
+      expect(results.map { |hash| hash[:object] }).to eq([
+        Tag.new(1, "alpha"),
+        Tag.new(2, "beta")
+      ])
+    end
+  end
+end

data/spec/knuckles/stages/renderer_spec.rb

@@ -28,5 +28,25 @@ RSpec.describe Knuckles::Stages::Renderer do
         ]
       )
     end
+
+    it "serializes using a class based renderer" do
+      tag = Tag.new(1, "alpha")
+
+      ar_view = Class.new do
+        def initialize(object, _options)
+          @object = object
+        end
+
+        def as_json
+          {tags: [{id: @object.id, name: @object.name}]}
+        end
+      end
+
+      results = Knuckles::Stages::Renderer.call(prepare([tag]), view: ar_view)
+
+      expect(results[0][:result]).to eq(
+        tags: [{id: 1, name: "alpha"}]
+      )
+    end
   end
 end

data/spec/knuckles/view_spec.rb

@@ -35,4 +35,14 @@ RSpec.describe Knuckles::View do
       )
     end
   end
+
+  describe ".render" do
+    it "performs combined rendering of relations and data" do
+      tag = Tag.new(1, "Alpha")
+
+      expect(TagView.render(tag)).to eq(
+        tags: [{id: 1, name: "Alpha"}]
+      )
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knuckles
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-07 00:00:00.000000000 Z
+date: 2016-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -77,9 +77,9 @@ files:
 - LICENSE.txt
 - README.md
 - lib/knuckles.rb
+- lib/knuckles/active/hydrator.rb
 - lib/knuckles/keygen.rb
 - lib/knuckles/pipeline.rb
-- lib/knuckles/stages.rb
 - lib/knuckles/stages/combiner.rb
 - lib/knuckles/stages/dumper.rb
 - lib/knuckles/stages/enhancer.rb
@@ -89,6 +89,7 @@ files:
 - lib/knuckles/stages/writer.rb
 - lib/knuckles/version.rb
 - lib/knuckles/view.rb
+- spec/knuckles/active/hydrator_spec.rb
 - spec/knuckles/keygen_spec.rb
 - spec/knuckles/pipeline_spec.rb
 - spec/knuckles/stages/combiner_spec.rb
@@ -128,6 +129,7 @@ signing_key:
 specification_version: 4
 summary: Simple performance aware data serialization
 test_files:
+- spec/knuckles/active/hydrator_spec.rb
 - spec/knuckles/keygen_spec.rb
 - spec/knuckles/pipeline_spec.rb
 - spec/knuckles/stages/combiner_spec.rb

data/lib/knuckles/stages.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Knuckles
-  module Stages
-    autoload :Combiner, "knuckles/stages/combiner"
-    autoload :Dumper, "knuckles/stages/dumper"
-    autoload :Enhancer, "knuckles/stages/enhancer"
-    autoload :Fetcher, "knuckles/stages/fetcher"
-    autoload :Hydrator, "knuckles/stages/hydrator"
-    autoload :Renderer, "knuckles/stages/renderer"
-    autoload :Writer, "knuckles/stages/writer"
-  end
-end