diagram 0.2.1 → 0.3.0

data/sig/diagrams/class_diagram.rbs

@@ -0,0 +1,33 @@
+
+module Diagrams
+  class ClassDiagram < Base
+    attr_reader classes: ::Array[Elements::ClassEntity]
+    attr_reader relationships: ::Array[Elements::Relationship]
+
+    # Initializes a new ClassDiagram.
+    def initialize: (?classes: ::Array[Elements::ClassEntity]?, ?relationships: ::Array[Elements::Relationship]?, ?version: Integer | String?) -> void
+
+    # Adds a class entity to the diagram.
+    def add_class: (Elements::ClassEntity class_entity) -> Elements::ClassEntity
+
+    # Adds a relationship to the diagram.
+    def add_relationship: (Elements::Relationship relationship) -> Elements::Relationship
+
+    # Finds a class entity by its name.
+    def find_class: (::String class_name) -> Elements::ClassEntity?
+
+    # Returns the specific content of the class diagram as a hash.
+    def to_h_content: () -> { classes: ::Array[Hash[Symbol, untyped]], relationships: ::Array[Hash[Symbol, untyped]] }
+
+    # Returns a hash mapping element types to their collections for diffing.
+    def identifiable_elements: () -> { classes: ::Array[Elements::ClassEntity], relationships: ::Array[Elements::Relationship] }
+
+    # Class method to create a ClassDiagram from a hash.
+    def self.from_h: (Hash[Symbol | String, untyped] data_hash, version: Integer | String?, checksum: String?) -> ClassDiagram
+
+    private
+
+    # Validates the consistency of classes and relationships during initialization.
+    def validate_elements!: () -> void
+  end
+end

data/sig/diagrams/elements/class_entity.rbs

@@ -0,0 +1,15 @@
+module Diagrams
+  module Elements
+    class ClassEntity < ::Dry::Struct
+      include Diagrams::Elements::Types
+
+      # Attributes
+      def name: () -> ::String
+      def attributes: () -> ::Array[::String]
+      def methods: () -> ::Array[::String]
+
+      # Methods
+      def to_h: () -> { name: ::String, attributes: ::Array[::String], methods: ::Array[::String] }
+    end
+  end
+end

data/sig/diagrams/elements/edge.rbs

@@ -0,0 +1,16 @@
+module Diagrams
+  module Elements
+    class Edge < ::Dry::Struct
+      include Diagrams::Elements::Types
+
+      # Attributes
+      def source_id: () -> ::String
+      def target_id: () -> ::String
+      def label: () -> ::String?
+
+      # Methods
+      # Dry::Struct provides to_h, signature reflects potential nil label removal
+      def to_h: () -> { source_id: ::String, target_id: ::String, ?label: ::String }
+    end
+  end
+end

data/sig/diagrams/elements/event.rbs

@@ -0,0 +1,14 @@
+module Diagrams
+  module Elements
+    class Event < ::Dry::Struct
+      include Diagrams::Elements::Types
+
+      # Attributes
+      def id: () -> ::String
+      def label: () -> ::String?
+
+      # Methods
+      def to_h: () -> { id: ::String, ?label: ::String }
+    end
+  end
+end

data/sig/diagrams/elements/node.rbs

@@ -0,0 +1,14 @@
+module Diagrams
+  module Elements
+    class Node < ::Dry::Struct
+      include Diagrams::Elements::Types
+
+      # Attributes
+      def id: () -> ::String
+      def label: () -> ::String
+
+      # Methods
+      def to_h: () -> { id: ::String, label: ::String }
+    end
+  end
+end

data/sig/diagrams/elements/relationship.rbs

@@ -0,0 +1,16 @@
+module Diagrams
+  module Elements
+    class Relationship < ::Dry::Struct
+      include Diagrams::Elements::Types
+
+      # Attributes
+      def source_class_name: () -> ::String
+      def target_class_name: () -> ::String
+      def type: () -> ::String
+      def label: () -> ::String?
+
+      # Methods
+      def to_h: () -> { source_class_name: ::String, target_class_name: ::String, type: ::String, ?label: ::String }
+    end
+  end
+end

data/sig/diagrams/elements/slice.rbs

@@ -0,0 +1,14 @@
+module Diagrams
+  module Elements
+    class Slice < ::Dry::Struct
+      include Diagrams::Elements::Types
+
+      # Attributes
+      def label: () -> ::String
+      def value: () -> ::Float
+
+      # Methods
+      def to_h: () -> { label: ::String, value: ::Float }
+    end
+  end
+end

data/sig/diagrams/elements/state.rbs

@@ -0,0 +1,14 @@
+module Diagrams
+  module Elements
+    class State < ::Dry::Struct
+      include Diagrams::Elements::Types
+
+      # Attributes
+      def id: () -> ::String
+      def label: () -> ::String?
+
+      # Methods
+      def to_h: () -> { id: ::String, ?label: ::String }
+    end
+  end
+end

data/sig/diagrams/elements/task.rbs

