activerecord-fsm 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b281902b922a683073baf632654a0657f7e9bdbb3c3348960491432428a68444
+  data.tar.gz: 157d440eb10fd597a283e677c6f698c2cf5b76e3888599a0d26d960678132eca
+SHA512:
+  metadata.gz: 696e9bc135f6c6b755102e5fb535a941bebf6d9e1fd224312673b889bb9ee1628b7551aa1cc939fc520b9570f9eff8495aa7470b3946e87dcbb2a2a5595c1524
+  data.tar.gz: e9d4c60a0d9eed133867c619bdf4558cdbb31766f225c3d892f55f5a76ed2eb691f745c8ae7b468d1aa91b0e9cb4001cf634788735acb5bd918ceaa6e8690a30

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in activerecord-fsm.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    activerecord-fsm (0.1.1)
+      activerecord (>= 5.2, < 7.0)
+      activesupport (>= 5.2, < 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3)
+      activesupport (= 6.0.3)
+    activerecord (6.0.3)
+      activemodel (= 6.0.3)
+      activesupport (= 6.0.3)
+    activesupport (6.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.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.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      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.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-fsm!
+  pry (~> 0.10)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 ElliotCui
+
+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,91 @@
+# ActiveRecord::Fsm
+
+A simple Finite State Machine.  
+Use this gem to auto define Finite State Machine on ActiveRecord with one column named `status`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-fsm'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install activerecord-fsm
+
+Maybe you need to do migration, add one column named `status`:
+
+    bin/rails generate migration AddStatusToFsmModel status:integer:index  
+    # or you can specify column type
+    bin/rails generate migration AddStatusToFsmModel status:{column_type}:index
+
+## Usage
+
+1. Include `ActiveRecord::Fsm` into `ApplicationRecord/ActiveRecord::Base` or directly into `FsmModel`.  
+2. Use `#fsm_define` to arrange permit_transitions set in which status can be transitioned from one to another. This will add:
+    
+        validates :status, presence: true, inclusion: { in: self.fsm_graph.states }
+        validate :fsm_graph_check_permit_transitions, on: :update, if: :will_save_change_to_status?
+
+    `fsm_graph_check_permit_transitions` has been defined as:
+    ```
+      def fsm_graph_check_permit_transitions
+        unless self.class.fsm_graph.valid_transition?(*self.status_change)
+          self.errors.add(:status, 'no permit status change')
+          throw :abort
+        end
+      end
+    ```
+    **Model without using `fsm_define` will only act as the same with `NomalModel` which doesn't has fsm mechanic.**  
+    In other words, using `fsm_define` will make `NomalModel` become `FsmModel`.
+
+3. Use `FsmModel.fsm_graph.states` to get permit_transition you defined.
+4. Use `ActiveRecord::Fsm::Graph.defined_klasses` to get all the models which really used `ActiveRecord::Fsm`.
+
+e.g.  
+
+```ruby
+class FsmModel < ApplicationRecord
+  STATE_1 = 1
+  STATE_2 = 2
+  STATE_3 = 3
+
+  PERMIT_TRANSITIONS = [
+    [STATE_1, STATE_2],
+    [STATE_2, STATE_3],
+    [STATE_1, STATE_3],
+  ]
+
+  fsm_define(PERMIT_TRANSITIONS)
+end
+
+ActiveRecord::Fsm::Graph.defined_klasses
+# => [FsmModel]
+
+class NormalModel < ApplicationRecord
+end
+
+ActiveRecord::Fsm::Graph.defined_klasses
+# => [FsmModel]
+```
+
+## 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]/activerecord-fsm.
+
+
+## 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/activerecord-fsm.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/activerecord/fsm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-fsm"
+  spec.version       = ActiveRecord::Fsm::VERSION
+  spec.authors       = ["ElliotCui"]
+  spec.email         = ["cuiyi.plus@gmail.com"]
+
+  spec.summary       = "A simple Finite State Machine."
+  spec.description   = "Use this gem to auto define Finite State Machine on ActiveRecord with one column named `status`."
+  spec.homepage      = "https://github.com/ElliotCui/activerecord-fsm"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 5.2", "< 7.0"
+  spec.add_dependency "activesupport", ">= 5.2", "< 7.0"
+
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/fsm"
+
+# 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/activerecord/fsm.rb

@@ -0,0 +1,34 @@
+require "activerecord/fsm/graph"
+
+module ActiveRecord
+  module Fsm
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      attr_accessor :fsm_graph
+
+      def fsm_define(transitions)
+        self.class_eval do
+          private
+
+          def fsm_graph_check_permit_transitions
+            unless self.class.fsm_graph.valid_transition?(*self.status_change)
+              self.errors.add(:status, 'no permit status change')
+              throw :abort
+            end
+          end
+        end
+
+        ActiveRecord::Fsm::Graph.defined_klasses << self
+        self.fsm_graph = ActiveRecord::Fsm::Graph.new(transitions)
+
+        validates :status, presence: true, inclusion: { in: self.fsm_graph.states }
+        validate :fsm_graph_check_permit_transitions, on: :update, if: :will_save_change_to_status?
+
+        self.fsm_graph
+      end
+    end
+
+    class Error < StandardError; end
+  end
+end

data/lib/activerecord/fsm/graph.rb

@@ -0,0 +1,29 @@
+module ActiveRecord
+  module Fsm
+    class Graph
+      attr_accessor :transitions, :states, :final_states
+
+      def initialize(transitions)
+        @transitions = transitions
+        @states = transitions.flatten.uniq
+        @final_states = transitions.map(&:last) - transitions.map(&:first)
+      end
+
+      def valid_transition?(cur_state, tar_state)
+        transitions.include?([cur_state, tar_state])
+      end
+
+      def final_state?(state)
+        final_states.include?(state)
+      end
+
+      class << self
+        attr_writer :defined_klasses
+
+        def defined_klasses
+          @defined_klasses ||= []
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/fsm/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Fsm
+    VERSION = "0.1.1"
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-fsm
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- ElliotCui
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Use this gem to auto define Finite State Machine on ActiveRecord with
+  one column named `status`.
+email:
+- cuiyi.plus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-fsm.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord/fsm.rb
+- lib/activerecord/fsm/graph.rb
+- lib/activerecord/fsm/version.rb
+homepage: https://github.com/ElliotCui/activerecord-fsm
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ElliotCui/activerecord-fsm
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: A simple Finite State Machine.
+test_files: []