hard-boiled 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in hard-boiled.gemspec
+gemspec
+
+gem 'rspec'

data/README.md

@@ -0,0 +1,40 @@
+## HardBoiled
+
+simply define mapping from you model to a simple hash. For those who worked with [thoughtbot](http://thoughtbot.com)'s [factory girl](http://github.com/thoughtbot/factory_girl) the DSL should be familiar.
+
+### Installation
+
+    gem install hard-boiled
+
+### Usage
+
+```ruby
+require 'hard-boiled'
+
+egg = OpenStruct.new({
+  :boil_time => 7,
+  :temperature => 99,
+  :colour => "beige"
+})
+
+HardBoiled::Presenter.define egg do
+  time :from => :boil_time
+  colour
+  temperature :format => "%d ℃"
+end # => { :time => 7, :temperature => "99 ℃", :colour => "beige" }
+```
+
+for more examples see the tests in the `spec` directory.
+
+### Similar Projects
+
+If _hard-boiled_ isn't your cup of tea, go and check out other ways to map models
+to hashes (for data serialization):
+
+* [Representative](https://github.com/mdub/representative)
+* [Tokamak](https://github.com/abril/tokamak)
+* [Builder](http://rubygems.org/gems/builder)
+* [JSONify](https://github.com/bsiggelkow/jsonify)
+* [Argonaut](https://github.com/jbr/argonaut)
+* [JSON Builder](https://github.com/dewski/json_builder)
+* [RABL](https://github.com/nesquena/rabl)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/hard-boiled.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hard-boiled/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hard-boiled"
+  s.version     = Hard::Boiled::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Lennart Melzer"]
+  s.email       = ["me@lmaa.name"]
+  s.homepage    = ""
+  s.summary     = %q{Get your models boiled down to plain hashes!}
+  s.description = %q{
+    HardBoiled helps you reducing your complex models (including their associations)
+    down to simple hashes usable for serialization into JSON or XML.
+
+    It leverages a DSL similar to thoughtbot's FactoryGirl 
+    to make mappings maintainable and pain-free.
+  }
+
+  s.rubyforge_project = "hard-boiled"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/hard-boiled.rb

@@ -0,0 +1,3 @@
+module HardBoiled
+  autoload :Presenter, 'hard-boiled/presenter'
+end

data/lib/hard-boiled/extract_options.rb

@@ -0,0 +1,32 @@
+# Somebody said, I won't depend on `ActiveSupport` for one method. Ok
+# these are two but still… taken from the
+# [rails project](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/array/extract_options.rb)
+class Hash
+  # By default, only instances of Hash itself are extractable.
+  # Subclasses of Hash may implement this method and return
+  # true to declare themselves as extractable. If a Hash
+  # is extractable, Array#extract_options! pops it from
+  # the Array when it is the last element of the Array.
+  def extractable_options?
+    instance_of?(Hash)
+  end
+end
+
+class Array
+  # Extracts options from a set of arguments. Removes and returns the last
+  # element in the array if it's a hash, otherwise returns a blank hash.
+  #
+  #   def options(*args)
+  #     args.extract_options!
+  #   end
+  #
+  #   options(1, 2)           # => {}
+  #   options(1, 2, :a => :b) # => {:a=>:b}
+  def extract_options!
+    if last.is_a?(Hash) && last.extractable_options?
+      pop
+    else
+      {}
+    end
+  end
+end

data/lib/hard-boiled/presenter.rb

@@ -0,0 +1,67 @@
+module HardBoiled
+  require File.dirname(__FILE__)+'/extract_options' unless {}.respond_to?(:extractable_options?)
+
+  # This class pretty much resembles what Thoughtbot did in 
+  # [FactoryGirl's DefinitionProxy](https://github.com/thoughtbot/factory_girl/blob/master/lib/factory_girl/definition_proxy.rb)
+  # although it just reduces a `class` to a simple `Hash`
+  class Presenter
+    class MissingFilterError < StandardError; end
+    UNPROXIED_METHODS = %w(__send__ __id__ nil? respond_to? class send object_id extend instance_eval initialize block_given? raise)
+
+    (instance_methods + private_instance_methods).each do |m|
+      undef_method m unless UNPROXIED_METHODS.include? m
+    end
+
+    attr_reader :subject, :parent_subject
+
+    def self.define object, parent = nil, &block
+      new(object, parent).
+      instance_eval(&block).
+      to_hash
+    end
+
+    def initialize subject, parent = nil
+      @subject = subject
+      @parent_subject = parent
+      @hash = {}
+    end
+
+    def to_hash
+      @hash
+    end
+
+    private
+    def method_missing id, *args, &block
+      options = args.extract_options!
+      value = options[:nil] ? nil : (args.shift || (options[:parent] ? parent_subject : subject).__send__(options[:from] || id))
+      @hash[id] =
+        if block_given?
+          if value.kind_of? Array
+            value.map do |v|
+              self.class.define(v, self.subject, &block)
+            end
+          else
+            self.class.define(value, self.subject, &block)
+          end
+        else
+          __format_value __apply_filters(value, options), options
+        end
+      self
+    end
+    
+    def __apply_filters value, options
+      if filters = options[:filters]
+        filters.inject(value) { |result, filter|
+          raise MissingFilterError unless self.respond_to?(filter)
+          self.__send__(filter, result)
+        }
+      else
+        value
+      end
+    end
+
+    def __format_value value, options
+      (format = options[:format]) ? format % value : value
+    end
+  end
+end

data/lib/hard-boiled/version.rb

@@ -0,0 +1,5 @@
+module Hard
+  module Boiled
+    VERSION = "0.0.1"
+  end
+end

data/spec/presenter_spec.rb

@@ -0,0 +1,97 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+module MyFilters
+  def upcase value
+    value.upcase
+  end
+
+  def twice_and_a_half value
+    value * 2.5
+  end
+end
+
+class Filterable < HardBoiled::Presenter
+  include MyFilters
+end
+
+describe HardBoiled::Presenter do
+  let(:egg) { 
+    OpenStruct.new({:temperature => 25, :boil_time => 7, :colour => "white"})
+  }
+
+  it "should produce correct hash" do
+    definition = described_class.define egg do
+      colour
+      time :from => :boil_time
+      consumer "Lennart"
+    end
+
+    definition.should == {
+      :colour => "white",
+      :time => 7,
+      :consumer => "Lennart"
+    }
+  end
+
+  context :nested do
+    let(:egg_box) {
+      OpenStruct.new({
+        :eggs => [egg],
+        :flavour => "extra tasty",
+        :packaged_at => "2011-11-22"
+      })
+    }
+
+    it "should allow nested objects" do
+      definition = Filterable.define egg_box do
+        contents :from => :eggs do
+          colour
+          time :from => :boil_time, :filters => [:twice_and_a_half], :format => "%.2f minutes"
+          taste :from => :flavour, :parent => true
+          consumer "Lennart", :filters => [:upcase]
+        end
+
+        date :from => :packaged_at, :format => "on %s"
+      end
+
+      definition.should == {
+        :contents => [
+          {
+            :colour => "white",
+            :time => "17.50 minutes",
+            :consumer => "LENNART",
+            :taste => "extra tasty"
+          }
+        ],
+        :date => "on 2011-11-22"
+      }
+    end
+  end
+
+  context :filtering do
+    it "should apply filters" do
+      definition = Filterable.define egg do
+        colour :filters => [:upcase]
+        time :from => :boil_time
+        consumer "Lennart"
+      end
+        
+      definition.should == {
+        :colour => "WHITE",
+        :time => 7,
+        :consumer => "Lennart"
+      }
+    end
+
+    it "should raise on missing filter" do
+      expect {
+        definition = described_class.define egg do
+          colour :filters => [:upcase]
+          time :from => :boil_time
+          consumer "Lennart"
+        end
+      }.to raise_error(HardBoiled::Presenter::MissingFilterError)
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'hard-boiled'
+
+require 'ostruct'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: hard-boiled
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Lennart Melzer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-23 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: "\n    HardBoiled helps you reducing your complex models (including their associations)\n    down to simple hashes usable for serialization into JSON or XML.\n\n    It leverages a DSL similar to thoughtbot's FactoryGirl \n    to make mappings maintainable and pain-free.\n  "
+email: 
+- me@lmaa.name
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- hard-boiled.gemspec
+- lib/hard-boiled.rb
+- lib/hard-boiled/extract_options.rb
+- lib/hard-boiled/presenter.rb
+- lib/hard-boiled/version.rb
+- spec/presenter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: hard-boiled
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Get your models boiled down to plain hashes!
+test_files: 
+- spec/presenter_spec.rb
+- spec/spec_helper.rb