pres 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38f3df21d4a8eec7d64db8e94ea4b032811c5af4
-  data.tar.gz: 3bb195b7290f4c41b96ac063e1ed2e49344d61cb
+  metadata.gz: 6c26aeb59d5a25f1249d32e9b31c52dd40c55262
+  data.tar.gz: fe9fb9d51ac9010b57d95cff1c7f00e55d04752d
 SHA512:
-  metadata.gz: ed39b6d60be0ac37a431a4b5d0921b6ed7bd11e3ba1d8f95c2e2a157d3d889ac08e60c6d8ca9807f1f1fe2b2e495ebecf20eba07cdfa31fce07bd8210d9dc80c
-  data.tar.gz: d007458b744e863ea1ab9db627236032930121ec89cf3d2686516748d7b0c43932ebbff90c3d14b11913db13a9c4799e4f0bc8eb2486527dc15b6d9e408bab83
+  metadata.gz: e315003283e6fed583e5f8b7399a3640a99b9177a9da67c0eb9adf1e94cdee6d06821979cecb824fef5fc26288177eea5dfd4aa71e8885636ec92afb9769e6b0
+  data.tar.gz: d47003fd1650d6800cf0b1380b5cd48aeb48279a52f1cfe28bf7bf0e264db2b6b396a1268751b1b9ee58ae2d87053eb3e9cdcd30f92af11b13d780be209f685e

data/README.md

@@ -5,10 +5,8 @@
 
 ## What?
 
-A Presenter is a rendering class that wraps a model. 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. Presenters are an alternative to an unorganized mass of helper 
+methods in your Rails application. The `pres` gem is a lightweight presenter solution.
 
 ## How and Why?
 
@@ -17,11 +15,10 @@ Rails' `ViewContext` contains convenience methods for views, such as `link_to`,
 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. This causes method
-bloat. `pres` instead injects the `ViewContext` as a dependency into the
-Presenter class, and uses `method_missing` to delegate to `ViewContext` methods.
-So `pres` produces small classes that contain and delegate to an existing object
-that handles server-side rendering.
+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
 
@@ -104,7 +101,7 @@ Use the presenter object in `doges/show.haml.html`
   .meme-link= doge.know_your_meme_link
 ```
 
-#### Collection Example
+#### Collections
 
 Create a presenter class in `app/presenters`:
 
@@ -114,7 +111,7 @@ class DogePresenter < Pres::Presenter
 end
 ```
 
-Wrap your model object in your controller with `present`:
+Wrap your model objects in your controller with `present`:
 
 ```ruby
 class DogesController
@@ -148,11 +145,10 @@ Or use each:
 
 #### Present with options
 
-Use keyword arguments (or an options hash) to pass additional options to a
-Presenter:
+Pass additional options to a Presenter as a hash:
 
 ```ruby
-class UserPresenter
+class UserPresenter < Pres::Presenter
   def initialize(object, view_context, cool: false)
     super
     @cool = cool
@@ -167,25 +163,19 @@ present(user, cool: true)
 #### Render a custom Presenter
 
 By default, a presenter class corresponding to the model class name is
-constructed. To specify a different class, pass the `presenter:` key, followed
-by any additional arguments:
+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. 
+To specify a different class, use the `presenter:` key.
 
 ```ruby
 user = User.new
-present(user, presenter: NiceUserPresenter, cool: true)
-=> #<NiceUserPresenter object: #<User> ...>
-```
-
-#### Render a collection
-
-```ruby
-present(User.first(5))
-=> [#<UserPresenter object: #<User> ...>]
+present(user, presenter: UserEditPresenter, cool: true)
+=> #<UserEditPresenter object: #<User> ...>
 ```
 
 #### Creating presenters in views
 
-You should create presenters in your controllers. If you would like to create
+You should create presenters in your controllers or within other presenters. If you would like to create
 a presenter in your view code, make the `present` method visible to your views:
 
 ```ruby
@@ -195,9 +185,7 @@ class ApplicationController
 end
 ```
 
-### More Goodness
-
-#### Presenters are objects
+### Presenters are objects
 
 You can mix in common methods.
 
@@ -208,12 +196,12 @@ module Shared
   end
 end
 
-class DogePresenter < Presenter
+class DogePresenter < Pres::Presenter
   include Shared
 end
 ```
 
-You can override methods without resorting to convoluted method names:
+You can override methods as usual:
 
 ```ruby
 class DogePresenter < Pres::Presenter
@@ -228,6 +216,9 @@ end
 
 #### Presenters can create other presenters
 
+If you are awesome, you could have one top-level presenter exposed per controller,
+which can then wrap child objects in presenters of their own.
+
 ```ruby
 class DogePresenter < Pres::Presenter
   def cats
@@ -244,7 +235,11 @@ end
 
 If you don't want to inherit from `Pres::Presenter`, you can include
 `Pres::ViewDelegation` and implement your own initializer (so the `present` helper
-will work).
+will work). 
+
+This technique is useful if you would like to delegate all methods in a model
+by default, instead of whitelisting methods on the wrapped model explicitly.
+Delegating everything to the model by default is how the `draper` gem works, for example.
 
 ```ruby
 class DogePresenter < SimpleDelegator

data/lib/pres/version.rb

@@ -1,3 +1,3 @@
 module Pres
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pres
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tee Parham
@@ -9,20 +9,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2016-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '11.0'
 description: A Simple Rails Presenter base class and controller helper
 email:
 - tee@neighborland.com
@@ -116,9 +116,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: A Simple Rails Presenter
 test_files: []
-has_rdoc: