presenter_rails 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7369b035085593e7c248402cfc1fba20a1dfb15a
-  data.tar.gz: 0e785985be1e307d9d88ee6159521fab37b6fdd2
+  metadata.gz: 07380e067bc7857407c563571ab083e00232e426
+  data.tar.gz: 4b783155f31ff25861d81b4cee5041ae8e40ef0a
 SHA512:
-  metadata.gz: 8750fc439086bce43b647378fab34d1f2205a149574f036a3333ab2f7084090710ca431744618d1492a9b56064df1d043b7fca7001192aa17208cefd1c7463ac
-  data.tar.gz: 51bd7a3ba559607f64f9667a07cc54da40415abb49b862d105e038cbf153f4f3790ae76f99b5c10bb729b4427a689a697cfb4811f365daa0dd6060f2d2ae356f
+  metadata.gz: bbb4331e7032230fffdd8d84e7ab8e7f62b14017439b3f3b67633f6636e987799c5bc5da8e4b8e1f913208a6fe20c83cd5da935daf91cb528eb4683c8c09f077
+  data.tar.gz: 3ac96ee5bf7174caa128c60ccb1c9d017026eda10beb4ac98f313b5ab073e7852af2d1f29c3ccbf94b7dfd651e2d180d7fc46ec429d451af658f819d579c39d1

data/README.md

@@ -1,38 +1,88 @@
-Singular Resource
+Presenter
 =====================
 
-Extracted from decent exposure, attempts to leave the useful parts, and just use `helper_method` to expose your view models.
+Presenter helps you expose view models to your views in a convenient way, while
+still allowing you to define methods with the same name inside your controllers.
 
-## DOES
-Allow you to find or initialize a simple resource, removing the boilerplate from CRUD actions.
+```ruby
+   # app/controllers/person_controller.rb
+   class PersonController < ApplicationController
 
+      present :person do
+        PersonPresenter.decorate(...)
+      end
+   end
+```
 
-## DOES NOT
-Expose the model in any way, scope the query to a collection method if defined, or deal with collections.
+```haml
+   / app/views/people/show.html.haml
+   .person
+     .person-name= person.name
+     .person-info= person.biography
+```
+If you don't provide a block for present, it will assume that you want to expose a `"#{name}_presenter"` method.
+```ruby
+   # app/controllers/person_controller.rb
+   class PersonController < ApplicationController
+      present :person, :people
 
+      private
 
-## Use
-It provides a private method that performs a query for the document when invoked, unless the id is not defined (`new`, `create`), in which case it returns an initialized model.
-```ruby
-   singular_resource :patient
+      def person_presenter
+        PersonPresenter.decorate(...)
+      end
+
+      def people_presenter
+        People.all
+      end
+   end
 ```
 
-#### Strategies
-Like `decent_exposure`, it's configurable, and provides different strategies.
-By default, it uses `StrongParametersStrategy`, which only assigns the attributes if a method name is provided via the `attributes` option.
+## Background
+Presenter attempts to simplify the exposure of variables to the views. It doesn't really care
+about what you are exposing, although it's specially useful to implement [two-step views](http://martinfowler.com/eaaCatalog/twoStepView.html) while using
+[draper](https://github.com/drapergem/draper) in combination with [resourcerer](https://github.com/ElMassimo/resourcerer).
 
-#### Options
-``` ruby
-  :optional => "True if shouldn't fail if document does not exist",
+### How it works
 
-  :model => "Class or name of the model class",
+When you provide a block, it defines a `"#{name}_presenter"` private method in your controller the same way you would do manually.
 
-  :finder_parameter => "Name of the parameter that has the document's id",
+After that, it creates helper methods for your views, each method calls its `"#{name}_presenter"` counterpart in the controller.
 
-  :attributes => "Name of the attributes method name if using strong parameters",
+#### Memoization
+Each presenter method is memoized, so the method is called only once and your views get the same instance every time.
+
+#### Corolary
+Since the helper methods defined are only available for the view, you can define methods with the same name in your controller :smiley:.
+
+License
+--------
+
+    Copyright (c) 2014 Máximo Mussini
+
+    MIT License
+
+    Permission is hereby granted, free of charge, to any person obtaining
+    a copy of this software and associated documentation files (the
+    "Software"), to deal in the Software without restriction, including
+    without limitation the rights to use, copy, modify, merge, publish,
+    distribute, sublicense, and/or sell copies of the Software, and to
+    permit persons to whom the Software is furnished to do so, subject to
+    the following conditions:
+
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-  :param_key => "Name of the parameter that has the document's attributes"
-```
 
-### Special Thanks
-Singular Resource is a subset of [decent_exposure](https://github.com/voxdolo/decent_exposure).
+Credits
+--------
+Presenter was crafted to use in combination with [resourcerer](https://github.com/ElMassimo/resourcerer) and
+[draper](https://github.com/drapergem/draper).

data/lib/presenter_rails/presenter.rb

@@ -1,7 +1,12 @@
+require 'pakiderm'
+
 module PresenterRails
   module Presenter
     extend ActiveSupport::Concern
-    include SimpleMemoizer
+
+    included do
+      extend Pakiderm
+    end
 
     module ClassMethods
 
@@ -11,7 +16,7 @@ module PresenterRails
         define_presenter_method!(presenter_methods, &block) if block_given?
 
         expose_presenter *methods
-        memoize *presenter_methods
+        memoize *presenter_methods, assignable: true
       end
 
       # Exposes a presenter method to the view for each provided name

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: presenter_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-05 00:00:00.000000000 Z
+date: 2014-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simple_memoizer
+  name: pakiderm
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Presenter helps you expose view models to your views with a declarative
@@ -56,17 +56,17 @@ licenses:
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -76,3 +76,4 @@ signing_key:
 specification_version: 4
 summary: ViewModels had a baby with helper_method
 test_files: []
+has_rdoc: