transitions_listener 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf5ad9460a9d232ee046520eb1e29b5d6a6f529571ba88d518e941dc5662abb5
+  data.tar.gz: be6081d137e8e47c995225f2e32951c0abd45d8c53b61ae180e75b1aa9ca5275
+SHA512:
+  metadata.gz: 2de3e33e1d5a4684a99d23837c40ff2207ae6f4d0f3e267aed8c2de5197ff7948574748fee538828120eabee12bb10d03525c7e3c2607ed9d89494657da6f5ef
+  data.tar.gz: 842e02b54c22ed9439b7ba355ca08b3e9c13830e36eb651e42c4ac6008e6101b5b98bc6e692c3204d453891420237055fd161bd11133df2ea4b8c3e1768bb93e

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+
+jobs:
+  build:
+    name: Tests and Code Style
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+
+      - name: Install sqlite3
+        run: sudo apt-get install libsqlite3-dev
+
+      - name: Bundle install
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+      - name: Tests (rspec)
+        run: |
+          bundle exec rspec
+      - name: Code style (Rubocop)
+        run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+# This is the configuration used to check the rubocop source code.
+
+AllCops:
+  Exclude:
+    - 'Rakefile'
+    - 'bin/**/*'
+    - 'Gemfile'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at owenperedo@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+gem 'rubocop'
+gem 'sqlite3'
+# Specify your gem's dependencies in transitions_listener.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    transitions_listener (0.1.0)
+      activerecord
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.4.2)
+      activesupport (= 5.2.4.2)
+    activerecord (5.2.4.2)
+      activemodel (= 5.2.4.2)
+      activesupport (= 5.2.4.2)
+      arel (>= 9.0)
+    activesupport (5.2.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.0)
+    parallel (1.19.1)
+    parser (2.7.1.1)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.81.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  rake
+  rspec
+  rubocop
+  sqlite3
+  transitions_listener!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Owen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# TransitionsListener
+
+This gem was inspired by [State Machine](https://github.com/pluginaweek/state_machine)
+to listen all state transitions and make actions before and after the transition is saved.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'transitions_listener'
+```
+
+And then execute: ```bundle install```
+
+
+## Usage 
+```ruby
+# == Schema Information
+#
+# Table name: articles
+#
+#  id              :bigint
+#  state           :string
+  
+class Article < ActiveRecord::Base
+  include TransitionsListener
+  listen_transitions :state do
+    after_transition active: :inactive do |article, transition|
+      # article.send_inactive_email
+    end
+    before_transition any => :deleted do |article, transition|
+      # article.errors.add(:base, "not possible") if article.active_carts.any?
+    end
+  end
+end
+```
+
+## API
+- ````listen_transitions(attr_name){block}```` permit to define state transitions listener for a specific model attribute
+- ````before_transition(states){block}```` permit to listen transitions before the new state is saved (Before update)
+- ````after_transition(states){block}```` permit to listen transitions after the new state was saved (After update)
+
+States can be defined as the following:
+- ```before_transition(any => any)``` block will be called when attr value is changed from any value to any value
+- ```before_transition(any => :active)``` block will be called when attr value is changed from any value to :active
+- ```before_transition(:active => any)``` block will be called when attr value is changed from :active value to any value
+- ```before_transition(%i[active inactive] => %i[deleted cancelled])``` block will be called when attr value is changed from :active or inactive to :deleted or :cancelled
+- ```before_transition(active: :inactive, inactive: :deleted)``` block will be called when attr value is changed from :active to :inactive or :inactive to :deleted
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/transitions_listener. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TransitionsListener project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/transitions_listener/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "transitions_listener"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/transitions_listener.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'transitions_listener/version'
+require 'transitions_listener/listener'
+
+module TransitionsListener
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.class_eval do
+      before_update do
+        self.class.perform_transition_listeners(self, :before)
+      end
+
+      after_update_commit do
+        self.class.perform_transition_listeners(self, :after)
+      end
+    end
+  end
+
+  module ClassMethods
+    def listen_transitions(attr, &block)
+      transition_listeners(TransitionsListener::Listener.new(attr, &block))
+    end
+
+    def perform_transition_listeners(model, kind = :before)
+      transition_listeners.each do |listener|
+        c_transition = current_transition_for(model, listener.attr)
+        listener.filter_transitions(kind, c_transition).each do |transition|
+          transition[:block].call(model, c_transition.merge(transition))
+        end
+      end
+    end
+
+    private
+
+    def transition_listeners(listener = nil)
+      @transition_listeners ||= []
+      @transition_listeners << listener if listener
+      @transition_listeners
+    end
+
+    def current_transition_for(model, attr)
+      to = model.send(attr)
+      from = model.send("#{attr}_was")
+      unless model.changed?
+        previous = model.send("#{attr}_previous_change")
+        from = previous.nil? ? to : previous.first
+      end
+      { from: from, to: to }
+    end
+  end
+end

data/lib/transitions_listener/listener.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module TransitionsListener
+  class Listener
+    attr_accessor :attr
+    def initialize(attr, &block)
+      @attr = attr
+      instance_eval(&block)
+    end
+
+    def before_transition(states, &block)
+      before_transitions(states: states, block: block)
+    end
+
+    def after_transition(states, &block)
+      after_transitions(states: states, block: block)
+    end
+
+    def filter_transitions(kind, from:, to:)
+      transitions = kind == :before ? before_transitions : after_transitions
+      transitions.select do |transition|
+        match_states?(transition[:states], from, to)
+      end
+    end
+
+    private
+
+    def match_states?(states, from_state, to_state)
+      parse_states(states).any? do |t_from, t_to|
+        (t_from == [any] || t_from.include?(from_state.to_s)) &&
+          (t_to == [any] || t_to.include?(to_state.to_s))
+      end
+    end
+
+    def any
+      'any_transition_key'
+    end
+
+    def before_transitions(transition = nil)
+      @before_transitions ||= []
+      @before_transitions << transition if transition
+      @before_transitions
+    end
+
+    def after_transitions(transition = nil)
+      @after_transitions ||= []
+      @after_transitions << transition if transition
+      @after_transitions
+    end
+
+    def parse_states(states)
+      states.map do |from, to|
+        from = [from] unless from.is_a? Array
+        to = [to] unless to.is_a? Array
+        [from.map(&:to_s), to.map(&:to_s)]
+      end.to_h
+    end
+  end
+end

data/lib/transitions_listener/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TransitionsListener
+  VERSION = '0.1.0'
+end

data/transitions_listener.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transitions_listener/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'transitions_listener'
+  spec.version       = TransitionsListener::VERSION
+  spec.authors       = ['Owen']
+  spec.email         = ['owenperedo@gmail.com']
+
+  spec.summary       = 'Permit to listen all transition movements'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/owen2345/transitions_listener'
+  spec.license       = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'activesupport'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: transitions_listener
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Owen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Permit to listen all transition movements
+email:
+- owenperedo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/transitions_listener.rb
+- lib/transitions_listener/listener.rb
+- lib/transitions_listener/version.rb
+- transitions_listener.gemspec
+homepage: https://github.com/owen2345/transitions_listener
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/owen2345/transitions_listener
+  source_code_uri: https://github.com/owen2345/transitions_listener
+  changelog_uri: https://github.com/owen2345/transitions_listener/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Permit to listen all transition movements
+test_files: []