presenter_rails 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07380e067bc7857407c563571ab083e00232e426
-  data.tar.gz: 4b783155f31ff25861d81b4cee5041ae8e40ef0a
+  metadata.gz: ad881d965883dd21b21b96fca07691befd7aaa50
+  data.tar.gz: bbd8f56f09035195e9b469733f98188b281e8c37
 SHA512:
-  metadata.gz: bbb4331e7032230fffdd8d84e7ab8e7f62b14017439b3f3b67633f6636e987799c5bc5da8e4b8e1f913208a6fe20c83cd5da935daf91cb528eb4683c8c09f077
-  data.tar.gz: 3ac96ee5bf7174caa128c60ccb1c9d017026eda10beb4ac98f313b5ab073e7852af2d1f29c3ccbf94b7dfd651e2d180d7fc46ec429d451af658f819d579c39d1
+  metadata.gz: d0540e2d1c5e94a3aacb7ca87db48ec09f67c8c06bca8685e3f6bb501c49aec9e7c08b4599fa1a8882fe2c97f27b598f05a90ab25b29e4f46430c89c28d4a853
+  data.tar.gz: cb5fd596bc8178cc99362e555d0c3039b3448786279a702791d332fbf43be36f6517b4bcf1b5a7d3c6fa5b6719073904961b08ebbb60432de43286ce483df6fb

data/README.md

