mergen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '00139ca81d6776ed67f74a55665915eeb5c342231164b0a35fdb89dca6e0f9f2'
+  data.tar.gz: 97379884ccde6d2d4d7ac38f46e3d99e7e236d59aa3b50b4efe3e543eab828a4
+SHA512:
+  metadata.gz: e0b5b66167b69d7f300c720ff0cf384d2d786ad4d442b77300de75e7213c5c047142f8cf8c7d7ca1883acada8435cfcbb0c29c1e76530c57282d9b3301173d25
+  data.tar.gz: ae1628bd499d6c942d3f0d0018d8b5f2dffa7b431d74dfa97224b9d77576447baedc55aaa7cd275729075a17b27c5875b06895a9084669a609049a245ff6a05e

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-04-12
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+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.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Yudai Takada
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# Mergen
+
+A tool to create mermaid class diagrams from Ruby code.
+
+## Installation
+
+```bash
+$ gem install mergen
+```
+
+## Usage
+
+### From Command Line
+
+```bash
+$ mergen path/to/ruby/files -o diagram.md
+```
+
+### From Ruby Code
+
+```ruby
+require 'mergen'
+
+generator = Mergen::Generator.new('path/to/ruby/files')
+diagram = generator.generate
+
+# Display the output
+puts diagram
+
+# Or save to a file
+File.write('diagram.md', diagram)
+```
+
+## Output Example
+
+The generated class diagram in Mermaid syntax will look like this:
+
+```
+classDiagram
+  class Person {
+    + name : property
+    + age : property
+    + initialize(name, age)
+    + greet()
+  }
+  
+  class Employee {
+    + department : property
+    + position : property
+    + work()
+  }
+  
+  Person <|-- Employee
+```
+
+## License
+
+Distributed under the [MIT License](LICENSE.txt).

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: %i[spec]

data/exe/mergen

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << File.join(__dir__, '../lib')
+require 'mergen'
+require 'optparse'
+
+options = {}
+parser = OptionParser.new do |opts|
+  opts.banner = 'Usage: mergen [options] PATH'
+
+  opts.on('-o', '--output FILE', 'output file') do |file|
+    options[:output] = file
+  end
+
+  opts.on('-h', '--help', 'show help message') do
+    puts opts
+    exit
+  end
+end
+
+begin
+  parser.parse!
+
+  if ARGV.empty?
+    puts 'error: PATH not specified'
+    puts parser
+    exit(1)
+  end
+
+  path = ARGV[0]
+
+  generator = Mergen::Generator.new(path)
+  diagram = generator.generate
+
+  if options[:output]
+    File.write(options[:output], diagram)
+    puts "class diagram generated in #{options[:output]}"
+  else
+    puts diagram
+  end
+rescue StandardError => e
+  puts "error: #{e.message}"
+  exit(1)
+end

data/lib/mergen/diagram.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Mergen
+  class Diagram
+    attr_reader :name, :type, :parent_class, :included_modules, :methods, :attributes
+
+    def initialize(name, type = :class)
+      @name = name
+      @type = type
+      @parent_class = nil
+      @included_modules = []
+      @methods = []
+      @attributes = []
+    end
+
+    def set_parent_class(parent_class)
+      @parent_class = parent_class
+    end
+
+    def add_included_module(module_name)
+      @included_modules << module_name
+    end
+
+    def add_method(method_name, visibility = :public)
+      @methods << { name: method_name, visibility: visibility }
+    end
+
+    def add_attribute(attr_name, visibility = :public, type = :attr_accessor)
+      @attributes << { name: attr_name, visibility: visibility, type: type }
+    end
+  end
+end

data/lib/mergen/diagram_generator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Mergen
+  class DiagramGenerator
+    def initialize(diagrams)
+      @diagrams = diagrams
+    end
+
+    def generate
+      lines = ['classDiagram']
+
+      @diagrams.each do |info|
+        if info.type == :module
+          lines << "  class #{info.name} {\n    <<module>>\n  }"
+        else
+          lines << "  class #{info.name} {"
+
+          info.attributes.each do |attr|
+            visibility = case attr[:visibility]
+                         when :private then '-'
+                         when :protected then '#'
+                         else '+'
+                         end
+
+            attr_type = case attr[:type]
+                        when :attr_reader then 'getter'
+                        when :attr_writer then 'setter'
+                        else 'property'
+                        end
+
+            lines << "    #{visibility} #{attr[:name]} : #{attr_type}"
+          end
+
+          info.methods.each do |method|
+            visibility = case method[:visibility]
+                         when :private then '-'
+                         when :protected then '#'
+                         else '+'
+                         end
+
+            lines << "    #{visibility} #{method[:name]}()"
+          end
+
+          lines << '  }'
+        end
+
+        lines << "  #{info.parent_class} <|-- #{info.name}" if info.parent_class
+
+        info.included_modules.each do |mod|
+          lines << "  #{mod} <|.. #{info.name} : includes"
+        end
+      end
+
+      lines.join("\n")
+    end
+  end
+end

