marmerdo 0.0.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a85efc4c3e7d9abe175ad1ae273f069b58c0408484290794a3e48d710ab9b2c
-  data.tar.gz: 0fe01c14fb23b07262b6263b3199efa10418a866b09a1e5ca7626d0381b644b4
+  metadata.gz: 8428d0053c598bd51bf6c6adad87c8039e8609f10abb36b2a1b1851cbf73550b
+  data.tar.gz: cd7a5dd6f1450b262921c65400047112c830a6f77260505558bdb40598a7a5d5
 SHA512:
-  metadata.gz: 54e4fa9d7fdc2c383b74030f1a268ad9674fa8cd2182078e7878856665857a7c0a332b557d62980a8de9a17e251a96a8d7dae204b8122af9a7f9952830a561ad
-  data.tar.gz: 0ab9af832c42fee5f0847195ce57595a171e257e8fd22505f46125531c64032c43ff3b1e189882ba2d6d7de0d8223e16aa5c2a24078816ddef22ab58523ddf42
+  metadata.gz: bfc719b5f4b91525bb768e0bf055cb81af55a8c79db3ca21c550ff177eeafb26f833bb4ca3c652fb65fa0f98ee5d38da2bb12d2c2f5fc8f7a9c410a239bba4b3
+  data.tar.gz: 5f287f8fbc54dc4e820af010fe8fd6c3026c0cb558587401425353e3b4f9d0eab56d22b37b93fdb0d371221196b4ae1db2dc975ab590313ea3bd2c679e9b3abf

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.6
+  NewCops: enable
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

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

data/CODE_OF_CONDUCT.md

@@ -39,7 +39,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at sijiaoh@outlook.com. 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.
 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 TODO: Write your name
+Copyright (c) 2023 sijiaoh
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -4,15 +4,13 @@
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add marmerdo
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install marmerdo
 
 ## Usage
 

data/lib/marmerdo/cli.rb

@@ -1,10 +1,33 @@
 require "thor"
+require_relative "error"
+require_relative "markdown_parser"
+require_relative "domain_diagram_generator"
+require_relative "output_generator"
 
 module Marmerdo
   class Cli < Thor
-    desc "generate", "Generate domain diagram from markdown docs."
-    def generate
-      puts "Hello World!"
+    class ArgumentError < Error; end
+
+    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|
+        content = File.read(source_path)
+        node = Marmerdo::MarkdownParser.new(source_path, content).parse
+
+        puts "Loaded #{node.name}." if node
+
+        node
+      end.compact
+
+      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,12 +1,14 @@
 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|
@@ -17,6 +19,7 @@ module Marmerdo
       [
         "classDiagram",
         classes,
+        links,
         relationships
       ].flatten.join("\n")
     end

data/lib/marmerdo/error.rb

@@ -0,0 +1,3 @@
+module Marmerdo
+  class Error < StandardError; end
+end

data/lib/marmerdo/markdown_parser.rb

@@ -4,28 +4,38 @@ require_relative "relationship"
 
 module Marmerdo
   class MarkdownParser
-    def initialize(name, content)
-      @name = name
+    def initialize(path, content)
+      @path = path
       @content = content
     end
 
-    # @return [Node]
+    # @return [Node, nil] the parsed node or nil if the file has no marmerdo front matter.
     def parse
+      return nil unless marmerdo_file?
+
       Node.new(
-        name: front_matter["name"] || @name,
-        namespace: front_matter["namespace"],
+        path: @path,
+        name: marmerdo_matter["name"] || File.basename(@path, ".*"),
         relationships: relationships
       )
     end
 
     private
 
+    def marmerdo_file?
+      front_matter.key?("marmerdo")
+    end
+
     def front_matter
-      @front_matter ||= FrontMatterParser::Parser.new(:md).call(@content).front_matter
+      @front_matter ||= FrontMatterParser::Parser.new(:md).call(@content).front_matter || {}
+    end
+
+    def marmerdo_matter
+      @marmerdo_matter ||= front_matter["marmerdo"] || {}
     end
 
     def relationships
-      @relationships ||= front_matter.filter { |k, _| Relationship::TYPES.include?(k.to_sym) }.map do |type, to|
+      @relationships ||= marmerdo_matter.filter { |k| Relationship::TYPES.include?(k.to_sym) }.map do |type, to|
         Relationship.new(type: type, to: to)
       end
     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

@@ -1,3 +1,5 @@
+require_relative "error"
+
 module Marmerdo
   class Relationship
     class UnknownRelationshipType < Error; end

data/lib/marmerdo/version.rb

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

data/lib/marmerdo.rb

@@ -4,6 +4,5 @@ require_relative "marmerdo/version"
 require_relative "marmerdo/cli"
 
 module Marmerdo
-  class Error < StandardError; end
   # Your code goes here...
 end

data/marmerdo.gemspec

@@ -36,4 +36,6 @@ Gem::Specification.new do |spec|
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
+
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marmerdo
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.2.0
 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
@@ -58,8 +58,10 @@ files:
 - lib/marmerdo.rb
 - lib/marmerdo/cli.rb
 - lib/marmerdo/domain_diagram_generator.rb
+- 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
@@ -71,6 +73,7 @@ metadata:
   homepage_uri: https://github.com/sijiaoh/marmerdo
   source_code_uri: https://github.com/sijiaoh/marmerdo
   changelog_uri: https://github.com/sijiaoh/marmerdo/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths: