porth 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in porbt.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Tate Johnson <tate@tatey.com>
+
+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,133 @@
+# Porth (Plain Old Ruby Template Handler)
+
+Write your views using plain old Ruby. Views are for representation, not defining
+`#as_json` in a model. There's no need to learn a DSL for building arrays and hashes.
+Just use Ruby. Views are written once and rendered in JSON(P) or XML based on
+the requested format. Porth makes few assumptions and can be configured.
+
+## Installation
+
+Add this to your project's Gemfile and run `$ bundle install`
+
+``` ruby
+gem 'porth'
+```
+
+## Usage
+
+Create a controller that responds to JSON, XML or both.
+
+``` ruby
+# app/controllers/transmitters_controller.rb
+class TransmittersController < ApplicationController
+  respond_to :json, :xml
+  
+  def index
+    @transmitters = Transmitter.all
+    respond_with @transmitters
+  end
+
+  # ...
+end
+````
+
+Create a template with a `.rb` extension. Write plain old Ruby. Objects
+must respond to `#to_json` or `#to_xml`. Arrays and hashes are best.
+
+``` ruby
+# app/views/transmitters/index.rb
+@transmitters.map do |t|
+  {
+    name: t.area_served,
+    latitude: t.latitude,
+    longitude: t.longitude,
+    nearby: t.nearby.size
+  }
+end
+```
+
+GET /transmitters.json
+
+``` javascript
+[{"name":"Brisbane","latitude":-27.4661111111111,"longitude":152.946388888889,"nearby":11}]
+```
+
+GET /transmitters.json?callback=myFunction
+
+``` javascript
+myFunction([{"name":"Brisbane","latitude":-27.4661111111111,"longitude":152.946388888889,"nearby":11}])
+```
+
+GET /transmitters.xml
+
+``` xml
+<?xml version="1.0" encoding="UTF-8"?>
+<transmitters type="array">
+  <transmitter>
+    <name>Brisbane</name>
+    <latitude type="float">-27.4661111111111</latitude>
+    <longitude type="float">152.946388888889</longitude>
+    <nearby type="integer">11</nearby>
+  </transmitter>
+</transmitters>
+```
+
+`Porth::UnknownFormatError` is raised when the requested format is not supported.
+
+### JSONP
+
+Porth calls `#json_callback` to get the function name for JSONP responses. By default
+this method is added to `ActionController::Base` and returns `params[:callback]`. Override
+`#json_callback` to get different behaviour.
+
+``` ruby
+class ApplicationController < ActionController::Base
+  # ...
+
+  protected
+  
+  def json_callback
+    nil # Ignore JSONP requests
+  end
+end
+```
+
+### XML
+
+Porth guesses the resource's name from the controller's class. `Foo::BarsController`
+becomes `bars`. Override `#xml_root` to explicitly set the resource name.
+
+``` ruby
+class TransmittersController < ApplicationController
+  # ...
+
+  protected
+  
+  def xml_root
+    'sites'
+  end
+end
+```
+
+## Compatibility
+
+* ActionPack 3.1.0
+* JRuby 1.6.4
+* Ruby 1.9.2
+
+## Contributing
+
+1. Fork
+2. Install dependancies by running `$ bundle install`
+3. Write tests and code
+4. Make sure the tests pass by running `$ rake`
+5. Push and send a pull request on GitHub
+
+## Credits
+
+Porth is the result of numerous discussions at [Everyday Hero](http://www.everydayhero.com.au) 
+around better API design.
+
+## Copyright
+
+Copyright © 2011 Tate Johnson. Released under the MIT license. See LICENSE.

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler'
+rescue LoadError
+  raise "Could not load the bundler gem. Install it with `gem install bundler`."
+end
+
+begin
+  Bundler.setup
+rescue Bundler::GemNotFound
+  raise RuntimeError, "Bundler couldn't find some gems. Did you run `bundle install`?"
+end
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new :test do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/lib/porth.rb

@@ -0,0 +1,12 @@
+require 'action_controller'
+require 'json'
+
+require 'porth/format/json'
+require 'porth/format/xml'
+require 'porth/handler'
+require 'porth/unknown_format_error'
+
+Porth::Handler.register_format :json, Porth::Format::JSON
+Porth::Handler.register_format :xml,  Porth::Format::XML
+
+ActionView::Template.register_template_handler :rb, Porth::Handler

data/lib/porth/format/json.rb

@@ -0,0 +1,19 @@
+module Porth
+  module Format
+    module JSON
+      def self.call controller, object
+        json     = object.to_json
+        callback = controller.send :json_callback
+        callback ? "#{callback}(#{json})" : json
+      end
+      
+      module ControllerExtensions
+        protected
+        
+        def json_callback
+          params[:callback]
+        end
+      end
+    end
+  end
+end

data/lib/porth/format/xml.rb

@@ -0,0 +1,17 @@
+module Porth
+  module Format
+    module XML
+      def self.call controller, object
+        object.to_xml :root => controller.send(:xml_root)
+      end
+      
+      module ControllerExtensions
+        protected
+                
+        def xml_root
+          self.class.name.sub('Controller', '').underscore.split('/').last.pluralize
+        end
+      end
+    end
+  end
+end

data/lib/porth/handler.rb

@@ -0,0 +1,30 @@
+module Porth  
+  class Handler
+    attr_reader :template
+    
+    def initialize template
+      @template = template
+    end
+    
+    def call
+      "#{format}.call controller, instance_eval { #{template.source} }"
+    end
+    
+    def format
+      self.class.formats.fetch(template.formats.first) { raise UnknownFormatError }
+    end
+    
+    def self.call template
+      new(template).call
+    end
+    
+    def self.formats
+      @formats ||= {}
+    end
+    
+    def self.register_format format, mod
+      formats[format] = mod
+      ActionController::Base.send :include, mod::ControllerExtensions
+    end
+  end
+end

data/lib/porth/unknown_format_error.rb

@@ -0,0 +1,7 @@
+module Porth
+  class UnknownFormatError < StandardError
+    def message
+      'Unknown format. Supported formats are ' + Handler.formats.keys.join(', ')
+    end
+  end
+end

data/lib/porth/version.rb

@@ -0,0 +1,3 @@
+module Porth
+  VERSION = '0.0.1'
+end

data/porth.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "porth/version"
+
+Gem::Specification.new do |s|
+  s.name        = "porth"
+  s.version     = Porth::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tate Johnson"]
+  s.email       = ["tate@tatey.com"]
+  s.homepage    = "https://github.com/tatey/porth"
+  s.summary     = %q{Plain Old Ruby Template Handler}
+  s.description = %q{Write your views using plain old Ruby}
+
+  s.rubyforge_project = "porbt"
+
+  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"]
+  
+  s.add_runtime_dependency 'actionpack', '>= 3.1.0', '< 4.0.0'
+  s.add_runtime_dependency 'json',       '~> 1.6.1'
+  
+  s.add_development_dependency 'minitest', '~> 2.6.2'
+  s.add_development_dependency 'rake',     '~> 0.9.2'
+end

data/test/fixtures/block.rb

@@ -0,0 +1,3 @@
+(1..2).map do |n|
+  {n => n * 2}
+end

data/test/fixtures/instance_variable.rb

@@ -0,0 +1 @@
+[@foo]

data/test/port/handler_test.rb

@@ -0,0 +1,10 @@
+require 'action_view'
+require 'test_helper'
+
+class HandlerTest < MiniTest::Unit::TestCase
+  def test_unsupported_format
+    assert_raises UnknownFormatError do
+      Handler.new(ActionView::Template.new(nil, nil, nil, {:format => 'text/html'})).format
+    end
+  end
+end

data/test/port/rendering_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class RenderingTest < MiniTest::Unit::TestCase
+  class TestsController < ActionController::Base
+    def params
+      @params ||= {}
+    end
+  end
+
+  def render file, format, assigns = {}
+    ActionView::Base.new(template_dir, assigns, @controller).tap do |view|
+      view.lookup_context.freeze_formats [format]
+    end.render :file => file
+  end
+
+  def template_dir
+    File.expand_path File.dirname(__FILE__) + '/../fixtures'
+  end
+
+  def setup
+    @controller = TestsController.new
+  end
+    
+  def test_json
+    assert_equal '[{"1":2},{"2":4}]', render('block', :json)
+  end
+  
+  def test_json_callback
+    @controller.params[:callback] = 'myFunction'
+    assert_equal 'myFunction([{"1":2},{"2":4}])', render('block', :json)
+  end
+
+  def test_xml
+    assert_equal %{<?xml version="1.0" encoding="UTF-8"?>\n<tests type="array">\n  <test 1="2" type="hash"/>\n  <test 2="4" type="hash"/>\n</tests>\n}, render('block', :xml)
+  end
+  
+  def test_instance_variable
+    assert_equal '["bar"]', render('instance_variable', :json, 'foo' => 'bar')
+  end
+end

data/test/port/xml_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+class XMLTest < MiniTest::Unit::TestCase
+  def klass name
+    instance_eval <<-RUBY_STRING
+      Class.new do
+        include Format::XML::ControllerExtensions
+        
+        def self.name
+          '#{name}'
+        end
+      end
+    RUBY_STRING
+  end
+  
+  def test_send_xml_root
+    assert_equal 'foos', klass('Foo').new.send(:xml_root)
+    assert_equal 'foos', klass('FooController').new.send(:xml_root)
+    assert_equal 'foos', klass('FoosController').new.send(:xml_root)
+    assert_equal 'bars', klass('Foo::BarController').new.send(:xml_root)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'porth'
+
+include Porth

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: porth
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tate Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &70355213483100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70355213483100
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70355213481080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70355213481080
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70355213479740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *70355213479740
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70355213477700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70355213477700
+description: Write your views using plain old Ruby
+email:
+- tate@tatey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/porth.rb
+- lib/porth/format/json.rb
+- lib/porth/format/xml.rb
+- lib/porth/handler.rb
+- lib/porth/unknown_format_error.rb
+- lib/porth/version.rb
+- porth.gemspec
+- test/fixtures/block.rb
+- test/fixtures/instance_variable.rb
+- test/port/handler_test.rb
+- test/port/rendering_test.rb
+- test/port/xml_test.rb
+- test/test_helper.rb
+homepage: https://github.com/tatey/porth
+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'
+      segments:
+      - 0
+      hash: -1831659487050102680
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1831659487050102680
+requirements: []
+rubyforge_project: porbt
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Plain Old Ruby Template Handler
+test_files:
+- test/fixtures/block.rb
+- test/fixtures/instance_variable.rb
+- test/port/handler_test.rb
+- test/port/rendering_test.rb
+- test/port/xml_test.rb
+- test/test_helper.rb