knuckles 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c87ae8cc3d3661d7f726b97cc65a6a14ddd1570
-  data.tar.gz: b9a84d855d7088f3808eeeba46311e6707f220e6
+  metadata.gz: 19a29c342c27e5b5dd82cf59118e2145707f2d06
+  data.tar.gz: 9660418feed584f2ae6b0b75a54ece8a31fab387
 SHA512:
-  metadata.gz: 288a745e8475764d7322d8108ef201c93b9adc61f10469caad7b00d626d8598202c6e88baa775e1c82d6a18920371a3841aa259b036a33cefb05a230067b0a24
-  data.tar.gz: 0660c72b861d3405249949734808987969644f43ad6ce63b01b0b1d7166586908e44c1ca8f1bba73c434e7c6d6cfe3f01c4becb0fa65e86751fae694c72458f4
+  metadata.gz: a29a4f519dcae90684811f5905e3641d20823e681c487dbefaea4a0157abc8e242ec368fa6a6fc5fbbcca6faddef9a9d7dadea8f41f241c6be3c7af158bcfd2f
+  data.tar.gz: e6662ef32ed48439b934cb2997f8cbb8f21b539aba41ac28e30aa57ebdcc7847732e9b1028fd58485f1795a220cc655165ad3d759851e781b8faf75f122c3894

data/.rubocop.yml

@@ -1,9 +1,17 @@
 AllCops:
   Exclude:
-    - 'bench/**/*'
-    - 'bin/*'
-    - 'tmp/**/*'
-    - 'vendor/**/*'
+    - "bench/**/*"
+    - "bin/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+  Exclude:
+    - "Gemfile*"
+    - "Rakefile"
+    - "*.gemspec"
+    - "spec/**/*"
 
 Style/IfUnlessModifier:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## v0.2.0 - 2016-03-23
+
+* Add: Introduce the enhancer stage, used to augment data after it has been
+  rendered but before it is combined. This allows pruning or augmenting rendered
+  data after it has been retrieved from the cache, meaning results can be
+  tailored to the "current user" of a request without per-user-caching.
+* Add: Uniformly combine cached and rendered results regardless of key type.
+  This also sees an improvement to the `uniq` check performed during dumping.
+
 ## v0.1.1 - 2016-03-22
 
 * Performance: Improve unique handling by favoring a single `uniq!` call over

data/lib/knuckles/combiner.rb

@@ -1,19 +1,19 @@
-require "set"
+# frozen_string_literal: true
 
 module Knuckles
   module Combiner
     extend self
 
     def name
-      "combiner".freeze
+      "combiner"
     end
 
     def call(prepared, _)
       prepared.each_with_object(array_backed_hash) do |hash, memo|
         hash[:result].each do |root, values|
           case values
-          when Hash  then memo[root] << values
-          when Array then memo[root] += values
+          when Hash  then memo[root.to_s] << values
+          when Array then memo[root.to_s] += values
           end
         end
       end

data/lib/knuckles/dumper.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Knuckles
   module Dumper
     extend self
 
     def name
-      "dumper".freeze
+      "dumper"
     end
 
     def call(objects, _options)
@@ -14,7 +16,9 @@ module Knuckles
 
     def keys_to_arrays(objects)
       objects.each do |_, value|
-        value.uniq! if value.is_a?(Array)
+        if value.is_a?(Array)
+          value.uniq! { |hash| hash["id"] || hash[:id] }
+        end
       end
     end
   end

data/lib/knuckles/enhancer.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Knuckles
+  module Enhancer
+    extend self
+
+    def name
+      "enhancer"
+    end
+
+    def call(prepared, options)
+      enhancer = options[:enhancer]
+
+      if enhancer
+        prepared.each do |hash|
+          hash[:result] = enhancer.call(hash[:result], options)
+        end
+      end
+
+      prepared
+    end
+  end
+end

data/lib/knuckles/fetcher.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Knuckles
   module Fetcher
     extend self
 
     def name
-      "fetcher".freeze
+      "fetcher"
     end
 
     def call(prepared, options)

data/lib/knuckles/hydrator.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Knuckles
   module Hydrator
     extend self
 
     def name
-      "hydrator".freeze
+      "hydrator"
     end
 
     def call(prepared, options)

data/lib/knuckles/keygen.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Knuckles
   module Keygen
     extend self

data/lib/knuckles/pipeline.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Knuckles
   class Pipeline
     def self.default_stages
@@ -5,6 +7,7 @@ module Knuckles
        Knuckles::Hydrator,
        Knuckles::Renderer,
        Knuckles::Writer,
+       Knuckles::Enhancer,
        Knuckles::Combiner,
        Knuckles::Dumper]
     end

data/lib/knuckles/renderer.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Knuckles
   module Renderer
     extend self
 
     def name
-      "renderer".freeze
+      "renderer"
     end
 
     def call(objects, options)

