fmm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70e6ddb7251def8d0c06d8ed0f3ad5d87c34dd2b
+  data.tar.gz: 3cad9dc7ffea1523e9756218fc1bab6f6a457dbe
+SHA512:
+  metadata.gz: 04f799b649ec15779c7c972225d569146b3dae1c47c12ee463d9dfe9557ccc4bdc809a9bf00bf0adf1b892af3e38c753f162477b4a7a065577145653b2b821d9
+  data.tar.gz: 5170b666468f20d802f2904bb79c8742f9965ca7421a165ec529d6d14320a60047c0a0b62bf6efb80b25c8290e2a2349510351611e10cfd34bf1e422fd55eac8

data/.gitignore

@@ -0,0 +1,7 @@
+.*.swp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 EC
+
+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,17 @@
+
+# FMM
+
+FMM is short for "functional micromachines;" it is based on 
+the [micromachine](https://github.com/soveran/micromachine/)
+gem, a nicely compact little finite state machine implementation.
+
+Micromachine is an imperative design, based on the methods and 
+mutable state of an instance of class `MicroMachine`. FMM takes 
+a functional approach, where (a) the state machine operations
+are pure functions that take the current state as an argument
+and return an updated state, and (b) instead of building
+the machine imperatively by calls to `machine.on(...)`, we
+assume the machine is given as a data structure of a certain
+format. (A validation method is included.) 
+
+Updates soon. In the meantime, have a look at the test suite.

data/fmm.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name = "fmm"
+  s.version = "0.1.0"
+  s.summary = %{FMM: a minimal finite state machine with functional leanings}
+  s.description = %Q{FMM is a small finite state machine implementation based on Michael Martens' micromachine, but recast in the idioms of functional programming: instead of mutable state we use arguments and return values, and instead of methods bound to an instance of a class like MicroMachine, we provide utility functions that operate on any suitable data structure.}
+  s.author = ["Erik Cameron"]
+  s.email = ["root@erikcameron.org"]
+  s.homepage = "http://github.com/erikcameron/fmm"
+  s.license = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_development_dependency "rspec", "~> 0"
+end

data/lib/fmm.rb

@@ -0,0 +1,176 @@
+module FMM
+  class InvalidEvent < NoMethodError; end
+  class InvalidState < ArgumentError; end
+  class InvalidMachine < TypeError; end   # this is ultimately a data error
+
+  extend self
+
+  # validate a state machine; defacto specification; no
+  # state for which this method returns true should ever
+  # crash with an InvalidMachine error
+  def validate!(state)
+    # The state is a Hash-like object (HLO) with a value
+    # at key :_machine
+    unless state[:_machine]
+      raise InvalidMachine, "no state machine found: #{state}"
+    end
+
+    # The machine has a current state 
+    unless state[:_machine][:current]
+      raise InvalidMachine, "no current state: #{state}"
+    end
+
+    # The machine specifies a set of transitions (and hence states)
+    unless state[:_machine][:transitions]
+      raise InvalidMachine, "you must specify some transitions: #{state}"
+    end
+
+    # The transitions table must be a HLO...
+    unless state[:_machine][:transitions].is_a?(Hash)
+      raise InvalidMachine, "transitions must be a hash: #{state}"
+    end
+
+    # ...all of whose values are also HLOs
+    unless state[:_machine][:transitions].values.map { |v| v.is_a?(Hash) }.inject(:&)
+      raise InvalidMachine, "transitions must be a hash of hashes: #{state}"
+    end
+      
+    # Callbacks (which are all post-transition; see below) are optional,
+    # but if they exist...
+    if state[:_machine][:callbacks]
+      # ...they must be in a HLO...
+      unless state[:_machine][:callbacks].is_a?(Hash)
+        raise InvalidMachine, "callbacks must be a hash: #{state}"
+      end
+      
+      # ...whose values are either callables or collections thereof
+      valid_callbacks = state[:_machine][:callbacks].values.flatten.map do |v| 
+        v.respond_to?(:call)
+      end.inject(:&)
+      
+      unless valid_callbacks
+        raise InvalidMachine, "callbacks must be callables or arrays thereof: #{state}"
+      end
+    end
+   
+    # Aliases are optional, but if they exist...
+    if state[:_machine][:aliases]
+      # ...they must be in a HLO. This is all we can actually
+      # say about aliases, other than this: The keys of this
+      # HLO correspond to states, but can be of any type; 
+      # nonexistent states simply won't be consulted. Similarly,
+      # the values are all either names of states or collections 
+      # thereof, but that doesn't actually place any type limitation
+      # on what the values _are_, other than not letting them be
+      # arrays, because they will be flattened.
+      unless state[:_machine][:aliases].is_a?(Hash)
+        raise InvalidMachine, "aliases must be a hash: #{state}"
+      end
+    end
+    true
+  end
+        
+  # trigger state changes
+ 
+  def trigger(state, event, payload = nil)
+    payload.freeze if payload.respond_to?(:freeze)
+    trigger?(state, event) and change(state, event, payload)
+  end
+
+  def trigger!(state, event, payload = nil)
+    trigger(state, event, payload) or
+      raise InvalidState, "Event '#{event}' not valid from state :'#{current(state)}'"
+  end
+
+  # talk to the machine object
+  
+  def current(state)
+    state[:_machine][:current]
+  rescue => err
+    # reraise as an explicit InvalidMachine;
+    # get the orig out of #cause
+    raise InvalidMachine, '#current'
+  end  
+
+  def transitions(state)
+    state[:_machine][:transitions]
+  rescue => err
+    raise InvalidMachine, '#transitions'
+  end
+
+  def callbacks(state)
+    state[:_machine][:callbacks]  || {}
+  rescue => err
+    raise InvalidMachine, '#callbacks'
+  end
+
+  def aliases_for(state)
+    state[:_machine][:aliases] ? state[:_machine][:aliases][current(state)] : nil
+  end
+
+  # from most to least specific, as this is the order
+  # in which we will resolve available transitions
+  # and run callbacks
+  def all_names_for(state)
+    [ current(state), aliases_for(state), :* ].flatten
+  end
+
+  def trigger?(state, event)
+    unless transitions(state).has_key?(event)
+      raise InvalidEvent, "no such event #{event}"
+    end
+    resolve_next_state_name(state, event) ? true : false
+  end
+
+  def events(state)
+    transitions(state).keys
+  end
+
+  def triggerable_events(state)
+    events(state).select { |event| trigger?(state, event) }
+  end
+
+  def machine_states(state)
+    transitions(state).values.map(&:to_a).flatten.uniq
+  end
+
+private
+
+  # 
+  # the elbow grease
+  #
+  # there was a whole one-person debate here about the
+  # point/utility of pre-transition callbacks; if they
+  # actually prove to be something useful, we can add them
+  # without breaking existing machines. ([:_machine][:before],
+  # at which point, we can just construe [:_machine][:callbacks]
+  # as synonymous with [:post]) for now, i don't really see what 
+  # purpose they serve in this sort of application other than 
+  # being able to veto state changes, maybe; for now i say poo 
+  # on them
+
+  def change(state, event, payload)
+    state   = update_machine_state(state, resolve_next_state_name(state, event))
+    # post callbacks; these we very much want
+    resolve_callbacks(state).each do |callback|
+      state = callback.call(state, event, payload)
+    end
+    state
+  rescue => err
+    raise InvalidMachine.new('#change')
+  end
+
+  def resolve_callbacks(state)
+    all_names_for(state).map { |n| callbacks(state)[n] }.flatten.compact 
+  end
+
+  def resolve_next_state_name(state, event)
+    all_names_for(state).map { |n| transitions(state)[event][n] }.compact.first
+  end
+
+  def update_machine_state(state, target)
+    raise InvalidState, "nil target" unless target
+    new_machine = state[:_machine].merge({ current: target })
+    state.merge({ _machine: new_machine })
+  end
+end

data/spec/machine_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require './lib/fmm.rb'
+require './spec/test_machine.rb'
+
+describe FMM do
+  let(:state) { FMM::TestMachine.create }
+
+  it "validates the test machine" do
+    expect(FMM.validate!(state)).to eq(true)
+  end
+
+  context "when advancing" do 
+    let(:new_state) { FMM.trigger!(state, :begin) }
+      
+    it "accepts begin" do
+      expect(FMM.current(new_state)).to eq(:step1)
+    end
+
+    it "doesn't mutate the original state object" do
+      expect(FMM.current(state)).to eq(:new)
+    end
+    
+    it "runs step1 callback" do
+      expect(new_state[:step1]).to eq([{ begin: nil }])
+    end
+    
+    it "runs the * callback" do
+      expect(new_state[:all]).to eq([{ begin: nil }])
+    end 
+    
+    it "doesn't run uncalled for callbacks" do
+      expect(new_state[:aliased]).to be(nil)
+    end
+
+    it "refuses invalid transitions" do
+      bad_transition_return = FMM.trigger(state, :end)
+      expect(bad_transition_return).to be(false)
+    end
+
+    it "raises on invalid transition with trigger!" do
+      expect { FMM.trigger!(state, :end) }.to raise_error(FMM::InvalidState)
+    end
+
+    it "raises on invalid event no matter what" do
+      expect { FMM.trigger(state, :no_such_event) }.to raise_error(FMM::InvalidEvent) 
+    end
+
+    it "passes payload to callback" do
+      payloaded_state = FMM.trigger!(state, :begin, :a_very_simple_payload)
+      expect(payloaded_state[:all]).to eq([{ begin: :a_very_simple_payload }])
+    end 
+
+    it "accepts the * state in transitions" do 
+      bailed_state = FMM.trigger!(state, :bail)
+      expect(FMM.current(bailed_state)).to eq(:bail)
+    end
+
+    context "further" do
+      let(:step2_state) { FMM.trigger!(new_state, :advance) } 
+      
+      it "sets step2 state" do  
+        expect(FMM.current(step2_state)).to eq(:step2)
+      end
+
+      it "runs callbacks for aliased states" do 
+        expect(step2_state[:aliased]).to eq([{ advance: nil }])
+      end
+     
+      it "recognizes aliased states in the transition table" do 
+        aliased_state = FMM.trigger!(step2_state, :aliased)
+        expect(FMM.current(aliased_state)).to eq(:recognized)
+      end
+      
+      it "recognizes when aliases don't apply in the transition table" do
+        expect { FMM.trigger!(FMM.trigger!(step2_state, :bail), :aliased) }.to raise_error(FMM::InvalidState)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/test_machine.rb

@@ -0,0 +1,43 @@
+module FMM
+  module TestMachine
+    extend self
+
+    def create
+      { _machine:
+        {
+          current: :new,
+          transitions: TRANSITIONS,
+          callbacks: CALLBACKS,
+          aliases: ALIASES
+        }
+      }
+    end
+
+    TRANSITIONS = {
+      begin: { :new => :step1 },
+      advance: { :step1 => :step2, :step2 => :step3 },
+      end: { :step3 => :done },
+      aliased: { :aliased => :recognized },
+      bail: { :* => :bail }
+    }.freeze
+
+    CALLBACKS = {
+      step1: lambda { |state, event, payload| step1_callback(state, event, payload) },
+      aliased: lambda { |s,e,p| aliased_callback(s,e,p) },
+      :* => lambda { |s,e,p| all_callback(s,e,p) }
+    }.freeze
+
+    ALIASES = {
+      step2: [ :aliased ],
+      step3: [ :aliased ]
+    }.freeze
+
+    # some testing methods
+    [ :step1, :aliased, :all ].each do |m|
+      define_method(:"#{m}_callback") do |state, event, payload|
+        call_history = (state[m] || []).push({ event => payload })
+        state.merge({ m => call_history })
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: fmm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Erik Cameron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'FMM is a small finite state machine implementation based on Michael
+  Martens'' micromachine, but recast in the idioms of functional programming: instead
+  of mutable state we use arguments and return values, and instead of methods bound
+  to an instance of a class like MicroMachine, we provide utility functions that operate
+  on any suitable data structure.'
+email:
+- root@erikcameron.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- fmm.gemspec
+- lib/fmm.rb
+- spec/machine_spec.rb
+- spec/spec_helper.rb
+- spec/test_machine.rb
+homepage: http://github.com/erikcameron/fmm
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: 'FMM: a minimal finite state machine with functional leanings'
+test_files: []