diagram 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ef3c343a2636e4f7ffda61678ff784b5d0b083d25ab83364e0285cb5c150acd
+  data.tar.gz: 9988256feb04b4eee350d792cc697cdb3bee87371a0211f5f714a4f1c380d2e8
+SHA512:
+  metadata.gz: b9bf6af4e963b22981ce1eec3205e1d35e3a25752183fc2b91b1650148e3eb08f738522535b6234eca33cab21be7070132f8f41f4dff9663fa35bff8cf1d742d
+  data.tar.gz: 4ce8d1844a7bd0c961a89ed838d3541cbf10a9794f897622aea05f81b654937acc9054c7a09a114d625e22bfe12af524ea7832e3a20a1f40f0ca1e9c39548fb1

data/lib/diagrams/abstract_diagram.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Diagrams
+  # Abstract class for diagrams
+  class AbstractDiagram < Dry::Struct
+    module Types
+      include Dry.Types()
+    end
+
+    def initialize(*)
+      raise NotImplementedError, 'Cannot instantiate abstract class' if instance_of?(AbstractDiagram)
+
+      super
+    end
+
+    def type
+      raise NotImplementedError, 'Subclasses must define `type`.'
+    end
+
+    ## Errors
+    class ValidationError < StandardError; end
+    class EmptyDiagramError < ValidationError; end
+    class InvalidPercentageError < ValidationError; end
+    class DuplicateLabelError < ValidationError; end
+  end
+end

data/lib/diagrams/class_diagram/class/field.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class ClassDiagram
+    class Class
+      class Field < Dry::Struct
+        attribute :name, ClassDiagram::Types::String
+        attribute :type, ClassDiagram::Types::String.optional.default('String')
+        attribute :visibility,
+                  ClassDiagram::Types::String.optional.default('public')
+                                             .constrained(format: /\A(public|private|protected|Internal)\z/)
+      end
+    end
+  end
+end

data/lib/diagrams/class_diagram/class/function/argument.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class ClassDiagram
+    class Class
+      class Function
+        class Argument < Dry::Struct
+          attribute :name, ClassDiagram::Types::String
+          attribute :type, ClassDiagram::Types::String.optional.default(nil)
+        end
+      end
+    end
+  end
+end

data/lib/diagrams/class_diagram/class/function.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class ClassDiagram
+    class Class
+      class Function < Dry::Struct
+        attribute :name, ClassDiagram::Types::String
+        attribute :return_type, ClassDiagram::Types::String.optional.default('void')
+        attribute :arguments, ClassDiagram::Types::Array.of(Argument)
+        attribute :visibility,
+                  ClassDiagram::Types::String.optional.default('public')
+                                             .constrained(format: /\A(public|private|protected)\z/)
+      end
+    end
+  end
+end

data/lib/diagrams/class_diagram/class.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class ClassDiagram
+    class Class < Dry::Struct
+      attribute :id, ClassDiagram::Types::String.constrained(format: /\A[a-zA-Z0-9_-]+\z/)
+      attribute :label, ClassDiagram::Types::String.optional.default(nil)
+      attribute :fields, ClassDiagram::Types::Array.of(Field)
+      attribute :functions, ClassDiagram::Types::Array.of(Function)
+    end
+  end
+end

data/lib/diagrams/class_diagram.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class ClassDiagram < AbstractDiagram
+    attribute :classes, ClassDiagram::Types::Array.of(Class)
+  end
+end

data/lib/diagrams/comparable.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Diagrams
+  module Comparable
+    def ==(other)
+      other.class == self.class && other.state == state
+    end
+    alias eql? ==
+
+    def hash
+      state.hash
+    end
+
+    protected
+
+    def state
+      instance_variables.map { |name| instance_variable_get(name) }
+    end
+  end
+end

data/lib/diagrams/flowchart_diagram/link.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class FlowchartDiagram
+    class Link < Dry::Struct
+      attribute :from, FlowchartDiagram::Types::String
+      attribute :to, FlowchartDiagram::Types::String
+      attribute :label, FlowchartDiagram::Types::String.optional.default(nil)
+    end
+  end
+end

data/lib/diagrams/flowchart_diagram/node.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class FlowchartDiagram
+    class Node < Dry::Struct
+      attribute :id, FlowchartDiagram::Types::String
+      attribute :label, FlowchartDiagram::Types::String
+    end
+  end
+end

data/lib/diagrams/flowchart_diagram.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class FlowchartDiagram < AbstractDiagram
+    attribute :id, Types::String
+    attribute :nodes, Types::Array.of(Node)
+    attribute :links, Types::Array.of(Link)
+  end
+end

data/lib/diagrams/gantt_diagram/section/task.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class GanttDiagram
+    class Section
+      class Task < Dry::Struct
+        attribute :name, GanttDiagram::Types::String
+        attribute :start, GanttDiagram::Types::String
+        attribute :end, GanttDiagram::Types::String
+      end
+    end
+  end
+end

data/lib/diagrams/gantt_diagram/section.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class GanttDiagram
+    class Section < Dry::Struct
+      attribute :name, GanttDiagram::Types::String
+      attribute :tasks, GanttDiagram::Types::Array.of(Task)
+    end
+  end
+end

