moory 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2da947ef2377d008e244f6f586afb7a3df20e3c7e289f3276927ae47ce2c0ea
-  data.tar.gz: 6d79a5960e831ca314afd25c4bb6c57eec25e795490c50b336584a1227cc92b7
+  metadata.gz: 48186775b1c7f9b85822f58dadc0f2f355b1fc872e6ab7abcb1883da9b9d74e9
+  data.tar.gz: 4edd7b2f0a957aaeb6d016d25b9fc7f638f69dc20e2d925c9a11b0a13863a092
 SHA512:
-  metadata.gz: 858277ca758168f5c8837a0c102f0c0d5c7b1d667ea963093961f1718b4ced53116cc9f527cd67371bf9eaca25336fe6a1e555dd0d550ae2fd2c6f9aa175f08c
-  data.tar.gz: 5f7df4f74a3e53ddce03819accefc1f1186ed6cdba5ec7dfec7f45a5d0e45aa1c435f342ecf84831b406fb22052ca10bc20d3003bc87ef26e9b29769f0a410b8
+  metadata.gz: a5c5a11ad922e36aa09687535e52273661520b64b42c0867a6d0f5c9b9b120a2408e98737515f10be6dfeffc83ee55b55a3699c8dc007e2c7b59b1b9b09b8a06
+  data.tar.gz: 62c3df5b0cd326376f1434d2d6a8c3b3f3b7c1a3abdd05a0c9425f3f118bde51cccad786d48186d2155d7b32e900ef455858014fef72a9e581a8b367d19eae67

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    moory (0.3.2)
+    moory (0.3.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -3,20 +3,20 @@ Welcome to the Moory gem!
 
 You can use this gem to create various kinds of finite machines using a simple specification language.
 
-Below is an example of of how you might use the Acceptor, but until I can get some tutorial material together, please take a look at the examples directory.  Therein you'll find the Acceptor, a Decoder (Mealy machine), and something useless but (hopefully) illuminating.  Reading the spec files might also help.
+The [wiki](https://github.com/elclavijero/moory/wiki) is where to go if you are for looking for tutorial material.  Perhaps also look in the examples directory.  Therein you'll find use of the Acceptor, Decoder (Mealy machine), and something useless but (hopefully) illuminating.
+
+Until you do, here is an example showing how you might use the Acceptor.
+
 
 ## Example: Creating an acceptor for ab*
 
 ### Motivation
 
-Imagine that you want to create an incredible machine; one capable of determining whether a given character string belongs to the language described by the regular expression `ab*`.  Naturally, 
-you would not reach for a Regexp. That would be far too easy.  Instead you derive from
-the regular expression a Deterministic Finite Automaton (DFA) that does the job.  Here's what it 
-might look like:
+Imagine that you want to create an incredible machine. One capable of determining whether a given character string belongs to the language described by the regular expression `ab*`.  You're not going to use a Regexp. That would be far too easy.  Instead you derive from the regular expression a Deterministic Finite Automaton (DFA) that does the job.  Here's what it might look like:
 
 ![ab_star](images/ab_star.png)
 
-Of course, you've set up and solved a system of equations verifying that the design is correct.  But how do we implement this in Ruby?  We won't bother trying to apply the State design pattern, because it is a pain.  Instead, we will employ Moory which is one of the 200+ gems that exist to make creating finite machines easy.
+Of course, you've set up and solved a system of equations verifying that the design is correct.  Now how do you implement this in Ruby?  You won't bother trying to apply the State design pattern, because it is a pain.  Instead, you'll employ Moory, which is one of the 200+ gems that exist to make creating finite machines easy.
 
 ### Implementing the Acceptor
 
@@ -45,7 +45,7 @@ ab_star = Moory::Acceptor.create(
 )
 ```
 
-I'll explain the syntax of the transitions later, but, you have done enough to confidently type:
+I'll explain the syntax of the transitions later (see the [wiki](https://github.com/elclavijero/moory/wiki)) but you have done enough to confidently type:
 
 ```ruby
 ab_star.accepts?(string: "ab")
@@ -61,7 +61,7 @@ ab_star.accepts?(string: "aab")  # => false
 ab_star.accepts?(string: "aba")  # => false
 ```
 
-We aren't stuck with testing the strings against the initial state.  We can ask the machine to begin its match in any state:
+You aren't stuck with testing the strings against the initial state.  You can ask the machine to begin its match in any state:
 
 ```ruby
 ab_star.accepts?(string: "bbb", in_state: '1') 
@@ -74,11 +74,23 @@ But what about including characters that don't belong to the machine's alphabet?
 ab_star.accepts?(string: "bbc", in_state: '1')
 ```
 
-Well this one will be unceremoniously rejected with a runtime error (unless you are using version 0.1.0, where I forgot to handle bad input, sorry!)
+Well this one will be unceremoniously rejected with a runtime error (unless you are using version 0.1.0, where I forgot to handle bad input, sorry!).  Incidentally, if you want to change that behaviour, you should override the `default_proc`.
+```ruby
+ab_star.default_proc = proc { |msg| puts "I'm going to ignore that #{msg}" }
+```
+
+Now look
+```ruby
+ab_star.accepts?(string: "abcbb")
+# I'm going to ignore that c
+# => true
+```
+
+That's better.
 
 ### Before you go...
 
-There's more to Moory than its Acceptor.  I'll show you how to use its other features in another memo.
+There's more to Moory than its Acceptor.  I'll show you how to use its other features in the [wiki](https://github.com/elclavijero/moory/wiki).
 
 
 ## Installation

data/examples/readme_example.rb

@@ -0,0 +1,38 @@
+require 'moory'
+
+# Create an acceptor for the language described by ab*
+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 }
+)
+
+# Check some strings
+ab_star.accepts?(string: "ab")   # => true
+ab_star.accepts?(string: "abbb") # => true
+ab_star.accepts?(string: "aab")  # => false
+ab_star.accepts?(string: "aba")  # => false
+
+# Check a string against another starting state
+ab_star.accepts?(string: "bbb", in_state: '1')
+# => true
+
+# Uncomment the next line, and you'll see a runtime error
+# ab_star.accepts?(string: "bbc", in_state: '1')
+
+# Assign a default_proc, which is called when the Acceptor 
+# encounters a character not in its alphabet e.g. 'c'
+ab_star.default_proc = proc { |msg| puts "I'm going to ignore that #{msg}" }
+
+# Deliberately give the Acceptor a bad character.
+ab_star.accepts?(string: "abcbb")
+# I'm going to ignore that c
+# => true
+

data/lib/moory/version.rb

@@ -1,3 +1,3 @@
 module Moory
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moory
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Adam W. Grant
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-08 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,7 @@ files:
 - bin/console
 - bin/setup
 - examples/ab_star.rb
+- examples/readme_example.rb
 - examples/silly.rb
 - examples/single_as_and_bs.rb
 - images/ab_star.png