mikado_graph_generator 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9668c3aa3a4cbac985e84579b150178e63a3b155
-  data.tar.gz: de1a9a1372befe308df515bc7af3385b6d39f75e
+  metadata.gz: f3c75276f5053c1f45d6fd5e88ff3a0c276eaae1
+  data.tar.gz: dbea48efaa1e281a7909bf990f9c6fb5a7f81160
 SHA512:
-  metadata.gz: c294f274b5a39dc63f13ad80bf3cd7c1a78ea37ac58a1980018f59aac5f8e21ffc879695c556926ded48b1f2197ce0fae038465dbb6bf739d47aa689efa6de3d
-  data.tar.gz: d6a43e88070ce788e8cad2c79ade43ff102bfbbe658a9fc34d665e6a0fef207360a680ad41a2e94b377e7ec8e33ccd49fe84364ed10b13e62b1a736adddf93cd
+  metadata.gz: cb5d06068c26ef4a6cbf7ac97f471c8f642046bc6159c55df1c77a61b42481eea02e124b43403ad0f8fd9ec9c5f02ea6887b2fab2e3369caa0fe0f58554b9b10
+  data.tar.gz: 36f1d8b650b48d2aa28fd57ff35d01477bcee22a6303a0ab6956c0350e7580faaa797f9e32f1a950b7bdf88696bd19c9e7d9813bd18076fb80ef75db71705bd4

data/.envrc

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+export PATH=`pwd`/bin:$PATH

data/.envrc.sample

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+export PATH=`pwd`/bin:$PATH

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mikado_graph_generator (0.2.2)
+    mikado_graph_generator (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -44,21 +44,50 @@ MikadoGraph::Generator.define do
       state("State G")
     end
   end
-end.generate("png", "img/example_usage.png") # generate takes GraphViz format and output path
+end.generate("png", "img/example_usage_vertical.png") # generate takes GraphViz format and output path
 ```
 
-Save this file to `example_usage.rb` and then you can then execute this file in the terminal using:
+Save this file to `example_usage_vertical.rb` and then you can then execute this file in the terminal using:
 
 ```bash
-ruby example_usage.rb
+ruby example_usage_vertical.rb
 ```
 
-This will utilize the *GraphViz* `dot` command to create this PNG output of the above Mikado Graph generator definition:
+This will utilize *GraphViz* to create this PNG output of the above Mikado Graph generator definition:
 
-![Example Usage](https://github.com/snasirca/mikado_graph_generator/blob/master/img/example_usage.png)
+![Example Usage Vertical](https://github.com/snasirca/mikado_graph_generator/blob/master/img/example_usage_vertical.png)
 
 NOTE: If you don't provide any parameters to `generate`, it'll default to a `dot` output in the STDOUT.
 
+If you want to instead do a horizontal orientation of your graph, simply provide the direction flag to `#generate` like so:
+
+```ruby
+generate(direction: :horizontal)
+```
+
+Here is an example usage:
+
+```ruby
+require "mikado_graph"
+
+MikadoGraph::Generator.define do
+  state("State A").depends_on do
+    state("State B").depends_on do
+      state("State D")
+      state("State E")
+    end
+    state("State C").depends_on do
+      state("State F")
+      state("State G")
+    end
+  end
+end.generate(format: "png", path: "img/example_usage_horizontal.png", direction: :horizontal)
+```
+
+This will generate this graph:
+
+![Example Usage Horizontal](https://github.com/snasirca/mikado_graph_generator/blob/master/img/example_usage_horizontal.png)
+
 ## 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_horizontal.rb

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

data/{example_usage.rb → example_usage_vertical.rb}

@@ -11,4 +11,4 @@ MikadoGraph::Generator.define do
       state("State G")
     end
   end
-end.generate("png", "img/example_usage.png")
+end.generate(format: "png", path: "img/example_usage_vertical.png")

data/lib/mikado_graph/generator.rb

@@ -10,10 +10,10 @@ module MikadoGraph
       generator_instance
     end
 
-    def generate(format = "dot", path = nil)
+    def generate(options = {})
       add_states_to_graph(dependencies.dependent_states)
-      output_options = {}
-      output_options[format] = path
+      arrange_graph_direction(options)
+      output_options = build_output_options(options)
       graph.output(output_options)
     end
 
@@ -26,7 +26,6 @@ module MikadoGraph
 
     def initialize_graph
       @graph = GraphViz.new(nil)
-      @graph[:rankdir] = "LR"
       @graph.node[:shape] = "box"
     end
 
@@ -46,5 +45,16 @@ module MikadoGraph
       dependent_state_node = graph.add_nodes(dependent_state.name)
       graph.add_edges(dependent_state_node, state_node)
     end
+
+    def arrange_graph_direction(options)
+      direction = options.fetch(:direction, :vertical)
+      graph[:rankdir] = "LR" if direction == :horizontal
+    end
+
+    def build_output_options(options)
+      output_options = {}
+      output_options[options.fetch(:format, "dot")] = options.fetch(:path, nil)
+      output_options
+    end
   end
 end

data/lib/mikado_graph/version.rb

@@ -1,3 +1,3 @@
 module MikadoGraph
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mikado_graph_generator
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Shahriyar Nasir
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-06 00:00:00.000000000 Z
+date: 2017-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,6 +145,8 @@ extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
 - ".editorconfig"
+- ".envrc"
+- ".envrc.sample"
 - ".gitignore"
 - ".rspec"
 - ".rubocop"
@@ -161,8 +163,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- example_usage.rb
-- img/example_usage.png
+- example_usage_horizontal.rb
+- example_usage_vertical.rb
+- img/example_usage_horizontal.png
+- img/example_usage_vertical.png
 - lib/mikado_graph.rb
 - lib/mikado_graph/dependencies.rb
 - lib/mikado_graph/generator.rb