machina 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d67cfd0648b85a02e58ce0f287c24a5f2a2424ff50ac949b1272f44885cb3f77
+  data.tar.gz: 341433286e327508944bd8fac79640b0be466288629fe02f4c296ba3f3ea01cd
+SHA512:
+  metadata.gz: 8e34227ae96d02e0682e7c3a489d318baffcb95b91d6068b740010e4640f1f3bad6da62e03683ce259bfd8db02032aae4a23392d54c951140ee6fd185b2e24d3
+  data.tar.gz: edefe97cd25753f5d7458502cc625817b3204c0957e5351eb3a2ef9889dea8e72f22b0ac315ef521ccc8ba94b52aff0c7f28b2c3693a7ea0d428cc1c4ec3c371

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    machina (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  machina!
+
+BUNDLED WITH
+   1.17.2

data/Makefile

@@ -0,0 +1,13 @@
+.PHONY: *
+
+default: test
+
+build:
+	rm *.gem
+	gem build machina.gemspec
+
+publish: build
+	gem push *.gem
+
+test:
+	ruby -Ilib:spec spec/*_spec.rb

data/README.md

@@ -0,0 +1,22 @@
+# Machina
+
+_a god introduced by means of a crane in ancient Greek and Roman drama to decide the final outcome_
+
+![](https://theatricaleffectsandstaging.files.wordpress.com/2016/05/untitled1.png?w=390&h=326)
+
+```ruby
+fsm = Machina.new(:unconfirmed)
+
+fsm.when[:welcome_email] = -> { send_welcome_email }
+fsm.when[:enable_account] = -> (user) { user.enabled! }
+
+fsm[:confirm] = {
+  :unconfirmed => [:welcome_email, :enable_account, :confirmed],
+}
+
+fsm.on[:confirm] = -> (user) { puts "Starting confirmation process for #{user.id}." }
+
+fsm.state # => :unconfirmed
+fsm.trigger!(:confirm, user)
+fsm.state # => :confirmed
+```

data/lib/machina.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+class Machina
+  InvalidEventError = Class.new(StandardError)
+  InvalidStateChangeError = Class.new(StandardError)
+
+  EVENT = -> (h, k) { h[k] = ->(*args) {} }
+
+  attr_reader :state, :events
+
+  # Initializes Machina
+  #
+  # @param initial_state [Symbol] the initial state of the state machine
+  # @return [Machina] the initialized Machina
+  #
+  def initialize(initial_state)
+    @state = initial_state
+    @events = Hash.new { |h, k| h[k] = [] }
+  end
+
+  # Triggers an event.
+  #
+  # @param event [Symbol] the event to trigger
+  # @param args [Array<Object>] the objects that the callback will receive
+  # @return [void]
+  #
+  def trigger(event, *args)
+    return unless trigger?(event)
+
+    Array(events[event][state]).each do |candidate_state|
+      begin
+        self.when[candidate_state].call(*args)
+      rescue StandardError
+        break
+      end
+
+      @state = candidate_state
+    end
+
+    on[event].call(*args)
+  end
+
+  # Triggers an event and raises on error.
+  #
+  # @param event [Symbol] the event to trigger
+  # @param args [Array<Object>] the objects that the callback will receive
+  # @return [void]
+  #
+  def trigger!(event, *args)
+    raise InvalidStateChangeError, "Event #{event} missing #{state} step" unless trigger?(event)
+
+    trigger(event, *args)
+  end
+
+  # Checks if an event can be triggered
+  #
+  # @param event [Symbol] the event to trigger
+  # @return [Boolean] the chance posibility
+  #
+  def trigger?(event)
+    raise InvalidEventError, "Event #{event} not found." unless events.key?(event)
+
+    events[event].key?(state)
+  end
+
+  # Defines the list of possible callbacks when an event is triggered
+  #
+  # @return [Hash]
+  #
+  def on
+    @on ||= Hash.new(&EVENT)
+  end
+
+  # Defines the list of possible callbacks when a state is reached
+  #
+  # @return [Hash]
+  #
+  def when
+    @when ||= Hash.new(&EVENT)
+  end
+
+  # Defines the list of possible events and their transitions
+  #
+  # @param key [Symbol] the event name
+  # @param states [Hash] the event transitions
+  # @return [void]
+  #
+  def []=(key, states)
+    events[key] = states
+  end
+end

data/machina.gemspec

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name              = "machina"
+  s.version           = "0.0.1"
+  s.summary           = "Simple state machine"
+  s.description       = "Really really simple state machine"
+  s.authors           = ["elcuervo"]
+  s.licenses          = %w[MIT HUGWARE]
+  s.email             = ["elcuervo@elcuervo.net"]
+  s.homepage          = "http://github.com/elcuervo/machina"
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files test`.split("\n")
+end

data/spec/machina_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+
+
+Post = Struct.new(:title, :notified, :published)
+
+describe Machina do
+  attr_reader :fsm
+
+  before { @fsm = Machina.new(:start) }
+
+  it "basic" do
+    fsm[:begin] = { :start => :step1 }
+
+    assert_equal :start, fsm.state
+
+    fsm.trigger(:begin)
+
+    assert_equal :step1, fsm.state
+  end
+
+  it "complex" do
+    post = Post.new("Something HN worthy", false, false)
+    completed = false
+
+    fsm.when[:send_notification] = -> (post) { post.notified = true }
+    fsm.when[:published] = -> (post) { post.published = true }
+
+    fsm[:complete] = {
+      :start  => [:review, :send_notification, :published],
+      :review => [:send_notification, :published],
+      :reset  => :start
+    }
+
+    fsm.on[:complete] = -> (_post) { completed = true }
+
+    assert_equal :start, fsm.state
+    assert_equal false, completed
+    assert_equal false, post.notified
+    assert_equal false, post.published
+
+    fsm.trigger(:complete, post)
+
+    assert_equal :published, fsm.state
+    assert_equal true, completed
+    assert_equal true, post.notified
+    assert_equal true, post.published
+  end
+
+  it "stops on error" do
+    fsm.when[:stop] = -> { raise }
+
+    fsm[:act] = {
+      :start => [:a, :b, :stop, :final]
+    }
+
+    fsm.trigger(:act)
+
+    assert_equal :b, fsm.state
+  end
+
+  it "trigger!" do
+    fsm[:one] = {
+      :not_start => :reset
+    }
+
+    assert_raises(Machina::InvalidStateChangeError) { fsm.trigger!(:one) }
+    assert_raises(Machina::InvalidEventError)       { fsm.trigger!(:two) }
+
+    assert_equal :start, fsm.state
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "minitest/autorun"
+require "machina"

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: machina
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- elcuervo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-04 00:00:00.000000000 Z
+dependencies: []
+description: Really really simple state machine
+email:
+- elcuervo@elcuervo.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Makefile
+- README.md
+- lib/machina.rb
+- machina.gemspec
+- spec/machina_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/elcuervo/machina
+licenses:
+- MIT
+- HUGWARE
+metadata: {}
+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.3
+signing_key: 
+specification_version: 4
+summary: Simple state machine
+test_files: []