roar-rails 0.0.2 → 0.0.3

data/.gitignore

@@ -1,4 +1,7 @@
 *.gem
+*.swp
+*.swo
+bin
 .bundle
 Gemfile.lock
 pkg/*

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.2
+gemfile:
+  - Gemfile
+  - gemfiles/Gemfile.rails3-0

data/CHANGES.markdown

@@ -0,0 +1,3 @@
+h2. 0.0.3
+
+* Works with Rails 3.0 now, too. Fixed the `mounted_helpers` import.

data/Gemfile

@@ -1,6 +1,4 @@
 source "http://rubygems.org"
 
-#gem 'actionpack', :path => "../rayls-vor-rebase"
-
 # Specify your gem's dependencies in roar-rails.gemspec
 gemspec

data/README.markdown

@@ -4,26 +4,92 @@ _Makes using Roar's representers in your Rails app fun._
 
 ## Features
 
-### URL Helpers
+* Rendering with responders
+* URL helpers in representers
+* Better tests
+* Autoloading
+
+## Rendering with #respond_with
+
+Easily render resources using representers with the built-in responder.
+
+```ruby
+class SingersController < ApplicationController
+  respond_to :json
+
+  def show
+    singer = Singer.find_by_id(params[:id])
+    respond_with singer
+  end
+
+  def self.responder
+    Class.new(super).send :include, Roar::Rails::Responder
+  end
+
+end
+```
+
+Need to use a representer with a different name than your model? Pass it in using the `:with_representer` option:
+
+```ruby
+class SingersController < ApplicationController
+  respond_to :json
+
+  def show
+    singer = Musician.find_by_id(params[:id])
+    respond_with singer, :with_representer => SingerRepresenter
+  end
+
+  def self.responder
+    Class.new(super).send :include, Roar::Rails::Responder
+  end
+
+end
+```
+
+Goes great with [Jose Valim's responders gem][responders]!
+
+```ruby
+class SingersController < ApplicationController
+  respond_to :json
+
+  responders Roar::Rails::Responder
+
+  def show
+    singer = Singer.find_by_id(params[:id])
+    respond_with singer
+  end
+
+end
+```
+
+## 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
 ```
+To get the hyperlinks up and running, please make sure to set the right _host name_ in your environment files (config/environments):
 
-### Testing
+```ruby
+config.representer.default_url_options = {:host => "127.0.0.1:3000"}
+```
 
-### Autoloading
+## Testing
 
+## Autoloading
 
+Put your representers in `app/representers` and they will be autoloaded by Rails. Also, frequently used modules as media representers and features don't need to be required manually.
 
 
 ## Contributors
 
-* [Railslove](http://www.railslove.de) and especially Michael Bumann [bumi] have heavily supported development of roar-rails ("resource :singers"). 
+* [Railslove](http://www.railslove.de) and especially Michael Bumann [bumi] have heavily supported development of roar-rails ("resource :singers").
+
+[responders]: https://github.com/plataformatec/responders

data/gemfiles/Gemfile.rails3-0

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in roar-rails.gemspec
+gemspec path: '../'
+
+gem 'railties', '~> 3.0.11'

data/lib/roar-rails.rb

@@ -1,5 +1,6 @@
 require "roar/rails/version"
 require "roar/representer"
+require "roar/rails/responder"
 require "roar/rails/railtie"
 
 module Roar::Representer

data/lib/roar/rails/railtie.rb

@@ -9,7 +9,7 @@ module Roar
       initializer "roar.set_configs" do |app|
         ::Roar::Representer.module_eval do
           include app.routes.url_helpers
-          include app.routes.mounted_helpers
+          include app.routes.mounted_helpers unless ::Rails::VERSION::MINOR == 0
           
           include UrlMethods  # provide an initial #default_url_options.
         end

data/lib/roar/rails/responder.rb

@@ -0,0 +1,23 @@
+module Roar::Rails
+  module Responder
+    def extend_with_representer!(resource, representer=nil)
+      representer ||= representer_for_resource(resource)
+      resource.extend(representer)
+    end
+    def display(resource, given_options={})
+      if resource.respond_to?(:map!)
+        resource.map! do |r|
+          extend_with_representer!(r)
+          r.to_hash
+        end
+      else
+        extend_with_representer!(resource, options.delete(:with_representer))
+      end
+      super
+    end
+    private
+    def representer_for_resource(resource)
+      (resource.class.name + "Representer").constantize
+    end
+  end
+end

data/lib/roar/rails/test_case.rb

@@ -4,30 +4,30 @@ module Roar
       def get(action, *args)
         process(action, "GET", *args)
       end
-      
+
       def post(action, *args)
         process(action, "POST", *args)
       end
-      
+
       def put(action, *args)
         process(action, "PUT", *args)
       end
-      
+
       def delete(action, *args)
         process(action, "DELETE", *args)
       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)  # FIXME: for Rails <=3.1, only.
       end
-      
+
       module Assertions
         require 'test_xml/test_unit'
         def assert_body(body, options={})
@@ -35,7 +35,7 @@ module Roar
           assert_equal body, response.body
         end
       end
-      
+
       include Assertions
     end
   end

data/lib/roar/rails/url_methods.rb

@@ -3,7 +3,7 @@
 module Roar::Rails
   module UrlMethods
     def default_url_options
-      Rails.application.config.representer.default_url_options
+      Rails.application.config.representer.default_url_options or {}
     end
   end
 end

data/lib/roar/rails/validations_representer.rb

@@ -0,0 +1,25 @@
+require 'representable/json/collection'
+require 'representable/json/hash'
+
+# Represents a validators hash for a model.
+module ValidatorsRepresenter
+  class ValidatorClient
+    attr_accessor :kind, :options
+  end
+  
+  # Represents a single Validator instance.
+  module ValidatorRepresenter
+    include Roar::Representer::JSON
+    property :kind
+    hash :options
+  end
+  
+  # Represents an array of validators for an attribute.
+  module AttributeValidators
+    include Representable::JSON::Collection
+    items :extend => ValidatorRepresenter, :class => ValidatorClient
+  end
+
+  include Representable::JSON::Hash
+  values :extend => AttributeValidators, :class => Array
+end

data/lib/roar/rails/version.rb

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

data/roar-rails.gemspec

@@ -18,7 +18,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 "roar", "~> 0.9.1"
+  s.add_runtime_dependency "roar", "~> 0.9.2"
   s.add_runtime_dependency "test_xml"
   s.add_runtime_dependency "actionpack",    "~> 3.0"
   s.add_runtime_dependency "railties",    "~> 3.0"

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

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

data/test/representer_test.rb

@@ -2,12 +2,26 @@ 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
 
+  test "it works with uninitialized config.representer.default_url_options" do
+    url_options = Rails.application.config.representer.default_url_options
+    
+    begin
+      Rails.application.config.representer.default_url_options = nil
+      assert_raises RuntimeError, ArgumentError do
+        get :show, :id => "bumi"
+      end
+      assert $!.message =~ /Missing host to link to/
+    rescue
+    ensure
+      Rails.application.config.representer.default_url_options = url_options    
+    end
   end
 end

data/test/responder_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+Singer = Struct.new(:name)
+class SingersController < ActionController::Base
+  respond_to :json
+
+  def explicit_representer
+    singer = Musician.new("Bumi")
+    respond_with singer, :with_representer => SingerRepresenter
+  end
+
+  def implicit_representer
+    singer = Singer.new("Bumi")
+    respond_with singer
+  end
+
+  def collection_of_representers
+    singers = [Singer.new("Bumi"), Singer.new("Bjork"), Singer.new("Sinead")]
+    respond_with singers
+  end
+
+  def self.responder
+    Class.new(super).send :include, Roar::Rails::Responder
+  end
+
+end
+
+class ResponderTest < ActionController::TestCase
+  include Roar::Rails::TestCase
+
+  tests SingersController
+
+  test "responder allows specifying representer" do
+    get :explicit_representer, :format => 'json'
+    assert_equal singer.to_json, @response.body
+  end
+
+  test "responder finds representer by convention" do
+    get :implicit_representer, :format => 'json'
+    assert_equal singer.to_json, @response.body
+  end
+
+  test "responder works with collections" do
+    get :collection_of_representers, :format => 'json'
+    assert_equal singers.map(&:to_hash).to_json, @response.body
+  end
+
+  def singer(name="Bumi")
+    singer = Musician.new(name)
+    singer.extend SingerRepresenter
+  end
+
+  def singers
+    [singer("Bumi"), singer("Bjork"), singer("Sinead")]
+  end
+
+end

data/test/validations_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+require 'active_model'
+require 'roar/rails/validations_representer'
+
+
+class ValidationsTest < MiniTest::Spec
+ class Comment
+    include ActiveModel::Validations
+    validates :name, :presence => true
+  end
+
+  describe "ValidatorRepresenter" do
+    it "renders a representation in #to_json" do
+      assert_equal "{\"kind\":\"presence\",\"options\":{}}", Comment._validators[:name].first.extend(ValidatorsRepresenter::ValidatorRepresenter).to_json
+    end
+    
+    it "parses validator config in #from_json" do
+      validator = ValidatorsRepresenter::ValidatorClient.new.extend(ValidatorsRepresenter::ValidatorRepresenter).from_json("{\"kind\":\"presence\",\"attributes\":[\"name\"],\"options\":{}}")
+      assert_equal "presence", validator.kind
+      assert_equal({}, validator.options)
+    end
+  end
+  
+  describe "ValidatorsRepresenter" do
+    it "renders a collection in #to_json" do
+      assert_equal "{\"name\":[{\"kind\":\"presence\",\"options\":{}}]}", Comment._validators.extend(ValidatorsRepresenter).to_json
+    end
+    
+    it "parses validators in #from_json" do
+      validations = {}.extend(ValidatorsRepresenter).from_json("{\"name\":[{\"kind\":\"presence\",\"options\":[]}]}")
+      assert_equal "presence", validations["name"].first.kind
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Nick Sutterer
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-05 00:00:00 +01:00
+date: 2012-02-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,8 +28,8 @@ dependencies:
         segments: 
         - 0
         - 9
-        - 1
-        version: 0.9.1
+        - 2
+        version: 0.9.2
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -112,13 +112,18 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
+- CHANGES.markdown
 - Gemfile
 - README.markdown
 - Rakefile
+- gemfiles/Gemfile.rails3-0
 - lib/roar-rails.rb
 - lib/roar/rails/railtie.rb
+- lib/roar/rails/responder.rb
 - lib/roar/rails/test_case.rb
 - lib/roar/rails/url_methods.rb
+- lib/roar/rails/validations_representer.rb
 - lib/roar/rails/version.rb
 - roar-rails.gemspec
 - test/dummy/Rakefile
@@ -156,8 +161,10 @@ files:
 - test/dummy/tmp/app/cells/blog/post/latest.html.erb
 - test/dummy/tmp/app/cells/blog/post_cell.rb
 - test/representer_test.rb
+- test/responder_test.rb
 - test/test_case_test.rb
 - test/test_helper.rb
+- test/validations_test.rb
 has_rdoc: true
 homepage: ""
 licenses: []