decorate-responder 1.0.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7e2ed8a107be5875df2018ef0de8b9f23e5a34e2
-  data.tar.gz: 05661393b1584cafd1a81e19ac5996a153e94a4b
+SHA256:
+  metadata.gz: 341221a91749fda160099631f71595082dbd6e83018c6e73edd369b1d9baaf3e
+  data.tar.gz: 56b00d4a5fd527a688bd1a247753f8b24f2dc899d87c22df5fa8b22780c6a544
 SHA512:
-  metadata.gz: 712c96ef7be18a34553452c3aaf66deab8ce635392c66e533cd307c4ffc83b159d38a3ab86fa4b10f7c7cc6308099318d6740a4fe09db11884712bfdf7f22e06
-  data.tar.gz: 1edc44ac77087b155089987e25ba287f179a4f39f53f213f3dad4fafde1d41da8f2fa132ba63b5bbed3c288931e283a51be9ee215db6a47201bf41d0c7abae4e
+  metadata.gz: d86488e8d1fd0b95b37e4fc8c39b674e7b6013418403147516c0cdd2f42cbf0cf0dadd6d3959462c885a6de887ee2c8dfa8b43a48f937980743a7dead06b35ef
+  data.tar.gz: bde2ee45d29787b502a86ae691a3eece24f326c66d43d70c89b10dba249473250861bc8121952ee921e59eeb92785da01cf9fefca5f2b8767af18590519e3939

data/.travis.yml

@@ -1,10 +1,18 @@
+dist: xenial
+cache: bundler
 language: ruby
 rvm:
