lucidMachines 0.1.2

data/lib/lucidMachines/chart.rb

@@ -0,0 +1,132 @@
+class Chart
+  attr_reader :pages, :blocks, :links
+  
+  def initialize
+    @pages = {}
+    @blocks = {}
+    @links = {}
+  end
+
+  def states
+    @blocks.each_value.select{|b| b.is_state?}
+  end
+
+  def states_on_page(page)
+    @blocks.each_value.select{|b| b.is_state? and b.page == page }
+  end
+
+  def blocks_on_page(page)
+    @blocks.each_value.select{|b| b.page == page }
+  end
+
+  def get_blocks_of_type(type)
+    @blocks.each_value.select do |b|
+      b.type.eql? type
+    end
+  end
+
+  
+  def add_page(page)
+    @pages[page.id] = page
+  end
+
+  def get_page(id)
+    return @pages[id]
+  end
+
+  def page(name_to_find)
+    out = @pages.values.select do |p|
+      p.name.eql? name_to_find
+    end
+
+    return nil if out.empty?
+    return out.first
+  end
+
+  # same for blocks
+  def add_block(b) ;  @blocks[b.id] = b; end 
+  def get_block(id); @blocks[id] ; end
+
+  # same for links
+  def add_link(l) ;  @links[l.id] = l; end 
+  def get_link(id); @links[id] ; end
+
+  def has_block?(id)
+    @blocks.has_key? id
+  end
+  
+  
+  # replace text with objects
+  def set_pages
+    @pages.each_value do |page|
+      @blocks.each_value do |block|
+        page.set_block(block.id, block) if block.page_id == page.id
+      end
+      @links.each_value do |link|
+        link.set_page(page) if link.page_id == page.id
+      end
+    end
+  end
+
+  # replace text with objects
+  def set_links
+    @links.each_value do |link|
+      source_block = get_block(link.source)
+      destination_block = get_block(link.destination)
+
+      next if source_block.nil? or destination_block.nil?
+      
+      source_block.link_to destination_block, link
+      destination_block.link_from source_block, link
+    end
+  end
+
+  def check_initial
+    @blocks.each_value do |b|
+      next unless b.has_links?
+      b.links_from.each_value do |b2|
+        if b2.text.eql? "Initial"
+          b2.hide
+          b.set_initial
+        end
+      end
+    end
+  end
+
+
+  def subchart_for_page(page)
+    chart = Chart.new
+
+    # add the page 
+    chart.add_page!( { page.id => page} )
+
+    # add the blocks of this page
+
+    @blocks.each do |block_id, block|
+      next unless block.page == page
+      chart.add_block!({ block_id => block })
+    end
+    
+    # add the links of this page
+    @links.each do |link_id, link|
+      next unless link.page == page
+      chart.add_link!({ link_id => link })
+    end
+
+    return chart
+  end
+
+  def add_page!(page)
+    @pages.merge!(page)
+  end
+  
+  def add_block!(block)
+    @blocks.merge!(block)
+  end
+
+  def add_link!(link)
+    @links.merge!(link)
+  end
+  
+end
+

data/lib/lucidMachines/cli.rb

@@ -0,0 +1,68 @@
+require 'thor'
+require 'ruby-graphviz'
+
+module LucidMachines
+  class CLI < Thor
+
+    desc "convert", "Convert a CSV file"
+    def convert(csv_file, sheet)
+
+      puts "Exporting #{csv_file}, sheet: #{sheet}."
+      
+      chart =  ChartLoader.new(csv_file).chart
+      # export_all chart
+      export(chart, sheet)
+    end
+
+  end
+end
+
+
+
+# # coding: utf-8
+# require 'ruby-graphviz'
+# require 'csv'
+
+# require 'aasm'
+# require 'aasm-diagram'
+
+# require './loader'
+# require './elements'
+# require './chart'
+# require './aasm_export'
+# require './graphviz_export'
+# require './exporter'
+
+# # IRB.CurrentContext.echo = true
+# include ChartReader
+
+# # chart =  ChartLoader.new("integration2.csv").chart; nil;
+
+# chart =  ChartLoader.new("integration.csv").chart
+# # export_all chart
+# export(chart,"state machine def")
+# export(chart,"ex4")
+# export(chart,"ex3")
+
+
+# # p_ex2 = @chart.page "ex2" ; nil ;
+# # @ex2 = @chart.subchart_for_page p_ex2; nil ;
+# # GraphVizExport.new(@ex2).build_graph("chart-ex2.png") ;  nil ;
+
+
+# # @ae = AASMExport.new(@ex2); nil ; 
+# # JobTest.class_eval @ae.export
+# # @ae.generate_methods_placeholder_for(JobTest)
+
+
+# # @j = JobTest.new
+# # ## Todo write in a file ?
+
+# # AASMDiagram::Diagram.new(@j.aasm, 'ex2-2.png')
+
+# # open('ex2.rb', 'w') do |f|
+# #   f << @ae.export
+# #   f << @ae.generate_methods_placeholder
+# # end
+
+

