simple_state 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d51d05c5b496ea37f1552970663fdef75edf0cc
+  data.tar.gz: 9baff062c6e20cf27fa1b11e74950fc64a870a43
+SHA512:
+  metadata.gz: 64c97493796f1d83dafce345d99b2ccc832c04e8a0a6ddda923cd0c21e973ade1337a13ae5bdcaac7f527e5b6c7a31eee521309a9788e36e195e1e7818927c0d
+  data.tar.gz: ba79834fa016146ded67fe6188d8b4f10570e250525285aabbb9d5eb49014ba9cddbf8a7f817c971f47547b962e3e5d9499738531dc50d97d402b9247fe44094

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,42 @@
+AllCops:
+  Include:
+    - '**/*.gemspec'
+    - '**/Rakefile'
+  Exclude:
+    - 'vendor/**/*'
+    - db/**/*
+    - config/**/*
+    - script/**/*
+    - spec/dummy/**/*
+    - bin/**/*
+    - !ruby/regexp /old_and_unused\.rb$/
+  DisplayCopNames: true
+
+LineLength:
+  Max: 160
+
+BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+Alias:
+  EnforcedStyle: prefer_alias_method
+
+Documentation:
+  Enabled: false
+
+MethodLength:
+  Max: 15
+
+AbcSize:
+  Max: 20
+
+ClassAndModuleChildren:
+  Enabled: false
+
+FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in simple_state.gemspec
+gemspec
+
+group :test, :development do
+  gem "pry"
+end

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    simple_state (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.1)
+    diff-lcs (1.3)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simple_state!
+
+BUNDLED WITH
+   1.13.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Przemek Lusar
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Przemek Lusar
+
+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,55 @@
+# SimpleState [![Build Status](https://travis-ci.org/lluzak/simple_state.svg?branch=master)](https://travis-ci.org/lluzak/simple_state)
+
+Dead simple state machine for modular usage.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_state'
+```
+
+## Usage
+
+``` ruby
+class Unit
+  def initialize(state:)
+    @state = state
+  end
+
+  attr_accessor :state
+end
+
+unit = Unit.new(state: :pending)
+
+state_machine = SimpleState::Machine.new(unit, :state) do
+  state :pending, :outsourced, :printed, :matched, :dispatched, :cancelled
+
+  transition :print, from: [:pending, :outsourced], to: :printed
+  transition :match, from: :printed, to: :matched
+  transition :ship, from: :matched, to: :dispatched
+  transition :cancel, from: [:pending, :outsourced, :printed, :matched], to: :cancelled
+end
+
+state_machine.can_print?
+state_machine.print!
+
+state_machine.match!
+state_machine.can_cancel?
+
+```
+
+## 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/lluzak/simple_state. 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,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 "simple_state"
+
+# 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/simple_state.rb

@@ -0,0 +1,7 @@
+require "simple_state/version"
+require "simple_state/definition"
+require "simple_state/machine"
+
+module SimpleState
+  TransitionError = Class.new(StandardError)
+end

data/lib/simple_state/definition.rb

@@ -0,0 +1,23 @@
+class SimpleState::Definition
+  def self.define(&block)
+    new(&block).definition
+  end
+
+  attr_reader :definition
+
+  def initialize(&block)
+    @definition = { transitions: {} }
+
+    instance_exec(&block)
+  end
+
+  private
+
+  def transition(name, to:, from:)
+    @definition[:transitions][name] = { from: [*from], to: to }
+  end
+
+  def state(*states)
+    @definition[:states] = states
+  end
+end

data/lib/simple_state/machine.rb

@@ -0,0 +1,36 @@
+module SimpleState
+  class Machine
+    def initialize(object, state_attribute = :state, definition = nil, &block)
+      @object          = object
+      @state_attribute = state_attribute
+      @definition      = definition || SimpleState::Definition.define(&block)
+
+      define_trasition_methods
+    end
+
+    private
+
+    def transitions
+      @definition[:transitions]
+    end
+
+    def define_trasition_methods
+      transitions.each { |name, options| define_transition_method(name, options) }
+    end
+
+    def define_transition_method(name, from:, to:)
+      define_singleton_method(:"can_#{name}?") do
+        current_state = @object.public_send(@state_attribute)
+        from.include?(current_state.to_sym)
+      end
+
+      define_singleton_method(:"#{name}!") do
+        unless public_send(:"can_#{name}?")
+          raise TransitionError, "Unable to transition from #{@object.public_send(@state_attribute)} to #{to}"
+        end
+
+        @object.public_send(:"#{@state_attribute}=", to)
+      end
+    end
+  end
+end

data/lib/simple_state/version.rb

@@ -0,0 +1,3 @@
+module SimpleState
+  VERSION = "0.1.0".freeze
+end

data/simple_state.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simple_state/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_state"
+  spec.version       = SimpleState::VERSION
+  spec.authors       = ["Przemek Lusar"]
+  spec.email         = ["lluzak@gmail.com"]
+
+  spec.summary       = "Simple state machine"
+  spec.description   = "Simplified state machine on bare Ruby",
+                       spec.homepage      = "https://github.com/lluzak/simple_state",
+                       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"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: simple_state
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Przemek Lusar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: '["Simplified state machine on bare Ruby", "https://github.com/lluzak/simple_state",
+  "MIT"]'
+email:
+- lluzak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_state.rb
+- lib/simple_state/definition.rb
+- lib/simple_state/machine.rb
+- lib/simple_state/version.rb
+- simple_state.gemspec
+homepage: https://github.com/lluzak/simple_state
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Simple state machine
+test_files: []