resubject 0.0.1 → 0.0.2

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
+gem 'rails', '~> 3.2.10'
+
 # Specify your gem's dependencies in resubject.gemspec
 gemspec

data/IDEAS.md

@@ -0,0 +1,51 @@
+Present a object with a symbol
+
+    present user, context: :public
+    # => present user, PublicUserPresenter
+
+    present user, :public, :crazy
+    # => present user, PublicPresenter, CrazyPresenter
+
+    # best way to handle this?
+    present user, :public, :user
+    # => present user, PublicPresenter, UserPresenter
+
+Helper class methods
+
+    class UserPresenter < Resubject::Presenter
+      # formats to default (to_s), only if present
+      # object.created_at
+      timestamp :created_at
+
+      # formats to long (to_s(:long))
+      timestamp :created_at, format: :long
+
+      # multiple
+      timestamps :created_at, :updated_at
+
+      autolink!
+      # create object.link
+
+      # currency format
+      currency :price
+
+      # change options
+      currency :price, format: 'whatever'
+    end
+
+Test helpers
+
+    describe UserPresenter do
+      it 'has currency' do
+        user = stub price: 200.0
+        presented(user).currency.should == '$200.00'
+      end
+
+      # or
+
+      subject { UserPresenter.new(stub(price: 200.0)) }
+
+      it 'has currency' do
+        presented.currency.should == '$200'
+      end
+    end

data/README.md

@@ -10,13 +10,17 @@ Uber simple presenters using Ruby's SimpleDelegator.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'resubject', '~> 0.0.1'
+gem 'resubject', '~> 0.0.2'
 ```
 
 And then execute:
 
     $ bundle
 
+## Documentation
+
+Checkout the documentation in [rdoc.info/resubject](http://rdoc.info/github/felipeelias/resubject/master/frames)
+
 ## Usage
 
 Resubject works on top of `SimpleDelegator` which simply delegates every method call to the delegated object. Example:
@@ -37,7 +41,7 @@ Then use the delegator:
 ```ruby
 box = Box.new('Awkward Package', ['platypus', 'sloth', 'anteater'])
 
