simonmenke-render_any 0.0.2

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Simon Menke
+
+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.rdoc

@@ -0,0 +1,91 @@
+= RenderAny
+
+RenderAny allows you to describe how a (restful) controller behaves for a specific format.
+
+
+== Example
+
+This is an example controller which responds to <tt>:html</tt>, <tt>:xml</tt>, <tt>:json</tt> and <tt>:yaml</tt>
+
+  class PostsController < ApplicationController
+    def index
+      @posts = Post.all
+      render_any @posts
+    end
+  
+    def show
+      @post = Post.find(params[:id])
+      render_any @post
+    end
+  
+    def new
+      @post = Post.new
+      render_any @post
+    end
+  
+    def edit
+      @post = Post.find(params[:id])
+      render_any @post
+    end
+  
+    def create
+      @post = Post.new(params[:post])
+      render_create(@post) { @post.save }
+    end
+  
+    def update
+      @post = Post.find(params[:id])
+      render_update(@post) { @post.update_attributes(params[:post]) }
+    end
+  
+    def destroy
+      @post = Post.find(params[:id])
+      render_destroy(@post) { @post.destroy }
+    end
+  end
+
+== Adding a format
+
+Adding a format is easy, just put something like this in an initializer.
+
+  RenderAny.register :html do |s|
+    
+    s.default do |object, options|
+      render
+    end
+    
+    s.not_found do |object, options|
+      render_optional_error_file :not_found
+    end
+    
+    s.unprocessable_entity do |object, options|
+      render_optional_error_file :unprocessable_entity
+    end
+    
+    s.create do |object, options|
+      redirect_to object
+    end
+    
+    s.create_failed do |object, options|
+      render :action => 'new'
+    end
+    
+    s.update do |object, options|
+      redirect_to object
+    end
+    
+    s.update_failed do |object, options|
+      render :action => 'edit'
+    end
+    
+    s.destroy do |object, options|
+      redirect_to [object.class.to_s.underscore.pluralize.to_sym]
+    end
+    
+    s.destroy_failed do |object, options|
+      redirect_to object
+    end
+    
+  end
+
+Copyright (c) 2009 Simon Menke, released under the MIT license

data/lib/render_any/action_controller/render_any.rb

@@ -0,0 +1,42 @@
+module RenderAny
+  module ActionController #:nodoc:
+    module RenderAny
+      
+      def render_any(object, options={})
+        mime_types = ::RenderAny.mime_type_for_request(request)
+        
+        if object.nil?
+          render_any_with(:not_found,     false, mime_types, object, options)
+        else
+          render_any_with(params[:action], true,  mime_types, object, options)
+        end
+        
+      end
+      
+      private
+      
+      def serialize_and_render_with(handler, use_default, mime_types, object, options)
+        mime_types.each do |type|
+          serializer = ::RenderAny.serializers[type.to_sym]
+          next if serializer.nil?
+          next if !serializer.has_handler? handler and !use_default
+          handler = serializer.handler(handler)
+          handler = handler.bind(self)
+          handler.call(object, options)
+          return true
+        end
+        
+        return false
+      end
+      
+      def render_any_with(handler, use_default, mime_types, object, options)
+        if serialize_and_render_with(handler, use_default, mime_types, object, options)
+          return true
+        else
+          serialize_and_render_with(:unprocessable_entity, false, mime_types, object, options)
+        end
+      end
+      
+    end
+  end
+end

data/lib/render_any/action_controller/render_any_failable.rb

@@ -0,0 +1,28 @@
+module RenderAny
+  module ActionController #:nodoc:
+    module RenderAnyFailable
+      
+      def render_any_failable(object, options={}, success=nil, &block)
+        mime_types = ::RenderAny.mime_type_for_request(request)
+        
+        if success.nil? and object and block
+          success = block.call(object)
+        end
+        
+        if object.nil?
+          render_any_with(:not_found, false, mime_types, object, options)
+        elsif success
+          render_any_with(params[:action], true, mime_types, object, options)
+        else
+          render_any_with("#{params[:action]}_failed", true, mime_types, object, options)
+        end
+        
+      end
+      
+      alias_method :render_update, :render_any_failable
+      alias_method :render_create, :render_any_failable
+      alias_method :render_destroy, :render_any_failable
+      
+    end
+  end
+end

data/lib/render_any/serializer.rb

@@ -0,0 +1,35 @@
+# RenderAny
+module RenderAny
+
+  class Serializer
+    attr_reader :format
+    
+    def initialize(format, &block)
+      @format = format.to_sym
+      block.call(self)
+    end
+    
+    def self.handler(name, fallback=:default)
+      class_eval %{
+        def #{name}(&block)
+          @#{name}_proc = block if block
+          @#{name}_proc #{fallback ? "|| #{fallback}" : ''}
+        end
+      }
+    end
+    
+    def self.configure
+      yield self
+    end
+    
+    def handler(name)
+      send(name)
+    end
+    
+    def has_handler?(name)
+      !! instance_variable_get("@#{name}_proc")
+    end
+    
+  end
+  
+end

data/lib/render_any.rb

@@ -0,0 +1,21 @@
+# RenderAny
+module RenderAny
+  
+  class << self
+    attr_accessor :serializers
+  end
+  self.serializers = {}
+  
+  def self.register(format, &block)
+    self.serializers[format.to_sym] = Serializer.new(format, &block)
+  end
+      
+  def self.mime_type_for_request(request)
+    if ::ActionController::Base.use_accept_header
+      Array(Mime::Type.lookup_by_extension(request.parameters[:format]) || request.accepts)
+    else
+      [request.format]
+    end
+  end
+  
+end

