mikado_graph_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d40123be1c0da8c638c131cbf9950308e0d5e65
+  data.tar.gz: 2868134bffaa3ac330a39fc874276a5498236d38
+SHA512:
+  metadata.gz: af89d6afa1fc13b87c5fdc2dbc105467c905d8941a8668011482f4e9b0b65a4a8c9fc0430a2cece900662ea178cc6c7097165ccf577ffb2c115b208c8896cf5a
+  data.tar.gz: d8c6e2b6a8840bd531bab60bb806642b070082a7bc0af910e52180770cc7f6146bf358f8926c9bfd8c7e22ed3181765ff6463856cb12d3c75ed0cbd1a6445624

data/.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea/
+
+*.png

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.3

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    mikado_graph_generator (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  mikado_graph_generator!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.14.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Shahriyar Nasir
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# Mikado Graph Generator
+
+Welcome to a DSL for creating Mikado Graphs using *GraphViz*.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "mikado_graph"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mikado_graph
+
+### Prerequisites
+
+Ensure you have *GraphViz* installed. On macOS you can install it using Homebrew with the following command:
+
+```bash
+brew install graphviz
+```
+
+## Usage
+
+You can use this gem's DSL in the following way to create a Mikado Graph generator definition file:
+
+```ruby
+require "mikado_graph"
+
+MikadoGraph::Generator.generate 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
+```
+
+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
+```
+
+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)
+
+## 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).
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mikado_graph"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mikado_graph.rb

@@ -0,0 +1,8 @@
+require "mikado_graph/version"
+
+require "mikado_graph/state"
+require "mikado_graph/dependencies"
+require "mikado_graph/generator"
+
+module MikadoGraph
+end

data/lib/mikado_graph/dependencies.rb

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

data/lib/mikado_graph/generator.rb

@@ -0,0 +1,44 @@
+module MikadoGraph
+  module Generator
+    extend self
+
+    def generate(&block)
+      dependencies = Dependencies.new
+      dependencies.instance_eval(&block)
+      convert(dependencies.dependent_states)
+    end
+
+    private
+
+    def convert(states)
+      convert_header
+      convert_states_and_dependencies(states)
+      convert_footer
+    end
+
+    def convert_header
+      puts "digraph {"
+      puts "  node [shape=box];"
+      puts "  rankdir=\"LR\";"
+    end
+
+    def convert_states_and_dependencies(states)
+      states.each { |state| convert_dependencies(state) }
+    end
+
+    def convert_dependencies(state)
+      state.dependent_states.each do |dependent_state|
+        convert_dependency(state, dependent_state)
+        convert_dependencies(dependent_state)
+      end
+    end
+
+    def convert_dependency(state, dependent_state)
+      puts "  \"#{dependent_state.name}\" -> \"#{state.name}\";"
+    end
+
+    def convert_footer
+      puts "}"
+    end
+  end
+end

data/lib/mikado_graph/state.rb

@@ -0,0 +1,23 @@
+module MikadoGraph
+  class State
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def depends_on(&block)
+      dependencies = Dependencies.new
+      dependencies.instance_eval(&block)
+      @dependent_states = dependencies.dependent_states
+    end
+
+    def dependent_states
+      @dependent_states || []
+    end
+
+    def to_s
+      name
+    end
+  end
+end

data/lib/mikado_graph/version.rb

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

data/mikado_graph.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$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.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|
+    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 "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: mikado_graph_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shahriyar Nasir
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Provides a simple DSL for generating Mikado Graphs using GraphViz.
+email:
+- contact@snasir.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- img/multi_level_mikado_graph.png
+- lib/mikado_graph.rb
+- lib/mikado_graph/dependencies.rb
+- lib/mikado_graph/generator.rb
+- lib/mikado_graph/state.rb
+- lib/mikado_graph/version.rb
+- mikado_graph.gemspec
+homepage: https://github.com/snasirca/mikado_graph_generator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Mikado Graph generator
+test_files: []