data/lib/diagrams/gantt_diagram.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class GanttDiagram < AbstractDiagram
+    attribute :title, GanttDiagram::Types::String
+    attribute :sections, GanttDiagram::Types::Array.of(Section)
+  end
+end

data/lib/diagrams/pie_diagram/section.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class PieDiagram
+    class Section < Dry::Struct
+      attribute :label, PieDiagram::Types::String.optional.default(nil)
+      attribute :value, PieDiagram::Types::Coercible::Float.optional.default(0).constrained(gteq: 0)
+    end
+  end
+end

data/lib/diagrams/pie_diagram.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class PieDiagram < AbstractDiagram
+    attribute :id, Types::String.optional.default(nil)
+    attribute :title, Types::String.optional.default('')
+    attribute :sections, Types::Array.of(Section).optional.default([].freeze)
+
+    def type
+      :pie
+    end
+
+    def validate!
+      raise EmptyDiagramError, 'Pie diagram must have at least one section' if sections.empty?
+
+      return true if sections.map(&:label).uniq.size == sections.size
+
+      raise DuplicateLabelError,
+            'Pie diagram sections must have unique labels'
+    end
+
+    def plot
+      circle_char = '*'
+      pie_diameter = 10
+      pie_radius = pie_diameter / 2.0
+
+      (-pie_radius.to_i..pie_radius.to_i).each do |i|
+        (-pie_radius.to_i..pie_radius.to_i).each do |j|
+          distance_to_center = Math.sqrt((i**2) + (j**2))
+          if distance_to_center > pie_radius - 0.5 && distance_to_center < pie_radius + 0.5
+            print circle_char
+          else
+            print ' '
+          end
+        end
+        print "\n"
+      end
+
+      sections.each do |section|
+        puts "#{section.label}: #{section.value}%"
+      end
+    end
+
+    def valid?
+      validate!
+    end
+  end
+end

data/lib/diagrams/plot.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Diagrams
+  module Plot
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def plottable?
+        true
+      end
+    end
+
+    def plottable?
+      self.class.plottable?
+    end
+
+    def plot
+      raise NotImplementedError
+    end
+  end
+end

data/lib/diagrams/state_diagram/event.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class StateDiagram
+    class Event < Dry::Struct
+      attribute :id, StateDiagram::Types::String
+      attribute :label, StateDiagram::Types::String.optional.default(nil)
+    end
+  end
+end

data/lib/diagrams/state_diagram/state.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class StateDiagram
+    class State < Dry::Struct
+      attribute :id, StateDiagram::Types::String
+      attribute :label, StateDiagram::Types::String.optional.default(nil)
+      attribute :type,
+                StateDiagram::Types::String.optional.default('state').enum('state', 'start', 'end', 'fork', 'join')
+    end
+  end
+end

data/lib/diagrams/state_diagram/transition.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class StateDiagram
+    class Transition < Dry::Struct
+      attribute :from, StateDiagram::Types::String
+      attribute :to, StateDiagram::Types::String
+      attribute :label, StateDiagram::Types::String.optional.default(nil)
+    end
+  end
+end

data/lib/diagrams/state_diagram.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Diagrams
+  class StateDiagram < AbstractDiagram
+    attribute :id, Types::String
+    attribute :states, Types::Array.of(State)
+    attribute :transitions, Types::Array.of(Transition)
+  end
+end

data/lib/diagrams/version.rb

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

data/lib/diagrams.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'diagrams/version'
+require 'dry-struct'
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+# This module handles diagrams creation and manipulation.
+module Diagrams
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: diagram
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Abdelkader Boudih
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+description: Work with diagrams in Ruby
+email:
+- seuros@pre-history.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/diagrams.rb
+- lib/diagrams/abstract_diagram.rb
+- lib/diagrams/class_diagram.rb
+- lib/diagrams/class_diagram/class.rb
+- lib/diagrams/class_diagram/class/field.rb
+- lib/diagrams/class_diagram/class/function.rb
+- lib/diagrams/class_diagram/class/function/argument.rb
+- lib/diagrams/comparable.rb
+- lib/diagrams/flowchart_diagram.rb
+- lib/diagrams/flowchart_diagram/link.rb
+- lib/diagrams/flowchart_diagram/node.rb
+- lib/diagrams/gantt_diagram.rb
+- lib/diagrams/gantt_diagram/section.rb
+- lib/diagrams/gantt_diagram/section/task.rb
+- lib/diagrams/pie_diagram.rb
+- lib/diagrams/pie_diagram/section.rb
+- lib/diagrams/plot.rb
+- lib/diagrams/state_diagram.rb
+- lib/diagrams/state_diagram/event.rb
+- lib/diagrams/state_diagram/state.rb
+- lib/diagrams/state_diagram/transition.rb
+- lib/diagrams/version.rb
+homepage: https://github.com/seuros/diagram-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/seuros/diagram-ruby
+  source_code_uri: https://github.com/seuros/diagram-ruby
+  changelog_uri: https://github.com/seuros/diagram-ruby/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Work with diagrams in Ruby
+test_files: []