yaks 0.7.7 → 0.8.0.alpha

data/spec/unit/yaks/pipeline_spec.rb

@@ -0,0 +1,140 @@
+RSpec.describe Yaks::Pipeline do
+  subject(:pipeline) { described_class.new(steps) }
+  let(:steps) {
+    [
+      [:step1, ->(i, e) { i + 1 }],
+      [:step2, ->(i, e) { i + 10 }],
+      [:step3, ->(i, e) { i + e[:foo] }],
+    ]
+  }
+  let(:env) {{ foo: 100 }}
+
+  describe '#call' do
+    it 'should call steps in turn, passing in the last result and env' do
+      expect(pipeline.call(1000, env)).to equal 1111
+    end
+  end
+
+  describe '#insert_hooks' do
+    let(:hooks)   { [] }
+
+    describe 'before' do
+      let(:hooks) { [[:before, :step2, :before_step2, ->(i, e) { i - (i % 100) }]] }
+
+      it 'should insert a hook before the step' do
+        expect(pipeline.insert_hooks(hooks).call(1000, env)).to equal 1110
+      end
+    end
+
+    describe 'after' do
+      let(:hooks) { [[:after, :step2, :after_step2, ->(i, e) { i - (i % 100) }]] }
+
+      it 'should insert a hook after the step' do
+        expect(pipeline.insert_hooks(hooks).call(1000, env)).to equal 1100
+      end
+    end
+
+    describe 'around' do
+      let(:hooks) { [[:around, :step2, :after_step2, ->(i, e, &b) { e[:foo] + b[i, e] + b[i, e] }]] }
+
+      it 'should insert a hook after the step' do
+        expect(pipeline.insert_hooks(hooks).call(1000, env)).to equal 2222
+      end
+    end
+
+    describe 'skip' do
+      let(:hooks) { [[:skip, :step2 ]] }
+
+      it 'should insert a hook after the step' do
+        expect(pipeline.insert_hooks(hooks).call(1000, env)).to equal 1101
+      end
+    end
+
+    describe 'multiple hooks' do
+      let(:hooks) {
+        [
+          [:after, :step2, :after_step2, ->(i, e) { i % 10 }],
+          [:skip, :step3]
+        ]
+      }
+
+      it 'should insert the hooks' do
+        expect(pipeline.insert_hooks(hooks).call(1000, env)).to equal 1
+      end
+    end
+
+    it 'should return a pipeline with the right step names' do
+      expect(pipeline
+              .insert_hooks([[:before, :step2, :step1_1, ->(i, e) { i+1 }]])
+              .insert_hooks([[:before, :step1_1, :step1_0, ->(i, e) { i+10 }]])
+              .insert_hooks([[:after,  :step1_1, :step1_2, ->(i, e) { i+100 }]])
+              .insert_hooks([[:around, :step1_1, :step1_1_0, ->(i, e, &b) { b.call(i, e)+1000 }]])
+              .insert_hooks([[:around, :step1_2, :step1_3, ->(i, e, &b) { b.call(i, e)+1000 }]])
+              .insert_hooks([[:after,  :step1_3, :step1_4, ->(i, e) { i + 10000 }]])
+              .call(1000, env)
+            ).to equal 13222
+    end
+
+  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[1].last).to be runner.formatter
+    #     expect(runner.steps[2].last.call).to be :after_format_impl
+    #   end
+    # end
+
+    # describe 'around' do
+    #   let(:hooks) do
+    #     proc {
+    #       around(:serialize) do |res, env, &block|
+    #         "serialized[#{env}][#{block.call(res, env)}]"
+    #       end
+    #     }
+    #   end
+
+    #   it 'should insert a hook around the step' do
+    #     expect(runner.steps.map(&:first)).to eql [
+    #       :map, :format, :primitivize, :serialize
+    #     ]
+    #     expect(runner.steps.assoc(:serialize).last.call(["res1"], "env1")).to eql(
+    #       "serialized[env1][[\n  \"res1\"\n]]"
+    #     )
+    #   end
+    # end
+
+    # describe 'around' do
+    #   let(:hooks) { ->(*) { skip(:serialize) } }
+
+    #   it 'should skip a certain 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
+
+    #   it 'should pass on unchanged steps' do
+    #     expect(runner.steps.assoc(:map)[1]).to eql runner.mapper
+    #   end
+    # end

data/spec/unit/yaks/primitivize_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Primitivize do
   subject(:primitivizer) { described_class.create }
 

