mikado_graph_generator 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3c75276f5053c1f45d6fd5e88ff3a0c276eaae1
-  data.tar.gz: dbea48efaa1e281a7909bf990f9c6fb5a7f81160
+  metadata.gz: a16c549fe09057fbb0d4090de664ca9458a3a3fa
+  data.tar.gz: 03e6bb95d832c01d44c848725de31f1a4cfee999
 SHA512:
-  metadata.gz: cb5d06068c26ef4a6cbf7ac97f471c8f642046bc6159c55df1c77a61b42481eea02e124b43403ad0f8fd9ec9c5f02ea6887b2fab2e3369caa0fe0f58554b9b10
-  data.tar.gz: 36f1d8b650b48d2aa28fd57ff35d01477bcee22a6303a0ab6956c0350e7580faaa797f9e32f1a950b7bdf88696bd19c9e7d9813bd18076fb80ef75db71705bd4
+  metadata.gz: 1565ecd8e5bff92f0bd122659d744f9da06eba78321ddf256f69b63e6691c0913a4387ec5cdb975ba691531b1f1af60f99833f15d3b13df51d05e251b2b78a4f
+  data.tar.gz: 8b0feeefbdc005ed029483568acd36322a526c4da14d78568efa9f6eb639bb21c02d85b723c920d3a931f1fca53e5966bb73f412474cd31a58c9771a940d6f8d

data/.rubocop.enabled.yml

@@ -115,7 +115,7 @@ RSpec/NotToNot:
 # Check that the keys, separators, and values of a multi-line hash literal are aligned according
 # to configuration. With 'key' everything is left aligned.
 #
-Style/AlignHash:
+Layout/AlignHash:
   EnforcedHashRocketStyle: key
   EnforcedColonStyle: key
   EnforcedLastArgumentHashStyle: always_ignore
@@ -123,13 +123,13 @@ Style/AlignHash:
 #
 # Here we check if the parameters on a multi-line method call or definition are aligned.
 #
-Style/AlignParameters:
+Layout/AlignParameters:
   EnforcedStyle: with_fixed_indentation
 
 #
 # This cop checks how the 'whens' of a case expression are indented in relation to its 'case' or 'end' keyword.
 #
-Style/CaseIndentation:
+Layout/CaseIndentation:
   EnforcedStyle: end
   IndentOneStep: true
 
@@ -153,7 +153,7 @@ Style/EmptyMethod:
 #     a: 1,
 #     b: 2 }
 #
-Style/FirstHashElementLineBreak:
+Layout/FirstHashElementLineBreak:
   Enabled: true
 
 #
@@ -172,7 +172,7 @@ Style/FirstHashElementLineBreak:
 #   method foo, bar,
 #     baz
 #
-Style/FirstMethodArgumentLineBreak:
+Layout/FirstMethodArgumentLineBreak:
   Enabled: true
 
 # This cop checks the indentation of the first parameter in a method call. Parameters after the first one are checked by Style/AlignParameters, not by this cop.
@@ -187,7 +187,7 @@ Style/FirstMethodArgumentLineBreak:
 #     first_param,
 #   second_param)
 #
-Style/FirstParameterIndentation:
+Layout/FirstParameterIndentation:
   EnforcedStyle: consistent
 
 #
@@ -202,7 +202,7 @@ Style/FirstParameterIndentation:
 #     :no_difference
 #   ])
 #
-Style/IndentArray:
+Layout/IndentArray:
   EnforcedStyle: consistent
 
 #
@@ -217,7 +217,7 @@ Style/IndentArray:
 #     no: :difference
 #   })
 #
-Style/IndentHash:
+Layout/IndentHash:
   EnforcedStyle: consistent
 
 #
@@ -334,7 +334,7 @@ Style/MethodCallWithArgsParentheses:
 #     b
 #   )
 #
-Style/MultilineMethodCallBraceLayout:
+Layout/MultilineMethodCallBraceLayout:
   EnforcedStyle: new_line
 
 #
@@ -346,7 +346,7 @@ Style/MultilineMethodCallBraceLayout:
 #     something
 #   end
 #
-Style/MultilineMethodCallIndentation:
+Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
 #
@@ -370,5 +370,5 @@ Style/StringLiterals:
 #   # good
 #   variable_1 = 1
 #
-Style/VariableNumber:
+Naming/VariableNumber:
   EnforcedStyle: snake_case

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mikado_graph_generator (0.3.0)
+    mikado_graph_generator (0.4.0)
 
 GEM
   remote: https://rubygems.org/
@@ -42,14 +42,15 @@ GEM
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parser (2.3.3.1)
-      ast (~> 2.2)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
     powerpack (0.1.1)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rainbow (2.2.1)
+    rainbow (3.0.0)
     rake (10.5.0)
     rb-fsevent (0.9.8)
     rb-inotify (0.9.8)
@@ -67,21 +68,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
-    rubocop (0.47.1)
-      parser (>= 2.3.3.1, < 3.0)
+    rubocop (0.52.0)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
       powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    rubocop-rspec (1.10.0)
-      rubocop (>= 0.42.0)
+    rubocop-rspec (1.21.0)
+      rubocop (>= 0.52.0)
     ruby-graphviz (1.2.2)
-    ruby-progressbar (1.8.1)
+    ruby-progressbar (1.9.0)
     ruby_dep (1.5.0)
     shellany (0.0.1)
     slop (3.6.0)
     thor (0.19.4)
-    unicode-display_width (1.1.3)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
@@ -94,9 +96,9 @@ DEPENDENCIES
   mikado_graph_generator!
   rake (~> 10.0)
   rspec (~> 3.0)
