pastafari 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 826ce80ab51bf0bf0f065662fe05887bb8fa492e
+  data.tar.gz: 75dbc566afbbd71d10c938a86cc8bf8d5926be8d
+SHA512:
+  metadata.gz: ca09299d06320bbf4119cdc56399ee6855270ddf891ba84983eb64b9e99d5420d5f2f6884d804c2db89577b2acca3a6e0ac9a5bd28d0b3dc0e3ad90f04e5cf25
+  data.tar.gz: 769a9252a4e0443321cc798b895a85aef7f40d1b4ea898542b819f78d4da9b0f9d6ac93db12396385243147fbf0304ebeb1bc67c444f6922b5f3ab1a3a220358

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,16 @@
+inherit_from: .rubocop_todo.yml
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - '*.gemspec'

data/.rubocop_todo.yml

@@ -0,0 +1,15 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-12-24 16:08:28 -0500 using RuboCop version 0.46.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, IgnoreClassMethods, Whitelist.
+# Whitelist: to_ary, to_a, to_c, to_enum, to_h, to_hash, to_i, to_int, to_io, to_open, to_path, to_proc, to_r, to_regexp, to_str, to_s, to_sym
+Style/TrivialAccessors:
+  Exclude:
+    - 'lib/pastafari/builders/fsm_builder.rb'

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at josh@joshtompkins.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joshua Tompkins
+
+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,84 @@
+# Pastafari
+
+Pastafari is a library for building simple finite state machines in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pastafari'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pastafari
+
+## Usage
+
+```ruby
+# Define an FSM with the Pastafari FSM DSL:
+fsm = Pastafari::FSM.build do
+  # Set the order of operations with #transition.
+  # :before runs the current state's transition functions before processing the input.
+  # :after runs the transition function after input processing.
+  transition :after # :after is the default value
+
+  # Set the initial state:
+  initial_state :first_state
+  # If #initial_state isn't called, the first state defined by the DSL will be
+  # assumed to be the initial FSM state.
+
+  state :first_state do
+    # Define the input processing function:
+    process { |i| puts i }
+
+    # If this state can transition into another state, define the transition
+    # conditions:
+    transition_to(:second_state).when { |i| i == 1 }
+    # The transition function is a predicate - it should return a truthy or falsey
+    # value. If the function returns a truthy value, the FSM will transition into
+    # the new state.
+
+    # You can define as many transitions as you'd like:
+    transition_to(:third_state).when { |i| i == 2 }
+    # If a transition references a state that isn't defined, Pastafari will
+    # raise an error.    
+  end
+
+  state :second_state do
+    # The processing function MUST be called; if it isn't, Pastafari will
+    # raise an error.
+    process { |i| puts i / 2 }
+  end
+
+  state :third_state do
+    process { |i| puts i / 3 }
+
+    # Transition functions are optional.
+  end
+end
+
+# Run the FSM with #run. Pass in an array, or a value that can be converted to an
+# Array with #Array.
+fsm.run([1, 2, 3]) # => should print 1, 1, 1
+```
+
+## 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]/pastafari. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task ci: [:spec, :rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pastafari'
+
+# 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

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/lib/pastafari.rb

@@ -0,0 +1,7 @@
+require 'pastafari/version'
+require 'pastafari/fsm'
+require 'pastafari/state'
+require 'pastafari/transition'
+require 'pastafari/builders/fsm_builder'
+require 'pastafari/builders/state_builder'
+require 'pastafari/errors/invalid_state_error'

data/lib/pastafari/builders/fsm_builder.rb

@@ -0,0 +1,79 @@
+module Pastafari
+  module Builders
+    class FsmBuilder
+      VALID_TRANSITIONS = [:before, :after].freeze
+
+      def initialize
+        @states = {}
+        @transition_at = :after
+      end
+
+      def state(name, &block)
+        builder = Builders::StateBuilder.new(name)
+        builder.instance_eval(&block)
+
+        state = builder.build
+
+        @states[state.name] = state
+      end
+
+      def transition(at)
+        validate_transition_at(at)
+
+        @transition_at = at
+      end
+
+      def initial_state(state)
+        @initial_state = state
+      end
+
+      def build
+        validate_states_given
+        validate_initial_state
+        validate_transitions
+
+        set_initial_state!
+
+        Pastafari::Fsm.new(@states, @transition_at, @initial_state)
+      end
+
+      private
+
+      def set_initial_state!
+        @initial_state ||= @states.values.first.name
+      end
+
+      def validate_transition_at(at)
+        return if VALID_TRANSITIONS.include?(at)
+
+        raise ArgumentError, 'Transition value must be one of :before, :after.'
+      end
+
+      def validate_states_given
+        return unless @states.length.zero?
+
+        raise Pastafari::Errors::InvalidStateError, 'No states defined.'
+      end
+
+      def validate_initial_state
+        return unless @initial_state
+
+        return if @states.key?(@initial_state)
+
+        raise Pastafari::Errors::InvalidStateError,
+              'Initial state points to a non-existent state.'
+      end
+
+      def validate_transitions
+        @states.each do |name, state|
+          state.transitions.map(&:next_state).each do |k|
+            next if @states.key? k
+
+            raise Pastafari::Errors::InvalidStateError,
+                  "State #{name} is transitioning to non-existent state #{k}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pastafari/builders/state_builder.rb

