depdump 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf799ff81ff8e6325d2eb5951cc6c7846e7f78129474316f25d1c63d912d174f
+  data.tar.gz: a93f915ca7717d494338bda447aebcc34deca93cb1da87c538123956a08448bf
+SHA512:
+  metadata.gz: 7719ee27728869f30fe5fe2ef19d9f5e42ce47a797ecc12d3531706446b083014a0cb1294c72f467cce2695a87d75475802f5e85a8014a819b36e9f5d46b3369
+  data.tar.gz: 8e8a0cc79281fff35b92771046662980d5f131d83229cf6dc38c226228231f0abc0188748f276bea24ab8573639e5065bda9c0e8105a6decd066eccb41993c15

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at upinetree@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'pry-byebug'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 upinetree
+
+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,70 @@
+# Depdump
+
+:construction: Still a work in progress, interfaces may be changed.
+
+A dump tool of ruby class/module dependencies.
+
+- It aims to dump all static dependencies
+- Dynamic referencing by metaprogramming is not supported
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'depdump'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install depdump
+
+## Usage
+
+Quick start:
+
+    $ cd my/cool/ruby/project
+    $ depdump
+
+Or, specify files and directories.
+
+    $ depdump lib/greate_module.rb app
+
+Then, the dependency graph appeared as a JSON string in stdout.
+
+    {
+      "nodes": [
+        ["A"],
+        ["A", "B"]
+      ],
+      "edges": [
+        {
+          "from": ["A"],
+          "to": ["A", "B"]
+        }
+      ]
+    }
+
+And some execution warnings are written in `depdump-error.log`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 tags, 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/upinetree/depdump. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Depdump project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/depdump/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "depdump"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/depdump.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "depdump/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "depdump"
+  spec.version = Depdump::VERSION
+  spec.authors = ["upinetree"]
+  spec.email = ["upinetree@gmail.com"]
+
+  spec.summary = %q{A dump tool of ruby class/module dependencies.}
+  spec.description = %q{A dump tool of ruby class/module dependencies.}
+  spec.homepage = "https://github.com/upinetree/depdump"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/upinetree/depdump"
+  spec.metadata["changelog_uri"] = "https://github.com/upinetree/depdump/commits/master"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "parser", "~> 2.6"
+
+  spec.add_development_dependency "bundler", "~> 2.1.a"
+  spec.add_development_dependency "rake"
+end

data/exe/depdump

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# Avoid mixing error output into redirect value
+$stderr.reopen("depdump-error.log", "w")
+
+require "depdump"
+require "optparse"
+
+options = ARGV.getopts("o:", "f:")
+
+Depdump.configure do |c|
+  c.output = File.open(options["o"], "w") if options["o"]
+  c.formatter = options["f"] if options["f"]
+end
+
+files = ARGV.empty? ? ["."] : ARGV
+Depdump::Cli.run(files)

data/lib/depdump.rb

@@ -0,0 +1,20 @@
+require_relative "depdump/configurable"
+require_relative "depdump/dependency_graph"
+require_relative "depdump/parser"
+require_relative "depdump/registry"
+require_relative "depdump/tracer"
+require_relative "depdump/version"
+
+require "parser/current"
+
+module Depdump
+  include Configurable
+
+  class Cli
+    def self.run(files)
+      parser = Depdump::Parser.new.tap { |p| p.parse(files) }
+      graph = parser.dependency_graph
+      Depdump.config.output.write(graph.format)
+    end
+  end
+end

data/lib/depdump/configurable.rb

@@ -0,0 +1,44 @@
+module Depdump
+  module Configurable
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.config
+    end
+
+    def config
+      self.class.config
+    end
+
+    module ClassMethods
+      def configure
+        yield config
+      end
+
+      def config
+        @config ||= Configuration.new
+      end
+    end
+
+    class Configuration
+      attr_accessor :output
+      attr_reader :formatter
+
+      def initialize
+        @output = $stdout
+        @format = Depdump::DependencyGraph::Formatter::Json.new
+      end
+
+      def formatter=(type)
+        @formatter =
+          case type
+          when "json"
+            Depdump::DependencyGraph::Formatter::Json.new
+          when "table"
+            Depdump::DependencyGraph::Formatter::Table.new
+          else
+            raise "Unknow format: #{type}"
+          end
+      end
+    end
+  end
+end

data/lib/depdump/dependency_graph.rb

