state_machine_enum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c62f9ef7d3062c2cfec2c914d2b4bdcb8dbd38621e7317af107d0ce65edf88ef
+  data.tar.gz: 98f294f99cb3943dd145874afef82add8533816a863a35411511cc32a7447826
+SHA512:
+  metadata.gz: 213b039f7fe5b20f9a68306f17ae10d044bf56107d33d4cd0ad0c03c86d3c01a3bb963df8ccc117b3dda9a1cfe324dc5647adb77da0c0f33c57f293153a079ec
+  data.tar.gz: 490ec1ce157ce84481dd36e0973fa2601cc1638503b2769f04d60010527b81db4c9f208b1d6dfe285b81e65e143cfbaec802e55b8b6ee047af9a672bd0bedc3d

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Stanislav Katkov
+
+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,60 @@
+# StateMachineEnum
+
+This concern adds a method called "state_machine_enum" useful for defining an enum using string values along with valid state transitions. Validations will be added for the state transitions and a proper enum is going to be defined. For example:
+
+```ruby
+state_machine_enum :state do |states|
+  states.permit_transition(:created, :approved_pending_settlement)
+  states.permit_transition(:approved_pending_settlement, :rejected)
+  states.permit_transition(:created, :rejected)
+  states.permit_transition(:approved_pending_settlement, :settled)
+end
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add state_machine_enum
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install state_machine_enum
+
+## Usage
+
+StateMachineEnum needs to be extended and then it could be used, as example in AR model.
+
+```
+class User < ApplicationRecord
+  include StateMachineEnum
+
+  state_machine_enum :state do |s|
+    s.permit_transition(:registered, :active)
+    s.permit_transition(:active, :banned)
+    s.permit_transition(:banned, :active)
+    s.permit_transition(:active, :deleted)
+  end
+end
+```
+
+And then it will offer bunch of convenient methods and callbacks that ensure proper state transitions.
+
+```
+user = User.new(state: 'registered')
+user.active?
+user.registered! # throws InvalidState error, because state can not transition to "registered".
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/cheddar-me/state_machine_enum.
+
+## 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,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/state_machine_enum/version.rb

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

data/lib/state_machine_enum.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require_relative "state_machine_enum/version"
+require "active_support/concern"
+
+# This concern adds a method called "state_machine_enum" useful for defining an enum using
+# string values along with valid state transitions. Validations will be added for the
+# state transitions and a proper enum is going to be defined. For example:
+#
+#   state_machine_enum :state do |states|
+#     states.permit_transition(:created, :approved_pending_settlement)
+#     states.permit_transition(:approved_pending_settlement, :rejected)
+#     states.permit_transition(:created, :rejected)
+#     states.permit_transition(:approved_pending_settlement, :settled)
+#   end
+
+module StateMachineEnum
+  extend ActiveSupport::Concern
+
+  class StatesCollector
+    attr_reader :states
+    attr_reader :after_commit_hooks
+    attr_reader :common_after_commit_hooks
+    attr_reader :after_attribute_write_hooks
+    attr_reader :common_after_write_hooks
+
+    def initialize
+      @transitions = Set.new
+      @states = Set.new
+      @after_commit_hooks = {}
+      @common_after_commit_hooks = []
+      @after_attribute_write_hooks = {}
+      @common_after_write_hooks = []
+    end
+
+    def permit_transition(from, to)
+      @states << from.to_s << to.to_s
+      @transitions << [from.to_s, to.to_s]
+    end
+
+    def may_transition?(from, to)
+      @transitions.include?([from.to_s, to.to_s])
+    end
+
+    def after_inline_transition_to(target_state, &blk)
+      @after_attribute_write_hooks[target_state.to_s] ||= []
+      @after_attribute_write_hooks[target_state.to_s] << blk.to_proc
+    end
+
+    def after_committed_transition_to(target_state, &blk)
+      @after_commit_hooks[target_state.to_s] ||= []
+      @after_commit_hooks[target_state.to_s] << blk.to_proc
+    end
+
+    def after_any_committed_transition(&blk)
+      @common_after_commit_hooks << blk.to_proc
+    end
+
+    def validate(model, attribute_name)
+      return unless model.persisted?
+
+      was = model.attribute_was(attribute_name)
+      is = model[attribute_name]
+
+      unless was == is || @transitions.include?([was, is])
+        model.errors.add(attribute_name, "Invalid transition from #{was} to #{is}")
+      end
+    end
+  end
+
+  class InvalidState < StandardError
+  end
+
+  class_methods do
+    def state_machine_enum(attribute_name, **options_for_enum)
+      # Collect the states
+      collector = StatesCollector.new
+      yield(collector).tap do
+        # Define the enum using labels, with string values
+        enum_map = collector.states.map(&:to_sym).zip(collector.states.to_a).to_h
+        enum(attribute_name, enum_map, **options_for_enum)
+
+        # Define validations for transitions
+        validates attribute_name, presence: true
+        validate { |model| collector.validate(model, attribute_name) }
+
+        # Define inline hooks
+        before_save do |model|
+          _value_was, value_has_become = model.changes[attribute_name]
+          next unless value_has_become
+          hook_procs = collector.after_attribute_write_hooks[value_has_become].to_a + collector.common_after_write_hooks.to_a
+          hook_procs.each do |hook_proc|
+            hook_proc.call(model)
+          end
+        end
+
+        # Define after commit hooks
+        after_commit do |model|
+          _value_was, value_has_become = model.previous_changes[attribute_name]
+          next unless value_has_become
+          hook_procs = collector.after_commit_hooks[value_has_become].to_a + collector.common_after_commit_hooks.to_a
+          hook_procs.each do |hook_proc|
+            hook_proc.call(model)
+          end
+        end
+
+        # Define the check methods
+        define_method(:"ensure_#{attribute_name}_one_of!") do |*allowed_states|
+          val = self[attribute_name]
+          return if Set.new(allowed_states.map(&:to_s)).include?(val)
+          raise InvalidState, "#{attribute_name} must be one of #{allowed_states.inspect} but was #{val.inspect}"
+        end
+
+        define_method(:"ensure_#{attribute_name}_may_transition_to!") do |next_state|
+          val = self[attribute_name]
+          raise InvalidState, "#{attribute_name} already is #{val.inspect}" if next_state.to_s == val
+        end
+
+        define_method(:"#{attribute_name}_may_transition_to?") do |next_state|
+          val = self[attribute_name]
+          return false if val == next_state.to_s
+          collector.may_transition?(val, next_state)
+        end
+      end
+    end
+  end
+end

data/sig/state_machine_enum.rbs

@@ -0,0 +1,4 @@
+module StateMachineEnum
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: state_machine_enum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stanislav Katkov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Concern that makes it easy to define and enforce possibe state transitions
+  for a field/object
+email:
+- skatkov@cheddar.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/state_machine_enum.rb
+- lib/state_machine_enum/version.rb
+- sig/state_machine_enum.rbs
+homepage: https://cheddar.me
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://cheddar.me
+  source_code_uri: https://github.com/cheddar-me/state_machine_enum
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Define possible state transitions for a field
+test_files: []