stateful_enum 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d0d82f2cf13496a059030aac0a34a998e47997bcbf6605637fa488c5363454d
-  data.tar.gz: 69fc206ccfc3d4290ad0961cac0d011e92ed1fa5421c0064bd881213d52082d5
+  metadata.gz: 862f0fff7013f98f6f39aa069098e104f7d48bcdefabbb30ca8accf6f817dd49
+  data.tar.gz: 645171697753e52e14c87a42df936df727d2b984bfc0dba7f05a18c874667694
 SHA512:
-  metadata.gz: e3f5cec3415b7401c36acf28d5dda810d75818cc88b38a768e721757aaf508714ee0613b7926bb0b5e05832df83e6d7deadc3cc0b816eb3e7ab9a6286f6b1399
-  data.tar.gz: 6a8d8196552d59c696c42872ae3a9decb62ddef4e75b42566af8e45cd2d3887e3fe6688808ac230f3d35ba7501f4e06328a4fad93462d3e8aee4fca985da4720
+  metadata.gz: ade6a0c15d35d147bb60f17d7dca8e36c0aa43975d14ca88dc88cf402b3bebd6b4d443b050048a0fbe8d92a339ae2fd966c6aa6220623e385d9df1c401366d8f
+  data.tar.gz: b6fd92a9296efb47852956375d73b8c801b63bbf877e4a9612db5f3f74f96ee4930a6cefe12cd635ea667ff43f0875ffebce8307bada70d409ac78f8171095c7

data/.github/workflows/main.yml

@@ -0,0 +1,92 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        ruby_version: [ruby-head, '3.4', '3.3', '3.2', '3.1']
+        rails_version: [edge, '8.1', '8.0', '7.2', '7.1', '7.0', '6.1']
+
+        include:
+          - ruby_version: '3.0'
+            rails_version: '7.1'
+          - ruby_version: '3.0'
+            rails_version: '7.0'
+          - ruby_version: '3.0'
+            rails_version: '6.1'
+          - ruby_version: '3.0'
+            rails_version: '6.0'
+
+          - ruby_version: '2.7'
+            rails_version: '7.1'
+          - ruby_version: '2.7'
+            rails_version: '7.0'
+          - ruby_version: '2.7'
+            rails_version: '6.1'
+          - ruby_version: '2.7'
+            rails_version: '6.0'
+
+          - ruby_version: '2.6'
+            rails_version: '6.1'
+          - ruby_version: '2.6'
+            rails_version: '6.0'
+          - ruby_version: '2.6'
+            rails_version: '5.2'
+          - ruby_version: '2.6'
+            rails_version: '5.1'
+          - ruby_version: '2.6'
+            rails_version: '5.0'
+          - ruby_version: '2.6'
+            rails_version: '4.2'
+            bundler_version: '1'
+
+          - ruby_version: '2.5'
+            rails_version: '5.2'
+          - ruby_version: '2.5'
+            rails_version: '4.2'
+            bundler_version: '1'
+
+          - ruby_version: '2.4'
+            rails_version: '5.2'
+          - ruby_version: '2.4'
+            rails_version: '4.2'
+            bundler_version: '1'
+
+          - ruby_version: '2.3'
+            rails_version: '4.1'
+            bundler_version: '1'
+
+          - ruby_version: '2.2'
+            rails_version: '5.2'
+            bundler_version: '1'
+
+        exclude:
+          - ruby_version: '3.1'
+            rails_version: 'edge'
+          - ruby_version: '3.1'
+            rails_version: '8.1'
+          - ruby_version: '3.1'
+            rails_version: '8.0'
+
+    env:
+      RAILS_VERSION: ${{ matrix.rails_version }}
+
+    runs-on: ubuntu-24.04
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "${{ matrix.ruby_version }}"
+          rubygems: ${{ matrix.ruby_version < '2.7' && 'default' || 'latest' }}
+          bundler: "${{ matrix.bundler_version }}"
+          bundler-cache: true
+        continue-on-error: ${{ (matrix.ruby_version == 'ruby-head') || (matrix.rails_version == 'edge') || (matrix.allow_failures == 'true') }}
+
+      - run: sudo apt-get install graphviz
+
+      - run: bundle exec rake
+        continue-on-error: ${{ (matrix.ruby_version == 'ruby-head') || (matrix.rails_version == 'edge') || (matrix.allow_failures == 'true') }}

data/.gitignore