@@ -0,0 +1,58 @@
+require "json"
+
+module Depdump
+  class DependencyGraph
+    attr_reader :nodes, :edges
+
+    def initialize(tree)
+      @nodes = Set.new
+      @edges = Set.new
+      build(tree)
+    end
+
+    def build(tree)
+      tree.each_node do |node|
+        next if node == tree.root
+
+        @nodes << node
+        node.relations.each do |r|
+          referenced_namespaces = r.resolve(tree)
+          if referenced_namespaces
+            @edges << { from: node.namespaces, to: referenced_namespaces }
+          else
+            # TODO: Show file path and line no.
+            warn "[skip] cannot resolve: #{node.namespaces} => #{r.reference}"
+          end
+        end
+      end
+    end
+
+    def format
+      Depdump.config.formatter.call(nodes, edges)
+    end
+
+    module Formatter
+      class Json
+        def call(nodes, edges)
+          JSON.dump({
+            nodes: nodes.map(&:namespaces),
+            edges: edges.to_a,
+          })
+        end
+      end
+
+      class Table
+        def call(_nodes, edges)
+          rows = [
+            "| From | To  |",
+            "| ---  | --- |",
+          ]
+          rows = rows + edges.map do |edge|
+            ["|", edge[:from].join("::"), "|", edge[:to].join("::"), "|"].join(" ")
+          end
+          rows.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/depdump/parser.rb

@@ -0,0 +1,33 @@
+module Depdump
+  class Parser
+    attr_reader :tracer
+
+    def initialize
+      @tracer = Tracer.new
+    end
+
+    def parse(files)
+      expand_directory(files).each do |file|
+        source = File.read(file)
+        ast = ::Parser::CurrentRuby.parse(source)
+        tracer.trace_node(ast)
+      end
+    end
+
+    def dependency_graph
+      DependencyGraph.new(tracer.registry_tree)
+    end
+
+    private
+
+    def expand_directory(paths)
+      paths.flat_map do |path|
+        if File.directory?(path)
+          Dir.glob(File.join(path, "**", "*.rb"))
+        else
+          path
+        end
+      end
+    end
+  end
+end

data/lib/depdump/registry.rb

@@ -0,0 +1,3 @@
+require_relative "registry/tree"
+require_relative "registry/tree/node"
+require_relative "registry/tree/relation"

data/lib/depdump/registry/tree.rb

@@ -0,0 +1,40 @@
+module Depdump
+  class Registry
+    class Tree
+      def root
+        @root ||= Node.new(
+          namespaces: [],
+          parent: nil,
+        )
+      end
+
+      def find_or_create_node(namespaces, parent)
+        # TODO: could be cached rather than search everytime
+        registered = root.detect { |node| namespaces == node.namespaces }
+        return registered if registered
+
+        Node.new(namespaces: namespaces, parent: parent).tap { |n|
+          parent.children << n
+        }
+      end
+
+      def each_node
+        return unless block_given?
+        root.each { |node| yield node }
+      end
+
+      def resolve(partial_namespaces, entry_node)
+        current_node = entry_node
+        prev_node = nil
+        resolved_node = nil
+
+        while current_node && resolved_node.nil?
+          resolved_node = current_node.dig(partial_namespaces)
+          prev_node, current_node = current_node, current_node&.parent
+        end
+
+        resolved_node
+      end
+    end
+  end
+end

data/lib/depdump/registry/tree/node.rb

@@ -0,0 +1,62 @@
+module Depdump
+  class Registry
+    class Tree
+      class Node
+        include Enumerable
+
+        attr_reader :namespaces, :children, :parent, :relations
+
+        def initialize(namespaces: [], parent:)
+          @namespaces = namespaces
+          @relations = []
+          @children = []
+          @parent = parent
+        end
+
+        def create_relation(reference, search_entry_node: nil)
+          Relation.new(node: self, reference: reference, search_entry_node: search_entry_node).tap { |r|
+            @relations << r
+          }
+        end
+
+        def root?
+          parent.nil?
+        end
+
+        def hash
+          namespaces.hash
+        end
+
+        def eql?(other)
+          namespaces == other.namespaces
+        end
+
+        def each(&block)
+          return unless block_given?
+
+          children.each do |child|
+            yield child
+            child.each(&block)
+          end
+        end
+
+        def dig(partial_namespaces)
+          found = nil
+
+          children.each do |node|
+            exactly_match = node.namespaces.last(partial_namespaces.size) == partial_namespaces
+            found = node and break if exactly_match
+
+            route_match = node.namespaces.last == partial_namespaces.first
+            if route_match
+              found = node.dig(partial_namespaces[1..-1])
+              break if found
+            end
+          end
+
+          found
+        end
+      end
+    end
+  end
+end

