fae 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0f89598b59524e013062bb117f47fcd1889716a
+  data.tar.gz: b9a9397367d130f47918553a63344e7e73fb4fa1
+SHA512:
+  metadata.gz: ed9dff23f912d6156c0bd0d81e220ab95da5a44361883303ed56d1f5d009169b332ff3662b8b40b2285d45406302e65d7a6fba052a9249280d6b21f8c85e49b7
+  data.tar.gz: 2d20b2843097ee222bd03a73288fcba66f240a4b76324299efad7144979f8816fa77b14fa9c9efe2152b9c7bacb9d4299fc237ea69623b9b4525ab94917969af

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fae.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Casey Scarborough
+
+MIT License
+
+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,29 @@
+# Fae
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fae'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fae
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fae/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/fae

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'yaml'
+require_relative '../lib/fae'
+
+options = {}
+OptionParser.new do |opt|
+  opt.banner = "Usage: fae [options]"
+
+  opt.on('-h', '--help', 'View this help menu') { puts opt; exit 0 }
+  opt.on('-f FILENAME', '--file FILENAME', 'Evaluate a data file') { |o| options[:file] = o }
+  opt.on('-v', '--version', 'Display the version number') { puts Fae::VERSION; exit 0 }
+  opt.on('-i', '--interactive', 'Start interactive check') { options[:interactive] = true }
+
+  begin
+    opt.parse!
+  rescue OptionParser::InvalidOption => e
+    puts e.message
+    puts opt
+    exit 1
+  rescue OptionParser::MissingArgument => e
+    puts e.message
+    puts opt
+    exit 1
+  end
+end
+
+if (options[:file])
+  Fae.load_file(options[:file])
+else
+  Fae.interactive
+end

data/fae.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fae/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fae"
+  spec.version       = Fae::VERSION
+  spec.authors       = ["Casey Scarborough"]
+  spec.email         = ["caseyscarborough@gmail.com"]
+  spec.summary       = %q{Evaluates Finite Automata State Diagrams for correctness.}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.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.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "colorize"
+end

data/lib/fae.rb

@@ -0,0 +1,124 @@
+require 'colorize'
+
+# Fae classes
+require_relative 'string'
+require_relative 'fae/language'
+require_relative 'fae/state'
+require_relative 'fae/finite_automata'
+require_relative 'fae/version'
+
+module Fae
+
+  class << self
+
+    def load_file(filename)
+      diagrams = nil
+      begin
+        diagrams = YAML.load_file(filename)
+      rescue Exception => e
+        abort "No such file: #{filename}"
+      end
+
+      diagrams.each do |diagram|
+        language = diagram["language"].split(',')
+        language.map(&:strip!)
+        lang = Fae::Language.new(language)
+        fa = Fae::FiniteAutomata.new(lang, diagram["description"])
+
+        states = []
+        diagram["states"].keys.each do |state|
+          name = state
+          values = diagram["states"][name].split(",")
+          values.map(&:strip!)
+
+          paths = {}
+          values.each do |value|
+            match = value.split("->")
+            match.map(&:strip!)
+            if (match)
+              paths[match[0].to_sym] = match[1]
+            end
+          end
+          states << Fae::State.new(name, paths, values[-1] == "accepting")        
+        end
+
+        strings = []
+        diagram["strings"].keys.each do |string|
+          value = string
+          valid = diagram["strings"][string] == "valid"
+          strings << String.new(value.dup, valid)
+        end
+
+        fa.add_states(states)
+        fa.add_strings(strings)
+        fa.evaluate!
+      end
+    end
+
+    def interactive
+      states  = []
+      strings = []
+
+      print "~ Enter the letters of your language separated by a comma: ".colorize(:yellow)
+      letters = gets.chomp.split(",")
+      letters.map(&:strip!)
+
+      language = Language.new(letters)
+      print "~ Enter the description of your state diagram: ".colorize(:yellow)
+      description = gets.chomp
+
+      fa = FiniteAutomata.new(language, description)
+      print "~ Enter your state names separated by a comma: ".colorize(:yellow)
+      state_names = gets.chomp.split(",")
+      state_names.map(&:strip!)
+
+      state_names.each do |state|
+        paths = {}
+        puts "\nState #{state}:".colorize(:blue)
+
+        letters.each do |letter|
+          valid = false
+          while (!valid)
+            print "~ In state ".colorize(:yellow) + state.colorize(:blue) + " the letter ".colorize(:yellow) + letter.colorize(:blue) + " will take you to what state? ".colorize(:yellow)
+            next_state = gets.chomp
+            if (!state_names.include?(next_state))
+              puts "State #{next_state} is not one of your state names. Please choose from the following: #{state_names}".colorize(:red)
+            else
+              paths[letter.to_sym] = next_state
+              valid = true
+            end
+          end
+        end
+
+        print "~ Is state ".colorize(:yellow) + state.colorize(:blue) + " an accepting state? (y/n): ".colorize(:yellow)
+        accepting = gets.chomp.casecmp('y').zero?
+        states << State.new(state, paths, accepting)
+      end
+
+      finished = false
+      string_values = []
+      puts "~ Enter strings to test your state diagram with (type 'done' when finished):".colorize(:yellow)
+
+      while(!finished)
+        value = gets.chomp
+        if (value == 'done')
+          finished = true
+        else
+          string_values << value
+        end
+      end
+
+      string_values.each do |value|
+        print "~ Is ".colorize(:yellow) + value.colorize(:blue) + " a valid string for this state diagram? (y/n): ".colorize(:yellow)
+        valid = gets.chomp.casecmp('y').zero?
+        strings << String.new(value, valid)
+      end
+      puts
+
+      fa.add_states(states)
+      fa.add_strings(strings)
+      fa.evaluate!
+    end
+
+  end
+end

