presenters 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69f95c182bc6eda82898058fb35217c4d43048ab
-  data.tar.gz: 23d801295ba2931095867ff4c14c96344f9143ac
+  metadata.gz: 5af20d803cdbb814f9343d13d776dd2c74d93d35
+  data.tar.gz: ef9146bc38045e313bd7ff49c6952e45b8fdae36
 SHA512:
-  metadata.gz: 99fccf469f532451a20525623a4b632a1cbb5c53c025782fc0390f0e61b3309109b32edbc5b21ea686f076118506d7e726448c5833bac6f2d14ddf9af699f9a4
-  data.tar.gz: 3c2d2291cff69d3c2a69c6bdbab71636cdf17764c36475741c6d08d2e173083a07ec606c0650e40c22c69be5dcde833ab24e8fde80659ad9a2dd559a1b2b669e
+  metadata.gz: 949dbc93d43843feb426e732b43b94d6d9106e0c1c83ace79e30cd6fb0c6563628e6a5acd1c1091f9d3ffb73a78ff122ff3000ca454a1050fee6c84f3d7df6bd
+  data.tar.gz: 4b87da8367009c19eee08c47a4c37d0020b1f3556e4434c5a5849ab8db7a42f64801956885d6e9409e712c329b1eb9d30786d6aab37f3c790051fa64cfc79b70

data/.travis.yml

@@ -2,3 +2,6 @@ language: ruby
 rvm:
   - 2.2.2
 before_install: gem install bundler
+branches:
+  only:
+    - master

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# v0.2.0 / 2015-08-23
+
+* Include helpers in Presenter.
+* Add presenter method to ActiveRecord:Base.
+* Add presenters method.
+
+# v0.1.0 / 2015-08-23
+
+Create project

data/README.md

@@ -1,6 +1,8 @@
 # Presenters
 
-A simple presenter pattern for ruby. It also can work in rails. This is based on [Presenters in Rails](http://nithinbekal.com/posts/rails-presenters/)
+A simple presenter pattern for ruby. It can work in rails. This is based on [Presenters in Rails](http://nithinbekal.com/posts/rails-presenters/)
+
+[![Build Status](https://api.travis-ci.org/emn178/presenters.png)](https://travis-ci.org/emn178/presenters)
 
 ## Installation
 
@@ -18,11 +20,17 @@ Or install it yourself as:
 
     gem install presenters
 
+For rails, add this config in `config/application.rb`
+```ruby
+config.autoload_paths += %W(#{config.root}/presenters)
+```
+And you can put presenters in `app/presenters`
+
 ## Usage
 
 ### Create presenter class
 Assume you have a class named Post, you can create PostPresenter.
-```Ruby
+```ruby
 class PostPresenter < Presenter
   def title
     super || 'No Title'
@@ -30,15 +38,16 @@ class PostPresenter < Presenter
 end
 ```
 And you can wrap object like this:
-```Ruby
+```ruby
 post = Post.new :title => nil, :content => "My Content"
 presenter = PostPresenter.new post
 presenter.title # "No Title"
 # delegate to Post
 presenter.content # "My Content"
 ```
-You can use `present` and `present_each` method to wrap objects. It will find presenter class in the same name. (Eq: Post => PostPresenter)
-```Ruby
+### Helpers
+You can use `present` and `present_each` method to wrap objects. It will find presenter class in the prefix. (eg. Post => PostPresenter)
+```ruby
 present(@post) do |post|
   # do something...
 end
@@ -46,9 +55,9 @@ end
 present_each(@posts) do |post|
   # do something...
 end
-```Ruby
+```
 You can specify presenter, too.
-```Ruby
+```ruby
 present(@post, CustomPresenter) do |post|
   # do something...
 end
@@ -56,9 +65,40 @@ end
 present_each(@posts, CustomPresenter) do |post|
   # do something...
 end
-```Ruby
+```
+You can use presenters to convert object array to presenters array
+```ruby
+presenters(@posts).each_with_index do |post, index|
+  # do something...
+end
+```
 You can use the helper in the view in rails application.
 
+### Use Presenters in Presenter
+If you want to use other presenters in the presenter. You can use following methods:
+```ruby
+class UserPresenter < Presenter
+  def name
+    super || "Anonymous"
+  end
+end
+
+class PostPresenter < Presenter
+  def poster
+    # You want to use UserPresenter and get its name here.
+  end
+end
+
+# method 1
+present(user).name
+
+# method 2
+UserPresenter.new(user).name
+
+# method 3, if user is a ActiveRecord::Base
+user.presenter.name
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/presenters/helper.rb

@@ -1,10 +1,7 @@
 module Presenters
   module Helper
-    def present(instance, class_type = nil, &block)
-      class_type = class_type || Object.const_get("#{instance.class}Presenter")
-      presenter = class_type.new(instance)
-      yield(presenter) if block_given?
-      return presenter
+    def present(*args, &block)
+      Helper.present(*args, &block)
     end
 
     def present_each(instances, class_type = nil, &block)
@@ -12,5 +9,18 @@ module Presenters
         present(instance, class_type, &block)
       end
     end
+
+    def presenters(instances, class_type = nil)
+      instances.map do |instance|
+        present(instance)
+      end
+    end
+
+    def self.present(instance, class_type = nil, &block)
+      class_type = class_type || Object.const_get("#{instance.class}Presenter")
+      presenter = class_type.new(instance)
+      yield(presenter) if block_given?
+      return presenter
+    end
   end
 end

data/lib/presenters/model.rb

@@ -0,0 +1,8 @@
+module Presenters
+  module Model
+    def presenter
+      @presenter = Helper.present(self) if @presenter.nil?
+      @presenter
+    end
+  end
+end

data/lib/presenters/presenter.rb

@@ -1,4 +1,5 @@
 module Presenters
   class Presenter < SimpleDelegator
+    include Helper
   end
 end

data/lib/presenters/version.rb

@@ -1,3 +1,3 @@
 module Presenters
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/presenters.rb

@@ -1,6 +1,7 @@
 require "presenters/version"
-require "presenters/presenter"
 require "presenters/helper"
+require "presenters/model"
+require "presenters/presenter"
 
 module Presenters
   if defined?(::Rails::Engine)
@@ -11,6 +12,7 @@ module Presenters
         end
         Presenter.include ActionView::Helpers
         Presenter.include Rails.application.routes.url_helpers
+        ActiveRecord::Base.include Presenters::Model
       end
     end
   end

data/presenters.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Chen Yi-Cyuan"]
   spec.email         = ["emn178@gmail.com"]
 
-  spec.summary       = %q{A simple presenter pattern for ruby. It also can work in rails.}
-  spec.description   = %q{A simple presenter pattern for ruby. It also can work in rails.}
+  spec.summary       = %q{A simple presenter pattern for ruby. It can work in rails.}
+  spec.description   = %q{A simple presenter pattern for ruby. It can work in rails.}
   spec.homepage      = "https://github.com/emn178/presenters"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: presenters
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chen Yi-Cyuan
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A simple presenter pattern for ruby. It also can work in rails.
+description: A simple presenter pattern for ruby. It can work in rails.
 email:
 - emn178@gmail.com
 executables: []
@@ -76,12 +76,14 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/presenters.rb
 - lib/presenters/helper.rb
+- lib/presenters/model.rb
 - lib/presenters/presenter.rb
 - lib/presenters/version.rb
 - presenters.gemspec
@@ -108,5 +110,5 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: A simple presenter pattern for ruby. It also can work in rails.
+summary: A simple presenter pattern for ruby. It can work in rails.
 test_files: []