data/spec/unit/yaks/resource/link_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Resource::Link do
   subject(:link) { described_class.new(rel: rel, uri: uri, options: options) }
 

data/spec/unit/yaks/resource_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Resource do
   subject(:resource) { described_class.new(init_opts) }
   let(:init_opts) { {} }
@@ -72,10 +70,10 @@ RSpec.describe Yaks::Resource do
     it 'should do updates without modifying the original' do
       expect(
         resource
-          .update_attributes(foo: :bar)
+          .merge_attributes(foo: :bar)
           .add_link(:a_link)
           .add_subresource(:a_subresource)
-          .update_attributes(foo: :baz)
+          .merge_attributes(foo: :baz)
       ).to eq Yaks::Resource.new(
         attributes: {x: :y, foo: :baz},
         links: [:one, :a_link],

data/spec/unit/yaks/runner_spec.rb

@@ -1,20 +1,19 @@
-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(:config) { Yaks.new }
   let(:options) { {} }
 
-  describe '#call' do
+  shared_examples 'high-level runner test' do
+    let(:options) { {env: {foo: "from_env"}} }
     let(:runner) {
       Class.new(described_class) do
         def steps
           [ [:step1, proc { |x| x + 35      }],
-            [:step2, proc { |x| "#{x} #{x}" }] ]
+            [:step2, proc { |x, env| "#{env[:foo]}[#{x} #{x}]" }] ]
         end
       end.new(object: object, config: config, options: options)
     }
@@ -22,10 +21,18 @@ RSpec.describe Yaks::Runner do
     let(:object) { 7 }
 
     it 'should go through all the steps' do
-      expect(runner.call).to eql "42 42"
+      expect(runner.call).to eql "from_env[42 42]"
     end
   end
 
+  describe '#call' do
+    include_examples 'high-level runner test'
+  end
+
+  describe '#process' do
+    include_examples 'high-level runner test'
+  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: [])
@@ -42,7 +49,7 @@ RSpec.describe Yaks::Runner do
 
   describe '#format_class' do
     let(:config) do
-      Yaks::Config.new do
+      Yaks.new do
         default_format :collection_json
       end
     end
@@ -89,7 +96,7 @@ RSpec.describe Yaks::Runner do
     end
 
     context 'with a default format specified' do
-      let(:config) { Yaks::Config.new { default_format :collection_json } }
+      let(:config) { Yaks.new { default_format :collection_json } }
 
       context 'with a format in the options' do
         let(:options) { { format: :json_api } }
@@ -108,7 +115,7 @@ RSpec.describe Yaks::Runner do
 
   describe '#formatter' do
     let(:config) {
-      Yaks::Config.new do
+      Yaks.new do
         default_format :json_api
         format_options :json_api, {format_option: [:foo]}
       end
@@ -142,69 +149,6 @@ RSpec.describe Yaks::Runner do
     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, 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) }
