power-types 0.3.1 → 0.6.0

data/.ruby-version

@@ -0,0 +1 @@
+2.7

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Ignacio Baixas
+Copyright 2022 Platanus
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,5 +1,7 @@
 # Power Types
-[![Gem Version](https://badge.fury.io/rb/power-types.svg)](https://badge.fury.io/rb/power-types) [![Build Status](https://travis-ci.org/platanus/power-types.svg?branch=master)](https://travis-ci.org/platanus/power-types) [![Coverage Status](https://coveralls.io/repos/github/platanus/power-types/badge.svg)](https://coveralls.io/github/platanus/power-types)
+[![Gem Version](https://badge.fury.io/rb/power-types.svg)](https://badge.fury.io/rb/power-types)
+[![CircleCI](https://circleci.com/gh/platanus/local_resource.svg?style=shield)](https://app.circleci.com/pipelines/github/platanus/local_resource)
+[![Coverage Status](https://coveralls.io/repos/github/platanus/power-types/badge.svg)](https://coveralls.io/github/platanus/power-types)
 
 Rails pattern enforcing types used by the Platanus team.
 
@@ -8,7 +10,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.
 
@@ -28,10 +30,20 @@ bundle install
 
 ## Power types
 
-- [Services](#services)
-- [Commands](#commands)
-- [Observers](#observers)
-- [Values and Utils](#values-and-utils)
+- [Power Types](#power-types)
+  - [Introduction](#introduction)
+  - [Installation](#installation)
+  - [Power types](#power-types-1)
+    - [Services](#services)
+    - [Commands](#commands)
+    - [Observers](#observers)
+    - [Values](#values)
+    - [Presenters](#presenters)
+    - [Utils](#utils)
+  - [Publishing](#publishing)
+  - [Contributing](#contributing)
+  - [Credits](#credits)
+  - [License](#license)
 
 ### Services
 
@@ -201,7 +213,7 @@ describe MyModelObserver do
 end
 ```
 
-Now, suppose you have defined the following model (with name and villian attributes) and observer:
+Now, suppose you have defined the following model (with name and villain attributes) and observer:
 
 ```ruby
 class Wizard < ActiveRecord::Base
@@ -214,7 +226,7 @@ class WizardObserver < PowerTypes::Observer
   after_create :kill_villain
 
   def kill_villain
-    p "#{object.name} have killed #{object.villian}"
+    p "#{object.name} has killed #{object.villain}"
   end
 end
 ```
@@ -222,43 +234,202 @@ end
 Then, you can use it like this:
 
 ```ruby
-Wizard.create!(name: "Gandalf", villian: "Sauron") #=> This action will trigger the method kill_villian defined in the WizardObserver's after_create callback.
+Wizard.create!(name: "Gandalf", villain: "Sauron") #=> This action will trigger the method kill_villain defined in the WizardObserver's after_create callback.
 ```
 
 > As you can guess, `object` holds the Wizard instance.
 
-### Values and Utils
+You can trigger multiple methods on the same callback. For example:
 
-This two types do not have generators.
+```ruby
+class WizardObserver < PowerTypes::Observer
+  after_create :kill_villain
+  after_create :bury_villains_corpse
+
+  def kill_villain
+    p "#{object.name} has killed #{object.villain}"
+  end
+
+  def bury_villains_corpse
+    p "#{object.name} has buried #{object.villain}'s corpse"
+  end
+end
+```
+Note: Triggering the event will preserve the order of the methods, so in the example `kill_villain` will be called before `bury_villains_corpse`.
+
+Recently we added three new callbacks, `after_create_commit`, `after_update_commit` and `after_save_commit`. With these callbacks we want to reproduce the `after_commit` transactional callback from Active Record. For this implementation we use the gem [After Commit Everywhere](https://github.com/Envek/after_commit_everywhere) to be able to use the `after_commit` callbacks outside the Active Record models.
+
+### Values
+
+This pattern doesn't have a generator.
 
 Values are just simple Ruby classes, but watch out to keep them in the Values directory!
 
-Utils should be defined as a module.  There you define the independent but related functions.  Use the extend self pattern to call them directly after the module name.
+### 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
-module MagicTricks
-  extend self
+class UsersController < InheritedResources::Base
+  def show
+    presenter_params = { user: user }
+    @presenter = present_with(:users_show, presenter_params)
+  end
 
-  def dissappear(object)
-    #blah blah
+  private
+
+  def user
+    @user ||= User.find!(params[:id])
   end
+end
+```
 
-  def shrink(children)
-    #bleh bleeh
+```ruby
+class UserDecorator < Draper::Decorator
+  delegate_all
+
+  def cool_view_name
+    "~º#{name}º~"
   end
+end
+```
 
-  def shuffle(cards)
-    #blaah
+```ruby
+class UsersShowPresenter < PowerTypes::PresenterBase
+  def platanus_link
+    h.link_to "Hi #{user.cool_view_name}!", platanus_url
   end
-end  
+end
+```
+
+In the view, you can use it like this:
+
+```
+<div><%= @presenter.platanus_link %></div>
+```
+
+### Utils
+
+To generate a util we use:
+
+```
+$ bundle exec rails g util Numbers clean double
 ```
 
-Example of calling a Util function:
+This will generate the `NumbersUtil` class in the `app/utils` directory, as follows:
 
 ```ruby
-MagicTricks.dissapear(rabbit)
+class NumbersUtil < PowerTypes::BaseUtil
+
+  def self.clean
+    # Method code goes here
+  end
+
+  def self.double
+    # Method code goes here
+  end
+
+end
+```
+
+And it will generate the spec file as well, in the `spec/utils` directory:
+
+```ruby
+require 'rails_helper'
+
+describe NumbersUtil do
+  describe '#clean' do
+    pending 'describe what the util method clean does here'
+  end
+
+  describe '#double' do
+    pending 'describe what the util method double does here'
+  end
+
+end
+```
+
+Every util will inherit from the class `PowerTypes::BaseUtil` which raises an error when the initialize method is called. The purpose of this is to ensure that all the utils methods work as class methods. Thus, there is no need to create an instance of the util to use its methods. For instance, we could use the `NumbersUtil` as follows:
+
+```ruby
+NumbersUtil.clean('5.000') # -> 5000
+NumbersUtil.double(100) # -> 200
 ```
 
+## Publishing
+
+On master/main branch...
+
+1. Change `VERSION` in `lib/power-types/version.rb`.
+2. Change `Unreleased` title to current version in `CHANGELOG.md`.
+3. Run `bundle install`.
+4. Commit new release. For example: `Releasing v0.1.0`.
+5. Create tag. For example: `git tag v0.1.0`.
+6. Push tag. For example: `git push origin v0.1.0`.
+
 ## 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/generators/rails/templates/util.rb

@@ -0,0 +1,7 @@
+class <%= class_name %>Util < PowerTypes::BaseUtil
+<% attributes_names.each do |method_name| %>
+  def self.<%= method_name %>
+    # Method code goes here
+  end
+<% end %>
+end

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

@@ -0,0 +1,9 @@
+require 'rails_helper'
+
+describe <%= class_name %>Util do
+<% attributes_names.each do |method_name| %>
+  describe '#<%= method_name %>' do
+    pending 'describe what the util method <%= method_name %> does here'
+  end
+<% end %>
+end

data/lib/generators/rails/util_generator.rb

@@ -0,0 +1,14 @@
+module Rails
+  class UtilGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :attributes, type: :array, default: [], banner: 'method method'
+
+    desc 'This generator creates a new util at app/utils'
+
+    def create_util
+      template('util.rb', "app/utils/#{file_name.underscore}_util.rb")
+      template('util_spec.rb', "spec/utils/#{file_name.underscore}_util_spec.rb")
+    end
+  end
+end

data/lib/power_types/errors.rb

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

data/lib/power_types/patterns/base_util.rb

@@ -0,0 +1,7 @@
+module PowerTypes
+  class BaseUtil
+    def initialize
+      raise PowerTypes::UtilError.new('a util cannot be instantiated')
+    end
+  end
+end

data/lib/power_types/patterns/observer/observer.rb

@@ -1,5 +1,7 @@
 module PowerTypes
   class Observer
+    include AfterCommitEverywhere
+
     attr_reader :object
 
     PowerTypes::Util::OBSERVABLE_EVENTS.each do |event|
@@ -34,5 +36,21 @@ module PowerTypes
     def initialize(_object)
       @object = _object
     end
+
+    PowerTypes::Util::OBSERVABLE_TRANSACTIONAL_EVENTS.each do |event|
+      PowerTypes::Util::OBSERVABLE_TYPES.each do |type|
+        next unless type == :after
+
+        method_name = "#{type}_#{event}"
+        callback = method_name.gsub('_commit', '')
+        define_singleton_method(method_name) do |method|
+          send(callback) { execute_method_after_commit(method) }
+        end
+      end
+    end
+
+    def execute_method_after_commit(method)
+      after_commit { send(method) }
+    end
   end
 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/util.rb

@@ -1,6 +1,7 @@
 module PowerTypes
   module Util
     OBSERVABLE_EVENTS = [:create, :update, :save, :destroy]
+    OBSERVABLE_TRANSACTIONAL_EVENTS = [:create_commit, :update_commit, :save_commit]
     OBSERVABLE_TYPES = [:before, :after]
   end
 end

data/lib/power_types/version.rb

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

data/lib/power_types.rb

@@ -1,10 +1,17 @@
-require "power_types/version"
-require "power_types/util"
-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 'active_support/all'
+require 'after_commit_everywhere'
+
+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'
+require 'power_types/patterns/base_util'
 
 module PowerTypes
 end

data/power-types.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'power_types/version'
@@ -19,16 +18,17 @@ 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_dependency "after_commit_everywhere", "~> 1.2", ">= 1.2.2"
+
+  spec.add_development_dependency "bundler", "~> 2.2.15"
+  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 "rake", "~> 10.4"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "rubocop", "0.66"
+  spec.add_development_dependency "rubocop-rspec"
 end