mikado_graph_generator 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 50d127099e97a095948b836a9cd6d547caf4961f
-  data.tar.gz: 7a9dc695f1e142367483d130b0388d0dd6959337
+SHA256:
+  metadata.gz: a254c6a80eab0d8a945761db1885099d097e377e84a45710610e2fbb66f336fb
+  data.tar.gz: 2f9164d1e405be0c8cc583c578f8768ec82f9fe4fecf9c0531b224573f1d7a27
 SHA512:
-  metadata.gz: fb466184253fd7dd6882c9939e5e18a34553604a1952ddd3195cc1956ee4abfc872258346d154dc511e2c2447e6948bfa3bfc764fc15f34ea5c90c33c0d51495
-  data.tar.gz: daf8ef624d17918aafaf78aa9aa498da21d0c33992396296f513dcf4360d5e41f6d33e6978f47a1aaf57135ebe1fb5d1a6cbdaa75bafe27d028c3a0b8c8f898e
+  metadata.gz: 78de18a57dfd317370ea5b26b4d48337b33d575b7184686b6b8139efac1d72b37fa98f09a08bc01f0d09094e96de8380240ad2475a15502bdb93e9cc0e0d68ea
+  data.tar.gz: 1793b88bb2c63668f226beb685631e1b221b19b53fe45a9f6660584704b1e4d571ab42b2e7b3f75a62688d32660735246bbf20ffe458edb90a76ddb49654804c

data/.editorconfig

@@ -1,10 +1,8 @@
 root = true
 
 [*]
-
 indent_style = space
 indent_size = 2
-end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true

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/.gitignore

