pres 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 245241e4780fa67fb2d4bfa415969da3469475f6
-  data.tar.gz: 17c852515fbd44b8d5c0fbce156cdab402b2edf5
+  metadata.gz: 38f3df21d4a8eec7d64db8e94ea4b032811c5af4
+  data.tar.gz: 3bb195b7290f4c41b96ac063e1ed2e49344d61cb
 SHA512:
-  metadata.gz: deda6b5cd350392c43eccf280bbb814494752622e027e630cb4c9189e986acebf9c840abe0620b4c41bc58a32e0986963728fb02ad41aaa8db8b7ce5519338f0
-  data.tar.gz: 1a1da379bfeea98e5d7912a116c46f96c995e67e0e918b12bf65f7e5f22e883e41960ab08a492178f571cbe24790b5e01233a9d83ee923a2501eb31b8c8064e9
+  metadata.gz: ed39b6d60be0ac37a431a4b5d0921b6ed7bd11e3ba1d8f95c2e2a157d3d889ac08e60c6d8ca9807f1f1fe2b2e495ebecf20eba07cdfa31fce07bd8210d9dc80c
+  data.tar.gz: d007458b744e863ea1ab9db627236032930121ec89cf3d2686516748d7b0c43932ebbff90c3d14b11913db13a9c4799e4f0bc8eb2486527dc15b6d9e408bab83

data/README.md

@@ -20,14 +20,9 @@ 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 
+So `pres` produces small classes that contain and delegate to an existing object
 that handles server-side rendering.
 
-## Presenter vs. Decorator
-
-Decorators add methods to a model. `pres` encourages you to whitelist model methods 
-via delegation.
-
 ## Install
 
 Add it to your Gemfile:
@@ -36,11 +31,11 @@ Add it to your Gemfile:
 gem "pres"
 ```
 
-Include the `Presents` module:
+Include the `Pres::Presents` module:
 
 ```ruby
 class ApplicationController
-  include Presents
+  include Pres::Presents
 end
 ```
 
@@ -50,12 +45,14 @@ Add `app/presenters` to your application's autoload paths in `application.rb`:
 config.autoload_paths += %W( #{ config.root }/app/presenters )
 ```
 
-#### Example Usage
+### Usage
+
+The quickest way to get started is to use the `Pres::Presenter` base class.
 
 Create a presenter class in `app/presenters`:
 
 ```ruby
-class DogePresenter < Presenter
+class DogePresenter < Pres::Presenter
   # explicitly delegate methods to the model
   delegate :name, to: :object
 
@@ -88,9 +85,9 @@ class DogesController
   end
 
   private
-  
+
   helper_method :doge
-  
+
   def doge
     @doge ||= present(Doge.find(params[:id]))
   end  
@@ -112,7 +109,7 @@ Use the presenter object in `doges/show.haml.html`
 Create a presenter class in `app/presenters`:
 
 ```ruby
-class DogePresenter < Presenter
+class DogePresenter < Pres::Presenter
   # same as above
 end
 ```
@@ -151,7 +148,7 @@ Or use each:
 
 #### Present with options
 
-Use keyword arguements (or an options hash) to pass additional options to a
+Use keyword arguments (or an options hash) to pass additional options to a
 Presenter:
 
 ```ruby
@@ -193,12 +190,12 @@ a presenter in your view code, make the `present` method visible to your views:
 
 ```ruby
 class ApplicationController
-  include Presents
+  include Pres::Presents
   helper_method :present
 end
 ```
 
-## More Goodness
+### More Goodness
 
 #### Presenters are objects
 
@@ -219,7 +216,7 @@ end
 You can override methods without resorting to convoluted method names:
 
 ```ruby
-class DogePresenter < Presenter
+class DogePresenter < Pres::Presenter
   include Shared
 
   def truncated_name(length: 60)
@@ -232,7 +229,7 @@ end
 #### Presenters can create other presenters
 
 ```ruby
-class DogePresenter < Presenter
+class DogePresenter < Pres::Presenter
   def cats
     present(object.cats)
   end  
