resubject 0.0.4 → 0.1.0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.1.0
+
+- enhancements
+  - Add time_ago helper
+  - Add percentage helper
+  - Add date_format helper
+
 # 0.0.4
 
 - bugfixes

data/Gemfile

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

data/README.md

@@ -10,7 +10,7 @@ Uber simple presenters using Ruby's SimpleDelegator.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'resubject', '~> 0.0.4'
+gem 'resubject', '~> 0.1.0'
 ```
 
 And then execute:
@@ -21,9 +21,56 @@ And then execute:
 
 Checkout the documentation in [rdoc.info/resubject](http://rdoc.info/github/felipeelias/resubject/master/frames)
 
+## Introduction
+
+Resubject uses Ruby's [SimpleDelegator](http://apidock.com/ruby/SimpleDelegator) class to create its presenters.
+
+SimpleDelegator is a concrete implemenation of the Delegator class. Basically, it delegates any method calls to the object passed into the constructor:
+
+```ruby
+require 'delegate'
+
+array = SimpleDelegator.new([1, 2, 3])
+
+array.count # => 3
+array.map   # => #<Enumerator: ...>
+```
+
+It doesn't override the class name, but you still can access the original object.
+
+```ruby
+array.class
+# => SimpleDelegator
+array.__getobj__.class
+# => Array
+```
+
+This means you can create a class that inherits from SimpleDelegator and customize its behaviour:
+
+```ruby
+class ForeverZeroArray < SimpleDelegator
+  def omg!
+    "OMG!"
+  end
+
+  def count
+    0
+  end
+end
+```
+
+You can define new methods or override existing ones:
+
+```ruby
+ForeverZeroArray.new([1,2,3]).count
+# => 0
+ForeverZeroArray.new([1,2,3]).omg!
+# => OMG!
+```
+
 ## Usage
 
-Resubject works on top of `SimpleDelegator` which simply delegates every method call to the delegated object. Example:
+Using the `Resubject::Presenter` class, you can create Presenters from it. Example:
 
 ```ruby
 class Box < Struct.new(:name, :items)
