decent_decoration 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 90d0430f1cee38e0fae31e1b25e47d290afab09c
+  data.tar.gz: 113deae413021de7e3dbde8b322907ef309691d7
+SHA512:
+  metadata.gz: 03e355bf3778078a544e5d946d4152a6f4a3596fa6415a70a95342613ff40910bccacee50c4f67ac67b47a01e06cbc340f57f0c969924be8650621a3f91bbdb1
+  data.tar.gz: ca9e72308a7692f83a0c55dcfbeaad07659b0bde77e4e1a3e55eff93e63270b2a21c4d16dbc28b3bade7097a2f1b6698797e5f9e692da5208e6d01c3c26895ee

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
+  - 2.0.0
 notifications:
   email:
     recipients:

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in decent_decorate.gemspec
 gemspec
+
+gem 'coveralls', require: false

data/Gemfile.lock

@@ -0,0 +1,133 @@
+PATH
+  remote: .
+  specs:
+    decent_decoration (0.0.3)
+      decent_exposure (> 0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    decent_exposure (2.0.1)
+    diff-lcs (1.2.3)
+    draper (1.1.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      request_store (~> 1.0.3)
+    erubis (2.7.0)
+    hike (1.2.2)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.7)
+    mail (2.5.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.23)
+    multi_json (1.7.2)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.13)
+      actionmailer (= 3.2.13)
+      actionpack (= 3.2.13)
+      activerecord (= 3.2.13)
+      activeresource (= 3.2.13)
+      activesupport (= 3.2.13)
+      bundler (~> 1.0)
+      railties (= 3.2.13)
+    railties (3.2.13)
+      actionpack (= 3.2.13)
+      activesupport (= 3.2.13)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.4)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    request_store (1.0.5)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    rspec-rails (2.13.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.18.1)
+    tilt (1.3.7)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.2)
+  coveralls
+  decent_decoration!
+  draper (>= 1.0.0)
+  rails (~> 3.2)
+  rspec (~> 2.13)
+  rspec-rails (~> 2.13)

data/README.md

