knuckles 0.1.0

data/spec/knuckles/renderer_spec.rb

@@ -0,0 +1,32 @@
+RSpec.describe Knuckles::Renderer do
+  describe ".call" do
+    it "serializes a collection of objects" do
+      tag_a  = Tag.new(1, "alpha")
+      tag_b  = Tag.new(2, "gamma")
+      post_a = Post.new(1, "hello", [tag_a, tag_b])
+      post_b = Post.new(2, "there", [tag_a])
+
+      objects = prepare([post_a, post_b])
+      results = Knuckles::Renderer.call(objects, view: PostView)
+
+      expect(results[0][:result]).to eq(
+        posts: [
+          {id: 1, title: "hello", tag_ids: [1, 2]}
+        ],
+        tags: [
+          {id: 1, name: "alpha"},
+          {id: 2, name: "gamma"}
+        ]
+      )
+
+      expect(results[1][:result]).to eq(
+        posts: [
+          {id: 2, title: "there", tag_ids: [1]}
+        ],
+        tags: [
+          {id: 1, name: "alpha"}
+        ]
+      )
+    end
+  end
+end

data/spec/knuckles/view_spec.rb

@@ -0,0 +1,38 @@
+require "time"
+
+RSpec.describe Knuckles::View do
+  let(:view) { Knuckles::View }
+
+  describe "callback methods" do
+    it "defines defaults for all callback methods" do
+      obj = Object.new
+
+      expect(view.root).to be_nil
+      expect(view.data(obj)).to eq({})
+      expect(view.relations(obj)).to eq({})
+    end
+  end
+
+  describe ".has_one" do
+    it "serializes an object using the given view" do
+      object = Tag.new(1, "Alpha")
+
+      expect(view.has_one(object, TagView)).to eq(
+        [{id: object.id, name: object.name}]
+      )
+    end
+  end
+
+  describe ".has_many" do
+    it "serializes all objects using the given view" do
+      object_a = Tag.new(1, "Alpha")
+      object_b = Tag.new(2, "Beta")
+
+      objects = [object_a, object_b]
+
+      expect(view.has_many(objects, TagView)).to eq(
+        [{id: 1, name: "Alpha"}, {id: 2, name: "Beta"}]
+      )
+    end
+  end
+end

data/spec/knuckles/writer_spec.rb

@@ -0,0 +1,41 @@
+RSpec.describe Knuckles::Writer do
+  class FakeCache
+    def write_multi(*)
+      true
+    end
+  end
+
+  after do
+    Knuckles.reset!
+  end
+
+  describe ".call" do
+    it "writes all un-cached values" do
+      prepared = [
+        {key: "t/1/1", cached?: true,  result: {tags: [{id: 1, name: "a"}]}},
+        {key: "t/2/2", cached?: false, result: {tags: [{id: 2, name: "b"}]}}
+      ]
+
+      result = Knuckles::Writer.call(prepared, {})
+
+      expect(result).to eq(prepared)
+      expect(Knuckles.cache.read("t/1/1")).to be_nil
+      expect(Knuckles.cache.read("t/2/2")).not_to be_nil
+    end
+
+    it "leverages write multi for caches that support it" do
+      prepared = [
+        {key: "t/1/1", cached?: false, result: {tags: []}},
+        {key: "t/2/1", cached?: true, result: {tags: []}}
+      ]
+
+      Knuckles.cache = FakeCache.new
+
+      expect(Knuckles.cache).to receive(:write_multi) { true }
+
+      result = Knuckles::Writer.call(prepared, {})
+
+      expect(result).to eq(prepared)
+    end
+  end
+end

data/spec/knuckles_spec.rb

@@ -0,0 +1,33 @@
+require "knuckles"
+
+RSpec.describe Knuckles do
+  after do
+    Knuckles.reset!
+  end
+
+  describe "customization" do
+    it "all dependencies can be overridden" do
+      custom = Object.new
+
+      Knuckles.cache = custom
+      Knuckles.keygen = custom
+      Knuckles.notifications = custom
+      Knuckles.serializer = custom
+
+      expect(Knuckles.cache).to eq(custom)
+      expect(Knuckles.keygen).to eq(custom)
+      expect(Knuckles.notifications).to eq(custom)
+      expect(Knuckles.serializer).to eq(custom)
+    end
+
+    it "provides a confugration block for convenience" do
+      custom = Object.new
+
+      Knuckles.configure do |config|
+        config.cache = custom
+      end
+
+      expect(Knuckles.cache).to eq(custom)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require "coveralls"
+require "knuckles"
+
+require_relative "./support/models"
+require_relative "./support/views"
+
+Coveralls.wear!
+
+module PrepHelper
+  def prepare(objects)
+    Knuckles::Pipeline.new.prepare(objects)
+  end
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+  config.warnings = true
+
+  config.default_formatter = "doc" if config.files_to_run.one?
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.include PrepHelper
+end

data/spec/support/models.rb

@@ -0,0 +1,11 @@
+Post = Struct.new(:id, :title, :tags) do
+  def updated_at
+    Time.now
+  end
+end
+
+Tag = Struct.new(:id, :name) do
+  def updated_at
+    Time.now
+  end
+end

data/spec/support/views.rb

@@ -0,0 +1,27 @@
+PostView = Module.new do
+  extend Knuckles::View
+
+  def self.root
+    :posts
+  end
+
+  def self.data(post, _)
+    {id: post.id, title: post.title, tag_ids: post.tags.map(&:id)}
+  end
+
+  def self.relations(post, _)
+    {tags: has_many(post.tags, TagView)}
+  end
+end
+
+TagView = Module.new do
+  extend Knuckles::View
+
+  def self.root
+    :tags
+  end
+
+  def self.data(tag, _)
+    {id: tag.id, name: tag.name}
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: knuckles
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Parker Selbert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-21 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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- parker@sorentwo.com
+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/fetcher.rb
+- lib/knuckles/hydrator.rb
+- lib/knuckles/keygen.rb
+- lib/knuckles/pipeline.rb
+- lib/knuckles/renderer.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/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/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: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+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/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/view_spec.rb
+- spec/knuckles/writer_spec.rb
+- spec/knuckles_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/views.rb