data/rails/init.rb

@@ -0,0 +1,181 @@
+# Include hook code here
+::ActionController::Base.send :include, ::RenderAny::ActionController::RenderAny
+::ActionController::Base.send :include, ::RenderAny::ActionController::RenderAnyFailable
+
+::RenderAny::Serializer.configure do |s|
+  s.handler(:default, nil)
+  s.handler(:not_found)
+  s.handler(:unprocessable_entity)
+  
+  s.handler(:index)
+  s.handler(:show)
+  s.handler(:new)
+  s.handler(:edit)
+  
+  s.handler(:create)
+  s.handler(:create_failed, :create)
+  s.handler(:update)
+  s.handler(:update_failed, :update)
+  s.handler(:destroy)
+  s.handler(:destroy_failed, :destroy)
+end
+
+::RenderAny.register :html do |s|
+  
+  s.default do |object, options|
+    render
+  end
+  
+  s.not_found do |object, options|
+    render_optional_error_file :not_found
+  end
+  
+  s.unprocessable_entity do |object, options|
+    render_optional_error_file :unprocessable_entity
+  end
+  
+  s.create do |object, options|
+    redirect_to object
+  end
+  
+  s.create_failed do |object, options|
+    render :action => 'new'
+  end
+  
+  s.update do |object, options|
+    redirect_to object
+  end
+  
+  s.update_failed do |object, options|
+    render :action => 'edit'
+  end
+  
+  s.destroy do |object, options|
+    redirect_to [object.class.to_s.underscore.pluralize.to_sym]
+  end
+  
+  s.destroy_failed do |object, options|
+    redirect_to object
+  end
+  
+end
+
+::RenderAny.register :xml do |s|
+  
+  s.default do |object, options|
+    render :xml => object.to_xml(options)
+  end
+  
+  s.not_found do |object, options|
+    render_optional_error_file :not_found
+  end
+  
+  s.unprocessable_entity do |object, options|
+    render_optional_error_file :unprocessable_entity
+  end
+  
+  s.create do |object, options|
+    render :xml => object.to_xml(options), :status => :created, :location => object
+  end
+  
+  s.create_failed do |object, options|
+    render :xml => object.errors, :status => :unprocessable_entity
+  end
+  
+  s.update do |object, options|
+    head :ok
+  end
+  
+  s.update_failed do |object, options|
+    render :xml => object.errors, :status => :unprocessable_entity
+  end
+  
+  s.destroy do |object, options|
+    head :ok
+  end
+  
+  s.destroy_failed do |object, options|
+    render :xml => object.errors, :status => :unprocessable_entity
+  end
+  
+end
+
+::RenderAny.register :json do |s|
+  
+  s.default do |object, options|
+    render :json => object.to_json(options)
+  end
+  
+  s.not_found do |object, options|
+    render_optional_error_file :not_found
+  end
+  
+  s.unprocessable_entity do |object, options|
+    render_optional_error_file :unprocessable_entity
+  end
+  
+  s.create do |object, options|
+    render :json => object.to_json(options), :status => :created, :location => object
+  end
+  
+  s.create_failed do |object, options|
+    render :json => object.errors, :status => :unprocessable_entity
+  end
+  
+  s.update do |object, options|
+    head :ok
+  end
+  
+  s.update_failed do |object, options|
+    render :json => object.errors, :status => :unprocessable_entity
+  end
+  
+  s.destroy do |object, options|
+    head :ok
+  end
+  
+  s.destroy_failed do |object, options|
+    render :json => object.errors, :status => :unprocessable_entity
+  end
+  
+end
+
+::RenderAny.register :yaml do |s|
+  
+  s.default do |object, options|
+    render :text => object.to_yaml(options), :content_type => 'text/yaml'
+  end
+  
+  s.not_found do |object, options|
+    render_optional_error_file :not_found
+  end
+  
+  s.unprocessable_entity do |object, options|
+    render_optional_error_file :unprocessable_entity
+  end
+  
+  s.create do |object, options|
+    render :text => object.to_yaml(options), :content_type => 'text/yaml', :status => :created, :location => object
+  end
+  
+  s.create_failed do |object, options|
+    render :text => object.errors.to_yaml, :content_type => 'text/yaml', :status => :unprocessable_entity
+  end
+  
+  s.update do |object, options|
+    head :ok
+  end
+  
+  s.update_failed do |object, options|
+    render :text => object.errors.to_yaml, :content_type => 'text/yaml', :status => :unprocessable_entity
+  end
+  
+  s.destroy do |object, options|
+    head :ok
+  end
+  
+  s.destroy_failed do |object, options|
+    render :text => object.errors.to_yaml, :content_type => 'text/yaml', :status => :unprocessable_entity
+  end
+  
+end

data/tasks/render_any_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :render_any do
+#   # Task goes here
+# end

data/test/render_any_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class RenderAnyTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: simonmenke-render_any
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Simon Menke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-07 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: simon.menke@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- test/render_any_test.rb
+- test/test_helper.rb
+- lib/render_any/action_controller/render_any.rb
+- lib/render_any/action_controller/render_any_failable.rb
+- lib/render_any/serializer.rb
+- lib/render_any.rb
+- rails/init.rb
+- tasks/render_any_tasks.rake
+- MIT-LICENSE.txt
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/simonmenke/render_any
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: render_any
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Automaticaly render an appropriate response.
+test_files: 
+- test/render_any_test.rb
+- test/test_helper.rb