statesman_viz 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63b5b866bd27273946a7ae91bf7d7da411915e5e7890c968743913e3f2720e87
+  data.tar.gz: a85a519b1e5b5cf5d999f31f504a4e318e7cff7cef0201caefd46179076187c6
+SHA512:
+  metadata.gz: 817eac5a2a8957d8bee0cb6512c17272bfa499299e2838a7bdd862362a78902dcab6a787480147b5c82b66ef80f31290ccbc70cd24feae220239bda36a2e1935
+  data.tar.gz: e4556618df3cd886dc5203a676fac6ba201d7ce10cd0fd169d680a99ec00af1b9c9150c702ca1c5e74f3a94135a0c59c4f70e04b827e39e1d1e5d3e5c14b3d81

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.5.0
+before_install:
+  - sudo apt-get install graphviz
+  - gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sanniabdulmusawwir@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 statesman_viz.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sanni Abdulmusawwir
+
+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,91 @@
+# StatesmanViz [![Build Status](https://travis-ci.org/Sannim1/statesmanviz.svg?branch=master)](https://travis-ci.org/Sannim1/statesmanviz)
+
+A tool for visualizing state machines defined using [Statesman](https://github.com/gocardless/statesman)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'statesman_viz'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install statesman_viz
+
+## Usage
+- Define a [Statesman](https://github.com/gocardless/statesman) state machine like below.
+
+```ruby
+class OrderStateMachine
+  include Statesman::Machine
+
+  state :pending, initial: true
+  state :checking_out
+  state :purchased
+  state :shipped
+  state :cancelled
+  state :failed
+  state :refunded
+
+  transition from: :pending,      to: [:checking_out, :cancelled]
+  transition from: :checking_out, to: [:purchased, :cancelled]
+  transition from: :purchased,    to: [:shipped, :failed]
+  transition from: :shipped,      to: :refunded
+
+  guard_transition(to: :checking_out) do |order|
+    order.products_in_stock?
+  end
+
+  before_transition(from: :checking_out, to: :cancelled) do |order, transition|
+    order.reallocate_stock
+  end
+
+  before_transition(to: :purchased) do |order, transition|
+    PaymentService.new(order).submit
+  end
+
+  after_transition(to: :purchased) do |order, transition|
+    MailerService.order_confirmation(order).deliver
+  end
+end
+```
+
+- Invoke `StatesmanViz` to generate the state machine diagram.
+
+```ruby
+StatesmanViz.generate(OrderStateMachine)
+```
+
+- The output diagram is saved as `OrderStateMachine.png` in the current working directory.
+
+![OrderStateMachine.png](OrderStateMachine.png)
+
+## Development
+
+TODO
+
+<!-- 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/sannim1/statesmanviz. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the StatesmanViz project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sannim1/statesmanviz/blob/master/CODE_OF_CONDUCT.md).
+
+## Credit
+
+Thanks to [Tadas Sasnauskas](https://github.com/tadas-s) and the lovely people at [Ruby Hacknight - London](https://www.meetup.com/ruby-hacknight-london/) ❤️

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 "statesman_viz"
+
+# 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/run_statesman_viz

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "statesman_viz"
+require "statesman"
+
+class OrderStateMachine
+  include Statesman::Machine
+
+  state :pending, initial: true
+  state :checking_out
+  state :purchased
+  state :shipped
+  state :cancelled
+  state :failed
+  state :refunded
+
+  transition from: :pending,      to: [:checking_out, :cancelled]
+  transition from: :checking_out, to: [:purchased, :cancelled]
+  transition from: :purchased,    to: [:shipped, :failed]
+  transition from: :shipped,      to: :refunded
+
+  guard_transition(to: :checking_out) do |order|
+    order.products_in_stock?
+  end
+
+  before_transition(from: :checking_out, to: :cancelled) do |order, transition|
+    order.reallocate_stock
+  end
+
+  before_transition(to: :purchased) do |order, transition|
+    PaymentService.new(order).submit
+  end
+
+  after_transition(to: :purchased) do |order, transition|
+    MailerService.order_confirmation(order).deliver
+  end
+end
+
+StatesmanViz.generate(OrderStateMachine)
+
+# state_graph = GraphViz.new( :G, :type => :digraph )
+
+# node_map = {}
+# OrderStateMachine.states.each do |state|
+#   node_map[state] = state_graph.add_nodes(state)
+# end
+
+# OrderStateMachine.successors.each do |from_state, to_states|
+#   to_states.each do |to_state|
+#     state_graph.add_edges(node_map[from_state], node_map[to_state])
+#   end
+# end
+
+# state_graph.output( :png => "orderstatemachine.png" )

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/statesman_viz.rb

@@ -0,0 +1,40 @@
+require "statesman_viz/version"
+require "graphviz"
+
+module StatesmanViz
+  class << self
+    def generate(state_machine_class)
+      unless state_machine_class.respond_to?(:states)
+        raise ArgumentError, "State machine class must respond to `.states`"
+      end
+      unless state_machine_class.respond_to?(:successors)
+        raise ArgumentError, "State machine class must respond to `.successors`"
+      end
+
+      state_graph = GraphViz.new( :G, :type => :digraph )
+
+      node_map = {}
+      state_machine_class.states.each do |state|
+        state = state.to_s
+        node_map[state] = state_graph.add_nodes(state)
+      end
+
+      state_machine_class.successors.each do |from_state, to_states|
+        from_state = from_state.to_s
+        to_states.each do |to_state|
+          to_state = to_state.to_s
+          state_graph.add_edges(node_map[from_state], node_map[to_state])
+        end
+      end
+
+      output_file_path = "/tmp/StatesmanViz"
+      unless Dir.exists?(output_file_path)
+        FileUtils.mkdir_p(output_file_path)
+      end
+
+      output_file_name = File.join(output_file_path, "#{state_machine_class.to_s}.png")
+
+      state_graph.output(:png => output_file_name)
+    end
+  end
+end

data/lib/statesman_viz/version.rb

@@ -0,0 +1,3 @@
+module StatesmanViz
+  VERSION = "0.1.1"
+end

data/statesman_viz.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "statesman_viz/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "statesman_viz"
+  spec.version       = StatesmanViz::VERSION
+  spec.authors       = ["Sanni Abdulmusawwir"]
+  spec.email         = ["sanniabdulmusawwir@gmail.com"]
+
+  spec.summary       = "A tool for visualizing Statesman statemachines"
+  spec.description   = "A tool for visualizing Statesman statemachines"
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  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"] = ""
+  # 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_dependency "ruby-graphviz", "~> 1.2"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "statesman", "~> 3.4.1"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: statesman_viz
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Sanni Abdulmusawwir
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: statesman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.1
+description: A tool for visualizing Statesman statemachines
+email:
+- sanniabdulmusawwir@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- OrderStateMachine.png
+- README.md
+- Rakefile
+- bin/console
+- bin/run_statesman_viz
+- bin/setup
+- lib/statesman_viz.rb
+- lib/statesman_viz/version.rb
+- statesman_viz.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.3
+signing_key: 
+specification_version: 4
+summary: A tool for visualizing Statesman statemachines
+test_files: []