pres 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 56f81f8f4780bf77547fd95e4a887096ce5cf826
-  data.tar.gz: 7a38a3d761ad8614b04fa208911bf84e64b9a507
+SHA256:
+  metadata.gz: 1c299e16a162674ba826b413ab48bbdc0850af84d8958eb6a3e9f440c7cd4e82
+  data.tar.gz: 40e724787b143aa0ede13a41f2d84e6e2b2297584fb7ab36c2b448826609863d
 SHA512:
-  metadata.gz: b6f6ab94d54b811eaadaffcef217552109a1431692b82f435c43542fc54e21688c2e5aa039f4bff8422dce76e9937b64538094d28afb7c4aeb233d1f9e9b0452
-  data.tar.gz: a11d34d228f17a2786c041f7243acd0ddf30ceec3dc567555a687ce084fd3477146fb8edaa83a45806b3d6091d944aebe9345b40556f42370f85e83d656515cb
+  metadata.gz: '039604e02f82018fff8345492080896501efb7c8b05dab17ed2dfcf7babf9a4873687fac56986ac3b53ed76d4bc048ad4037be350bca4b5985d76c78ad3d0b5c'
+  data.tar.gz: e53da96e07d916ae51ddb499d171ee566f1df5e300ae61d1cc4e2c4e061a6b7614bb546f42d2d8c39a2e0e40f084bff72bc7dbc1fa73a1877fd5fc9bfcfb7371

data/README.md

@@ -5,19 +5,28 @@
 
 ## What?
 
-A Presenter is a rendering class. Presenters are an alternative to an unorganized mass of helper 
-methods in your Rails application. The `pres` gem is a lightweight presenter solution.
+A Presenter is a rendering class. The `pres` gem is a lightweight presenter
+solution with no runtime gem dependencies.
+
+`Pres` provides the following:
+
+1. `Pres::Presenter` is a presenter base class.
+1. `present` is a convenience method to create presenters.
+1. `Pres::ViewDelegation` is a delegation module, included in the `Presenter` base class.
 
 ## How and Why?
 
+Presenters are an alternative to an unorganized mass of helper
+methods in your ruby application.
+
 Rails' `ViewContext` contains convenience methods for views, such as `link_to`,
 `url_for`, `truncate`, `number_to_currency`, etc. It's the thing that makes
 Rails views nice to work with.
 
 Other presenter libraries mix in all the methods from the Rails `ViewContext` to
-make it easy to call those methods in the Presenter class. `pres` instead injects 
-the `ViewContext` as a dependency into the Presenter class, and uses `method_missing` 
-to delegate to `ViewContext` methods. `pres` produces small classes that contain and 
+make it easy to call those methods in the Presenter class. `pres` instead injects
+the `ViewContext` as a dependency into the Presenter class, and uses `method_missing`
+to delegate to `ViewContext` methods. `pres` produces small classes that contain and
 delegate to an existing object that handles server-side rendering.
 
 ## Install
@@ -28,6 +37,8 @@ Add it to your Gemfile:
 gem "pres"
 ```
 
+## Setup with Rails
+
 Include the `Pres::Presents` module:
 
 ```ruby
@@ -53,7 +64,7 @@ class DogePresenter < Pres::Presenter
   end
 
   def name_header
-    # object is the Doge
+    # object is the Doge used to initialize the presenter
     content_tag(:h1, object.name)  
   end
 
@@ -68,30 +79,24 @@ class DogePresenter < Pres::Presenter
 end
 ```
 
-Wrap your model object in your controller with `present`:
+Wrap your model object in a presenter in your controller with `present`:
 
 ```ruby
 class DogesController
   def show
+    @doge = present(Doge.find(params[:id]))
   end
-
-  private
-
-  helper_method \
-  def doge
-    @doge ||= present(Doge.find(params[:id]))
-  end  
 end
 ```
 
 Use the presenter object in `doges/show.haml.html`
 
 ```haml
-= doge.name_header
+= @doge.name_header
 .status
-  You are #{doge.signed_in_status}
+  You are #{@doge.signed_in_status}
 .links
-  .meme-link= doge.know_your_meme_link
+  .meme-link= @doge.know_your_meme_link
 ```
 
 #### Collections
@@ -104,25 +109,19 @@ class DogePresenter < Pres::Presenter
 end
 ```
 
-Wrap your model objects in your controller with `present`:
+Build an array of presenters in your controller with `present`:
 
 ```ruby
 class DogesController
   def index
+    @doges = present(Doge.all)
   end
-
-  private
-
-  helper_method \
-  def doges
-    @doges ||= present(Doge.all)
-  end  
 end
 ```
 
 Use the presenter objects in `doges/index.haml.html`
 
-This renders "doges/_doge.html.haml" for each item, as usual:
+This renders "doges/_doge.html.haml" for each item, following rails' usual conventions:
 
 ```haml
 = render @doges
@@ -131,32 +130,34 @@ This renders "doges/_doge.html.haml" for each item, as usual:
 Or use each:
 
 ```haml
