yaks 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17023a2415d74fcf0ea0c840dfa7f1d2fcb8afb4
-  data.tar.gz: 3fc6a562a7ba74d7064d2898f04ed32d1ba1b3b4
+  metadata.gz: 558f64d7a2d93038fc00cad3ff0c7442b3458e6f
+  data.tar.gz: 60e1a98b810c825d8bc44efa69fda28656970153
 SHA512:
-  metadata.gz: 159c85fc53b2b7aa8e6fbc9a23fa3c1fa969f667e36e96c58e97ac4bc76b52bf7aaa1e95e309d319c121eeaafd30dc71a7de7fef3cca0173aae844593f3a5238
-  data.tar.gz: c0ec3d24906a2b12accd6548e574679e239def3d9e71228e1c35812c302c8c92afc118d3af47927b82e5c329bfeee0190df7b8b8f54300c1f3bc7eb1ca6a21db
+  metadata.gz: 362873163152bd0ca6466a70b0aeb2c58bb8b024ead9920af7869697aef5d6a52a5b50a5b31973afee16213da5f1dc85734e833ca9a8b9b9b634d10b047bfa1f
+  data.tar.gz: 9ab584641aacf534cdd60c42f13229073867f8e3f83973d78ef92cd268574656272c15311a7091cc3764dab74f89612e0d51a09d2a02009867a210406958de1d

data/find_missing_tests.rb

@@ -20,7 +20,7 @@ env = Mutant::Env::Bootstrap.call(Mutant::CLI.call(args))
 integration = env.config.integration
 
 integration.setup
-binding.pry if integration.all_tests.empty?      # rubocop:disable Lint/Debugger
+binding.pry if integration.all_tests.empty? # rubocop:disable Lint/Debugger
 
 env.subjects.each do |subject|
   match_expression = subject.match_expressions.first

data/lib/yaks/format/halo.rb

@@ -21,7 +21,7 @@ module Yaks
 
       def serialize_form(form)
         raw = form.to_h_compact
-        raw[:href]  = raw.delete(:action) if raw[:action]
+        raw[:href] = raw.delete(:action) if raw[:action]
         raw[:fields] = form.fields.map(&method(:serialize_form_field))
         raw
       end

data/lib/yaks/mapper/association_mapper.rb

@@ -9,7 +9,7 @@ module Yaks
         @context       = context.merge(
           mapper_stack: context[:mapper_stack] + [parent_mapper]
         )
-        @rel           = association.map_rel(policy)
+        @rel           = association.map_rel(policy) # rubocop:disable Style/ExtraSpacing
       end
 
       def policy

data/lib/yaks/mapper/attribute.rb

@@ -1,19 +1,22 @@
 module Yaks
   class Mapper
     class Attribute
-      include Attribs.new(:name, :block)
-      include Util
+      extend Forwardable, Util
+      include Attribs.new(:name, :block, if: true), Util
 
-      def self.create(name, _options = nil, &block)
-        new(name: name, block: block)
+      def self.create(name, options = {}, &block)
+        new(options.merge(name: name, block: block))
       end
 
       def add_to_resource(resource, mapper, _context)
+        return resource unless Resolve(self.if, mapper)
+
         if block
           attribute = Resolve(block, mapper)
         else
           attribute = mapper.load_attribute(name)
         end
+
         resource.merge_attributes(name => attribute)
       end
     end

data/lib/yaks/null_resource.rb

@@ -14,7 +14,7 @@ module Yaks
       to_enum
     end
 
-    def collection?
+    def collection? # rubocop:disable Style/TrivialAccessors
       @collection
     end
 

data/lib/yaks/reader/json_api.rb

@@ -7,13 +7,13 @@ module Yaks
         if parsed_json['data'].is_a?(Array)
           CollectionResource.new(
             attributes: parsed_json['meta'].nil? ? nil : {meta: parsed_json['meta']},
-            members: parsed_json['data'].map { |data| call('data'  => data, 'included' => included) }
+            members: parsed_json['data'].map { |data| call('data' => data, 'included' => included) }
           )
         else
           attributes = parsed_json['data'].dup
           links = attributes.delete('links') || {}
           relationships = attributes.delete('relationships') || {}