@@ -231,8 +175,8 @@ RSpec.describe Yaks::Runner do
   describe '#serializer' do
     context 'with a serializer configured' do
       let(:config) {
-        Yaks::Config.new do
-          json_serializer do |input|
+        Yaks.new do
+          serializer(:json) do |input|
             "serialized #{input}"
           end
         end
@@ -259,24 +203,12 @@ RSpec.describe Yaks::Runner do
         [ :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
 
   describe '#primitivizer' do
     describe 'with a non json based format' do
       let(:config) do
-        Yaks::Config.new do
+        Yaks.new do
           default_format :html
         end
       end
@@ -294,11 +226,9 @@ RSpec.describe Yaks::Runner do
   end
 
   describe '#hooks' do
-    before do
-      Yaks::Config::DSL.new(config) do
-        after(:map, :this_happens_after_map)
-      end
-    end
+    let(:config) {
+      super().after(:map, :this_happens_after_map)
+    }
 
     it 'should contain the hooks from the config' do
       expect(runner.hooks).to eql [[:after, :map, :this_happens_after_map, nil]]
@@ -313,4 +243,34 @@ RSpec.describe Yaks::Runner do
     end
   end
 
+  describe '#map' do
+    let(:mapper_class) do
+      Struct.new(:options) do
+        include Yaks::FP::Callable
+        def call(obj, env) "mapped[#{obj}]" end
+      end
+    end
+
+    let(:options) { { mapper: mapper_class } }
+    let(:object)  { "foo" }
+
+    it 'should only run the mapper' do
+      expect(runner.map).to eql "mapped[foo]"
+    end
+
+    context 'with a hook on the :map step' do
+      let(:config)  do
+        Yaks.new do
+          around(:map) do |res, env, &block|
+            "around[#{block.call(res, env)}]"
+          end
+        end
+      end
+
+      it 'should invoke the hook as well' do
+        expect(runner.map).to eql "around[mapped[foo]]"
+      end
+    end
+  end
+
 end

data/spec/unit/yaks/serializer_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Serializer do
   after do
     Yaks::Serializer.instance_variable_set("@serializers", nil)

data/spec/unit/yaks/util_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Yaks::Util do
   include Yaks::Util
 
@@ -55,6 +53,18 @@ RSpec.describe Yaks::Util do
     end
   end
 
+  describe '#extract_options' do
+    it 'should extract a final hash' do
+      args, opts = extract_options([:a, :b, {hello: :world}])
+      expect([args, opts]).to eql [[:a, :b], {hello: :world}]
+    end
+
+    it 'should provide an empty hash if none was given' do
+      args, opts = extract_options([:a, :b])
+      expect([args, opts]).to eql [[:a, :b], {}]
+    end
+  end
+
 end
 
 RSpec.describe Yaks::Util::Deprecated do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaks
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.8.0.alpha
 platform: ruby
 authors:
 - Arne Brasseur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-02 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflection
@@ -242,16 +242,17 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".rspec"
 - README.md
 - Rakefile
 - lib/yaks.rb
 - lib/yaks/attributes.rb
 - lib/yaks/breaking_changes.rb
+- lib/yaks/builder.rb
 - lib/yaks/changelog.rb
 - lib/yaks/collection_mapper.rb
 - lib/yaks/collection_resource.rb
 - lib/yaks/config.rb
-- lib/yaks/config/dsl.rb
 - lib/yaks/configurable.rb
 - lib/yaks/default_policy.rb
 - lib/yaks/errors.rb
@@ -263,31 +264,40 @@ files:
 - lib/yaks/fp.rb
 - lib/yaks/fp/callable.rb
 - lib/yaks/html5_forms.rb
+- lib/yaks/identifier/link_relation.rb
 - lib/yaks/mapper.rb
 - lib/yaks/mapper/association.rb
 - lib/yaks/mapper/association_mapper.rb
 - lib/yaks/mapper/attribute.rb
-- lib/yaks/mapper/class_methods.rb
 - lib/yaks/mapper/config.rb
 - lib/yaks/mapper/form.rb
+- lib/yaks/mapper/form/config.rb
 - lib/yaks/mapper/form/field.rb
+- lib/yaks/mapper/form/field/option.rb
+- lib/yaks/mapper/form/fieldset.rb
 - lib/yaks/mapper/has_many.rb
 - lib/yaks/mapper/has_one.rb
 - lib/yaks/mapper/link.rb
 - lib/yaks/null_resource.rb
+- lib/yaks/pipeline.rb
 - lib/yaks/primitivize.rb
+- lib/yaks/reader/hal.rb
 - lib/yaks/resource.rb
 - lib/yaks/resource/form.rb
+- lib/yaks/resource/form/field.rb
+- lib/yaks/resource/form/fieldset.rb
 - lib/yaks/resource/link.rb
 - lib/yaks/runner.rb
 - lib/yaks/serializer.rb
-- lib/yaks/stateful_builder.rb
 - lib/yaks/util.rb
 - lib/yaks/version.rb
+- resources/iana-link-relations.csv
 - spec/acceptance/acceptance_spec.rb
 - spec/acceptance/json_shared_examples.rb
 - spec/acceptance/models.rb
 - spec/fixture_helpers.rb
+- spec/integration/dynamic_form_fields_spec.rb
+- spec/integration/fieldset_spec.rb
 - spec/integration/map_to_resource_spec.rb
 - spec/json/confucius.collection.json
 - spec/json/confucius.hal.json
@@ -309,11 +319,10 @@ files:
 - spec/support/shared_contexts.rb
 - spec/support/youtypeit_models_mappers.rb
 - spec/unit/yaks/attributes_spec.rb
+- spec/unit/yaks/builder_spec.rb
 - spec/unit/yaks/collection_mapper_spec.rb
 - spec/unit/yaks/collection_resource_spec.rb
-- spec/unit/yaks/config/dsl_spec.rb
 - spec/unit/yaks/config_spec.rb
-- spec/unit/yaks/configurable_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
@@ -327,7 +336,6 @@ files:
 - spec/unit/yaks/mapper/association_mapper_spec.rb
 - spec/unit/yaks/mapper/association_spec.rb
 - spec/unit/yaks/mapper/attribute_spec.rb
-- spec/unit/yaks/mapper/class_methods_spec.rb
 - spec/unit/yaks/mapper/config_spec.rb
 - spec/unit/yaks/mapper/form/field_spec.rb
 - spec/unit/yaks/mapper/form_spec.rb
@@ -336,12 +344,12 @@ files:
 - spec/unit/yaks/mapper/link_spec.rb
 - spec/unit/yaks/mapper_spec.rb
 - spec/unit/yaks/null_resource_spec.rb
+- spec/unit/yaks/pipeline_spec.rb
 - 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/serializer_spec.rb
-- spec/unit/yaks/stateful_builder_spec.rb
 - spec/unit/yaks/util_spec.rb
 - spec/yaml/confucius.yaml
 - spec/yaml/youtypeitwepostit.yaml
@@ -351,18 +359,45 @@ licenses:
 - MIT
 metadata:
   changelog: |-
-    General extension and improvements to form handling.
+    Improved Collection+JSON support, dynamically generated form fields.
 
-    Add top level links in Collection+JSON (Carles Jove i Buxeda)
+    #### Collection+JSON
 
-    The mapper DSL method "control" has been renamed to "form". There is a
-    deprecated alias available.
+    Carles Jove i Buxeda has done some great work to improve support for Collection+JSON, GET forms are now rendered as CJ queries.
 
-    Add Yaks::Resource#find_form for querying a resource for an embedded
-    form by name.
+    #### Dynamic Form Fields
 
-    Introduce yaks.map() so you can only call the mapping step without
-    running the whole pipeline.
+    A new introduction are "dynamic" form fields. Up to now it was hard to generate forms based on the object being serialized. Now it's possible to add dynamic sections to a Form definition. These will be evaluated at map-time, they receive the object being mapped, and inside the syntax for defining form fields can be used.
+
+    ```
+    form :checkout do
+      text :name
+      text :lastname
+
+      dynamic do |object|
+        object.shipping_options.each do |shipping|
+          radio shipping.type_name, title: shipping.description
+        end
+      end
+    end
+    ```
+
+    #### Fieldset and Legend
+
+    Support for the fieldset element type has been added, which works as you would expect
+
+    ```
+    form :foo do
+      fieldset do
+        legend "Hello"
+        text :field_1
+      end
+    end
+    ```
+
+    #### Remove links
+
+    A link de
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -374,9 +409,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
@@ -388,6 +423,8 @@ test_files:
 - spec/acceptance/json_shared_examples.rb
 - spec/acceptance/models.rb
 - spec/fixture_helpers.rb
+- spec/integration/dynamic_form_fields_spec.rb
+- spec/integration/fieldset_spec.rb
 - spec/integration/map_to_resource_spec.rb
 - spec/json/confucius.collection.json
 - spec/json/confucius.hal.json
@@ -409,11 +446,10 @@ test_files:
 - spec/support/shared_contexts.rb
 - spec/support/youtypeit_models_mappers.rb
 - spec/unit/yaks/attributes_spec.rb
+- spec/unit/yaks/builder_spec.rb
 - spec/unit/yaks/collection_mapper_spec.rb
 - spec/unit/yaks/collection_resource_spec.rb
-- spec/unit/yaks/config/dsl_spec.rb
 - spec/unit/yaks/config_spec.rb
-- spec/unit/yaks/configurable_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
@@ -427,7 +463,6 @@ test_files:
 - spec/unit/yaks/mapper/association_mapper_spec.rb
 - spec/unit/yaks/mapper/association_spec.rb
 - spec/unit/yaks/mapper/attribute_spec.rb
-- spec/unit/yaks/mapper/class_methods_spec.rb
 - spec/unit/yaks/mapper/config_spec.rb
 - spec/unit/yaks/mapper/form/field_spec.rb
 - spec/unit/yaks/mapper/form_spec.rb
@@ -436,12 +471,12 @@ test_files:
 - spec/unit/yaks/mapper/link_spec.rb
 - spec/unit/yaks/mapper_spec.rb
 - spec/unit/yaks/null_resource_spec.rb
+- spec/unit/yaks/pipeline_spec.rb
 - 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/serializer_spec.rb
-- spec/unit/yaks/stateful_builder_spec.rb
 - spec/unit/yaks/util_spec.rb
 - spec/yaml/confucius.yaml
 - spec/yaml/youtypeitwepostit.yaml