@@ -0,0 +1,16 @@
+module Diagrams
+  module Elements
+    class Task < ::Dry::Struct
+      include Diagrams::Elements::Types
+
+      # Attributes
+      def id: () -> ::String
+      def name: () -> ::String
+      def start_date: () -> ::String # Or ::Date if type is changed
+      def end_date: () -> ::String   # Or ::Date if type is changed
+
+      # Methods
+      def to_h: () -> { id: ::String, name: ::String, start_date: ::String, end_date: ::String }
+    end
+  end
+end

data/sig/diagrams/elements/transition.rbs

@@ -0,0 +1,15 @@
+module Diagrams
+  module Elements
+    class Transition < ::Dry::Struct
+      include Diagrams::Elements::Types
+
+      # Attributes
+      def source_state_id: () -> ::String
+      def target_state_id: () -> ::String
+      def label: () -> ::String?
+
+      # Methods
+      def to_h: () -> { source_state_id: ::String, target_state_id: ::String, ?label: ::String }
+    end
+  end
+end

data/sig/diagrams/elements/types.rbs

@@ -0,0 +1,18 @@
+# Signatures for the shared Dry::Types module used by elements.
+# Note: Dry::Types integration with RBS can be complex. This is a basic representation.
+module Diagrams
+  module Elements
+    module Types
+      # Define common types used in elements if needed, or rely on Dry::Types inference.
+      # Example:
+      # type StrictString = ::String
+      # type StrictFloat = ::Float
+      # type StrictArray[T] = ::Array[T]
+      # type String? = StrictString?
+      # ... etc ...
+
+      # Include the Dry::Types module interface (basic representation)
+      include ::Dry::Types
+    end
+  end
+end

data/sig/diagrams/flowchart_diagram.rbs

@@ -0,0 +1,32 @@
+module Diagrams
+  class FlowchartDiagram < Base
+    attr_reader nodes: ::Array[Element::Node]
+    attr_reader edges: ::Array[Element::Edge]
+
+    # Initializes a new FlowchartDiagram.
+    def initialize: (?nodes: ::Array[Element::Node]?, ?edges: ::Array[Element::Edge]?, ?version: Integer | String?) -> void
+
+    # Adds a node to the diagram.
+    def add_node: (Element::Node node) -> Element::Node
+
+    # Adds an edge to the diagram.
+    def add_edge: (Element::Edge edge) -> Element::Edge
+
+    # Finds a node by its ID.
+    def find_node: (::String node_id) -> Element::Node?
+
+    # Returns the specific content of the flowchart diagram as a hash.
+    def to_h_content: () -> { nodes: ::Array[Hash[Symbol, untyped]], edges: ::Array[Hash[Symbol, untyped]] }
+
+    # Returns a hash mapping element types to their collections for diffing.
+    def identifiable_elements: () -> { nodes: ::Array[Elements::Node], edges: ::Array[Elements::Edge] }
+
+    # Class method to create a FlowchartDiagram from a hash.
+    def self.from_h: (Hash[Symbol | String, untyped] data_hash, version: Integer | String?, checksum: String?) -> FlowchartDiagram
+
+    private
+
+    # Validates the consistency of nodes and edges during initialization.
+    def validate_elements!: () -> void
+  end
+end

data/sig/diagrams/gantt_diagram.rbs

@@ -0,0 +1,29 @@
+module Diagrams
+  class GanttDiagram < Base
+    attr_reader title: ::String
+    attr_reader tasks: ::Array[Elements::Task]
+
+    # Initializes a new GanttDiagram.
+    def initialize: (?title: ::String?, ?tasks: ::Array[Elements::Task]?, ?version: Integer | String?) -> void
+
+    # Adds a task to the diagram.
+    def add_task: (Elements::Task task) -> Elements::Task
+
+    # Finds a task by its ID.
+    def find_task: (::String task_id) -> Elements::Task?
+
+    # Returns the specific content of the Gantt diagram as a hash.
+    def to_h_content: () -> { title: ::String, tasks: ::Array[Hash[Symbol, untyped]] }
+
+    # Returns a hash mapping element types to their collections for diffing.
+    def identifiable_elements: () -> { tasks: ::Array[Elements::Task] }
+
+    # Class method to create a GanttDiagram from a hash.
+    def self.from_h: (Hash[Symbol | String, untyped] data_hash, version: Integer | String?, checksum: String?) -> GanttDiagram
+
+    private
+
+    # Validates the consistency of tasks during initialization.
+    def validate_elements!: () -> void
+  end
+end

data/sig/diagrams/pie_diagram.rbs

