petrinet 0.1.0

data/lib/petrinet/net.rb

@@ -0,0 +1,158 @@
+require 'set'
+require_relative 'pnml_builder'
+require_relative 'graphviz_builder'
+require_relative 'animated_gif_builder'
+
+module Petrinet
+  # Represents a Petri Net in a particular state. Instances of this class are immutable. The following methods return
+  # new instances:
+  #
+  # * mark
+  # * fire
+  #
+  # The internal representation uses a VASS - https://en.wikipedia.org/wiki/Vector_addition_system
+  # A good explanation of how this works with Petri Nets is here: https://github.com/bitwrap/bitwrap-io/blob/master/whitepaper.md
+  #
+  class Net
+    def self.from_pnml(xml)
+      builder = PnmlBuilder.new(xml)
+      builder.net
+    end
+
+    def self.build(&proc)
+      builder = Builder.new
+      proc.call(builder)
+      builder.net
+    end
+
+    attr_reader :prefire_transition_name
+
+    def initialize(state_vector, place_index_by_place_name, transition_vectors_by_transition_name, prefire_transition_name = nil)
+      @state_vector = state_vector
+      @place_index_by_place_name = place_index_by_place_name
+      @transition_vectors_by_transition_name = transition_vectors_by_transition_name
+      @prefire_transition_name = prefire_transition_name
+      freeze
+    end
+
+    # Marks the petri net and returns a new instance
+    def mark(marking)
+      new_state_vector = Array.new(@state_vector.size, 0)
+      marking.each do |place_name, token_count|
+        index = @place_index_by_place_name[place_name]
+        new_state_vector[index] = token_count
+      end
+      self.class.new(new_state_vector, @place_index_by_place_name, @transition_vectors_by_transition_name)
+    end
+
+    def fire(transition_name)
+      new_state_vector = new_state_vector(transition_name)
+      self.class.new(new_state_vector, @place_index_by_place_name, @transition_vectors_by_transition_name)
+    end
+
+    def prefire(transition_name)
+      self.class.new(@state_vector, @place_index_by_place_name, @transition_vectors_by_transition_name, transition_name)
+    end
+
+    def fireable?(transition_name)
+      begin
+        new_state_vector(transition_name)
+        true
+      rescue
+        false
+      end
+    end
+
+    def fireable
+      result = Set.new
+      @transition_vectors_by_transition_name.keys.each do |transition_name|
+        begin
+          fire(transition_name)
+          result.add(transition_name)
+        rescue => ignore
+          # It wasn't fireable - ignore it
+        end
+      end
+      result
+    end
+
+    def to_svg
+      builder = GraphvizBuilder.new(self, @transition_vectors_by_transition_name, @place_index_by_place_name.invert, @state_vector)
+      builder.svg
+    end
+
+    def to_animated_gif(transition_names, gif_path)
+      builder = AnimatedGifBuilder.new(self)
+      builder.write(transition_names, gif_path)
+    end
+
+    private
+
+    def new_state_vector(transition_name)
+      transition_vectors = @transition_vectors_by_transition_name[transition_name]
+      raise "Unknown transition: #{transition_name}. Known transitions: #{@transition_vectors_by_transition_name.keys}" if transition_vectors.nil?
+      transition_vectors.reduce(@state_vector) do |state_vector, transition_vector|
+        v = state_vector.zip(transition_vector).map { |s, t| s + t }
+        raise "Cannot fire: #{transition_name}" unless valid?(v)
+        v
+      end
+    end
+
+    def valid?(state_vector)
+      !(state_vector.any? { |s| s.negative? })
+    end
+
+    class Builder
+      def initialize
+        @place_names = Set.new
+        @transition_by_name = Hash.new
+        @state_vector = []
+      end
+
+      def transition(transition_name, arcs)
+        take_place_names = [arcs[:take]].flatten
+        give_place_names = [arcs[:give]].flatten
+        @place_names.merge(take_place_names)
+        @place_names.merge(give_place_names)
+        @transition_by_name[transition_name] = Transition.new(take_place_names, give_place_names)
+      end
+
+      def net
+        place_index_by_place_name = Hash.new do |h, k|
+          index = h.size
+          @state_vector[index] = 0
+          h[k] = index
+        end
+
+        transition_vectors_by_transition_name_pairs = @transition_by_name.map do |transition_name, transition|
+          [transition_name, transition.to_vectors(@place_names.size, place_index_by_place_name)]
+        end
+        transition_vectors_by_transition_name = Hash[transition_vectors_by_transition_name_pairs]
+
+        Net.new(@state_vector.freeze, place_index_by_place_name.freeze, transition_vectors_by_transition_name.freeze)
+      end
+
+      class Transition
+        def initialize(take_place_names, give_place_names)
+          @take_place_names = take_place_names
+          @give_place_names = give_place_names
+        end
+
+        def to_vectors(size, place_index_by_place_name)
+          take_vector = Array.new(size, 0)
+          @take_place_names.each do |take_place_name|
+            index = place_index_by_place_name[take_place_name]
+            take_vector[index] -= 1
+          end
+
+          give_vector = Array.new(size, 0)
+          @give_place_names.each do |give_place_name|
+            index = place_index_by_place_name[give_place_name]
+            give_vector[index] += 1
+          end
+          [take_vector, give_vector]
+        end
+      end
+    end
+  end
+end

