mikado_graph_generator 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d40123be1c0da8c638c131cbf9950308e0d5e65
-  data.tar.gz: 2868134bffaa3ac330a39fc874276a5498236d38
+  metadata.gz: 50d127099e97a095948b836a9cd6d547caf4961f
+  data.tar.gz: 7a9dc695f1e142367483d130b0388d0dd6959337
 SHA512:
-  metadata.gz: af89d6afa1fc13b87c5fdc2dbc105467c905d8941a8668011482f4e9b0b65a4a8c9fc0430a2cece900662ea178cc6c7097165ccf577ffb2c115b208c8896cf5a
-  data.tar.gz: d8c6e2b6a8840bd531bab60bb806642b070082a7bc0af910e52180770cc7f6146bf358f8926c9bfd8c7e22ed3181765ff6463856cb12d3c75ed0cbd1a6445624
+  metadata.gz: fb466184253fd7dd6882c9939e5e18a34553604a1952ddd3195cc1956ee4abfc872258346d154dc511e2c2447e6948bfa3bfc764fc15f34ea5c90c33c0d51495
+  data.tar.gz: daf8ef624d17918aafaf78aa9aa498da21d0c33992396296f513dcf4360d5e41f6d33e6978f47a1aaf57135ebe1fb5d1a6cbdaa75bafe27d028c3a0b8c8f898e

data/.travis.yml

@@ -1,5 +1,7 @@
-sudo: false
 language: ruby
 rvm:
   - 2.3.1
-before_install: gem install bundler -v 1.14.3
+before_install:
+  - gem install bundler -v 1.14.3
+  - sudo apt-get -qq update
+  - sudo apt-get install -y graphviz

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mikado_graph_generator (0.1.0)
+    mikado_graph_generator (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -21,6 +21,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
+    ruby-graphviz (1.2.2)
 
 PLATFORMS
   ruby
@@ -30,6 +31,7 @@ DEPENDENCIES
   mikado_graph_generator!
   rake (~> 10.0)
   rspec (~> 3.0)
+  ruby-graphviz
 
 BUNDLED WITH
    1.14.3

data/README.md

@@ -1,4 +1,4 @@
-# Mikado Graph Generator
+# Mikado Graph Generator [![Build Status](https://travis-ci.org/snasirca/mikado_graph_generator.svg?branch=master)](https://travis-ci.org/snasirca/mikado_graph_generator) [![Code Climate](https://codeclimate.com/github/snasirca/mikado_graph_generator/badges/gpa.svg)](https://codeclimate.com/github/snasirca/mikado_graph_generator)
 
 Welcome to a DSL for creating Mikado Graphs using *GraphViz*.
 
@@ -33,30 +33,32 @@ You can use this gem's DSL in the following way to create a Mikado Graph generat
 ```ruby
 require "mikado_graph"
 
-MikadoGraph::Generator.generate do
-  state("State A").depends_on do
-    state("State B").depends_on do
+MikadoGraph::Generator.define do
+  state("State A").depends_on {
+    state("State B").depends_on {
       state("State D")
       state("State E")
-    end
-    state("State C").depends_on do
+    }
+    state("State C").depends_on {
       state("State F")
       state("State G")
-    end
-  end
-end
+    }
+  }
+end.generate("png", "img/example_usage.png") # generate takes GraphViz format and output path
 ```
 
-You can then execute this file in the terminal using:
+Save this file to `example_usage.rb` and then you can then execute this file in the terminal using:
 
 ```bash
-ruby multi_level_mikado_graph_generator.rb | dot -Tpng -o img/multi_level_mikado_graph.png
+ruby example_usage.rb
 ```
 
 This will utilize the *GraphViz* `dot` command to create this PNG output of the above Mikado Graph generator definition:
 
 ![Multi-Level Mikado Graph](https://github.com/snasirca/mikado_graph_generator/blob/master/img/multi_level_mikado_graph.png)
 
+NOTE: If you don't provide any parameters to `generate`, it'll default to a `dot` output in the STDOUT.
+
 ## Development
 
 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.

data/example_usage.rb

@@ -0,0 +1,14 @@
+require "mikado_graph"
+
+MikadoGraph::Generator.define do
+  state("State A").depends_on {
+    state("State B").depends_on {
+      state("State D")
+      state("State E")
+    }
+    state("State C").depends_on {
+      state("State F")
+      state("State G")
+    }
+  }
+end.generate("png", "img/example_usage.png")

data/lib/mikado_graph/generator.rb

@@ -1,44 +1,50 @@
+require "graphviz"
+
 module MikadoGraph
-  module Generator
-    extend self
+  class Generator
+    attr_reader :dependencies, :graph
+
+    def self.define(&block)
+      generator_instance = new
+      generator_instance.dependencies.instance_eval(&block)
+      generator_instance
+    end
 
-    def generate(&block)
-      dependencies = Dependencies.new
-      dependencies.instance_eval(&block)
-      convert(dependencies.dependent_states)
+    def generate(format = "dot", path = nil)
+      add_states_to_graph(dependencies.dependent_states)
+      output_options = {}
+      output_options[format] = path
+      graph.output(output_options)
     end
 
     private
 
-    def convert(states)
-      convert_header
-      convert_states_and_dependencies(states)
-      convert_footer
+    def initialize
+      @dependencies = Dependencies.new
+      initialize_graph
     end
 
-    def convert_header
-      puts "digraph {"
-      puts "  node [shape=box];"
-      puts "  rankdir=\"LR\";"
+    def initialize_graph
+      @graph = GraphViz.new(nil)
+      @graph[:rankdir] = "LR"
+      @graph.node[:shape] = "box"
     end
 
-    def convert_states_and_dependencies(states)
-      states.each { |state| convert_dependencies(state) }
+    def add_states_to_graph(states)
+      states.each { |state| add_state_dependencies(state) }
     end
 
-    def convert_dependencies(state)
+    def add_state_dependencies(state)
       state.dependent_states.each do |dependent_state|
-        convert_dependency(state, dependent_state)
-        convert_dependencies(dependent_state)
+        add_dependency(state, dependent_state)
+        add_state_dependencies(dependent_state)
       end
     end
 
-    def convert_dependency(state, dependent_state)
-      puts "  \"#{dependent_state.name}\" -> \"#{state.name}\";"
-    end
-
-    def convert_footer
-      puts "}"
+    def add_dependency(state, dependent_state)
+      state_node = graph.add_nodes(state.name)
+      dependent_state_node = graph.add_nodes(dependent_state.name)
+      graph.add_edges(dependent_state_node, state_node)
     end
   end
 end

data/lib/mikado_graph/version.rb

@@ -1,3 +1,3 @@
 module MikadoGraph
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/mikado_graph.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "ruby-graphviz"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mikado_graph_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Shahriyar Nasir
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-01 00:00:00.000000000 Z
+date: 2017-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides a simple DSL for generating Mikado Graphs using GraphViz.
 email:
 - contact@snasir.ca
@@ -70,7 +84,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- img/multi_level_mikado_graph.png
+- example_usage.rb
 - lib/mikado_graph.rb
 - lib/mikado_graph/dependencies.rb
 - lib/mikado_graph/generator.rb