meta_presenter 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2520562652ee736cdd7cca496683fb093e0b8f6ef5935429504b819feb61991f
-  data.tar.gz: ab969767427ce4242ba5f70b144e277522d81c857b9393596dec839482c2aae9
+  metadata.gz: 8304ed69b8fcec17f9f190714e38d3d84e5dfc0747889303120c4d4eb77c8630
+  data.tar.gz: 2005c166ac8139c6e567c5e19c56ab5d38febc3a596e5a0f30edfd09074dcafb
 SHA512:
-  metadata.gz: effeb19171c360f4bb06dcbef0779d60ef321c068a26544a941c33907b4875e5277eceb15dca065608ac4124aeafe00542dd1836ee6b10f3a22cfcb5c07a0d8d
-  data.tar.gz: b4c3959db506ec00f8579e791dd0bf0f76d2955837f2524a256941bc4d2cd6422ca8338464f71a251f21e6f955518047970e9ea57d4cda10451faf16b046df52
+  metadata.gz: e6184fa5b49ecfba29fcc2825bd4dfcf82f83d4dcad33311bf9b9586cadeb2dfb1475796e1ca21db0bbf04a57dd8093454b88c3c91f41186c9fdfa9119226176
+  data.tar.gz: 4ff04576a64dd7c50670b74b5bbd2aa27c8a198000c5b3d2fd325b4806e0026bc2de595884818aa975d002c7537c9b91df9680134585dbdafe38374a29f54b44

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    meta_presenter (0.1.5)
+    meta_presenter (0.2.0)
       actionmailer (>= 4.0)
       actionpack (>= 4.0)
 

data/README.md