data/lib/petrinet/pnml_builder.rb

@@ -0,0 +1,71 @@
+require 'nokogiri'
+
+module Petrinet
+  class PnmlBuilder
+    def initialize(xml)
+      @xml = xml
+    end
+
+    def net
+      doc = Nokogiri::XML(@xml)
+
+      transition_by_id = {}
+      place_by_id = {}
+      edges = []
+
+      transitions = Hash.new {|h, k| h[k] = {take: [], give: []}}
+      markings = Hash.new
+
+      # https://github.com/bitwrap/bitwrap-io/blob/master/bitwrap_io/machine/pnml.py#L216
+
+      doc.xpath('//place').each do |place_node|
+        place_id = place_node[:id].to_sym
+        initial_marking_nodes = place_node.xpath('initialMarking/value/text()')
+        initial_marking = initial_marking_nodes.empty? ? 0 : initial_marking_nodes[0].text.split(',')[1].to_i
+
+        # place = Place.new(initial_marking)
+        # place_by_id[place_id] = place
+
+        # TODO: Remove
+        markings[place_id] = initial_marking
+      end
+
+      doc.xpath('//transition').each do |transition_node|
+        transition_id = transition_node[:id].to_sym
+
+        # transition = Transition.new
+        # transition_by_id[transition_id] = transition
+
+        # TODO: Remove
+        transitions[transition_id]
+      end
+
+      doc.xpath('//arc').each do |arc_node|
+        source_id = arc_node[:source].to_sym
+        target_id = arc_node[:target].to_sym
+
+        # edge = Edge.new(source_id, target_id)
+        # edges.push(edge)
+
+        if transitions.has_key?(source_id)
+          transition_name = source_id
+          place_name = target_id
+          transitions[transition_name][:give] << place_name
+        elsif transitions.has_key?(target_id)
+          transition_name = target_id
+          place_name = source_id
+          transitions[transition_name][:take] << place_name
+        else
+          raise "Unknown transition name in one of: #{source_id} -> #{target_id}"
+        end
+      end
+
+      net = Net.build do |b|
+        transitions.each do |transition_name, places|
+          b.transition(transition_name, take: places[:take], give: places[:give])
+        end
+      end
+      net.mark(markings)
+    end
+  end
+end

data/lib/petrinet/version.rb

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

data/lib/petrinet.rb

@@ -0,0 +1,8 @@
+require "petrinet/version"
+require "petrinet/net"
+require "petrinet/marking_transition_script"
+
+module Petrinet
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/petrinet.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "petrinet/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "petrinet"
+  spec.version       = Petrinet::VERSION
+  spec.authors       = ["Aslak Hellesøy"]
+  spec.email         = ["aslak.hellesoy@smartbear.com"]
+
+  spec.summary       = %q{Petri Net simulator}
+  spec.description   = spec.description
+  spec.homepage      = "https://github.com/cucumber/petrinet"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "#{spec.homepage}.git"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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 "nokogiri", "~> 1.10.4"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: petrinet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aslak Hellesøy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: ''
+email:
+- aslak.hellesoy@smartbear.com
+executables:
+- petrinet
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- examples/cucumber-protocol/cucumber-protocol.xml
+- examples/cucumber-protocol/transition_sample_1.gif
+- examples/cucumber-protocol/transition_sample_1.txt
+- examples/voting/voting.xml
+- examples/x-ray-machine/v1-problem.gif
+- examples/x-ray-machine/v1-problem.txt
+- examples/x-ray-machine/v2-fixed.gif
+- examples/x-ray-machine/v2-fixed.txt
+- examples/x-ray-machine/x-ray-machine-1.xml
+- examples/x-ray-machine/x-ray-machine-2.xml
+- exe/petrinet
+- lib/petrinet.rb
+- lib/petrinet/animated_gif_builder.rb
+- lib/petrinet/graphviz_builder.rb
+- lib/petrinet/marking_transition_script.rb
+- lib/petrinet/net.rb
+- lib/petrinet/pnml_builder.rb
+- lib/petrinet/version.rb
+- petrinet.gemspec
+homepage: https://github.com/cucumber/petrinet
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/cucumber/petrinet
+  source_code_uri: https://github.com/cucumber/petrinet.git
+  changelog_uri: https://github.com/cucumber/petrinet/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Petri Net simulator
+test_files: []