@@ -10,5 +10,7 @@ gemfiles/*.lock
 /tmp/
 /log/
 /test/dummy/log/
+/test/dummy/tmp/
+/test/dummy/**/*.png
 
 .byebug_history

data/Gemfile

@@ -1,6 +1,30 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in stateful_enum.gemspec
 gemspec
 
-gem 'byebug'
+if ENV['RAILS_VERSION'] == 'edge'
+  gem 'rails', git: 'https://github.com/rails/rails.git'
+elsif ENV['RAILS_VERSION']
+  gem 'rails', "~> #{ENV['RAILS_VERSION']}.0"
+  if ENV['RAILS_VERSION'] <= '5.0'
+    gem 'sqlite3', '< 1.4'
+  elsif ENV['RAILS_VERSION'] <= '7.1'
+    gem 'sqlite3', '~> 1.4'
+  end
+else
+  gem 'rails'
+end
+
+gem 'selenium-webdriver'
+gem 'nokogiri', RUBY_VERSION < '2.1' ? '~> 1.6.0' : '>= 1.7'
+gem 'loofah', RUBY_VERSION < '2.5' ? '< 2.21.0' : '>= 0'
+
+if RUBY_VERSION >= '3.3'
+  gem 'bigdecimal'
+  gem 'mutex_m'
+end
+
+gem 'benchmark' if RUBY_VERSION >= '3.5'

data/README.md

@@ -1,4 +1,4 @@
-# StatefulEnum [![Build Status](https://travis-ci.org/amatsuda/stateful_enum.svg?branch=master)](https://travis-ci.org/amatsuda/stateful_enum)
+# StatefulEnum [![Build Status](https://github.com/amatsuda/stateful_enum/actions/workflows/main.yml/badge.svg)](https://github.com/amatsuda/stateful_enum/actions)
 
 stateful_enum is a state machine gem built on top of ActiveRecord's built-in ActiveRecord::Enum.
 
@@ -41,7 +41,7 @@ The stateful_enum gem extends AR::Enum definition to take a block with a similar
 Example:
 ```ruby
 class Bug < ApplicationRecord
-  enum status: {unassigned: 0, assigned: 1, resolved: 2, closed: 3} do
+  enum :status, {unassigned: 0, assigned: 1, resolved: 2, closed: 3} do
     event :assign do
       transition :unassigned => :assigned
     end
@@ -122,6 +122,29 @@ end
 
 You can define `before` and `after` event hooks inside of an `event` block.
 
+Event methods accept arguments (both positional and keyword arguments) that are passed through to the callbacks:
+
+```ruby
+class Bug < ApplicationRecord
+  enum :status, {unassigned: 0, assigned: 1, resolved: 2, closed: 3} do
+    event :close do
+      before do |closed_by:, reason: nil|
+        self.closed_by = closed_by
+        self.close_reason = reason
+      end
+
+      after do |closed_by:, **|
+        Notifier.notify "Bug##{id} was closed by #{closed_by.name}"
+      end
+
+      transition all - [:closed] => :closed
+    end
+  end
+end
+
+@bug.close(closed_by: current_user, reason: 'Duplicate')
+```
+
 ### Inspecting All Defined Events And Current Possible Events
 
 You can get the list of defined events from the model class:
@@ -175,9 +198,9 @@ You can specify relative or absolute output path via environment variable `DEST_
 * Better Error handling
 
 
-## Support Rails Versions
+## Supported Rails Versions
 
-* Rails 4.1.x, 4.2.x, 5.0, 5.1, 5.2, and 6.0 (edge)
+* Rails 4.1.x, 4.2.x, 5.0, 5.1, 5.2, 6.0, 6.1, 7.0, 7.1, 7.2, 8.0, 8.1, and 8.2 (edge)
 
 
 ## Contributing

data/Rakefile

@@ -13,11 +13,3 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task default: :test
-
-namespace :test do
-  task :all do
-    YAML.load(File.read(File.expand_path('.travis.yml')))['gemfile'].each do |gemfile|
-      sh "BUNDLE_GEMFILE='#{gemfile}' bundle exec rake test"
-    end
-  end
-end

data/lib/generators/stateful_enum/graph_generator.rb

@@ -39,7 +39,7 @@ module StatefulEnum
           @g.get_node(final) {|n| n['shape'] = 'doublecircle' }
         end
 
-        @g.output png: File.join((ENV['DEST_DIR'] || Dir.pwd), "#{model.name}.png")
+        @g.output png: File.join((ENV['DEST_DIR'] || Dir.pwd), "#{model.name}_#{column}.png")
       end
 
       def event(name, &block)