data/lib/fae/finite_automata.rb

@@ -0,0 +1,95 @@
+module Fae
+  class FiniteAutomata
+    def initialize(language, description)
+      @states = []
+      @strings = []
+      @invalids = []
+      @language = language
+      @description = description
+    end
+
+    def add_strings(strings)
+      strings.each do |string|
+        @strings << string
+      end
+    end
+
+    def add_states(states)
+      states.each do |state|
+        add_state(state)
+      end
+    end
+
+    def get_state(name)
+      retrieved_state = nil
+      @states.each do |state|
+        if (state.name == name)
+          retrieved_state = state
+          break
+        end
+      end
+      if (retrieved_state.nil?)
+        raise "State #{name} was not found in this Finite Automata. Ensure that all states have outputs for #{@language.characters}"
+      end
+      return retrieved_state
+    end
+
+    def evaluate!
+      @invalids = []
+      if (@states.length == 0)
+        raise "You must add some states to your Finite Automata before checking strings"
+      end
+
+      puts """Evaluating strings for #{@description} using language #{@language.characters}".colorize(:yellow)
+      @strings.each do |string|
+        valid = evaluate_string(string)
+        if (!valid)
+          @invalids << string
+        end
+      end
+
+      num_invalid = @invalids.length
+      if (num_invalid > 0)
+        puts "State diagram may be incorrect for #{@description}".colorize(:red)
+        puts "\nA total of #{num_invalid} string#{'s' if num_invalid != 1} did not meet your expectations:\n"
+
+        @invalids.each do |string|
+          expected_string = string.expected ? "valid".colorize(:green) : "invalid".colorize(:red)
+          puts "* You expected the string '#{string.colorize(:blue)}' to be #{expected_string}"
+        end
+        puts "\nIf these expectations are correct, then your state diagram needs revising. Otherwise, you've simply expected the wrong values."
+      else
+        puts "State diagram is correct.".colorize(:green)
+      end
+      puts
+    end
+
+  private
+    def add_state(new_state)
+      valid = true
+      @states.each do |state|
+        if (new_state.name == state.name)
+          raise 'Duplicate state added for Finite Automata'
+        end
+      end
+      @states << new_state
+    end
+
+    def evaluate_string(string)
+      print "#{string.colorize(:blue)}: "
+      if (@language.string_is_valid(string))
+        result = @states.first.evaluate(string, self)
+        if (result[:valid] != string.expected)
+          puts "\u2717".encode("utf-8").colorize(:red)
+          return false
+        else
+          puts "\u2713".encode("utf-8").colorize(:green)
+          return true
+        end
+      else
+        puts "not valid for language #{@characters}".colorize(:red)
+        return true
+      end
+    end
+  end
+end

data/lib/fae/language.rb

@@ -0,0 +1,24 @@
+module Fae
+  class Language
+    attr_accessor :characters
+
+    def initialize(characters)
+      @characters = []
+      @characters = characters.uniq
+    end
+
+    def string_is_valid(string)
+      # Use lookahead to check for valid string
+      regex = "^(?=.*\\D)[#{@characters.join('|')}]+$"
+
+      if (string.match /#{regex}/)
+        return true
+      end
+      return false
+    end
+
+    def add_character(char)
+      @characters << char
+    end
+  end
+end

data/lib/fae/state.rb

@@ -0,0 +1,21 @@
+module Fae
+  class State
+    attr_accessor :name, :next_states, :valid
+
+    def initialize(name, next_states, valid)
+      @name = name
+      @next_states = next_states
+      @valid = valid
+    end
+
+    def evaluate(string, fa)
+      if (string.first.empty?)
+        output = valid ? "valid".colorize(:green) : "invalid".colorize(:red)
+        print "#{@name} (#{output}) "
+        return { :output => output, :valid => valid }
+      end
+      print "#{@name} #{'->'.colorize(:light_black)} "
+      fa.get_state(next_states[string.first.to_sym]).evaluate(string.shift_left, fa)
+    end
+  end
+end

data/lib/fae/version.rb

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

data/lib/string.rb

@@ -0,0 +1,18 @@
+# Used to add functionality to the Ruby String class.
+class String
+  attr_accessor :expected
+  
+  def self.new(value, expected)
+    string = value
+    string.expected = expected
+    string
+  end
+
+  def first
+    self[0, 1]
+  end
+
+  def shift_left(num = 1)
+    self[num..-1]
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: fae
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Casey Scarborough
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- caseyscarborough@gmail.com
+executables:
+- fae
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/fae
+- fae.gemspec
+- lib/fae.rb
+- lib/fae/finite_automata.rb
+- lib/fae/language.rb
+- lib/fae/state.rb
+- lib/fae/version.rb
+- lib/string.rb
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Evaluates Finite Automata State Diagrams for correctness.
+test_files: []