decorate-responder 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.8.7

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in decorate-responder.gemspec
+gemspec
+
+group :development do
+  gem 'minitest'
+  gem 'rake'
+end
+
+group :test do
+  gem 'draper'
+  gem 'actionpack'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jan Graichen
+
+MIT License
+
+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.md

@@ -0,0 +1,73 @@
+# Decorate::Responder [![Build Status](https://travis-ci.org/jgraichen/decorate-responder.png?branch=master)](https://travis-ci.org/jgraichen/decorate-responder)
+
+A Rails responder that will apply a decorator to a resource in the responder chain.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'decorate-responder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install decorate-responder
+
+You will also need a decorator gem like [draper](drapergem/draper) or your own decorator implementation.
+
+## Usage
+
+Add `Responders::DecorateResponder` to your responder chain:
+
+```ruby
+class AppResponder < Responder
+  include Responders::DecorateResponder
+end
+
+class MyController < ApplicationController
+  self.responder = AppResponder
+end
+```
+
+Or use it with [plataformatec/responders](https://github.com/plataformatec/responders):
+
+```ruby
+class MyController < ApplicationController
+  responders Responders::DecorateResponder
+end
+```
+
+If you're using a decorator gem such as [draper](drapergem/draper) that injects a `decorate` method into your resources they will get decorated automatically.
+
+You can also explicitly decorate your resources by adding a `decorate` method to your controller:
+
+```ruby
+class AppController
+  responders Responders::DecorateResponder
+
+  def decorate(resource)
+  	MyDecorator.new resource
+  end
+end
+```
+
+If the resource and controller do not have a `decorate` method the resource will not be decorated.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add tests for your feature.
+4. Add your feature.
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
+
+## License
+
+[MIT License](http://www.opensource.org/licenses/mit-license.php)
+
+Copyright (c) 2013, Jan Graichen

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/decorate-responder.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'decorate-responder/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "decorate-responder"
+  gem.version       = DecorateResponder::VERSION
+  gem.authors       = ["Jan Graichen"]
+  gem.email         = ["jg@altimos.de"]
+  gem.description   = %q{A Rails responder to decorate resources.}
+  gem.summary       = %q{A Rails responder to decorate resources.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/decorate-responder/version.rb

@@ -0,0 +1,12 @@
+module DecorateResponder
+  module VERSION
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+    STAGE = nil
+
+    def self.to_s
+      [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join '.'
+    end
+  end
+end

data/lib/decorate-responder.rb

@@ -0,0 +1,8 @@
+
+module Responders
+  autoload :DecorateResponder, 'responders/decorate_responder'
+end
+
+module DecroateResponder
+  autoload :VERSION, 'decorate-responder/version'
+end

data/lib/responders/decorate_responder.rb

@@ -0,0 +1,14 @@
+module Responders
+  module DecorateResponder
+    def to_format
+      @resource = decorate_resource(resource)
+      super
+    end
+
+    def decorate_resource(res)
+      return controller.decorate(res) if controller.respond_to? :decorate
+      return res.decorate if res.respond_to? :decorate
+      res
+    end
+  end
+end

data/test/decorate_responder_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper.rb'
+
+class DecorateResponderTest < ActionController::TestCase
+  tests AppController
+
+  def json; JSON[@response.body] end
+
+  def test_non_decoration
+    get :index, :format => :json, :resource => [ "abc" ]
+
+    assert_equal 1, json.size
+    assert_equal "abc", json[0]
+  end
+
+  def test_decoration
+    get :index, :format => :json, :resource => User.new(:name => "John")
+
+    assert_equal "UserDecorator", json["class"]
+  end
+end

data/test/explicit_decorate_responder_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper.rb'
+
+class ExplicitDecorateResponderTest < ActionController::TestCase
+  tests ExplicitDecorateController
+
+  def json; JSON[@response.body] end
+
+  def test_decoration
+    get :index, :format => :json, :resource => User.new(:name => "John")
+
+    assert_equal "MyDecorator", json["class"]
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,78 @@
+require 'minitest/autorun'
+require 'bundler'
+
+Bundler.setup
+
+# Configure Rails
+ENV["RAILS_ENV"] = "test"
+
+require 'active_support'
+require 'action_controller'
+require 'draper'
+
+require 'decorate-responder'
+
+Responders::Routes = ActionDispatch::Routing::RouteSet.new
+Responders::Routes.draw do
+  match '/index' => 'app#index'
+  match '/ex' => 'explicit_decorate#index'
+end
+
+class ActiveSupport::TestCase
+  setup do @routes = Responders::Routes end
+end
+
+class AppResponder < ActionController::Responder
+  include Responders::DecorateResponder
+end
+
+class User
+  attr_reader :name
+  def initialize(name)
+    @name = name
+  end
+
+  def decorate
+    UserDecorator.new self
+  end
+end
+
+class UserDecorator < Draper::Decorator
+  decorates User
+
+  def as_json(options)
+    { :class => "UserDecorator" }
+  end
+end
+
+class MyDecorator < Draper::Decorator
+  def as_json(options)
+    { :class => "MyDecorator" }
+  end
+end
+
+class AppController < ActionController::Base
+  include Responders::Routes.url_helpers
+
+  self.responder = AppResponder
+  respond_to :json
+
+  def index
+    respond_with params[:resource]
+  end
+end
+
+class ExplicitDecorateController < ActionController::Base
+  include Responders::Routes.url_helpers
+
+  self.responder = AppResponder
+  respond_to :json
+
+  def index
+    respond_with params[:resource]
+  end
+
+  def decorate(resource)
+    MyDecorator.new(resource)
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: decorate-responder
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jan Graichen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-09 00:00:00.000000000 Z
+dependencies: []
+description: A Rails responder to decorate resources.
+email:
+- jg@altimos.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- decorate-responder.gemspec
+- lib/decorate-responder.rb
+- lib/decorate-responder/version.rb
+- lib/responders/decorate_responder.rb
+- test/decorate_responder_test.rb
+- test/explicit_decorate_responder_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -288045878216154046
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -288045878216154046
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A Rails responder to decorate resources.
+test_files:
+- test/decorate_responder_test.rb
+- test/explicit_decorate_responder_test.rb
+- test/test_helper.rb