halogen 0.0.1

data/spec/halogen_spec.rb

@@ -0,0 +1,127 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+describe Halogen do
+  let :klass do
+    Class.new { include Halogen }
+  end
+
+  describe Halogen::ClassMethods do
+    describe '#resource' do
+      it 'includes resource module' do
+        klass = Class.new { include Halogen }
+
+        expect(klass).to receive(:define_resource)
+
+        klass.resource :foo
+
+        expect(klass.included_modules.include?(Halogen::Resource)).to eq(true)
+      end
+    end
+
+    describe '#collection' do
+      it 'includes collection module' do
+        klass = Class.new { include Halogen }
+
+        expect(klass).to receive(:define_collection)
+
+        klass.collection :foo
+
+        expect(klass.included_modules.include?(Halogen::Collection)).to eq(true)
+      end
+    end
+  end
+
+  describe Halogen::InstanceMethods do
+    describe '#initialize' do
+      it 'symbolizes option keys' do
+        repr = klass.new(
+          'embed'  => { 'foo' => 'bar' },
+          'ignore' => 'this',
+          :convert => 'that')
+
+        expect(repr.options).to eq(
+          embed:   { 'foo' => 'bar' },
+          ignore:  'this',
+          convert: 'that'
+        )
+      end
+    end
+
+    describe '#render' do
+      let :rendered do
+        klass.new.render
+      end
+
+      it 'renders simple link' do
+        klass.link(:label) { 'href' }
+
+        expect(rendered[:_links][:label]).to eq(href: 'href')
+      end
+
+      it 'does not include link if conditional checks fail' do
+        klass.send(:define_method, :return_false) { false }
+        klass.send(:define_method, :return_nil)   { nil }
+
+        klass.link(:label) { 'href' }
+
+        klass.link(:label_2, if: false)          { 'href' }
+        klass.link(:label_3, if: proc { false }) { 'href' }
+        klass.link(:label_4, if: proc { nil })   { 'href' }
+        klass.link(:label_5, if: :return_false)  { 'href' }
+
+        expect(rendered[:_links].keys).to eq([:label])
+      end
+
+      it 'includes link if conditional checks pass' do
+        klass.send(:define_method, :return_true) { true }
+        klass.send(:define_method, :return_one)  { 1 }
+
+        klass.link(:label) { 'href' }
+
+        klass.link(:label_2, if: true)          { 'href' }
+        klass.link(:label_3, if: proc { true }) { 'href' }
+        klass.link(:label_4, if: proc { 1 })    { 'href' }
+        klass.link(:label_5, if: :return_true)  { 'href' }
+
+        expected = [:label, :label_2, :label_3, :label_4, :label_5]
+        expect(rendered[:_links].keys).to eq(expected)
+      end
+    end
+
+    describe '#depth' do
+      it 'is zero for top level representer' do
+        expect(klass.new.depth).to eq(0)
+      end
+
+      it 'has expected value for embedded children' do
+        parent = klass.new
+
+        child = klass.new
+        allow(child).to receive(:parent).and_return(parent)
+
+        grandchild = klass.new
+        allow(grandchild).to receive(:parent).and_return(child)
+
+        expect(parent.depth).to eq(0)
+        expect(child.depth).to eq(1)
+        expect(grandchild.depth).to eq(2)
+      end
+    end
+
+    describe '#to_json' do
+      it 'converts rendered representer to json' do
+        expect(klass.new.to_json).to eq('{}')
+      end
+    end
+  end
+
+  describe '.config' do
+    it 'yields configuration instance' do
+      Halogen.configure do |config|
+        expect(config).to eq(Halogen.config)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+#
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec'
+end
+
+require 'bundler/setup'
+Bundler.setup
+
+require 'halogen'

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: halogen
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Heather Rivers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Provides a framework-agnostic interface for generating HAL+JSON representations
+  of resources
+email:
+- heather@modeanalytics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/extensions.md
+- examples/simple.rb
+- halogen.gemspec
+- lib/halogen.rb
+- lib/halogen/collection.rb
+- lib/halogen/configuration.rb
+- lib/halogen/definition.rb
+- lib/halogen/definitions.rb
+- lib/halogen/embeds.rb
+- lib/halogen/embeds/definition.rb
+- lib/halogen/errors.rb
+- lib/halogen/hash_util.rb
+- lib/halogen/links.rb
+- lib/halogen/links/definition.rb
+- lib/halogen/properties.rb
+- lib/halogen/properties/definition.rb
+- lib/halogen/railtie.rb
+- lib/halogen/resource.rb
+- lib/halogen/version.rb
+- spec/halogen/collection_spec.rb
+- spec/halogen/configuration_spec.rb
+- spec/halogen/definition_spec.rb
+- spec/halogen/definitions_spec.rb
+- spec/halogen/embeds/definition_spec.rb
+- spec/halogen/embeds_spec.rb
+- spec/halogen/links/definition_spec.rb
+- spec/halogen/links_spec.rb
+- spec/halogen/properties_spec.rb
+- spec/halogen/resource_spec.rb
+- spec/halogen_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mode/halogen
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: HAL+JSON generator
+test_files:
+- spec/halogen/collection_spec.rb
+- spec/halogen/configuration_spec.rb
+- spec/halogen/definition_spec.rb
+- spec/halogen/definitions_spec.rb
+- spec/halogen/embeds/definition_spec.rb
+- spec/halogen/embeds_spec.rb
+- spec/halogen/links/definition_spec.rb
+- spec/halogen/links_spec.rb
+- spec/halogen/properties_spec.rb
+- spec/halogen/resource_spec.rb
+- spec/halogen_spec.rb
+- spec/spec_helper.rb
+has_rdoc: