decent_decoration 0.0.1 → 0.0.2

data/README.md

@@ -1,24 +1,63 @@
-# DecentDecoration
+# decent_decoration
 
-TODO: Write a gem description
+decent_decoration allows you to use excellent [decent_exposure][decent_exposure] gem with decorators.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'decent_decoration'
+```
+gem 'decent_decoration'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
-Or install it yourself as:
+## Usage
 
-    $ gem install decent_decoration
+``` ruby
+# app/controllers/conferences_controller.rb
+# with decent_exposure
+class ConferencesController < ApplicationController
+  expose(:conference) { ConferenceDecorator.new(build_conference) }
 
-## Usage
+  private
+
+  def build_conference
+    # create new conference or fetch existing one
+  end
+end
+
+# with decent_decoration
+class ConferencesController < ApplicationController
+  expose_decorated(:conference)
+end
+
+```
 
-TODO: Write usage instructions here
+Define a decorator explicitly:
+
+``` ruby
+# app/controllers/conferences_controller.rb
+class ConferencesController < ApplicationController
+  expose_decorated(:conference, decorator: SponsoredConferenceDecorator)
+end
+```
+
+decent_decoration supports most of the awesome [decent_exposure api][decent_exposure_api]. Read [more about it!][decent_exposure_api]
+
+``` ruby
+# app/controllers/attendees_controller.rb
+class AttendeesController < ApplicationController
+  expose_decorated(:conference)
+  expose_decorated(:attendees, ancestor: :conference)
+end
+```
+
+You can use any decorator mechanism as long as `ConferenceDecorator` responds to `#decorate` or `#new`. Try [draper][draper].
 
 ## Contributing
 
@@ -27,3 +66,7 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+[decent_exposure]: https://github.com/voxdolo/decent_exposure
+[decent_exposure_api]: https://github.com/voxdolo/decent_exposure#usage
+[draper]: https://github.com/drapergem/draper

data/decent_decoration.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["pewniak747@gmail.com"]
   gem.description   = %q{Use decent_exposure with decorators (e.g. Draper)}
   gem.summary       = %q{Use decent_exposure with decorators (e.g. Draper)}
-  gem.homepage      = "https://github.com/pewniak747/decent_decoration"
+  gem.homepage      = "https://github.com/netguru/decent_decoration"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/decent_decoration/decorate.rb

@@ -1,13 +1,14 @@
 module DecentDecoration
   module Decorate
-    def decorate(name, options = {}, &block)
-      decorator_class = "#{name.to_s.singularize.classify}Decorator".constantize
+    def expose_decorated(name, options = {}, &block)
+      decorator_class = options.delete(:decorator) || "#{name.to_s.singularize.classify}Decorator".constantize
       decorated_name = name.to_sym
       undecorated_name = "undecorated_#{name}".to_sym
 
       options[:model] ||= decorated_name
+      decorate_method = decorator_class.respond_to?(:decorate) ? :decorate : :new
       expose(undecorated_name, options, &block)
-      expose(decorated_name) { decorator_class.new(public_send(undecorated_name)) }
+      expose(decorated_name) { decorator_class.public_send(decorate_method, public_send(undecorated_name)) }
     end
   end
 end

data/lib/decent_decoration/version.rb

@@ -1,3 +1,3 @@
 module DecentDecoration
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/fixtures/controllers.rb

@@ -17,7 +17,8 @@ end
 class ConferencesController < ActionController::Base
   include Rails.application.routes.url_helpers
 
-  decorate(:conference)
+  expose_decorated(:conference)
+  expose_decorated(:other_conference, model: Conference, decorator: CoolConferenceDecorator)
 
   def show
     render :text => "foo"

data/spec/fixtures/decorators.rb

@@ -5,3 +5,6 @@ class ConferenceDecorator < SimpleDelegator
     __getobj__
   end
 end
+
+class CoolConferenceDecorator < ConferenceDecorator
+end

data/spec/integration/rails_application_spec.rb

@@ -12,4 +12,9 @@ describe ConferencesController, type: :controller do
     get '/conference/RuPy'
     controller.conference.decorated_object.should be_instance_of(Conference)
   end
+
+  it "should be specified decorator" do
+    get '/conference/RuPy'
+    controller.other_conference.should be_instance_of(CoolConferenceDecorator)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decent_decoration
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-18 00:00:00.000000000 Z
+date: 2012-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decent_exposure
@@ -111,7 +111,7 @@ files:
 - spec/fixtures/decorators.rb
 - spec/fixtures/fake_rails_application.rb
 - spec/integration/rails_application_spec.rb
-homepage: https://github.com/pewniak747/decent_decoration
+homepage: https://github.com/netguru/decent_decoration
 licenses: []
 post_install_message: 
 rdoc_options: []