mschuerig-ruby_template_handler 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-04-02
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/ruby_template_handler.rb
+rails/init.rb
+test/test_helper.rb
+test/test_ruby_template_handler.rb

data/README.rdoc

@@ -0,0 +1,77 @@
+= ruby_template_handler
+
+* http://github.com/mschuerig/ruby_template_handler
+
+== DESCRIPTION:
+
+A Rails view template handler that renders Ruby objects to JSON.
+
+== FEATURES/PROBLEMS:
+
+* I'm not entirely sure how sensible this whole thing is, but there you go.
+
+== SYNOPSIS:
+
+A controller action for returning a list of Movie objects in JSON format
+
+  # app/controllers/movies_controller.rb
+  def index
+    respond_to do |format|
+      format.json do
+        @movies = Movie.all
+        @count = Movie.count
+        render :template => 'movies/index.json.rb'
+      end
+    end
+  end
+
+  # app/views/movies/index.json.rb
+  {
+    :identifier => Movie.primary_key,
+    :totalCount => @count,
+    # render @movies does not work as it insists on returning a string
+    :items => @movies.map { |m| render(m) }
+  }
+
+  # app/views/movies/_movie.json.rb
+  {
+    :id => movie.to_param,
+    :title => movie.title,
+    :releaseDate => movie.release_date
+  }
+
+In general, "full" templates are rendered to strings, whereas
+partials are rendered as objects.
+
+== REQUIREMENTS:
+
+* Rails
+
+== INSTALL:
+
+* sudo gem install mschuerig-ruby_template_handler
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Michael Schuerig
+
+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/Rakefile

@@ -0,0 +1,23 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/ruby_template_handler'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('ruby_template_handler', RubyTemplateHandler::VERSION) do |p|
+  p.developer('Michael Schuerig', 'michael@schuerig.de')
+  p.changes            = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps         = [
+    ['actionpack','>= 2.2'],
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }

data/lib/ruby_template_handler.rb

@@ -0,0 +1,15 @@
+
+require 'action_view'
+
+class RubyTemplateHandler < ActionView::TemplateHandler
+  VERSION = '0.0.1'
+  include ActionView::TemplateHandlers::Compilable
+
+  def compile(template)
+    src =  'self.output_buffer = (' + template.source + ')'
+    unless File.basename(template.filename).starts_with?('_')
+      src += '.to_json'
+    end
+    src
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+# Include hook code here
+require 'ruby_template_handler'
+ActionView::Template.register_template_handler :rb, RubyTemplateHandler

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/ruby_template_handler'

data/test/test_ruby_template_handler.rb

@@ -0,0 +1,77 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'ostruct'
+require 'action_controller'
+
+ActionView::Template.register_template_handler :rb, RubyTemplateHandler
+
+class Movie
+  def self.primary_key
+    'id'
+  end
+end
+
+class TestRubyTemplateHandler < Test::Unit::TestCase
+
+  class TestController < ActionController::Base
+    def initialize(movies)
+      @movies = Array(movies)
+      @count = @movies.size
+    end
+    undef_method :request, :response
+  end
+  
+  class TestTemplate < ActionView::Template
+    def initialize(filename, source)
+      @filename, @source = filename, source
+      self.format = 'json'
+      self.extension = 'rb'
+    end
+    def source
+      @source
+    end
+  end
+  
+  def setup
+    @movie = OpenStruct.new({
+      :title => 'Rendered Insane',
+      :release_date => Time.utc(2008, 4, 2)
+    })
+    
+    controller = TestController.new(@movie)
+    @view = ActionView::Base.new
+    @view.controller = controller
+    
+    @template = TestTemplate.new('app/views/movies/index.json.rb', <<TMPL
+{
+  :identifier => Movie.primary_key,
+  :totalCount => @count
+}
+TMPL
+    )
+
+    @partial = TestTemplate.new('app/views/movies/_movie.json.rb', <<TMPL
+{
+  :title => movie.title,
+  :releaseDate => movie.release_date
+}
+TMPL
+    )
+  end
+  
+  def test_render_template
+    result = @template.render(@view)
+    assert_kind_of String, result
+    assert_match /"identifier": "id"/, result
+    assert_match /"totalCount": 1/, result
+  end
+  
+  def test_render_partial
+    result = @partial.render(@view, :movie => @movie)
+    assert_kind_of Hash, result
+    assert_equal(
+      {
+        :title => 'Rendered Insane',
+        :releaseDate => Time.utc(2008, 4, 2)
+      }, result)
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: mschuerig-ruby_template_handler
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Schuerig
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.2"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Rails view templates that return Ruby objects.
+email: 
+- michael@schuerig.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/ruby_template_handler.rb
+- rails/init.rb
+- test/test_helper.rb
+- test/test_ruby_template_handler.rb
+has_rdoc: false
+homepage: http://github.com/mschuerig/ruby_template_handler
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: ruby_template_handler
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Rails view templates that return Ruby objects.
+test_files: 
+- test/test_helper.rb
+- test/test_ruby_template_handler.rb