petrinet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca5cb3389ec8322e7851cf937e15b1d7fef235b22f88f2897f5eba513bb3231e
+  data.tar.gz: 71ff8229ac9063bc50ec0fb4bf1b163c9dd9d40ac51c2ed21f53c53ebdabfd67
+SHA512:
+  metadata.gz: ed35c9308bfc520d96f40fdd4a63e7294d9996d0d0bc1eaabc30be003af2ffead875dc2c763ed8644303984dd4e7ad5e0d8e3a65b048efc8694ac0a6aea6e68b
+  data.tar.gz: c3626f4573b6ea2ad70605103c2d165ef7299c5421b2c24d28c72693708a6ee0dab8349accac37246cce1d6704babc7ab39964285b6fef7111190186054cb14c

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.0.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Aslak Hellesøy
+
+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/Makefile

@@ -0,0 +1,33 @@
+SHELL := /usr/bin/env bash
+PNML_FILES=$(wildcard examples/**/*.xml)
+SVG_FILES=$(wildcard examples/**/**/*.svg)
+RUBY_FILES=$(wildcard lib/**/*.rb)
+
+.SECONDARY:
+
+default: .rspec_ok examples/cucumber-protocol/transition_sample_1.gif examples/x-ray-machine/v1-problem.gif examples/x-ray-machine/v2-fixed.gif
+
+.rspec_ok: Gemfile.lock $(RUBY_FILES)
+	bundle exec rspec
+	touch $@
+
+Gemfile.lock: Gemfile
+	bundle install
+	touch $@
+
+examples/cucumber-protocol/transition_sample_1.gif: examples/cucumber-protocol/cucumber-protocol.xml Gemfile.lock $(RUBY_FILES) exe/petrinet
+	ruby -Ilib exe/petrinet --script examples/cucumber-protocol/transition_sample_1.txt --output $@ $<
+
+examples/x-ray-machine/v1-problem.gif: examples/x-ray-machine/x-ray-machine-1.xml Gemfile.lock $(RUBY_FILES) exe/petrinet
+	ruby -Ilib exe/petrinet --script examples/x-ray-machine/v1-problem.txt --output $@ $<
+
+examples/x-ray-machine/v2-fixed.gif: examples/x-ray-machine/x-ray-machine-2.xml Gemfile.lock $(RUBY_FILES) exe/petrinet
+	ruby -Ilib exe/petrinet --script examples/x-ray-machine/v2-fixed.txt --output $@ $<
+
+clean:
+	rm -f examples/**/*.gif .rspec_ok
+.PHONY: clean
+
+clobber: clean
+	rm -f Gemfile.lock
+.PHONY: clobber

data/README.md

@@ -0,0 +1,73 @@
+# Petrinet
+
+A command line utility for generating animated gifs of petri nets. This tool is designed to support living
+documentation and test-driven development of systems that can be modelled with petri nets.
+
+## Example
+
+An X-Ray machine in a hospital, taken from [Modeling Business Processes - A Petri Net-Oriented Approach](https://mitpress.mit.edu/books/modeling-business-processes).
+
+![x-ray](./examples/x-ray-machine/v2-fixed.gif)
+
+The input for generating this gif is two file:
+
+* a [PNML](https://en.wikipedia.org/wiki/Petri_Net_Markup_Language) file, for example created with 
+  [PIPE](https://sarahtattersall.github.io/PIPE/) or other petri net diagramming tool.
+* a *marking-transition* script
+
+## Marking-Transition script
+
+This is a simple text file to specify the initial *marking* of the net, and transitions to fire. The animation
+above was generated from the following marking file:
+
+```
+wait:3
+free:1
+enter
+make_photo
+leave
+enter
+make_photo
+leave
+enter
+make_photo
+leave
+```
+
+This file can be written by hand, or it can be generated.
+
+### Generating a Marking-Transition script
+
+There are two typical ways to generate a marking-transition script - either via *controlled* automated tests,
+or from a running production system. Both of them require the system to *log* internal events and commands.
+
+A specialised (but simple) tool could parse those logs and generate a marking-transition script, which can then
+be fed to `petrinet` for validation and generation of living documentation in the form of animated petri nets.
+
+## Installation
+
+You need the following tools installed:
+
+* Graphviz - the `dot` executable must be on your `PATH`
+* ImageMagick - the `convert` executable must be on your `PATH`
+* Ruby
+
+Then run the following from the command line:
+
+    gem install petrinet
+
+## Usage
+
+You need a `.pnml` file that describes your net, and a `.txt` marking-transition file. Generate an animated gif:
+
+    petrinet --script my-marking-transition.txt my-petri-net-pnml.xml
+
+This will generate a file named `my-marking-transition.gif` (the name is derived from the `.txt` file)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cucumber/petrinet.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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