-          type  = attributes.delete('type')
+          type = attributes.delete('type')
           attributes.merge!(attributes.delete('attributes') || {})
 
           embedded   = convert_embedded(Hash[relationships], included)
@@ -48,14 +48,14 @@ module Yaks
               CollectionResource.new(
                 members: data.map { |link|
                   data = included.find{ |item| (item['id'] == link['id']) && (item['type'] == link['type']) }
-                  call('data'  => data, 'included' => included)
+                  call('data' => data, 'included' => included)
                 },
                 rels: [rel]
               )
             end
           else
             data = included.find{ |item| (item['id'] == data['id']) && (item['type'] == data['type']) }
-            call('data'  => data, 'included' => included).with(rels: [rel])
+            call('data' => data, 'included' => included).with(rels: [rel])
           end
         end.compact
       end

data/lib/yaks/resource/form.rb

@@ -18,7 +18,7 @@ module Yaks
         !method.nil? && method.downcase.to_sym == meth.downcase.to_sym
       end
 
-      def has_action?                      # rubocop:disable Style/PredicateName
+      def has_action? # rubocop:disable Style/PredicateName
         !action.nil?
       end
     end

data/lib/yaks/util.rb

@@ -46,7 +46,7 @@ module Yaks
     #   A proc or a plain value
     # @param [Object] context
     #   (optional) A context used to instance_eval the proc
-    def Resolve(maybe_proc, context = nil)    # rubocop:disable Style/MethodName
+    def Resolve(maybe_proc, context = nil) # rubocop:disable Style/MethodName
       if maybe_proc.respond_to?(:to_proc) && !maybe_proc.instance_of?(Symbol)
         if context
           if maybe_proc.arity > 0

data/lib/yaks/version.rb

@@ -1,3 +1,3 @@
 module Yaks
-  VERSION = '0.11.0'
+  VERSION = '0.12.0'
 end

data/spec/acceptance/acceptance_spec.rb

@@ -70,6 +70,6 @@ RSpec.describe Yaks::Format::CollectionJson do
       end
     }
 
-    include_examples 'JSON Writer',  'youtypeitwepostit'
+    include_examples 'JSON Writer', 'youtypeitwepostit'
   end
 end

data/spec/acceptance/json_shared_examples.rb

@@ -1,6 +1,6 @@
 RSpec.shared_examples_for 'JSON Writer' do |fixture_name|
   describe 'Yaks::Resource => JSON' do