@@ -1,15 +1,10 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-.idea/
+# Ignore all logfiles and tempfiles.
+.DS_Store
+.idea/*
+coverage/
+doc/
+log/*.log
+pkg/
+tmp/
 
 *.png

data/.rspec

@@ -1,2 +1,4 @@
 --format documentation
 --color
+--require support/spec_helper
+--order random

data/.rubocop

@@ -0,0 +1 @@
+--display-cop-names

data/.rubocop.disabled.yml

@@ -0,0 +1,168 @@
+#
+# Do not enforce any of these cops...
+#
+# Note: cops are ordered alphabetically.
+#
+
+require: rubocop-rspec
+
+#
+# Checks that tests use 'described_class'.
+#
+# Note: I can't figure out which is the correct cop so I've included both.
+#
+RSpec/DescribedClass:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+#
+# Checks that the second argument to 'describe' specifies a method.
+#
+RSpec/DescribeMethod:
+  Enabled: false
+
+#
+# Checks for 'subject' definitions that come after 'let' definitions.
+#
+#   # bad
+#   RSpec.describe User do
+#     let(:params) { blah }
+#     subject { described_class.new(params) }
+#
+#     it 'is valid' do
+#       expect(subject.valid?).to be(true)
+#     end
+#   end
+#
+#   # good
+#   RSpec.describe User do
+#     subject { described_class.new(params) }
+#
+#     let(:params) { blah }
+#
+#     it 'is valid' do
+#       expect(subject.valid?).to be(true)
+#     end
+#   end
+#
+RSpec/LeadingSubject:
+  Enabled: false
+
+#
+# This cop looks for uses of block comments (=begin...=end).
+#
+Style/BlockComments:
+  Enabled: false
+
+#
+# Check for if and case statements where each branch is used for assignment to the same variable when using
+# the return of the condition can be used instead.
+#
+#   # bad
+#   if foo
+#     bar = 1
+#   else
+#     bar = 2
+#   end
+#
+#   # good
+#   bar = if foo
+#     1
+#   else
+#     2
+#   end
+#
+Style/ConditionalAssignment:
+  Enabled: false
+
+#
+# This cop checks for missing top-level documentation of classes and modules.
+#
+Style/Documentation:
+  Enabled: false
+
+#
+# This cop checks for uses of double negation (!!) to convert something to a boolean value. As this is both
+# cryptic and usually redundant, it should be avoided.
+#
+Style/DoubleNegation:
+  Enabled: false
+
+#
+# This cop checks for the formatting of empty method definitions. By default it enforces empty method definitions to go
+# on a single line (compact style), but it can be configured to enforce the end to go on its own line (expanded style.)
+#
+# Note: A method definition is not considered empty if it contains comments.
+#
+Style/EmptyMethod:
+  Enabled: false
+
+#
+# This cop is designed to help upgrade to Ruby 3.0. It will add the comment `# frozen_string_literal: true` to the top
+# of files to enable frozen string literals. Frozen string literals will be default in Ruby 3.0. The comment will be
+# added below a shebang and encoding comment. The frozen string literal comment is only valid in Ruby 2.3+.
+#
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+#
+# This cops checks for use of extend self or module_function in a module.
+#
+Style/ModuleFunction:
+  Enabled: false
+
+#
+# This cop checks whether some constant value isn't a mutable literal (e.g. array or hash).
+#
+#   # bad
+#   CONST = [1, 2, 3]
+#
+#   # good
+#   CONST = [1, 2, 3].freeze
+#
+Style/MutableConstant:
+  Enabled: false
+
+#
+# This cop (by default) checks for uses of methods Hash#has_key? and Hash#has_value? where it enforces Hash#key? and
+# Hash#value? It is configurable to enforce the inverse, using verbose method names also.
+#
+#   EnforcedStyle: short
+#
+#   # bad
+#   Hash#has_key?
+#   Hash#has_value?
+#
+#   # good
+#   Hash#key?
+#   Hash#value?
+#
+#   EnforcedStyle: verbose
+#
+#   # bad
+#   Hash#key?
+#   Hash#value?
+#
+#   # good
+#   Hash#has_key?
+#   Hash#has_value?
+#
+Style/PreferredHashMethods:
+  Enabled: false
+
+#
+# This cop checks whether the block parameters of a single-line method accepting a block match the names
+# specified via configuration.
+#
+# For instance one can configure reduce(inject) to use |a, e| as parameters.
+#
+Style/SingleLineBlockParams:
+  Enabled: false
+
+#
+# This cop can check for the %w() syntax.
+#
+Style/WordArray:
+  Enabled: false

data/.rubocop.enabled.yml

@@ -0,0 +1,300 @@
+#
+# Enforce all of these cops...
+#
+# Note: cops are ordered alphabetically.
+#
+
+require: rubocop-rspec
+
+#
+# This cop checks whether the end keywords are aligned properly.
+#
+#   # good
+#   variable = if true
+#   end
+#
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+#
+# This cop looks for error classes inheriting from Exception and its standard library subclasses,
+# excluding subclasses of StandardError.
+#
+Lint/InheritException:
+  EnforcedStyle: runtime_error
+
+#
+# This cop checks if the length of a block exceeds some maximum value. Comment lines can optionally be ignored.
+# The maximum allowed length is configurable. The cop can be configured to ignore blocks passed to certain methods.
+#
+Metrics/BlockLength:
+  ExcludedMethods:
+    - describe
+
+#
+# This cop checks the length of lines in the source code.
+#
+Layout/LineLength:
+  Max: 140
+
+#
+# This cop checks if the length of a method exceeds some maximum value.
+#
+Metrics/MethodLength:
+  Max: 15
+
+#
+# Checks for long examples.
+#
+RSpec/ExampleLength:
+  Max: 20
+
+#
+# This cop checks for consistent style when specifying RSpec hooks which run for each example.
+#
+#   # bad
+#   before(:each) do
+#     ...
+#   end
+#
+#   # bad
+#   before(:example) do
+#     ...
+#   end
+#
+#   # good
+#   before do
+#     ...
+#   end
+#
+RSpec/HookArgument:
+  EnforcedStyle: implicit
+
+#
+# Checks if examples contain too many 'expect' calls.
+#
+RSpec/MultipleExpectations:
+  Max: 3
+
+#
+# Checks for consistent method usage for negating expectations.
+#
+RSpec/NotToNot:
+  EnforcedStyle: to_not
+
+#
+# Check that the keys, separators, and values of a multi-line hash literal are aligned according
+# to configuration. With 'key' everything is left aligned.
+#
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: key
+  EnforcedColonStyle: key
+  EnforcedLastArgumentHashStyle: always_ignore
+
+#
+# Here we check if the parameters on a multi-line method call or definition are aligned.
+#
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+#
+# This cop checks how the 'whens' of a case expression are indented in relation to its 'case' or 'end' keyword.
+#
+Layout/CaseIndentation:
+  EnforcedStyle: end
+  IndentOneStep: true
+
+#
+# This cop checks for the formatting of empty method definitions. By default it enforces empty method definitions
+# to go on a single line (compact style).
+#
+Style/EmptyMethod:
+  Exclude:
+    - 'db/migrate/*'
+
+#
+# This cop checks for a line break before the first element in a multi-line hash.
+#
+#   # bad
+#   { a: 1,
+#     b: 2}
+#
+#   # good
+#   {
+#     a: 1,
+#     b: 2 }
+#
+Layout/FirstHashElementLineBreak:
+  Enabled: true
+
+#
+# This cop checks for a line break before the first argument in a multi-line method call.
+#
+#   # bad
+#   method(foo, bar,
+#     baz)
+#
+#   # good
+#   method(
+#     foo, bar,
+#     baz)
+#
+#   # ignored
+#   method foo, bar,
+#     baz
+#
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: true
+
+#
+# This cop checks for uses of the lambda literal syntax.
+#
+#   # literal
+#   f = ->(x) { x }
+#   f = ->(x) do
+#         x
+#       end
+#
+Style/Lambda:
+  EnforcedStyle: literal
+
+#
+# This cop checks presence of parentheses in method calls containing parameters. As in popular Ruby's frameworks a lot
+# of methods should always be called without parentheses, users can ignore them by passing their names to IgnoredMethods
+# option.
+#
+#   # bad
+#   array.delete e
+#
+#   # good
+#   array.delete(e)
+#
+#   # good if `puts` is listed in IgnoredMethods
+#   puts 'test'
+#
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  IgnoredMethods:
+    - add_development_dependency
+    - after_initialize
+    - assert
+    - assert_contents
+    - assert_empty
+    - assert_equal
+    - assert_held
+    - assert_nil
+    - assert_presence_of
+    - assert_raises
+    - assert_should_strip_whitespace
+    - assert_time_within
+    - attr_accessor
+    - attr_reader
+    - attr_writer
+    - attribute
+    - autocomplete_for
+    - before_action
+    - belongs_to
+    - column
+    - delegate
+    - describe
+    - extend
+    - field
+    - guard
+    - gem
+    - goto
+    - has_many
+    - in_line_ajax_action
+    - include
+    - it
+    - it_behaves_like
+    - link
+    - puts
+    - raise
+    - redefine_const
+    - redirect_to
+    - render
+    - require
+    - require_relative
+    - ruby
+    - scope
+    - should
+    - source
+    - task
+    - to
+    - to_not
+    - validate
+    - validates
+    - validates_numericality_of
+    - validates_presence_of
+    - within
+
+#
+# This cop checks that closing brace of a multi-line method call must be on the line after the last
+# argument of the call.
+#
+#   # symmetrical: bad
+#   # new_line: good
+#   # same_line: bad
+#   foo(a,
+#     b
+#   )
+#
+#   # symmetrical: bad
+#   # new_line: bad
+#   # same_line: good
+#   foo(
+#     a,
+#     b)
+#
+#   # symmetrical: good
+#   # new_line: bad
+#   # same_line: good
+#   foo(a,
+#     b)
+#
+#   # symmetrical: good
+#   # new_line: good
+#   # same_line: bad
+#   foo(
+#     a,
+#     b
+#   )
+#
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: new_line
+
+#
+# This cop checks the indentation of the method name part in method calls that span more than one line.
+#
+#   # good
+#   while a
+#       .b
+#     something
+#   end
+#
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+#
+# This cop looks for uses of Perl-style global variables.
+#
+Style/SpecialGlobalVars:
+  EnforcedStyle: use_english_names
+
+#
+# Checks if uses of quotes match the configured preference.
+#
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+#
+# This cop makes sure that all numbered variables use snake_case for their numbering.
+#
+#   # bad
+#   variable1 = 1
+#
+#   # good
+#   variable_1 = 1
+#
+Naming/VariableNumber:
+  EnforcedStyle: snake_case

data/.rubocop.yml

@@ -0,0 +1,10 @@
+#
+# The Rubocop configuration for mikado_graph_generator
+#
+
+AllCops:
+  NewCops: enable
+
+inherit_from:
+  - .rubocop.disabled.yml
+  - .rubocop.enabled.yml

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/.travis.yml

@@ -1,7 +1,10 @@
 language: ruby
 rvm:
-  - 2.3.1
+  - 2.6.6
 before_install:
-  - gem install bundler -v 1.14.3
+  - gem update --system
   - sudo apt-get -qq update
   - sudo apt-get install -y graphviz
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/Gemfile

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec

data/Gemfile.lock

@@ -1,37 +1,106 @@
 PATH
   remote: .
   specs:
-    mikado_graph_generator (0.2.0)
+    mikado_graph_generator (0.4.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.1)
+    coderay (1.1.3)
     diff-lcs (1.3)
-    rake (10.5.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    ffi (1.13.1)
+    formatador (0.2.5)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-bundler (3.0.0)
+      bundler (>= 2.1, < 3)
+      guard (~> 2.2)
+      guard-compat (~> 1.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.3.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.5)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    ruby-graphviz (1.2.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.85.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-rspec (1.40.0)
+      rubocop (>= 0.68.1)
+    ruby-graphviz (1.2.5)
+      rexml
+    ruby-progressbar (1.10.1)
+    shellany (0.0.1)
+    thor (1.0.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.14)
+  bundler (~> 2.1.4)
+  guard-bundler
+  guard-rspec
+  guard-rubocop
   mikado_graph_generator!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
-  ruby-graphviz
+  rubocop (~> 0.52)
+  rubocop-rspec (~> 1.21)
+  ruby-graphviz (~> 1.2)
 
 BUNDLED WITH
-   1.14.3
+   2.1.4

data/Guardfile

@@ -0,0 +1,56 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app processing config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :bundler do
+  require "guard/bundler"
+  require "guard/bundler/verify"
+  helper = Guard::Bundler::Verify.new
+
+  files = ["Gemfile"]
+  files += Dir["*.gemspec"] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  watch(/.+\.rb$/)
+end
+
+guard :rubocop, cli: ["-S", "-D"] do
+  watch(/.+\.rb$/)
+end

data/README.md

@@ -1,4 +1,4 @@
-# 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)
+# Mikado Graph Generator [![Gem Version](https://badge.fury.io/rb/mikado_graph_generator.svg)](https://badge.fury.io/rb/mikado_graph_generator) [![Build Status](https://travis-ci.org/snasirca/mikado-graph-generator.svg?branch=master)](https://travis-ci.org/snasirca/mikado-graph-generator) [![Maintainability](https://api.codeclimate.com/v1/badges/d748f762abb3995c15eb/maintainability)](https://codeclimate.com/github/snasirca/mikado-graph-generator/maintainability)
 
 Welcome to a DSL for creating Mikado Graphs using *GraphViz*.
 
@@ -34,40 +34,72 @@ You can use this gem's DSL in the following way to create a Mikado Graph generat
 require "mikado_graph"
 
 MikadoGraph::Generator.define do
-  state("State A").depends_on {
-    state("State B").depends_on {
+  state("State A").with_prerequisites do
+    state("State B").with_prerequisites do
       state("State D")
       state("State E")
-    }
-    state("State C").depends_on {
+    end
+    state("State C").with_prerequisites do
       state("State F")
       state("State G")
-    }
-  }
-end.generate("png", "img/example_usage.png") # generate takes GraphViz format and output path
+    end
+  end
+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:
+> You can also use the shorthand `with_prereqs` instead of `with_prerequisites` for defining prerequisite 
+dependencies between states.
+
+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:
 
-![Multi-Level Mikado Graph](https://github.com/snasirca/mikado_graph_generator/blob/master/img/multi_level_mikado_graph.png)
+![Example Usage Vertical](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").with_prerequisites do
+    state("State B").with_prerequisites do
+      state("State D")
+      state("State E")
+    end
+    state("State C").with_prerequisites 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](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.
 
-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).
+Use `direnv` to speed development.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/snasirca/mikado_graph_generator. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/snasirca/mikado-graph-generator. 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.
 
 ## License
 

data/Rakefile

@@ -3,4 +3,5 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
+# task sync_rubocop

data/example_usage_horizontal.rb

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

data/example_usage_vertical.rb

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

data/lib/mikado_graph.rb

@@ -1,7 +1,7 @@
 require "mikado_graph/version"
 
 require "mikado_graph/state"
-require "mikado_graph/dependencies"
+require "mikado_graph/prerequisites"
 require "mikado_graph/generator"
 
 module MikadoGraph

data/lib/mikado_graph/generator.rb

@@ -2,49 +2,59 @@ require "graphviz"
 
 module MikadoGraph
   class Generator
-    attr_reader :dependencies, :graph
+    attr_reader :prerequisites, :graph
 
     def self.define(&block)
       generator_instance = new
-      generator_instance.dependencies.instance_eval(&block)
+      generator_instance.prerequisites.instance_eval(&block)
       generator_instance
     end
 
-    def generate(format = "dot", path = nil)
-      add_states_to_graph(dependencies.dependent_states)
-      output_options = {}
-      output_options[format] = path
+    def generate(options = {})
+      add_states_to_graph(prerequisites.states)
+      arrange_graph_direction(options)
+      output_options = build_output_options(options)
       graph.output(output_options)
     end
 
     private
 
     def initialize
-      @dependencies = Dependencies.new
+      @prerequisites = Prerequisites.new
       initialize_graph
     end
 
     def initialize_graph
       @graph = GraphViz.new(nil)
-      @graph[:rankdir] = "LR"
       @graph.node[:shape] = "box"
     end
 
     def add_states_to_graph(states)
-      states.each { |state| add_state_dependencies(state) }
+      states.each { |state| add_state_prerequisites(state) }
     end
 
-    def add_state_dependencies(state)
-      state.dependent_states.each do |dependent_state|
-        add_dependency(state, dependent_state)
-        add_state_dependencies(dependent_state)
+    def add_state_prerequisites(state)
+      state.prerequisite_states.each do |prerequisite_state|
+        add_prerequisite_dependency(state, prerequisite_state)
+        add_state_prerequisites(prerequisite_state)
       end
     end
 
-    def add_dependency(state, dependent_state)
+    def add_prerequisite_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)
+      graph.add_edges(state_node, dependent_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/{dependencies.rb → prerequisites.rb}

@@ -1,14 +1,14 @@
 module MikadoGraph
-  class Dependencies
-    attr_reader :dependent_states
+  class Prerequisites
+    attr_reader :states
 
     def initialize
-      @dependent_states = []
+      @states = []
     end
 
     def state(state_name)
       new_state = State.new(state_name)
-      dependent_states << new_state
+      states << new_state
       new_state
     end
   end

data/lib/mikado_graph/state.rb

@@ -1,20 +1,18 @@
 module MikadoGraph
   class State
-    attr_reader :name
+    attr_reader :name, :prerequisite_states
 
     def initialize(name)
       @name = name
+      @prerequisite_states = []
     end
 
-    def depends_on(&block)
-      dependencies = Dependencies.new
-      dependencies.instance_eval(&block)
-      @dependent_states = dependencies.dependent_states
-    end
-
-    def dependent_states
-      @dependent_states || []
+    def with_prerequisites(&block)
+      prerequisites = Prerequisites.new
+      prerequisites.instance_eval(&block)
+      @prerequisite_states = prerequisites.states
     end
+    alias with_prereqs with_prerequisites
 
     def to_s
       name

data/lib/mikado_graph/version.rb

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

data/mikado_graph.gemspec

@@ -1,26 +1,31 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
+
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "mikado_graph/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "mikado_graph_generator"
-  spec.version       = MikadoGraph::VERSION
-  spec.authors       = ["Shahriyar Nasir"]
-  spec.email         = ["contact@snasir.ca"]
+  spec.name = "mikado_graph_generator"
+  spec.version = MikadoGraph::VERSION
+  spec.authors = ["Shahriyar Nasir"]
+  spec.email = ["contact@snasir.ca"]
 
-  spec.summary       = "Mikado Graph generator"
-  spec.description   = "Provides a simple DSL for generating Mikado Graphs using GraphViz."
-  spec.homepage      = "https://github.com/snasirca/mikado_graph_generator"
-  spec.license       = "MIT"
+  spec.summary = "Mikado Graph generator"
+  spec.description = "Provides a simple DSL for generating Mikado Graphs using GraphViz."
+  spec.homepage = "https://github.com/snasirca/mikado_graph_generator"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-rubocop"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "ruby-graphviz"
+  spec.add_development_dependency "rubocop", "~> 0.52"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.21"
+  spec.add_development_dependency "ruby-graphviz", "~> 1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mikado_graph_generator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Shahriyar Nasir
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2020-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +94,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
 description: Provides a simple DSL for generating Mikado Graphs using GraphViz.
 email:
 - contact@snasir.ca
@@ -74,20 +144,31 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".envrc"
+- ".envrc.sample"
 - ".gitignore"
 - ".rspec"
+- ".rubocop"
+- ".rubocop.disabled.yml"
+- ".rubocop.enabled.yml"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- example_usage.rb
+- 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
+- lib/mikado_graph/prerequisites.rb
 - lib/mikado_graph/state.rb
 - lib/mikado_graph/version.rb
 - mikado_graph.gemspec
@@ -95,7 +176,7 @@ homepage: https://github.com/snasirca/mikado_graph_generator
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,9 +191,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Mikado Graph generator
 test_files: []

data/example_usage.rb

@@ -1,14 +0,0 @@
-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")