roar-rails 0.0.3 → 0.0.4

data/CHANGES.markdown

@@ -1,3 +1,7 @@
+h2. 0.0.4
+
+* Added `#consume!` to infer representer name and parse the incoming document for a model.
+
 h2. 0.0.3
 
 * Works with Rails 3.0 now, too. Fixed the `mounted_helpers` import.

data/README.markdown

@@ -5,6 +5,7 @@ _Makes using Roar's representers in your Rails app fun._
 ## Features
 
 * Rendering with responders
+* Parsing incoming documents
 * URL helpers in representers
 * Better tests
 * Autoloading
@@ -15,17 +16,13 @@ Easily render resources using representers with the built-in responder.
 
 ```ruby
 class SingersController < ApplicationController
+  include Roar::Rails::ControllerAdditions
   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
 ```
 
@@ -33,17 +30,13 @@ Need to use a representer with a different name than your model? Pass it in usin
 
 ```ruby
 class SingersController < ApplicationController
+  include Roar::Rails::ControllerAdditions
   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
 ```
 
@@ -63,6 +56,34 @@ class SingersController < ApplicationController
 end
 ```
 
+
+## Parsing incoming documents
+
+In `#create` and `#update` actions it is often necessary to parse the incoming representation and map it to a model instance. Use the `#consume!` method for this.
+
+```ruby
+class SingersController < ApplicationController
+  respond_to :json
+
+  def create
+    singer = Singer.new
+    consume!(singer)
+    
+    respond_with singer
+  end
+end
+```
+
+The `consume!` call will roughly do the following.
+
+```ruby
+singer.
+  extend(SingerRepresenter)
+  from_json(request.body)
+```
+
+So, `#consume!` helps you figuring out the representer module and reading the incoming document.
+
 ## URL Helpers
 
 Any URL helpers from the Rails app are automatically available in representers.

data/lib/roar-rails.rb

@@ -1,6 +1,5 @@
 require "roar/rails/version"
 require "roar/representer"
-require "roar/rails/responder"
 require "roar/rails/railtie"
 
 module Roar::Representer
@@ -15,6 +14,9 @@ end
 
 module Roar
   module Rails
-    # Your code goes here...
+    autoload("TestCase", "roar/rails/test_case")
+    autoload("ControllerAdditions", "roar/rails/controller_additions")
+    autoload("Responder", "roar/rails/responder")
+    autoload("ModelMethods", "roar/rails/responder")
   end
 end

data/lib/roar/rails/controller_additions.rb

@@ -0,0 +1,25 @@
+module Roar::Rails
+  module ControllerAdditions
+    extend ActiveSupport::Concern
+    include ModelMethods
+    
+    module ClassMethods
+      def responder
+        Class.new(super).send :include, Roar::Rails::Responder
+      end
+    end
+    
+    
+    def consume!(model)
+      format = formats.first  # FIXME: i expected request.content_mime_type to do the job. copied from responder.rb. this will return the wrong format when the controller responds to :json and :xml and the Content-type is :xml (?)
+      extend_with_representer!(model)
+      model.send(compute_parsing_method(format), request.body.string) # e.g. from_json("...")
+      model
+    end
+    
+  private
+    def compute_parsing_method(format)
+      "from_#{format}"
+    end
+  end
+end

data/lib/roar/rails/responder.rb

@@ -1,23 +1,31 @@
 module Roar::Rails
-  module Responder
-    def extend_with_representer!(resource, representer=nil)
-      representer ||= representer_for_resource(resource)
-      resource.extend(representer)
+  module ModelMethods
+    # DISCUSS: move this into a generic namespace as we could need that in Sinatra as well.
+    def extend_with_representer!(model, representer=nil)
+      representer ||= representer_for_model(model)
+      model.extend(representer)
+    end
+    
+  private
+    def representer_for_model(model)
+      (model.class.name + "Representer").constantize
     end
-    def display(resource, given_options={})
-      if resource.respond_to?(:map!)
-        resource.map! do |r|
+  end
+  
+  module Responder
+    include ModelMethods
+    
+    def display(model, given_options={})
+      # TODO: remove the [] semantics, this should be done with a Collection representer.
+      if model.respond_to?(:map!)
+        model.map! do |r|
           extend_with_representer!(r)
           r.to_hash
         end
       else
-        extend_with_representer!(resource, options.delete(:with_representer))
+        extend_with_representer!(model, 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/version.rb

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

data/test/consume_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class ConsumeTest < ActionController::TestCase
+  include Roar::Rails::TestCase
+  
+  class SingersController < ActionController::Base
+    include Roar::Rails::ControllerAdditions
+    respond_to :json, :xml
+
+    def consume_json
+      singer = consume!(Singer.new)
+      render :text => singer.to_json
+    end
+  end
+
+  tests SingersController
+  
+  test "#consume parses incoming document and updates the model" do
+    post :consume_json, "{\"name\": \"Bumi\"}", :format => 'json'
+    assert_equal singer.to_json, @response.body
+  end
+
+  def singer(name="Bumi")
+    singer = Musician.new(name)
+    singer.extend SingerRepresenter
+  end
+end

data/test/responder_test.rb

@@ -1,32 +1,29 @@
 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
+  
+  class SingersController < ActionController::Base
+    include Roar::Rails::ControllerAdditions
+    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
+  end
 
   tests SingersController
 

metadata

@@ -1,116 +1,89 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: roar-rails
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-17 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: roar
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &75385160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 9
-        - 2
+      - !ruby/object:Gem::Version
         version: 0.9.2
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: test_xml
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *75385160
+- !ruby/object:Gem::Dependency
+  name: test_xml
+  requirement: &73843430 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: actionpack
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *73843430
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &73842350 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: railties
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *73842350
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &73841770 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *73841770
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &73840790 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 8
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.8.1
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: tzinfo
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *73840790
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: &73839600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
+  prerelease: false
+  version_requirements: *73839600
 description: Rails extensions for using Roar in the popular web framework.
-email: 
+email:
 - apotonick@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - CHANGES.markdown
@@ -119,6 +92,7 @@ files:
 - Rakefile
 - gemfiles/Gemfile.rails3-0
 - lib/roar-rails.rb
+- lib/roar/rails/controller_additions.rb
 - lib/roar/rails/railtie.rb
 - lib/roar/rails/responder.rb
 - lib/roar/rails/test_case.rb
@@ -126,6 +100,7 @@ files:
 - lib/roar/rails/validations_representer.rb
 - lib/roar/rails/version.rb
 - roar-rails.gemspec
+- test/consume_test.rb
 - test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/controllers/singers_controller.rb
@@ -165,37 +140,28 @@ files:
 - test/test_case_test.rb
 - test/test_helper.rb
 - test/validations_test.rb
-has_rdoc: true
-homepage: ""
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: roar-rails
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Use Roar in Rails.
 test_files: []
-