-presentable = BoxPresenter.new(box, nil)
+presentable = BoxPresenter.new(box)
 presentable.contents
 # => platypus, sloth, anteater
 ```
@@ -84,6 +88,56 @@ Or if you prefer, you can use the `#present` method directly into your views
 <%= present(@box).contents %>
 ```
 
+## Helpers
+
+You can define presentable attributes:
+
+```ruby
+class PostPresenter < Resubject::Presenter
+  presents :title
+  presents :comments # or => presents :comments, CommentPresenter
+end
+```
+
+Then the attributes will return an instance of those presenters:
+
+```ruby
+post.title
+# => <TitlePresenter>
+
+post.comments
+# => [<CommentPresenter>, <CommentPresenter>, <CommentPresenter>]
+```
+
+Or if you wish, you can use the `present` method inside your class
+
+```ruby
+class PostPresenter < Resubject::Presenter
+  def comments
+    present(to_model.comments, SomePresenter)
+  end
+end
+```
+
+### Helpers on Rails
+
+`Resubject` can generate some rails helpers for your attributes:
+
+```ruby
+class ProductPresenter < Resubject::Presenter
+  currency :price, precision: 2
+end
+```
+
+Will generate:
+
+```ruby
+product.price
+# => $10.00
+```
+
+Check out [the extensions file](https://github.com/felipeelias/resubject/blob/master/lib/resubject/rails/extensions.rb) for other attribute helpers.
+
 ## Maintainers
 
 - Felipe Elias Philipp - [coderwall.com/felipeelias](http://coderwall.com/felipeelias)

data/lib/resubject/builder.rb

@@ -0,0 +1,65 @@
+module Resubject
+  module Builder
+    class InvalidPresenterArgument < StandardError #:nodoc:
+    end
+
+    # Presents a object or a collection of objects
+    #
+    # Examples:
+    #
+    #    Builder.present box, template
+    #    => <BoxPresenter>
+    #
+    #    # Using a custom presenter
+    #    Builder.present box, template, CustomPresenter
+    #    => <CustomPresenter>
+    #
+    #    # Using multiple presenters
+    #    Builder.present box, template, OnePresenter, CustomPresenter
+    #    => <OnePresenter<CustomPresenter>>
+    #
+    #    # Using a collection
+    #    Builder.present [box, box], template
+    #    => [<BoxPresenter>, <BoxPresenter>]
+    #
+    def self.present(objects, template, *presenters)
+      if objects.respond_to?(:each)
+        Builder.present_all(objects, template, *presenters)
+      else
+        Builder.present_one(objects, template, *presenters)
+      end
+    end
+
+    # Presents a single object (see .present)
+    #
+    # Example:
+    #
+    #    Builder.present box, template
+    #    => <BoxPresenter>
+    #
+    def self.present_one(object, template, *presenters)
+      presenters = [Naming.presenter_for(object)] unless presenters.any?
+
+      unless presenters.all? { |p| p.is_a?(Class) && p.ancestors.include?(Resubject::Presenter) }
+        raise InvalidPresenterArgument.new("Expected a presenter in #{presenters.inspect}")
+      end
+
+      presenters.inject(object) do |presented, klass|
+        klass.new(presented, template)
+      end
+    end
+
+    # Presents a collection of objects (see .present)
+    #
+    # Example:
+    #
+    #    Builder.present [box, box], template
+    #    => [<BoxPresenter>, <BoxPresenter>]
+    #
+    def self.present_all(objects, template, *presenters)
+      objects.map do |o|
+        Builder.present_one(o, template, *presenters)
+      end
+    end
+  end
+end

data/lib/resubject/naming.rb

@@ -0,0 +1,20 @@
+require 'active_support/core_ext/string/inflections'
+
+module Resubject
+  module Naming
+    def self.presenter_for(presentable)
+      klass = case presentable
+        when Symbol
+          presentable.to_s
+        when String
+          presentable
+        else
+          presentable.class.to_s
+        end
+
+      presenter = "#{klass.camelize}Presenter"
+
+      Object.const_get presenter
+    end
+  end
+end

data/lib/resubject/presenter.rb

@@ -2,36 +2,55 @@ require 'delegate'
 
 module Resubject
   class Presenter < SimpleDelegator
-    attr_reader :template
-    alias :h :template
+    attr_reader  :context
+    alias_method :template, :context
 
-    def initialize(model, template)
-      @template = template
+    def initialize(model, context = nil)
+      @context = context
       super(model)
     end
 
-    def to_model
-      __getobj__
+    alias_method :to_model, :__getobj__
+
+    # Builds a collection of presenters given an array of objects
+    #
+    # Example:
+    #
+    #   boxes = [box1, box2, box3]
+    #   BoxPresenter.all boxes
+    #   # => [<BoxPresenter>, <BoxPresenter>, <BoxPresenter>]
+    #
+    def self.all(collection, context = nil)
+      collection.map { |c| new(c, context) }
     end
 
-    def self.all(collection, template)
-      collection.map { |object| new(object, template) }
+    # Creates a presenter from object or collection of objects
+    # See Builder.present for more details
+    # Example:
+    #
+    #    present box
+    #    => <BoxPresenter>
+    #
+    def present(objects, *presenters)
+      Builder.present objects, context, *presenters
     end
 
-  private
-
-    def self.inject_presenter_for(*options)
-      options.each do |resource|
-        presenter_name = "#{resource}_presenter"
-        attr_writer presenter_name
-
-        define_method presenter_name do
-          instance_variable_get("@#{presenter_name}") || presenter_name.camelize.constantize
-        end
-
-        define_method "present_#{resource}" do |object|
-          send(presenter_name).new(object, @template)
-        end
+    # Generates a instance method with the attribute presented
+    #
+    # Example:
+    #
+    #    class BoxPresenter < Resubject::Presenter
+    #      presents :name
+    #      # or
+    #      # presents :name, CustomPresenter
+    #    end
+    #
+    #    BoxPresenter.new(box).name
+    #    => <NamePresenter>
+    #
+    def self.presents(attribute, *presenters)
+      define_method attribute do
+        present to_model.send(attribute), *presenters
       end
     end
   end

data/lib/resubject/rails/engine.rb

@@ -0,0 +1,10 @@
+module Resubject
+  class Engine < ::Rails::Engine #:nodoc:
+    initializer "resubject.helpers" do
+      ActiveSupport.on_load(:action_controller) do
+        require 'resubject/rails/helpers'
+        include Resubject::Helpers
+      end
+    end
+  end
+end

data/lib/resubject/rails/extensions.rb

@@ -0,0 +1,30 @@
+module Resubject
+  module Rails #:nodoc:
+    module Extensions
+      # Generates an attribute using `number_to_currency` helper from rails
+      #
+      # Examples:
+      #
+      #    class ProductPresenter < Resubject::Presenter
+      #      currency :price
+      #    end
+      #
+      #    # Will create a `price` attribute using `number_to_currency`
+      #
+      #    product.price
+      #    # => '$10.00'
+      #
+      # Options:
+      #
+      #    currency :price, precision: 3   # => '$123.456'
+      #    currency :price, locale: :fr    # => '123,51 €'
+      #
+      # See ActionView::Helpers::NumberHelper#number_to_currency[http://api.rubyonrails.org/classes/ActionView/Helpers/NumberHelper.html#method-i-number_to_currency] for other options
+      def currency(attribute, options = {})
+        define_method attribute do
+          template.number_to_currency to_model.send(attribute), options
+        end
+      end
+    end
+  end
+end

data/lib/resubject/rails/helpers.rb

@@ -1,27 +1,17 @@
 module Resubject
   module Helpers
-    def self.included(base)
+    def self.included(base) #:nodoc:
       base.send(:helper_method, :present)
-      base.send(:private, :present_object)
     end
 
-    def present(object, *presenter_classes)
-      presenter = if object.respond_to?(:each)
-        object.map { |o| present_object(o, presenter_classes) }
-      else
-        present_object(object, presenter_classes)
-      end
+    def present(objects, *presenters)
+      presenters = Builder.present(objects, view_context, *presenters)
 
-      presenter.tap do |p|
+      presenters.tap do |p|
         if block_given?
           yield p
         end
       end
     end
-
-    def present_object(object, presenter_classes)
-      presenter_classes = ["#{object.class}Presenter".constantize] if presenter_classes.empty?
-      presenter_classes.inject(object) { |o, klass| klass.new(o, view_context) }
-    end
   end
 end

data/lib/resubject/rails.rb

@@ -1,11 +1,34 @@
-require 'resubject/rails/helpers'
+require 'resubject/rails/engine'
+require 'resubject/rails/extensions'
 
 module Resubject
-  class Engine < ::Rails::Engine
-    initializer "resubject.helpers" do
-      ActiveSupport.on_load(:action_controller) do
-        include Resubject::Helpers
-      end
+  class Presenter
+    extend Resubject::Rails::Extensions
+
+    private
+
+    def translate(*args, &block)
+      context.t(*args, &block)
+    end
+
+    alias_method :t, :translate
+
+    def localize(*args, &block)
+      context.l(*args, &block)
+    end
+
+    alias_method :l, :localize
+
+    def routes
+      ::Rails.application.routes.url_helpers
+    end
+
+    alias_method :r, :routes
+
+    def helpers
+      context
     end
+
+    alias_method :h, :helpers
   end
 end

data/lib/resubject/version.rb

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

data/lib/resubject.rb

@@ -1,3 +1,5 @@
 require 'resubject/version'
+require 'resubject/naming'
 require 'resubject/presenter'
+require 'resubject/builder'
 require 'resubject/rails' if defined? Rails

data/resubject.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.add_dependency 'activesupport', '~> 3.2'
+
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec", "~> 2.12.0"
 end

data/spec/resubject/builder_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Resubject::Builder do
+  let(:template) { stub }
+
+  before do
+    stub_const 'Box', Class.new
+    stub_const 'BoxPresenter', Class.new(Resubject::Presenter)
+    stub_const 'OtherBoxPresenter', Class.new(Resubject::Presenter)
+  end
+
+  describe '.present_one' do
+    it 'presents the object with related class' do
+      presented = Resubject::Builder.present_one Box.new, template
+      expect(presented).to be_a BoxPresenter
+    end
+
+    it 'presents the object with custom class' do
+      presented = Resubject::Builder.present_one Box.new, template, OtherBoxPresenter
+      expect(presented).to be_a OtherBoxPresenter
+    end
+
+    it 'presents the object with multiple classes' do
+      OtherBoxPresenter.should_receive(:new).twice
+      presenters = [OtherBoxPresenter, OtherBoxPresenter]
+      presented  = Resubject::Builder.present_one Box.new, template, *presenters
+    end
+
+    it 'raises an error if custom presenter is not a presenter' do
+      expect do
+        Resubject::Builder.present_one Box.new, template, *[nil, Class.new]
+      end.to raise_error(Resubject::Builder::InvalidPresenterArgument)
+    end
+  end
+
+  describe '.present_all' do
+    it 'presents multiple objects' do
+      box = Box.new
+      presented = Resubject::Builder.present_all [box, box], template
+
+      expect(presented.map(&:class)).to eq [BoxPresenter, BoxPresenter]
+    end
+
+    it 'presents multiple objects with custom presenters' do
+      box = Box.new
+      presented = Resubject::Builder.present_all [box, box], template, OtherBoxPresenter
+
+      expect(presented.map(&:class)).to eq [OtherBoxPresenter, OtherBoxPresenter]
+    end
+  end
+
+  describe '.present' do
+    it 'presents single object' do
+      presented = Resubject::Builder.present Box.new, template
+      expect(presented).to be_a BoxPresenter
+    end
+
+    it 'presents multiple objects' do
+      box = Box.new
+      presented = Resubject::Builder.present [box, box], template
+
+      expect(presented.map(&:class)).to eq [BoxPresenter, BoxPresenter]
+    end
+  end
+end

data/spec/resubject/naming_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Resubject::Naming do
+  before do
+    stub_const 'Box', Class.new
+    stub_const 'BoxPresenter', Class.new
+  end
+
+  it 'gets the presenter class from an object' do
+    presenter = Resubject::Naming.presenter_for Box.new
+
+    expect(presenter).to eq BoxPresenter
+  end
+
+  it 'gets the presenter class from a symbol' do
+    presenter = Resubject::Naming.presenter_for :box
+
+    expect(presenter).to eq BoxPresenter
+  end
+
+  it 'gets the presenter class from a string' do
+    presenter = Resubject::Naming.presenter_for 'box'
+
+    expect(presenter).to eq BoxPresenter
+  end
+end

data/spec/resubject/presenter_spec.rb

@@ -2,12 +2,62 @@ require 'spec_helper'
 
 describe Resubject::Presenter do
   let(:object)   { mock :object }
-  let(:template) { mock :template }
 
-  subject { Resubject::Presenter.new(object, template) }
+  subject { Resubject::Presenter.new(object) }
 
   it 'delegate methods to object' do
     object.should_receive(:pretty)
     subject.pretty
   end
+
+  describe :to_model do
+    it 'returns the delegated object' do
+      expect(subject.to_model).to eq object
+    end
+  end
+
+  describe '.all' do
+    it 'creates various instances of the presenter' do
+      presented = Resubject::Presenter.all([object, object])
+
+      expect(presented.map(&:class)).to eq [Resubject::Presenter,
+                                            Resubject::Presenter]
+    end
+  end
+
+  describe :present do
+    it 'creates a presenter' do
+      stub_const 'Box', Class.new
+      stub_const 'BoxPresenter', Class.new(Resubject::Presenter)
+
+      presented = subject.present Box.new
+      expect(presented).to be_a BoxPresenter
+    end
+  end
+
+  describe '.presents' do
+    let :presenter do
+      Class.new(Resubject::Presenter) do
+        presents :item
+        presents :other_item, ItemPresenter
+      end
+    end
+
+    before do
+      stub_const 'Item', Class.new
+      stub_const 'ItemPresenter', Class.new(Resubject::Presenter)
+    end
+
+    it 'generates a method preseting the attribute' do
+      box = stub :box, :item => Item.new
+
+      expect(presenter.new(box).item).to be_a ItemPresenter
+    end
+
+    it 'presents the attributes with custom presenter' do
+      box = stub :box, :other_item => stub
+
+      expect(presenter.new(box).other_item).to be_a ItemPresenter
+    end
+  end
 end

data/spec/resubject/rails/extensions_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'rails/all'
+require 'resubject/rails'
+
+describe Resubject::Presenter, 'extensions' do
+  let(:model) { mock :model }
+
+  let(:presenter) do
+    Class.new(Resubject::Presenter) do
+      currency :price
+    end
+  end
+
+  subject do
+    presenter.new(model, ActionView::Base.new)
+  end
+
+  describe '.currency' do
+    it 'returns currency format' do
+      model.should_receive(:price).and_return(10.0)
+      expect(subject.price).to eq "$10.00"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resubject
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,8 +10,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-19 00:00:00.000000000 Z
+date: 2013-01-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  name: activesupport
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
@@ -56,16 +72,24 @@ files:
 - .rspec
 - .travis.yml
 - Gemfile
+- IDEAS.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/resubject.rb
+- lib/resubject/builder.rb
+- lib/resubject/naming.rb
 - lib/resubject/presenter.rb
 - lib/resubject/rails.rb
+- lib/resubject/rails/engine.rb
+- lib/resubject/rails/extensions.rb
 - lib/resubject/rails/helpers.rb
 - lib/resubject/version.rb
 - resubject.gemspec
+- spec/resubject/builder_spec.rb
+- spec/resubject/naming_spec.rb
 - spec/resubject/presenter_spec.rb
+- spec/resubject/rails/extensions_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/felipeelias/resubject
 licenses:
@@ -82,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       segments:
       - 0
       version: '0'
-      hash: 3361348896197597575
+      hash: 134183276947229850
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -91,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       segments:
       - 0
       version: '0'
-      hash: 3361348896197597575
+      hash: 134183276947229850
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -99,5 +123,8 @@ signing_key:
 specification_version: 3
 summary: Uber simple presenters using Ruby's SimpleDelegator
 test_files:
+- spec/resubject/builder_spec.rb
+- spec/resubject/naming_spec.rb
 - spec/resubject/presenter_spec.rb
+- spec/resubject/rails/extensions_spec.rb
 - spec/spec_helper.rb