enum-transitions 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c14766eb62c8818cf3142933685a7dbadd825a42c00f34543aa14996ecacbba2
+  data.tar.gz: 052d0e5d8ac1d0d459aa70e3ca190eb18a1e435c4a811f3c114683121eaa0617
+SHA512:
+  metadata.gz: 0de272af650ab10c23763fcdeb7b511a4049154e864d60fd352c9d71a98d00cd390dab7fb4a20a25d4c05fcdc5f1ebc2de7a468e5efd33814b3b029357f2a3d8
+  data.tar.gz: b966fe288ca193691e9dac6a9f64e5912a1f63692dc3c6e10d9a1eaed8ce420e3162c3e57e23e9ac4225f0457134321a67e2f2ff61d8b40ec15c74f86d7da8d2

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in enum-transitions.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    enum-transitions (1.0.0)
+      activerecord (~> 5.0)
+      activesupport (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.7)
+      activesupport (= 5.1.7)
+    activerecord (5.1.7)
+      activemodel (= 5.1.7)
+      activesupport (= 5.1.7)
+      arel (~> 8.0)
+    activesupport (5.1.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.0)
+    rake (12.3.3)
+    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)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  enum-transitions!
+  rake (~> 12.3.3)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Artem Nistratov
+
+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,53 @@
+# Enum::Transitions
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enum-transitions', '~> 1.0.0
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enum-transitions
+
+## Usage
+
+```ruby
+class Model < ApplicationRecord
+  include Enum::Transitions::DSL
+
+  enum state: [:pending, :active, :finihed, :failed]
+
+  transitions enum: :state do
+    allow pending => active
+
+    allow active => [finihed, failed] do
+      after do
+        # ...
+      end
+    end
+
+    after_leaving pending do
+      # ...
+    end
+  end
+end
+```
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/adone/enum-transitions.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "enum/transitions"
+
+# 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/enum-transitions.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enum/transitions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'enum-transitions'
+  spec.version       = Enum::Transitions::VERSION
+  spec.authors       = ['Artem Nistratov']
+  spec.email         = ['artem.nistratov@gmail.com']
+
+  spec.summary       = 'Simple state transitions for ActiveRecord enum columns'
+  spec.description   = 'Simple state transitions for ActiveRecord enum columns'
+  spec.homepage      = 'https://github.com/adone/enum-transitions'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/adone/enum-transitions'
+  # spec.metadata['changelog_uri'] = 'TODO: Put your gem's CHANGELOG.md URL here.'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_runtime_dependency 'activerecord', '~> 5.0'
+  spec.add_runtime_dependency 'activesupport', '~> 5.0'
+end

data/lib/enum/transitions.rb

@@ -0,0 +1,19 @@
+require 'enum/transitions/version'
+require 'active_support'
+
+module Enum
+  module Transitions
+    extend ActiveSupport::Autoload
+
+    autoload :DSL
+    autoload :Mixin
+    autoload :Naming
+    autoload :Machine
+    autoload :UpdateHandler
+    autoload :Configuration
+
+    module Errors
+      TransitionNotAllowed = Class.new(RuntimeError)
+    end
+  end
+end

data/lib/enum/transitions/configuration.rb

@@ -0,0 +1,25 @@
+module Enum
+  module Transitions
+    class Configuration
+      attr_reader :enum, :states, :transitions, :callbacks
+
+      # @param enum [String]
+      # @param states [Array<String>]
+      def initialize(enum, states)
+        @enum   = enum
+        @states = states
+        @transitions = {}
+        @callbacks   = {}
+      end
+
+      def with_safe_nesting
+        @transitions.default_proc = ->(hash, key) { hash[key] = {} }
+        @callbacks.default_proc = ->(hash, key) { hash[key] = [] }
+        yield
+      ensure
+        @callbacks.default_proc = nil
+        @transitions.default_proc = nil
+      end
+    end
+  end
+end

data/lib/enum/transitions/dsl.rb

@@ -0,0 +1,25 @@
+module Enum
+  module Transitions
+    module DSL
+      extend ActiveSupport::Concern
+      extend ActiveSupport::Autoload
+
+      autoload :Proxy
+      autoload :Callbacks
+
+      class_methods do
+        def transitions(enum:, &block)
+          states = public_send(enum.to_s.pluralize).keys
+          config = Configuration.new(enum.to_s, states)
+          proxy  = Proxy.embed(states).new(config)
+
+          config.with_safe_nesting do
+            Docile.dsl_eval(proxy, &block)
+          end
+
+          include Mixin.new(config)
+        end
+      end
+    end
+  end
+end

data/lib/enum/transitions/dsl/callbacks.rb