@@ -1,41 +1,47 @@
-Presenter
+Presenter [![Gem Version](https://badge.fury.io/rb/presenter_rails.svg)](http://badge.fury.io/rb/presenter_rails) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ElMassimo/presenter_rails/blob/master/LICENSE.txt)
 =====================
 
 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.
 
 ```ruby
-   # app/controllers/person_controller.rb
-   class PersonController < ApplicationController
+ # app/controllers/people_controller.rb
+ class PeopleController < ApplicationController
 
-      present :person do
-        PersonPresenter.decorate(...)
-      end
-   end
+    present(:person) {
+      PersonDecorator.decorate(person)
+    }
+
+    ...
+
+    def person
+      People.find(params[:id])
+    end
+ end
 ```
 
 ```haml
-   / app/views/people/show.html.haml
-   .person
-     .person-name= person.name
-     .person-info= person.biography
+ / 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.
+
+The method is also available in the controller, with a `_presenter` suffix:
 ```ruby
-   # app/controllers/person_controller.rb
-   class PersonController < ApplicationController
-      present :person, :people
+ # app/controllers/people_controller.rb
+ class PeopleController < ApplicationController
+
+    ...
 
-      private
+    def update
+      person.update(attrs)
+      redirect_to person_presenter.path, notice: "Successfully updated."
+    end
 
-      def person_presenter
-        PersonPresenter.decorate(...)
-      end
+    ...
 
-      def people_presenter
-        People.all
-      end
-   end
+ end
 ```
 
 ## Background
@@ -45,12 +51,12 @@ about what you are exposing, although it's specially useful to implement [two-st
 
 ### How it works
 
-When you provide a block, it defines a `"#{name}_presenter"` private method in your controller the same way you would do manually.
+When you provide a block, it defines a `"#{name}_presenter"` private method in your controller.
 
-After that, it creates helper methods for your views, each method calls its `"#{name}_presenter"` counterpart in the controller.
+After that, it creates a helper method for your views, which calls the `"#{name}_presenter"` counterpart in the controller.
 
 #### Memoization
-Each presenter method is memoized, so the method is called only once and your views get the same instance every time.
+Each presenter method is memoized, so the method is called only once and your views get the same instance every time. The block is evaluated only if the method is called.
 
 #### Corolary
 Since the helper methods defined are only available for the view, you can define methods with the same name in your controller :smiley:.

data/lib/presenter_rails.rb

@@ -1,5 +1,24 @@
-require 'presenter_rails/presenter'
+require "presenter_rails/version"
+require "active_support/all"
 
-ActiveSupport.on_load(:action_controller) do
-  include PresenterRails::Presenter
+module PresenterRails
+  autoload :Controller, "presenter_rails/controller"
+
+  # Internal: Name of the presenter method as defined in the controller.
+  def self.method_name_for(name)
+    "#{ name }_presenter"
+  end
+
+  # Internal: Name of the instance variable used to memoize a presenter method.
+  def self.ivar_for(name)
+    "@_presenter_#{ name.to_s.gsub("?", "_query").gsub("!", "_bang") }"
+  end
+
+  ActiveSupport.on_load :action_controller do
+    extend Controller
+  end
+
+  ActiveSupport.on_load :action_mailer do
+    extend Controller
+  end
 end

data/lib/presenter_rails/controller.rb

@@ -0,0 +1,26 @@
+module PresenterRails
+  module Controller
+    # Public: Defines a method and makes it available to the view context
+    # under the specified name as a memoized variable.
+    #
+    # name  - The name of the method as called from the view context.
+    # block - Executed once if (and only if) the method is called.
+    #
+    # Returns nothing.
+    def present(name, &block)
+      presenter_method = PresenterRails.method_name_for(name)
+      ivar = PresenterRails.ivar_for(name)
+
+      private define_method(presenter_method) {
+        unless instance_variable_defined?(ivar)
+          instance_variable_set(ivar, instance_exec(&block))
+        end
+        instance_variable_get(ivar)
+      }
+
+      helper Module.new {
+        define_method(name) { controller.send(presenter_method) }
+      }
+    end
+  end
+end

data/lib/presenter_rails/version.rb

@@ -0,0 +1,3 @@
+module PresenterRails
+  VERSION = "2.0.0"
+end

data/spec/features/birds_controller_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+require "support/rails_app"
+require "rspec/rails"
+
+RSpec.describe BirdsController, type: :controller do
+  Given(:bird) { double(:bird) }
+
+  context "present works well with the view context" do
+    Given {
+      class BirdsController
+        present(:bird) { bird }
+        present(:bird?) { bird_presenter.present? }
+      end
+
+      expect_any_instance_of(BirdsController).to receive(:bird).once.and_return(bird)
+    }
+    When { get :index }
+    Then { controller.view_context.bird == bird }
+    And  { controller.view_context.bird  == controller.send(:bird_presenter) }
+    And  { controller.view_context.bird? == true }
+  end
+end

data/spec/features/birds_mailer_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+require "support/rails_app"
+require "rspec/rails"
+require "action_mailer"
+
+class BirdsMailer < ActionMailer::Base
+  present(:bird) { OpenStruct.new(name: @name) }
+
+  def hello_bird(name:)
+    @name = name
+    mail { |format| format.text { render plain: bird_presenter.name } }
+  end
+end
+
+RSpec.describe BirdsMailer, type: :mailer do
+  Given(:name) { "pidgeon" }
+
+  context "with keyword arguments" do
+    When(:mail) { BirdsMailer.hello_bird(name: name) }
+    Then { mail.body.to_s == name }
+  end
+end

data/spec/presenter_rails/controller_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+require "rspec/rails"
+
+RSpec.describe PresenterRails::Controller do
+  class Thing; end
+  class DifferentThing; end
+
+  class ViewContext
+    attr_reader :controller
+
+    def initialize(controller)
+      @controller = controller
+    end
+  end
+
+  class BaseController
+    extend PresenterRails::Controller
+
+    def self.helper(helper_module)
+      @helper_modules ||= []
+      @helper_modules << helper_module
+    end
+
+    def self.helper_modules
+      @helper_modules
+    end
+
+    def view_context
+      self.class.helper_modules.inject(ViewContext.new(self)) { |view_context, helper_module|
+        view_context.extend(helper_module)
+      }
+    end
+  end
+
+  Given(:controller_class) { Class.new(BaseController) }
+  Given(:controller) { controller_class.new }
+  Given(:view_context) { controller.view_context }
+  Given(:helper_modules) { controller_class.helper_modules }
+
+  delegate :present, to: :controller_class
+
+  context "present" do
+    Given {
+      expect(controller).to receive(:thing).once.and_return(Thing.new)
+      expect(controller).to receive(:different_thing).once.and_return(DifferentThing.new)
+      expect(controller).to receive(:empty).once.and_return(nil)
+    }
+
+    Given {
+      present(:thing) { thing }
+      present(:another_thing) { different_thing }
+      present(:empty?) { empty }
+    }
+
+    Then { controller.send(:thing_presenter).is_a?(Thing) }
+    And  { controller.send(:another_thing_presenter).is_a?(DifferentThing) }
+    And  { controller.send(:'empty?_presenter').nil? }
+
+    And  { helper_modules.size == 3 }
+    And  { helper_modules[0].instance_methods == [:thing] }
+    And  { helper_modules[1].instance_methods == [:another_thing] }
+    And  { helper_modules[2].instance_methods == [:empty?] }
+
+    And  { view_context.thing.is_a?(Thing) }
+    And  { view_context.another_thing.is_a?(DifferentThing) }
+    And  { view_context.empty?.nil? }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "presenter_rails"
+require "rspec/given"
+require "pry-byebug"

data/spec/support/rails_app.rb

@@ -0,0 +1,41 @@
+require "action_controller"
+require "rails"
+
+def request_params(params)
+  return params if Rails::VERSION::MAJOR < 5
+  { params: params }
+end
+
+module Rails
+  class App
+    def env_config
+      {}
+    end
+
+    def routes
+      @routes ||= ActionDispatch::Routing::RouteSet.new.tap do |routes|
+        routes.draw do
+          resources :birds
+        end
+      end
+    end
+  end
+
+  def self.root
+    ''
+  end
+
+  def self.application
+    @app ||= App.new
+  end
+end
+
+class ApplicationController < ActionController::Base
+  include Rails.application.routes.url_helpers
+end
+
+class BirdsController < ApplicationController
+ def index
+   head :ok
+ end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: presenter_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2017-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,19 +25,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pakiderm
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Presenter helps you expose view models to your views with a declarative
   approach.
 email:
@@ -49,19 +91,24 @@ extra_rdoc_files:
 files:
 - README.md
 - lib/presenter_rails.rb
-- lib/presenter_rails/presenter.rb
+- lib/presenter_rails/controller.rb
+- lib/presenter_rails/version.rb
+- spec/features/birds_controller_spec.rb
+- spec/features/birds_mailer_spec.rb
+- spec/presenter_rails/controller_spec.rb
+- spec/spec_helper.rb
+- spec/support/rails_app.rb
 homepage: https://github.com/ElMassimo/presenter_rails
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options:
-- "--charset=UTF-8"
+rdoc_options: []
 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
@@ -71,9 +118,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: ViewModels had a baby with helper_method
-test_files: []
-has_rdoc: 
+test_files:
+- spec/features/birds_controller_spec.rb
+- spec/features/birds_mailer_spec.rb
+- spec/presenter_rails/controller_spec.rb
+- spec/spec_helper.rb
+- spec/support/rails_app.rb

data/lib/presenter_rails/presenter.rb

@@ -1,55 +0,0 @@
-require 'pakiderm'
-
-module PresenterRails
-  module Presenter
-    extend ActiveSupport::Concern
-
-    included do
-      extend Pakiderm
-    end
-
-    module ClassMethods
-
-      # Can take a list of presenter methods, or a name and block for a presenter method
-      def present(*methods, &block)
-        presenter_methods = methods.map {|name| Presenter.method_name_for(name) }
-        define_presenter_method!(presenter_methods, &block) if block_given?
-
-        expose_presenter *methods
-        memoize *presenter_methods, assignable: true
-      end
-
-      # Exposes a presenter method to the view for each provided name
-      def expose_presenter(*method_names)
-        presenters_module = Module.new do
-          method_names.each do |name|
-            module_eval <<-ruby_eval, __FILE__, __LINE__ + 1
-              def #{name}
-                controller.send('#{Presenter.method_name_for(name)}')
-              end
-            ruby_eval
-          end
-        end
-        helper presenters_module
-      end
-
-      private
-
-      # Defines a private presenter method that invokes the provided block
-      def define_presenter_method!(methods, &block)
-        if methods.size != 1
-          Kernel.abort "[ERROR] You are providing a block for the `#{methods.join(', ')}` methods, " \
-            "but you can only provide a block for a single presenter at a time.\n #{caller.second}"
-        end
-        presenter_method = methods.first
-        define_method presenter_method, &block
-        private presenter_method
-      end
-    end
-
-    # Name of the presenter methods
-    def self.method_name_for(name)
-      "#{name}_presenter"
-    end
-  end
-end