birkirb-jsonbuilder 0.0.6

data/README

@@ -0,0 +1,65 @@
+= jsonbuilder
+
+  by nov http://github.com/nov <nov@cerego.com> and
+     birkirb http://github.com/birkirb
+
+== Description
+
+== Installation
+
+  git clone http://github.com/nov/jsonbuilder.git
+  cd jsonbuilder
+  rake install
+
+=== Archive Installation
+
+  rake install
+
+=== Gem Installation
+
+  gem install jsonbuilder --source http://gems.rubyforge.org
+
+     OR for the lastest development version
+
+  gem install nov-jsonbuilder --source http://gems.github.com
+
+== Features/Problems
+
+  The Hash builder will return a hash structured in a similar way as the corresponding xml
+  built by XmlMarkup. The Json builder will return the same kind of hash as a JSON string
+
+  USAGE:
+  def serialize(builder, options = {})
+    builder.user(
+      :id => id,
+      :url => url
+    )
+    builder.array_mode do
+      builder.images do
+        package.images.each do |image|
+          builder << image.builder(builder.class.new, :only_url => true)
+        end
+      end
+    end
+    builder.target!
+  end
+
+  def to_xml(options = {})
+    self.serialize(Builder::XMmlMarkup.new, options)
+  end
+
+  def to_hash(options = {})
+    self.serialize(Builder::Hash.new, options)
+  end
+
+  def to_json(options = {})
+    self.serialize(Builder::Json.new, options)
+  end
+
+== Synopsis
+
+== Copyright
+
+Author::    nov <nov@matake.jp> and birkirb
+Copyright:: Copyright (c) 2009 nov
+License::   MIT License

data/Rakefile

@@ -0,0 +1,134 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/contrib/sshpublisher'
+require 'fileutils'
+include FileUtils
+
+NAME              = "jsonbuilder"
+AUTHOR            = "nov"
+EMAIL             = "nov@matake.jp"
+DESCRIPTION       = "Builder::XmlMarkup like JsonBuilder (Builder::JsonMarkup)"
+RUBYFORGE_PROJECT = NAME
+HOMEPATH          = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+BIN_FILES         = %w(  )
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/lib"
+require 'lib/jsonbuilder'
+VERS              = JsonBuilder::Version.to_version
+CLEAN.include ['*.gem', '.config']
+RDOC_OPTS = [
+  "--title", "#{NAME} documentation",
+  "--charset", "utf-8",
+  "--opname", "index.html",
+  "--line-numbers",
+  "--main", "README",
+  "--inline-source",
+]
+
+task :default => [:spec]
+task :package => [:clean]
+
+Rake::TestTask.new("spec") do |t|
+  t.libs   << "spec"
+  t.pattern = "spec/**/*_spec.rb"
+  t.verbose = true
+end
+
+spec = Gem::Specification.new do |s|
+  s.name              = NAME
+  s.version           = VERS
+  s.platform          = Gem::Platform::RUBY
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = ["README", "ChangeLog"]
+  s.rdoc_options     += RDOC_OPTS + ['--exclude', '^(examples)/']
+  s.summary           = DESCRIPTION
+  s.description       = DESCRIPTION
+  s.author            = AUTHOR
+  s.email             = EMAIL
+  s.homepage          = HOMEPATH
+  s.executables       = BIN_FILES
+  s.rubyforge_project = RUBYFORGE_PROJECT
+  s.require_path      = "lib"
+  #s.autorequire       = ""
+  s.test_files        = Dir["spec/*_spec.rb"]
+  s.files = %w(README ChangeLog Rakefile) +
+    Dir.glob("{spec,lib}/**/*") + 
+    Dir.glob("examples/**/*.rb")
+  s.add_dependency('builder')
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.need_tar = true
+  p.gem_spec = spec
+end
+
+desc "Install"
+task :install do
+  name = "#{NAME}-#{VERS}.gem"
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{name}}
+end
+
+desc "Uninstall"
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{NAME}}
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'html'
+  rdoc.options += RDOC_OPTS
+  rdoc.template = "resh"
+  #rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+  if ENV['DOC_FILES']
+    rdoc.rdoc_files.include(ENV['DOC_FILES'].split(/,\s*/))
+  else
+    rdoc.rdoc_files.include('README', 'ChangeLog')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
+end
+
+desc "Publish to RubyForge"
+task :rubyforge => [:rdoc, :package] do
+  require 'rubyforge'
+  Rake::RubyForgePublisher.new(RUBYFORGE_PROJECT, 'nov').upload
+end
+
+# rake release VERSION=x.y.z
+desc 'Package and upload the release to rubyforge.'
+task :release => [:clean, :package] do |t|
+  v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
+  abort "Versions don't match #{v} vs #{VERS}" unless v == VERS
+  pkg = "pkg/#{NAME}-#{VERS}"
+
+  require 'rubyforge'
+  rf = RubyForge.new.configure
+  puts "Logging in"
+  rf.login
+
+  c = rf.userconfig
+  c["preformatted"] = true
+
+  files = [
+    "#{pkg}.tgz",
+    "#{pkg}.gem"
+  ].compact
+
+  puts "Releasing #{NAME} v. #{VERS}"
+  rf.add_release RUBYFORGE_PROJECT, NAME, VERS, *files
+end
+
+desc 'Show information about the gem.'
+task :debug_gem do
+  puts spec.to_ruby
+end
+
+desc 'Update gem spec'
+task :gemspec do
+  open("#{NAME}.gemspec", 'w').write spec.to_ruby
+end

