power-types 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09c102791e603d22a9adc00c2541eefe568d5535bec4bcf1cd339166653edae6'
-  data.tar.gz: 36fa5e71d80e34ebd2c7aaf93cceecfe3375008d2084dc1e283d5ae80efd2756
+  metadata.gz: 0d925bbf270d6ba204b3e091b60f5b16a5f02e5c6a76a6cee0ce710ff148f548
+  data.tar.gz: f494be84a510e19471380a1b3163e8ccb5b320f7c3307b272090314297a0491c
 SHA512:
-  metadata.gz: b219f01522f1c1de782ebdc7957b915df269d5663e651b4e67c1bdf44bc430c95d85f73e28f9d5fa1f1c317c8d9b766088900e1ab75575d8cca5f9d01d5bc34f
-  data.tar.gz: 34ffe18ebf5ed15af95c4a9be9579994dde7268f64d0fa6d8cd8fd7196c9f1cf87edbca8793d5f6fbe918f033e18fbd8ce355bf0a97cc52be7612ed1b665b59a
+  metadata.gz: 8dcbe2f8d896b4f3de9431d79247ce76426528ebc206a8585f33770dab9f110ad9849f8d5a46435c6fcc3fd84493cddcdec5d6b1916ce7f238dd74d4a825f6d3
+  data.tar.gz: 26570fe587be13f151c0ac0627b361de02977ad32c3651ee1f5f6f7135b0357c33d55fe217931cc569a81a09756b8aff0efc7ef30c0d52cb35e9039db5aef87c

data/.circleci/config.yml