data/lib/stateful_enum/active_record_extension.rb

@@ -9,13 +9,31 @@ module StatefulEnum
     #       transition :unassigned => :assigned
     #     end
     #   end
-    def enum(definitions, &block)
-      prefix, suffix = definitions[:_prefix], definitions[:_suffix] if Rails::VERSION::MAJOR >= 5
-      enum = super definitions
+    if Rails::VERSION::MAJOR >= 7
+      def enum(name = nil, values = nil, **options, &block)
+        return super unless block
 
-      if block
-        definitions.each_key do |column|
-          states = enum[column]
+        definitions = super name, values, **options
+
+        if name
+          (@_defined_stateful_enums ||= []) << StatefulEnum::Machine.new(self, name, (definitions.is_a?(Hash) ? definitions.keys : definitions), options[:prefix], options[:suffix], &block)
+        else
+          definitions.each do |column, states|
+            (@_defined_stateful_enums ||= []) << StatefulEnum::Machine.new(self, column, (states.is_a?(Hash) ? states.keys : states), options[:_prefix], options[:_suffix], &block)
+          end
+        end
+
+        definitions
+      end
+    else
+      def enum(definitions, &block)
+        return super unless block
+
+        # Preserving prefix and suffix values before calling super because the super destroys the given Hash
+        prefix, suffix = definitions[:_prefix], definitions[:_suffix] if Rails::VERSION::MAJOR >= 5
+        enum_values = super definitions
+
+        enum_values.each_pair do |column, states|
           (@_defined_stateful_enums ||= []) << StatefulEnum::Machine.new(self, column, (states.is_a?(Hash) ? states.keys : states), prefix, suffix, &block)
         end
       end

data/lib/stateful_enum/machine.rb

@@ -5,7 +5,7 @@ module StatefulEnum
     attr_reader :events
 
     def initialize(model, column, states, prefix, suffix, &block)
-      @model, @column, @states, @events = model, column, states, []
+      @model, @column, @states, @events = model, column, states.map(&:to_sym), []
       @prefix = if prefix
         prefix == true ? "#{column}_" : "#{prefix}_"
       end
@@ -27,7 +27,7 @@ module StatefulEnum
     end
 
     class Event
-      attr_reader :name, :value_method_name
+      attr_reader :name, :value_method_name, :transitions
 
       def initialize(model, column, states, prefix, suffix, name, &block)
         @states, @name, @transitions, @before, @after = states, name, {}, [], []
@@ -42,24 +42,23 @@ module StatefulEnum
           # def assign()
           detect_enum_conflict! column, value_method_name
 
-          # defining callbacks
-          define_callbacks value_method_name
-          before.each do |before_callback|
-            model.set_callback value_method_name, :before, before_callback
-          end
-          after.each do |after_callback|
-            model.set_callback value_method_name, :after, after_callback
-          end
-
-          define_method value_method_name do
+          define_method value_method_name do |*args, **kwargs|
             to, condition = transitions[send(column).to_sym]
             #TODO better error
-            if to && (!condition || instance_exec(&condition))
+            if to && (condition.nil? || instance_exec(&condition))
               #TODO transaction?
-              run_callbacks value_method_name do
-                original_method = self.class.send(:_enum_methods_module).instance_method "#{prefix}#{to}#{suffix}!"
-                original_method.bind(self).call
+              before.each do |before_callback|
+                instance_exec(*args, **kwargs, &before_callback)
               end
+
+              original_method = self.class.send(:_enum_methods_module).instance_method "#{prefix}#{to}#{suffix}!"
+              ret = original_method.bind(self).call
+
+              after.each do |after_callback|
+                instance_exec(*args, **kwargs, &after_callback)
+              end
+
+              ret
             else
               false
             end
@@ -67,8 +66,8 @@ module StatefulEnum
 
           # def assign!()
           detect_enum_conflict! column, "#{value_method_name}!"
-          define_method "#{value_method_name}!" do
-            send(value_method_name) || raise('Invalid transition')
+          define_method "#{value_method_name}!" do |*args, **kwargs|
+            send(value_method_name, *args, **kwargs) || raise('Invalid transition')
           end
 
           # def can_assign?()
@@ -77,7 +76,7 @@ module StatefulEnum
             state = send(column).to_sym
             return false unless transitions.key? state
             _to, condition = transitions[state]
-            !condition || instance_exec(&condition)
+            condition.nil? || instance_exec(&condition)
           end
 
           # def assign_transition()

data/lib/stateful_enum/state_inspection.rb

