mouse_organ 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 641094f0c65c8fbee427c96d520549086475873b
+  data.tar.gz: b22183796cb160f016e6d215c5a0ea98d2cc846b
+SHA512:
+  metadata.gz: 49314c17a6e28eea2e114bfeb68dae62185180bbf68a0bb79d04e960eb848e4e537abd02cfe00f0492008658271f8e12ae4a7f8a4f7249576ffaa9c1c6532079
+  data.tar.gz: b4f2da325915322c469846f81a95375b9395b874efa28bc6f25dc5515a5866ef68de2fbb52fa6f05ba30a4ce453cc4e2aec1550f6ff0499dc5c7de93e35e77c0

data/.hgignore

@@ -0,0 +1,15 @@
+syntax: regexp
+
+^\.bundle/
+^Gemfile.lock
+^doc/
+^pkg/
+^spec/reports/
+^tmp/
+
+syntax: glob
+*.bundle
+*.so
+*.o
+*.a
+.ruby-version

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+-I .

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+
+  gem "rspec", "~> 3.8"
+  gem "pry"
+  gem "rdoc"
+  
+end
+
+
+

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrew Jones
+
+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,70 @@
+Mouse Organ
+===========
+
+Ladies and gentlemen, the Marvelous -- Mechanical -- Mouse Organ!
+
+This is a _very_ small mixin that turns a class into a basic state machine.
+
+
+Installation
+------------
+
+Just download lib/mouse_organ.rb into your code.  Or you could just use it as a pattern of sorts,
+and roll your own in the same vein.
+
+I mean, sure, you can also `gem install mouse_organ`.  But honestly, it might be better to have the
+class where you can see it, for documentation purposes?  Your call.
+
+
+
+Example
+-------
+
+```{.ruby}
+class Foo
+  include MouseOrgan
+
+  def initialize
+    machine_start(:one)
+  end
+
+  def state_one
+    transition_to :two
+    sleep 1
+  end
+
+  def state_two
+    transition_to :three
+    sleep 1
+  end
+
+  def state_three
+    throw :machine_stop
+  end
+
+  def transition_to(state)
+    puts state
+    super
+  end
+
+end
+```
+
+
+What You Get
+------------
+
+Each of your methods that start `state_` define a state of the state machine.  To start the machine,
+pass `#machine_start` the initial state name (e.g., `:two` for the state defined by `#state_two`).  
+
+Inside a state method, you can change to a new state using `transition_to(:statename)`. You can
+stop the machine using `throw :machine_stop`, or you can override `#machine_stop?` to return true
+if the machine should stop.
+
+Passing an invalid state to `#machine_start` or `#transition_to` raises ArgumentError.
+
+The attribute @state holds the current state. 
+
+It might be useful to override `#transition_to` as I have above -- for example, in order to log
+every change of state.
+

data/lib/mouse_organ.rb

@@ -0,0 +1,70 @@
+##
+# A tiny mixin to turn a class into a state machine.
+# Example:
+#
+# class Foo
+#   include MouseOrgan
+#
+#   def initialize
+#     machine_start(:one)
+#   end
+#
+#   def state_one
+#     transition_to :two
+#     sleep 1
+#   end
+#
+#   def state_two
+#     transition_to :three
+#     sleep 1
+#   end
+#
+#   def state_three
+#     throw :machine_stop
+#   end
+#
+#   def transition_to(state)
+#     puts state
+#     super
+#   end
+#
+# end
+#     
+module MouseOrgan
+  VERSION = "0.1.0"
+ 
+  def machine_start(initial)
+    transition_to initial
+
+    catch :machine_stop do
+      loop do
+        send state_method(@state)
+        throw :machine_stop if machine_stop?
+      end
+    end
+
+    self
+  end
+
+  def transition_to(state)
+    if self.respond_to? state_method(state)
+      @state = state
+    else
+      fail ArgumentError, "Unknown state '#{state}'"
+    end
+
+    self
+  end
+
+  def machine_stop?
+    false
+  end
+
+  private
+
+  def state_method(state)
+    "state_#{state}".to_sym
+  end
+
+end # of MouseOrgan
+

data/mouse_organ.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mouse_organ'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mouse_organ"
+  spec.version       = MouseOrgan::VERSION
+  spec.authors       = ["Andy Jones"]
+  spec.email         = ["andy.jones@twosticksconsulting.co.uk"]
+  spec.summary       = %q|Tiny state machine|
+  spec.description   = <<-DESC.gsub(/^\s+/, "")
+    A tiny mixin to turn a class into a state machine.
+  DESC
+
+  spec.homepage      = "https://bitbucket.org/andy-twosticks/mouse_organ"
+  spec.license       = "MIT"
+
+  spec.files         = `hg status -macn0`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.extra_rdoc_files = spec.files.grep(%r{^md/})
+
+  #spec.add_runtime_dependency "devnull",    '~>0.1'
+  #spec.add_runtime_dependency "octothorpe", '~>0.4'
+
+end