data/lib/lucidMachines/elements.rb

@@ -0,0 +1,107 @@
+class Element
+  attr_reader :id, :page_id
+  attr_reader :text, :type
+
+  attr_reader :page
+  attr_reader :initial, :hidden
+  
+  def initialize(entry)
+    @id = entry["Id"]
+    @type = entry["Name"]
+    @text = entry["Text Area 1"]
+    @page_id = entry["Page ID"]
+    @link_to = {}
+    @link_from = {}
+    @initial = false
+  end
+  
+  def set_initial ; @initial = true; end
+  def is_initial? ; @initial; end
+
+  def hide ; @hidden = true; end
+  def is_hidden? ; @hidden; end
+
+  def is_state?
+
+    # not is_hidden? and has_links? and not text.nil?
+    return false if is_hidden? or not has_links?
+
+    if text.nil?
+      type.eql? "transition"
+    else
+      true
+    end
+  end
+  
+  def link_to(element, link)
+    @link_to[link] = element
+  end
+
+  def link_from(element, link)
+    @link_from[link] = element
+  end
+
+  def links_to; @link_to; end
+  def links_from; @link_from; end
+
+  def links_to_type(type)
+    @link_to.each_value.select{ |b| b.type.eql? type }
+  end
+
+  def links_from_type(type)
+    @link_from.each_value.select{ |b| b.type.eql? type }
+  end
+
+  
+  def has_links?
+    @link_to.size != 0 or @link_from.size != 0
+  end
+  
+  def set_page(p)
+    @page = p
+  end
+
+  def to_s
+    "Element: " + @id
+  end
+end
+
+class Page < Element
+  attr_reader :name
+  attr_reader :blocks
+  
+  def initialize(entry)
+    super(entry)
+    puts "ERROR: You cannot create this page" unless is_page? entry
+    @name = entry["Text Area 1"]
+    @blocks = {}
+  end
+
+  def set_block(id, block)
+    @blocks[id] = block
+    block.set_page(self)
+  end
+  
+  def to_s
+    "Page: " + @name.to_s
+  end
+
+end
+
+class Link < Element
+  attr_reader :source, :destination
+  attr_reader :source_arrow, :destination_arrow
+  
+  def initialize(entry)
+    super(entry)
+    @source = entry["Line Source"]
+    @destination = entry["Line Destination"]
+
+    @source_arrow = entry["Source Arrow"]
+    @destination_arrow= entry["Destination Arrow"]
+  end
+
+  def to_s
+    "Link : " + @source.to_s + " -> " + @destination.to_s
+  end
+end

data/lib/lucidMachines/exporter.rb

@@ -0,0 +1,39 @@
+class JobTest
+  include AASM
+  def tie_shoes
+    puts "Tying the shoes ..."
+  end
+end
+
+def export_all(chart)
+  chart.pages.each_value do |p|
+    export(chart, p.name)
+  end
+end
+
+def export(chart, page_name)
+  p_ex2 = chart.page page_name
+  page = chart.subchart_for_page p_ex2
+
+  # export  GraphViz 1
+  GraphVizExport.new(page).build_graph("export/chart-#{page_name}.png")
+
+  # export AASM
+  page_aasm_export = AASMExport.new(page)
+
+  # export to a file
+  open("export/#{page_name}_generated.rb", 'w') do |f|
+    f << page_aasm_export.export
+    f << page_aasm_export.generate_methods_placeholder
+  end
+  
+  # export GraphViz 2  (through aasm-diagram)
+
+  ## Extend the JobTest class
+  # JobTest.class_eval page_aasm_export.export
+  # page_aasm_export.generate_methods_placeholder_for(JobTest)
+  # @j = JobTest.new
+  # AASMDiagram::Diagram.new(@j.aasm, "export/chart-#{page_name}-2.png")
+
+end
+

data/lib/lucidMachines/graphviz_export.rb

