objenealogist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca90d0b5901aa3b2d3d517d772c715b926545530421ea695646a80f4c10e432c
+  data.tar.gz: 7f4f3f5a7aa8b5b1f24855e7b8fa68c258dbbc42686ff29ddc5767105d35782d
+SHA512:
+  metadata.gz: e406e9f86b6708851d5d56a2340001ec1d6574a8f36481bf1b388103f14712d24f38886d12529860d3b5f84b7673621b78d945f8a93a10d3cd24285e9673c586
+  data.tar.gz: 9718d6c0482ee0e89799c75afb6d86a6e4b90824cae2ff09033da119e0dae326db491b4d9c5cf2fa6cce0620403453302c430c4a6cc60b6cfd92f5ebdfa0231e

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Koji NAKAMURA
+
+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,39 @@
+# Objenealogist
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/objenealogist`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_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:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/objenealogist.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/objenealogist/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Objenealogist
+  VERSION = "0.1.0"
+end

data/lib/objenealogist.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require "prism"
+
+require_relative "objenealogist/version"
+
+class Objenealogist
+  class ClassVisitor < Prism::Visitor
+    attr_reader :found
+
+    def initialize(target_class_names)
+      @target_class_names = target_class_names.map(&:to_s).map(&:to_sym)
+      @found = []
+      @stack = []
+    end
+
+    def visit_class_node(node)
+      @stack << node.name
+      name = @stack.join("::").to_sym
+      @found << [name, node.location] if @target_class_names.include?(name)
+      super
+      @stack.pop
+    end
+
+    alias visit_module_node visit_class_node
+  end
+
+  class << self
+    def to_tree(clazz, show_methods: true, show_locations: true)
+      # ruby -r./lib/objenealogist -e 'puts Objenealogist.to_tree(Objenealogist)'
+      process_one(clazz, show_methods:, show_locations:).join("\n")
+    end
+
+    def process_one(clazz, result = [], location_map = create_location_map(clazz), indent = "", show_methods: true,
+                    show_locations: true)
+      locations = location_map[clazz.to_s.to_sym]
+
+      result << "#{indent}C #{clazz}#{format_locations(locations, show_locations:, target: clazz.to_s)}" if indent == ""
+      if locations && locations[:methods] && show_methods
+        locations[:methods].sort do |a, b|
+          a[2] == b[2] ? a[0] <=> b[0] : a[2] <=> b[2]
+        end.each_with_index do |method, index|
+          m, path, line = method
+          mark = locations[:methods].size - 1 == index ? "└" : "├"
+          result << "#{indent}│ #{mark} #{m}#{format_locations("#{path}:#{line}", show_locations:, target: clazz.to_s)}"
+        end
+        result << "#{indent}│"
+      end
+
+      (clazz.included_modules - (clazz.superclass&.included_modules || [])).each do |mod|
+        locations = location_map[mod.to_s.to_sym]
+        result << "#{indent}├── M #{mod}#{format_locations(locations, show_locations:, target: mod.to_s)}"
+        if locations && locations[:methods] && show_methods # rubocop:disable Style/Next
+          locations[:methods].sort do |a, b|
+            a[2] == b[2] ? a[0] <=> b[0] : a[2] <=> b[2]
+          end.each_with_index do |method, index|
+            m, path, line = method
+            mark = locations[:methods].size - 1 == index ? "└" : "├"
+            result << "#{indent}|     #{mark} #{m}#{format_locations("#{path}:#{line}", show_locations:,
+                                                                                        target: mod.to_s)}"
+          end
+          result << "#{indent}|"
+        end
+      end
+
+      if clazz.superclass
+        locations = location_map[clazz.superclass.to_s.to_sym]
+        result << "#{indent}└── C #{clazz.superclass}#{format_locations(locations, show_locations:,
+                                                                                   target: clazz.superclass.to_s)}"
+        process_one(clazz.superclass, result, location_map, "    #{indent}", show_methods:, show_locations:)
+      else
+        result
+      end
+    end
+
+    def format_locations(locations, show_locations: true, target: "")
+      return "" unless show_locations
+      return "" if show_locations.is_a?(Regexp) && show_locations !~ target
+
+      if locations.is_a?(String)
+        if locations != ":0" && show_locations
+          " (location: #{locations})"
+        else
+          ""
+        end
+      elsif locations && locations[:locations]&.any? && show_locations
+        " (location: #{locations[:locations].map { |path, loc| "#{path}:#{loc.start_line}" }.join(", ")})"
+      else
+        ""
+      end
+    end
+
+    def create_location_map(clazz)
+      instance = clazz.allocate
+      methods = clazz.methods + instance.methods
+      source_locations = methods.map do |m|
+        if clazz.respond_to?(m) && clazz.method(m).source_location
+          [m] + clazz.method(m).source_location
+        elsif instance.respond_to?(m) && instance.method(m).source_location
+          [m] + instance.method(m).source_location
+        end
+      end.compact
+      location_map = {}
+      source_locations.uniq { |_, path,| path }.each do |method, path, line|
+        next unless File.exist?(path)
+
+        source = File.open(path).read
+        visitor = ClassVisitor.new(clazz.ancestors)
+        Prism.parse(source).value.accept(visitor)
+        visitor.found.each do |name, def_location|
+          (location_map[name] ||= { name: name, locations: [], methods: [] })[:locations] << [path, def_location]
+        end
+      end
+      source_locations.uniq(&:join).each do |m, method_path, line|
+        locations = location_map.values.find do |location|
+          location[:locations].any? do |source_path, loc|
+            method_path == source_path && loc.start_line <= line && line <= loc.end_line
+          end
+        end
+        if locations
+          locations[:methods] << [m, method_path, line]
+        else
+          location_map[clazz.to_s.to_sym]&.[](:methods)&.<< [m, nil, 0]
+        end
+      end
+      # {M1:
+      #   {name: :M1,
+      #    locations: [["objenealogist.rb", (122,0)-(124,3)]],
+      #    methods: [[:m1, "objenealogist.rb", 123]]}}
+      location_map
+    end
+  end
+end
+
+module M1
+  def m1 = :m1
+end
+
+module M2
+  def m2 = :m2
+end
+
+module M3
+  def m3 = :m3
+end
+
+module M4
+  include M3
+  def m4 = :m4
+end
+
+module M5
+  def m5 = :m5
+end
+
+class C1
+  include M5
+  def c1 = :c1
+end
+
+module NS
+  class C2 < C1
+    include M4
+    def c2 = :c2
+  end
+end
+
+class MyClass < NS::C2
+  include M1
+  include M2
+  def c = :c
+  def self.singleton_c = :singleton_c
+end

data/sig/objenealogist.rbs

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

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: objenealogist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Koji NAKAMURA
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: object + genealogist -> objenealogist
+email:
+- kozy4324@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/objenealogist.rb
+- lib/objenealogist/version.rb
+- sig/objenealogist.rbs
+homepage: https://github.com/kozy4324/objenealogist
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kozy4324/objenealogist
+  source_code_uri: https://github.com/kozy4324/objenealogist
+  changelog_uri: https://github.com/kozy4324/objenealogist/releases
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: object + genealogist -> objenealogist
+test_files: []