data/spec/mouse_organ_spec.rb

@@ -0,0 +1,124 @@
+require "mouse_organ"
+
+
+RSpec.describe "MouseOrgan" do
+
+  let(:class_organ1) do
+    Class.new do
+      include MouseOrgan
+    end
+  end
+
+  let(:class_organ2) do
+    Class.new do
+      include MouseOrgan
+      attr_reader :state
+
+      def go; machine_start(:one); end
+
+      def state_one; throw :machine_stop; end
+    end
+  end
+
+  let(:class_organ3) do
+    Class.new do
+      include MouseOrgan
+
+      def go; machine_start(:one); end
+
+      def state_one;    transition_to :two;    end 
+      def state_two;    transition_to :three;  end 
+      def state_three;  throw :machine_stop;   end
+    end
+  end
+
+  let(:class_organ4) do
+    Class.new do
+      include MouseOrgan
+
+      def go; machine_start(:one); end
+
+      def state_one;    transition_to :two;    end 
+      def state_two;    transition_to :three;  end 
+      def state_three;  transition_to :one;    end
+
+      def machine_stop?; @state == :three; end
+    end
+  end
+
+  let(:class_organ5) do
+    Class.new do
+      include MouseOrgan
+      attr_reader :state_history
+
+      def initialize; @state_history = []; end
+
+      def go; machine_start(:one); end
+
+      def state_one;    transition_to :two;    end 
+      def state_two;    transition_to :three;  end 
+      def state_three;  throw :machine_stop;   end
+
+      def transition_to(state)
+        @state_history << state
+        super
+      end
+    end
+  end
+
+  let(:organ1) { class_organ1.new }
+  let(:organ2) { class_organ2.new }
+  let(:organ3) { class_organ3.new }
+  let(:organ4) { class_organ4.new }
+  let(:organ5) { class_organ5.new }
+
+
+  describe "#machine_start" do
+
+    it "raises ArgumentError if given an invalid state" do
+      expect{ organ1.machine_start(:wrong) }.to raise_error ArgumentError
+    end
+
+    it "transitions to the initial state" do
+      expect( organ2 ).to receive(:transition_to).with(:one).and_call_original
+      organ2.go
+    end
+
+    it "transits through the given states and stops when :machine_stop is thrown" do
+      expect( organ3 ).to receive(:transition_to).with(:one).and_call_original.ordered
+      expect( organ3 ).to receive(:transition_to).with(:two).and_call_original.ordered
+      expect( organ3 ).to receive(:transition_to).with(:three).and_call_original.ordered
+      organ3.go
+    end
+
+    it "transits through the given states and stops when #machine_stop? is true" do
+      expect( organ4 ).to receive(:transition_to).with(:one).and_call_original.ordered
+      expect( organ4 ).to receive(:transition_to).with(:two).and_call_original.ordered
+      expect( organ4 ).to receive(:transition_to).with(:three).and_call_original.ordered
+      organ4.go
+    end
+      
+  end # of #machine_start
+
+
+  describe "#transition_to" do
+     
+    it "raises ArgumentError if given an invalid state" do
+      expect{ organ2.transition_to(:two) }.to raise_error ArgumentError
+    end
+
+    it "sets @state to the new state" do
+      organ2.transition_to(:one)
+      expect( organ2.state ).to eq :one
+    end
+
+    it "will allow overriding" do
+      organ5.go
+      expect( organ5.state_history ).to eq(%i|one two three|)
+    end
+
+  end # of #transition_to
+  
+  
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'pry' #always useful when debugging
+
+RSpec.configure do |config|
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.disable_monkey_patching!
+  config.warnings = true
+  config.order = :random
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  Kernel.srand config.seed
+end
+

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: mouse_organ
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Jones
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-31 00:00:00.000000000 Z
+dependencies: []
+description: 'A tiny mixin to turn a class into a state machine.
+
+'
+email:
+- andy.jones@twosticksconsulting.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".hgignore"
+- ".rspec"
+- Gemfile
+- LICENSE.md
+- README.md
+- lib/mouse_organ.rb
+- mouse_organ.gemspec
+- spec/mouse_organ_spec.rb
+- spec/spec_helper.rb
+homepage: https://bitbucket.org/andy-twosticks/mouse_organ
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Tiny state machine
+test_files:
+- spec/mouse_organ_spec.rb
+- spec/spec_helper.rb