@@ -37,7 +37,7 @@ module StatefulEnum
       @defined_stateful_enums.flat_map do |stateful_enum|
         col = stateful_enum.instance_variable_get :@column
         pe = stateful_enum.events.select {|e| @model_instance.send("can_#{e.value_method_name}?") }
-        pe.flat_map {|e| e.instance_variable_get(:@transitions)[@model_instance.send(col).to_sym].first }
+        pe.flat_map {|e| e.transitions[@model_instance.send(col).to_sym].first }
       end
     end
   end

data/lib/stateful_enum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StatefulEnum
-  VERSION = '0.6.0'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: stateful_enum
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Akira Matsuda
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,21 +100,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - MIT-LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- gemfiles/Gemfile-rails.4.1.x
-- gemfiles/Gemfile-rails.4.2.x
-- gemfiles/Gemfile-rails.5.0.x
-- gemfiles/Gemfile-rails.5.1.x
-- gemfiles/Gemfile-rails.5.2.x
-- gemfiles/Gemfile-rails.6.0.x
-- gemfiles/Gemfile-rails.edge
 - lib/generators/stateful_enum/graph_generator.rb
 - lib/generators/stateful_enum/plantuml_generator.rb
 - lib/stateful_enum.rb
@@ -129,7 +121,6 @@ homepage: https://github.com/amatsuda/stateful_enum
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -144,8 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A state machine plugin on top of ActiveRecord::Enum
 test_files: []

data/.travis.yml

@@ -1,47 +0,0 @@
-language: ruby
-
-sudo: false
-
-cache:
-  - apt
-  - bundler
-before_install:
-  - gem i bundler -v '<2'
-
-addons:
-  apt:
-    packages:
-      - graphviz
-
-matrix:
-  include:
-    - rvm: 2.6.0
-      gemfile: gemfiles/Gemfile-rails.6.0.x
-
-    - rvm: 2.6.0
-      gemfile: gemfiles/Gemfile-rails.5.2.x
-    - rvm: 2.6.0
-      gemfile: gemfiles/Gemfile-rails.5.1.x
-    - rvm: 2.6.0
-      gemfile: gemfiles/Gemfile-rails.5.0.x
-
-    - rvm: 2.5.3
-      gemfile: gemfiles/Gemfile-rails.4.2.x
-
-    - rvm: 2.3.8
-      gemfile: gemfiles/Gemfile-rails.4.1.x
-
-    - rvm: 2.4.5
-      gemfile: gemfiles/Gemfile-rails.5.2.x
-    - rvm: 2.2.10
-      gemfile: gemfiles/Gemfile-rails.5.2.x
-
-    - rvm: ruby-head
-      gemfile: gemfiles/Gemfile-rails.5.2.x
-
-    - rvm: 2.6.0
-      gemfile: gemfiles/Gemfile-rails.edge
-
-  allow_failures:
-    - rvm: ruby-head
-    - gemfile: gemfiles/Gemfile-rails.edge

data/gemfiles/Gemfile-rails.4.1.x

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec path: '..'
-
-gem 'rails', '~> 4.1.0'
-gem 'sqlite3', '~> 1.3.6'

data/gemfiles/Gemfile-rails.4.2.x

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec path: '..'
-
-gem 'rails', '~> 4.2.0'
-gem 'sqlite3', '~> 1.3.6'

data/gemfiles/Gemfile-rails.5.0.x

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec path: '..'
-
-gem 'rails', '~> 5.0.0'
-gem 'sqlite3', '~> 1.3.6'

data/gemfiles/Gemfile-rails.5.1.x

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec path: '..'
-
-gem 'rails', '~> 5.1.0'
-gem 'sqlite3', '~> 1.3.6'

data/gemfiles/Gemfile-rails.5.2.x

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec path: '..'
-
-gem 'rails', '~> 5.2.0'
-gem 'sqlite3', '~> 1.3.6'

data/gemfiles/Gemfile-rails.6.0.x

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec path: '..'
-
-gem 'rails', '~> 6.0.0.rc1'
-gem 'selenium-webdriver'

data/gemfiles/Gemfile-rails.edge

@@ -1,14 +0,0 @@
-source 'https://rubygems.org'
-
-git_source(:github) do |repo_name|
-  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
-  "https://github.com/#{repo_name}.git"
-end
-
-gemspec path: '..'
-
-github 'rails/rails' do
-  gem 'rails'
-end
-gem 'sqlite3'
-gem 'selenium-webdriver'