@@ -1,5 +1,8 @@
 # decent_decoration
 [![Build Status](https://secure.travis-ci.org/netguru/decent_decoration.png?branch=master)](http://travis-ci.org/netguru/decent_decoration)
+[![Code Climate](https://codeclimate.com/github/netguru/decent_decoration.png)](https://codeclimate.com/github/netguru/decent_decoration)
+[![Coverage Status](https://coveralls.io/repos/netguru/decent_decoration/badge.png?branch=master)](https://coveralls.io/r/netguru/decent_decoration)
+[![Gem Version](https://badge.fury.io/rb/decent_decoration.png)](http://badge.fury.io/rb/decent_decoration)
 
 decent_decoration allows you to use excellent [decent_exposure][decent_exposure] gem with decorators.
 
@@ -36,9 +39,10 @@ end
 class ConferencesController < ApplicationController
   expose_decorated(:conference)
 end
-
 ```
 
+decent_decoration makes decorated objects accessible in views. They remain undecorated in your controllers.
+
 Define a decorator explicitly:
 
 ``` ruby
@@ -48,6 +52,15 @@ class ConferencesController < ApplicationController
 end
 ```
 
+decent_decoration detect automatically if you want to decorate a collection. To circumvent this pass collection: true/false
+
+``` ruby
+# app/controllers/conferences_controller.rb
+class ConferencesController < ApplicationController
+  expose_decorated(:conferences, collection: false)
+end
+```
+
 decent_decoration supports most of the awesome [decent_exposure api][decent_exposure_api]. Read [more about it!][decent_exposure_api]
 
 ``` ruby

data/decent_decoration.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
   gem.add_runtime_dependency     'decent_exposure', '> 0'
-  gem.add_development_dependency 'rspec', '~> 2.7'
-  gem.add_development_dependency 'rspec-rails', '~> 2.7'
-  gem.add_development_dependency 'actionpack', '~> 3.1'
-  gem.add_development_dependency 'activesupport', '~> 3.1'
+  gem.add_development_dependency 'rspec', '~> 2.13'
+  gem.add_development_dependency 'rspec-rails', '~> 2.13'
+  gem.add_development_dependency 'rails', '~> 3.2'
+  gem.add_development_dependency 'activesupport', '~> 3.2'
   gem.add_development_dependency 'draper', '>= 1.0.0'
 end

data/lib/decent_decoration.rb

@@ -2,5 +2,5 @@ require "decent_decoration/decorate"
 require "decent_decoration/version"
 
 ActiveSupport.on_load(:action_controller) do
-  extend DecentDecoration::Decorate
+  extend DecentDecoration::ControllerMethods
 end

data/lib/decent_decoration/decorate.rb

@@ -1,21 +1,81 @@
 module DecentDecoration
-  module Decorate
-    def expose_decorated(name, options = {}, &block)
-      options[:model] ||= name
-      original_name = name.to_s
-      plural_name = original_name.pluralize
-      singular_name = original_name.singularize
-      decorator_class = options.delete(:decorator) || "#{options[:model].to_s.classify}Decorator".constantize
-
-      if plural_name == original_name && plural_name != singular_name && decorator_class.respond_to?(:decorate_collection)
-        decorate_method = :decorate_collection
+  class Decoration
+    attr_accessor :name, :original_options
+    private :original_options
+
+    def initialize(name, options = {})
+      self.name = name
+      self.original_options = options
+    end
+
+    def decorated_name
+      "decorated_#{name}".to_sym
+    end
+
+    def options
+      original_options.except(:decorator, :collection).tap do |h|
+        h[:model] ||= name
+      end
+    end
+
+    def decorator_class
+      original_options.fetch(:decorator) { infer_decorator_class }
+    end
+
+    def decorate_method
+      if decorate_collection? && decorator_class.respond_to?(:decorate_collection)
+        :decorate_collection
+      elsif decorator_class.respond_to?(:decorate)
+        :decorate
       else
-        decorate_method = decorator_class.respond_to?(:decorate) ? :decorate : :new
+        :new
       end
+    end
 
-      undecorated_name = "undecorated_#{name}".to_sym
-      expose(undecorated_name, options, &block)
-      expose(name) { decorator_class.public_send(decorate_method, public_send(undecorated_name)) }
+    private
+
+    def infer_decorator_class
+      "#{options[:model].to_s.classify}Decorator".constantize
+    end
+
+    def decorate_collection?
+      (plural_name? && force_collection != false) || force_collection == true
+    end
+
+    def force_collection
+      original_options[:collection]
+    end
+
+    def plural_name?
+      plural_name == name && plural_name != singular_name
+    end
+
+    def plural_name
+      name.to_s.pluralize.to_sym
+    end
+
+    def singular_name
+      name.to_s.singularize.to_sym
+    end
+  end
+
+  module ControllerMethods
+    def expose_decorated(name, options = {}, &block)
+      decoration = Decoration.new(name, options)
+
+      decorator_class  = decoration.decorator_class
+      decorate_method  = decoration.decorate_method
+      decorated_name = decoration.decorated_name
+      options          = decoration.options
+
+      expose(name, options, &block)
+      expose(decorated_name) { decorator_class.public_send(decorate_method, public_send(name)) }
+
+      helper Module.new do
+        define_method(name) do
+          public_send(decorated_name)
+        end
+      end
     end
   end
 end

data/lib/decent_decoration/version.rb

@@ -1,3 +1,3 @@
 module DecentDecoration
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/decoration_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe DecentDecoration::Decoration do
+  let(:klass) { DecentDecoration::Decoration }
+
+  it "should be initialized with name" do
+    subject = klass.new(:conference)
+    subject.name.should == :conference
+  end
+
+  it "should be initialized with options" do
+    subject = klass.new(:conference, { model: :conference })
+    subject.options.should == { model: :conference }
+  end
+
+  describe "#decorated_name" do
+    it "should consist of name prepended by decorated" do
+      klass.new(:conference).decorated_name.should == :decorated_conference
+    end
+  end
+
+  describe "#decorator_class" do
+    it "should infer the class from name" do
+      klass.new(:conference).decorator_class.should == ConferenceDecorator
+    end
+
+    it "should use :decorator if passed" do
+      klass.new(:conference, decorator: AttendeeDecorator).decorator_class.should == AttendeeDecorator
+    end
+  end
+
+  describe "#decorate_method" do
+    describe "when name is plural" do
+      subject { klass.new(:conferences, decorator: decorator) }
+      let(:decorator) { stub }
+
+      it "should be :decorate_collection if decorator supports it" do
+        decorator.stub(:decorate_collection)
+        subject.decorate_method.should == :decorate_collection
+      end
+
+      it "should be :decorate if decorator does not support :decorate_collection and supports :decorate" do
+        decorator.stub(:decorate)
+        subject.decorate_method.should == :decorate
+      end
+
+      it "should be :new if decorator does not support :decorate_collection or :decorate" do
+        subject.decorate_method.should == :new
+      end
+
+      it "should be :decorate if decorator supports it and collection: false" do
+        decorator.stub(:decorate)
+        decorator.stub(:decorate_collection)
+        subject = klass.new(:conferences, decorator: decorator, collection: false)
+        subject.decorate_method.should == :decorate
+      end
+    end
+
+    describe "when name is singular" do
+      subject { klass.new(:conference, decorator: decorator) }
+      let(:decorator) { stub }
+
+      it "should not be :decorate_collection even if decorator supports it" do
+        decorator.stub(:decorate_collection)
+        subject.decorate_method.should_not == :decorate_collection
+      end
+
+      it "should be :decorate_collection if decorator supports it and collection: true" do
+        decorator.stub(:decorate)
+        decorator.stub(:decorate_collection)
+        subject = klass.new(:conference, decorator: decorator, collection: true)
+        subject.decorate_method.should == :decorate_collection
+      end
+
+      it "should be :decorate if decorator supports it" do
+        decorator.stub(:decorate)
+        subject.decorate_method.should == :decorate
+      end
+
+      it "should be :new if decorator does not support :decorate" do
+        subject.decorate_method.should == :new
+      end
+    end
+  end
+end

data/spec/integration/draper_spec.rb

@@ -1,15 +1,18 @@
+require 'spec_helper'
 require 'fixtures/fake_rails_application'
 require 'rspec/rails'
 
 describe AttendeesController, type: :controller do
-  it "should be a decorator" do
+  before do
     get '/attendee/dave'
-    controller.attendee.should be_instance_of(AttendeeDecorator)
+  end
+
+  it "should be a decorator" do
+    controller.view_context.attendee.should be_instance_of(AttendeeDecorator)
   end
 
   it "should be a decorator in collection" do
-    get '/attendee/dave'
-    controller.attendees.each do |attendee|
+    controller.view_context.attendees.each do |attendee|
       attendee.should be_instance_of(AttendeeDecorator)
     end
   end

data/spec/integration/rails_application_spec.rb

@@ -2,18 +2,39 @@ require 'fixtures/fake_rails_application'
 require 'rspec/rails'
 
 describe ConferencesController, type: :controller do
-  it "should be a decorator" do
+  before do
     get '/conference/RuPy'
-    controller.conference.should be_instance_of(ConferenceDecorator)
   end
 
-  it "should have decorated conference" do
-    get '/conference/RuPy'
-    controller.conference.decorated_object.should be_instance_of(Conference)
+  describe "inside a view" do
+    it "should be a decorator" do
+      controller.view_context.conference.should be_instance_of(ConferenceDecorator)
+    end
+
+    it "should have decorated conference" do
+      controller.view_context.conference.decorated_object.should be_instance_of(Conference)
+    end
+
+    it "should be specified decorator" do
+      controller.view_context.other_conference.should be_instance_of(CoolConferenceDecorator)
+    end
+
+    it "should cache decorator" do
+      controller.view_context.conference.object_id.should == controller.view_context.conference.object_id
+    end
+
+    it "should cache decorated object" do
+      controller.view_context.conference.decorated_object.object_id.should == controller.view_context.conference.decorated_object.object_id
+    end
   end
 
-  it "should be specified decorator" do
-    get '/conference/RuPy'
-    controller.other_conference.should be_instance_of(CoolConferenceDecorator)
+  describe "inside a controller" do
+    it "should be undecorated object" do
+      controller.conference.should be_instance_of(Conference)
+    end
+
+    it "should not be specified decorator" do
+      controller.other_conference.should be_instance_of(Conference)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'active_support/all'
+require 'decent_decoration'
+require 'coveralls'
+
+Coveralls.wear!

metadata

@@ -1,110 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: decent_decoration
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Tomasz Pewiński
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-08 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decent_exposure
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - '>'
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - '>'
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.13'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.13'
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: draper
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
 description: Use decent_exposure with decorators (e.g. Draper)
@@ -117,6 +104,7 @@ files:
 - .gitignore
 - .travis.yml
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -124,40 +112,43 @@ files:
 - lib/decent_decoration.rb
 - lib/decent_decoration/decorate.rb
 - lib/decent_decoration/version.rb
+- spec/decoration_spec.rb
 - spec/fixtures/controllers.rb
 - spec/fixtures/decorators.rb
 - spec/fixtures/fake_rails_application.rb
 - spec/fixtures/models.rb
 - spec/integration/draper_spec.rb
 - spec/integration/rails_application_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/netguru/decent_decoration
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Use decent_exposure with decorators (e.g. Draper)
 test_files:
+- spec/decoration_spec.rb
 - spec/fixtures/controllers.rb
 - spec/fixtures/decorators.rb
 - spec/fixtures/fake_rails_application.rb
 - spec/fixtures/models.rb
 - spec/integration/draper_spec.rb
 - spec/integration/rails_application_spec.rb
+- spec/spec_helper.rb