@@ -0,0 +1,36 @@
+module Diagrams
+  class PieDiagram < Base
+    attr_reader title: ::String
+    attr_reader slices: ::Array[Elements::Slice]
+
+    # Initializes a new PieDiagram.
+    def initialize: (?title: ::String?, ?slices: ::Array[Elements::Slice]?, ?version: Integer | String?) -> void
+
+    # Adds a slice to the diagram.
+    # Note: update_checksum and initial_load are internal flags.
+    def add_slice: (Elements::Slice slice, ?update_checksum: bool, ?initial_load: bool) -> Elements::Slice
+
+    # Finds a slice by its label.
+    def find_slice: (::String label) -> Elements::Slice?
+
+    # Calculates the total raw value of all slices.
+    def total_value: () -> ::Float
+
+    # Returns the specific content of the pie diagram as a hash.
+    def to_h_content: () -> { title: ::String, slices: ::Array[Hash[Symbol, untyped]] }
+
+    # Returns a hash mapping element types to their collections for diffing.
+    def identifiable_elements: () -> { slices: ::Array[Elements::Slice] }
+
+    # Class method to create a PieDiagram from a hash.
+    def self.from_h: (Hash[Symbol | String, untyped] data_hash, version: Integer | String?, checksum: String?) -> PieDiagram
+
+    private
+
+    # Validates the consistency of slices during initialization.
+    def validate_elements!: () -> void
+
+    # Recalculates the percentage for each slice based on the total value.
+    def recalculate_percentages!: () -> void
+  end
+end

data/sig/diagrams/state_diagram.rbs

@@ -0,0 +1,40 @@
+module Diagrams
+  class StateDiagram < Base
+    attr_reader title: ::String
+    attr_reader states: ::Array[Elements::State]
+    attr_reader transitions: ::Array[Elements::Transition]
+    attr_reader events: ::Array[Elements::Event]
+
+    # Initializes a new StateDiagram.
+    def initialize: (?title: ::String?, ?states: ::Array[Elements::State]?, ?transitions: ::Array[Elements::Transition]?, ?events: ::Array[Elements::Event]?, ?version: Integer | String?) -> void
+
+    # Adds a state to the diagram.
+    def add_state: (Elements::State state) -> Elements::State
+
+    # Adds a transition to the diagram.
+    def add_transition: (Elements::Transition transition) -> Elements::Transition
+
+    # Adds an event to the diagram.
+    def add_event: (Elements::Event event) -> Elements::Event
+
+    # Finds a state by its ID.
+    def find_state: (::String state_id) -> Elements::State?
+
+    # Finds an event by its ID.
+    def find_event: (::String event_id) -> Elements::Event?
+
+    # Returns the specific content of the state diagram as a hash.
+    def to_h_content: () -> { title: ::String, states: ::Array[Hash[Symbol, untyped]], transitions: ::Array[Hash[Symbol, untyped]], events: ::Array[Hash[Symbol, untyped]] }
+
+    # Returns a hash mapping element types to their collections for diffing.
+    def identifiable_elements: () -> { states: ::Array[Elements::State], transitions: ::Array[Elements::Transition], events: ::Array[Elements::Event] }
+
+    # Class method to create a StateDiagram from a hash.
+    def self.from_h: (Hash[Symbol | String, untyped] data_hash, version: Integer | String?, checksum: String?) -> StateDiagram
+
+    private
+
+    # Validates the consistency of elements during initialization.
+    def validate_elements!: () -> void
+  end
+end

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: diagram
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Abdelkader Boudih
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-03 00:00:00.000000000 Z
+date: 2025-03-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-equalizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: dry-struct
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +37,174 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.5
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.59'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.59'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Work with diagrams in Ruby
 email:
 - seuros@pre-history.com
@@ -32,27 +213,38 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/diagrams.rb
-- lib/diagrams/abstract_diagram.rb
+- lib/diagrams/base.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/elements/class_entity.rb
+- lib/diagrams/elements/edge.rb
+- lib/diagrams/elements/event.rb
+- lib/diagrams/elements/node.rb
+- lib/diagrams/elements/relationship.rb
+- lib/diagrams/elements/slice.rb
+- lib/diagrams/elements/state.rb
+- lib/diagrams/elements/task.rb
+- lib/diagrams/elements/transition.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
+- sig/diagrams/base.rbs
+- sig/diagrams/class_diagram.rbs
+- sig/diagrams/elements/class_entity.rbs
+- sig/diagrams/elements/edge.rbs
+- sig/diagrams/elements/event.rbs
+- sig/diagrams/elements/node.rbs
+- sig/diagrams/elements/relationship.rbs
+- sig/diagrams/elements/slice.rbs
+- sig/diagrams/elements/state.rbs
+- sig/diagrams/elements/task.rbs
+- sig/diagrams/elements/transition.rbs
+- sig/diagrams/elements/types.rbs
+- sig/diagrams/flowchart_diagram.rbs
+- sig/diagrams/gantt_diagram.rbs
+- sig/diagrams/pie_diagram.rbs
+- sig/diagrams/state_diagram.rbs
 homepage: https://github.com/seuros/diagram-ruby
 licenses:
 - MIT
@@ -61,7 +253,6 @@ metadata:
   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
@@ -69,15 +260,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Work with diagrams in Ruby
 test_files: []

data/lib/diagrams/abstract_diagram.rb

@@ -1,26 +0,0 @@
-# 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

@@ -1,15 +0,0 @@
-# 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

@@ -1,14 +0,0 @@
-# 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