yaks 0.4.4 → 0.5.0

data/spec/unit/yaks/runner_spec.rb

@@ -0,0 +1,260 @@
+require 'spec_helper'
+
+RSpec.describe Yaks::Runner do
+  subject(:runner) {
+    described_class.new(object: object, config: config, options: options)
+  }
+
+  let(:object) { Object.new }
+  let(:config) { Yaks::Config.new }
+  let(:options) { {} }
+
+  describe '#call' do
+    let(:runner) {
+      Class.new(described_class) do
+        def steps
+          [ [:step1, ->(x) { x + 35     }],
+            [:step2, ->(x) { "#{x} #{x}"}] ]
+        end
+      end.new(object: object, config: config, options: options)
+    }
+
+    let(:object) { 7 }
+
+    it 'should go through all the steps' do
+      expect(runner.call).to eql "42 42"
+    end
+  end
+
+  describe '#context' do
+    it 'should contain the policy, env, and an empty mapper_stack' do
+      expect(runner.context).to eql(policy: config.policy, env: {}, mapper_stack: [])
+    end
+
+    context 'with an item mapper' do
+      let(:options) { { item_mapper: :foo } }
+
+      it 'should contain the item_mapper' do
+        expect(runner.context).to eql(policy: config.policy, env: {}, mapper_stack: [], item_mapper: :foo)
+      end
+    end
+  end
+
+  describe '#format_class' do
+    let(:config) do
+      Yaks::Config.new do
+        default_format :collection_json
+      end
+    end
+
+    let(:rack_env) {
+      { 'HTTP_ACCEPT' => 'application/hal+json;q=0.8, application/vnd.api+json' }
+    }
+
+    it 'should fall back to the default when no HTTP_ACCEPT key is present' do
+      runner = described_class.new(object: nil, config: config, options: { env: {} })
+      expect(runner.format_class).to equal Yaks::Format::CollectionJson
+    end
+
+    it 'should detect format based on accept header' do
+      rack_env = { 'HTTP_ACCEPT' => 'application/hal+json;q=0.8, application/vnd.api+json' }
+      runner = described_class.new(object: nil, config: config, options: { env: rack_env })
+      expect(runner.format_class).to equal Yaks::Format::JsonAPI
+    end
+
+    it 'should know to pick the best match' do
+      rack_env = { 'HTTP_ACCEPT' => 'application/hal+json;q=0.8, application/vnd.api+json;q=0.7' }
+      runner = described_class.new(object: nil, config: config, options: { env: rack_env })
+      expect(runner.format_class).to equal Yaks::Format::Hal
+    end
+
+    it 'should pick the one given in the options if no header matches' do
+      rack_env = { 'HTTP_ACCEPT' => 'text/html, application/json' }
+      runner = described_class.new(object: nil, config: config, options: { format: :hal, env: rack_env })
+      expect(runner.format_class).to equal Yaks::Format::Hal
+    end
+
+    it 'should fall back to the default when no mime type is recognized' do
+      rack_env = { 'HTTP_ACCEPT' => 'text/html, application/json' }
+      runner = described_class.new(object: nil, config: config, options: { env: rack_env })
+      expect(runner.format_class).to equal Yaks::Format::CollectionJson
+    end
+  end
+
+  describe '#format_name' do
+    context 'with no format specified' do
+      it 'should default to :hal' do
+        expect(runner.format_name).to eql :hal
+      end
+    end
+
+    context 'with a default format specified' do
+      let(:config) { Yaks::Config.new { default_format :collection_json } }
+
+      context 'with a format in the options' do
+        let(:options) { { format: :json_api } }
+        it 'should give preference to that one' do
+          expect(runner.format_name).to eql :json_api
+        end
+      end
+
+      context 'without a format in the options' do
+        it 'should take the specified default' do
+          expect(runner.format_name).to eql :collection_json
+        end
+      end
+    end
+  end
+
+  describe '#formatter' do
+    let(:config) {
+      Yaks::Config.new do
+        default_format :json_api
+        format_options :json_api, {format_option: [:foo]}
+      end
+    }
+
+    let(:formatter) { runner.formatter }
+
+    it 'should create a formatter based on class and options' do
+      expect(formatter).to be_a Yaks::Format::JsonAPI
+      expect(formatter.send(:options)).to eql(format_option: [:foo])
+    end
+  end
+
+  describe '#insert_hooks' do
+    let(:options) { { mapper: Yaks::Mapper } }
+      let(:config) { Yaks::Config.new(&hooks) }
+
+    describe 'before' do
+      let(:hooks) { proc { before(:map) { :before_map_impl } } }
+
+      it 'should insert a hook before the step' do
+        expect(runner.steps.map(&:first)).to eql [
+          :before_map, :map, :format, :primitivize, :serialize
+        ]
+        expect(runner.steps.assoc(:before_map).last.call).to be :before_map_impl
+      end
+    end
+
+    describe 'after' do
+      let(:hooks) { proc { after(:format) { :after_format_impl } } }
+
+      it 'should insert a hook after the step' do
+        expect(runner.steps.map(&:first)).to eql [
+          :map, :format, :after_format, :primitivize, :serialize
+        ]
+        expect(runner.steps.assoc(:after_format).last.call).to be :after_format_impl
+      end
+    end
+
+    describe 'around' do
+      let(:hooks) { proc { around(:format) { :around_format_impl } } }
+
+      it 'should insert a hook around the step' do
+        expect(runner.steps.map(&:first)).to eql [
+          :map, :format, :primitivize, :serialize
+        ]
+        expect(runner.steps.assoc(:format).last.call(nil)).to be :around_format_impl
+      end
+    end
+
+    describe 'around' do
+      let(:hooks) { proc { skip(:serialize) } }
+
+      it 'should insert a hook before the step' do
+        expect(runner.steps.map(&:first)).to eql [
+          :map, :format, :primitivize
+        ]
+      end
+    end
+
+    describe 'multiple hooks' do
+      let(:hooks) {
+        proc {
+          after(:format) { :after_format_impl }
+          skip(:serialize)
+        }
+      }
+
+      it 'should insert the hooks' do
+        expect(runner.steps.map(&:first)).to eql [
+          :map, :format, :after_format, :primitivize
+        ]
+      end
+    end
+  end
+
+  describe '#mapper' do
+    context 'with an explicit mapper in the options' do
+      let(:mapper_class) { Class.new(Yaks::Mapper) }
+      let(:options) { { mapper: mapper_class } }
+
+      it 'should take the mapper from options' do
+        expect(runner.mapper).to be_a mapper_class
+      end
+    end
+
+    context 'without a mapper specified' do
+      let(:object) { Pet.new(id: 7, name: 'fifi', species: 'cat') }
+
+      it 'should infer one from the object to be mapped' do
+        expect(runner.mapper).to be_a PetMapper
+      end
+
+      it 'should pass the context to the mapper' do
+        expect(runner.mapper.context).to be runner.context
+      end
+    end
+  end
+
+  describe '#serializer' do
+    context 'with a serializer configured' do
+      let(:config) {
+        Yaks::Config.new do
+          json_serializer do |input|
+            "serialized #{input}"
+          end
+        end
+      }
+
+      it 'should try to find an explicitly configured serializer' do
+        expect(runner.serializer.call('42')).to eql 'serialized 42'
+      end
+    end
+
+    it 'should fall back to the policy' do
+      expect(runner.serializer.call([1,2,3])).to eql "[\n  1,\n  2,\n  3\n]"
+    end
+  end
+
+  describe '#steps' do
+    let(:options) {{ mapper: Yaks::Mapper }}
+
+    it 'should have all four steps' do
+      expect(runner.steps).to eql [
+        [ :map, runner.mapper ],
+        [ :format, runner.formatter ],
+        [ :primitivize, runner.primitivize],
+        [ :serialize, runner.serializer ]
+      ]
+    end
+
+    context 'with hooks' do
+      let(:config) {
+        Yaks::Config.new do
+          after(:format, :my_hook) { :foo }
+        end
+      }
+
+      it 'should insert hooks' do
+        expect(runner.steps.map(&:first)).to eql [:map, :format, :my_hook, :primitivize, :serialize]
+      end
+    end
+  end
+
+  it 'should memoize' do
+    expect(runner.formatter).to be runner.formatter
+  end
+
+end