@@ -0,0 +1,103 @@
+version: 2.1
+
+env-vars: &env-vars
+  RAILS_ENV: test
+  NODE_ENV: test
+  BUNDLE_PATH: vendor/bundle
+
+orbs:
+  ruby: circleci/ruby@0.1.2
+  browser-tools: circleci/browser-tools@1.1.3
+
+executors:
+  main-executor:
+    parameters:
+      ruby-version:
+        description: "Ruby version"
+        default: "2.7"
+        type: string
+    docker:
+      - image: circleci/ruby:<<parameters.ruby-version>>-node
+        environment: *env-vars
+
+commands:
+  setup:
+    description: checkout code and install dependencies
+    steps:
+      - checkout
+      - run:
+          name: Install bundle dependencies
+          command: |
+            gem install bundler:2.2.15
+            bundle install
+
+jobs:
+  lint:
+    executor: main-executor
+    steps:
+      - setup
+      - run:
+          name: Install reviewdog
+          command: |
+            curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh | sh -s -- -b ./bin
+      - run:
+          name: Get files to lint
+          command: |
+            mkdir tmp
+            git diff origin/master --name-only --diff-filter=d > tmp/files_to_lint
+      - run:
+          name: Run rubocop
+          shell: /bin/bash
+          command: |
+            cat tmp/files_to_lint | grep -E '.+\.(rb)$' | xargs bundle exec rubocop --force-exclusion \
+            | ./bin/reviewdog -reporter=github-pr-review -f=rubocop
+  test:
+    parameters:
+      ruby-version:
+        description: "Ruby version"
+        default: "2.7"
+        type: string
+    executor:
+      name: main-executor
+      ruby-version: <<parameters.ruby-version>>
+    steps:
+      - setup
+      - run:
+          name: Run Tests
+          command: |
+            RSPEC_JUNIT_ARGS="-r rspec_junit_formatter -f RspecJunitFormatter -o test_results/rspec.xml"
+            RSPEC_FORMAT_ARGS="-f progress --no-color -p 10"
+            bundle exec rspec ./spec $RSPEC_FORMAT_ARGS $RSPEC_JUNIT_ARGS
+      - store_test_results:
+          path: test_results
+  deploy:
+    executor: main-executor
+    steps:
+      - setup
+      - run:
+          name: Setup rubygems
+          command: bash .circleci/setup-rubygems.sh
+      - run:
+          name: Publish to rubygems
+          command: |
+            gem build power-types.gemspec
+            version_tag=$(git describe --tags)
+            gem push power-types-${version_tag#v}.gem
+
+workflows:
+  version: 2
+  main:
+    jobs:
+      - lint:
+          context: org-global
+      - test:
+          matrix:
+            parameters:
+              ruby-version: ["2.5", "2.6", "2.7"]
+      - deploy:
+          context: org-global
+          filters:
+            tags:
+              only: /.*/
+            branches:
+              ignore: /.*/

data/.circleci/setup-rubygems.sh

@@ -0,0 +1,3 @@
+mkdir ~/.gem
+echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
+chmod 0600 /home/circleci/.gem/credentials

data/.rubocop.yml

@@ -198,7 +198,6 @@ Style/WordArray:
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-w
   Enabled: false
   MinSize: 0
-  WordRegex: !ruby/regexp /\A[\p{Word}]+\z/
 Metrics/AbcSize:
   Description: A calculated magnitude based on number of assignments, branches, and
     conditions.

data/.ruby-version

@@ -1 +1 @@
-2.5
+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.
 
@@ -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,42 +234,34 @@ 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
-
-These two types don't have generators.
-
-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.
+You can trigger multiple methods on the same callback. For example:
 
 ```ruby
-module MagicTricks
-  extend self
-
-  def dissappear(object)
-    #blah blah
-  end
+class WizardObserver < PowerTypes::Observer
+  after_create :kill_villain
+  after_create :bury_villains_corpse
 
-  def shrink(children)
-    #bleh bleeh
+  def kill_villain
+    p "#{object.name} has killed #{object.villain}"
   end
 
-  def shuffle(cards)
-    #blaah
+  def bury_villains_corpse
+    p "#{object.name} has buried #{object.villain}'s corpse"
   end
-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`.
 
-Example of calling a Util function:
+### Values
 
-```ruby
-MagicTricks.dissapear(rabbit)
-```
+This pattern doesn't have a generator.
+
+Values are just simple Ruby classes, but watch out to keep them in the Values directory!
 
 ### Presenters
 
@@ -365,6 +369,65 @@ 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
+```
+
+This will generate the `NumbersUtil` class in the `app/utils` directory, as follows:
+
+```ruby
+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/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

@@ -1,2 +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/util.rb

@@ -1,6 +1,6 @@
 module PowerTypes
   module Util
-    OBSERVABLE_EVENTS = [:create, :update, :save, :destroy]
+    OBSERVABLE_EVENTS = [:create, :update, :save, :destroy, :commit]
     OBSERVABLE_TYPES = [:before, :after]
   end
 end

data/lib/power_types/version.rb

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

data/lib/power_types.rb

@@ -10,6 +10,7 @@ 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'
@@ -20,18 +19,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"
-  spec.add_development_dependency "bundler", "~> 2.1.4"
+
+  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 "pry", "~> 0.10"
-  spec.add_development_dependency "pry-byebug", "~> 3.2"
-  spec.add_development_dependency "pry-nav", "~> 0.2"
-  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 "rspec_junit_formatter"
   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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ignacio Baixas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2022-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 2.2.15
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 2.2.15
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -95,48 +95,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: pry-nav
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: pry-remote
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -166,19 +124,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: rspec-nc
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -207,26 +165,6 @@ 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
@@ -235,13 +173,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".circleci/setup-rubygems.sh"
 - ".coveralls.yml"
 - ".gitignore"
-- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -261,9 +199,13 @@ files:
 - lib/generators/rails/templates/presenter_spec.rb
 - lib/generators/rails/templates/service.rb
 - lib/generators/rails/templates/service_spec.rb
+- lib/generators/rails/templates/util.rb
+- lib/generators/rails/templates/util_spec.rb
+- lib/generators/rails/util_generator.rb
 - lib/power-types.rb
 - lib/power_types.rb
 - lib/power_types/errors.rb
+- lib/power_types/patterns/base_util.rb
 - lib/power_types/patterns/command.rb
 - lib/power_types/patterns/observer/observable.rb
 - lib/power_types/patterns/observer/observer.rb
@@ -293,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Power Types for Rails by Platanus

data/.hound.yml

@@ -1,4 +0,0 @@
----
-ruby:
-  enabled: true
-  config_file: ".rubocop.yml"

data/.travis.yml

@@ -1,13 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.0
-before_install: gem install bundler -v 2.1.4
-deploy:
-  provider: rubygems
-  api_key:
-    secure: e5mtRDYciM2I5IxsMJDKKNSHgyQsfmAQEMCgbf1tN+SEmxeJTif0FXfA1M4vZ2y6XL7sza0Pf1hTMIqmEIh4L8tv/JxTOl6ZWkD2l8x+nn/2Hlu5mVsztsBh+qDPWPg29hbvTptOfcLHfAqIboB4L4f5nNuHeeLZQjGD7irwaVil7IntV3oG+XfD1uJzkqO9x7Xw+cN+HzACwZQ3u+XhmedCnMWJdCwai5QZAYlytxqKirYoGgS9pi4ZgAs0ptIT+aG3dG8ckCRvhDiu2iGDrv7AnG+K2MrI7O06g0676Iao1O0xTcW2Yo9uArkVXRo9L3Ghk1T5O5zCPoiF7oLiNlBkHeRGOw/+H+88NxziNaOi9BZswn2ROpFylVPrg8hDvIoOqRZfxqgnCtM2vTdOdyCcPOJgm3nhZl9OZ9aPbE3x/Fh5zXVBFT5Vwz3RV0s9uDuKa6pjphxOGb/be+ZYyPJ/uOU7Wo6Qj+lQ+/YBwbZ2wPJ2qAqb69gRBliYpSFbMsLptKw7YUYNW22yknZHGrhHlok7YDDpotUMMDJmSKUrXvBIPdqq9Y61gXLXE5QxxQkWqAFyhluDDMdIDs0PMkDBl45LvHfPJQZxp8sX+FK5ashmMPgdsDcb8DRK+LYrCHrinMkPcwIME5JeuAnb7bT0ErrtBSq8iAD8sPeI+/Q=
-  gem: power-types
-  on:
-    tags: true
-    repo: platanus/power-types