knuckles 0.2.0 → 0.3.0

data/lib/knuckles.rb

@@ -4,46 +4,94 @@ require "active_support/notifications"
 require "active_support/cache"
 require "json"
 
+# Knuckles is a performance focused data serialization pipeline. More simply,
+# it tries to serialize models into large JSON payloads as quickly as possible.
+# It operates on a collection of data through stages, passing them through a
+# pipeline of transformations.
+#
+# The default configuration uses `MemoryStore`, but you can configure it along
+# with other customizations.
+#
+# @example Configuration
+#
+#   Knuckles.configure do |config|
+#     config.cache      = Readthis::Cache.new
+#     config.keygen     = Readthis::Expanders
+#     config.serializer = Oj
+#   end
+#
+# With the module configured you can begin transforming models into JSON (or
+# MessagePack, whatever your API uses):
+#
+# @example Usage with default pipeline
+#
+#   Knuckles.new.call(models, view: SubmissionView) #=>
+#     '{"submissions":[], "tags":[], "responses":[]}'
+#
 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"
   autoload :Pipeline, "knuckles/pipeline"
-  autoload :Renderer, "knuckles/renderer"
+  autoload :Stages, "knuckles/stages"
   autoload :View, "knuckles/view"
-  autoload :Writer, "knuckles/writer"
 
   extend self
 
   attr_writer :cache, :keygen, :notifications, :serializer
 
+  # Convenience method for initializing a new `Pipeline`
+  #
+  # @see Knuckles::Pipeline#initialize
+  #
   def new(*args)
     Knuckles::Pipeline.new(*args)
   end
 
+  # Module accessor for `cache`, defaults to `Cache::MemoryStore`
+  #
+  # @return [#cache] A cache instance
+  #
   def cache
     @cache ||= ActiveSupport::Cache::MemoryStore.new
   end
 
+  # Module accessor `keygen`, defaults to `Knuckles::Keygen`
+  #
+  # @return [Module] Cache key generation module
+  #
   def keygen
     @keygen ||= Knuckles::Keygen
   end
 
+  # Module accessor for `notifications`, defaults to
+  # `ActiveSupport::Notifications`
+  #
+  # @return [Module] Instrumentation module
+  #
   def notifications
     @notifications ||= ActiveSupport::Notifications
   end
 
+  # Module accessor for `serializer`, defaults to `JSON`
+  #
+  # @return [Module] The serializer
+  #
   def serializer
     @serializer ||= JSON
   end
 
+  # Convenience for setting properties as within a block
+  #
+  # @example Configuring knuckles
+  #
+  #   Knuckles.configure do |config|
+  #     config.serializer = MessagePack
+  #   end
+  #
   def configure
     yield self
   end
 
+  # @private
   def reset!
     @cache = nil
     @keygen = nil

data/spec/knuckles/pipeline_spec.rb

@@ -13,46 +13,6 @@ RSpec.describe Knuckles::Pipeline do
     end
   end
 
-  describe "#delete" do
-    it "removes an existing stage" do
-      pipeline = Knuckles::Pipeline.new
-
-      pipeline.delete(Knuckles::Writer)
-
-      expect(pipeline.stages).not_to include(Knuckles::Writer)
-    end
-  end
-
-  describe "#insert_after" do
-    it "adds a stage after an existing stage" do
-      custom = Module.new
-      pipeline = Knuckles::Pipeline.new
-
-      pipeline.insert_after(Knuckles::Fetcher, custom)
-
-      expect(pipeline.stages).to include(custom)
-      expect(pipeline.stages.take(2)).to eq([
-        Knuckles::Fetcher,
-        custom
-      ])
-    end
-  end
-
-  describe "#insert_before" do
-    it "adds a stage after an existing stage" do
-      custom = Module.new
-      pipeline = Knuckles::Pipeline.new
-
-      pipeline.insert_before(Knuckles::Fetcher, custom)
-
-      expect(pipeline.stages).to include(custom)
-      expect(pipeline.stages.take(2)).to eq([
-        custom,
-        Knuckles::Fetcher
-      ])
-    end
-  end
-
   describe "#call" do
     it "aggregates the result of all stages" do
       filter_a = Module.new do

data/spec/knuckles/{combiner_spec.rb → stages/combiner_spec.rb}

@@ -1,4 +1,4 @@
-RSpec.describe Knuckles::Combiner do
+RSpec.describe Knuckles::Stages::Combiner do
   describe ".call" do
     it "merges all results into a single object" do
       prepared = [
@@ -16,7 +16,7 @@ RSpec.describe Knuckles::Combiner do
         }
       ]
 
