jsonit 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (C) 2011 by Klaas Speller
+
+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,167 @@
+# Jsonit
+
+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.
+
+## Usage
+
+``` ruby
+require 'json'    # Jsonit expects a #to_json method on object.
+require 'jsonit'
+
+# a simple object
+Jsonit::Builder.new do |json|
+  json.foo "bar"
+end.to_json #=> {"foo":"bar"}
+
+# nested object
+Jsonit::Builder.new do |json|
+  json.foo do
+    json.bar "baz"
+  end
+  
+  json.alpha do
+    json.bravo do
+      json.charlie "delta"
+    end
+  end
+end.to_json #=> {"foo":{"bar":"baz"},"alpha":{"bravo":{"charlie":"delta"}}}
+
+# arrays
+Jsonit::Builder.new do |json|
+  json.first [1, 2, 3]
+
+  json.second [1, 2, 3] do |itm|
+    json.value itm
+  end
+end.to_json #=> {"first":[1, 2, 3],"second":[{"value":1},{"value":2},{"value":3}]}
+
+```
+
+## Rails 3
+
+Jsonit can be used with rails 3.
+
+In `app/helpers/photos_helper.rb`
+
+``` ruby
+class PhotosHelper
+  def photos
+    Photo.all
+  end
+end
+```
+
+In `app/controllers/photos_controller.rb`
+
+``` ruby
+class PhotosController < ApplicationController
+  respond_to :json
+end
+
+```
+
+In `app/views/photos/index.json.jsonit`
+
+``` ruby
+json.ok true
+json.data photos do |photo|
+  photo.title    photo.title
+  photo.location url_for(photo)
+end
+```
+
+Result will be something like:
+
+``` json
+{
+  "ok": true,
+  "data": [
+        {
+          "title": "My First Photo",
+          "location": "http://www.example.com/photos/1.json"
+        }
+  ]
+}
+
+```
+
+## Sinatra
+
+Jsonit can be used with Sinatra.
+
+In your Gemfile:
+
+``` ruby
+gem 'json'
+gem 'jsonit'
+```
+
+In `views/index.jsonit`:
+
+``` ruby
+json.foo "bar"
+```
+
+In your app:
+
+``` ruby
+class App < Sinatra::Base
+  get "/" do
+    jsonit :index
+  end
+end
+```
+
+
+## Padrino
+
+Jsonit can be used with Padrino.
+
+In your Gemfile:
+
+``` ruby
+gem 'json'
+gem 'jsonit'
+```
+
+In `app/views/photos/index.json.jsonit`:
+
+``` ruby
+json.photos photos do |photo|
+  json.title    photo.title
+  json.location url_for(:photos, :show, :photo_id => photo.id)
+end
+```
+
+In your controller:
+
+``` ruby
+MyApp.controllers :photos do
+  helpers do
+    def photos
+      Photos.all
+    end
+  end
+
+  get :index, :provides => :json do
+    render :'photos/index'
+  end
+
+  get :show, :with => :photo_id, :provides => :json do
+    render :'photo/show'
+  end
+end
+```
+
+
+## Project status
+
+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.
+
+

data/Rakefile

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

data/jsonit.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jsonit/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jsonit"
+  s.version     = Jsonit::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Klaas Speller"]
+  s.email       = ["k.speller@voormedia.com"]
+  s.homepage    = ""
+  s.summary     = %q{A JSON templating language}
+  s.description = %q{Create JSON documents with ease}
+
+  s.rubyforge_project = "jsonit"
+
+  s.add_development_dependency "json"
+  s.add_development_dependency "tilt"
+  s.add_development_dependency "rspec"
+
+  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/jsonit/builder.rb

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

data/lib/jsonit/rails/railtie.rb

@@ -0,0 +1,14 @@
+require "jsonit/rails/template_handler"
+
+module Jsonit
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer "jsonit.register_handler" do |app|
+        app.paths["app/views"].eager_load!
+        ActiveSupport.on_load(:action_view) do
+          ActionView::Template.register_template_handler "jsonit", Jsonit::Rails::TemplateHandler
+        end
+      end
+    end
+  end
+end

data/lib/jsonit/rails/template_handler.rb

@@ -0,0 +1,16 @@
+require "jsonit/builder"
+module Jsonit
+  module Rails
+    class TemplateHandler
+    default_format = Mime::JSON
+    
+    class << self
+        def call(template)
+          "::Jsonit::Builder.new do |json|" +
+          template.source +
+          "end.to_json"
+        end
+      end
+    end
+  end
+end

data/lib/jsonit/tilt/tilt_jsonit.rb