@@ -136,7 +183,18 @@ 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.
+#### Available helpers
+
+```text
+Presenter           Maps to                     Class/Module
+
+currency            number_to_currency          ActionView::Helpers::NumberHelper
+percentage          number_to_percentage        ActionView::Helpers::NumberHelper
+time_ago            time_ago_in_words           ActionView::Helpers::DateHelper
+date_format         to_s                        ActiveSupport::TimeWithZone
+```
+
+More helpers will be added. Feel free to contribute with yours! Also, Check out [the extensions file](https://github.com/felipeelias/resubject/blob/master/lib/resubject/rails/extensions.rb).
 
 ## Maintainers
 

data/lib/resubject/rails/extensions.rb

@@ -28,6 +28,88 @@ module Resubject
           template.number_to_currency to_model.send(attribute), options
         end
       end
+
+      # Generates an attribute using `time_ago_in_words` helper from rails
+      #
+      # @example
+      #
+      #   class ProductPresenter < Resubject::Presenter
+      #     time_ago :posted_at
+      #   end
+      #
+      #   # Will redefine the `posted_at` attribute using `time_ago_in_words`
+      #
+      #   product.posted_at
+      #   # => 'about 1 hour'
+      #
+      # @param [Symbol] attribute the name of the attribute to be generated
+      # @see http://apidock.com/rails/ActionView/Helpers/DateHelper/time_ago_in_words
+      def time_ago(attribute, include_seconds = false)
+        define_method attribute do
+          return if to_model.send(attribute).nil?
+          template.time_ago_in_words to_model.send(attribute), include_seconds
+        end
+      end
+
+      # Generates an attribute using `number_to_percentage` helper from rails
+      #
+      # @example
+      #
+      #   class ProductPresenter < Resubject::Presenter
+      #     percentage :rating
+      #   end
+      #
+      #   # Will create a `rating` attribute using `number_to_percentage`
+      #
+      #   product.rating
+      #   # => '95.000%'
+      #
+      # @example Also, any number_to_percentage options are accepted
+      #
+      #   currency :rating, precision: 0   # => '95%'
+      #   currency :rating, locale: :fr    # => '1 000,000%'
+      #
+      # @param [Symbol] attribute the name of the presented attribute to be generated
+      # @param [Hash] options the options for `number_to_percentage` method
+      # @see http://apidock.com/rails/ActionView/Helpers/NumberHelper/number_to_percentage
+      def percentage(attribute, options = {})
+        define_method attribute do
+          template.number_to_percentage to_model.send(attribute), options
+        end
+      end
+
+      # Formats a date/time attribtue using `to_s` helper from ActiveSupport::TimeWithZone
+      #
+      # @example
+      #
+      #   class PostPresenter < Resubject::Presenter
+      #     date_format :created_at, :short
+      #   end
+      #
+      #   # Will generate a `created_at` method in the presenter
+      #
+      #   post.created_at
+      #   # => '13 Jan 14:10'
+      #
+      # @example Other accepted formats
+      #
+      #   :db           # => 2008-12-25 14:35:05
+      #   :number       # => 20081225143505
+      #   :time         # => 14:35
+      #   :short        # => 25 Dec 14:35
+      #   :long         # => December 25, 2008 14:35
+      #   :long_ordinal # => December 25th, 2008 14:35
+      #   :rfc822       # => Thu, 25 Dec 2008 14:35:05 +0000
+      #
+      # @param [Symbol] attribute the name of the presented attribute to be generated
+      # @param [Symbol] format the format defined in Time::DATE_FORMATS
+      # @see http://apidock.com/rails/ActiveSupport/TimeWithZone/to_s
+      def date_format(attribute, format = :default)
+        define_method attribute do
+          return if to_model.send(attribute).nil?
+          to_model.send(attribute).to_s(format)
+        end
+      end
     end
   end
 end

data/lib/resubject/version.rb

@@ -1,3 +1,3 @@
 module Resubject
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/spec/resubject/rails/extensions_spec.rb

@@ -1,13 +1,18 @@
 require 'spec_helper'
-require 'rails/all'
-require 'resubject/rails'
+require 'action_view'
+require 'resubject/rails/extensions'
 
 describe Resubject::Presenter, 'extensions' do
   let(:model) { mock :model }
 
   let(:presenter) do
     Class.new(Resubject::Presenter) do
+      extend Resubject::Rails::Extensions
+
       currency :price
+      time_ago :posted_at
+      percentage :rating, precision: 0
+      date_format :created_at, :short
     end
   end
 
@@ -21,4 +26,35 @@ describe Resubject::Presenter, 'extensions' do
       expect(subject.price).to eq "$10.00"
     end
   end
+
+  describe '.time_ago' do
+    it 'returns time ago in words' do
+      model.stub(:posted_at).and_return(Time.now - 60 * 60)
+      expect(subject.posted_at).to eq "about 1 hour"
+    end
+
+    it 'returns nothing if value is nil' do
+      model.stub(:posted_at).and_return(nil)
+      expect(subject.posted_at).to eq nil
+    end
+  end
+
+  describe '.percentage' do
+    it 'returns formatted percentage' do
+      model.stub(:rating).and_return(95.123)
+      expect(subject.rating).to eq "95%"
+    end
+  end
+
+  describe '.date_format' do
+    it 'returns formatted date' do
+      model.stub(:created_at).and_return(Time.at(1358082653).utc)
+      expect(subject.created_at).to eq "13 Jan 13:10"
+    end
+
+    it 'returns nothing if value is nil' do
+      model.stub(:created_at).and_return(nil)
+      expect(subject.created_at).to eq nil
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resubject
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-07 00:00:00.000000000 Z
+date: 2013-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   type: :runtime
@@ -124,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       segments:
       - 0
       version: '0'
-      hash: -3489835523721177517
+      hash: 1859410703920262887
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       segments:
       - 0
       version: '0'
-      hash: -3489835523721177517
+      hash: 1859410703920262887
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24