porth 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# CHANGELOG
+
+# 0.0.2 / 2012-01-21
+
+* XML singularizes resource name when view returns a single object
+* Relaxed dependancy versions. Works with Rails 3.0.0+ and any version of JSON
+
+# 0.0.1 / 2011-10-23
+
+* Initial release

data/README.md

@@ -1,5 +1,7 @@
 # Porth (Plain Old Ruby Template Handler)
 
+[![Build Status](https://secure.travis-ci.org/tatey/porth.png)](http://travis-ci.org/tatey/porth)
+
 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
@@ -109,18 +111,108 @@ class TransmittersController < ApplicationController
 end
 ```
 
+Resource names are pluralized or singularized by introspecting the return type from
+the view. Following convention, collection actions (index) should return 
+an array of objects and member actions (new, create, edit, update, delete) should 
+return an object. Override `#xml_pluralized_root` to explicitly set the collection 
+resource name and override `#xml_singularize_root` to explicitly set the member 
+resource name.
+
+``` ruby
+class SeaFoodsController < ApplicationController
+  # ...
+
+  protected
+  
+  def xml_pluralized_root
+    'fish'
+  end
+          
+  def xml_singularized_root
+    'fish'
+  end
+end
+```
+
+## Examples
+
+Remember, anything you can do in Ruby you can do in Porth. Here are a few ideas
+for writing and testing your views.
+
+### Subset
+
+Conveniently select a subset of attributes.
+
+``` ruby
+# app/views/users/show.rb
+@author.attributes.slice 'id', 'first_name', 'last_name', 'email'
+```
+
+### Variable and Condition
+
+Hashes may get dirty if you attempt to build them all in one go. Consider storing
+the hash in a variable and adding to it based on a condition. Like a method you
+need to return the hash on the last line.
+
+``` ruby
+# app/views/users/show.rb
+attributes = @author.attributes.slice 'id', 'first_name', 'last_name', 'email'
+if current_user.admin?
+  attributes['ip_address'] = @author.ip_address
+  attributes['likability'] = @author.determine_likability_as_of Time.current
+end
+attributes
+```
+
+### Functional Test
+
+Use functional tests to verify the response's body is correct.
+
+``` ruby
+# app/views/posts/show.rb
+@author.attributes.slice 'id', 'title', 'body'
+```
+
+JSON maps well to Ruby's hashes. Set the response to JSON, parse the body into 
+a hash and verify the key-value pairs.
+
+``` ruby
+# test/functional/posts_controller_test.rb
+require 'test_helper'
+
+class PostsControllerTest < ActionController::TestCase
+  # ...
+  
+  test "GET show" do
+    get :show, id: posts(:hello_word).id, format: 'json'
+    post = JSON.parse response.body
+    assert_equal 123040040, post['id']
+    assert_equal 'Hello, World!', post['title']
+    assert_equal 'Lorem ipsum dolar sit amet...', post['body']
+  end
+end
+```
+
 ## Compatibility
 
+* MRI 1.8.7
+* MRI 1.9.2+
+* JRuby 1.6.4+
+
+## Dependancies
+
 * ActionPack 3.1.0
-* JRuby 1.6.4
-* Ruby 1.9.2
+
+## Extensions
+
+* [porth-plist](https://github.com/soundevolution/porth-plist) - Adds Property list (.plist) support
 
 ## Contributing
 
 1. Fork
 2. Install dependancies by running `$ bundle install`
 3. Write tests and code
-4. Make sure the tests pass by running `$ rake`
+4. Make sure the tests pass by running `$ bundle exec rake`
 5. Push and send a pull request on GitHub
 
 ## Credits

data/lib/porth.rb

@@ -1,5 +1,4 @@
 require 'action_controller'
-require 'json'
 
 require 'porth/format/json'
 require 'porth/format/xml'

data/lib/porth/format/xml.rb

@@ -2,14 +2,27 @@ module Porth
   module Format
     module XML
       def self.call controller, object
-        object.to_xml :root => controller.send(:xml_root)
+        method = if object.respond_to?(:count) && !object.respond_to?(:keys)
+          :xml_pluralized_root
+        else
+          :xml_singularized_root
+        end
+        object.to_xml :root => controller.send(method)
       end
       
       module ControllerExtensions
         protected
-                
+        
         def xml_root
-          self.class.name.sub('Controller', '').underscore.split('/').last.pluralize
+          self.class.name.sub('Controller', '').underscore.split('/').last
+        end
+        
+        def xml_pluralized_root
+          xml_root.pluralize
+        end
+                
+        def xml_singularized_root
+          xml_root.singularize
         end
       end
     end

data/lib/porth/version.rb

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

data/porth.gemspec

@@ -20,8 +20,7 @@ Gem::Specification.new do |s|
   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_runtime_dependency 'actionpack', '>= 3.0.0', '< 4.0.0'
   
   s.add_development_dependency 'minitest', '~> 2.6.2'
   s.add_development_dependency 'rake',     '~> 0.9.2'

data/test/fixtures/array.rb

@@ -0,0 +1 @@
+[{:foo => 'bar'}]

data/test/fixtures/block.rb

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

data/test/fixtures/hash.rb

@@ -0,0 +1 @@
+{:foo => 'bar'}

data/test/porth/format/xml_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class Format::XMLTest < MiniTest::Unit::TestCase
+  def mock_controller name
+    instance_eval <<-RUBY_STRING
+      Class.new do
+        include Format::XML::ControllerExtensions
+        
+        public :xml_root, :xml_pluralized_root, :xml_singularized_root
+        
+        def self.name
+          '#{name}'
+        end
+      end
+    RUBY_STRING
+  end
+  
+  def test_xml_root
+    assert_equal 'foo', mock_controller('Foo').new.xml_root
+    assert_equal 'foo', mock_controller('FooController').new.xml_root
+    assert_equal 'foos', mock_controller('FoosController').new.xml_root
+    assert_equal 'bar', mock_controller('Foo::BarController').new.xml_root
+  end
+  
+  def test_xml_pluralized_root
+    assert_equal 'foos', mock_controller('Foo').new.xml_pluralized_root
+    assert_equal 'foos', mock_controller('Foos').new.xml_pluralized_root
+  end
+  
+  def test_xml_singularized_root
+    assert_equal 'foo', mock_controller('Foo').new.xml_singularized_root
+    assert_equal 'foo', mock_controller('Foos').new.xml_singularized_root
+  end
+end

data/test/porth/rendering/json_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class Rendering::JSONTest < MiniTest::Unit::TestCase
+  include Rendering
+  
+  def test_render_json
+    assert_equal '[{"value":1},{"value":2}]', render('block', :json, MockController.new)
+  end
+  
+  def test_render_json_with_callback
+    controller = MockController.new
+    controller.params[:callback] = 'myFunction'
+    assert_equal 'myFunction([{"value":1},{"value":2}])', render('block', :json, controller)
+  end
+  
+  def test_render_json_with_instance_variable
+    assert_equal '["bar"]', render('instance_variable', :json, MockController.new, {'foo' => 'bar'})
+  end
+end

data/test/porth/rendering/xml_test.rb

@@ -0,0 +1,25 @@
+require 'active_support/core_ext/hash'
+require 'rexml/document'
+require 'test_helper'
+
+class Rendering::XMLTest < MiniTest::Unit::TestCase
+  include Rendering
+  
+  def test_render_xml
+    assert_equal "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<mocks type=\"array\">\n  <mock>\n    <value type=\"integer\">1</value>\n  </mock>\n  <mock>\n    <value type=\"integer\">2</value>\n  </mock>\n</mocks>\n", render(:block, :xml, MockController.new)
+  end
+
+  def test_render_xml_with_array_of_objects
+    xml = REXML::Document.new render('array', :xml, MockController.new)
+    assert_equal 'mocks', xml.root.name
+  end
+
+  def test_render_xml_with_object
+    xml = REXML::Document.new render('hash', :xml, MockController.new)
+    assert_equal 'mock', xml.root.name
+  end
+  
+  def test_render_xml_with_instance_variable
+    assert_equal "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<mocks type=\"array\">\n  <mock>bar</mock>\n</mocks>\n", render('instance_variable', :xml, MockController.new, {'foo' => 'bar'})
+  end
+end

data/test/test_helper.rb

@@ -1,4 +1,22 @@
 require 'minitest/autorun'
 require 'porth'
 
+module Rendering
+  class MockController < ActionController::Base
+    def params
+      @params ||= {}
+    end    
+  end
+
+  def render file, format, controller, 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
+end
+
 include Porth

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: porth
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,36 +9,25 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-23 00:00:00.000000000Z
+date: 2012-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &70355213483100 !ruby/object:Gem::Requirement
+  requirement: &70304282535720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.0.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
+  version_requirements: *70304282535720
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70355213479740 !ruby/object:Gem::Requirement
+  requirement: &70304282563600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -46,10 +35,10 @@ dependencies:
         version: 2.6.2
   type: :development
   prerelease: false
-  version_requirements: *70355213479740
+  version_requirements: *70304282563600
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70355213477700 !ruby/object:Gem::Requirement
+  requirement: &70304282560040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -57,7 +46,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70355213477700
+  version_requirements: *70304282560040
 description: Write your views using plain old Ruby
 email:
 - tate@tatey.com
@@ -66,6 +55,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -77,11 +68,14 @@ files:
 - lib/porth/unknown_format_error.rb
 - lib/porth/version.rb
 - porth.gemspec
+- test/fixtures/array.rb
 - test/fixtures/block.rb
+- test/fixtures/hash.rb
 - test/fixtures/instance_variable.rb
-- test/port/handler_test.rb
-- test/port/rendering_test.rb
-- test/port/xml_test.rb
+- test/porth/format/xml_test.rb
+- test/porth/handler_test.rb
+- test/porth/rendering/json_test.rb
+- test/porth/rendering/xml_test.rb
 - test/test_helper.rb
 homepage: https://github.com/tatey/porth
 licenses: []
@@ -97,7 +91,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1831659487050102680
+      hash: -621584802889882658
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -106,17 +100,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1831659487050102680
+      hash: -621584802889882658
 requirements: []
 rubyforge_project: porbt
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Plain Old Ruby Template Handler
 test_files:
+- test/fixtures/array.rb
 - test/fixtures/block.rb
+- test/fixtures/hash.rb
 - test/fixtures/instance_variable.rb
-- test/port/handler_test.rb
-- test/port/rendering_test.rb
-- test/port/xml_test.rb
+- test/porth/format/xml_test.rb
+- test/porth/handler_test.rb
+- test/porth/rendering/json_test.rb
+- test/porth/rendering/xml_test.rb
 - test/test_helper.rb

data/test/port/rendering_test.rb

@@ -1,40 +0,0 @@
-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

@@ -1,22 +0,0 @@
-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