jsonit 0.0.1 → 0.0.2

data/{LICENCE → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (C) 2011 by Klaas Speller
+Copyright (C) 2011 by Voormedia B.V.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -4,8 +4,13 @@ Jsonit provides a way to quickly construct handcrafted json documents.
 Jsonit requires objects to respond to `#to_json`.  
 It will attempt to load the json gem if this is not the case.
 
+## Installation
+
+`gem install jsonit`
+
 ## Usage
 
+
 ``` ruby
 require 'json'    # Jsonit expects a #to_json method on object.
 require 'jsonit'
@@ -150,7 +155,7 @@ MyApp.controllers :photos do
   end
 
   get :show, :with => :photo_id, :provides => :json do
-    render :'photo/show'
+    render :'photos/show'
   end
 end
 ```
@@ -162,6 +167,6 @@ Jsonit is currently under active development.
 
 ## LICENSE
 
-Json is Copyright (c) 2011 Klaas Speller and Voormedia and distributed under the MIT license. See the LICENCE file for more info.
+Json is Copyright (c) 2011 Voormedia B.V. and distributed under the MIT license. See the LICENSE file for more info.
 
 

data/jsonit.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "json"
   s.add_development_dependency "tilt"
   s.add_development_dependency "rspec"
+  s.add_development_dependency "mocha"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/jsonit/builder.rb

@@ -1,51 +1,58 @@
 module Jsonit
   class Builder
 
-    instance_methods.each { |m| undef_method(m) unless m.to_s =~ /^__|object_id/ }
+    instance_methods.each { |m| undef_method(m) unless m.to_s =~ /^__|object_id|\?$|!$/ }
 
-    def initialize
-      @document = scoped! do
-        yield self if block_given?
-      end
+    def initialize(scope={})
+      @document = @current_scope = scope
+      yield self if block_given?
     end
 
     def to_s
-      @document.to_json
+      to_json
     end
 
-    def to_json(*)
-      to_s
+    def to_json(*args)
+      @document.to_json(*args)
     end
 
-    def set!(key, value=nil, &blk)
-      @current_scope[key] = if !block_given?
-        value
-      elsif value
+    def set!(key=nil, value=nil, &blk)
+      if !block_given?
+        assign!(key, value)
+      elsif value.is_a?(Enumerable)
         array!(key, value, &blk)
       else
-        object!(key, &blk)
+        object!(key, value, &blk)
       end
+      self
     end
-    alias_method :method_missing, :set!
-    
-    private
 
-    def scoped!
+    def object!(key=nil, value=nil, &blk)
       @current_scope, previous_scope = {}, @current_scope
-      yield
-      @current_scope
-    ensure
-      @current_scope = previous_scope
+      yield value
+      @current_scope, new_scope = previous_scope, @current_scope
+      !key.nil? ? assign!(key, new_scope) : Builder.new(new_scope)
     end
-
-    def object!(key, &blk)
-      scoped!(&blk)
+    
+    def array!(key, collection=[], &blk)
+      collection.map! { |itm| object!(nil, itm, &blk) } if block_given?
+      assign!(key, collection)
     end
 
-    def array!(key, collection, &blk)
-      collection.map do |itm|
-        scoped! { blk.call(itm) }
+    def assign!(key, value=nil)
+      if value.is_a?(Hash) && @current_scope[key].is_a?(Hash)
+        @current_scope[key].merge!(value)
+      else
+        @current_scope[key] = value
+      end
+      self
+    end
+    
+    def method_missing(meth, *args, &blk)
+      if (meth.to_s =~ /\?$|!$/).nil?
+        return set!(meth, *args, &blk)
       end
+      super
     end
   end
 end

data/lib/jsonit/version.rb

@@ -1,3 +1,3 @@
 module Jsonit
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/jsonit/builder_spec.rb

@@ -1,64 +1,165 @@
 require "spec_helper"
 require "jsonit/builder"
 
-describe Jsonit::Builder, "Building json" do
-  specify "a simple object" do
-    Jsonit::Builder.new.to_json.should == %|{}|
-  end
+describe Jsonit::Builder do
+
+  describe ".new" do
+    it 'represents an empty object' do
+      Jsonit::Builder.new.to_json.should == %|{}|
+    end
+
+    it 'sets the root scope if provided' do
+      scope = { :foo => "bar" }
+      Jsonit::Builder.new(scope).to_json.should == %|{"foo":"bar"}|
+    end
 
-  specify "a simple object with a string value" do
-    Jsonit::Builder.new do |json|
-      json.foo "bar"
-    end.to_json.should == %|{"foo":"bar"}|
+    it 'evaluates the passed block' do
+      obj = mock()
+      obj.expects(:ping).once
+      Jsonit::Builder.new do |json|
+        obj.ping
+      end.to_json
+    end
   end
 
-  specify "#to_json" do
-    expect { Jsonit::Builder.new.to_json }.to_not raise_error
+  describe "#set!" do
+    let(:json) { Jsonit::Builder.new }
+
+    it 'returns an instance of self' do
+      json.set!.should be_a Jsonit::Builder
+    end
+
+    it 'sets a key value pair' do
+      json.set!(:foo, "bar").to_json.should == %|{"foo":"bar"}|
+    end
+
+    it 'sets value to null if not provided' do
+      json.set!(:foo).to_json.should == %|{"foo":null}|
+    end
+
+    it 'sets value to an object if block is provided' do
+      json.set!(:foo) { }.to_json.should == %|{"foo":{}}|
+    end
+
+    it 'sets values on nested object within block' do
+      json.set!(:foo) { json.set!(:a, "b") }.should == %|{"foo":{"a":"b"}}|
+    end
   end
 
-  specify "a nested object" do
-    Jsonit::Builder.new do |json|
-      json.foo do
-        json.bar "baz"
-      end
+  describe "#object!" do
+    let(:json) { Jsonit::Builder.new }
 
-      json.alpha do
-        json.bravo "charlie"
-        json.delta "echo"
+    it 'creates an object' do
+      json.object!(:foo) { }.to_json.should == %|{"foo":{}}|
+    end
 
-        json.foxtrot do
-          json.golf "hotel"
-        end
-      end
-    end.to_json.should == %|{"foo":{"bar":"baz"},"alpha":{"bravo":"charlie","delta":"echo","foxtrot":{"golf":"hotel"}}}|
+    it 'passes value to the block' do
+      value = mock()
+      value.expects(:ping)
+      json.object!(:foo, value) { |val| val.ping }
+    end
+
+    it 'sets scope to the object' do
+      json.object!(:foo) { json.set!(:bar, "baz") }.to_json.should == %|{"foo":{"bar":"baz"}}|
+    end
+
+    it 'continues an object with same key' do
+      json.object!(:foo) { json.set!(:a, "b") }
+      json.object!(:foo) { json.set!(:c, "d") }
+      json.to_json.should == %|{"foo":{"a":"b","c":"d"}}|
+    end
   end
 
-  specify "an array" do
-    Jsonit::Builder.new do |json|
-      json.foo [1, "bar", false, true]
-    end.to_json.should == %|{"foo":[1,"bar",false,true]}|
+  describe "#array!" do
+    let(:json) { Jsonit::Builder.new }
+
+    it 'creates an array' do
+      json.array!(:foo).to_json.should == %|{"foo":[]}|
+    end
+
+    it 'sets value to array if no block is given' do
+      json.array!(:foo, ["a", 1, false]).to_json.should == %|{"foo":["a",1,false]}|
+    end
+
+    it 'executes block for each entry in the collection' do
+      obj1, obj2 = mock(), mock()
+      obj1.expects(:ping).once
+      obj2.expects(:ping).once
+
+      json.array!(:foo, [obj1, obj2]) { |obj| obj.ping }.to_json
+    end
+
+    it 'creates an object for each entry' do
+      json.array!(:foo, [1,"a"]) { |val| json.set!(:val, val) }.to_json.should == %|{"foo":[{"val":1},{"val":"a"}]}|
+    end
   end
 
-  specify "explicit keys" do
-    Jsonit::Builder.new do |json|
-      json.set! :foo, "bar"
-    end.to_json.should == %|{"foo":"bar"}|
+
+  describe "#assign!" do
+    let(:json) { Jsonit::Builder.new }
+
+    it 'returns an instance of self' do
+      json.assign!(:foo).should be_a Jsonit::Builder
+    end
+
+    it 'creates a key value pair' do
+      json.assign!(:foo, "bar").to_json.should == %|{"foo":"bar"}|
+    end
+
+    it 'can assign an array' do
+      json.assign!(:foo, ["a", "b", "c"]).to_json.should == %|{"foo":["a","b","c"]}|
+    end
+    
+    it 'can assign an object' do
+      json.assign!(:foo, {"a" => "b"}).to_json.should == %|{"foo":{"a":"b"}}|
+    end
+
+    it 'continues an object with same key' do
+      json.assign!(:foo, {"a" => "b"})
+      json.assign!(:foo, {"c" => "d"})
+      json.to_json.should == %|{"foo":{"a":"b","c":"d"}}|
+    end
   end
-  
-  specify "explicit with block" do
-    Jsonit::Builder.new do |json|
-      json.set! :foo  do
-        json.set! :bar, "baz"
+
+  describe "ghost methods" do
+    let(:json) { Jsonit::Builder.new }
+    
+    it 'does not raise method missing for method with format /^[a-z][a-z0-9]+$/' do
+      [:a, :b, :c].each do |m|
+        expect { json.send(m) }.to_not raise_error
       end
-    end.to_json.should == %|{"foo":{"bar":"baz"}}|
-  end
+    end
 
-  specify "collections with a block" do
-    Jsonit::Builder.new do |json|
-      json.foos ["bar", "baz"] do |item|
-        json.value item
+
+    it 'raises method missing for ending with a "?"' do
+      [:a?, :b?, :c?].each do |m|
+        expect { eval("json.#{m.to_s}") }.to raise_error(NoMethodError)
+      end
+    end
+    
+    it 'raises method missing for ending with a "!"' do
+      [:a!, :b!, :c!].each do |m|
+        expect { eval("json.#{m.to_s}") }.to raise_error(NoMethodError)
       end
-      json.foo "bar"
-    end.to_json.should == %|{"foos":[{"value":"bar"},{"value":"baz"}],"foo":"bar"}|
+    end
+  end
+
+  describe "DSL" do
+    it "can nest multiple levels" do
+      Jsonit::Builder.new do |json|
+        json.foo do
+          json.bar "baz"
+        end
+
+        json.alpha do
+          json.bravo "charlie"
+          json.delta "echo"
+
+          json.foxtrot do
+            json.golf "hotel"
+          end
+        end
+      end.to_json.should == %|{"foo":{"bar":"baz"},"alpha":{"bravo":"charlie","delta":"echo","foxtrot":{"golf":"hotel"}}}|
+    end
   end
 end

data/spec/spec_helper.rb

@@ -3,3 +3,8 @@ $:.unshift File.dirname(__FILE__)
 
 require "json"
 
+RSpec.configure do |config|
+  config.mock_with :mocha
+end
+
+

metadata

@@ -2,7 +2,7 @@
 name: jsonit
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Klaas Speller
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-21 00:00:00 +02:00
+date: 2011-04-26 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,6 +46,17 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: Create JSON documents with ease
 email: 
 - k.speller@voormedia.com
@@ -58,7 +69,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- LICENCE
+- LICENSE
 - README.md
 - Rakefile
 - jsonit.gemspec