-      combined = Knuckles::Combiner.call(prepared, {})
+      combined = Knuckles::Stages::Combiner.call(prepared, {})
 
       expect(combined).to eq(
         "author" => [

data/spec/knuckles/{dumper_spec.rb → stages/dumper_spec.rb}

@@ -1,4 +1,4 @@
-RSpec.describe Knuckles::Dumper do
+RSpec.describe Knuckles::Stages::Dumper do
   describe ".call" do
     it "dumps a tree of objects" do
       objects = {
@@ -16,7 +16,7 @@ RSpec.describe Knuckles::Dumper do
         ]
       }
 
-      dumped = Knuckles::Dumper.call(objects, {})
+      dumped = Knuckles::Stages::Dumper.call(objects, {})
 
       expect(dumped).to eq(
         JSON.dump(

data/spec/knuckles/{enhancer_spec.rb → stages/enhancer_spec.rb}

@@ -1,9 +1,9 @@
-RSpec.describe Knuckles::Enhancer do
+RSpec.describe Knuckles::Stages::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)
+      expect(Knuckles::Stages::Enhancer.call(prepared, {})).to eq(prepared)
     end
 
     it "modifies the rendered values with a lambda" do
@@ -12,7 +12,7 @@ RSpec.describe Knuckles::Enhancer do
         {result: {"posts" => [], "tags" => []}}
       ]
 
-      enhanced = Knuckles::Enhancer.call(
+      enhanced = Knuckles::Stages::Enhancer.call(
         prepared,
         tagless: true,
         enhancer: lambda do |result, options|

data/spec/knuckles/{fetcher_spec.rb → stages/fetcher_spec.rb}

@@ -1,4 +1,4 @@
-RSpec.describe Knuckles::Fetcher do
+RSpec.describe Knuckles::Stages::Fetcher do
   describe ".call" do
     it "fetches all cached data for top level objects" do
       objects = [Tag.new(1, "alpha"), Tag.new(2, "gamma")]
@@ -6,7 +6,7 @@ RSpec.describe Knuckles::Fetcher do
       Knuckles.cache.write(Knuckles.keygen.expand_key(objects.first), "result")
 
       objects = prepare(objects)
-      results = Knuckles::Fetcher.call(objects, {})
+      results = Knuckles::Stages::Fetcher.call(objects, {})
 
       expect(pluck(results, :result)).to eq(["result", nil])
       expect(pluck(results, :cached?)).to eq([true, false])
@@ -20,7 +20,7 @@ RSpec.describe Knuckles::Fetcher do
       end
 
       objects = prepare([Tag.new(1, "alpha")])
-      results = Knuckles::Fetcher.call(objects, keygen: keygen)
+      results = Knuckles::Stages::Fetcher.call(objects, keygen: keygen)
 
       expect(pluck(results, :key)).to eq(["alpha"])
     end

data/spec/knuckles/{hydrator_spec.rb → stages/hydrator_spec.rb}

@@ -1,9 +1,9 @@
-RSpec.describe Knuckles::Hydrator do
+RSpec.describe Knuckles::Stages::Hydrator do
   describe ".call" do
     it "is a noop without a hydrate lambda" do
       objects = [Tag.new(1, "alpha")]
 
-      expect(Knuckles::Hydrator.call(objects, {})).to eq(objects)
+      expect(Knuckles::Stages::Hydrator.call(objects, {})).to eq(objects)
     end
 
     it "refines the object collection using hydrate" do
@@ -14,7 +14,7 @@ RSpec.describe Knuckles::Hydrator do
         hashes.each { |hash| hash[:object] = :updated }
       end
 
-      hydrated = Knuckles::Hydrator.call(prepared, hydrate: hydrate)
+      hydrated = Knuckles::Stages::Hydrator.call(prepared, hydrate: hydrate)
 
       expect(hydrated.map { |hash| hash[:object] }).to eq([:updated, :updated])
     end

data/spec/knuckles/{renderer_spec.rb → stages/renderer_spec.rb}

@@ -1,4 +1,4 @@
-RSpec.describe Knuckles::Renderer do
+RSpec.describe Knuckles::Stages::Renderer do
   describe ".call" do
     it "serializes a collection of objects" do
       tag_a  = Tag.new(1, "alpha")
@@ -7,7 +7,7 @@ RSpec.describe Knuckles::Renderer do
       post_b = Post.new(2, "there", [tag_a])
 
       objects = prepare([post_a, post_b])
-      results = Knuckles::Renderer.call(objects, view: PostView)
+      results = Knuckles::Stages::Renderer.call(objects, view: PostView)
 
       expect(results[0][:result]).to eq(
         posts: [

data/spec/knuckles/{writer_spec.rb → stages/writer_spec.rb}

@@ -1,4 +1,4 @@
-RSpec.describe Knuckles::Writer do
+RSpec.describe Knuckles::Stages::Writer do
   class FakeCache
     def write_multi(*)
       true
@@ -16,7 +16,7 @@ RSpec.describe Knuckles::Writer do
         {key: "t/2/2", cached?: false, result: {tags: [{id: 2, name: "b"}]}}
       ]
 
-      result = Knuckles::Writer.call(prepared, {})
+      result = Knuckles::Stages::Writer.call(prepared, {})
 
       expect(result).to eq(prepared)
       expect(Knuckles.cache.read("t/1/1")).to be_nil
@@ -33,7 +33,7 @@ RSpec.describe Knuckles::Writer do
 
       expect(Knuckles.cache).to receive(:write_multi) { true }
 
-      result = Knuckles::Writer.call(prepared, {})
+      result = Knuckles::Stages::Writer.call(prepared, {})
 
       expect(result).to eq(prepared)
     end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: knuckles
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-23 00:00:00.000000000 Z
+date: 2016-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '4.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -73,50 +73,37 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bench/bench_helper.rb
-- bench/fixtures/serializers.rb
-- bench/fixtures/submissions.json
-- bench/profiling.rb
-- bench/realistic.rb
-- bench/simple.rb
-- bin/rspec
-- knuckles.gemspec
 - 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
 - lib/knuckles/pipeline.rb
-- lib/knuckles/renderer.rb
+- lib/knuckles/stages.rb
+- lib/knuckles/stages/combiner.rb
+- lib/knuckles/stages/dumper.rb
+- lib/knuckles/stages/enhancer.rb
+- lib/knuckles/stages/fetcher.rb
+- lib/knuckles/stages/hydrator.rb
+- lib/knuckles/stages/renderer.rb
+- lib/knuckles/stages/writer.rb
 - lib/knuckles/version.rb
 - lib/knuckles/view.rb
-- 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
 - spec/knuckles/pipeline_spec.rb
-- spec/knuckles/renderer_spec.rb
+- spec/knuckles/stages/combiner_spec.rb
+- spec/knuckles/stages/dumper_spec.rb
+- spec/knuckles/stages/enhancer_spec.rb
+- spec/knuckles/stages/fetcher_spec.rb
+- spec/knuckles/stages/hydrator_spec.rb
+- spec/knuckles/stages/renderer_spec.rb
+- spec/knuckles/stages/writer_spec.rb
 - spec/knuckles/view_spec.rb
-- spec/knuckles/writer_spec.rb
 - spec/knuckles_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
 - spec/support/views.rb
-homepage: ''
+homepage: https://github.com/sorentwo/knuckles
 licenses:
 - MIT
 metadata: {}
@@ -141,17 +128,18 @@ signing_key:
 specification_version: 4
 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
 - spec/knuckles/pipeline_spec.rb
-- spec/knuckles/renderer_spec.rb
+- spec/knuckles/stages/combiner_spec.rb
+- spec/knuckles/stages/dumper_spec.rb
+- spec/knuckles/stages/enhancer_spec.rb
+- spec/knuckles/stages/fetcher_spec.rb
+- spec/knuckles/stages/hydrator_spec.rb
+- spec/knuckles/stages/renderer_spec.rb
+- spec/knuckles/stages/writer_spec.rb
 - spec/knuckles/view_spec.rb
-- spec/knuckles/writer_spec.rb
 - spec/knuckles_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
 - spec/support/views.rb
+has_rdoc: 

data/.gitignore

@@ -1,15 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-TODO.md

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.rubocop.yml

@@ -1,41 +0,0 @@
-AllCops:
-  Exclude:
-    - "bench/**/*"
-    - "bin/*"
-    - "tmp/**/*"
-    - "vendor/**/*"
-
-Style/FrozenStringLiteralComment:
-  EnforcedStyle: always
-  Exclude:
-    - "Gemfile*"
-    - "Rakefile"
-    - "*.gemspec"
-    - "spec/**/*"
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-# Documentation is coming
-Style/Documentation:
-  Enabled: false
-
-# Extend self preserves private methods
-Style/ModuleFunction:
-  Enabled: false
-
-Style/PredicateName:
-  NamePrefix:
-    - is_
-  NamePrefixBlacklist:
-    - is_
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-  EnforcedStyleForEmptyBraces: no_space
-
-Style/IndentArray:
-  Enabled: false

data/.travis.yml

@@ -1,10 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.2.4
-  - 2.3.0
-  - ruby-head
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-bundler_args: --without benchmarking

data/Gemfile

@@ -1,11 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem "rubocop", require: false
-gem "coveralls", require: false
-
-group :benchmarking do
-  gem "benchmark-ips"
-  gem "stackprof"
-end

data/Rakefile

@@ -1,9 +0,0 @@
-require "bundler/setup"
-require "bundler/gem_tasks"
-require "rubocop/rake_task"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-RuboCop::RakeTask.new
-
-task default: [:spec, :rubocop]

data/bench/bench_helper.rb

@@ -1,48 +0,0 @@
-require "bundler"
-
-Bundler.setup
-
-require "active_support/cache"
-require "benchmark/ips"
-require "json"
-require "knuckles"
-require_relative "fixtures/serializers"
-
-class BenchModel
-  attr_reader :key
-
-  def initialize(key, attributes)
-    attributes.each do |key, value|
-      self.class.send(:define_method, key) { value }
-    end
-  end
-
-  def cache_key
-    "#{key}/#{id}/#{updated_at}"
-  end
-end
-
-module BenchHelper
-  extend self
-
-  def submissions
-    mapping = %w[scout responses tags]
-    loaded  = JSON.load(IO.read("bench/fixtures/submissions.json"))
-
-    loaded.map do |object|
-      mapping.each do |key|
-        object[key] = structify(key, object[key])
-      end
-
-      structify('submissions', object)
-    end
-  end
-
-  def structify(key, object)
-    if object.is_a?(Array)
-      object.map { |obj| BenchModel.new(key, obj) }
-    else
-      BenchModel.new(key, object)
-    end
-  end
-end

data/bench/fixtures/serializers.rb

@@ -1,93 +0,0 @@
-module ScoutView
-  extend Knuckles::View
-
-  def self.root
-    :scouts
-  end
-
-  def self.data(object, _)
-    { id: object.id,
-      first_name: object.first_name,
-      gender: object.gender,
-      city: object.city,
-      state: object.state,
-      country: object.country,
-      education: object.education,
-      employment_status: object.employment_status,
-      ethnicity: object.ethnicity,
-      household_composition: object.household_composition,
-      household_income: object.household_income,
-      industry: object.industry,
-      created_at: object.created_at,
-      updated_at: object.updated_at }
-  end
-end
-
-module ResponseView
-  extend Knuckles::View
-
-  def self.root
-    :responses
-  end
-
-  def self.data(object, _)
-    { id: object.id,
-      answers: object.answers,
-      question_id: object.question_id,
-      respondable_id: object.respondable_id,
-      longitude: object.longitude,
-      latitude: object.latitude,
-      time_zone: object.time_zone,
-      answered_at: object.answered_at,
-      created_at: object.created_at,
-      updated_at: object.updated_at }
-  end
-end
-
-module TagView
-  extend Knuckles::View
-
-  def self.root
-    :tags
-  end
-
-  def self.data(object, _)
-    { id: object.id,
-      parent_id: object.parent_id,
-      name: object.name,
-      group: object.group,
-      auto_tag: object.auto_tag,
-      keywords: object.keywords,
-      created_at: object.created_at,
-      updated_at: object.updated_at }
-  end
-end
-
-module SubmissionView
-  extend Knuckles::View
-
-  def self.root
-    :submissions
-  end
-
-  def self.data(object, _)
-    { id: object.id,
-      screener_id: object.screener_id,
-      rating: object.rating,
-      latitude: object.latitude,
-      longitude: object.longitude,
-      source: object.source,
-      time_zone: object.time_zone,
-      bookmarks_count: object.bookmarks_count,
-      notes_count: object.notes_count,
-      finished_at: object.finished_at,
-      created_at: object.created_at,
-      updated_at: object.updated_at }
-  end
-
-  def self.relations(object, _)
-    { scouts: has_one(object.scout, ScoutView),
-      responses: has_many(object.responses, ResponseView),
-      tags: has_many(object.tags, TagView) }
-  end
-end