power-types 0.3.1 → 0.4.0

data/.ruby-version

@@ -0,0 +1 @@
+2.5

data/.travis.yml

@@ -1,8 +1,8 @@
 sudo: false
 language: ruby
 rvm:
-- 2.3.1
-before_install: gem install bundler -v 1.12.4
+  - 2.5.0
+before_install: gem install bundler -v 2.1.4
 deploy:
   provider: rubygems
   api_key:

data/README.md

@@ -8,7 +8,7 @@ Rails pattern enforcing types used by the Platanus team.
 In Rails projects, Platanus encourages to use classes beyond models and controllers to hold the app's logic.
 These powerful types proposed are Services, Commands, Observers, Utils and Values.
 
-For a deeper understanding about the usage of these patterns, feel welcome to read the [related post in Platanus Blog](https://blog.platan.us/services-commands-y-otros-poderosos-patrones-en-rails) (in spanish).
+For a deeper understanding about the usage of these patterns, feel welcome to read the [related post in Platanus Blog](https://blog.platan.us/services-commands-y-otros-poderosos-patrones-en-rails-27c2d3aa7c2e) (in spanish).
 
 The goal aimed with this gem is to go further, and not just apply this patterns over POROs (plain simple ruby classes). The gem provides an special structure and syntax to create and run services, commands and more, with ease.
 
@@ -229,7 +229,7 @@ Wizard.create!(name: "Gandalf", villian: "Sauron") #=> This action will trigger
 
 ### Values and Utils
 
-This two types do not have generators.
+These two types don't have generators.
 
 Values are just simple Ruby classes, but watch out to keep them in the Values directory!
 
@@ -259,6 +259,112 @@ Example of calling a Util function:
 MagicTricks.dissapear(rabbit)
 ```
 
+### Presenters
+
+For generating presenters we use:
+
+```
+$ rails generate presenter users_show
+```
+
+This will create the `UsersShowPresenter` class, inheriting from a base class:
+
+```ruby
+class UsersShowPresenter < PowerTypes::PresenterBase
+end
+```
+
+And its corresponding rspec file:
+
+```ruby
+require 'rails_helper'
+
+describe UsersShowPresenter do
+  pending "add some examples to (or delete) #{__FILE__}"
+end
+```
+
+To initialize a presenter inside your controller action you should execute the `present_with` method with valid params:
+
+```ruby
+class UsersController < InheritedResources::Base
+  def show
+    presenter_params = { param1: 1, param2: 2 }
+    @presenter = present_with(:users_show, presenter_params)
+  end
+end
+```
+
+You can access view helper methods through the `h` method:
+
+```ruby
+class UsersShowPresenter < PowerTypes::PresenterBase
+  def platanus_link
+    h.link_to "Hi Platanus!", "https://platan.us"
+  end
+end
+```
+
+You can access `presenter_params` inside the presenter as an `attr_reader`
+
+```ruby
+class UsersController < InheritedResources::Base
+  def show
+    presenter_params = { platanus_url: "https://platan.us" }
+    @presenter = present_with(:users_show, presenter_params)
+  end
+end
+```
+
+```ruby
+class UsersShowPresenter < PowerTypes::PresenterBase
+  def platanus_link
+    h.link_to "Hi Platanus!", platanus_url
+  end
+end
+```
+
+If the presenter param has a [decorator](https://github.com/drapergem/draper), the `attr_reader` will be decorated.
+
+```ruby
+class UsersController < InheritedResources::Base
+  def show
+    presenter_params = { user: user }
+    @presenter = present_with(:users_show, presenter_params)
+  end
+
+  private
+
+  def user
+    @user ||= User.find!(params[:id])
+  end
+end
+```
+
+```ruby
+class UserDecorator < Draper::Decorator
+  delegate_all
+
+  def cool_view_name
+    "~º#{name}º~"
+  end
+end
+```
+
+```ruby
+class UsersShowPresenter < PowerTypes::PresenterBase
+  def platanus_link
+    h.link_to "Hi #{user.cool_view_name}!", platanus_url
+  end
+end
+```
+
+In the view, you can use it like this:
+
+```
+<div><%= @presenter.platanus_link %></div>
+```
+
 ## Contributing
 
 1. Fork it

data/lib/generators/power_types/init_generator.rb

@@ -1,12 +1,22 @@
 module PowerTypes
   class InitGenerator < Rails::Generators::Base
     desc "This generator creates the folder structure for the power-types gem"
+
     def create_folders
       empty_directory "app/commands/"
       empty_directory "app/services/"
       empty_directory "app/observers/"
+      empty_directory "app/presenters/"
       empty_directory "app/utils/"
       empty_directory "app/values/"
     end
+
+    def config_presenters
+      insert_into_file(
+        "app/controllers/application_controller.rb",
+        "\n  include PowerTypes::Presentable",
+        after: "ActionController::Base"
+      )
+    end
   end
 end

data/lib/generators/rails/presenter_generator.rb

@@ -0,0 +1,12 @@
+module Rails
+  class PresenterGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc "This generator creates a new presenter at app/presenters"
+
+    def create_presenter
+      template('presenter.rb', "app/presenters/#{file_name.underscore}_presenter.rb")
+      template('presenter_spec.rb', "spec/presenters/#{file_name.underscore}_presenter_spec.rb")
+    end
+  end
+end

data/lib/generators/rails/templates/presenter.rb

@@ -0,0 +1,2 @@
+class <%= class_name %>Presenter < PowerTypes::BasePresenter
+end

data/lib/generators/rails/templates/presenter_spec.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+describe <%= class_name %>Presenter do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

data/lib/power_types.rb

@@ -1,10 +1,15 @@
+require "active_support/all"
+
 require "power_types/version"
 require "power_types/util"
+require "power_types/errors"
 require "power_types/patterns/service"
 require "power_types/patterns/command"
 require "power_types/patterns/observer/observable"
 require "power_types/patterns/observer/observer"
 require "power_types/patterns/observer/trigger"
+require "power_types/patterns/presenter/base_presenter"
+require "power_types/patterns/presenter/presentable"
 
 module PowerTypes
 end

data/lib/power_types/errors.rb

@@ -0,0 +1,2 @@
+class PowerTypes::Error < RuntimeError; end
+class PowerTypes::PresenterError < PowerTypes::Error; end

data/lib/power_types/patterns/presenter/base_presenter.rb

@@ -0,0 +1,28 @@
+module PowerTypes
+  class BasePresenter
+    def initialize(view, params = {})
+      @h = view
+
+      params.each_pair do |attribute, value|
+        if respond_to?(attribute, true)
+          raise PowerTypes::PresenterError.new(
+            "attribute #{attribute} already defined in presenter"
+          )
+        end
+
+        singleton_class.send(:attr_accessor, attribute)
+        instance_variable_set("@#{attribute}", decorated_value(value))
+      end
+    end
+
+    private
+
+    attr_reader :h
+
+    def decorated_value(value)
+      return value unless value.respond_to?(:decorate)
+
+      value.decorate
+    end
+  end
+end

data/lib/power_types/patterns/presenter/presentable.rb

@@ -0,0 +1,20 @@
+module PowerTypes
+  module Presentable
+    def present_with(presenter_name, data = {})
+      presenter_class_by_name(presenter_name).new(view_context, data)
+    end
+
+    def presenter_class_by_name(presenter_name)
+      class_name = presenter_name.to_s.classify
+      class_constant = class_name.safe_constantize
+
+      if class_constant.blank?
+        raise PowerTypes::PresenterError.new(
+          "missing #{class_name} presenter class"
+        )
+      end
+
+      class_constant
+    end
+  end
+end

data/lib/power_types/version.rb

@@ -1,3 +1,3 @@
 module PowerTypes
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

data/power-types.gemspec

@@ -19,16 +19,19 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.4"
-  spec.add_development_dependency "rspec", "~> 3.1"
-  spec.add_development_dependency "rspec-nc", "~> 0.2"
+  spec.add_dependency "activesupport"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
+  spec.add_development_dependency "coveralls"
   spec.add_development_dependency "guard", "~> 2.11"
   spec.add_development_dependency "guard-rspec", "~> 4.5"
-  spec.add_development_dependency "terminal-notifier-guard", "~> 1.6", ">= 1.6.1"
   spec.add_development_dependency "pry", "~> 0.10"
-  spec.add_development_dependency "pry-remote", "~> 0.1"
   spec.add_development_dependency "pry-byebug", "~> 3.2"
   spec.add_development_dependency "pry-nav", "~> 0.2"
-  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "pry-remote", "~> 0.1"
+  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "rspec-nc", "~> 0.2"
+  spec.add_development_dependency "rubocop", "0.66"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "terminal-notifier-guard", "~> 1.6", ">= 1.6.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: power-types
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Ignacio Baixas
@@ -9,156 +9,164 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2020-10-19 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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '2.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '2.11'
 - !ruby/object:Gem::Dependency
-  name: rspec-nc
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '4.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '4.5'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: terminal-notifier-guard
+  name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: pry-remote
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: pry-remote
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: pry-nav
+  name: rspec-nc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -172,7 +180,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.66'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.66'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -185,6 +207,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
 description: Power Types for Rails by Platanus
 email:
 - ignacio@platan.us
@@ -198,6 +240,7 @@ files:
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -208,19 +251,25 @@ files:
 - lib/generators/power_types/init_generator.rb
 - lib/generators/rails/command_generator.rb
 - lib/generators/rails/observer_generator.rb
+- lib/generators/rails/presenter_generator.rb
 - lib/generators/rails/service_generator.rb
 - lib/generators/rails/templates/command.rb
 - lib/generators/rails/templates/command_spec.rb
 - lib/generators/rails/templates/observer.rb
 - lib/generators/rails/templates/observer_spec.rb
+- lib/generators/rails/templates/presenter.rb
+- lib/generators/rails/templates/presenter_spec.rb
 - lib/generators/rails/templates/service.rb
 - lib/generators/rails/templates/service_spec.rb
 - lib/power-types.rb
 - lib/power_types.rb
+- lib/power_types/errors.rb
 - lib/power_types/patterns/command.rb
 - lib/power_types/patterns/observer/observable.rb
 - lib/power_types/patterns/observer/observer.rb
 - lib/power_types/patterns/observer/trigger.rb
+- lib/power_types/patterns/presenter/base_presenter.rb
+- lib/power_types/patterns/presenter/presentable.rb
 - lib/power_types/patterns/service.rb
 - lib/power_types/util.rb
 - lib/power_types/version.rb
@@ -244,8 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Power Types for Rails by Platanus