@@ -0,0 +1,20 @@
+module Enum
+  module Transitions
+    module DSL
+      class Callbacks
+        def initialize(config, transition)
+          @config = config
+          @transition = transition
+        end
+
+        def before(&block)
+          @config.callbacks[@transition] << [:before, block]
+        end
+
+        def after(&block)
+          @config.callbacks[@transition] << [:after, block]
+        end
+      end
+    end
+  end
+end

data/lib/enum/transitions/dsl/proxy.rb

@@ -0,0 +1,63 @@
+module Enum
+  module Transitions
+    module DSL
+      class Proxy
+        include Naming
+
+        # @param states [Array<String>]
+        def self.embed(states)
+          Class.new(self) do
+            states.each do |state|
+              define_method(state) { state }
+            end
+          end
+        end
+
+        # @param config [Enum::Transitions::Configuration]
+        def initialize(config)
+          @config = config
+        end
+
+        # @param transitions[Hash{Array<Symbol>=>Array<Symbol>}]
+        def allow(transitions, &block)
+          transitions.each_pair do |sources, targets|
+            Array(sources).product(Array(targets)) do |source, target|
+              transition = transition_event(source, target)
+
+              @config.transitions[source][target] = transition
+              @config.callbacks[transition] ||= []
+              @config.callbacks[leaving_event(source)] ||= []
+              @config.callbacks[entering_event(target)] ||= []
+
+              Docile.dsl_eval(Callbacks.new(@config, transition), &block)
+            end
+          end
+        end
+
+        def before_leaving(*states, &block)
+          states.each do |state|
+            @config.callbacks[leaving_event(state)] << [:before, block]
+          end
+        end
+
+        def after_leaving(*states, &block)
+          states.each do |state|
+            @config.callbacks[leaving_event(state)] << [:after, block]
+          end
+        end
+
+        def before_entering(*states, &block)
+          states.each do |state|
+            @config.callbacks[entering_event(state)] << [:before, block]
+          end
+        end
+
+        def after_entering(*states, &block)
+          states.each do |state|
+            @config.callbacks[entering_event(state)] << [:after, block]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/enum/transitions/mixin.rb

@@ -0,0 +1,29 @@
+module Enum
+  module Transitions
+    class Mixin < Module
+      include ActiveSupport::Concern
+
+      # @param config [Enum::Transitions::Configuration]
+      def initialize(config)
+        @_dependencies = []
+        @_enum = config.enum
+
+        included do
+          define_callbacks(*config.callbacks.keys)
+
+          config.callbacks.each_pair do |event, callbacks|
+            callbacks.each do |kind, block|
+              set_callback(event, kind, &block)
+            end
+          end
+
+          around_update UpdateHandler.new(config), if: :"#{config.enum}_changed?"
+        end
+      end
+
+      def inspect
+        "Enum::Transitions::Mixin[#{@_enum}]"
+      end
+    end
+  end
+end

data/lib/enum/transitions/naming.rb

@@ -0,0 +1,17 @@
+module Enum
+  module Transitions
+    module Naming
+      def transition_event(source, target)
+        :"#{@config.enum}_from_#{source}_to_#{target}"
+      end
+
+      def leaving_event(state)
+        :"#{@config.enum}_leaving_#{state}"
+      end
+
+      def entering_event(state)
+        :"#{@config.enum}_entering_#{state}"
+      end
+    end
+  end
+end

data/lib/enum/transitions/update_handler.rb

@@ -0,0 +1,27 @@
+module Enum
+  module Transitions
+    class UpdateHandler
+      include Naming
+
+      # @param config [Enum::Transisions::Configuration]
+      def initialize(config)
+        @config = config
+      end
+
+      def around_update(model)
+        source, target = model.changes[@config.enum]
+        transition = @config.transitions.dig(source, target)
+
+        raise Errors::TransitionNotAllowed if transition.nil?
+
+        model.run_callbacks transition do
+          model.run_callbacks leaving_event(source) do
+            model.run_callbacks entering_event(target) do
+              yield
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/enum/transitions/version.rb

@@ -0,0 +1,5 @@
+module Enum
+  module Transitions
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: enum-transitions
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Artem Nistratov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Simple state transitions for ActiveRecord enum columns
+email:
+- artem.nistratov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- enum-transitions.gemspec
+- lib/enum/transitions.rb
+- lib/enum/transitions/configuration.rb
+- lib/enum/transitions/dsl.rb
+- lib/enum/transitions/dsl/callbacks.rb
+- lib/enum/transitions/dsl/proxy.rb
+- lib/enum/transitions/mixin.rb
+- lib/enum/transitions/naming.rb
+- lib/enum/transitions/update_handler.rb
+- lib/enum/transitions/version.rb
+homepage: https://github.com/adone/enum-transitions
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/adone/enum-transitions
+  source_code_uri: https://github.com/adone/enum-transitions
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Simple state transitions for ActiveRecord enum columns
+test_files: []