-- doges.each do |doge|
+- @doges.each do |doge|
   = doge.name_header
 ```
 
 #### Present with options
 
-Pass additional options to a Presenter as a hash:
+Pass additional options to a Presenter as a hash. The presenter class exposes the
+`options` hash as a method:
 
 ```ruby
-class UserPresenter < Pres::Presenter
-  def initialize(object, view_context, cool: false)
-    super
-    @cool = cool
-  end  
-end
-
 user = User.new
-present(user, cool: true)
+
+# These two lines are the same:
+# 1. explicit
+presenter = UserPresenter.new(user, view_context, something: 123)
+# 2. using #present
+presenter = present(user, something: 123)
 => #<UserPresenter object: #<User> ...>
+
+presenter.options[:something]
+=> 123
 ```
 
-#### Render a custom Presenter
+#### Use a custom presenter class
 
 By default, a presenter class corresponding to the model class name is
 constructed in `present`. For example, if you present a `User`, a `UserPresenter`
-class is constructed. An error is raised if the presenter class does not exist. 
+class is constructed. An error is raised if the presenter class does not exist.
 To specify a different class, use the `presenter:` key.
 
 ```ruby
@@ -178,10 +179,10 @@ present(User.new)
 # => #<MyPresenter object: #<User> ...>
 ```
 
-#### Creating presenters in views
+#### Create presenters in views
 
-If you would like to create a presenter in your view code, make the `present` method 
-visible to your views.
+You can create a presenter in your view code. First make the `present` method
+visible to your views by declaring it a `helper_method`:
 
 ```ruby
 class ApplicationController
@@ -190,29 +191,13 @@ class ApplicationController
 end
 ```
 
-This makes it easy to create presenters inline in a view:
+Then you can create presenters inline in a view:
 
 ```haml
 - present(@doge) do |doge|
   = doge.name_header
 ```
 
-### Presenters are objects
-
-You can mix in common methods.
-
-```ruby
-module Shared
-  def truncated_name(length: 40)
-    truncate object.name, length: length
-  end
-end
-
-class DogePresenter < Pres::Presenter
-  include Shared
-end
-```
-
 You can override methods as usual:
 
 ```ruby
@@ -220,7 +205,7 @@ class DogePresenter < Pres::Presenter
   include Shared
 
   def truncated_name(length: 60)
-    # whoa this one is different!
+    # override
     super(length: length)
   end
 end
@@ -228,8 +213,7 @@ end
 
 #### Presenters can create other presenters
 
-Ideally, you can have one top-level presenter exposed per controller,
-which can then wrap child objects in presenters of their own.
+Presenters can wrap child objects in presenters of their own.
 
 ```ruby
 class DogePresenter < Pres::Presenter

data/lib/pres.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pres/version"
 require "pres/view_delegation"
 require "pres/presents"

data/lib/pres/presenter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Base Presenter class
 # Construct with object, view_context, and optional options
 module Pres

data/lib/pres/presents.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pres
   module Presents
     private
@@ -53,12 +55,20 @@ module Pres
       if object.respond_to?(:to_ary)
         object.map { |item| present(item, presenter: presenter, **args) }
       else
-        presenter ||= Presenter if object.nil?
-        presenter ||= object.respond_to?(:presenter_class) && object.presenter_class
-        presenter ||= Object.const_get("#{object.class.name}Presenter")
+        presenter ||= presenter_klass(object)
         wrapper = presenter.new(object, view_context, **args)
         block_given? ? yield(wrapper) : wrapper
       end
     end
+
+    def presenter_klass(object)
+      if object.nil?
+        Presenter
+      elsif object.respond_to?(:presenter_class)
+        object.presenter_class
+      else
+        Object.const_get("#{object.class.name}Presenter")
+      end
+    end
   end
 end

data/lib/pres/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pres
-  VERSION = "1.4.1"
+  VERSION = "1.5.0"
 end

data/lib/pres/view_delegation.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 module Pres
   module ViewDelegation
     def view_context
       @view_context
     end
 
-    # Send missing symbols to view_context first
-    def method_missing(symbol, *args, &block)
-      if view_context.respond_to?(symbol, true)
-        view_context.send(symbol, *args, &block)
+    # Send missing methods to view_context first
+    def method_missing(method, *args, &block)
+      if view_context.respond_to?(method, true)
+        view_context.send(method, *args, &block)
       else
         super
       end
     end
 
-    def respond_to_missing?(symbol, _ = false)
-      view_context.respond_to?(symbol, true) || super
+    def respond_to_missing?(method, _ = false)
+      view_context.respond_to?(method, true) || super
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pres
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Tee Parham
@@ -9,22 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-12 00:00:00.000000000 Z
+date: 2018-12-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +66,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -88,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: A Simple Rails Presenter