hash_builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d558232e333db81f54b2908babff87135a04524
+  data.tar.gz: 9a7ab805dfed411cd2692581801583b55e2c4589
+SHA512:
+  metadata.gz: 855bc8140cfd594a54e0f9ac6bfcf601c5fc108e0821f2f0cb8d55285d078718e1de2235996037b8c2e04a66a156021edd7106ea93e6355020362929516a8791
+  data.tar.gz: 261c27848fa2040eddde40c2beec7346c56ab35aee6d2bb0a4645f31c13f2c62d43817bcd6e0a78efe78db832f54b92f6fb49072f367b67ddd5d6db9a4b19267

data/.gitignore

@@ -0,0 +1,5 @@
+# Build artifacts
+/pkg
+
+# Bundle config
+/.bundle

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    hash_builder (0.1.0)
+      exec_env
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.1)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    diff-lcs (1.2.4)
+    exec_env (0.1.0)
+    i18n (0.6.5)
+    json (1.8.1)
+    json_builder (3.1.7)
+      activesupport (>= 2.0.0)
+      json
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.4)
+  hash_builder!
+  json_builder
+  rake (~> 10.1)
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Marten Lienen
+
+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,203 @@
+# HashBuilder
+
+This gem allows you to build hashes in a way, that is totally copied from
+[json_builder](https://github.com/dewski/json_builder). I created this,
+because json_builder does not allow extraction of partials, which I rely
+heavily on, to keep my JSON generation DRY.
+And while I was at it, I found it a good idea to increase the abstraction
+level and build hashes instead of JSON because, this allows for easier
+manipulation of the results, application in more different circumstances
+and you can generate JSON and YAML with the well known `to_json` and
+`to_yaml` methods from it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hash_builder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash_builder
+
+## Usage
+
+```ruby
+require "hash_builder"
+require "json"
+require "yaml"
+
+hash = HashBuilder.build do
+  url "https://github.com/CQQL"
+  name "CQQL"
+  age 21
+
+  interests [:ruby, :clojure] do |n|
+    name n
+  end
+
+  loves do
+    example do
+      code :yes
+    end
+  end
+end
+#=> {:url=>"https://github.com/CQQL", :name=>"CQQL", :age=>21, :interests=>[{:name=>:ruby}, {:name=>:clojure}], :loves=>{:example=>{:code=>:yes}}}
+
+hash.to_json
+#=> "{\"url\":\"https://github.com/CQQL\",\"name\":\"CQQL\",\"age\":21,\"interests\":[{\"name\":\"ruby\"},{\"name\":\"clojure\"}],\"loves\":{\"example\":{\"code\":\"yes\"}}}"
+
+hash.to_yaml
+#=> "---\n:url: https://github.com/CQQL\n:name: CQQL\n:age: 21\n:interests:\n- :name: :ruby\n- :name: :clojure\n:loves:\n  :example:\n    :code: :yes\n"
+```
+
+## Usage with rails
+
+To use HashBuilder in a rails app, add the gem to your Gemfile.
+
+```ruby
+gem "hash_builder"
+```
+
+From then on HashBuilder will render `.json_builder` templates as
+JSON. But there is a special case in that HashBuilder actually renders
+partials as hashes instead of JSON strings so that you can use them to
+create nested data structures instead of strings to use in templates.
+
+```ruby
+class HashController < ApplicationController
+  def index
+    @users = [
+      { name: "CQQL", quote: "Emacs > Vim" },
+      { name: "Joshua Bloch", quote: "The cleaner and nicer the program, the faster it's going to run. And if it doesn't, it'll be easy to make it fast." }
+    ]
+  end
+end
+```
+
+```ruby
+# hash/index.json_builder
+num_users @users.size
+
+users @users.map { |u| render partial: "user", locals: { user: u } }
+```
+
+```ruby
+# hash/_user.json_builder
+name user[:name]
+name_length user[:name].size
+quote user[:quote]
+```
+
+A request to `/hash/` returns the following JSON response
+
+```json
+{
+  "num_users": 2,
+  "users": [
+    {
+      "name": "CQQL",
+      "name_length": 4,
+      "quote": "Emacs > Vim"
+    },
+    {
+      "name": "Joshua Bloch",
+      "name_length": 12,
+      "quote": "The cleaner and nicer the program, the faster it's going to run. And if it doesn't, it'll be easy to make it fast."
+    }
+  ]
+}
+```
+
+## Performance
+
+There is a [benchmark script](./benchmark.rb), that returns the
+following results on my machine
+
+```
+$ ruby benchmark.rb 
+                                   user     system      total        real
+HashBuilder                    0.650000   0.070000   0.720000 (  0.714533)
+HashBuilder + JSON.generate    1.290000   0.060000   1.350000 (  1.352620)
+HashBuilder + to_json          4.650000   0.070000   4.720000 (  4.716388)
+JSONBuilder                    1.780000   0.090000   1.870000 (  1.872545)
+```
+
+For some reason transforming hashes to JSON with `to_json` is really slow.
+
+## Tradeoffs
+
+This is built with [exec_env](https://github.com/CQQL/exec_env), so
+there is quite a lot of ruby magic going on under the hood. As long as
+you only use lexical bingings in your block, you won't notice
+anything.
+
+```ruby
+def render_user (user)
+  HashBuilder.build do
+    name user.name
+  end
+end
+```
+
+But your dynamic bindings will be lost, because the block is executed
+in another context.
+
+```ruby
+class User
+  attr_accessor :email
+
+  def to_hash
+    HashBuilder.build do
+      # email accessor is not available here.
+      email_address email # => Error
+    end
+  end
+end
+```
+
+This can be fixed however by explicitly passing a scop.e
+
+```ruby
+class User
+  attr_accessor :email
+
+  def to_hash
+    HashBuilder.build(scope: self) do
+      # All is fine now.
+      email_address email
+    end
+  end
+end
+```
+
+But there is yet another problem. If you tried to set the hash key
+`email`, you would receive an error because the line `email email`
+would actually expand to `user.email(user.email)` if `user` is the
+user object, because `user` responds to `email`. The quite ugly
+workaround looks like this
+
+```ruby
+class User
+  attr_accessor :email
+
+  def to_hash
+    HashBuilder.build(scope: self) do
+      # Bypass scope and local variables
+      xsend :email, email
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/benchmark.rb

@@ -0,0 +1,57 @@
+require "benchmark"
+require "json"
+require "hash_builder"
+require "json_builder"
+
+template = (-> {
+              name "Garrett Bjerkhoel"
+              birthday Time.local(1991, 9, 14)
+              
+              street do
+                address "1143 1st Ave"
+                address2 "Apt 200"
+                city "New York"
+                state "New York"
+                zip 10065
+              end
+              
+              skills do
+                ruby true
+                asp false
+                php true
+                mysql true
+                mongodb true
+                haproxy true
+                marathon false
+              end
+              
+              single_skills ['ruby', 'php', 'mysql', 'mongodb', 'haproxy']
+              booleans [true, true, false, nil]             
+            })
+
+runs = 15000
+Benchmark.bm(28) do |bench|
+  bench.report("HashBuilder") do
+    runs.times do
+      HashBuilder.build(&template)
+    end
+  end
+
+  bench.report("HashBuilder + JSON.generate") do
+    runs.times do
+      JSON.generate(HashBuilder.build(&template))
+    end
+  end
+  
+  bench.report("HashBuilder + to_json") do
+    runs.times do
+      HashBuilder.build(&template).to_json
+    end
+  end
+
+  bench.report("JSONBuilder") do
+    runs.times do
+      JSONBuilder::Compiler.generate(&template)  
+    end
+  end
+end

data/hash_builder.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hash_builder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash_builder"
+  spec.version       = HashBuilder::VERSION
+  spec.authors       = ["Marten Lienen"]
+  spec.email         = ["marten.lienen@gmail.com"]
+  spec.description   = %q{Build hashes with the full power of ruby at your fingertips}
+  spec.summary       = %q{The readme has examples}
+  spec.homepage      = "https://github.com/CQQL/hash_builder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.4"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "json_builder"
+
+  spec.add_dependency "exec_env"
+end

data/lib/hash_builder/template.rb

@@ -0,0 +1,39 @@
+module HashBuilder
+  # Renders templates with '.json_builder' extension.
+  #
+  # If the template is a normal view, it will render a JSON string.
+  # If the template however is a partial, it renders a Hash so that
+  # json_builder files can use partials.
+  class Template
+    def self.default_format
+      Mime::JSON
+    end
+
+    def self.call (template)
+      render_code = <<-RUBY
+HashBuilder.build(scope: self, locals: local_assigns) do
+  #{template.source}
+end
+RUBY
+      if !is_partial?(template)
+        # ActiveModel defines #as_json in a way, that is not compatible
+        # with JSON.
+        if defined?(ActiveModel)
+          render_code = "ActiveSupport::JSON.encode(#{render_code})"
+        else
+          render_code = "JSON.generate(#{render_code})"
+        end
+      end
+      
+      render_code
+    end
+
+    def self.is_partial? (template)
+      template.virtual_path.split("/").last.start_with?("_")
+    end
+  end
+end
+
+if defined?(ActionView)
+  ActionView::Template.register_template_handler :json_builder, HashBuilder::Template
+end

data/lib/hash_builder/version.rb

@@ -0,0 +1,3 @@
+module HashBuilder
+  VERSION = "0.1.0"
+end

data/lib/hash_builder.rb

@@ -0,0 +1,51 @@
+require "exec_env"
+
+require "hash_builder/version"
+require "hash_builder/template"
+
+module HashBuilder
+  # Build a Hash.
+  #
+  # args - Arguments to be passed to the hash
+  # scope - Method calls in the block will be sent to scope object
+  # locals - Local variables to be injected into the block
+  #
+  # Examples
+  #
+  #   HashBuilder.build(locals: {foo: 1}) do
+  #     foo foo
+  #     bar 2
+  #   end
+  #   # => { foo: 1, bar: 2}
+  def self.build (args: [], scope: nil, locals: {}, &block)
+    env = ExecEnv::Env.new
+    env.scope = scope
+    env.locals = locals
+    
+    block_result = env.exec(*args, &block)
+
+    messages = env.messages
+
+    if messages.size > 0
+      hash = {}
+      
+      messages.each do |(name, args, block)|
+        arg = args.first
+        
+        if args.size == 1 && block && arg.is_a?(Enumerable) && !arg.is_a?(Hash)
+          hash[name] = arg.map do |*objects|
+            HashBuilder.build(args: objects, scope: scope, locals: locals, &block)
+          end
+        elsif block
+          hash[name] = HashBuilder.build(scope: scope, locals: locals, &block)
+        elsif args.size == 1
+          hash[name] = arg
+        end
+      end
+
+      hash
+    else
+      block_result
+    end
+  end
+end

data/spec/hash_builder/template_spec.rb

@@ -0,0 +1,29 @@
+require "json"
+
+class ViewStub
+  def local_assigns
+    {}
+  end
+end
+
+describe HashBuilder::Template do
+  let(:view) { ViewStub.new }
+
+  it "should render a template into a JSON string" do
+    template = double("template", source: "foo 1\nbar 'test'", virtual_path: "test/index")
+
+    code = HashBuilder::Template.call(template)
+    json = view.instance_eval(code)
+
+    expect(JSON.parse(json)).to eq({ "foo" => 1, "bar" => "test" })
+  end
+
+  it "should render a hash if the template is a partial" do
+    template = double("template", source: "foo 1\nbar 'test'", virtual_path: "test/_index")
+
+    code = HashBuilder::Template.call(template)
+    hash = view.instance_eval(code)
+
+    expect(hash).to eq({ foo: 1, bar: "test" })
+  end
+end

data/spec/hash_builder_spec.rb

@@ -0,0 +1,64 @@
+describe HashBuilder do
+  it "should construct a simple hash" do
+    hash = HashBuilder.build do
+      key "A test key"
+
+      number 1337
+    end
+
+    expect(hash).to eq({ key: "A test key", number: 1337 })
+  end
+
+  it "should construct nested hashes" do
+    hash = HashBuilder.build do
+      level1 "Easy"
+
+      container do
+        level2 "Harder"
+      end
+    end
+
+    expect(hash).to eq({ level1: "Easy", container: { level2: "Harder" } })
+  end
+
+  it "should iterate over enumerables if arg and block is given" do
+    hash = HashBuilder.build do
+      numbers (0..3).to_a do |num|
+        i num
+      end
+    end
+
+    expect(hash).to eq({ numbers: [{ i: 0 }, { i: 1 }, { i: 2 }, { i: 3 }] })
+  end
+
+  it "should pass the environment into nested blocks" do
+    scope = Object.new
+    scope.instance_variable_set(:@id, 13)
+
+    hash = HashBuilder.build(locals: { user: "CQQL" }, scope: scope) do
+      user do
+        name user
+        id @id
+      end
+    end
+
+    expect(hash).to eq({ user: { id: 13, name: "CQQL" } })
+  end
+
+  it "should not set keys that have no explicit value" do
+    hash = HashBuilder.build do
+      read
+      write 1
+    end
+
+    expect(hash).to eq({ write: 1 })
+  end
+
+  it "should allow setting keys to nil" do
+    hash = HashBuilder.build do
+      foo nil
+    end
+
+    expect(hash).to eq({ foo: nil })
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "hash_builder"

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: hash_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marten Lienen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !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: json_builder
+  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: exec_env
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Build hashes with the full power of ruby at your fingertips
+email:
+- marten.lienen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark.rb
+- hash_builder.gemspec
+- lib/hash_builder.rb
+- lib/hash_builder/template.rb
+- lib/hash_builder/version.rb
+- spec/hash_builder/template_spec.rb
+- spec/hash_builder_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/CQQL/hash_builder
+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.1.5
+signing_key: 
+specification_version: 4
+summary: The readme has examples
+test_files:
+- spec/hash_builder/template_spec.rb
+- spec/hash_builder_spec.rb
+- spec/spec_helper.rb