@@ -0,0 +1,71 @@
+class GraphVizExport
+  def initialize(chart)
+    @chart = chart
+    @g = GraphViz.new( :G, :type => :digraph )
+
+    @node_map = {}
+    @edge_map = {}
+  end
+  
+  def build_graph(output_name)
+    create_nodes
+    create_edges
+    @g.output( :png => output_name )
+  end
+
+  def create_nodes
+    @chart.states.each do |b|
+      
+      n = @g.add_node(b.id)
+      @node_map[b] = n
+
+      n[:label] =  b.text.to_s
+      n[:color] = "purple" if b.is_initial?
+      n[:shape] = "box" # look like lucid@chart
+
+      n[:shape] = "diamond" if b.type.eql? "event"
+      n[:shape] = "circle" if b.type.eql? "transition"
+    end
+  end
+  
+  def create_edges
+    @chart.states.each do |b|
+      
+      src = @node_map[b]
+
+      b.links_to.each do |link, b2|
+
+        next unless b2.is_state?
+        
+        dst = @node_map[b2]
+        next if b2.is_hidden?
+        e = @g.add_edges(src, dst)
+
+        # b.add_edge(e)
+        @edge_map[b] = [] if @edge_map[b].nil?
+        @edge_map[b] << e 
+        
+        # style
+        e[:arrowhead] = get_arrow_style(link.destination_arrow)
+        e[:arrowtail] = get_arrow_style(link.source_arrow)
+        
+        #    if link.source_arrow.eql? "None"
+        
+        unless link.text.nil?
+          e[:label] = link.text
+          e[:color] = "red" if link.text.eql? "No"
+          e[:color] = "green" if link.text.eql? "Yes"
+        end
+      end
+    end
+  end
+  
+  def get_arrow_style(lucid_style)
+    return "none" if lucid_style.eql? "None"
+    return "normal" if lucid_style.eql? "Arrow"
+    return "empty" if lucid_style.eql? "Hollow Arrow"
+    return "open" if lucid_style.eql? "Open Arrow"
+    
+    return "none"
+  end
+end

data/lib/lucidMachines/loader.rb

@@ -0,0 +1,95 @@
+TextTypes = ["Text", "Process", "Terminator", "Decision"]
+Containers = ["Swim Lane"]
+StructTypes = ["Page", "Line"] + Containers
+Links = ["Line"]
+
+ValidArrows = ["Arrow"]
+InvalidArrow = ["None"]
+ArrowTypes = ValidArrows + InvalidArrow
+
+def is_page?(d); d["Page ID"].nil? and d["Name"] == "Page"; end
+
+class ChartLoader
+  attr_reader :chart, :raw_data
+  
+  def initialize(name)
+    
+    arr_of_arrs = CSV.read name
+
+    @header = arr_of_arrs.first
+    @raw_data = arr_of_arrs[1..-1]
+    d = @raw_data.first
+    
+    @struct_data = arr_of_arrs[1..-1].map{ |d| create_entry(@header, d)}
+    @chart = Chart.new
+
+    # 1. Pages and Get rid of them...
+    pages = load_pages
+    @struct_data.reject!{ |d| pages.include? d }
+    
+    # 2. Containers
+    # load_containers  ## TODO
+
+    # Links, and get rid of them
+    links = load_links
+    @struct_data.reject!{ |d| links.include? d }
+
+    # Blocks, and get rid of them
+    blocks = load_all_blocks
+    @struct_data.reject!{ |d| blocks.include? d }
+
+    #      puts "Elements left: "  + @struct_data.size.to_s
+
+    @chart.set_pages
+    @chart.set_links
+    @chart.check_initial
+  end
+  
+
+  def create_entry(header, data)
+    output = {}
+    data.each_with_index do |d, i|
+      next unless d != nil
+      output[header[i]] = d
+    end
+    output
+  end
+  
+  
+  def load_pages
+    pages_raw = @struct_data.select{|d| is_page? d }
+    pages_raw.map do |d|
+      p = Page.new(d)
+      @chart.add_page p
+      d
+    end
+  end
+  
+  def load_blocks
+    # It is a text type
+    blocks = @struct_data.select {|d| TextTypes.any? d["Name"] }
+    blocks.map do |d|
+      e = Element.new(d)
+      @chart.add_block e
+      d
+    end
+  end
+
+  def load_all_blocks
+    # It is a text type
+    blocks = @struct_data
+    blocks.map do |d|
+      @chart.add_block(Element.new(d))
+      d
+    end
+  end
+  
+  def load_links
+    links = @struct_data.select{|d| Links.any? d["Name"] }
+    links.map do |d|
+      @chart.add_link(Link.new(d))
+      d
+    end
+  end
+
+end

