marmerdo 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ce6cbcddd18a42bee1e2598c90df0afbf96e778d02339dfdd78673d38dc8089
-  data.tar.gz: 4d28c78b6f3795cf1d04f66d5d6f0087fb09a8597eab09fffbbffc6988d95c90
+  metadata.gz: 69476fe32f74a4b4a7081f5bf65ce187026b8e3afa257ad7b0c5b3622153bba4
+  data.tar.gz: 7a0c231bdd97fb8a7c68e003d618421b8b5839ddce6cd8672e1f895478f0dd74
 SHA512:
-  metadata.gz: 10f9f7c3c329f97182f170708280b48751114cb2c041b6b9ad0051618e15aa0c6c83b505b7365254536b97ee4d6c097978dfa8a759fa756d377ab62f7b44cca8
-  data.tar.gz: 956553af5976166cec1c91f5dd862d6b5e9b6c379f9b38d9e5b14e50acbd1e02af214a6c74c5ca3e109b4522683d24136be56a2bf184cace2a518479789fb53d
+  metadata.gz: '08cb33a93c568b1e799aed8824a371d5716b521a6e8437727a304f59f1b806a1b6d56a7bef96cee1d6344fe8558b0db6fc86a5dd7fc002ce764ea54e48b5f9e9'
+  data.tar.gz: 24c9314b548c06974be900afbc46d0e7ab2a98c9a01b36dd936fddff2a676c87f64da9e80a0a87d1a98a153973b504a9bf98fb74eb1374f1dfc49da7c4550aae

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [0.2.1] - 2023-12-20
+
+- 複数の関連先をサポート。
+
+## [0.2.0] - 2023-12-20
+
+- 警告コメントを追加。
+- Markdowサポートを追加。
+- classにMarkdownファイルへのリンクを追加。
+
 ## [0.1.0] - 2023-12-18
 
-最低限の機能を備えた初期リリース。
+- 最低限の機能を備えた初期リリース。

data/lib/marmerdo/cli.rb

@@ -2,25 +2,32 @@ require "thor"
 require_relative "error"
 require_relative "markdown_parser"
 require_relative "domain_diagram_generator"
+require_relative "output_generator"
 
 module Marmerdo
   class Cli < Thor
     class ArgumentError < Error; end
 
-    desc "generate SOURCE_GLOB OUTPUT", "Generate a mermaid diagram from markdown files"
-    def generate(source_glob, output)
-      raise ArgumentError, "You must provide a source glob and an output file" if source_glob.nil? || output.nil?
+    desc "generate SOURCE_GLOB OUTPUT_PATH", "Generate a mermaid diagram from markdown files"
+    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?
 
       nodes = Dir[source_glob].map do |source_path|
-        puts "Parsing #{source_path}"
-        name = File.basename(source_path, ".*")
         content = File.read(source_path)
-        Marmerdo::MarkdownParser.new(name, content).parse
+        node = Marmerdo::MarkdownParser.new(source_path, content).parse
+
+        puts "Loaded #{node.name}." if node
+
+        node
       end.compact
 
-      puts "Writing diagram to #{output}"
-      mermaid = Marmerdo::DomainDiagramGenerator.new(nodes).generate
-      File.write(output, mermaid)
+      puts "Writing domain diagram to #{output_path}."
+
+      domain_diagram = Marmerdo::DomainDiagramGenerator.new(output_path: output_path, nodes: nodes).generate
+      output_content = OutputGenerator.new(output_path, domain_diagram).generate
+      File.write(output_path, output_content)
+
+      puts "Done!"
     end
   end
 end

data/lib/marmerdo/domain_diagram_generator.rb

@@ -1,22 +1,25 @@
 module Marmerdo
   class DomainDiagramGenerator
-    def initialize(nodes)
+    def initialize(output_path:, nodes:)
+      @output_path = output_path
       @nodes = nodes
     end
 
     # @return [String] mermaid class diagram
     def generate
       classes = @nodes.map(&:to_mermaid_line)
+      links = @nodes.map { |node| node.generate_mermaid_link(@output_path) }
 
       relationships = @nodes.flat_map do |node|
         node.relationships.map do |relationship|
-          relationship.to_mermaid_line(node.name)
+          relationship.to_mermaid_str(node.name)
         end
       end
 
       [
         "classDiagram",
         classes,
+        links,
         relationships
       ].flatten.join("\n")
     end

data/lib/marmerdo/markdown_parser.rb

@@ -4,8 +4,8 @@ require_relative "relationship"
 
 module Marmerdo
   class MarkdownParser
