marmerdo 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75e6024f088234f63afcedd06d33ca186beb1b13f0736b39f015027341930b7a
-  data.tar.gz: 6366471bac61e54a3203fa00f9076902e1312314668052f2382e3c13ceef19a3
+  metadata.gz: 8e2b0cdbcedf12f9dfb5911895a513b11eb2ec50ae992662726a42e6850a9b25
+  data.tar.gz: 14eab34bb7327b4577e305875dd8ceb38c4b481d9f430f4c2e46d380b21742c0
 SHA512:
-  metadata.gz: d8c2114f14742c25fde0c4b8c455a843fbd28af00cad65a1a45a09d57f74575d116366daa2a05367a32f720edd31f153eacf403b718de74c35fef9df780784bc
-  data.tar.gz: 8c042444b75adff10d17cc72d4c882ccb70cf1274a7ba0bbba1aa263b27a1fe4dde4863a1d325a72308f5b2be0015bf1ca9a22b6fc6549a8db735b67754e5b2a
+  metadata.gz: a03c366404c619416df15a42309b1f35b50aacbc88c2341de3b2a1d19f07a9e1cfb5213504701e383839c408722a922b2ea45faf459ebc4443863d554a972fc7
+  data.tar.gz: f7656b060e14e70a3c084f34a95a3a379175d531693842b0975e3f7f6bc9ea2b804f99459f4e587c5181351c8517e8353e40d2cdaca60921f1fcb179f0d4efbf

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.3.1] - 2024-01-07
+
+- 0.3.0がRubyGemsで反映されないため進めたバージョン。
+- 変更はなし。
+
+## [0.3.0] - 2024-01-07
+
+- Add namespace support.
+- inheritanceなどのキーワードのかわりに、直接Mermaid記法でRelationを記載するよう変更。
+
+## [0.2.3] - 2023-12-25
+
+- Add link_extension option.
+
 ## [0.2.2] - 2023-12-20
 
 - 相対リンクが`./`から始まらないことがある問題を修正。

data/lib/marmerdo/cli.rb

@@ -9,9 +9,12 @@ module Marmerdo
     class ArgumentError < Error; end
 
     desc "generate SOURCE_GLOB OUTPUT_PATH", "Generate a mermaid diagram from markdown files"
+    option :link_extension, type: :boolean, default: true, desc: "Whether to write the file extension to the link."
     def generate(source_glob, output_path)
       raise ArgumentError, "You must provide a source glob and an output file" if source_glob.nil? || output_path.nil?
 
+      enable_link_extension = options[:link_extension]
+
       nodes = Dir[source_glob].map do |source_path|
         content = File.read(source_path)
         node = Marmerdo::MarkdownParser.new(source_path, content).parse
@@ -23,7 +26,11 @@ module Marmerdo
 
       puts "Writing domain diagram to #{output_path}."
 
-      domain_diagram = Marmerdo::DomainDiagramGenerator.new(output_path: output_path, nodes: nodes).generate
+      domain_diagram = Marmerdo::DomainDiagramGenerator.new(
+        output_path: output_path,
+        nodes: nodes,
+        enable_link_extension: enable_link_extension
+      ).generate
       output_content = OutputGenerator.new(output_path, domain_diagram).generate
       File.write(output_path, output_content)
 

data/lib/marmerdo/domain_diagram_generator.rb

@@ -1,14 +1,17 @@
 module Marmerdo
   class DomainDiagramGenerator
-    def initialize(output_path:, nodes:)
+    def initialize(output_path:, nodes:, enable_link_extension:)
       @output_path = output_path
       @nodes = nodes
+      @enable_link_extension = enable_link_extension
     end
 
     # @return [String] mermaid class diagram
     def generate
-      classes = @nodes.map(&:to_mermaid_line)
-      links = @nodes.map { |node| node.generate_mermaid_link(@output_path) }
+      classes = @nodes.map(&:to_mermaid_str)
+      links = @nodes.map do |node|
+        node.generate_mermaid_link(@output_path, enable_link_extension: @enable_link_extension)
+      end
 
       relationships = @nodes.flat_map do |node|
         node.relationships.map do |relationship|