data/spec/unit/yaks/util_spec.rb

@@ -31,7 +31,7 @@ RSpec.describe Yaks::Util do
 
   describe '#camelize' do
     it 'should camelize' do
-      expect(camelize('foo_bar/baz')).to eql 'FooBar::Baz'
+      expect(camelize('foo_bar_moo/baz/booz')).to eql 'FooBarMoo::Baz::Booz'
     end
   end
 
@@ -40,4 +40,10 @@ RSpec.describe Yaks::Util do
       expect(underscore('FooBar::Baz-Quz::Quux')).to eql 'foo_bar/baz__quz/quux'
     end
   end
+
+  describe '#slice_hash' do
+    it '#should retain the given keys from a hash' do
+      expect(slice_hash({a: 1, b:2, c:3}, :a, :c, :d)).to eql(a: 1, c:3)
+    end
+  end
 end

data/yaks.gemspec

@@ -26,11 +26,14 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'concord'      , '~> 0.1.4'
   gem.add_runtime_dependency 'uri_template' , '~> 0.6.0'
   gem.add_runtime_dependency 'rack-accept'  , '~> 0.4.5'
+  gem.add_runtime_dependency 'anima'        , '~> 0.2.0'
+  gem.add_runtime_dependency 'adamantium'   , '~> 0.2.0'
 
   gem.add_development_dependency 'virtus'
