mini-aasm 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84be5609986ebac0b4a28f3ac8ee3e484b74e230926c2ca9315c11099f074e09
+  data.tar.gz: 51c35e5155e38b8f1386191c684d2e8a2ad2962b4a9cd96b6aa1e38e4e21c7a1
+SHA512:
+  metadata.gz: 9e82f17fc45134a2698fe728700305b60d30460e2ba2ef03386490c7e1df0ee0283e83a35d0c794884953393ce782750b3873332f2e1c8d759dabbffa160a306
+  data.tar.gz: d2db46d854bc7e62bc73f61499be1255a55c4ec8c791266e7d4cd07f6af101d393d3c86803b41033d3d44e49aebf7cabc0b81c73797888638b597e393c8186f9

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.5.3
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,38 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - mini-aasm.gemspec
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/BlockLength:
+  Max: 50
+
+Style/Documentation:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/mini-aasm.rb
+
+Lint/UnderscorePrefixedVariableName:
+  Exclude:
+    - lib/mini-aasm.rb

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mini-aasm.gemspec
+gemspec
+
+gem "minitest"
+gem "minitest-reporters"
+gem "pry", require: true
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 0.80"
+gem "rubocop-minitest", require: false
+gem "rubocop-rake", require: false

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    mini-aasm (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    minitest-reporters (1.5.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-minitest (0.19.1)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  mini-aasm!
+  minitest
+  minitest-reporters
+  pry
+  rake (~> 13.0)
+  rubocop (~> 0.80)
+  rubocop-minitest
+  rubocop-rake
+
+BUNDLED WITH
+   2.2.3

data/README.md

@@ -0,0 +1,82 @@
+# MiniAASM
+
+A State Machine library intended to be compatible with lightweight implementations of the Ruby language using 100LOC and only standard libraries. Inspired by [Heroku Postgres State Machines](https://www.citusdata.com/blog/2016/08/12/state-machines-to-run-databases/).
+
+## Usage
+
+```ruby
+class PeriodicJob
+  include MiniAASM
+
+  aasm do
+    state :waiting, initial: true
+    state :executing
+    state :terminated
+
+    event :work_succeeded do
+      transitions from: :executing, to: :waiting
+      transitions from: :waiting, to: :executing, guard: %i[ready?]
+    end
+
+    event :work_failed do
+      transitions from: %i[waiting executing], to: :terminated
+    end
+
+    # ...
+  end
+end
+```
+
+_See [test/support/periodic_job.rb](test/support/periodic_job.rb)._
+
+```ruby
+> job = PeriodicJob.new
+=> #<PeriodicJob:0x000055de0c03ec98>
+> job.current_state
+=> :waiting
+job.work_succeeded!
+=> :executing
+> job.work_succeeded!
+=> :waiting
+> job.work_failed!
+=> :terminated
+```
+
+```ruby
+> job = PeriodicJob.new(ready: false)
+=> #<PeriodicJob:0x000055de0c11e528>
+> job.work_succeeded!
+MiniAASM::InvalidTransition: MiniAASM::InvalidTransition
+```
+
+## Best Practice
+
+1. The state machine should be trying to converge an eventually consistent end state which looks like a status.
+2. States should be separated into atomic units of work.
+3. State transitions should be invoked in an idempotent way.
+  
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mini-aasm'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install mini-aasm
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/mini-aasm.

data/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+# Test
+
+require "rake/testtask"
+
+Rake::TestTask.new do |task|
+  task.libs << "test" # require File.expand_path('test/test_helper', File.dirname(__FILE__))
+  task.pattern = "test/*_test.rb"
+end
+
+# Lint
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new do |task|
+  task.requires << "rubocop-rake"
+  task.requires << "rubocop-minitest"
+end
+
+# Default
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "mini-aasm"
+
+# 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/mini-aasm.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "mini_aasm/version"
+
+module MiniAASM
+  class InvalidTransition < RuntimeError; end
+  class UndefinedState < RuntimeError; end
+
+  class Configuration
+    module DSL
+      module ClassMethods
+        def aasm(&block)
+          config = Configuration.new(self)
+          config.instance_eval(&block)
+          config.configure!
+        end
+      end
+
+      class StateTransitions < Array
+        attr_reader :name
+
+        def initialize(name)
+          @name = name
+
+          super()
+        end
+
+        def transitions(from:, to:, guard: [])
+          self << [[from].flatten, to, [guard].flatten]
+        end
+      end
+
+      def state(name, opts = {})
+        states[name] = opts
+      end
+
+      def event(name, &block)
+        event = StateTransitions.new(name)
+        event.instance_eval(&block)
+        events[name] = event
+      end
+    end
+
+    include DSL
+
+    attr_reader :klass, :states, :events
+
+    def initialize(klass)
+      @klass = klass
+      @states = {}
+      @events = {}
+    end
+
+    def configure!
+      _aasm = self
+
+      klass.define_method(:_aasm) { _aasm }
+
+      klass.define_method(:states) do
+        _aasm.states.keys
+      end
+
+      klass.define_method(:current_state) do
+        @current_state ||= _aasm.initial_state
+      end
+
+      klass.define_method(:set_current_state) do |state|
+        raise UndefinedState unless states.include?(state)
+
+        @current_state = state
+      end
+
+      events.each do |(name, event)|
+        klass.define_method(:"#{name}!") do
+          transitions = event.select { |(from_states, _)| from_states.include?(current_state) }
+          _, to_state = transitions.find { |(_, _, guards)| guards.all? { |guard| send(guard) } }
+
+          raise InvalidTransition unless to_state
+
+          set_current_state to_state
+        end
+      end
+    end
+
+    def initial_state
+      states.find { |(_name, opts)| opts[:initial] }.first
+    end
+  end
+
+  def self.included(klass)
+    klass.extend Configuration::DSL::ClassMethods
+  end
+end

data/lib/mini_aasm/version.rb

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

data/mini-aasm.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/mini_aasm/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mini-aasm"
+  spec.version       = MiniAASM::VERSION
+  spec.authors       = ["James Moriarty"]
+  spec.email         = ["jamespaulmoriarty@gmail.com"]
+
+  spec.summary       = "A State Machine library intended to be compatible with lightweight implementations of the Ruby language."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/jamesmoriarty/mini-aasm"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jamesmoriarty/mini-aasm"
+  spec.metadata["changelog_uri"] = "https://github.com/jamesmoriarty/mini-aasm/CHANGELOG.md"
+
+  # 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{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: mini-aasm
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- James Moriarty
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-01-25 00:00:00.000000000 Z
+dependencies: []
+description: A State Machine library intended to be compatible with lightweight implementations
+  of the Ruby language.
+email:
+- jamespaulmoriarty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mini-aasm.rb
+- lib/mini_aasm/version.rb
+- mini-aasm.gemspec
+homepage: https://github.com/jamesmoriarty/mini-aasm
+licenses: []
+metadata:
+  homepage_uri: https://github.com/jamesmoriarty/mini-aasm
+  source_code_uri: https://github.com/jamesmoriarty/mini-aasm
+  changelog_uri: https://github.com/jamesmoriarty/mini-aasm/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: A State Machine library intended to be compatible with lightweight implementations
+  of the Ruby language.
+test_files: []