diagrams-rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca6654ecfc36d63b19a5081d1cd9bc05fc071bd78539da3ee0a37776eaf1508e
+  data.tar.gz: a1509778ac0d02b70017f2e5eb7cb736843d73ad2842aadafad24f7c6387e323
+SHA512:
+  metadata.gz: 46125e7f16938e35d0141c0f8d954b08d7fc5da41fb5f3d6d3860295a0aaca13610dc4dc84f6c1551a82720f74719e533a0b94850ce1d18306722ba2f3e16e0d
+  data.tar.gz: eee3bba493ed460caf6dde29078950ae14bacba44f898e5df2ed08003c02651e0c7605005ee96a672637ea57ea6913c5d02370676407c65c669f6896281df0bc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/FileName:
+  Enabled: false
+
+Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-19
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ger O'Mahony
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 TODO: Write your name
+
+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,35 @@
+# Diagrams in Ruby
+
+This Ruby-based DSL allows you to create complex Graphviz DOT diagrams programmatically.
+
+Graphviz provides the CLI for converting `.dot` files into images.
+
+With this DSL, you can define nodes, edges, and nested clusters that represent relationships and hierarchies visually.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```Ruby
+gem 'diagrams-rb', '~> 0.1'
+```
+
+or install:
+
+```Ruby
+gem install diagrams-rb
+```
+
+To use this DSL and render the `.dot` files it generates, you need to install [Graphviz](https://graphviz.org). See the [documentation](https://g-omahony.github.io/diagrams-rb-docs/docs/installation/) for more details.
+
+## Usage
+
+See the [documentation](https://g-omahony.github.io/diagrams-rb-docs/) for details and examples.
+
+## Contributing
+
+1. Fork it ( https://github.com/g-omahony/diagrams-rb/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/diagrams/digraph.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class Digraph
+    def initialize(**attributes, &block)
+      @graph = Dot.new(**attributes)
+      instance_eval(&block)
+      @graph.generate_image
+    end
+
+    def node(id, label: nil, icon: nil, **attributes)
+      @graph.add_node(id, label: label, icon: icon, **attributes)
+    end
+
+    def edge(from, to:, **attributes)
+      Array(from).each { |f| Array(to).each { |t| @graph.add_edge(f, to: t, **attributes) } }
+    end
+
+    def cluster(label = '', **attributes, &block)
+      @graph.begin_cluster(label, **attributes)
+      instance_eval(&block)
+      @graph.end_cluster
+    end
+  end
+end

data/lib/diagrams/dot.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'tempfile'
+
+module Diagrams
+  class Dot
+    GRAPH_DEFAULTS = {
+      pad: '2.0',
+      splines: 'ortho',
+      nodesep: '0.60',
+      ranksep: '0.75',
+      rankdir: 'TB',
+      fontname: '"Sans-Serif"',
+      fontsize: '15',
+      fontcolor: '"#2D3436"'
+    }.freeze
+
+    NODE_DEFAULTS = {
+      shape: 'box',
+      style: 'rounded',
+      fixedsize: 'true',
+      width: '1.4',
+      height: '1.4',
+      labelloc: 'b',
+      imagescale: 'true',
+      penwidth: '0',
+      fontname: '"Sans-Serif"',
+      fontsize: '13',
+      fontcolor: '"#2D3436"'
+    }.freeze
+
+    CLUSTER_DEFAULTS = {
+      shape: 'box',
+      style: 'rounded',
+      labeljust: 'l',
+      pencolor: '"#AEB6BE"'
+    }.freeze
+
+    CLUSTER_BGCOLORS = %w[#E5F5FD #EBF3E7 #ECE8F6 #FDF7E3].freeze
+
+    EDGE_DEFAULTS = {
+      color: '"#7B8894"',
+      fontcolor: '"#2D3436"',
+      fontname: '"Sans-Serif"',
+      fontsize: '13'
+    }.freeze
+
+    attr_accessor :dot_output, :format, :space, :clen
+
+    def initialize(**attrs)
+      @dot_output = "digraph G {\n".dup
+      @format = attrs.delete(:format) || 'png'
+      GRAPH_DEFAULTS.merge(attrs).each do |key, value|
+        @dot_output << "    #{key}=#{value};\n"
+      end
+      @space = '  '
+      @clen = CLUSTER_BGCOLORS.length
+      @depth = 0
+      @cluster_idx = -1
+    end
+
+    def indent
+      space * @depth
+    end
+
+    def add_node(id, label: '', icon: nil, **attrs)
+      attributes = NODE_DEFAULTS.merge(attrs).map { |k, v| "#{k}=#{v}" }.join(',')
+      dot_output << "#{indent}    #{id} [label=\"#{label}\", image=\"#{icon}\", #{attributes}];\n"
+    end
+
+    def add_edge(from, to:, **attrs)
+      attributes = EDGE_DEFAULTS.merge(attrs).map { |k, v| "#{k}=#{v}" }.join(',')
+      dot_output << "    #{from} -> #{to} [#{attributes}];\n"
+    end
+
+    def begin_cluster(label, **attrs) # rubocop:disable Metrics/AbcSize
+      cluster_label = label.empty? ? "cluster_#{@cluster_idx += 1}" : label
+
+      dot_output << "#{indent}subgraph cluster_#{identifier(cluster_label)} {\n"
+      dot_output << "#{indent}    label=\"#{label}\";\n"
+      dot_output << "#{indent}    bgcolor=\"#{CLUSTER_BGCOLORS[@depth % clen]}\";\n"
+      CLUSTER_DEFAULTS.merge(attrs).each do |key, value|
+        dot_output << "#{indent}   #{key}=#{value};\n"
+      end
+      @depth += 1
+    end
+
+    def end_cluster
+      dot_output << "#{indent}}\n"
+      @depth -= 1
+    end
+
+    def identifier(string)
+      string.gsub(/\s+/, '_')
+    end
+
+    def generate_image
+      output_path = caller_locations.last.path.gsub('.rb', ".#{format}")
+      dot_output << "}\n"
+      Tempfile.open('temp.dot') do |file|
+        File.write(file.path, dot_output)
+
+        cmd = "dot -T#{format} #{file.path} -o #{output_path}"
+        _, stderr, status = Open3.capture3(cmd)
+        puts stderr unless status.success?
+      end
+    end
+  end
+end

data/lib/diagrams/resources.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Diagrams
+  module Resources
+    class << self
+      def load_icons # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        root = File.expand_path('../..', __dir__)
+        base_path = "#{root}/resources"
+
+        Dir.glob("#{base_path}/**/*.png").each do |file_path|
+          relative_path = file_path.sub("#{base_path}/", '')
+          path_parts = relative_path.split('/')
+
+          image_name_with_extension = path_parts.pop
+          image_name_without_extension = File.basename(image_name_with_extension, '.png')
+
+          current_module = self
+          path_parts.each do |part|
+            # Create or get the submodule dynamically
+            submodule = current_module.const_get(part.capitalize) rescue nil
+            unless submodule
+              submodule = Module.new
+              current_module.const_set(part.capitalize, submodule)
+            end
+            current_module = submodule
+          end
+
+          current_module.define_singleton_method(image_name_without_extension.gsub('-', '_')) do
+            file_path
+          end
+        end
+      end
+    end
+  end
+end

data/lib/diagrams/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Diagrams
+  VERSION = '0.0.1'
+end

data/lib/diagrams-rb.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'diagrams/version'
+
+module Diagrams
+  require 'diagrams/dot'
+  require 'diagrams/digraph'
+  require 'diagrams/resources'
+
+  Resources.load_icons
+  include(Resources)
+end