rails_presenter 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,8 @@
 # Rails Presenter
 
-[![Build Status](https://travis-ci.org/dfmonaco/rails_presenter.png?branch=master)](https://travis-ci.org/dfmonaco/rails_presenter)
+### Code Status
+* [![Build Status](https://travis-ci.org/dfmonaco/rails_presenter.png?branch=master)](https://travis-ci.org/dfmonaco/rails_presenter)
+* [![Coverage Status](https://coveralls.io/repos/dfmonaco/rails_presenter/badge.png?branch=master)](https://coveralls.io/r/dfmonaco/rails_presenter)
 
 ##Before:
 
@@ -146,4 +148,37 @@ class ProductPresenter < RailsPresenter::Base
 end
 ```
 
+## How does it work?
+Basically there are two main components, the presenter class and the #present helper method.
 
+### The presenter class
+You can think of a presenter as a mix between a domain model object and a view template, every method call not defined in the current class will be forwarded to the original domain model object, besides you can access all the view template functionality through the #h method. Also the #target method will get you the unmodified original domain model object.
+
+```ruby
+class ProductPresenter < RailsPresenter::Base
+
+  def image
+    h.link_to(h.image_tag(super), h.product_path(target))
+  end
+
+end
+```
+
+### The #present helper method
+The helper method #present it's used to instantiate new presenter objects, it takes any object, an array of objects or an ActiveRecord::Relation and returns the corresponding presenter instances.
+
+```ruby
+present(Customer.new).map(&:class) # => CustomerPresenter
+present([Customer.new, Product.new]).map(&:class) # => [CustomerPresenter, ProductPresenter]
+present(Product.limit(2).order(:name))).map(&:class) # => [ProductPresenter, ProductPresenter]
+```
+This method determines the name of the presenter class from the target object, for example a Project object would instantiate a ProjectPresenter object. If the assumed presenter class doesn't exist it will return the unmodified target object.
+
+You can pass an optional block too:
+
+```ruby
+present(@purchase_order) do |purhase_order_presenter|
+  purchase_order_presenter.date
+  purchase_order_presenter.number
+end
+```

data/lib/rails_presenter/base.rb

@@ -122,10 +122,12 @@ module RailsPresenter
       @template
     end
 
-    def o
+    def target
       __getobj__
     end
 
+    alias_method :o, :target
+
     def to_s
       respond_to?(:name) ? name : super
     end
@@ -143,7 +145,7 @@ module RailsPresenter
       h.render partial: 'shared/show_with_attrs', locals: {attrs_hash: attrs_hash}
     end
 
-    def self_location(location = o)
+    def self_location(location = target)
       h.polymorphic_path location
     end
 
@@ -162,8 +164,8 @@ module RailsPresenter
       when /^h_(.*)$/
         get_iv_from_view($1)
       when /^get_(.*)$/
-        return o if o.is_a? $1.camelize.constantize
-        get_iv_from_view($1) || o.public_send($1)
+        return target if target.is_a? $1.camelize.constantize
+        get_iv_from_view($1) || target.public_send($1)
       else
         super
       end
@@ -171,7 +173,7 @@ module RailsPresenter
 
     private
     def base_object_name
-      o.class.to_s.underscore
+      target.class.to_s.underscore
     end
 
     def get_iv_from_view(iv_name)

data/lib/rails_presenter/version.rb

@@ -1,3 +1,3 @@
 module RailsPresenter
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_presenter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-03 00:00:00.000000000 Z
+date: 2013-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.11
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.11
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Presenters for Rails applications
 email:
 - dfmonaco@gmail.com
@@ -108,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 644764051
+      hash: 84679471
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -117,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 644764051
+      hash: 84679471
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25