data/lib/knuckles/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Knuckles
-  VERSION = "0.1.1".freeze
+  VERSION = "0.2.0".freeze
 end

data/lib/knuckles/view.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Knuckles
   module View
     extend self

data/lib/knuckles/writer.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Knuckles
   module Writer
     extend self
 
     def name
-      "writer".freeze
+      "writer"
     end
 
     def call(objects, _)

data/lib/knuckles.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/notifications"
 require "active_support/cache"
 require "json"
@@ -5,6 +7,7 @@ require "json"
 module Knuckles
   autoload :Combiner, "knuckles/combiner"
   autoload :Dumper, "knuckles/dumper"
+  autoload :Enhancer, "knuckles/enhancer"
   autoload :Fetcher, "knuckles/fetcher"
   autoload :Hydrator, "knuckles/hydrator"
   autoload :Keygen, "knuckles/keygen"

data/spec/knuckles/combiner_spec.rb

@@ -10,8 +10,8 @@ RSpec.describe Knuckles::Combiner do
           }
         }, {
           result: {
-            posts: [{id: 2, title: "there", tag_ids: [1]}],
-            tags: [{id: 1, name: "alpha"}]
+            "posts" => [{"id" => 2, "title" => "there", "tag_ids" => [1]}],
+            "tags" => [{"id" => 1, "name" => "alpha"}]
           }
         }
       ]
@@ -19,17 +19,17 @@ RSpec.describe Knuckles::Combiner do
       combined = Knuckles::Combiner.call(prepared, {})
 
       expect(combined).to eq(
-        author: [
+        "author" => [
           {id: 1, name: "Michael"}
         ],
-        posts: [
+        "posts" => [
           {id: 1, title: "hello", tag_ids: [1, 2]},
-          {id: 2, title: "there", tag_ids: [1]}
+          {"id" => 2, "title" => "there", "tag_ids" => [1]}
         ],
-        tags: [
+        "tags" => [
           {id: 1, name: "alpha"},
           {id: 2, name: "gamma"},
-          {id: 1, name: "alpha"}
+          {"id" => 1, "name" => "alpha"}
         ]
       )
     end

data/spec/knuckles/dumper_spec.rb

@@ -5,11 +5,14 @@ RSpec.describe Knuckles::Dumper do
         author: {id: 1, name: "Ernest"},
         posts: [
           {id: 1, title: "great"},
+          {id: 2, title: "stuff"},
           {id: 2, title: "stuff"}
         ],
         tags: [
           {id: 1, name: "alpha"},
-          {id: 2, name: "gamma"}
+          {id: 2, name: "gamma"},
+          {id: 1, name: "alpha"},
+          {"id" => 2, "name" => "gamma"}
         ]
       }
 

data/spec/knuckles/enhancer_spec.rb

@@ -0,0 +1,33 @@
+RSpec.describe Knuckles::Enhancer do
+  describe ".call" do
+    it "is a noop without an enhancer lambda" do
+      prepared = [Tag.new(1, "alpha")]
+
+      expect(Knuckles::Enhancer.call(prepared, {})).to eq(prepared)
+    end
+
+    it "modifies the rendered values with a lambda" do
+      prepared = [
+        {result: {"posts" => [], "tags" => []}},
+        {result: {"posts" => [], "tags" => []}}
+      ]
+
+      enhanced = Knuckles::Enhancer.call(
+        prepared,
+        tagless: true,
+        enhancer: lambda do |result, options|
+          if options[:tagless]
+            result.delete_if { |key, _| key == "tags" }
+          end
+
+          result
+        end
+      )
+
+      expect(enhanced).to eq([
+        {result: {"posts" => []}},
+        {result: {"posts" => []}}
+      ])
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knuckles
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Parker Selbert
@@ -93,6 +93,7 @@ files:
 - lib/knuckles.rb
 - lib/knuckles/combiner.rb
 - lib/knuckles/dumper.rb
+- lib/knuckles/enhancer.rb
 - lib/knuckles/fetcher.rb
 - lib/knuckles/hydrator.rb
 - lib/knuckles/keygen.rb
@@ -103,6 +104,7 @@ files:
 - lib/knuckles/writer.rb
 - spec/knuckles/combiner_spec.rb
 - spec/knuckles/dumper_spec.rb
+- spec/knuckles/enhancer_spec.rb
 - spec/knuckles/fetcher_spec.rb
 - spec/knuckles/hydrator_spec.rb
 - spec/knuckles/keygen_spec.rb
@@ -141,6 +143,7 @@ summary: Simple performance aware data serialization
 test_files:
 - spec/knuckles/combiner_spec.rb
 - spec/knuckles/dumper_spec.rb
+- spec/knuckles/enhancer_spec.rb
 - spec/knuckles/fetcher_spec.rb
 - spec/knuckles/hydrator_spec.rb
 - spec/knuckles/keygen_spec.rb