-  gem.add_development_dependency 'rspec', '~> 2.99'
+  gem.add_development_dependency 'rspec', '~> 3.0'
   gem.add_development_dependency 'bogus'
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'yard'
   gem.add_development_dependency 'mutant-rspec'
   gem.add_development_dependency 'mutant'
   gem.add_development_dependency 'rspec-its'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaks
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Arne Brasseur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-26 00:00:00.000000000 Z
+date: 2014-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflection
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: anima
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: adamantium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.99'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.99'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bogus
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: mutant-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -196,6 +238,7 @@ files:
 - README.md
 - Rakefile
 - bench/bench.rb
+- bench/bench_1000.rb
 - lib/yaks.rb
 - lib/yaks/breaking_changes.rb
 - lib/yaks/collection_mapper.rb
@@ -208,6 +251,7 @@ files:
 - lib/yaks/format/hal.rb
 - lib/yaks/format/json_api.rb
 - lib/yaks/fp.rb
+- lib/yaks/fp/callable.rb
 - lib/yaks/fp/hash_updatable.rb
 - lib/yaks/fp/updatable.rb
 - lib/yaks/mapper.rb
@@ -223,6 +267,7 @@ files:
 - lib/yaks/primitivize.rb
 - lib/yaks/resource.rb
 - lib/yaks/resource/link.rb
+- lib/yaks/runner.rb
 - lib/yaks/util.rb
 - lib/yaks/version.rb
 - notes.org
@@ -235,8 +280,9 @@ files:
 - spec/json/confucius.collection.json
 - spec/json/confucius.hal.json
 - spec/json/confucius.json_api.json
-- spec/json/hal_plant_collection.json
 - spec/json/john.hal.json
+- spec/json/plant_collection.collection.json
+- spec/json/plant_collection.hal.json
 - spec/json/youtypeitwepostit.collection.json
 - spec/spec_helper.rb
 - spec/support/classes_for_policy_testing.rb