@@ -0,0 +1,35 @@
+
+module Tilt
+  class JsonitTemplate < ::Tilt::Template
+    default_mime_type = 'application/json'
+
+    def self.engine_initialized?
+      defined? ::Jsonit
+    end
+
+    def initialize_engine
+      require_template_library 'jsonit'
+    end
+
+    def prepare; end
+
+    def evaluate(scope, locals, &block)
+      return super(scope, locals, &block) if data.respond_to?(:to_str)
+      json = ::Jsonit::Builder.new
+      data.call(json)
+    end
+
+    def precompiled_preamble(locals)
+      "\n#{super};::Jsonit::Builder.new do |json|"
+    end
+
+    def precompiled_postamble(locals)
+      "\nend.to_json"
+    end
+
+    def precompiled_template(locals)
+      data.to_str
+    end
+  end
+  register 'jsonit', ::Tilt::JsonitTemplate
+end

data/lib/jsonit/version.rb

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

data/lib/jsonit.rb

@@ -0,0 +1,14 @@
+require "jsonit/builder"
+module Jsonit
+  require "json" unless Object.respond_to?(:to_json)
+  require "jsonit/rails/railtie" if defined?(::Rails)
+  require "jsonit/tilt/tilt_jsonit" if defined?(::Tilt)
+
+  if defined?(::Sinatra)
+    module ::Sinatra::Templates
+      def jsonit(template, options={}, locals={})
+        render :jsonit, template, options, locals
+      end
+    end
+  end
+end

data/spec/jsonit/builder_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+require "jsonit/builder"
+
+describe Jsonit::Builder, "Building json" do
+  specify "a simple object" do
+    Jsonit::Builder.new.to_json.should == %|{}|
+  end
+
+  specify "a simple object with a string value" do
+    Jsonit::Builder.new do |json|
+      json.foo "bar"
+    end.to_json.should == %|{"foo":"bar"}|
+  end
+
+  specify "#to_json" do
+    expect { Jsonit::Builder.new.to_json }.to_not raise_error
+  end
+
+  specify "a nested object" 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
+
+  specify "an array" do
+    Jsonit::Builder.new do |json|
+      json.foo [1, "bar", false, true]
+    end.to_json.should == %|{"foo":[1,"bar",false,true]}|
+  end
+
+  specify "explicit keys" do
+    Jsonit::Builder.new do |json|
+      json.set! :foo, "bar"
+    end.to_json.should == %|{"foo":"bar"}|
+  end
+  
+  specify "explicit with block" do
+    Jsonit::Builder.new do |json|
+      json.set! :foo  do
+        json.set! :bar, "baz"
+      end
+    end.to_json.should == %|{"foo":{"bar":"baz"}}|
+  end
+
+  specify "collections with a block" do
+    Jsonit::Builder.new do |json|
+      json.foos ["bar", "baz"] do |item|
+        json.value item
+      end
+      json.foo "bar"
+    end.to_json.should == %|{"foos":[{"value":"bar"},{"value":"baz"}],"foo":"bar"}|
+  end
+end

data/spec/jsonit/tilt/tilt_jsonit_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+require "tilt"
+
+require "jsonit"
+
+describe "Jsonit Tilt Support" do
+  it 'is registered for ".jsonit" files' do
+    Tilt['test.jsonit'].should == ::Tilt::JsonitTemplate
+    Tilt['test.json.jsonit'].should == ::Tilt::JsonitTemplate
+  end
+
+  specify "loading and evaluating templates on #render" do
+    template = Tilt::JsonitTemplate.new { |t| "json.foo 'bar'" }
+    template.render.should == %|{"foo":"bar"}|
+  end
+
+  specify "can be rendered more than once" do
+    template = Tilt::JsonitTemplate.new { |t| "json.foo 'bar'" }
+    3.times { template.render.should == %|{"foo":"bar"}| }
+  end
+
+  specify "passing locals" do
+    template = Tilt::JsonitTemplate.new { 'json.foo name' }
+    template.render(Object.new, :name => 'Joe').should == %|{"foo":"Joe"}|
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+$:.unshift File.dirname(__FILE__)
+
+require "json"
+

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: jsonit
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Klaas Speller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-21 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: tilt
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Create JSON documents with ease
+email: 
+- k.speller@voormedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- jsonit.gemspec
+- lib/jsonit.rb
+- lib/jsonit/builder.rb
+- lib/jsonit/rails/railtie.rb
+- lib/jsonit/rails/template_handler.rb
+- lib/jsonit/tilt/tilt_jsonit.rb
+- lib/jsonit/version.rb
+- spec/jsonit/builder_spec.rb
+- spec/jsonit/tilt/tilt_jsonit_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 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: jsonit
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: A JSON templating language
+test_files: 
+- spec/jsonit/builder_spec.rb
+- spec/jsonit/tilt/tilt_jsonit_spec.rb
+- spec/spec_helper.rb