data/lib/mergen/parser.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Mergen
+  class Parser
+    def parse(content)
+      res = []
+      current_class = nil
+      current_visibility = :public
+
+      content.each_line do |line|
+        line = line.strip
+        if line =~ /^class\s+([A-Z][A-Za-z0-9_]*)\s*(<\s*([A-Z][A-Za-z0-9_:]*))?\s*$/
+          class_name = ::Regexp.last_match(1)
+          parent_class = ::Regexp.last_match(3)
+          current_class = Diagram.new(class_name)
+          current_class.set_parent_class(parent_class) if parent_class
+          res << current_class
+          current_visibility = :public
+        elsif line =~ /^module\s+([A-Z][A-Za-z0-9_]*)\s*$/
+          module_name = ::Regexp.last_match(1)
+          current_class = Diagram.new(module_name, :module)
+          res << current_class
+          current_visibility = :public
+        elsif current_class && line =~ /^\s*include\s+([A-Z][A-Za-z0-9_:]*)\s*$/
+          current_class.add_included_module(::Regexp.last_match(1))
+        elsif current_class && line =~ /^\s*def\s+([a-z_][a-zA-Z0-9_]*[?!=]?)/
+          current_class.add_method(::Regexp.last_match(1), current_visibility)
+        elsif current_class && line =~ /^\s*(attr_accessor|attr_reader|attr_writer)\s+(:[a-z_][a-zA-Z0-9_]*(?:\s*,\s*:[a-z_][a-zA-Z0-9_]*)*)/
+          attr_type = ::Regexp.last_match(1).to_sym
+          attr_list = ::Regexp.last_match(2)
+          attr_list.scan(/:[a-z_][a-zA-Z0-9_]*/).each do |attr|
+            attr_name = attr.sub(/^:/, '')
+            current_class.add_attribute(attr_name, current_visibility, attr_type)
+          end
+        elsif current_class && line =~ /^\s*(private|protected|public)\s*$/
+          current_visibility = ::Regexp.last_match(1).to_sym
+        end
+      end
+      res
+    end
+  end
+end

data/lib/mergen/version.rb

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

data/lib/mergen.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'mergen/version'
+require 'mergen/parser'
+require 'mergen/diagram'
+require 'mergen/diagram_generator'
+
+module Mergen
+  class Generator
+    def initialize(path)
+      @path = path
+      @parser = Parser.new
+    end
+
+    def generate
+      diagrams = []
+      targets(@path).each do |file|
+        file_content = File.read(file)
+        diagrams.concat(@parser.parse(file_content))
+      end
+
+      DiagramGenerator.new(diagrams).generate
+    end
+
+    private
+
+    def targets(path)
+      if File.directory?(path)
+        Dir.glob(File.join(path, '**', '*.rb'))
+      elsif File.file?(path) && path.end_with?('.rb')
+        [path]
+      else
+        []
+      end
+    end
+  end
+end

data/sig/mergen.rbs

@@ -0,0 +1,4 @@
+module Mergen
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: mergen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yudai Takada
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A tool to create mermaid class diagrams from Ruby code.
+email:
+- t.yudai92@gmail.com
+executables:
+- mergen
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/mergen
+- lib/mergen.rb
+- lib/mergen/diagram.rb
+- lib/mergen/diagram_generator.rb
+- lib/mergen/parser.rb
+- lib/mergen/version.rb
+- sig/mergen.rbs
+homepage: https://github.com/ydah/mergen
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ydah/mergen
+  source_code_uri: https://github.com/ydah/mergen
+  changelog_uri: https://github.com/ydah/mergen/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+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.7.0.dev
+specification_version: 4
+summary: A tool to create mermaid class diagrams from Ruby code.
+test_files: []