-    def initialize(name, content)
-      @name = name
+    def initialize(path, content)
+      @path = path
       @content = content
     end
 
@@ -14,8 +14,8 @@ module Marmerdo
       return nil unless marmerdo_file?
 
       Node.new(
-        name: marmerdo_matter["name"] || @name,
-        namespace: marmerdo_matter["namespace"],
+        path: @path,
+        name: marmerdo_matter["name"] || File.basename(@path, ".*"),
         relationships: relationships
       )
     end

data/lib/marmerdo/node.rb

@@ -1,19 +1,27 @@
+require "pathname"
+
 module Marmerdo
   class Node
-    # @return [Symbol, nil]
+    # @return [Symbol]
+    attr_reader :path
+    # @return [Symbol]
     attr_reader :name
-    # @return [Symbol, nil]
-    attr_reader :namespace
     attr_accessor :relationships
 
-    def initialize(name:, namespace:, relationships:)
-      @name = name&.to_sym
-      @namespace = namespace&.to_sym
+    def initialize(path:, name:, relationships:)
+      @path = path
+      @name = name.to_sym
       @relationships = relationships
     end
 
     def to_mermaid_line
       "class #{name}"
     end
+
+    def generate_mermaid_link(output_path)
+      output_dir = Pathname.new(output_path).dirname
+      relative_path = Pathname.new(path).relative_path_from(output_dir).to_s
+      "link #{name} \"#{relative_path}\""
+    end
   end
 end

data/lib/marmerdo/output_generator.rb

@@ -0,0 +1,56 @@
+require_relative "error"
+
+module Marmerdo
+  # This class generates a markdown or mermaid file from a mermaid diagram.
+  class OutputGenerator
+    WARNING_COMMENT = "This file was generated by Marmerdo. Do not edit it manually.".freeze
+
+    class UnknownOutputExtensionError < Error
+      def initialize(output_extension)
+        super("Unknown output extension #{output_extension}.\nSupported filetypes are markdown and mermaid.")
+      end
+    end
+
+    def initialize(output_path, domain_diagram)
+      @output_path = output_path
+      @domain_diagram = domain_diagram
+    end
+
+    # @return [String]
+    def generate
+      case output_filetype
+      when :markdown
+        [
+          "<!-- #{WARNING_COMMENT} -->",
+          "",
+          "```mermaid",
+          @domain_diagram,
+          "```"
+        ].join("\n")
+      when :mermaid
+        [
+          "%% #{WARNING_COMMENT}",
+          "",
+          @domain_diagram
+        ].join("\n")
+      end
+    end
+
+    private
+
+    def output_extension
+      File.extname(@output_path)
+    end
+
+    def output_filetype
+      case output_extension
+      when ".markdown", ".md"
+        :markdown
+      when ".mermaid", ".mmd"
+        :mermaid
+      else
+        raise UnknownOutputExtensionError, output_extension
+      end
+    end
+  end
+end

data/lib/marmerdo/relationship.rb

@@ -19,7 +19,7 @@ module Marmerdo
     # @return [Symbol]
     attr_reader :type
 
-    # @return [Symbol]
+    # @return [Array<Symbol>]
     attr_reader :to
 
     def self.valid_type?(type)
@@ -28,30 +28,36 @@ module Marmerdo
 
     def initialize(type:, to:)
       @type = type.to_sym
-      @to = to.to_sym
+      @to = if to.is_a?(Array)
+              to.map(&:to_sym)
+            else
+              [to.to_sym]
+            end
     end
 
-    def to_mermaid_line(from)
-      case type
-      when :inheritance
-        "#{to} <|-- #{from}"
-      when :composition
-        "#{to} *-- #{from}"
-      when :aggregation
-        "#{to} o-- #{from}"
-      when :association
-        "#{from} --> #{to}"
-      when :link_solid
-        "#{from} -- #{to}"
-      when :dependency
-        "#{from} ..> #{to}"
-      when :realization
-        "#{from} ..|> #{to}"
-      when :link_dashed
-        "#{from} .. #{to}"
-      else
-        raise UnknownRelationshipType
-      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")
     end
   end
 end

data/lib/marmerdo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marmerdo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - sijiaoh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-17 00:00:00.000000000 Z
+date: 2023-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: front_matter_parser
@@ -61,6 +61,7 @@ files:
 - lib/marmerdo/error.rb
 - lib/marmerdo/markdown_parser.rb
 - lib/marmerdo/node.rb
+- lib/marmerdo/output_generator.rb
 - lib/marmerdo/relationship.rb
 - lib/marmerdo/version.rb
 - marmerdo.gemspec