data/lib/depdump/registry/tree/relation.rb

@@ -0,0 +1,20 @@
+module Depdump
+  class Registry
+    class Tree
+      class Relation
+        attr_reader :node, :reference
+
+        def initialize(node:, reference:, search_entry_node: nil)
+          @node = node
+          @reference = reference
+          @search_entry_node = search_entry_node || node
+        end
+
+        def resolve(tree)
+          resolved_node = tree.resolve(reference, @search_entry_node)
+          resolved_node&.namespaces
+        end
+      end
+    end
+  end
+end

data/lib/depdump/tracer.rb

@@ -0,0 +1,73 @@
+module Depdump
+  class Tracer
+    attr_reader :classes, :relations, :registry_tree
+
+    def initialize
+      @registry_tree = Registry::Tree.new
+      @context = @registry_tree.root
+    end
+
+    def trace_node(node, namespaces = [])
+      return unless node.respond_to?(:type)
+
+      case node.type
+      when :class, :module
+        trace_class(node, namespaces)
+      when :const
+        trace_const(node, namespaces)
+      else
+        node.children.map { |n| trace_node(n, namespaces) }
+      end
+    end
+
+    private
+
+    def trace_class(node, namespaces)
+      definition_node = node.children.first
+
+      # definition_node.type should be :const (otherwise syntax error occurs)
+      defined_namespaces = expand_const_namespaces(definition_node, namespaces)
+
+      # Assume as top level definition is the rest of the array after last nil (cbase) appeared
+      # e.g.) [nil, :A, nil, :B] => [:B]
+      if cbase_index = defined_namespaces.rindex(nil)
+        namespaces_size_from_top = defined_namespaces.size - (cbase_index + 1)
+        defined_namespaces = defined_namespaces.last(namespaces_size_from_top)
+      end
+
+      stack_context(defined_namespaces) do
+        node.children[1..-1].each { |n| trace_node(n, defined_namespaces) }
+      end
+    end
+
+    def trace_const(node, namespaces)
+      referenced_namespaces = expand_const_namespaces(node, [])
+
+      if referenced_namespaces.first.nil?
+        # Top level nil is inserted when :cbase appeared
+        @context.create_relation(referenced_namespaces[1..-1], search_entry_node: @registry_tree.root)
+      else
+        @context.create_relation(referenced_namespaces)
+      end
+    end
+
+    def stack_context(namespaces)
+      prev_context = @context
+      @context = @registry_tree.find_or_create_node(namespaces, prev_context)
+
+      yield
+
+      @context = prev_context
+    end
+
+    # returns [nil] if node.type is :cbase
+    def expand_const_namespaces(node, namespaces)
+      valid_definition = node.respond_to?(:type) && [:const, :cbase].include?(node.type)
+      return namespaces unless valid_definition
+
+      maybe_qualifing_node = node.children.first
+      qualified_namespaces = expand_const_namespaces(maybe_qualifing_node, namespaces)
+      qualified_namespaces + [node.children.last]
+    end
+  end
+end

data/lib/depdump/version.rb

@@ -0,0 +1,3 @@
+module Depdump
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: depdump
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- upinetree
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.a
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A dump tool of ruby class/module dependencies.
+email:
+- upinetree@gmail.com
+executables:
+- depdump
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- depdump.gemspec
+- exe/depdump
+- lib/depdump.rb
+- lib/depdump/configurable.rb
+- lib/depdump/dependency_graph.rb
+- lib/depdump/parser.rb
+- lib/depdump/registry.rb
+- lib/depdump/registry/tree.rb
+- lib/depdump/registry/tree/node.rb
+- lib/depdump/registry/tree/relation.rb
+- lib/depdump/tracer.rb
+- lib/depdump/version.rb
+homepage: https://github.com/upinetree/depdump
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/upinetree/depdump
+  source_code_uri: https://github.com/upinetree/depdump
+  changelog_uri: https://github.com/upinetree/depdump/commits/master
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A dump tool of ruby class/module dependencies.
+test_files: []