blockhead 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e2f6018fc079c37204364a6c67616e98ddfbed2
+  data.tar.gz: 4661877ffcd4484944ce3c4f5c5caeb5a01482bb
+SHA512:
+  metadata.gz: 93c2aa2bc903bd8b3e7d078f19e480354497bf1e7a216d1ca80ce9fd263f9c39417e2a821d6ec1015f551bd89ab6e9497b29b4f28dc1316b5655ae1cd7221aad
+  data.tar.gz: 3a9b5e507c747bd739fd1bea248b07c4fcd0f6ae960ff98b0744552ae3da047c71ba1bd5ef6606edb10b04031d9544bb16f86b72870a3d1e4cb12d3a8fccf600

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+script:
+  - "bundle exec rspec"
+rvm:
+  - 2.0.0
+language: ruby

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Vincent Franco
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# Blockhead
+
+[![Build Status](https://travis-ci.org/vinniefranco/blockhead.svg)](https://travis-ci.org/vinniefranco/blockhead.svg)
+[![Code Climate](https://codeclimate.com/github/vinniefranco/blockhead.png)](https://codeclimate.com/github/vinniefranco/blockhead.png)
+Easy marshalling of object attributes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'blockhead'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blockhead
+
+## Usage
+
+Say you have the following object with a 1:1 and a 1:M set of relational attributes:
+
+```ruby
+
+object = OpenStruct.new(
+  title: 'Fancy pants',
+  order_number: 'STORE-1234'
+  items: [
+    OpenStruct.new(name: 'ACD', sku: '1234', ...),
+  ]
+  customer: OpenStruct.new(name: 'Bill Murray', score: 10, ...)
+)
+
+```
+
+And you want to send a different structure to your data warehouse in the format of:
+
+```ruby
+
+{
+  name: 'Bill Murray',
+  order: 'STORE-1234',
+  items: [
+    { name: 'ACD', sku: '1234' }
+  ],
+  customer: {
+    score: 10
+  }
+}
+
+```
+
+To marshal you would just:
+
+```ruby
+
+schema = Blockhead::Schema.define object do
+  name -> { object.customer.name } # Accepts procs with object in scope
+  order_number as: :order # Aliases
+  items do
+    name # Simple definitions on collection attributes
+    sku
+  end
+  customer do
+    score
+  end
+end
+
+schema.marshal #=> { name: 'Bill Murray', order: 'STORE-1234', items: [{ name: 'ACD', sku: '1234' }], customer: { score: 10 } }
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/vinniefranco/blockhead/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/blockhead.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blockhead/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'blockhead'
+  spec.version       = Blockhead::VERSION
+  spec.authors       = ['Vincent Franco']
+  spec.email         = ['vince@freshivore.net']
+  spec.summary       = 'A simple DSL for marshaling objects into a schema'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/vinniefranco/blockhead'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'debugger', '~> 1.6'
+end

data/lib/blockhead.rb

@@ -0,0 +1,13 @@
+require 'blockhead/version'
+require 'blockhead/schema'
+require 'blockhead/marshaller'
+require 'blockhead/option_key'
+require 'blockhead/value_extractor'
+require 'blockhead/extractors/abstract'
+require 'blockhead/extractors/block'
+require 'blockhead/extractors/enumerable'
+require 'blockhead/extractors/proc'
+require 'blockhead/extractors/value'
+
+module Blockhead
+end

data/lib/blockhead/extractors/abstract.rb

@@ -0,0 +1,30 @@
+module Blockhead
+  module Extractors
+    class Abstract
+      attr_writer :next
+      attr_reader :object
+
+      def initialize(object, *args, proc)
+        @object = object
+        @args = args
+        @proc = proc
+      end
+
+      def valid?
+        fail '#valid? not implemented'
+      end
+
+      def extract_value
+        fail '#extract_value not implemented'
+      end
+
+      def extract
+        if valid?
+          extract_value
+        else
+          @next.extract
+        end
+      end
+    end
+  end
+end

data/lib/blockhead/extractors/block.rb

@@ -0,0 +1,13 @@
+module Blockhead
+  module Extractors
+    class Block < Abstract
+      def valid?
+        !!@proc
+      end
+
+      def extract_value
+        Schema.define(object, &@proc).marshal
+      end
+    end
+  end
+end

data/lib/blockhead/extractors/enumerable.rb

@@ -0,0 +1,19 @@
+module Blockhead
+  module Extractors
+    class Enumerable < Abstract
+      def valid?
+        @proc && safe_enumerable?
+      end
+
+      def extract_value
+        object.map { |obj| Block.new(obj, [], @proc).extract_value }
+      end
+
+      private
+
+      def safe_enumerable?
+        object.is_a?(::Enumerable) && !object.is_a?(::Hash)
+      end
+    end
+  end
+end

data/lib/blockhead/extractors/proc.rb

@@ -0,0 +1,19 @@
+module Blockhead
+  module Extractors
+    class Proc < Abstract
+      def valid?
+        arg.is_a?(::Proc)
+      end
+
+      def extract_value
+        arg.call
+      end
+
+      private
+
+      def arg
+        @args.first
+      end
+    end
+  end
+end

data/lib/blockhead/extractors/value.rb

@@ -0,0 +1,13 @@
+module Blockhead
+  module Extractors
+    class Value < Abstract
+      def valid?
+        true
+      end
+
+      def extract_value
+        object
+      end
+    end
+  end
+end

data/lib/blockhead/marshaller.rb

@@ -0,0 +1,29 @@
+module Blockhead
+  class Marshaller < BasicObject
+    attr_reader :attributes, :object
+
+    def initialize(object)
+      @attributes = {}
+      @object = object
+    end
+
+    def marshal
+      attributes
+    end
+
+    def method_missing(name, *args, &block)
+      key = OptionKey.new(name, args.first).key
+      attributes[key] = ValueExtractor.new(_call(name), *args, &block).extract
+    end
+
+    private
+
+    def _call(name)
+      if object.respond_to?(name)
+        object.send name
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/blockhead/option_key.rb

@@ -0,0 +1,24 @@
+module Blockhead
+  class OptionKey
+    attr_reader :default, :options
+
+    def initialize(name, options)
+      @default = name
+      @options = options
+    end
+
+    def key
+      if options?
+        options[:as]
+      else
+        default
+      end
+    end
+
+    private
+
+    def options?
+      options.is_a?(Hash)
+    end
+  end
+end

data/lib/blockhead/schema.rb

@@ -0,0 +1,21 @@
+module Blockhead
+  class Schema
+    attr_reader :object
+
+    def self.define(object, &block)
+      new(object).define(&block)
+    end
+
+    def initialize(object)
+      @object = object
+    end
+
+    def define(&block)
+      fail 'No schema definition' unless block
+      schema = Marshaller.new(object)
+      schema.instance_eval(&block)
+
+      schema
+    end
+  end
+end

data/lib/blockhead/value_extractor.rb

@@ -0,0 +1,24 @@
+module Blockhead
+  class ValueExtractor
+    attr_reader :extractor
+
+    def initialize(value, *args, &block)
+      proc = block.to_proc if block
+      @extractor = Extractors::Enumerable.new value, *args, proc
+
+      extractors.inject(extractor) do |fallback, link|
+        fallback.next = link.new value, *args, proc
+      end
+    end
+
+    def extract
+      extractor.extract
+    end
+
+    private
+
+    def extractors
+      [Extractors::Block, Extractors::Proc, Extractors::Value]
+    end
+  end
+end

data/lib/blockhead/version.rb

@@ -0,0 +1,3 @@
+module Blockhead
+  VERSION = '0.0.5'
+end

data/spec/blockhead/extractors/abstract_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Blockhead::Extractors::Abstract, '#valid?' do
+  let(:blank) { Blockhead::Extractors::Abstract.new(nil, nil, nil) }
+
+  it 'fails with "#valid? not implemented"' do
+    expect { blank.valid? }.to raise_error RuntimeError
+  end
+
+end
+
+describe Blockhead::Extractors::Abstract, '#extract_value' do
+  let(:blank) { Blockhead::Extractors::Abstract.new(nil, nil, nil) }
+
+  it 'fails with #extract_value not implemented' do
+    expect { blank.extract_value }.to raise_error RuntimeError
+  end
+end
+
+describe Blockhead::Extractors::Abstract, '#extract' do
+  let(:blank) { Blockhead::Extractors::Abstract.new(nil, nil, nil) }
+
+  it 'receives #extract_value when valid? is true' do
+    allow(blank).to receive(:valid?) { true }
+    expect(blank).to receive(:extract_value)
+
+    blank.extract
+  end
+
+  it '@next receives #extract when valid? is false' do
+    link = double
+    blank.next = link
+
+    allow(blank).to receive(:valid?) { false }
+    expect(link).to receive(:extract)
+
+    blank.extract
+  end
+end

data/spec/blockhead/extractors/block_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Blockhead::Extractors::Block, '#valid?' do
+  it 'is valid when @proc is assigned' do
+    expect(block_factory).to be_valid
+  end
+end
+
+describe Blockhead::Extractors::Block, '#extract_value' do
+  it 'marshals objects through Schema.define' do
+    expect(block_factory.extract_value).to eq title: 'This'
+  end
+end
+
+def block_factory
+  object = double('poro', title: 'This')
+  Blockhead::Extractors::Block.new object, [], Proc.new { title }
+end

data/spec/blockhead/extractors/enumerable_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Blockhead::Extractors::Enumerable, '#valid?' do
+  it 'is valid with a @proc and a array @value' do
+    extractor = enum_factory([], Proc.new { 'Test.'})
+    expect(extractor).to be_valid
+  end
+
+  it 'is invalid without a @proc' do
+    extractor = enum_factory([], nil)
+    expect(extractor).to_not be_valid
+  end
+
+  it 'is invalid with the incorrect @value type' do
+    extractor = enum_factory('', Proc.new { title })
+    expect(extractor).to_not be_valid
+  end
+end
+
+describe Blockhead::Extractors::Enumerable, '#extract_value' do
+  it 'passes elements in value to Schema with @proc' do
+    item = double(title: 'Foo')
+    extractor = enum_factory([item], Proc.new { title })
+    expect(extractor.extract_value).to eq [{ title: 'Foo' }]
+  end
+end
+
+def enum_factory(object, proc = nil)
+  Blockhead::Extractors::Enumerable.new(object, [], proc)
+end

data/spec/blockhead/extractors/proc_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Blockhead::Extractors::Proc, '#valid?' do
+  it 'is valid when a proc is passed in as the first argument' do
+    expect(proc_factory).to be_valid
+  end
+end
+
+describe Blockhead::Extractors::Proc, '#extract_value' do
+  it "uses the body of the proc as it's extracted value" do
+    expect(proc_factory.extract_value).to eq 'test'
+  end
+
+  it 'has @value within scope on extract' do
+    value = double(title: 'This')
+    proc = proc_factory(-> { "#{value.title} is a title" }, value)
+    expect(proc.extract_value).to eq 'This is a title'
+  end
+end
+
+def proc_factory(proc = -> { 'test' }, value = nil)
+  Blockhead::Extractors::Proc.new value, proc, nil
+end

data/spec/blockhead/extractors/value_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Blockhead::Extractors::Value, '#valid?' do
+  it 'returns true' do
+    extractor = Blockhead::Extractors::Value.new('test', [], nil)
+    expect(extractor).to be_valid
+  end
+end
+
+describe Blockhead::Extractors::Value, '#extract_value' do
+  it 'returns @value unmolested' do
+    extractor = Blockhead::Extractors::Value.new('test', [], nil)
+    expect(extractor.extract_value).to eq 'test'
+  end
+end

data/spec/blockhead/schema_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+require 'debugger'
+require 'ostruct'
+
+describe Blockhead::Schema, '::define' do
+  class Tester
+    def title
+      'Title'
+    end
+
+    def description
+      'Description'
+    end
+
+    def nested_array
+      [OpenStruct.new(sku: '1234')]
+    end
+
+    def nested_obj
+      OpenStruct.new(sku: '4321', price: OpenStruct.new(base: 1200))
+    end
+
+    def empty_array
+      []
+    end
+  end
+
+
+  it 'returns a hash' do
+    schema = schema_with { title }
+
+    expect(schema.marshal).to be_a Hash
+  end
+
+  it 'marshals objects methods' do
+    schema = schema_with do
+      title
+      description
+    end
+
+    expect(schema.marshal).to eq title: 'Title', description: 'Description'
+  end
+
+  it 'handles nil attributes' do
+    schema = schema_with do
+      title
+      description
+      not_found
+    end
+    response = { title: 'Title', description: 'Description', not_found: nil }
+    expect(schema.marshal).to eq response
+  end
+
+  it 'accepts hash aliases' do
+    schema = schema_with do
+      title as: 'header'
+      description as: 'body'
+    end
+
+    expect(schema.marshal).to eq 'header' => 'Title', 'body' => 'Description'
+  end
+
+  it 'accepts procs' do
+    schema = schema_with do
+      summary -> { "#{object.title} #{object.description}" }
+    end
+
+    expect(schema.marshal).to eq summary: 'Title Description'
+  end
+
+  it 'handles nested objects' do
+    schema = schema_with do
+      nested_obj do
+        sku
+        price do
+          base
+        end
+      end
+    end
+    result = { nested_obj: { sku: '4321', price: { base: 1200 } } }
+
+    expect(schema.marshal).to eq result
+  end
+
+  it 'handles nested objects with aliases' do
+    schema = schema_with do
+      nested_obj as: :cart do
+        sku
+        price do
+          base as: :cost
+        end
+      end
+    end
+
+    expect(schema.marshal).to eq cart: { sku: '4321', price: { cost: 1200 } }
+  end
+
+  it 'handles collections of objects' do
+    schema = schema_with do
+      nested_array as: :cart do
+        sku
+      end
+    end
+
+    expect(schema.marshal).to eq cart: [{ sku: '1234' }]
+  end
+
+  it 'handles empty collections' do
+    schema = schema_with do
+      title
+      empty_array
+    end
+
+    expect(schema.marshal).to eq title: 'Title', empty_array: []
+  end
+
+  def schema_with(&block)
+    Blockhead::Schema.define(Tester.new, &block)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'debugger'
+require 'bundler/setup'
+Bundler.require

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: blockhead
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Vincent Franco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: A simple DSL for marshaling objects into a schema
+email:
+- vince@freshivore.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- blockhead.gemspec
+- lib/blockhead.rb
+- lib/blockhead/extractors/abstract.rb
+- lib/blockhead/extractors/block.rb
+- lib/blockhead/extractors/enumerable.rb
+- lib/blockhead/extractors/proc.rb
+- lib/blockhead/extractors/value.rb
+- lib/blockhead/marshaller.rb
+- lib/blockhead/option_key.rb
+- lib/blockhead/schema.rb
+- lib/blockhead/value_extractor.rb
+- lib/blockhead/version.rb
+- spec/blockhead/extractors/abstract_spec.rb
+- spec/blockhead/extractors/block_spec.rb
+- spec/blockhead/extractors/enumerable_spec.rb
+- spec/blockhead/extractors/proc_spec.rb
+- spec/blockhead/extractors/value_spec.rb
+- spec/blockhead/schema_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/vinniefranco/blockhead
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '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: A simple DSL for marshaling objects into a schema
+test_files:
+- spec/blockhead/extractors/abstract_spec.rb
+- spec/blockhead/extractors/block_spec.rb
+- spec/blockhead/extractors/enumerable_spec.rb
+- spec/blockhead/extractors/proc_spec.rb
+- spec/blockhead/extractors/value_spec.rb
+- spec/blockhead/schema_spec.rb
+- spec/spec_helper.rb