lucidMachines 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e45b69e99c6fa792a59c07f778c2650116e627698dd6c7f59e19ea18d3999bdd
+  data.tar.gz: 75161768c35466c9b18479d4e29b89a689394f64a232779892abf1c158f1cf26
+SHA512:
+  metadata.gz: 26e5d9dc07e9a3ab1f62da9c9b0a69e6944d700051c900ab4874db4b88b20790833021afcaef0156d9d6a1e7778d5814ea1d2994f6bad4edabcac6277b1c2b0c
+  data.tar.gz: d759259eb5c5c22f4795392efdfbacac30d140c5183f1268b79b51aebc6685da6b125ac5caebeb9e01456f0a7dbb14448fb38ed95ae496cf3b8999884f39ed5a

data/.gitignore

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

data/.~lock.integration.csv#

@@ -0,0 +1 @@
+,jiii,jiii-mi,25.01.2019 22:33,file:///home/jiii/.config/libreoffice/4;

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 poqudrof@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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lucid-machines.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    lucidMachines (0.1.2)
+      aasm
+      aasm-diagram
+      ruby-graphviz
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aasm (5.0.6)
+      concurrent-ruby (~> 1.0)
+    aasm-diagram (0.1.2)
+      aasm (~> 5.0, >= 4.12)
+      ruby-graphviz (~> 1.2)
+    concurrent-ruby (1.1.5)
+    rake (10.5.0)
+    ruby-graphviz (1.2.4)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  lucidMachines!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,39 @@
+# Lucid::Machines
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/lucid/machines`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lucid-machines'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lucid-machines
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/lucid-machines. 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.
+
+## Code of Conduct
+
+Everyone interacting in the Lucid::Machines project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lucid-machines/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/aasm_export.rb

@@ -0,0 +1,380 @@
+# coding: utf-8
+
+module ChartReader
+
+  class AASMExport
+
+    EventCallbacks = ["before", "guards", "guard",
+                      "before_enter", "enter",
+                      "before_success",
+                      "success", "after",
+                      "error", "ensure"]
+    
+    GlobalEventCallbacks = ["before_all_events", "after_all_events",
+                            "error_on_all_events", "ensure_on_all_events"]
+
+    StateCallbacks = ["before_exit", "exit",
+                      "before_enter", "enter",
+                      "after_exit", "after_enter"]
+    
+    TransitionCallbacks = ["guard", "guards", "after", "success"]
+    GlobalTransitionCallbacks = ["after_all_transitions"]
+
+    attr_reader :method_names
+    
+    def initialize(chart)
+      @chart = chart
+      init_method_names
+      create
+    end
+
+    def init_method_names
+      @method_names = []
+    end
+
+    def method_names
+      # @method_names = @method_names.uniq
+      # return @method_names
+
+      # unique, no trailing spaces, inside spaces are underscores
+      @method_names.uniq.map{|t| sanitize(t)}
+    end
+
+    def sanitize(name)
+      name.strip.tr " ", "_"
+    end
+    
+    def create
+      @states = @chart.get_blocks_of_type "state"
+      @states = @states + @chart.get_blocks_of_type("Process")
+#      puts "States count: " + @states.size.to_s
+
+      @events = @chart.get_blocks_of_type "event"
+      @events = @events + @chart.get_blocks_of_type("Decision")
+#      puts "Events count: " + @events.size.to_s
+
+      ## Arrows between states are also events
+      ## handled in generate_events_code
+      
+      create_multi_events
+    end
+
+    attr_reader :transitions
+    
+    def create_multi_events
+      transitions = @chart.get_blocks_of_type("transition") +
+                      @chart.get_blocks_of_type("Summing Junction")
+
+      # puts transitions.size.to_s  + " found"
+      
+      @transitions = {}
+      # Hash with events as keys
+      ## Values:  Array of  [from_state, to_state]
+      ## ex:   {  event1 =>  [[[state1], state2], [[state1, state4], state3]] }
+
+#      puts "raw transitions found " + transitions.size.to_s
+      
+      ## select the valid one
+      transitions.each do |t|
+        # Link from a block. 
+        # and link to a block. 
+        # and link  from or to an event.
+
+        from_states = t.links_from_type("state") + t.links_from_type("Process")
+        to_state   = t.links_to_type("state") + t.links_to_type("Process")
+
+        event = t.links_to_type("event") + t.links_from_type("event")
+        event = event + t.links_to_type("Decision") + t.links_from_type("Decision")
+
+        priority = 0
+        t.links_from.each do |l, e|
+          if(l.text.to_i != 0)
+            priority =  l.text.to_i
+          end
+        end
+
+        ## Remove possible duplicate links...
+        from_states.uniq!
+        to_state.uniq!
+        event.uniq!
+        
+        if from_states.size < 1 or to_state.size != 1 or event.size != 1
+          print_warning(event, from_states, to_state)
+          next
+        end
+
+        event = event.first
+        to_state = to_state.first
+        
+#         puts "Adding, from " + from_states.first.text + " to " + to_state.text + " through " + event.text
+        ## get the ID from the link.
+
+        # Find the priority
+        all_links = t.links_to.merge(t.links_from)
+        prio = 0
+        from_states.each do |s|
+          link = all_links.key(to_state)
+          next if link.nil? or link.text.nil?
+          link_prio = link.to_i
+          prio = link_prio if link_prio > prio
+        end
+#        puts "Priority found " + prio.to_s  if prio != 0
+        
+        @transitions[event] = [] if @transitions[event].nil?
+        @transitions[event] << [from_states, to_state, priority, t]
+      end
+
+#      puts "Transitions found " + @transitions.size.to_s
+      
+    end
+
+    def print_warning(event, from_states, to_state)
+
+      if(event.size != 1)
+        puts "Warning: Transition without any event !" if event.size == 0
+
+        if event.size > 1
+          puts "Warning: Transition with multiple events !"
+          event.each do |e|
+            puts " - Event: " + e.to_s
+          end
+        end
+      end
+      
+      if(to_state != 1)
+        puts "Warning: Transition without output !" if to_state.size == 0
+        puts "Warning: Transition with multiple outputs !" if to_state.size > 1
+      end
+      
+      if(from_states.size < 1)
+        puts "Warning: Transition without input !" if from_states.size == 0
+      end
+    end
+    
+    
+    def generate_state_code
+      states_code = ""
+      @states.each do |state|
+
+        code = "      state :" + sanitize(state.text)
+        code = code + ", :initial => true" if state.initial
+
+        callback_code = generate_callback(state, "method", StateCallbacks)
+        
+        states_code = states_code + code + callback_code +  "\n"
+      end
+      states_code + "\n"
+    end
+
+
+    
+    def generate_events_code
+      
+      events_code = ""
+
+      ## Arrows between two blocks are events.
+      @chart.links.each_value do |link|
+        if (@chart.blocks[link.source].type == "state" or
+            @chart.blocks[link.source].type == "process") and
+          (@chart.blocks[link.destination].type == "state" or
+           @chart.blocks[link.destination].type == "process") and
+          not link.text.nil?
+          
+          name = sanitize(link.text)
+          
+          code = <<-SMALL_EVENT
+      event :#{name} do
+        transitions :from => :#{@chart.blocks[link.source].text}, :to => :#{@chart.blocks[link.destination].text}
+      end
+
+SMALL_EVENT
+
+          events_code = events_code + code
+        end
+      end
+      
+      @events.each do |event|
+        code = "      event :" + sanitize(event.text)
+
+        ## Add event :before  :after... 
+        callback_code = generate_callback(event, "method", EventCallbacks)
+        
+        code = code + callback_code + " do \n" 
+
+        ## Add the code if it is defined. 
+        code = code + generate_code_callback(event, EventCallbacks)
+        
+        ## Simple case:  This event links  from and to a state
+        inputs =  event.links_from_type "state"
+        outputs = event.links_to_type   "state"
+
+        inputs =  inputs + event.links_from_type("Process")
+        outputs = outputs + event.links_to_type("Process")
+
+        
+        if inputs.size > 0 and outputs.size == 1
+          transition = transition_code(event,
+                                       inputs,
+                                       outputs.first)
+          code = code + transition + "\n"
+
+        end
+
+        unless @transitions[event].nil?
+          ## Sort by ID if present
+
+          @sorted = @transitions[event].each.sort do |tr|
+            input, output, priority = tr
+            priority
+          end
+            
+          @sorted.each do |t|
+            inputs, output, priority, t_element = t
+            transition = transition_code(event, inputs, output)
+            transition_callback = generate_callback(t_element,
+                                                    "method",
+                                                    TransitionCallbacks)
+            code = code + transition + transition_callback + "\n"
+          end
+        end
+        
+        code = code + "      end\n\n" 
+        events_code = events_code + code
+      end
+
+      events_code
+    end
+
+    def transition_code(event, inputs, output)
+      
+      code = "        transitions :from => "
+      if inputs.size == 1
+        code = code + ":" + sanitize(inputs[0].text)
+      else
+        code = code + "["
+        inputs.each do |input|
+          code = code + ":" + sanitize(input.text) + ","
+        end
+        ## remove last "," 
+        code = code.chop + "]"
+      end
+
+      code = code + ", :to => :" + sanitize(output.text)
+      ## TODO: add options
+
+      # TransitionCallbacks
+      ## Add event :before  :after...  METHOD out of this
+      ## Not yet testable
+      #  callback_code = generate_callback(event, "method", TransitionCallbacks)
+      callback_code = ""
+      
+      return code + callback_code
+    end
+
+    def generate_callback(event, element_type, callbacks)
+
+      ## TODO: Handle the Guards -> create an array 
+      l1 = event.links_to.each.select{|link, e| e.type.eql? element_type  }
+      l2 = event.links_from.each.select{|link, e| e.type.eql? element_type }
+      links =  l1 + l2
+      code = ""
+      unless links.empty? 
+        links.each do |l|
+
+          link = l[0]
+          element = l[1]
+          if(callbacks.any? link.text)
+            code = code + ", :" + sanitize(link.text) +
+                   " => :" + sanitize(element.text)
+            
+            @method_names << element.text
+          end
+        end
+      end
+      return code
+    end
+
+    def generate_code_callback(event, callbacks)
+      l1 = event.links_to.each.select{|link, e| e.type.eql? "code"  }
+      l2 = event.links_from.each.select{|link, e| e.type.eql? "code" }
+      links =  l1 + l2
+      code = ""
+
+      unless links.empty? 
+        links.each do |l|
+          link = l[0]
+          element = l[1]
+
+          if(callbacks.any? link.text)
+            code = code +  "        " + link.text + " do"
+
+            if link.text == "error"
+              code = code + " |e|\n"
+            else
+              code = code + "\n"
+            end
+            indent = "          "
+            element.text.split("\n").each do |t|
+              code = code + indent + t
+            end
+
+            code = code + "\n        end\n"
+          end
+        end
+      end
+      return code
+    end
+
+    # Generate code that creates methods for each 
+    # method declared in the graph.
+    def generate_methods_placeholder
+      code = "\n"
+      method_names().each do |method_name|
+
+        code = code + <<-METH
+   def #{method_name}        
+      puts "Please implement the method #{method_name}" 
+      true
+   end
+
+METH
+      end
+      return code
+    end
+
+    # Generate methods that are not already
+    # Defined in the class.
+    def generate_methods_placeholder_for(klass, debug: true)
+      method_names().each do |method_name|
+        if klass.method_defined? method_name.to_sym
+          puts "Found: #{method_name}. " if debug
+          next
+        end
+        
+        puts "To implement: #{method_name}. " if debug
+        klass.define_method method_name.to_sym do
+          puts "Please implement the method #{method_name}" 
+          true
+        end
+        
+      end
+    end
+
+    # Export the document to code (String)
+    # It exports only the aasm code, not the
+    # methods called by it.
+    def export
+      start = <<-START
+    aasm do
+START
+
+      finish = <<-END
+   end
+END
+      return  start + generate_state_code +
+              generate_events_code + finish 
+#              generate_methods_placeholder 
+    end
+  end
+  
+end

data/bin/console

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