halogen 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecf269aadcd3040623710454934d01055e58f022
-  data.tar.gz: c389775b46ff5daabf1bb4ccaae8b4967f4eaf89
+  metadata.gz: 03f1c7cbbf77576c156629d55eb72a584853202d
+  data.tar.gz: b58d6a047ada10cbf8420c58c5d10834a054023f
 SHA512:
-  metadata.gz: f9ae4d73ca13c7ad45c68c718a527111b522adcc9b02772d641403edb9e642c564afd0a5172b2cb6908c034a35059a03f143555af0a812ad2a97e488529d67c9
-  data.tar.gz: a36c479ad935f1f2d74df13f14afb7652630dc6a9ca37b652cbf64499f2198b3afc839889f4c7328f0eb154b3265180b26799f065c60827ac4a447a4e767f256
+  metadata.gz: c18323cfdca7e3611c12a98d90b98447554fc7910f6db87a476051e79f48bad919757b5f885c2448584178f788783cf370068216ce82ca13169d373a8f6cfccd
+  data.tar.gz: 7e72385b86d49fccb69ffded60a2ee5fde898423d25f4339aef5b690354e8b0ddd81e315ec3f809df0e8ee6d9c6d2014cf64bc9bfca3adfd795fb76d85b5ff62

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in halogen.gemspec
 gemspec

data/README.md