data/lib/builder/abstract.rb

@@ -0,0 +1,23 @@
+module Builder
+
+  class Abstract
+    def nil?
+      false
+    end
+
+    def target!
+    end
+
+    def comment!
+    end
+
+    def declare!
+    end
+
+    def instruct!
+    end
+
+    def comment!
+    end
+  end
+end

data/lib/builder/hash.rb

@@ -0,0 +1,106 @@
+module Builder
+  class Hash < Abstract
+
+    def initialize(options = {})
+      # @default_content_key is used in such case: markup.key(value, :attr_key => attr_value)
+      # in this case, we need some key for value.
+      @default_content_key  = (options[:default_content_key] || :content).to_sym
+      @include_root = options[:include_root]
+      @target = {}
+      @array_mode = false
+    end
+
+    # NOTICE: you have to call this method to use array in json
+    def array_mode(key = nil, &block)
+      raise RuntimeError.new("cannot call inside array_mode block") if @array_mode
+      @array_mode = true
+      if eval("#{_current}").is_a?(::Hash)
+        key ||= :entry
+        eval("#{_current}.merge!(key => [])")
+        @path.push(key.to_sym)
+        yield(self)
+        @path.pop
+      else
+        eval("#{_current} = []")
+        yield(self)
+      end
+      @array_mode = false
+    end
+
+    def target!
+      if @include_root
+        @target
+      else
+        @target[@root]
+      end
+    end
+
+    def <<(_target)
+      if @array_mode
+        eval("#{_current} << _target")
+      else
+        eval("#{_current} ||= {}")
+        eval("#{_current}.merge!(_target)")
+      end
+    end
+
+    def text!(text)
+      raise RuntimeError.new("cannot call inside array_mode block") if @array_mode
+      if eval("#{_current}").is_a?(::Hash)
+        eval("#{_current}.merge!({@default_content_key => text})")
+      else
+        eval("#{_current} = text")
+      end
+    end
+    alias_method :cdata!, :text!
+
+    def tag!(key, *attrs, &block)
+      method_missing(key, *args, &block)
+    end
+
+    def method_missing(key, *args, &block)
+      key = args.first.is_a?(Symbol) ? "#{key}:#{args.shift}".to_sym : key.to_sym
+      args[0] = {@default_content_key => args[0]} if args.size > 1 && !args[0].is_a?(::Hash)
+      unless @root
+        _root(key, args, &block)
+      else
+        _child(key, args, &block)
+      end
+      target!
+    end
+
+    private
+
+    def _root(root, args, &block)
+      @root = root
+      @target[root] = {}
+      @path = [root]
+      _set_args(args, &block)
+      yield(self) if block_given?
+    end
+
+    def _child(key, args, &block)
+      eval("#{_current} ||= {}")
+      @path.push(key)
+      _set_args(args, &block)
+      @path.pop
+    end
+
+    def _set_args(args, &block)
+      args.each do |arg|
+        case arg
+        when ::Hash
+          self << arg
+        else
+          eval("#{_current} = arg")
+        end
+      end
+      yield(self) if block_given?
+    end
+
+    def _current
+      "@target[:\"#{@path.join('"][:"')}\"]"
+    end
+
+  end
+end

data/lib/builder/json.rb

@@ -0,0 +1,25 @@
+require 'json'
+
+module Builder
+
+  class Json < Hash
+
+    def initialize(options = {})
+      # @default_content_key is used in such case: markup.key(value, :attr_key => attr_value)
+      # in this case, we need some key for value.
+      @default_content_key  = (options[:default_content_key] || :content).to_sym
+      @include_root = options[:include_root]
+      @target = {}
+      @array_mode = false
+    end
+
+    def target!
+      if @include_root
+        @target.to_json
+      else
+        @target[@root].to_json
+      end
+    end
+  end
+
+end

data/lib/builder/xml_markup.rb

@@ -0,0 +1,9 @@
+module Builder
+  class XmlMarkup
+
+    # Add this no-op
+    def array_mode(key = nil, &block)
+      yield(self)
+    end
+  end
+end

data/lib/jsonbuilder.rb

@@ -0,0 +1,21 @@
+module JsonBuilder
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    REVISION = 6
+    class << self
+      def to_version
+        "#{MAJOR}.#{MINOR}.#{REVISION}"
+      end
+
+      def to_name
+        "#{MAJOR}_#{MINOR}_#{REVISION}"
+      end
+    end
+  end
+end
+
+require 'builder/abstract'
+require 'builder/hash'
+require 'builder/xml_markup'
+require 'builder/json'

data/spec/builder/hash_spec.rb

@@ -0,0 +1,218 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Builder::Hash, ".new" do
+  it "should be accessible" do
+    Builder::Hash.should respond_to(:new)
+  end
+end
+
+describe Builder::Hash do
+
+  it "should remove the root tag" do
+    builder = Builder::Hash.new
+    # XML :: <root><tag>value</tag></root>
+    builder.root do
+      builder.tag "value"
+    end
+    builder.target!.should == {:tag => "value"}
+  end
+
+  it "should not remove the root tag when include_root is true" do
+    builder = Builder::Hash.new(:include_root => true)
+    # XML :: <root><tag>value</tag></root>
+    builder.root do
+      builder.tag "value"
+    end
+    builder.target!.should == {:root => {:tag => "value"}}
+  end
+
+  it "should use the default_content_key when both content and attributes exist" do
+    builder = Builder::Hash.new
+    # XML :: <root><tag id="1">value</tag></root>
+    builder.root do
+      builder.tag("value", :id => 1)
+    end
+    builder.target!.should == {:tag => {:id => 1, :content => "value"}}
+  end
+
+  it "should use the default_content_key when both cdata! and attributes exist" do
+    builder = Builder::Hash.new
+    # XML :: <root><tag id="1"><![CDATA[value]]></tag></root>
+    builder.root do
+      builder.tag(:id => 1) do
+        builder.cdata! "value"
+      end
+    end
+    builder.target!.should == {:tag => {:id => 1, :content => "value"}}
+  end
+
+end
+
+describe Builder::Hash, "#target!" do
+
+  it "should return a String when there is only a root value" do
+    builder = Builder::Hash.new
+    builder.root("value")
+    builder.target!.should == "value"
+  end
+
+  it "should return a Hash when there is only a root value and include_root option is true" do
+    builder = Builder::Hash.new(:include_root => true)
+    # XML :: <root>value</root>
+    builder.root "value"
+    builder.target!.should == {:root => "value"}
+  end
+
+
+  it "should return a Hash when root has deeper structure" do
+    builder = Builder::Hash.new
+    builder.root do
+      builder.item("value")
+    end
+    builder.target!.should == {:item => 'value'}
+  end
+
+end
+
+describe Builder::Hash, "#array_mode" do
+
+  it "should support <<(hash)" do
+    builder = Builder::Hash.new
+    # XML ::
+    # <root>
+    #   <items>
+    #     <item>
+    #       <text>hello world 0</text>
+    #     </item>
+    #     <item>
+    #       <text>hello world 1</text>
+    #     </item>
+    #   </items>
+    # </root>
+    builder.root do
+      builder.items do
+        builder.array_mode do
+          2.times do |i|
+            _builder = Builder::Hash.new
+            builder << _builder.item do
+              _builder.text "hello world #{i}"
+            end
+          end
+        end
+      end
+    end
+    builder.target!.should == {
+      :items => [{:text => "hello world 0"}, {:text => "hello world 1"}]
+    }
+  end
+
+  it "should generate a new key if needed" do
+    builder = Builder::Hash.new
+    # XML ::
+    # <root>
+    #   <items site="smart.fm">
+    #     <item>
+    #       <text>hello world 0</text>
+    #     </item>
+    #     <item>
+    #       <text>hello world 1</text>
+    #     </item>
+    #   </items>
+    # </root>
+    builder.root do
+      builder.items(:site => "smart.fm") do
+        builder.array_mode do
+          2.times do |i|
+            _builder = Builder::Hash.new
+            builder << _builder.item do
+              _builder.text "hello world #{i}"
+            end
+          end
+        end
+      end
+    end
+    builder.target!.should == {
+      :items => {
+        :entry => [{:text => "hello world 0"}, {:text=>"hello world 1"}],
+        :site=>"smart.fm"
+      }
+    }
+  end
+
+  it "should treat an empty block as a blank Array" do
+    # XML ::
+    # <root>
+    #   <items>
+    #   </items>
+    # </root>
+    builder = Builder::Hash.new
+    builder.root do
+      builder.items do
+        builder.array_mode do
+        end
+      end
+    end
+    builder.target!.should == {:items => []}
+  end
+
+  it "should raise error if tag methods (method_missing) is used inside block"do
+    builder = Builder::Hash.new
+    builder.root do
+      builder.items do
+        lambda do
+          builder.array_mode do
+            builder.item("hello world")
+          end
+        end.should raise_error
+        lambda do
+          builder.array_mode do
+            builder.item do
+              builder.text("hello world")
+            end
+          end
+        end.should raise_error
+      end
+    end
+  end
+
+  it "should raise error if tag! is used inside block"do
+    builder = Builder::Hash.new
+    builder.root do
+      builder.items do
+        lambda do
+          builder.array_mode do
+            builder.tag!("item", "item1")
+          end
+        end.should raise_error
+      end
+    end
+  end
+
+  it "should raise error if cdata! (or text!) is used inside block"do
+    builder = Builder::Hash.new
+    builder.root do
+      builder.items do
+        lambda do
+          builder.array_mode do
+            builder.cdata!("text")
+          end
+        end.should raise_error
+      end
+    end
+  end
+
+  it "should raise error if array_mode is used inside block"do
+    builder = Builder::Hash.new
+    builder.root do
+      builder.items do
+        lambda do
+          builder.array_mode do
+            builder.array_mode do
+            end
+          end
+        end.should raise_error
+      end
+    end
+  end
+
+end

data/spec/builder/json_spec.rb

@@ -0,0 +1,26 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Builder::Json, ".new" do
+  it "should be accessible" do
+    Builder::Hash.should respond_to(:new)
+  end
+end
+
+describe Builder::Json, "#target!" do
+
+  it "should return a String when there is only a root value" do
+    builder = Builder::Hash.new
+    builder.root("value")
+    builder.target!.should be_a(String)
+  end
+
+  it "should return a JSON string when root has deeper structure" do
+    builder = Builder::Json.new
+    builder.root do
+      builder.item("value")
+    end
+    builder.target!.should be_a(String)
+    builder.target!.should =="{\"item\":\"value\"}"
+  end
+
+end

data/spec/builder/xml_markup_spec.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Builder::XmlMarkup, "#array_mode" do
+
+  it "should do nothing" do
+    builder = Builder::XmlMarkup.new
+    builder.root do
+      builder.array_mode do
+        builder.item("value")
+      end
+    end
+    builder2 = Builder::XmlMarkup.new
+    builder2.root do
+      builder2.item("value")
+    end
+    builder.target!.should == builder2.target!
+  end
+
+end

data/spec/jsonbuilder_spec.rb

@@ -0,0 +1,13 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe JsonBuilder::Version, "#to_version" do
+  it "should return version in 'X.Y.Z' format" do
+    JsonBuilder::Version.to_version.should =~ /\d+\.\d+\.\d+/
+  end
+end
+
+describe JsonBuilder::Version, "#to_name" do
+  it "should return version in 'X_Y_Z' format" do
+    JsonBuilder::Version.to_name.should =~ /\d+_\d+_\d+/
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+require 'builder'
+require 'jsonbuilder'

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: birkirb-jsonbuilder
+version: !ruby/object:Gem::Version 
+  version: 0.0.6
+platform: ruby
+authors: 
+- nov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-08 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Builder::XmlMarkup like JsonBuilder (Builder::JsonMarkup)
+email: nov@matake.jp
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- ChangeLog
+files: 
+- README
+- ChangeLog
+- Rakefile
+- spec/builder
+- spec/builder/hash_spec.rb
+- spec/builder/json_spec.rb
+- spec/builder/xml_markup_spec.rb
+- spec/jsonbuilder_spec.rb
+- spec/spec_helper.rb
+- lib/builder
+- lib/builder/abstract.rb
+- lib/builder/hash.rb
+- lib/builder/json.rb
+- lib/builder/xml_markup.rb
+- lib/jsonbuilder.rb
+has_rdoc: true
+homepage: http://jsonbuilder.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --title
+- jsonbuilder documentation
+- --charset
+- utf-8
+- --opname
+- index.html
+- --line-numbers
+- --main
+- README
+- --inline-source
+- --exclude
+- ^(examples)/
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: jsonbuilder
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Builder::XmlMarkup like JsonBuilder (Builder::JsonMarkup)
+test_files: 
+- spec/jsonbuilder_spec.rb