moory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75925ec5480670be1d13c23a9fa4d27832928abbba286a942a0bf8c92ed3ad4f
+  data.tar.gz: 5122d6a48f082ede41fbf06a271e74e87fad0e3b40422e205f34818b23308e90
+SHA512:
+  metadata.gz: d02f7cbad65475e7c6161df499496dc4e81142ee67006bb0b037f56aaf5dd6ef4af51da2673d777ba60092f319eb77177ed03995479163743b1644e13c4d7a5a
+  data.tar.gz: 2a1b2982658c16da3b5bdae03626bad859a88e45c3ff4469cac244f8083e027a616e3f749b8ae65fc95fc98629ca45ccb6a88bb3cb57af8c8f621cbebf3f98fd

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in moory.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    moory (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  moory!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Adam W. Grant
+
+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,40 @@
+# Moory
+Welcome to the Moory gem!
+
+You can use this gem to create various kinds of finite machines using a simple specification language.
+
+Until I can get some tutorial material together, please take a look at the examples directory.  Therein you'll find a Finite Acceptor, a Decoder (Mealy machine), and something useless but (hopefully) illuminating.  Reading the spec files might also help.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'moory'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install moory
+
+## Usage
+
+Please see the examples directory, for now.
+
+## 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]/moory.
+
+## 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/bin/console

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

@@ -0,0 +1,20 @@
+require 'moory'
+
+ab_star = Moory::Acceptor.create(
+  initial: '0',
+  transitions: %q{
+    0 : a : 1
+    0 : b : 2
+    1 : a : 2
+    1 : b : 1
+    2 : a : 2
+    2 : b : 2
+  },
+  final: %w{ 1 }
+)
+
+
+ab_star.accepts?(string: "abb")      
+# => true
+ab_star.accepts?(string:"abb", in_state: '1')
+# => false

data/examples/silly.rb

@@ -0,0 +1,34 @@
+require 'moory'
+
+silly = Moory::Interpreter.new do |i|
+  i.load """
+    0 : a / u / foo : 1
+    0 : b / v / foo : 2
+    1 : a / w / bar : 1
+    1 : b / x / bar : 2
+    2 : a / y /     : 1
+    2 : b / z       : 2
+  """
+end
+
+# Tell the interpreter where we want to start
+silly.state = '0'
+
+# Define some handlers for the effectors named in the 
+# loaded specification.
+silly.effectors = {
+  'foo' => proc { |msg| pp "#{msg} says: fooby fooby foo" },
+  'bar' => proc { |msg| pp "#{msg} says: barby barby bar" },
+}
+
+# Tell the interpreter the name of the effector we want to use
+# if a transition has output, but no effector.
+silly.fallback_effector = 'bar'
+
+
+# Send the interpreter some messages: putm means "PUT Message"
+silly.putm('b') # outputs: "v says: fooby fooby foo"
+silly.putm('b') # outputs: "z says: barby barby bar"
+silly.putm('a') # outputs: "y says: barby barby bar"
+silly.putm('a') # outputs: "w says: barby barby bar"
+

data/examples/single_as_and_bs.rb

@@ -0,0 +1,21 @@
+require 'moory'
+require 'stringio'
+
+ostream = StringIO.new
+
+mealy = Moory::Decoder.create(
+  initial: '0',
+  transitions: %q{
+    0 : a / a : 1
+    0 : b / b : 2
+    1 : a     : 1
+    1 : b / b : 2
+    2 : a / a : 1
+    2 : b     : 2
+  },
+  ostream: ostream
+)
+
+mealy.decode("abbbbbbaaaabaabbba")
+
+ostream.string # => "abababa"

data/lib/moory.rb

@@ -0,0 +1,9 @@
+require "moory/version"
+require "moory/interpreter"
+require "moory/parser"
+require "moory/acceptor"
+require "moory/decoder"
+
+module Moory
+  # Your code goes here...
+end

data/lib/moory/acceptor.rb

@@ -0,0 +1,17 @@
+module Moory
+  module Acceptor
+    def Acceptor.create(specification)
+      Moory::Interpreter.new do |i|
+        i.load(specification[:transitions])
+      
+        define_singleton_method(:accepts?) do |string:, in_state: nil|
+          i.state = in_state ? in_state : specification[:initial]
+          
+          string.each_char { |c| putm(c) }
+      
+          specification[:final].include?(i.state)
+        end
+      end
+    end
+  end
+end

data/lib/moory/decoder.rb

@@ -0,0 +1,20 @@
+module Moory
+  module Decoder
+    def Decoder.create(config)
+      Interpreter.new do |i|
+        i.load(config[:transitions])
+      
+        define_singleton_method(:decode) do |string|
+          i.state = config[:initial]
+          i.fallback_effector = config
+            .fetch(:ostream, $stdout)
+            .method(:write)
+      
+          string.each_char do |c|
+            i.putm(c)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/moory/interpreter.rb

@@ -0,0 +1,100 @@
+require 'set'
+
+module Moory
+  class Interpreter
+    attr_accessor :graph, :effectors, :state
+    attr_reader   :fallback_effector, :default_proc
+
+    SKIP = proc {}
+    WARN = proc { |msg| warn "Did not understand: #{msg}" }
+
+    def initialize(graph: {}, effectors: {}, default_proc: SKIP, &block)
+      @graph        = graph
+      @effectors    = effectors
+      @default_proc = default_proc
+
+      instance_eval &block if block_given?
+    end
+
+    def load(source)
+      p = Moory::Parser.new
+      @graph.merge!(p.analyse(source))
+    end
+
+    def fallback_effector=(obj)
+      candidate = obj.kind_of?(String) ? effectors[obj] : obj
+      
+      @fallback_effector = candidate.respond_to?(:call) ? candidate : nil
+    end
+
+    def default_proc=(obj)
+      @default_proc = obj.respond_to?(:call) ? obj : nil
+    end
+
+    def putm(msg)
+      warn """
+      #{self} received #{msg} before being assigned a state.
+      The message will be passed to the default_proc.
+      """ unless state
+      
+      understand?(msg) ? respond(msg) : bad_call(msg)
+    end
+
+    def understand?(msg)
+      receptors.include?(msg)
+    end
+
+    def receptors
+      graph.fetch(state,{}).keys.to_set
+    end
+
+    def states
+      @states ||= graph.keys.to_set
+    end
+
+    def alphabet
+      @alphabet ||= Set.new(
+        graph.each_value.collect { |m| m.keys }.flatten
+      )
+    end
+
+    private
+
+    def respond(msg)
+      dispatch(msg)
+      resettle(msg)
+    end
+
+    def dispatch(msg)
+      _effector, _output = effector(msg), output(msg)
+
+      if _effector.respond_to?(:call)
+        _effector.arity == 0 ?
+          _effector.call :
+          _effector.call(_output)
+      end
+    end
+
+    def resettle(msg)
+      @state = graph[state][msg][:state]
+    end
+
+    def effector(msg)
+      candidate = graph[state][msg][:effector]
+
+      if candidate.kind_of?(String)
+        effectors[candidate]
+      else
+        candidate || fallback_effector
+      end
+    end
+
+    def output(msg)
+      graph[state][msg][:output]
+    end
+
+    def bad_call(msg)
+      default_proc.call(msg) if default_proc
+    end
+  end
+end

data/lib/moory/parser.rb

@@ -0,0 +1,105 @@
+module Moory
+  class Parser
+    attr_reader :graph, :staged
+  
+    def initialize
+      @graph   = {}
+      prime
+    end
+  
+    def analyse(input)
+      input.each_line do |line| 
+        scan(line); store if valid?
+        reset
+      end
+
+      return graph
+    end
+  
+    private
+  
+    def scan(string)
+      string.chomp.each_char { |c| interpret(c) }
+    end
+  
+    def interpret(char)
+      if @interpreter.understand?(char)
+        @interpreter.putm(char)
+      else
+        staged.fetch(@focus) { |k| staged[k] = '' } << char
+      end
+    end
+  
+    def store
+      y = graph.fetch(staged['source']) { |k| graph[k] = {} }
+      z = y.fetch(staged['stimulus'])    { |k| y[k] = {} }
+      z.merge!({ 
+        state:    staged['target'],
+        output:   staged['output'],
+        effector: staged['effector'] }
+        .compact 
+      )
+    end
+  
+    def valid?
+      staged['source']   && 
+      staged['stimulus'] && 
+      staged['target']
+    end
+
+    def prime
+      interpreter.state = '0'
+      @staged   = {}
+      source
+    end
+
+    alias reset prime
+
+    def interpreter
+      @interpreter ||= Moory::Interpreter.new(config)
+    end
+
+    def config
+      {
+        graph: {
+          '0' => {
+            ':'  => { state: '1', effector: 'stimulus' },
+            ' '  => { state: '0' },
+            '\t' => { state: '0' }
+          },
+          '1' => { 
+            '/'  => { state: '2', effector: 'output' },
+            ':'  => { state: '4', effector: 'target' },
+            ' '  => { state: '1' },
+            '\t' => { state: '1' }
+          },
+          '2' => {
+            ':'  => { state: '4', effector: 'target' },
+            '/'  => { state: '3', effector: 'effector' },
+            ' '  => { state: '2' },
+            '\t' => { state: '2' }
+          },
+          '3' => {
+            ':'  => { state: '4', effector: method(:target) },
+            ' '  => { state: '2' },
+            '\t' => { state: '2' }
+          },
+          '4' => {
+            ' '  => { state: '4' },
+            '\t' => { state: '4' }
+          }
+        },
+        effectors: {
+            'stimulus' => method(:stimulus),
+            'output'   => method(:output),
+            'target'   => method(:target),
+            'effector' => method(:effector),
+        }
+      }
+    end
+
+    %w{
+      source stimulus target output effector
+    }.each { |c| define_method(c) { @focus = c } }
+  end
+end

data/lib/moory/version.rb

@@ -0,0 +1,3 @@
+module Moory
+  VERSION = "0.1.0"
+end

data/moory.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "moory/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "moory"
+  spec.version       = Moory::VERSION
+  spec.authors       = ["Adam W. Grant"]
+  spec.email         = ["adam_grnt@yahoo.co.uk"]
+
+  spec.summary       = %q{Use plain text to define finite machines.}
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # 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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: moory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam W. Grant
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- adam_grnt@yahoo.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/ab_star.rb
+- examples/silly.rb
+- examples/single_as_and_bs.rb
+- lib/moory.rb
+- lib/moory/acceptor.rb
+- lib/moory/decoder.rb
+- lib/moory/interpreter.rb
+- lib/moory/parser.rb
+- lib/moory/version.rb
+- moory.gemspec
+homepage: 
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Use plain text to define finite machines.
+test_files: []