-  rubocop (~> 0.47)
-  rubocop-rspec (~> 1.10)
+  rubocop (~> 0.52)
+  rubocop-rspec (~> 1.21)
   ruby-graphviz (~> 1.2)
 
 BUNDLED WITH
-   1.14.3
+   1.16.1

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 [![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*.
 
@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ### Prerequisites
 
-Ensure you have *GraphViz* installed. On macOS you can install it using Homebrew with the following command:
+Ensure you have *GraphViz* installed. On MacOS you can install it using Homebrew with the following command:
 
 ```bash
 brew install graphviz
@@ -34,12 +34,12 @@ 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 do
-    state("State B").depends_on do
+  state("State A").with_prerequisites do
+    state("State B").with_prerequisites do
       state("State D")
       state("State E")
     end
-    state("State C").depends_on do
+    state("State C").with_prerequisites do
       state("State F")
       state("State G")
     end
@@ -47,6 +47,9 @@ MikadoGraph::Generator.define do
 end.generate("png", "img/example_usage_vertical.png") # generate takes GraphViz format and output path
 ```
 
+> 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
@@ -55,7 +58,7 @@ ruby example_usage_vertical.rb
 
 This will utilize *GraphViz* to create this PNG output of the above Mikado Graph generator definition:
 
-![Example Usage Vertical](https://github.com/snasirca/mikado_graph_generator/blob/master/img/example_usage_vertical.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.
 
@@ -71,12 +74,12 @@ Here is an example usage:
 require "mikado_graph"
 
 MikadoGraph::Generator.define do
-  state("State A").depends_on do
-    state("State B").depends_on do
+  state("State A").with_prerequisites do
+    state("State B").with_prerequisites do
       state("State D")
       state("State E")
     end
-    state("State C").depends_on do
+    state("State C").with_prerequisites do
       state("State F")
       state("State G")
     end
@@ -86,12 +89,14 @@ end.generate(format: "png", path: "img/example_usage_horizontal.png", direction:
 
 This will generate this graph:
 
-![Example Usage Horizontal](https://github.com/snasirca/mikado_graph_generator/blob/master/img/example_usage_horizontal.png)
+![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.
 
+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.

data/example_usage_horizontal.rb

@@ -1,12 +1,12 @@
 require "mikado_graph"
 
 MikadoGraph::Generator.define do
-  state("State A").depends_on do
-    state("State B").depends_on do
+  state("State A").with_prerequisites do
+    state("State B").with_prerequisites do
       state("State D")
       state("State E")
     end
-    state("State C").depends_on do
+    state("State C").with_prerequisites do
       state("State F")
       state("State G")
     end

data/example_usage_vertical.rb

@@ -1,12 +1,12 @@
 require "mikado_graph"
 
 MikadoGraph::Generator.define do
-  state("State A").depends_on do
-    state("State B").depends_on do
+  state("State A").with_prerequisites do
+    state("State B").with_prerequisites do
       state("State D")
       state("State E")
     end
-    state("State C").depends_on do
+    state("State C").with_prerequisites do
       state("State F")
       state("State G")
     end

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,16 +2,16 @@ 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(options = {})
-      add_states_to_graph(dependencies.dependent_states)
+      add_states_to_graph(prerequisites.states)
       arrange_graph_direction(options)
       output_options = build_output_options(options)
       graph.output(output_options)
@@ -20,7 +20,7 @@ module MikadoGraph
     private
 
     def initialize
-      @dependencies = Dependencies.new
+      @prerequisites = Prerequisites.new
       initialize_graph
     end
 
@@ -30,20 +30,20 @@ module MikadoGraph
     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)

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.3.0"
+  VERSION = "0.4.0"
 end

data/mikado_graph.gemspec

@@ -1,5 +1,5 @@
-# coding: utf-8
 lib = File.expand_path("../lib", __FILE__)
+
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "mikado_graph/version"
 
@@ -20,12 +20,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-rubocop"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.52"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.21"
   spec.add_development_dependency "ruby-graphviz", "~> 1.2"
-  spec.add_development_dependency "rubocop", "~> 0.47"
-  spec.add_development_dependency "rubocop-rspec", "~> 1.10"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "guard-bundler"
-  spec.add_development_dependency "guard-rubocop"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mikado_graph_generator
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Shahriyar Nasir
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,117 +25,117 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-graphviz
+  name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.52'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.52'
 - !ruby/object:Gem::Dependency
-  name: guard-bundler
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.21'
 - !ruby/object:Gem::Dependency
-  name: guard-rubocop
+  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
@@ -143,7 +143,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
 - ".editorconfig"
 - ".envrc"
 - ".envrc.sample"
@@ -168,8 +167,8 @@ files:
 - 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
@@ -193,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Mikado Graph generator

data/.codeclimate.yml

@@ -1,37 +0,0 @@
----
-engines:
-  brakeman:
-    enabled: true
-    checks:
-      CVE_2015_3227:
-        enabled: false
-  bundler-audit:
-    enabled: true
-  duplication:
-    enabled: true
-    config:
-      languages:
-      - ruby
-      - javascript
-      - python
-      - php
-  fixme:
-    enabled: true
-  rubocop:
-    enabled: true
-ratings:
-  paths:
-  - Gemfile.lock
-  - "**.erb"
-  - "**.haml"
-  - "**.rb"
-  - "**.rhtml"
-  - "**.slim"
-  - "**.inc"
-  - "**.js"
-  - "**.jsx"
-  - "**.module"
-  - "**.php"
-  - "**.py"
-exclude_paths:
-- spec/