graphy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5855af538a3e42839fb6291076af3a81d7d6e117624e0ff912dfb537599b1d78
+  data.tar.gz: 43f3be7f19de34cf97743b03bdab151ae7cbc3d8fbe970802434dc11618dca33
+SHA512:
+  metadata.gz: 811d052517b6a4a32b354818976a62f6fd38dc695ad7df03b21601b58793f923909d7337aa1968547d55eb4e6c5a4f7f92213740210a63396376a1485de22bd1
+  data.tar.gz: 51c60f6b786035b87ee4357358db75b7edab3d7f0ffd6f605412b3d221081fc598f12ac4261cc7e02cc80685f779f3eba53c0788830c9794c078b6746042229d

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ing.ezcurdia@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in Graphy.gemspec
+gemspec
+
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    arq (0.1.0)
+      ruby-graphviz (~> 1.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.2)
+    rake (12.3.3)
+    rexml (3.2.4)
+    ruby-graphviz (1.2.5)
+      rexml
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  arq!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Luis Ezcurdia Razo
+
+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,83 @@
+# Graphy
+
+Create any diagram as code
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphy'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install graphy
+
+## Usage
+
+### Module
+
+```ruby
+Graphy.define 'UML View' do
+  entity 'Friendly'
+  namespace "Animal Kingdom" do
+    entity 'Animal' do
+      attributes :name
+    end
+
+    entity 'Dog', 'Animal' do
+      attributes :color
+      uses 'Friendly'
+    end
+
+    entity 'Cat', 'Animal' do
+      attributes :scratch
+    end
+  end
+
+  write(png: 'hello.png')
+end
+```
+
+### State machine
+
+```ruby
+Graphy.define 'State machine' do
+  node 'A'
+  node 'B', shape: 'diamond'
+  node 'C'
+  node 'D', shape: 'egg'
+
+  step 'A', to: 'B'
+  step 'B', to: 'C'
+  step 'C', to: 'A'
+  step 'C', to: 'D'
+  step 'D', to: 'C'
+
+  write(png: 'steps.png')
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/3zcurdia/graphy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/3zcurdia/graphy/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Arq project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/3zcurdia/graphy/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'graphy'
+
+# 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/examples/example00.rb

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+require 'graphviz/dsl'
+
+digraph :example do
+   cluster_0 do
+      graph[label: 'Animal Kingdom']
+      animal << dog
+      animal << cat
+   end
+   friendly << dog
+
+   output(png: "#{$0}.png")
+end

data/examples/example01.rb

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+require 'graphy'
+
+Graphy.define do
+  node 'A'
+  node 'B', shape: 'diamond'
+  node 'C'
+  node 'D', shape: 'egg'
+
+  step 'A', to: 'B'
+  step 'B', to: 'C'
+  step 'C', to: 'A'
+  step 'C', to: 'D'
+  step 'D', to: 'C'
+
+  write png: "#{$0}.png"
+end

data/examples/example02.rb

@@ -0,0 +1,20 @@
+require 'bundler/setup'
+require 'graphy'
+
+Graphy.define 'Life View' do
+  entity 'Friendly'
+  entity 'Animal' do
+    attributes :name, :other
+  end
+
+  entity 'Dog', 'Animal' do
+    attributes :color
+    uses 'Friendly'
+  end
+
+  entity 'Cat', 'Animal' do
+    attributes :scratch
+  end
+
+  write png: "#{$0}.png"
+end

data/graphy.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/graphy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'graphy'
+  spec.version       = Graphy::VERSION
+  spec.authors       = ['Luis Ezcurdia Razo']
+  spec.email         = ['ing.ezcurdia@gmail.com']
+
+  spec.summary       = 'Create diagrams as code.'
+  spec.description   = 'Create any graph diagram as code.'
+  spec.homepage      = 'https://github.com/3zcurdia/graphy'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/3zcurdia/graphy'
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'ruby-graphviz', '~> 1.2.0'
+end

data/lib/graphy.rb

@@ -0,0 +1,13 @@
+require 'graphviz'
+require 'graphy/node'
+require 'graphy/entity'
+require 'graphy/dependency'
+require 'graphy/dsl'
+require 'graphy/version'
+
+module Graphy
+  class Error < StandardError; end
+  def self.define(name=nil, options={}, &block)
+    Dsl.new(name, options, &block)
+  end
+end

data/lib/graphy/dependency.rb

@@ -0,0 +1,29 @@
+module Graphy
+  class Dependency
+    def self.for(reference, type: nil)
+      case type
+      when :parent
+        Parent
+      else
+        Default
+      end.new(reference)
+    end
+
+    class Default
+      attr_accessor :ref
+      def initialize(ref)
+        @ref = ref
+      end
+
+      def edge_attributes
+        {}
+      end
+    end
+
+    class Parent < Default
+      def edge_attributes
+        { style: 'dotted', color: 'blue' }
+      end
+    end
+  end
+end

data/lib/graphy/dsl.rb

@@ -0,0 +1,84 @@
+module Graphy
+  class Dsl
+    @registry = {}
+    @edges = []
+
+    def self.registry
+      @registry
+    end
+
+    def self.edges
+      @edges
+    end
+
+    def initialize(name, options = {}, &block)
+      @graph = GraphViz.new(name, map_options(options.merge(label: name)))
+      instance_eval(&block) if block
+    end
+
+    def namespace(name, &block)
+      opts = { parent: graph, type: graph.type }
+      graph.add_graph(Dsl.new(name, opts, &block).graph)
+    end
+
+    def component(name, &block)
+      node(name, shape: 'component', &block)
+    end
+
+    def note(name, &block)
+      node(name, shape: 'note', &block)
+    end
+
+    def node(name, shape: 'circle', &block)
+      return graph.get_node(name) unless graph.get_node(name.to_s).nil?
+
+      node = Node.new(name, graph: graph, shape: shape)
+      node.instance_eval(&block) if block_given?
+      Dsl.registry[name] = node
+    end
+
+    def entity(name, parent = nil, &block)
+      return graph.get_node(name) unless graph.get_node(name.to_s).nil?
+
+      entity = Entity.new(name, graph: graph)
+      entity.add_dependency(parent, type: :parent) if parent
+      entity.instance_eval(&block) if block_given?
+      Dsl.registry[name] = entity
+    end
+
+    def step(from, to:, options: {})
+      return if Dsl.edges.any? { |x| [from, to] == x }
+      source = Dsl.registry[from].graph_node
+      dest = Dsl.registry[to].graph_node
+      return if source.nil? || dest.nil?
+
+      Dsl.edges << [from, to]
+      graph.add_edge(source, dest, options)
+    end
+
+    def graph
+      build
+      @graph
+    end
+
+    def write(options = {})
+      graph.output(options)
+    end
+
+    private
+
+    def build
+      Dsl.registry.each do |name, node|
+        node.dependencies.each do |dep|
+          step(dep.ref, to: name, options: dep.edge_attributes)
+        end
+      end
+    end
+
+    def map_options(options = {})
+      align = options.delete(:align)
+      rankdir = align == :horizontal ? 'LR' : nil
+      options.merge(rankdir: rankdir).compact
+    end
+  end
+end

data/lib/graphy/entity.rb

@@ -0,0 +1,25 @@
+module Graphy
+  class Entity < Node
+    def initialize(name, graph:)
+      super(name, graph: graph, shape: 'record')
+      @attributes = []
+    end
+
+    def attributes(*values)
+      @attributes = values
+    end
+
+    protected
+
+    def label
+      "{ #{name} #{attributes_label} }"
+    end
+
+    private
+
+    def attributes_label
+      return if @attributes.empty?
+      "| #{@attributes.join("\n")}" 
+    end
+  end
+end

data/lib/graphy/node.rb

@@ -0,0 +1,38 @@
+module Graphy
+  class Node
+    attr_accessor :graph, :name, :shape, :penwidth, :fontsize, :style, :fillcolor, :dependencies
+    def initialize(name, graph:, shape: 'circle')
+      @name = name
+      @graph = graph
+      @shape = shape
+      @dependencies = []
+    end
+
+    def graph_node
+      @graph_node ||= graph.add_nodes(name, node_attributes)
+    end
+
+    def add_dependency(dependency, type: nil)
+      @dependencies << Dependency.for(dependency, type: type)
+    end
+    alias :uses :add_dependency
+
+    protected
+
+    def node_attributes
+      {
+        shape: shape,
+        penwidth: penwidth,
+        fontsize: fontsize,
+        fontname: 'Helvetica',
+        style: style,
+        fillcolor: fillcolor,
+        label: label
+      }.compact
+    end
+
+    def label
+      "#{name}\n"
+    end
+  end
+end

data/lib/graphy/version.rb

@@ -0,0 +1,3 @@
+module Graphy
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: graphy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luis Ezcurdia Razo
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: Create any graph diagram as code.
+email:
+- ing.ezcurdia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/example00.rb
+- examples/example00.rb.png
+- examples/example01.rb
+- examples/example01.rb.png
+- examples/example02.rb
+- examples/example02.rb.png
+- graphy.gemspec
+- lib/graphy.rb
+- lib/graphy/dependency.rb
+- lib/graphy/dsl.rb
+- lib/graphy/entity.rb
+- lib/graphy/node.rb
+- lib/graphy/version.rb
+homepage: https://github.com/3zcurdia/graphy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/3zcurdia/graphy
+  source_code_uri: https://github.com/3zcurdia/graphy
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.3
+signing_key:
+specification_version: 4
+summary: Create diagrams as code.
+test_files: []