-    let(:object)  { load_yaml_fixture(fixture_name) }
+    let(:object) { load_yaml_fixture(fixture_name) }
     let(:json_fixture) { load_json_fixture("#{fixture_name}.#{format_name}") }
     let(:serialized) {
       yaks_config.call(object, hooks: [[:skip, :serialize]], format: format_name)

data/spec/unit/yaks/config_spec.rb

@@ -12,9 +12,9 @@ RSpec.describe Yaks::Config do
       its(:default_format)      { should equal :hal }
       its(:policy_class)        { should <= Yaks::DefaultPolicy }
       its(:primitivize)         { should be_a Yaks::Primitivize }
-      its(:serializers)         { should eql(Yaks::Serializer.all)  }
-      its(:hooks)               { should eql([])  }
-      its(:format_options_hash) { should eql({})}
+      its(:serializers)         { should eql(Yaks::Serializer.all) }
+      its(:hooks)               { should eql([]) }
+      its(:format_options_hash) { should eql({}) }
     end
   end
 

data/spec/unit/yaks/configurable_spec.rb

@@ -1,3 +1,5 @@
+require 'securerandom'
+
 class Kitten
   include Attribs.new(:furriness)
 

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

@@ -322,7 +322,7 @@ RSpec.describe Yaks::Format::CollectionJson do
               ],
               "queries" => [
                 {"href" => "/foo", "rel" => "search", "prompt" => "My query prompt",
-                 "data" =>                   [
+                 "data" => [
                     {"name" => "foo", "value" => ""},
                     {"name" => "bar", "value" => "", "prompt" => "My Bar Field"}
                   ]

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

@@ -56,7 +56,7 @@ RSpec.describe Yaks::Mapper::Association do
     end
 
     context 'with a truthy condition' do
-      let(:if)     { ->{ true } }
+      let(:if) { ->{ true } }
 
       it 'should add the association' do
         expect(association.add_to_resource(Yaks::Resource.new, parent_mapper, yaks_context).subresources.length).to be 1
@@ -70,7 +70,7 @@ RSpec.describe Yaks::Mapper::Association do
     end
 
     context 'with a falsey condition' do
-      let(:if)     { ->{ false } }
+      let(:if) { ->{ false } }
 
       it 'should not add the association' do
         expect(association.add_to_resource(Yaks::Resource.new, parent_mapper, yaks_context).subresources.length).to be 0
@@ -182,7 +182,7 @@ RSpec.describe Yaks::Mapper::Association do
     end
 
     it 'should not munge the options hash' do
-      opts  = {mapper: :foo}
+      opts = {mapper: :foo}
       association_class.create(:foo, opts)
       expect(opts).to eql(mapper: :foo)
     end

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

@@ -2,7 +2,6 @@ RSpec.describe Yaks::Mapper::Attribute do
   include_context 'yaks context'
 
   let(:attribute_with_block) { described_class.create(:the_name) { "Alice" } }
-
   subject(:attribute) { described_class.create(:the_name) }
   fake(:mapper)
 
@@ -13,10 +12,11 @@ RSpec.describe Yaks::Mapper::Attribute do
 
   describe ".create" do
     its(:name) { should be :the_name }
+    its(:if) { should be_truthy }
     its(:block) { should be_nil }
 
-    it "should accept two parameter" do
-      expect{described_class.create(:the_name, {})}.not_to raise_error()
+    it "should accept only the name" do
+      expect{described_class.create(:the_name)}.not_to raise_error()
     end
 
     context "with block" do
@@ -28,14 +28,95 @@ RSpec.describe Yaks::Mapper::Attribute do
         expect(subject.block.call).to eq("Alice")
       end
     end
+
+    describe "options" do
+
+      let(:object) { Struct.new(:x, :y, :returns_nil).new(3, 4, nil) }
+
+      let(:mapper_class) do
+        Class.new(Yaks::Mapper) do
+          type 'foo'
+        end
+      end
+
+      let(:mapper) do
+        mapper_class.new(yaks_context).tap do |mapper|
+          mapper.call(object) # set @object
+        end
+      end
+
+      subject(:attribute) { described_class.create(:the_name, options) }
+
+      context 'with :if defined and resolving to false' do
+
+        let(:options) { {if: ->{ false }} }
+
+        it 'should not render the attribute' do
+          expect(attribute.add_to_resource(Yaks::Resource.new, mapper, yaks_context)).not_to eql(
+            Yaks::Resource.new(attributes: {the_name: 123})
+          )
+        end
+      end
+
+      context 'with :if defined and resolving to true' do
+        let(:options) { {if: ->{ true }} }
+
+        it 'should render the attribute' do
+          expect(attribute.add_to_resource(Yaks::Resource.new, mapper, yaks_context)).to eql(
+            Yaks::Resource.new(attributes: {the_name: 123})
+          )
+        end
+      end
+
+      context 'with :if defined and resolving to true via instance_eval' do
+        let(:options) { {if: ->{ object.name.length > 2 } } }
+
+        it 'should render the attribute' do
+          expect(attribute.add_to_resource(Yaks::Resource.new, mapper, yaks_context)).to eql(
+            Yaks::Resource.new(attributes: {the_name: 123})
+          )
+        end
+      end
+    end
+
   end
 
   describe "#add_to_resource" do
+
+    let(:options) { {if: ->{ true }} }
+    let(:options_false) { {if: ->{ 0 == 1 }} }
+    let(:attribute_with_block_and_false_options) {described_class.create(:the_name,options_false) { "Alice" } }
+    let(:attribute_with_block_and_options) { described_class.create(:the_name,options) { "Alice" } }
+
+
+
     it "should add itself to a resource based on a lookup" do
       expect(attribute.add_to_resource(Yaks::Resource.new, mapper, yaks_context))
         .to eql(Yaks::Resource.new(attributes: {the_name: 123}))
     end
 
+    context "when the attribute has a block and true options" do
+      subject(:attribute) { attribute_with_block_and_options }
+
+      it "should add itself to a resource with the block value" do
+        expect(attribute.add_to_resource(Yaks::Resource.new, mapper, yaks_context))
+          .to eql(Yaks::Resource.new(attributes: {the_name: "Alice"}))
+      end
+
+      
+    end
+
+    context "when the attribute has a block and false options" do
+      subject(:attribute) { attribute_with_block_and_false_options }
+
+      it "should not add itself to a resource with the block value" do
+        expect(attribute.add_to_resource(Yaks::Resource.new, mapper, yaks_context))
+          .not_to eql(Yaks::Resource.new(attributes: {the_name: "Alice"}))
+      end
+
+      
+    end
+
     context "when the attribute has a block" do
       subject(:attribute) { attribute_with_block }
 

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

@@ -22,7 +22,7 @@ RSpec.describe Yaks::Mapper::Form::Fieldset do
 
     context "with extra options" do
       let(:fieldset) {
-        described_class.create if: true  do
+        described_class.create if: true do
           text :first_name
         end
       }

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

@@ -72,7 +72,7 @@ RSpec.describe Yaks::Mapper::HasMany do
   describe '#collection_mapper' do
     let(:collection_mapper) { Yaks::Undefined }
 
-    subject(:has_many)  { described_class.new(name: :name, item_mapper: :mapper, rel: :rel, collection_mapper: collection_mapper) }
+    subject(:has_many) { described_class.new(name: :name, item_mapper: :mapper, rel: :rel, collection_mapper: collection_mapper) }
 
     context 'when the collection mapper is undefined' do
       it 'should derive one from collection and policy' do

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

@@ -3,7 +3,7 @@ RSpec.describe Yaks::Mapper::HasOne do
 
   AuthorMapper = Class.new(Yaks::Mapper) { attributes :name }
 
-  subject(:has_one)  do
+  subject(:has_one) do
     described_class.new(
       name: :author,
       item_mapper: association_mapper,

data/spec/unit/yaks/pipeline_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe Yaks::Pipeline do
   end
 
   describe '#insert_hooks' do
-    let(:hooks)   { [] }
+    let(:hooks) { [] }
 
     describe 'before' do
       let(:hooks) { [[:before, :step2, :before_step2, ->(i, _e) { i - (i % 100) }]] }

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

@@ -10,7 +10,7 @@ RSpec.describe Yaks::Resource::Link do
   its(:options) { should eql(title: 'mr. spectacular') }
 
   describe '#title' do
-    its(:title)      { should eql('mr. spectacular') }
+    its(:title) { should eql('mr. spectacular') }
   end
 
   describe '#templated?' do

data/spec/unit/yaks/runner_spec.rb

@@ -20,7 +20,7 @@ RSpec.describe Yaks::Runner do
     let(:runner) {
       Class.new(described_class) do
         def steps
-          [ [:step1, proc { |x| x + 35      }],
+          [ [:step1, proc { |x| x + 35 }],
             [:step2, proc { |x, env| "#{env[:foo]}[#{x} #{x}]" }] ]
         end
       end.new(object: object, config: config, options: options)
@@ -337,7 +337,7 @@ RSpec.describe Yaks::Runner do
       }
     }
 
-    let(:object)  { "foo" }
+    let(:object) { "foo" }
 
     it 'should only run the mapper' do
       expect(runner.map).to eql "mapped[foo]"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaks
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Arne Brasseur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-09 00:00:00.000000000 Z
+date: 2016-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abstract_type
@@ -465,7 +465,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Serialize to hypermedia. HAL, JSON-API, etc.