@@ -254,9 +300,11 @@ files:
 - spec/unit/yaks/config_spec.rb
 - spec/unit/yaks/default_policy/derive_mapper_from_object_spec.rb
 - spec/unit/yaks/default_policy_spec.rb
+- spec/unit/yaks/format/collection_json_spec.rb
 - spec/unit/yaks/format/hal_spec.rb
 - spec/unit/yaks/format/json_api_spec.rb
 - spec/unit/yaks/format_spec.rb
+- spec/unit/yaks/fp/callable_spec.rb
 - spec/unit/yaks/fp/hash_updatable_spec.rb
 - spec/unit/yaks/fp/updatable_spec.rb
 - spec/unit/yaks/fp_spec.rb
@@ -273,6 +321,7 @@ files:
 - spec/unit/yaks/primitivize_spec.rb
 - spec/unit/yaks/resource/link_spec.rb
 - spec/unit/yaks/resource_spec.rb
+- spec/unit/yaks/runner_spec.rb
 - spec/unit/yaks/util_spec.rb
 - spec/yaml/confucius.yaml
 - spec/yaml/youtypeitwepostit.yaml
@@ -284,18 +333,22 @@ metadata: {}
 post_install_message: |2+
 
 
-  Breaking Changes in Yaks 0.4.3
+  Breaking Changes in Yaks 0.5.0
   ==============================
 
-  Yaks::Mapper#filter was removed, if you override this method in your
-  mappers to conditionally filter attributes or associations, you will
-  have to override #attributes or #associations instead.
+  Yaks now serializes its output, you no longer have to convert to JSON
+  yourself. Use `skip :serialize' to get the old behavior, or
+  `json_serializer` to use a different JSON implementation.
+
+  The single `after' hook has been replaced with a set of `before',
+  `after', `around' and `skip' hooks.
 
-  When specifying a rel_template, now a single {rel} placeholder is
-  expected instead of {src} and {dest}.
+  If you've created your own subclass of `Yaks::Format' (previously:
+  `Yaks::Serializer'), then you need to update the call to
+  `Format.register'.
 
-  There are other internal changes. See the CHANGELOG and README for full
-  documentation.
+  These are potentially breaking changes. See the CHANGELOG and README
+  for full documentation.
 
 rdoc_options: []
 require_paths:
@@ -312,7 +365,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Serialize to hypermedia. HAL, JSON-API, etc.
@@ -325,8 +378,9 @@ test_files:
 - spec/json/confucius.collection.json
 - spec/json/confucius.hal.json
 - spec/json/confucius.json_api.json
-- spec/json/hal_plant_collection.json
 - spec/json/john.hal.json
+- spec/json/plant_collection.collection.json
+- spec/json/plant_collection.hal.json
 - spec/json/youtypeitwepostit.collection.json
 - spec/spec_helper.rb
 - spec/support/classes_for_policy_testing.rb
@@ -344,9 +398,11 @@ test_files:
 - spec/unit/yaks/config_spec.rb
 - spec/unit/yaks/default_policy/derive_mapper_from_object_spec.rb
 - spec/unit/yaks/default_policy_spec.rb
+- spec/unit/yaks/format/collection_json_spec.rb
 - spec/unit/yaks/format/hal_spec.rb
 - spec/unit/yaks/format/json_api_spec.rb
 - spec/unit/yaks/format_spec.rb
+- spec/unit/yaks/fp/callable_spec.rb
 - spec/unit/yaks/fp/hash_updatable_spec.rb
 - spec/unit/yaks/fp/updatable_spec.rb
 - spec/unit/yaks/fp_spec.rb
@@ -363,6 +419,7 @@ test_files:
 - spec/unit/yaks/primitivize_spec.rb
 - spec/unit/yaks/resource/link_spec.rb
 - spec/unit/yaks/resource_spec.rb
+- spec/unit/yaks/runner_spec.rb
 - spec/unit/yaks/util_spec.rb
 - spec/yaml/confucius.yaml
 - spec/yaml/youtypeitwepostit.yaml