data/lib/marmerdo/markdown_parser.rb

@@ -16,6 +16,7 @@ module Marmerdo
       Node.new(
         path: @path,
         name: marmerdo_matter["name"] || File.basename(@path, ".*"),
+        namespace: marmerdo_matter["namespace"],
         relationships: relationships
       )
     end
@@ -35,9 +36,9 @@ module Marmerdo
     end
 
     def relationships
-      @relationships ||= marmerdo_matter.filter { |k| Relationship::TYPES.include?(k.to_sym) }.map do |type, to|
-        Relationship.new(type: type, to: to)
-      end
+      @relationships ||= marmerdo_matter["relationships"]&.map do |relationship|
+        Relationship.new(relationship)
+      end || []
     end
   end
 end

data/lib/marmerdo/node.rb

@@ -6,19 +6,32 @@ module Marmerdo
     attr_reader :path
     # @return [Symbol]
     attr_reader :name
+    # @return [Symbol, nil]
+    attr_reader :namespace
     attr_accessor :relationships
 
-    def initialize(path:, name:, relationships:)
+    def initialize(path:, name:, namespace:, relationships:)
       @path = path
       @name = name.to_sym
+      @namespace = namespace&.to_sym
       @relationships = relationships
     end
 
-    def to_mermaid_line
-      "class #{name}"
+    def to_mermaid_str
+      str = "class #{name}"
+
+      return str if namespace.nil?
+
+      [
+        "namespace #{namespace} {",
+        str,
+        "}"
+      ].join("\n")
     end
 
-    def generate_mermaid_link(output_path)
+    def generate_mermaid_link(output_path, enable_link_extension:)
+      path = enable_link_extension ? @path : Pathname.new(@path).sub_ext("").to_s
+
       output_dir = Pathname.new(output_path).dirname
       relative_path = Pathname.new(path).relative_path_from(output_dir).to_s
       relative_path = "./#{relative_path}" unless relative_path.start_with?("../")

data/lib/marmerdo/relationship.rb

@@ -2,62 +2,15 @@ require_relative "error"
 
 module Marmerdo
   class Relationship
-    class UnknownRelationshipType < Error; end
+    # @return [String]
+    attr_accessor :str
 
-    TYPES = %i[
-      inheritance
-      composition
-      aggregation
-      association
-      link_solid
-      dependency
-      realization
-      link_dashed
-    ].freeze
-
-    # https://mermaid.js.org/syntax/classDiagram.html#defining-relationship
-    # @return [Symbol]
-    attr_reader :type
-
-    # @return [Array<Symbol>]
-    attr_reader :to
-
-    def self.valid_type?(type)
-      TYPES.include?(type.to_sym)
-    end
-
-    def initialize(type:, to:)
-      @type = type.to_sym
-      @to = if to.is_a?(Array)
-              to.map(&:to_sym)
-            else
-              [to.to_sym]
-            end
+    def initialize(str)
+      @str = str
     end
 
     def to_mermaid_str(from)
-      to.map do |t|
-        case type
-        when :inheritance
-          "#{t} <|-- #{from}"
-        when :composition
-          "#{t} *-- #{from}"
-        when :aggregation
-          "#{t} o-- #{from}"
-        when :association
-          "#{from} --> #{t}"
-        when :link_solid
-          "#{from} -- #{t}"
-        when :dependency
-          "#{from} ..> #{t}"
-        when :realization
-          "#{from} ..|> #{t}"
-        when :link_dashed
-          "#{from} .. #{t}"
-        else
-          raise UnknownRelationshipType
-        end
-      end.join("\n")
+      "#{from} #{str}"
     end
   end
 end

data/lib/marmerdo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Marmerdo
-  VERSION = "0.2.2"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marmerdo
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - sijiaoh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-20 00:00:00.000000000 Z
+date: 2024-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: front_matter_parser