@@ -2,7 +2,7 @@
 
 [![logo](https://user-images.githubusercontent.com/28652/50427588-2289cf80-087a-11e9-82e1-ae212adf0d07.png)](https://metapresenter.com)
 
-MetaPresenter is a Ruby gem that gives you access to the powerful presenter pattern in your Rails controllers. For each controller/action pair you get a presenter class in `app/presenters` that you can use in your views with with `presenter.method_name`. This helps you decompose your helper logic into tight, easily testable classes. There's even a DSL for method delegation on objects to reduce boilerplate.
+MetaPresenter is a Ruby gem for writing highly focused and testable view Rails presenter classes. For each controller/action pair you get a presenter class in `app/presenters` that you can use in your views with with `presenter.method_name`. This helps you decompose your helper logic into tight, easily testable classes. There's even a DSL for method delegation on objects to reduce boilerplate.
 
 ![overlay-shape-clean-sm](https://user-images.githubusercontent.com/28652/50854229-828c7580-1352-11e9-824b-a78c9a2404fb.png)
 
@@ -36,7 +36,7 @@ end
 
 ## Example
 
-Say you have a PagesController with an action for home and logs. Underneath `app/presenters` you can add a class for each action. In this example we'll also create an application and base presenter we'll inherit from to re-use code in the per-action presenters.
+Say you have a PagesController with `#home` and `#logs` actions. Underneath app/presenters you can add a presenter class for each action (Pages::HomePresenter and Pages::LogsPresenter). We'll also create an ApplicationPresenter superclass for methods that can be used in any action throughout the app.
 
 ```
 app/
@@ -113,7 +113,7 @@ class ApplicationPresenter < MetaPresenter::BasePresenter
 end
 ```
 
-app/presenters/pages_presenter.rb:
+app/presenters/pages_presenter.rb
 
 ```ruby
 class PagesPresenter < ApplicationPresenter
@@ -121,8 +121,8 @@ class PagesPresenter < ApplicationPresenter
   # all actions on PagesController
   def nav_items
     [
-        {name: "Home", path: home_path},
-        {name: "Logs", path: logs_path}
+      {name: "Home", path: home_path},
+      {name: "Logs", path: logs_path}
     ]
   end
 end
@@ -135,7 +135,7 @@ class Pages::HomePresenter < PagesPresenter
   # presenter.email, presenter.id or any other
   # method not already defined will delegate to
   # the current_user
-  delegate_all_to :current_user
+  delegate_all_to = :current_user
 
   # presenter.greeting in views
   def greeting
@@ -144,12 +144,12 @@ class Pages::HomePresenter < PagesPresenter
 end
 ```
 
-app/views/pages/home.html.haml
+app/views/pages/home.html.erb
 
-```Haml
-%h1 Home
-%p #{greeting}
-%p Last login #{distance_of_time_in_words_to_now(last_login_at)}
+```Erb
+<h1>Home</h1>
+<p><%= presenter.greeting %></p>
+<p>Last login <%= distance_of_time_in_words_to_now(presenter.last_login_at) %></p>
 ```
 
 app/presenters/pages/logs_presenter.rb
@@ -193,7 +193,7 @@ end
 
 ## Requirements
 
-MetaPresenter supports Ruby >= 2.1 and ActionPack >= 4.0. If you'd like to help adding support for older versions please submit a pull request with passing specs.
+MetaPresenter supports Ruby >= 2.1 and ActionPack/ActionMailer >= 4.0. If you'd like to help adding support for older versions please submit a pull request with passing specs.
 
 ## Links
 
@@ -207,6 +207,8 @@ To run the specs for the currently running Ruby version, run `bundle install` an
 Make sure the specs pass, bump the version number in meta_presenter.gemspec, build the gem with `gem build meta_presenter.gemspec`. Then commit changes and tag the commit with the current release number with `git tag -a "vVersionNumberHere" -m "vVersionNumberHere"`. Push the commit with `git push`, then push the tags with `git push origin --tags`. Finally, push the gem with `gem push meta_presenter-version-number-here.gem`.
 
 ## TODO
+* create an example app and link to the repo for it in this README
+* proofread the README instructions to make sure everything is correct
 * optional `rake meta_presenter:install` that generates the scaffolding for you. Or, you can manually create the files you want.
 * add support for layout-level presenters
 * add Rails 6 support once it comes out (hopefully just have to add a gemfiles/actionpack6.gemfile and it will run with the Appraisal suite)

data/lib/meta_presenter/base/delegate_all_to.rb

@@ -12,7 +12,7 @@ module MetaPresenter
         # all incoming methods send to the presenter that
         # we not already handled by the presenter otherwise
         # (such as explicitly defining the method)
-        class_attribute :delegate_all_to
+        class_attribute :delegate_all_to, instance_reader: false, instance_writer: false
 
         include InstanceMethods
       end

data/lib/meta_presenter/helpers.rb

@@ -23,21 +23,12 @@ module MetaPresenter
       helper_method :presenter
     end
 
-    class PresenterClassNotFoundError < NameError
-      def initialize(controller, action_name)
-        super("No presenter class and method found for #{controller.class.name}##{action_name} (Are you rendering another action's template? If so then move your presenter method to a base presenter class for the controller that both action presenters inherit from)")
-      end
-    end
-
     private
       # Initialize presenter with the current controller
       def presenter
         @presenter ||= begin
           controller = self
           klass = MetaPresenter::Builder.new(controller, action_name).presenter_class
-          if klass.nil?
-            raise PresenterClassNotFoundError.new(controller, action_name)
-          end
           klass.new(controller)
         end
       end

data/meta_presenter.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name          = 'meta_presenter'
-  s.version       = '0.1.6'
+  s.version       = '0.2.0'
   s.platform      = Gem::Platform::RUBY
   s.authors       = ['szTheory']
   s.description   = %q{Presenter pattern in your Rails controllers and actions}

data/spec/meta_presenter/base/delegate_all_to_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe MetaPresenter::Base::DelegateAllTo do
+
+  describe '.delegate_all_to' do
+    subject { presenter.send(method_name) }
+
+    let(:controller_class) { PagesController }
+    let(:controller) { controller_class.new }
+    let(:action_name) { 'logs' }
+    let(:presenter) { controller.view_context.presenter }
+
+    let(:controller_all_instance_methods) { controller.class.instance_methods(true) }
+    let(:presenter_all_instance_methods) { presenter.class.instance_methods(true) }
+
+    let(:delegate_object) { controller.send(delegate_object_method_name) }
+    let(:delegate_object_method_name) { :character }
+
+    before do
+      # stub action name on the controller
+      allow(controller).to receive(:action_name).and_return(action_name)
+
+      controller.class.redefine_method(delegate_object_method_name) do
+        OpenStruct.new(name: "Mario")
+      end
+
+      # set up the controller to delegate all to an object
+      presenter.class.delegate_all_to = delegate_object_method_name
+    end
+
+    def define_method_on_presenter
+      presenter.class.redefine_method(method_name) do
+        "presenter retval"
+      end
+    end
+
+    def define_method_on_controller
+      controller.class.redefine_method(method_name) do
+        "controller retval"
+      end
+    end
+
+    context "delegating a method the object responds to" do
+      let(:method_name) { :name }
+
+      before do
+        expect(delegate_object).to respond_to(method_name)
+      end
+
+      context "and presenter doesn't define the method" do
+        before do
+          expect(presenter_all_instance_methods).to_not include(method_name)
+        end
+
+        context "and controller doesn't define the method" do
+          before do
+            expect(controller_all_instance_methods).to_not include(method_name)
+          end
+
+          it "calls the method on the delegated object" do
+            expect(subject).to eql(delegate_object.send(method_name))
+          end
+        end
+
+        context "but controller defines the method" do
+          before do
+            define_method_on_controller
+            expect(controller_all_instance_methods).to include(method_name)
+          end
+
+          it "still calls the method on the delegated object" do
+            expect(subject).to eql(delegate_object.send(method_name))
+          end
+        end
+      end
+
+      context "but presenter also defines the method" do
+        before do
+          define_method_on_presenter
+          expect(presenter_all_instance_methods).to include(method_name)
+        end
+
+        it "calls the presenter defined method" do
+          expect(subject).to eql("presenter retval")
+        end
+      end
+    end
+
+    context "delegating a method the object doesn't respond to" do
+      let(:method_name) { :age }
+
+      before do
+        expect(delegate_object).to_not respond_to(method_name)
+      end
+
+      context "and presenter doesn't define the method" do
+        before do
+          expect(presenter_all_instance_methods).to_not include(method_name)
+        end
+
+        it { expect { subject }.to raise_error(NoMethodError, "undefined method `#{method_name}' for #<Pages::LogsPresenter>") }
+      end
+
+      context "but presenter defines the method" do
+        before do
+          define_method_on_presenter
+          expect(presenter_all_instance_methods).to include(method_name)
+        end
+
+        it "calls the presenter defined method" do
+          expect(subject).to eql("presenter retval")
+        end
+      end
+    end
+  end
+end

data/spec/meta_presenter/base/delegate_to_controller_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe MetaPresenter::Base::DelegateToController do
+
+  describe 'delegating a method to controller' do
+    subject { presenter.send(method_name) }
+
+    let(:controller_class) { PagesController }
+    let(:controller) { controller_class.new }
+    let(:action_name) { 'logs' }
+    let(:presenter) { controller.view_context.presenter }
+
+    before do
+      allow(controller).to receive(:action_name).and_return(action_name)
+    end
+
+    let(:directly_defined_instance_methods) { controller.class.instance_methods(false) }
+    let(:inherited_instance_methods) { controller.class.instance_methods(true) }
+
+    context "method exists on the controller" do
+      before do
+        expect(controller).to respond_to(method_name)
+      end
+
+      context "on the same class" do
+        let(:method_name) { :a_method_defined_on_pages_controller }
+
+        before do
+          expect(directly_defined_instance_methods).to include(method_name)
+        end
+
+        it { is_expected.to eql("pages controller method return value") }
+      end
+
+      context "on a superclass" do
+        let(:method_name) { :a_method_defined_on_application_controller }
+
+        before do
+          expect(directly_defined_instance_methods).to_not include(method_name)
+          expect(inherited_instance_methods).to include(method_name)
+        end
+
+        it { is_expected.to eql("application controller method return value") }
+      end
+    end
+
+    context "method doesn't exist on the controller" do
+      let(:method_name) { :a_method_not_defined_on_controller }
+
+      before do
+        expect(directly_defined_instance_methods).to_not include(method_name)
+        expect(inherited_instance_methods).to_not include(method_name)
+      end
+
+      it { expect { subject }.to raise_error(NoMethodError) }
+    end
+  end
+end

data/spec/meta_presenter/base_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe MetaPresenter::Base do
+
+  describe '#inspect' do
+    subject { presenter.inspect }
+
+    let(:controller_class) { ApplicationController }
+    let(:controller) { controller_class.new }
+    let(:action_name) { 'test' }
+    let(:presenter) { controller.view_context.presenter }
+    
+    before do
+      allow(controller).to receive(:action_name).and_return(action_name)
+    end
+
+    it { is_expected.to eql('#<ApplicationPresenter>') }
+  end
+end

data/spec/meta_presenter/builder_spec.rb

@@ -1,10 +1,9 @@
 require 'spec_helper'
-# require 'ostruct'
 
 describe MetaPresenter::Builder do
   let(:controller_class) { ApplicationController }
   let(:controller) { controller_class.send(:new) }
-  let(:action_name) { 'logs' }
+  let(:action_name) { 'test' }
   let(:object) { described_class.new(controller, action_name) }
 
   def controller_ancestors

data/spec/support/app/controllers/application_controller.rb

@@ -2,4 +2,8 @@ require 'action_controller'
 
 class ApplicationController < ActionController::Base
   include MetaPresenter::Helpers
+
+  def a_method_defined_on_application_controller
+    "application controller method return value"
+  end
 end

data/spec/support/app/controllers/pages_controller.rb

@@ -1,2 +1,6 @@
 class PagesController < ApplicationController
+
+  def a_method_defined_on_pages_controller
+    "pages controller method return value"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meta_presenter
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - szTheory
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
+date: 2019-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -163,6 +163,9 @@ files:
 - lib/meta_presenter/helpers.rb
 - logo.png
 - meta_presenter.gemspec
+- spec/meta_presenter/base/delegate_all_to_spec.rb
+- spec/meta_presenter/base/delegate_to_controller_spec.rb
+- spec/meta_presenter/base_spec.rb
 - spec/meta_presenter/builder_spec.rb
 - spec/meta_presenter/helpers_spec.rb
 - spec/spec_helper.rb
@@ -209,6 +212,9 @@ summary: MetaPresenter is a Ruby gem that gives you access to the powerful prese
   This helps you decompose your helper logic into small, tight, classes that are easily
   testable. There's even a DSL for method delegation on objects to reduce boilerplate.
 test_files:
+- spec/meta_presenter/base/delegate_all_to_spec.rb
+- spec/meta_presenter/base/delegate_to_controller_spec.rb
+- spec/meta_presenter/base_spec.rb
 - spec/meta_presenter/builder_spec.rb
 - spec/meta_presenter/helpers_spec.rb
 - spec/spec_helper.rb