presenter-rails 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ef5a2774a142651a244f17d207b850cf66d330b
-  data.tar.gz: b5c11f5d72a1f2a6845724ed1d6dbf9b1dea1b08
+  metadata.gz: a194fbba0a3a93907791c00696374006422a2e50
+  data.tar.gz: 850c833e23cee57c7f2b80a489d9840c79b7e88e
 SHA512:
-  metadata.gz: 11bf5be25532c008fe7affe61c637ce32a3a24ef5c41149bcc8880e8833d44d96a7cf6ebfd0e6fe7147e87689ea54845d7e38a75f25ff010055dc66090b4d37a
-  data.tar.gz: 1586385a58f932d1adf22d1d97fcc8d18e5ab949d225b193bd2923bd525ee5d09525dd51b3004be2f6a7e2c364e686e9a2b1ca7e20f7202d5ab4cda6a5c9711c
+  metadata.gz: 402427d29776317abd3578cb6b6877dcba195a5f6e51a62e3f58f99fc13b6c6aee157f9a0b9923a7db61ca00dbf9663cd0eb08341046792601551b6ba478e023
+  data.tar.gz: 26188dcddd364240037d724b95e4236bced96e1db189ad48494b2e9ed7fe38610187d612b60680db8047808c8574397fde421ecd5697407efd3a644f1ddf5905

data/README.md

@@ -51,55 +51,43 @@ After you run the install generator, run
 $ rails g presenter User
 ```
 
-to create a presenter file for one of your models. This will inherit from ApplicationPresenter, example shown below:
+this will create a presenter file for one of your models and will inherit from ApplicationPresenter, example shown below:
 ```ruby
 # app/presenters/user_presenter.rb
 class UserPresenter < ApplicationPresenter
 end
 ```
 
-Note: This automatically inherits a dynamic initialize method which sets an instance variable. You also inherit a helper method dynamically named after the model too.
-So you DO NOT have to define this yourself:
+Note: This provides you with a getter method: #subject.
+You can use #subject to acces the object you passed in when initializing the presenter. See below on how to do this.
 ```ruby
-def initialize(user)
-  @user = user
-end
-
-def user # Make sure you use the helper methods in your presenters in place of the instance variable.
-  @user
+# app/presenters/user_presenter.rb
+def full_name
+  subject.first_name + ' ' + subject.last_name
 end
 ```
 
-This also comes with with some error handling and some other code. So don't worry about this.
-I'm showing it just so you know what to expect if you try overwrite initialize or the helper without super. If you wish to extend it
-then remember to super or you will overwrite the default behaviour.
-
-If you do wish to extend the initialize method / change the instance variable name, call super first. Next, define an instance variable and assign it to the model object using the helper method (named after the model name).
+If you do wish to override the initialize method, call super as demonstrated below:
 ```ruby
-def initialize(user)
-  super
-  # assigning your variable to the user method gives it access to the inherited code.
-  @another_variable_name = self.user
-end
-```
+def initialize(user, middle_name)
+  @user = user
+  @user.update middle_name: middle_name
 
-This means you can define methods in your presenter using the instance variable named after your model.
-Let's imagine our User model has a first_name and last_name field and we want to define #name. All we would have to do is:
-```ruby
-class UserPresenter < ApplicationPresenter
-  def name
-    "#{user.first_name} #{user.last_name}"
-  end
+  # Make sure to pass your object to super.
+  super user
 end
 ```
 
-now you can initialize a presenter. There are 2 methods for this, either directly initialize the object as usual with:
+## Initializing the presenter
+Now you can initialize a presenter. There are 2 methods for this, either directly initialize the object as usual with:
 ```ruby
 @user = UserPresenter.new(user)
 ```
 or use our built in helper to accomplish the same thing:
 ```ruby
+# The present helper will work with a single model or a collection
 @user = present(user)
+@users = present(User.all)
 ```
 (More on this below)
 
@@ -114,7 +102,7 @@ end
 ```
 
 Now the user instance variable has access to all methods belonging to it's presenter and the model being passed in.
-This allows access to
+This allows access to:
 ```ruby
 @user.name
 # which returns first name and last name like 'Sam Sargent'
@@ -146,21 +134,5 @@ This allows access to
   @users = present(users)
 ```
 
-### #instance getter
-
-For each presenter you create, a helper method is defined to get the model object being passed in. This replaces the need to throw around
-the instance variable. It's also faster as it allows the method delegation to not have to parse naming and fetch instance variables every time the inherited #method_missing is called.
-
-shown using a User model as example
-```ruby
-# app/presenters/user_presenter.rb
-class UserPresenter < ApplicationPresenter
-  # this has the method #user defined automatically to access the user object being passed in to the presenter
-  def name
-    "#{user.first_name} {user.last_name}"
-  end
-end
-```
-
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/generators/presenter/templates/model_presenter.template

@@ -3,10 +3,8 @@ class <%= "#{model.singularize.camelcase}Presenter" %> < ApplicationPresenter
     # Don't worry about the initialize method, it's already handled for you.
 
     # You can now pass in an instance of <%= model.singularize.camelcase %> when you initialize this presenter
-    # and access it with the helper method
-    # #<%= model.singularize.underscore %>
-    # instead of an instance variable when writing your methods
+    # and access it with the helper method: subject
 
     # Write methods for this presenter in here using the helper method
   <%- end -%>
-end
+end

data/lib/presenter/base.rb

@@ -2,24 +2,20 @@ module Presenter
   class Base
     include Presenter::Naming
 
-    def initialize(model)
-      @model = model
-      generate_model_instance_getter
+    attr_reader :subject
+
+    def initialize(subject)
+      @subject = subject
     end
 
     protected
-    def generate_model_instance_getter
-      define_singleton_method model_object_name_from_presenter(@model) do
-        @model
-      end
-    end
 
     def method_missing(method, *args, &block)
-      @model.send(method, *args, &block)
+      subject.send(method, *args, &block)
     end
 
     def respond_to_missing?(method, include_all = false)
-      @model.respond_to?(method, include_all)
+      subject.respond_to?(method, include_all)
     end
   end
 end

data/lib/presenter/version.rb

@@ -1,3 +1,3 @@
 module Presenter
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: presenter-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Sam Sargent
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-30 00:00:00.000000000 Z
+date: 2017-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,8 +53,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Keep code neat and abstract view & presenter logic. Adding a simple separation
-  of concerns when creating your models with an easy API.
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Presenter design pattern for Rails.
 email:
 - samsarge@hotmail.co.uk
 - finnfrancis123@gmail.com
@@ -101,5 +114,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Easily implement the presenter design pattern in rails projects.
+summary: Presenter design pattern for Rails.
 test_files: []