jrb_handler 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+

data/Gemfile

@@ -0,0 +1,11 @@
+
+source :gemcutter
+
+gem "activesupport", ">=3.0.3"
+gem "actionpack", ">=3.0.3"
+
+group :development, :test do
+	gem "rspec", ">= 2.0"
+	gem "rspec-rails", ">= 2.0"
+end
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Paul Sadauskas
+
+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.markdown

@@ -0,0 +1,102 @@
+# JRB Templates
+
+JRB Templates makes it easy to write JSON web services in Rails.  Rather than maintaining two views for the collection and the individual resource, or rendering a third via a partial, you only have to write a single `.jrb` view.
+
+## Installation
+
+Either
+
+    $ gem install jrb_template
+
+or add
+
+    gem jrb_template
+
+to your `./Gemfile`
+
+
+## Examples
+
+Using the new Ruby 1.9 hash format, you can just write something that looks a lot like JSON:
+
+    # app/views/books/book.json.jrb
+    {
+      href:        book_url(book),
+      _type:       "Book",
+      title:       book.title
+      author_href: author_url(book.author),
+      synopsis:    book.summary,
+      isbn:        format_isbn(book.isbn),
+      created_at:  book.created_at,
+      updated_at:  book.updated_at
+    }
+
+
+In Ruby 1.8, you have to use the old hash format, and the order gets jumbled.
+
+Then, in your controller:
+
+    # app/controllers/books_controller.rb
+
+    class BooksController < ApplicationController
+
+      def index
+        @books = Book.all
+
+        respond_to do |format|
+          format.html
+          format.json { render :jrb_collection => @books }
+        end
+      end
+
+      def show
+        @book = Book.find(params[:id])
+
+        respond_to do |format|
+          format.html
+          format.json { render :jrb => @book }
+        end
+      end
+
+    end
+
+*Note: I do not recommend using application/json as the mime type extension. Please see [Versioning REST Web Services][].*
+
+Results in the following json:
+
+    # GET /books
+    {
+      href: "http://example.com/books",
+      count: 1,
+      items: [
+        {
+          href: "http://example.com/books/1
+          _type: "Book",
+          title: "Death From the Skies!",
+          author_href: "http://example.com/authors/plait_philip_c".
+          synopsis: " These Are the Ways the World Will End...".
+          isbn: "978-0670019977",
+          created_at: "2010-12-13T18:44:22Z",
+          updated_at: "2010-12-13T18:44:22Z"
+        }
+      ]
+    }
+
+    # GET /books/1
+    {
+      href: "http://example.com/books/1
+      _type: "Book",
+      title: "Death From the Skies!",
+      author_href: "http://example.com/authors/plait_philip_c".
+      synopsis: " These Are the Ways the World Will End...".
+      isbn: "978-0670019977",
+      created_at: "2010-12-13T18:44:22Z",
+      updated_at: "2010-12-13T18:44:22Z"
+    }
+
+
+
+
+
+
+[Versioning REST Web Services]: http://barelyenough.org/blog/2008/05/versioning-rest-web-services/

data/jrb_handler.gemspec

@@ -0,0 +1,33 @@
+
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require "jrb_handler/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jrb_handler"
+  s.version     = JrbHandler::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Paul Sadauskas"]
+  s.email       = ["psadauskas@gmail.com"]
+  s.homepage    = "http://github.com/paul/jrb_handler"
+  s.summary     = "A Rails template handler and renderer for JSON"
+  s.description = <<-DESC
+    Jrb Handler makes it easy to write JSON web services in Rails 3. Keep your views in views, not in your Model#to_json.
+  DESC
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_development_dependency "rspec", ">= 2.0.0"
+  s.add_development_dependency "rspec-rails", ">= 2.0.0"
+  s.add_development_dependency "bundler"
+
+  s.add_dependency "activesupport", ">= 3.0.3"
+  s.add_dependency "actionpack", ">= 3.0.3"
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ['lib']
+
+end

data/lib/active_support_extensions.rb

@@ -0,0 +1,11 @@
+
+require 'active_support/time_with_zone'
+
+# Personal preference, I like my JSON timestamps in UTC, and xmlschema
+# format, eg "2010-12-13T18:00:00Z"
+class ActiveSupport::TimeWithZone
+  def to_json(options = nil)
+    utc.xmlschema.to_json
+  end
+end
+