data/lib/lucidMachines/version.rb

@@ -0,0 +1,3 @@
+module LucidMachines
+  VERSION = "0.1.2"
+end

data/lib/lucidMachines.rb

@@ -0,0 +1,19 @@
+
+require 'aasm'
+require 'aasm-diagram'
+require 'csv'
+
+module LucidMachines
+
+  require 'lucidMachines/elements'
+  require 'lucidMachines/chart'
+  require 'lucidMachines/loader'
+  
+  require 'lucidMachines/aasm_export'
+  require 'lucidMachines/exporter'
+  require 'lucidMachines/graphviz_export'
+
+  
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/loader.rb

@@ -0,0 +1,99 @@
+module ChartReader
+  
+  TextTypes = ["Text", "Process", "Terminator", "Decision"]
+  Containers = ["Swim Lane"]
+  StructTypes = ["Page", "Line"] + Containers
+  Links = ["Line"]
+  
+  ValidArrows = ["Arrow"]
+  InvalidArrow = ["None"]
+  ArrowTypes = ValidArrows + InvalidArrow
+
+  def is_page?(d); d["Page ID"].nil? and d["Name"] == "Page"; end
+
+  class ChartLoader
+    attr_reader :chart, :raw_data
+    
+    def initialize(name)
+      
+      arr_of_arrs = CSV.read name
+
+      @header = arr_of_arrs.first
+      @raw_data = arr_of_arrs[1..-1]
+      d = @raw_data.first
+      
+      @struct_data = arr_of_arrs[1..-1].map{ |d| create_entry(@header, d)}
+      @chart = Chart.new
+
+      # 1. Pages and Get rid of them...
+      pages = load_pages
+      @struct_data.reject!{ |d| pages.include? d }
+  
+      # 2. Containers
+      # load_containers  ## TODO
+
+      # Links, and get rid of them
+      links = load_links
+      @struct_data.reject!{ |d| links.include? d }
+
+      # Blocks, and get rid of them
+      blocks = load_all_blocks
+      @struct_data.reject!{ |d| blocks.include? d }
+
+#      puts "Elements left: "  + @struct_data.size.to_s
+
+      @chart.set_pages
+      @chart.set_links
+      @chart.check_initial
+    end
+    
+
+    def create_entry(header, data)
+      output = {}
+      data.each_with_index do |d, i|
+        next unless d != nil
+        output[header[i]] = d
+      end
+      output
+    end
+    
+    
+    def load_pages
+      pages_raw = @struct_data.select{|d| is_page? d }
+      pages_raw.map do |d|
+        p = Page.new(d)
+        @chart.add_page p
+        d
+      end
+    end
+    
+    def load_blocks
+      # It is a text type
+      blocks = @struct_data.select {|d| TextTypes.any? d["Name"] }
+      blocks.map do |d|
+        e = Element.new(d)
+        @chart.add_block e
+        d
+      end
+    end
+
+    def load_all_blocks
+      # It is a text type
+      blocks = @struct_data
+      blocks.map do |d|
+        @chart.add_block(Element.new(d))
+        d
+      end
+    end
+    
+    def load_links
+      links = @struct_data.select{|d| Links.any? d["Name"] }
+      links.map do |d|
+        @chart.add_link(Link.new(d))
+        d
+      end
+    end
+
+  end
+  
+end

data/lucidMachines.gemspec

@@ -0,0 +1,48 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lucidMachines/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lucidMachines"
+  spec.version       = LucidMachines::VERSION
+  spec.authors       = ["Jeremy Laviole"]
+  spec.email         = ["poqudrof@gmail.com"]
+
+  spec.summary       = %q{Creates AASM state machines from LucidChart diagrams.}
+  spec.description   = %q{This gem converts diagrams exported from LucidChard in CSV format to AASM code in ruby. It can also convert to other formats such as in GraphViz.}
+  spec.homepage      = "https://forge.pole-aquinetic.net/RealityTech/lucid-machines"
+
+  # 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"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://forge.pole-aquinetic.net/RealityTech/lucid-machines"
+    spec.metadata["changelog_uri"] = "https://forge.pole-aquinetic.net/RealityTech/lucid-machines"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency 'aasm'
+  spec.add_dependency 'aasm-diagram'
+  spec.add_dependency 'ruby-graphviz'
+
+  ## CLI
+  spec.add_dependency "thor"
+  
+end

data/quickstart/quickstart/credentials.json

@@ -0,0 +1 @@
+../../credentials.json