@@ -243,6 +240,34 @@ end
 = render doge.cats
 ```
 
+### Using mixins instead of inheritance
+
+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).
+
+```ruby
+class DogePresenter < SimpleDelegator
+  include Pres::ViewDelegation
+
+  # you need to write your own initializer with SimpleDelegator
+  def initialize(object, view_context, options = {})
+    super
+    @view_context = view_context
+  end
+```
+
+```haml
+= doge.name
+```
+
+see [SimpleDelegator](http://ruby-doc.org/stdlib-2.3.0/libdoc/delegate/rdoc/SimpleDelegator.html)
+
+## Updating to version 1.0
+
+Modules and classes have been moved into the `Pres` namespace with version 1.0.
+Change your code references to `Pres::Presents` and `Pres::Presenter`.
+
 ## References
 
 * http://nithinbekal.com/posts/rails-presenters/

data/lib/pres/presenter.rb

@@ -1,22 +1,18 @@
 # Base Presenter class
 # Construct with object, view_context, and optional options
-class Presenter
-  attr_accessor :object, :options, :view_context
+module Pres
+  class Presenter
+    include Presents
+    include ViewDelegation
 
-  delegate :id, :to_partial_path, to: :object
+    attr_reader :object, :options
 
-  def initialize(object, view_context = nil, options = {})
-    self.object = object
-    self.view_context = view_context
-    self.options = options
-  end
-
-  # Send missing symbols to view_context
-  def method_missing(symbol, *args, &block)
-    view_context.send(symbol, *args, &block)
-  end
+    delegate :id, :to_partial_path, to: :object
 
-  def respond_to?(symbol, _ = false)
-    super || view_context.respond_to?(symbol, true)
+    def initialize(object, view_context = nil, options = {})
+      @object = object
+      @view_context = view_context
+      @options = options
+    end
   end
 end

data/lib/pres/presents.rb

@@ -1,35 +1,37 @@
-module Presents
-  private
+module Pres
+  module Presents
+    private
 
-  # Wrap an object or collection of objects with a presenter class.
-  #
-  # object    - a ruby class, or nil
-  # presenter - a Presenter class (optional)
-  #
-  # Examples
-  #
-  # user = User.new
-  # present(user, cool: true)
-  # => #<UserPresenter object: #<User> ...>
-  #
-  # user = User.new
-  # present(user, presenter: NiceUserPresenter, cool: true)
-  # => #<NiceUserPresenter object: #<User> ...>
-  #
-  # present([user])
-  # => [#<UserPresenter object: #<User> ...>]
-  #
-  # present(nil)
-  # => [#<Presenter object: nil ...>]
-  #
-  # Returns a new Presenter object or array of new Presenter objects
-  def present(object, presenter: nil, **args)
-    if object.respond_to?(:to_ary)
-      object.map { |item| present(item, presenter: presenter, **args) }
-    else
-      presenter ||= Presenter if object.nil?
-      presenter ||= Object.const_get("#{object.class.name}Presenter")
-      presenter.new(object, view_context, **args)
+    # Wrap an object or collection of objects with a presenter class.
+    #
+    # object    - a ruby class, or nil
+    # presenter - a Presenter class (optional)
+    #
+    # Examples
+    #
+    # user = User.new
+    # present(user, cool: true)
+    # => #<UserPresenter object: #<User> ...>
+    #
+    # user = User.new
+    # present(user, presenter: NiceUserPresenter, cool: true)
+    # => #<NiceUserPresenter object: #<User> ...>
+    #
+    # present([user])
+    # => [#<UserPresenter object: #<User> ...>]
+    #
+    # present(nil)
+    # => [#<Presenter object: nil ...>]
+    #
+    # Returns a new Presenter object or array of new Presenter objects
+    def present(object, presenter: nil, **args)
+      if object.respond_to?(:to_ary)
+        object.map { |item| present(item, presenter: presenter, **args) }
+      else
+        presenter ||= Presenter if object.nil?
+        presenter ||= Object.const_get("#{object.class.name}Presenter")
+        presenter.new(object, view_context, **args)
+      end
     end
   end
 end

data/lib/pres/version.rb

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

data/lib/pres/view_delegation.rb

@@ -0,0 +1,22 @@
+module Pres
+  module ViewDelegation
+    extend ActiveSupport::Concern
+
+    included do
+      attr_reader :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)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(symbol, _ = false)
+      view_context.respond_to?(symbol, true) || super
+    end
+  end
+end

data/lib/pres.rb

@@ -1,4 +1,6 @@
 require "active_support/core_ext/module/delegation"
+require "active_support/concern"
 require "pres/version"
-require "pres/presenter.rb"
-require "pres/presents.rb"
+require "pres/view_delegation"
+require "pres/presents"
+require "pres/presenter"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pres
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tee Parham
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-29 00:00:00.000000000 Z
+date: 2016-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -95,6 +95,7 @@ files:
 - lib/pres/presenter.rb
 - lib/pres/presents.rb
 - lib/pres/version.rb
+- lib/pres/view_delegation.rb
 homepage: https://github.com/neighborland/pres
 licenses:
 - MIT