yaks 0.8.3 → 0.9.0

data/spec/unit/yaks/format/json_api_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe Yaks::Format::JsonAPI do
 
     it 'should not include a "linked" key' do
       expect(format.call(resource)).to eql(
-        {'wizards' => [{foo: :bar}]}
+        {data: [{type: :wizards, foo: :bar}]}
       )
     end
   end
@@ -28,8 +28,9 @@ RSpec.describe Yaks::Format::JsonAPI do
     # TODO should it really behave this way? better to give preference to self link.
     it 'should give preference to the href attribute' do
       expect(format.call(resource)).to eql(
-        {'wizards' => [
+        {data: [
             {
+              type: :wizards,
               href: '/the/href'
             }
           ]
@@ -38,4 +39,92 @@ RSpec.describe Yaks::Format::JsonAPI do
     end
   end
 
+  context 'with a self link' do
+    let(:resource) {
+      Yaks::Resource.new(
+          type: 'wizard',
+          links: [
+              Yaks::Resource::Link.new(rel: :self, uri: '/the/self/link')
+          ]
+      )
+    }
+    it 'should use the self link in output' do
+      expect(format.call(resource)).to eql(
+         {data: [
+             {
+                 type: :wizards,
+                 href: '/the/self/link'
+             }
+         ]
+         }
+      )
+
+    end
+  end
+
+  context 'with subresources' do
+    let(:resource) {
+      Yaks::Resource.new(
+          type: 'wizard',
+          subresources: [
+              Yaks::Resource.new(type: 'spell', attributes: {id: 777, name: 'Lucky Sevens'})
+          ]
+      )
+    }
+    it 'should include links and linked' do
+      expect(format.call(resource)).to eql(
+         {
+           data: [
+             {
+               type: :wizards,
+               links: {'spell'  => {type: 'spells', id: 777}}
+             }
+           ],
+           linked: [{type: :spells, id: 777, name: 'Lucky Sevens'}]
+         }
+      )
+    end
+
+  end
+
+  context 'with null subresources' do
+    let(:resource) {
+      Yaks::Resource.new(
+          type: 'wizard',
+          subresources: [
+              Yaks::NullResource.new
+          ]
+      )
+    }
+    it 'should not include links' do
+      expect(format.call(resource)).to eql(
+         {data: [
+             {
+                 type: :wizards,
+             }
+         ]
+         }
+      )
+    end
+  end
+
+  context 'with no subresources or links' do
+    let(:resource) {
+      Yaks::Resource.new(
+          type: 'wizard',
+          subresources: []
+      )
+    }
+    it 'should not include links' do
+      expect(format.call(resource)).to eql(
+         {data: [
+             {
+                 type: :wizards
+             }
+         ]
+         }
+      )
+    end
+  end
+
 end

data/spec/unit/yaks/mapper/form/field_spec.rb

@@ -1,9 +1,10 @@
 RSpec.describe Yaks::Mapper::Form::Field do
   include_context 'yaks context'
 
-  let(:field)   { described_class.new( full_args ) }
+  let(:field)     { described_class.new( full_args ) }
   let(:name)      { :the_field }
-  let(:full_args) { {name: name}.merge(args) }
+  let(:full_args) { {name: name, options: options}.merge(args) }
+  let(:options)   { [] }
   let(:args) {
     {
       label: 'a label',
@@ -12,7 +13,11 @@ RSpec.describe Yaks::Mapper::Form::Field do
     }
   }
 
-  let(:mapper) { Yaks::Mapper.new(yaks_context) }
+  let(:mapper) do
+    Class.new(Yaks::Mapper) do
+      def month ; 'January' ; end
+    end.new(yaks_context)
+  end
 
   describe '.create' do
     it 'can take all args as a hash' do
@@ -28,9 +33,62 @@ RSpec.describe Yaks::Mapper::Form::Field do
     end
   end
 
-  describe '#to_resource_field' do
+  describe '#to_resource_fields' do
     it 'creates a Yaks::Resource::Form::Field with the same attributes' do
-      expect(field.to_resource(mapper)).to eql Yaks::Resource::Form::Field.new(full_args)
+      expect(field.to_resource_fields(mapper)).to eql [Yaks::Resource::Form::Field.new(full_args)]
+    end
+
+    context 'with dynamic attributes' do
+      let(:name) { ->{ month } }
+
+      it 'should expand attributes using the mapper' do
+        expect(field.to_resource_fields(mapper).first.name).to eql 'January'
+      end
+    end
+
+    context 'with a falsey if condition' do
+      let(:args) { super().merge(if: ->{ false })}
+      it 'returns an empty array' do
+        expect(field.to_resource_fields(mapper)).to eql []
+      end
+    end
+
+    context 'with a truthy if condition' do
+      let(:args) { super().merge(if: ->{ true })}
+      it 'returns a field' do
+        expect(field.to_resource_fields(mapper).first).to be_a Yaks::Resource::Form::Field
+      end
+    end
+
+    context 'with select optons' do
+      let(:options) {
+        [
+          Yaks::Mapper::Form::Field::Option.new(
+            label: 'Jan',
+            value: ->{ 'January' },
+            selected: ->{ month == 'January' }
+          ),
+          Yaks::Mapper::Form::Field::Option.new(
+            label: 'Feb',
+            value: ->{ 'February' },
+            selected: ->{ month == 'February' }
+          )
+        ]
+      }
+
+      it 'should convert them to Yaks::Form* objects' do
+        form_field = Yaks::Resource::Form::Field.new(
+          name: :the_field,
+          label: "a label",
+          options: [
+            Yaks::Resource::Form::Field::Option.new(value: "January", label: "Jan", selected: true),
+            Yaks::Resource::Form::Field::Option.new(value: "February", label: "Feb")
+          ],
+          type: "text",
+          value: "hello"
+        )
+        expect(field.to_resource_fields(mapper)).to eql [form_field]
+      end
     end
   end
 end

data/spec/unit/yaks/mapper/form/fieldset_spec.rb

@@ -0,0 +1,30 @@
+RSpec.describe Yaks::Mapper::Form::Fieldset do
+  include_context 'yaks context'
+  let(:mapper) { Yaks::Mapper.new(yaks_context) }
+
+  describe '#to_resource_fields' do
+    context 'with dynamic elements' do
+      let(:fieldset) do
+        described_class.create({}) do
+          dynamic do |object|
+            text object.name
+          end
+        end
+      end
+
+      it 'should render them based on the mapped object' do
+        mapper.call(fake(name: :anthony)) # hack to set the mapper's object
+        expect(fieldset.to_resource_fields(mapper)).to eql(
+          [
+            Yaks::Resource::Form::Fieldset.new(
+              fields: [
+                Yaks::Resource::Form::Field.new(name: :anthony, type: :text)
+              ]
+            )
+          ]
+        )
+      end
+    end
+  end
+
+end

data/spec/unit/yaks/mapper/form_spec.rb

@@ -14,6 +14,7 @@ RSpec.describe Yaks::Mapper::Form do
     }
   }
   let(:fields) { [] }
+  let(:mapper) { Yaks::Mapper.new(yaks_context) }
 
   describe '.create' do
     it 'should have a name of nil when ommitted' do
@@ -22,7 +23,6 @@ RSpec.describe Yaks::Mapper::Form do
   end
 
   describe '#add_to_resource' do
-    let(:mapper) { Yaks::Mapper.new(yaks_context) }
     let(:resource) { form.new.add_to_resource(Yaks::Resource.new, mapper, nil) }
 
     context 'with fields' do
@@ -54,5 +54,29 @@ RSpec.describe Yaks::Mapper::Form do
       end
     end
 
+    describe '#to_resource_form' do
+      context 'with dynamic elements' do
+        let(:form) do
+          described_class.create(name) do
+            dynamic do |object|
+              text object.name
+            end
+          end
+        end
+
+        it 'should render them based on the mapped object' do
+          mapper.call(fake(name: :anthony)) # hack to set the mapper's object
+          expect(form.to_resource_form(mapper)).to eql(
+            Yaks::Resource::Form.new(
+              name: :the_name,
+              fields: [
+                Yaks::Resource::Form::Field.new(name: :anthony, type: :text)
+              ]
+            )
+          )
+        end
+      end
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaks
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.0
 platform: ruby
 authors:
 - Arne Brasseur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-09 00:00:00.000000000 Z
+date: 2015-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflection
@@ -272,6 +272,7 @@ files:
 - lib/yaks/mapper/config.rb
 - lib/yaks/mapper/form.rb
 - lib/yaks/mapper/form/config.rb
+- lib/yaks/mapper/form/dynamic_field.rb
 - lib/yaks/mapper/form/field.rb
 - lib/yaks/mapper/form/field/option.rb
 - lib/yaks/mapper/form/fieldset.rb
@@ -282,6 +283,7 @@ files:
 - lib/yaks/pipeline.rb
 - lib/yaks/primitivize.rb
 - lib/yaks/reader/hal.rb
+- lib/yaks/reader/json_api.rb
 - lib/yaks/resource.rb
 - lib/yaks/resource/form.rb
 - lib/yaks/resource/form/field.rb
@@ -325,6 +327,7 @@ files:
 - spec/unit/yaks/collection_mapper_spec.rb
 - spec/unit/yaks/collection_resource_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
@@ -341,6 +344,7 @@ files:
 - spec/unit/yaks/mapper/config_spec.rb
 - spec/unit/yaks/mapper/form/field/option_spec.rb
 - spec/unit/yaks/mapper/form/field_spec.rb
+- spec/unit/yaks/mapper/form/fieldset_spec.rb
 - spec/unit/yaks/mapper/form_spec.rb
 - spec/unit/yaks/mapper/has_many_spec.rb
 - spec/unit/yaks/mapper/has_one_spec.rb
@@ -416,6 +420,7 @@ test_files:
 - spec/unit/yaks/collection_mapper_spec.rb
 - spec/unit/yaks/collection_resource_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
@@ -432,6 +437,7 @@ test_files:
 - spec/unit/yaks/mapper/config_spec.rb
 - spec/unit/yaks/mapper/form/field/option_spec.rb
 - spec/unit/yaks/mapper/form/field_spec.rb
+- spec/unit/yaks/mapper/form/fieldset_spec.rb
 - spec/unit/yaks/mapper/form_spec.rb
 - spec/unit/yaks/mapper/has_many_spec.rb
 - spec/unit/yaks/mapper/has_one_spec.rb