@@ -0,0 +1,35 @@
+module Pastafari
+  module Builders
+    class StateBuilder
+      def initialize(name)
+        @name = name
+        @transitions = []
+      end
+
+      def process(&block)
+        raise ArgumentError unless block
+
+        @handler = block
+      end
+
+      def transition_to(new_state)
+        Pastafari::Transition.new(new_state).tap { |t| @transitions << t }
+      end
+
+      def build
+        validate_handler
+
+        State.new(@name, @handler, @transitions)
+      end
+
+      private
+
+      def validate_handler
+        return if @handler
+
+        raise Pastafari::Errors::InvalidStateError,
+              '#process must be called when defining the State.'
+      end
+    end
+  end
+end

data/lib/pastafari/errors/invalid_state_error.rb

@@ -0,0 +1,5 @@
+module Pastafari
+  module Errors
+    class InvalidStateError < StandardError; end
+  end
+end

data/lib/pastafari/fsm.rb

@@ -0,0 +1,44 @@
+require 'pastafari/state'
+
+module Pastafari
+  class Fsm
+    def self.build(&block)
+      raise ArgumentError unless block
+
+      builder = Builders::FsmBuilder.new
+      builder.instance_eval(&block)
+
+      builder.build
+    end
+
+    def run(input)
+      Array(input).map { |value| process(value) }
+    end
+
+    attr_reader :states, :transition_at, :current_state
+
+    private
+
+    def initialize(states, transition_at, initial_state)
+      @transition_at = transition_at
+      @states = states
+      @current_state = initial_state || states.first
+    end
+
+    def process(input)
+      transition!(input) if transition_at == :before
+
+      output = states[current_state].process(input)
+
+      transition!(input) if transition_at == :after
+
+      output
+    end
+
+    def transition!(input)
+      new_state = states[current_state].evaluate_transitions(input)
+
+      @current_state = new_state if new_state
+    end
+  end
+end

data/lib/pastafari/state.rb

@@ -0,0 +1,32 @@
+module Pastafari
+  class State
+    def self.build(name, &block)
+      raise ArgumentError unless block
+
+      builder = Builders::StateBuilder.new(name)
+      builder.instance_eval(&block)
+
+      builder.build
+    end
+
+    attr_accessor :name, :handler, :transitions
+
+    def process(input)
+      handler.call(input)
+    end
+
+    def evaluate_transitions(input)
+      transition = transitions.detect { |t| t.evaluate(input) }
+
+      transition&.next_state
+    end
+
+    private
+
+    def initialize(name, handler, transitions)
+      @name = name
+      @handler = handler
+      @transitions = transitions || []
+    end
+  end
+end

data/lib/pastafari/transition.rb

@@ -0,0 +1,21 @@
+module Pastafari
+  class Transition
+    def initialize(next_state)
+      @next_state = next_state
+    end
+
+    attr_reader :next_state, :evaluator
+
+    def when(&block)
+      raise ArgumentError unless block
+
+      @evaluator = block
+    end
+
+    def evaluate(input)
+      raise Pastafari::Errors::InvalidStateError unless evaluator
+
+      evaluator.call(input)
+    end
+  end
+end

data/lib/pastafari/version.rb

@@ -0,0 +1,3 @@
+module Pastafari
+  VERSION = '0.1.0'.freeze
+end

data/pastafari.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pastafari/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pastafari"
+  spec.version       = Pastafari::VERSION
+  spec.authors       = ["Joshua Tompkins"]
+  spec.email         = ["josh@joshtompkins.com"]
+
+  spec.summary       = "A library for creating simple finite state machines."
+  spec.homepage      = "https://github.com/jtompkins/pastafari"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency 'simplecov'
+end

data/sample/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'pastafari'

data/sample/README.md

@@ -0,0 +1,15 @@
+# Pastafari Sample App
+
+A simple sample app for Pastafari.
+
+## Installation
+
+```sh
+bundle install
+```
+
+## Usage
+
+```sh
+bundle exec ruby sample.rb
+```

data/sample/sample.rb

@@ -0,0 +1,29 @@
+require 'pastafari'
+
+fsm = Pastafari::Fsm.build do
+  transition :after
+
+  state :process_a do
+    process { 1 }
+
+    transition_to(:process_b).when { |i| i == 'a' }
+  end
+
+  state :process_b do
+    process { 2 }
+
+    transition_to(:process_c).when { |i| i == 'b' }
+  end
+
+  state :process_c do
+    process { 3 }
+  end
+end
+
+input = %w(a b c)
+
+puts "Running FSM for input: '#{input.join(', ')}'. Expected output: '1, 2, 3'"
+
+output = fsm.run(%w(a b c)).join(', ')
+
+puts "Received output: #{output}"

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: pastafari
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joshua Tompkins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: pry
+  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: pry-byebug
+  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: simplecov
+  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: 
+email:
+- josh@joshtompkins.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pastafari.rb
+- lib/pastafari/builders/fsm_builder.rb
+- lib/pastafari/builders/state_builder.rb
+- lib/pastafari/errors/invalid_state_error.rb
+- lib/pastafari/fsm.rb
+- lib/pastafari/state.rb
+- lib/pastafari/transition.rb
+- lib/pastafari/version.rb
+- pastafari.gemspec
+- sample/Gemfile
+- sample/README.md
+- sample/sample.rb
+homepage: https://github.com/jtompkins/pastafari
+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.1
+signing_key: 
+specification_version: 4
+summary: A library for creating simple finite state machines.
+test_files: []