roar-rails 0.0.1 → 0.0.2

data/README.markdown

@@ -0,0 +1,29 @@
+# roar-rails
+
+_Makes using Roar's representers in your Rails app fun._
+
+## Features
+
+### URL Helpers
+
+Any URL helpers from the Rails app are automatically available in representers.
+
+```ruby
+module FruitRepresenter
+  include Roar::Representer::JSON
+  
+  link :self do
+    fruit_url self
+  end
+```
+
+### Testing
+
+### Autoloading
+
+
+
+
+## Contributors
+
+* [Railslove](http://www.railslove.de) and especially Michael Bumann [bumi] have heavily supported development of roar-rails ("resource :singers"). 

data/lib/roar-rails.rb

@@ -1,4 +1,16 @@
 require "roar/rails/version"
+require "roar/representer"
+require "roar/rails/railtie"
+
+module Roar::Representer
+  autoload("JSON", "roar/representer/json")
+  
+  module Feature
+    autoload("Hypermedia", "roar/representer/feature/hypermedia")
+  end
+end
+
+
 
 module Roar
   module Rails

data/lib/roar/rails/railtie.rb

@@ -0,0 +1,19 @@
+require "rails/railtie"
+require "roar/rails/url_methods"
+
+module Roar
+  module Rails
+    class Railtie < ::Rails::Railtie
+      config.representer = ActiveSupport::OrderedOptions.new
+      
+      initializer "roar.set_configs" do |app|
+        ::Roar::Representer.module_eval do
+          include app.routes.url_helpers
+          include app.routes.mounted_helpers
+          
+          include UrlMethods  # provide an initial #default_url_options.
+        end
+      end
+    end
+  end
+end

data/lib/roar/rails/test_case.rb

@@ -2,7 +2,7 @@ module Roar
   module Rails
     module TestCase
       def get(action, *args)
-        process(action, "GET", nil, *args)
+        process(action, "GET", *args)
       end
       
       def post(action, *args)
@@ -18,8 +18,14 @@ module Roar
       end
       
       def process(action, http_method, document="", params={})
+        if document.is_a?(Hash)
+          params = document
+          document = ""
+        end
+        
         request.env['RAW_POST_DATA'] = document
-        super(action, params, nil, nil, http_method)
+        
+        super(action, params, nil, nil, http_method)  # FIXME: for Rails <=3.1, only.
       end
       
       module Assertions

data/lib/roar/rails/url_methods.rb

@@ -0,0 +1,9 @@
+# Note: this file might be removed soon.
+
+module Roar::Rails
+  module UrlMethods
+    def default_url_options
+      Rails.application.config.representer.default_url_options
+    end
+  end
+end

data/lib/roar/rails/version.rb

@@ -1,5 +1,5 @@
 module Roar
   module Rails
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/roar-rails.gemspec

@@ -20,9 +20,9 @@ Gem::Specification.new do |s|
   
   s.add_runtime_dependency "roar", "~> 0.9.1"
   s.add_runtime_dependency "test_xml"
+  s.add_runtime_dependency "actionpack",    "~> 3.0"
+  s.add_runtime_dependency "railties",    "~> 3.0"
   
   s.add_development_dependency "minitest",	">= 2.8.1"
-  s.add_development_dependency "actionpack",    "~> 3.0"
-  s.add_dependency "railties",    "~> 3.0"
   s.add_development_dependency "tzinfo" # FIXME: why the hell do we need this for 3.1?
 end

data/test/dummy/app/controllers/singers_controller.rb

@@ -0,0 +1,8 @@
+Musician = Struct.new(:name)
+
+class SingersController < ActionController::Base
+  def show
+    singer = Musician.new("Bumi")
+    render :text => singer.extend(SingerRepresenter).to_json
+  end
+end

data/test/dummy/app/representers/singer_representer.rb

@@ -0,0 +1,10 @@
+module SingerRepresenter
+  include Roar::Representer::JSON
+  include Roar::Representer::Feature::Hypermedia
+  
+  property :name
+  
+  link :self do
+    singer_url(name)
+  end
+end

data/test/dummy/config/environments/test.rb

@@ -29,4 +29,6 @@ Dummy::Application.configure do
   # This is necessary if your schema can't be completely dumped by the schema dumper,
   # like if you have constraints or database-specific column types
   # config.active_record.schema_format = :sql
+  
+  config.representer.default_url_options = {:host => "http://roar.apotomo.de"}
 end

data/test/dummy/config/routes.rb

@@ -1,4 +1,5 @@
 Dummy::Application.routes.draw do
   match ':controller(/:action(/:id(.:format)))'
   root :to => 'musician#index'
+  resources :singers
 end

data/test/representer_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+class RepresenterTest < ActionController::TestCase
+  include Roar::Rails::TestCase
+  
+  tests SingersController
+  
+  test "representers can use URL helpers" do
+    get :show, :id => "bumi"
+    assert_body "{\"name\":\"Bumi\",\"links\":[{\"rel\":\"self\",\"href\":\"http://http://roar.apotomo.de/singers/Bumi\"}]}"
+
+  end
+end

data/test/test_case_test.rb

@@ -1,10 +1,5 @@
 require 'test_helper'
 
-ENV['RAILS_ENV'] = 'test'
-require "dummy/config/environment"
-require "rails/test_help" # adds stuff like @routes, etc.
-require "roar/rails/test_case"
-
 class TestCaseTest < ActionController::TestCase
   include Roar::Rails::TestCase
   
@@ -22,6 +17,11 @@ class TestCaseTest < ActionController::TestCase
     assert_equal "", response.body
   end
   
+  test "allows POST with options, only" do
+    post :show, :id => 1
+    assert_equal "1", response.body
+  end
+  
   test "allows POST with document" do
     post :show, "{}"
     assert_equal "{}", response.body

data/test/test_helper.rb

@@ -3,3 +3,8 @@ Bundler.setup
 
 require 'test/unit'
 require 'minitest/spec'
+
+ENV['RAILS_ENV'] = 'test'
+require "dummy/config/environment"
+require "rails/test_help" # adds stuff like @routes, etc.
+require "roar/rails/test_case"

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Nick Sutterer
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-03 00:00:00 +01:00
+date: 2012-01-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,22 +46,21 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: minitest
+  name: actionpack
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 2
-        - 8
-        - 1
-        version: 2.8.1
-  type: :development
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: actionpack
+  name: railties
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -72,21 +71,22 @@ dependencies:
         - 3
         - 0
         version: "3.0"
-  type: :development
+  type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: railties
+  name: minitest
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 3
-        - 0
-        version: "3.0"
-  type: :runtime
+        - 2
+        - 8
+        - 1
+        version: 2.8.1
+  type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: tzinfo
@@ -113,15 +113,19 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- README.markdown
 - Rakefile
 - lib/roar-rails.rb
+- lib/roar/rails/railtie.rb
 - lib/roar/rails/test_case.rb
+- lib/roar/rails/url_methods.rb
 - lib/roar/rails/version.rb
 - roar-rails.gemspec
 - test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/controllers/musician_controller.rb
+- test/dummy/app/controllers/singers_controller.rb
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/representers/singer_representer.rb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/views/musician/featured.html.erb
 - test/dummy/app/views/musician/featured_with_block.html.erb
@@ -151,6 +155,7 @@ files:
 - test/dummy/script/rails
 - test/dummy/tmp/app/cells/blog/post/latest.html.erb
 - test/dummy/tmp/app/cells/blog/post_cell.rb
+- test/representer_test.rb
 - test/test_case_test.rb
 - test/test_helper.rb
 has_rdoc: true

data/test/dummy/app/controllers/musician_controller.rb

@@ -1,36 +0,0 @@
-class MusicianController < ActionController::Base
-  def index
-    render :text => render_cell(:bassist, :promote)
-  end
-
-  def promote
-    render :text => render_cell(:trumpeter, :promote)
-  end
-
-  def promotion
-    render :text => render_cell(:bassist, :provoke)
-  end
-
-  def featured
-  end
-
-  def featured_with_block
-  end
-
-  def skills
-    render :text => render_cell(:bassist, :listen)
-  end
-
-  def hamlet
-  end
-
-  attr_reader :flag
-  def promotion_with_block
-    html = render_cell(:bassist, :play) do |cell|
-      @flag = cell.class
-    end
-
-    render :text => html
-  end
-
-end