@@ -1,6 +1,8 @@
 # Halogen
 
 [![Code Climate](https://codeclimate.com/repos/552430af695680100500b659/badges/cdae8d5a10147d135be9/gpa.svg)](https://codeclimate.com/repos/552430af695680100500b659/feed)
+[![Build Status](https://travis-ci.org/mode/halogen.svg?branch=master)](https://travis-ci.org/mode/halogen)
+[![Gem Version](https://badge.fury.io/rb/halogen.svg)](http://badge.fury.io/rb/halogen)
 
 This library provides a framework-agnostic interface for generating
 [HAL+JSON](http://stateless.co/hal_specification.html)

data/lib/halogen/collection.rb

@@ -30,14 +30,14 @@ module Halogen
     end
 
     module InstanceMethods # :nodoc:
-      # Override super to ensure that the primary collection is always embedded
+      # Ensure that the primary collection is always embedded
       #
       # @param key [String] the embed key to check
       #
       # @return [true, false] whether the given key should be embedded
       #
       def embed?(key)
-        super || key == self.class.collection_name
+        key == self.class.collection_name
       end
     end
   end

data/lib/halogen/embeds.rb

@@ -30,8 +30,6 @@ module Halogen
       #
       def embedded
         render_definitions(Definition.name) do |definition, result|
-          next unless embed?(definition.name.to_s)
-
           value = instance_eval(&definition.procedure)
 
           child = embedded_child(definition.name.to_s, value)
@@ -40,8 +38,8 @@ module Halogen
         end
       end
 
-      # @return [Hash, Array<Hash>] either a single rendered child representer
-      #   or an array of them
+      # @return [nil, Hash, Array<Hash>] either a single rendered child
+      #   representer or an array of them
       #
       def embedded_child(key, value)
         return unless value
@@ -87,20 +85,10 @@ module Halogen
       # @return [Hash] hash of options with top level string keys
       #
       def embed_options
-        options.fetch(:embed, {}).tap do |result|
+        @_embed_options ||= options.fetch(:embed, {}).tap do |result|
           Halogen::HashUtil.stringify_keys!(result)
         end
       end
-
-      # @param key [String]
-      #
-      # @return [true, false] whether to embed the key
-      #
-      def embed?(key)
-        return false unless embed_options.include?(key)
-
-        !%w(0 false).include?(embed_options.fetch(key).to_s)
-      end
     end
   end
 end

data/lib/halogen/embeds/definition.rb

@@ -14,6 +14,38 @@ module Halogen
 
         fail InvalidDefinition, "Embed #{name} must be defined with a proc"
       end
+
+      # Check whether this definition should be embedded for the given instance
+      #
+      # @param instance [Object]
+      #
+      # @return [true, false]
+      #
+      def enabled?(instance)
+        return false unless super
+
+        if instance.respond_to?(:embed?)
+          instance.embed?(name.to_s)
+        else
+          embed_via_options?(instance)
+        end
+      end
+
+      private
+
+      # @param instance [Object]
+      #
+      # @return [true, false]
+      #
+      def embed_via_options?(instance)
+        opts = instance.embed_options
+
+        # Definition name must appear in instance embed option keys
+        return false unless opts.include?(name.to_s)
+
+        # Check value of embed option for definition name
+        !%w(0 false).include?(opts.fetch(name.to_s).to_s)
+      end
     end
   end
 end

data/lib/halogen/links.rb

@@ -9,7 +9,7 @@ module Halogen
     end
 
     module ClassMethods # :nodoc:
-      # @return [Halogen::Embeds::Definition]
+      # @return [Halogen::Links::Definition]
       #
       def link(name, *args, &procedure)
         definitions.add(Definition.new(name, *args, procedure))
@@ -27,11 +27,9 @@ module Halogen
       #
       def links
         render_definitions(Definition.name) do |definition, result|
-          attrs = definition.options.fetch(:attrs, {})
+          value = definition.value(self)
 
-          href = definition.value(self)
-
-          result[definition.name] = attrs.merge(href: href) if href
+          result[definition.name] = value if value
         end
       end
     end

data/lib/halogen/links/definition.rb

@@ -23,6 +23,23 @@ module Halogen
              'Link requires either procedure or explicit value'
       end
 
+      # @return [nil, Hash]
+      #
+      def value(_instance)
+        hrefs = super
+
+        attrs = options.fetch(:attrs, {})
+
+        case hrefs
+        when Array
+          hrefs.map { |href| attrs.merge(href: href) }
+        when nil
+          # no-op
+        else
+          attrs.merge(href: hrefs)
+        end
+      end
+
       class << self
         # Build hash of options from flexible definition arguments
         #

data/lib/halogen/properties.rb

@@ -12,7 +12,7 @@ module Halogen
       # @param name [Symbol, String]
       # @param options [nil, Hash]
       #
-      # @return [Halogen::Embeds::Definition]
+      # @return [Halogen::Properties::Definition]
       #
       def property(name, options = {}, &procedure)
         definitions.add(Definition.new(name, options, procedure))

data/lib/halogen/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 #
 module Halogen
-  VERSION = '0.0.2' # :nodoc:
+  VERSION = '0.0.3' # :nodoc:
 end

data/spec/halogen/collection_spec.rb

@@ -44,34 +44,16 @@ describe Halogen::Collection do
 
   describe Halogen::Collection::InstanceMethods do
     describe '#embed?' do
-      it 'returns true if super is true' do
-        klass.collection_name = 'bar'
-
-        klass.embed(:foo) { klass.new }
-
-        repr = klass.new(embed: { foo: 1 })
-
-        expect(repr.embed?('foo')).to eq(true)
-      end
-
       it 'returns true if key matches collection name' do
         klass.collection_name = 'foo'
 
-        klass.embed(:foo) { klass.new }
-
-        repr = klass.new(embed: { foo: 0 })
-
-        expect(repr.embed?('foo')).to eq(true)
+        expect(klass.new.embed?('foo')).to eq(true)
       end
 
-      it 'returns false if no conditions match' do
+      it 'returns false if key does not match' do
         klass.collection_name = 'bar'
 
-        klass.embed(:foo) { klass.new }
-
-        repr = klass.new(embed: { foo: 0 })
-
-        expect(repr.embed?('foo')).to eq(false)
+        expect(klass.new.embed?('foo')).to eq(false)
       end
     end
   end

data/spec/halogen/embeds/definition_spec.rb

@@ -20,4 +20,48 @@ describe Halogen::Embeds::Definition do
       end
     end
   end
+
+  describe '#enabled?' do
+    let :definition do
+      Halogen::Embeds::Definition.new(:name, {}, proc {})
+    end
+
+    it 'is true if instance rules return true' do
+      repr = double(:repr, embed?: true)
+
+      expect(definition.enabled?(repr)).to eq(true)
+    end
+
+    it 'is false if instance rules return false' do
+      repr = double(:repr, embed?: false)
+
+      expect(definition.enabled?(repr)).to eq(false)
+    end
+  end
+
+  describe '#embed_via_options?' do
+    let :klass do
+      Class.new { include Halogen }
+    end
+
+    it 'is true for expected values' do
+      [1, 2, true, '1', '2', 'true', 'yes'].each do |value|
+        repr = klass.new(embed: { foo: value })
+
+        definition = Halogen::Embeds::Definition.new(:foo, {}, proc {})
+
+        expect(definition.send(:embed_via_options?, repr)).to eq(true)
+      end
+    end
+
+    it 'is false for expected values' do
+      [0, false, '0', 'false'].each do |value|
+        repr = klass.new(embed: { foo: value })
+
+        definition = Halogen::Embeds::Definition.new(:foo, {}, proc {})
+
+        expect(definition.send(:embed_via_options?, repr)).to eq(false)
+      end
+    end
+  end
 end

data/spec/halogen/embeds_spec.rb

@@ -185,23 +185,5 @@ describe Halogen::Embeds do
         expect(representer.embed_options).to eq('some' => { options: 1 })
       end
     end
-
-    describe '#embed?' do
-      it 'is true for expected values' do
-        [1, 2, true, '1', '2', 'true', 'yes'].each do |value|
-          representer = klass.new(embed: { foo: value })
-
-          expect(representer.embed?('foo')).to eq(true)
-        end
-      end
-
-      it 'is false for expected values' do
-        [0, false, '0', 'false'].each do |value|
-          representer = klass.new(embed: { foo: value })
-
-          expect(representer.embed?('foo')).to eq(false)
-        end
-      end
-    end
   end
 end

data/spec/halogen/links/definition_spec.rb

@@ -21,6 +21,40 @@ describe Halogen::Links::Definition do
     end
   end
 
+  describe '#value' do
+    it 'handles multiple hrefs' do
+      definition = Halogen::Links::Definition.new(
+        :name, proc { %w(first second) })
+
+      expect(definition.value(nil)).to eq([
+        { href: 'first' },
+        { href: 'second' }
+      ])
+    end
+
+    it 'handles multiple hrefs with additional attributes' do
+      definition = Halogen::Links::Definition.new(
+        :name, { attrs: { foo: 'bar' } }, proc { %w(first second) })
+
+      expect(definition.value(nil)).to eq([
+        { href: 'first', foo: 'bar' },
+        { href: 'second', foo: 'bar' }
+      ])
+    end
+
+    it 'handles single href' do
+      definition = Halogen::Links::Definition.new(:name, proc { 'first' })
+
+      expect(definition.value(nil)).to eq(href: 'first')
+    end
+
+    it 'is nil for nil href' do
+      definition = Halogen::Links::Definition.new(:name, proc {})
+
+      expect(definition.value(nil)).to be_nil
+    end
+  end
+
   describe '.build_options' do
     it 'has expected value without options hash' do
       options = Halogen::Links::Definition.build_options([])

data/spec/halogen/links_spec.rb

@@ -27,6 +27,14 @@ describe Halogen::Links do
             foo: 'foo', attrs: { templated: true, bar: 'bar' })
           expect(link.procedure.call).to eq('path')
         end
+
+        it 'handles multiple values' do
+          klass.link(:self) { %w(foo bar) }
+
+          rendered = klass.new.render[:_links][:self]
+
+          expect(rendered).to eq([{ href: 'foo' }, { href: 'bar' }])
+        end
       end
 
       describe 'without procedure' do
@@ -54,6 +62,30 @@ describe Halogen::Links do
           end
         end
       end
+
+      it 'converts string rel to symbol' do
+        link = klass.link('ea:find', value: 'path')
+
+        expect(link.name).to eq(:'ea:find')
+      end
+    end
+  end
+
+  describe Halogen::Links::InstanceMethods do
+    describe '#links' do
+      let :klass do
+        Class.new do
+          include Halogen
+
+          link(:self) { nil }
+        end
+      end
+
+      it 'does not include link if value is nil' do
+        repr = klass.new
+
+        expect(repr.links).to eq({})
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: halogen
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Heather Rivers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-07 00:00:00.000000000 Z
+date: 2015-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json