-  - 1.9.3
-env:
-  - RAILS_VERSION=3.2
-  - RAILS_VERSION=4.0
-  - RAILS_VERSION=head
-matrix:
-  allow_failure:
-    - env: RAILS_VERSION=head
+- 2.6.1
+- 2.5.3
+- 2.4.5
+- 2.3.8
+gemfile:
+- Gemfile
+- gemfiles/Gemfile.rails-5-2
+- gemfiles/Gemfile.rails-5-1
+- gemfiles/Gemfile.rails-5-0
+- gemfiles/Gemfile.rails-4-2
+jobs:
+  exclude:
+  - rvm: 2.6.1
+    gemfile: gemfiles/Gemfile.rails-4-2

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## 2.0.0 - 2019-02-18
+### Added
+- Add #decoration_context controller method (#5)
+
+### Removed
+- Remove support for Rails < 4.2 (#4)
+
+[unreleased]: https://github.com/jgraichen/decorate-responder/compare/v2.0.0...HEAD

data/Gemfile

@@ -1,12 +1,9 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in decorate-responder.gemspec
-gemspec
-
 gem 'draper'
 # draper requires activemodel
 gem 'activemodel'
 
-RAILS_VERSION = ENV['RAILS_VERSION'] || '4.0'
-
-eval_gemfile File.expand_path("../gemfiles/Gemfile.rails-#{RAILS_VERSION.gsub(/\.+/, '-')}", __FILE__)
+# Load the actual gem's dependencies from decorate-responder.gemspec
+gemroot = File.dirname File.absolute_path __FILE__
+gemspec path: gemroot

data/README.md

@@ -16,7 +16,7 @@ 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.
+You will also need a decorator gem like [draper](https://github.com/drapergem/draper) or your own decorator implementation.
 
 ## Usage
 
@@ -40,9 +40,22 @@ class MyController < ApplicationController
 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.
+If you're using a decorator gem such as [draper](https://github.com/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:
+When using draper, you may want to pass a [context hash](https://github.com/drapergem/draper#adding-context) from the controller to the decorator.
+You can provide this context by adding a (public!) `decoration_context` method to the controller:
+
+```ruby
+class AppController
+  responders Responder::DecorateResponder
+  
+  def decoration_context
+    { color: false }
+  end
+end
+```
+
+If you want to build even more advanced decoration logic, you can also explicitly decorate your resources by adding a `decorate` method to your controller:
 
 ```ruby
 class AppController

data/Rakefile

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

data/decorate-responder.gemspec

@@ -1,22 +1,25 @@
 # -*- 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.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.authors       = ['Jan Graichen']
+  gem.email         = ['jg@altimos.de']
+  gem.description   = 'A Rails responder to decorate resources.'
+  gem.summary       = 'A Rails responder to decorate resources.'
+  gem.homepage      = ''
   gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  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"]
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'responders', '~> 2.0'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'minitest'

data/gemfiles/Gemfile.rails-4-2

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Load root Gemfile
+self.instance_eval Bundler.read_file 'Gemfile'
+
+gem 'actionpack', '~> 4.2.0'

data/gemfiles/Gemfile.rails-5-0

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Load root Gemfile
+self.instance_eval Bundler.read_file 'Gemfile'
+
+gem 'actionpack', '~> 5.0.0'

data/gemfiles/Gemfile.rails-5-1

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Load root Gemfile
+self.instance_eval Bundler.read_file 'Gemfile'
+
+gem 'actionpack', '~> 5.1.0'

data/gemfiles/Gemfile.rails-5-2

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Load root Gemfile
+self.instance_eval Bundler.read_file 'Gemfile'
+
+gem 'actionpack', '~> 5.2.0'

data/lib/decorate-responder/version.rb

@@ -1,8 +1,8 @@
 module DecorateResponder
   module VERSION
-    MAJOR = 1
+    MAJOR = 2
     MINOR = 0
-    PATCH = 3
+    PATCH = 0
     STAGE = nil
 
     def self.to_s

data/lib/responders/decorate_responder.rb

@@ -1,13 +1,21 @@
 module Responders
   module DecorateResponder
-    def to_format
+    def respond
       @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
+
+      if res.respond_to? :decorate
+        if controller.respond_to? :decoration_context
+          return res.decorate context: controller.decoration_context
+        else
+          return res.decorate
+        end
+      end
+
       res
     end
   end

data/test/decorate_responder_test.rb

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

data/test/decorate_with_context_responder_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper.rb'
+
+class DecorateWithContextResponderTest < ActionController::TestCase
+  tests DecorateWithContextController
+
+  def json
+    JSON[@response.body]
+  end
+
+  def test_non_decoration
+    DecorateWithContextController.resource = ['abc']
+
+    get :index, format: :json
+
+    assert_equal 1, json.size
+    assert_equal 'abc', json[0]
+  end
+
+  def test_decoration_with_context
+    DecorateWithContextController.resource = User.new(name: 'John')
+
+    get :index, format: :json
+
+    assert_equal 'UserDecorator', json['class']
+    assert_equal 'bar', json['foo']
+  end
+end

data/test/explicit_decorate_responder_test.rb

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

data/test/test_helper.rb

@@ -1,25 +1,25 @@
 require 'minitest/autorun'
 require 'bundler'
 
-Bundler.setup
-
 # Configure Rails
-ENV["RAILS_ENV"] = "test"
+ENV['RAILS_ENV'] = 'test'
+
+Bundler.require
 
-require 'active_support'
-require 'action_controller'
-require 'draper'
+require 'action_dispatch'
 
+require 'responders'
 require 'decorate-responder'
 
 Responders::Routes = ActionDispatch::Routing::RouteSet.new
 Responders::Routes.draw do
   get '/index' => 'app#index'
   get '/ex' => 'explicit_decorate#index'
+  get '/ctx' => 'decorate_with_context#index'
 end
 
 class ActiveSupport::TestCase
-  setup do @routes = Responders::Routes end
+  setup { @routes = Responders::Routes }
 end
 
 class AppResponder < ActionController::Responder
@@ -32,47 +32,68 @@ class User
     @name = name
   end
 
-  def decorate
-    UserDecorator.new self
+  def decorate(*args)
+    UserDecorator.new self, *args
   end
 end
 
 class UserDecorator < Draper::Decorator
   decorates User
 
-  def as_json(options)
-    { :class => "UserDecorator" }
+  def as_json(_options)
+    { class: 'UserDecorator' }.merge(context)
   end
 end
 
 class MyDecorator < Draper::Decorator
-  def as_json(options)
-    { :class => "MyDecorator" }
+  def as_json(_options)
+    { class: 'MyDecorator' }
   end
 end
 
 class AppController < ActionController::Base
   include Responders::Routes.url_helpers
 
+  cattr_accessor :resource
+
   self.responder = AppResponder
   respond_to :json
 
   def index
-    respond_with params[:resource]
+    respond_with self.class.resource
   end
 end
 
 class ExplicitDecorateController < ActionController::Base
   include Responders::Routes.url_helpers
 
+  cattr_accessor :resource
+
   self.responder = AppResponder
   respond_to :json
 
   def index
-    respond_with params[:resource]
+    respond_with self.class.resource
   end
 
   def decorate(resource)
     MyDecorator.new(resource)
   end
 end
+
+class DecorateWithContextController < ActionController::Base
+  include Responders::Routes.url_helpers
+
+  cattr_accessor :resource
+
+  self.responder = AppResponder
+  respond_to :json
+
+  def index
+    respond_with self.class.resource
+  end
+
+  def decoration_context
+    {foo: 'bar'}
+  end
+end

metadata

@@ -1,41 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: decorate-responder
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-24 00:00:00.000000000 Z
+date: 2019-02-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A Rails responder to decorate resources.
@@ -45,20 +59,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - decorate-responder.gemspec
-- gemfiles/Gemfile.rails-3-2
-- gemfiles/Gemfile.rails-4-0
-- gemfiles/Gemfile.rails-head
+- gemfiles/Gemfile.rails-4-2
+- gemfiles/Gemfile.rails-5-0
+- gemfiles/Gemfile.rails-5-1
+- gemfiles/Gemfile.rails-5-2
 - lib/decorate-responder.rb
 - lib/decorate-responder/version.rb
 - lib/responders/decorate_responder.rb
 - test/decorate_responder_test.rb
+- test/decorate_with_context_responder_test.rb
 - test/explicit_decorate_responder_test.rb
 - test/test_helper.rb
 homepage: ''
@@ -71,21 +88,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: A Rails responder to decorate resources.
 test_files:
 - test/decorate_responder_test.rb
+- test/decorate_with_context_responder_test.rb
 - test/explicit_decorate_responder_test.rb
 - test/test_helper.rb

data/gemfiles/Gemfile.rails-3-2

@@ -1,2 +0,0 @@
-gem 'actionpack', '~> 3.2.0'
-gem 'minitest', '< 5.0'

data/gemfiles/Gemfile.rails-4-0

@@ -1 +0,0 @@
-gem 'actionpack', '~> 4.0.0'

data/gemfiles/Gemfile.rails-head

@@ -1 +0,0 @@
-gem 'actionpack', github: 'rails/rails'