data/lib/jrb_handler.rb

@@ -0,0 +1,18 @@
+
+module JrbHandler
+
+end
+
+unless respond_to?(:require_relative)
+  # Ripped right from 1.9 source
+  def require_relative(path)
+    require File.join(File.dirname(caller[0]), path.to_str)
+  end
+end
+
+require_relative 'jrb_handler/template_handler'
+require_relative 'jrb_handler/jrb_partial_renderer'
+require_relative 'jrb_handler/renderers'
+
+
+

data/lib/jrb_handler/jrb_partial_renderer.rb

@@ -0,0 +1,33 @@
+module JrbHandler
+
+  # Since I can't get the Rails team interested in making these changes, I have to monkey
+  # patch some privatish methods in AV::Partials::PartialRenderer. Works in 3.0.1, but I
+  # expect it to break frequently.
+  class JrbPartialRenderer < ActionView::Partials::PartialRenderer
+
+    # Skip rendering the results into a string, just leave it as an array.
+    def render_collection
+      return nil if @collection.blank?
+
+      if @options.key?(:spacer_template)
+        spacer = find_template(@options[:spacer_template]).render(@view, @locals)
+      end
+
+      result = @template ? collection_with_template : collection_without_template
+      # Skip forcing the result into a sting. Everything above this is just like the original method
+      #result.join(spacer).html_safe
+    end
+
+    # Tell the template finder we're not a partial, so it doesnt try to find the underscored method
+    def find_template(path=@path)
+      return path unless path.is_a?(String)
+      prefix = @view.controller_path unless path.include?(?/)
+
+      ##########
+      @view.find_template(path, prefix, false)
+      ##########
+    end
+
+  end
+
+end

data/lib/jrb_handler/renderers.rb

@@ -0,0 +1,31 @@
+module JrbHandler::Renderers
+
+  EPOCH = Time.utc(2000, 1, 1).iso8601
+
+  ::ActionController::Renderers.add(:jrb_collection) do |resources, options|
+    output = {
+      :href    => request.url,
+      :count   => resources.size,
+      :items   => render(:ssaj1 => resources)
+    }
+
+    output = ActiveSupport::JSON.encode(output, :pretty => !Rails.env.production?)
+    self.response_body = output
+  end
+
+  ::ActionController::Renderers.add(:jrb) do |resource, options|
+    options[:partial] ||= resource
+    #options.delete(:layout)
+
+    output = JrbPartialRenderer.new(self.view_context, options, nil).render
+
+    # If we got a set of resources, we're being rendered inside a collection,
+    # so just return the results and let the collection renderer handle the rest
+    return [] if output.nil?
+    return output if output.is_a?(Array)
+
+    output = ActiveSupport::JSON.encode(output, :pretty => !Rails.env.production?)
+    self.response_body = output
+  end
+
+end

data/lib/jrb_handler/template_handler.rb

@@ -0,0 +1,16 @@
+module JrbHandler
+  class TemplateHandler < ActionView::Template::Handler
+    include ActionView::Template::Handlers::Compilable
+
+    ActionView::Template.register_template_handler(:jrb, self)
+
+    self.default_format = Mime::JSON
+
+    def compile(template)
+      template.source
+    end
+
+  end
+end
+
+

data/lib/jrb_handler/version.rb

@@ -0,0 +1,4 @@
+
+module JrbHandler
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification 
+name: jrb_handler
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Paul Sadauskas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  version_requirements: *id005
+description: "    Jrb Handler makes it easy to write JSON web services in Rails 3. Keep your views in views, not in your Model#to_json.\n"
+email: 
+- psadauskas@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.markdown
+- jrb_handler.gemspec
+- lib/active_support_extensions.rb
+- lib/jrb_handler.rb
+- lib/jrb_handler/jrb_partial_renderer.rb
+- lib/jrb_handler/renderers.rb
+- lib/jrb_handler/template_handler.rb
+- lib/jrb_handler/version.rb
+has_rdoc: true
+homepage: http://github.com/paul/jrb_handler
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Rails template handler and renderer for JSON
+test_files: []
+