dependencytree 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c634c0026c52f65f94bb052cb1526f03ad0d923
-  data.tar.gz: bde9b61df5be813ff5a804d4f3361183a433d8d0
+  metadata.gz: 0eaccd9262969019a4816794b1523655b1e640d5
+  data.tar.gz: a8815740f3dee55ec51cf34e6155c16f340240f3
 SHA512:
-  metadata.gz: 87b9307a388b23abf36e7684547284caafd7bf1027e83f928d580fa0e7adbfa8ab4b274e01b816644f8bf4930fb5ad4c05286918947630b317b59a32676677fc
-  data.tar.gz: 03c3aa6f2601cd40dd6f07ce5e45b894ff72bc96bf530d82b4f51dd7443c68503a25444a8f3091272ed84b9e1a31c12d2029ff1beb33c8ca17528e1f167bc48e
+  metadata.gz: 544cd47f79beda8c029892f0c6ff991baa90c1b7e3aa34a5f1643384977aee3c3824024be83438efc8ad7753ba47069e7e7587ee8b9b862451a62b0fde97a0f7
+  data.tar.gz: 0fef2ba73b64d6724cf947cf04ea8d75e491a2ce8a4bee079854ec621df1323e6a50e143289ea867e1264ea7c53e49edb9d6a66fe153581d2b7e62bfe132b0cd

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
-task :default => :spec
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/**/*_test.rb']
+end
+desc "Run tests"
+
+task :default => :test

data/dependencytree.gemspec

@@ -23,7 +23,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "minitest", "~> 5.11"
   spec.add_dependency "parser", "~> 2.5.0.5"
   spec.add_dependency "ast", "~> 2.4.0"
 end

data/lib/dependencytree.rb

@@ -1,82 +1,9 @@
-require "dependencytree/treeinterpreter"
-require "dependencytree/dependencyresolver"
-
 require "dependencytree/version"
-require 'parser/current'
-require 'optparse'
-require 'pp'
-require 'json'
+require "dependencytree/treemain"
 require 'logger'
 
 module Dependencytree
 
-  def self.handle_path(options, consumer, path)
-    if options[:ignore].match(path)
-      return
-    end
-    if File.directory?(path)
-      STDERR.puts path if options[:verbose]
-      Dir.entries(path).each { |x|
-        resolved = File.join(path, x)
-        handle_path(options, consumer, resolved) if File.directory?(resolved) && x != "." && x != ".."
-        handle_path(options, consumer, resolved) if File.file?(resolved) && options[:pattern].match(resolved)
-      }
-    elsif File.file?(path)
-      STDERR.puts path if options[:verbose]
-      LOG.debug("Handling path #{path}")
-      tree = Parser::CurrentRuby.parse_file(path)
-      LOG.debug("Parsed tree: #{tree}") if LOG.debug?
-      consumer.visit(path, tree)
-    end
-  end
-
-  options = {}
-  options[:ignore] = /^$/
-  options[:pattern] = /.*\.rb/
-  OptionParser.new do |opt|
-    opt.on("-v", "--verbose", "Verbose output") do |o|
-      options[:verbose] = true
-    end
-    opt.on("-d", "--debug", "Log debugging output to file 'dependencytree.log'") do |o|
-      options[:debug] = true
-    end
-    opt.on("-p", "--pattern[=OPTIONAL]", "Pattern to accept source codes with (default: #{options[:pattern].to_s})") do |o|
-      options[:pattern] = /#{o}/
-    end
-    opt.on("-i", "--ignore[=OPTIONAL]", "Paths to not load (default: #{options[:ignore].to_s})") do |o|
-      options[:ignore] = /#{o}/
-    end
-    opt.on("-o", "--output[=OPTIONAL]", "Output path for the JSON file") do |o|
-      options[:output] = o
-    end
-    opt.on_tail("-h", "--help", "Show this message") do
-      puts opt
-      exit
-    end
-  end.parse!
-
-  if options[:debug]
-    log = Logger.new('dependencytree.log')
-    log.level = Logger::WARN
-  else
-    log = Logger.new(STDOUT)
-    log.level = Logger::WARN
-  end
-  LOG = log
-
-  treeinterpreter = TreeInterpreter.new
-  ARGV.each do |path|
-    handle_path(options, treeinterpreter, File.absolute_path(path))
-  end
-
-  dependencyresolver = DependencyResolver.new(treeinterpreter.classes_and_modules)
-  dependencyresolver.resolve_references
-
-  json = dependencyresolver.classes_and_modules.to_json
-  if options[:output]
-    File.write(options[:output], json)
-  else
-    puts json
-  end
+  TreeMain.main
 end
 

data/lib/dependencytree/classmodel.rb

@@ -16,13 +16,15 @@ module Dependencytree
     attr_reader :resolved_references
     attr_reader :unresolved_references
 
+    @@generator = SecureRandom
+
     # type: :class or :module
     # path: the filesystem path the parsed class was found in
     # module_name: eventual module name or :anonymous
     # class_name: the class name
     def initialize(type, path, name)
       # unique uuid for reference
-      @uuid = SecureRandom.uuid
+      @uuid = @@generator.uuid
       # :module or :class
       @type = type
       # filesystem path of (first) definition
@@ -36,10 +38,17 @@ module Dependencytree
       # list of (unresolved) references as arrays
       @references = []
 
+      # no parent by default (will be set later)
+      @parent = nil
+
       @resolved_references = []
       @unresolved_references = []
     end
 
+    def self.generator=(generator)
+      @@generator = generator
+    end
+
     # Gets the full name of the class/module as an array.
     # @return the full name, for example ["ModuleA","ModuleB","ClassA"]
     def full_name_array

data/lib/dependencytree/dependencyresolver.rb

@@ -12,7 +12,9 @@ module Dependencytree
     # path: the filesystem path the parsed class was found in
     # module_name: eventual module name or :anonymous
     # class_name: the class name
-    def initialize(classes_and_modules)
+    def initialize(log, classes_and_modules)
+      # store logger
+      @@log = log
       @classes_and_modules = classes_and_modules
       @by_full_name = @classes_and_modules.each_with_object({})  { |clazz, hash| hash[clazz.full_name()] = clazz }
     end
@@ -20,7 +22,7 @@ module Dependencytree
     # Goes thru all classes and tries to resolve the references.
     def resolve_references
       @classes_and_modules.each do |clazz|
-        LOG.debug("Processing class #{clazz.full_name} located in #{clazz.path}")
+        @@log.debug("Processing class #{clazz.full_name} located in #{clazz.path}")
         clazz.references.each do |reference_array|
           refered_class = resolve_reference(clazz, reference_array)
           if refered_class
@@ -43,9 +45,9 @@ module Dependencytree
       end
 
       if refered_class_model
-        LOG.debug("Resolved #{reference_array.join('::')} to uuid #{refered_class_model.uuid}")
+        @@log.debug("Resolved #{reference_array.join('::')} to uuid #{refered_class_model.uuid}")
       else
-        LOG.debug("Could not resolve #{reference_array.join('::')}")
+        @@log.debug("Could not resolve #{reference_array.join('::')}")
       end
       refered_class_model
     end
@@ -59,16 +61,16 @@ module Dependencytree
       reference_part = reference_array[0..-2]
       constant_name = reference_array[-1]
 
-      LOG.debug("Resolving reference array #{reference_array.to_s} as reference #{reference_part.to_s} and constant #{constant_name}")
+      @@log.debug("Resolving reference array #{reference_array.to_s} as reference #{reference_part.to_s} and constant #{constant_name}")
 
       refered_class_model = resolve_reference_direct(referer_class_model, reference_part)
       if refered_class_model
-        LOG.debug("Found reference to possible parent #{reference_part.to_s}")
+        @@log.debug("Found reference to possible parent #{reference_part.to_s}")
         if refered_class_model.constant_names.include? constant_name.to_sym
-          LOG.debug("Found class #{refered_class_model.full_name} constant #{constant_name}")
+          @@log.debug("Found class #{refered_class_model.full_name} constant #{constant_name}")
           refered_class_model
         else
-          LOG.debug("Found class #{refered_class_model.full_name}, but not constant #{constant_name}. Known constants: #{refered_class_model.constant_names}")
+          @@log.debug("Found class #{refered_class_model.full_name}, but not constant #{constant_name}. Known constants: #{refered_class_model.constant_names}")
           nil
         end
       else
@@ -81,15 +83,15 @@ module Dependencytree
     # @param reference_array the reference as in the source, can be absolute or relative to the referer class.
     # @return the refered class model or nil
     def resolve_reference_direct(referer_class_model, reference_array)
-      LOG.debug("Resolving reference array #{reference_array.to_s}")
+      @@log.debug("Resolving reference array #{reference_array.to_s}")
 
       referer_array = referer_class_model.full_name_array
       i = 0
       refered_class_model = nil
       while !refered_class_model do
-        LOG.debug("Referer array #{i} is #{referer_array.to_s}")
+        @@log.debug("Referer array #{i} is #{referer_array.to_s}")
         full_name = (referer_array+reference_array).join("::")
-        LOG.debug("Full name #{i} is #{full_name} #{full_name.class.name}")
+        @@log.debug("Full name #{i} is #{full_name} #{full_name.class.name}")
         refered_class_model = resolve_by_full_name(full_name)
 
         break if referer_array.empty?

data/lib/dependencytree/treeinterpreter.rb

@@ -8,7 +8,10 @@ module Dependencytree
   class TreeInterpreter
     attr_reader :classes_and_modules
 
-    def initialize
+    def initialize(log)
+      # the logging instance
+      @@log = log
+
       # path will be the file system path of the source file
       @path = nil
       # context_stack is the stack of modules/classes loaded (namespacing)
@@ -52,14 +55,14 @@ module Dependencytree
     # Handle a const expression.
     # @param node the const node itself to handle.
     def _const(node)
-      LOG.debug("const")
+      @@log.debug("const")
 
       raise ArgumentError, "type needs to be const (#{node.type})" if node.type != :const
       raise ArgumentError, "Children count needs to be 2 (#{node.children.length})" if node.children.length != 2
 
       reference = flatten_const_tree(node)
 
-      LOG.debug("Reference to #{reference.to_s}")
+      @@log.debug("Reference to #{reference.to_s}")
       top_of_stack.add_reference(reference)
     end
 
@@ -69,7 +72,7 @@ module Dependencytree
       raise ArgumentError, "Children count for module is != 2 (#{node.children.length})" if node.children.length != 2
       raise ArgumentError, "First module child needs to be a const (#{node.children[0].type} #{node.children[0].type})" if node.children[0].type != :const
 
-      LOG.debug("module #{node.children[0].children[1]}")
+      @@log.debug("module #{node.children[0].children[1]}")
 
       current_module_name = node.children[0].children[1]
       _handle_class_module_common(:module, current_module_name, node)
@@ -80,7 +83,7 @@ module Dependencytree
     def _class(node)    
       raise ArgumentError, "Children count for class is != 3 (#{node.children.length})" if node.children.length != 3
       raise ArgumentError, "First class child needs to be a const (#{node.children[0].type} #{node.children[0].type})" if node.children[0].type != :const
-      LOG.debug("class #{node.children[0].children[1]}")
+      @@log.debug("class #{node.children[0].children[1]}")
 
       current_class_name = node.children[0].children[1]
       _handle_class_module_common(:class, current_class_name, node)
@@ -97,7 +100,7 @@ module Dependencytree
         parent = @context_stack[-1]
         full_name = parent.full_name.to_s + "::" + name.to_s
       end
-      LOG.debug("Full name is #{full_name}")
+      @@log.debug("Full name is #{full_name}")
       resolved = _resolve(full_name)
 
       if ! resolved.nil?
@@ -113,7 +116,7 @@ module Dependencytree
       end
 
       if resolved.nil?
-        LOG.debug("Created new ClassModel for #{model.full_name}")
+        @@log.debug("Created new ClassModel for #{model.full_name}")
       end
 
       @context_stack << model
@@ -127,7 +130,7 @@ module Dependencytree
     def _def(node)
       raise ArgumentError, "Children count for def is != 3 (#{node.children.length})" if node.children.length != 3
 
-      LOG.debug("def #{node.children[0]}")
+      @@log.debug("def #{node.children[0]}")
 
       top_of_stack.add_method(node.children[0])
 
@@ -139,7 +142,7 @@ module Dependencytree
     def _casgn(node)
       raise ArgumentError, "Children count for casgn is != 3 (#{node.children.length})" if node.children.length != 3
 
-      LOG.debug("casgn #{node.children[1]}")
+      @@log.debug("casgn #{node.children[1]}")
 
       top_of_stack.add_constant(node.children[1])
 
@@ -179,12 +182,12 @@ module Dependencytree
     # @param tree the AST tree node.
     def visit(path, tree)
       begin
-        LOG.debug("Visiting path #{path}")
+        @@log.debug("Visiting path #{path}")
         @path = path
         visit_node(tree)
         @path = nil
       rescue Exception => e
-        LOG.error("Error in path #{path}")
+        @@log.error("Error in path #{path}")
         puts "Error in path #{path}"
         raise e
       end

data/lib/dependencytree/treemain.rb

@@ -0,0 +1,87 @@
+require "dependencytree/treeinterpreter"
+require "dependencytree/dependencyresolver"
+
+require "dependencytree/version"
+require 'parser/current'
+require 'optparse'
+require 'pp'
+require 'json'
+require 'logger'
+
+module Dependencytree
+
+  # Contains the main method for handling the program flow.
+  class TreeMain
+    def self.handle_path(options, consumer, path)
+      if options[:ignore].match(path)
+        return
+      end
+      if File.directory?(path)
+        STDERR.puts path if options[:verbose]
+        Dir.entries(path).each { |x|
+          resolved = File.join(path, x)
+          handle_path(options, consumer, resolved) if File.directory?(resolved) && x != "." && x != ".."
+          handle_path(options, consumer, resolved) if File.file?(resolved) && options[:pattern].match(resolved)
+        }
+      elsif File.file?(path)
+        STDERR.puts path if options[:verbose]
+        @@log.debug("Handling path #{path}")
+        tree = Parser::CurrentRuby.parse_file(path)
+        @@log.debug("Parsed tree: #{tree}") if @@log.debug?
+        consumer.visit(path, tree)
+      end
+    end
+
+    def self.main
+      options = {}
+      options[:ignore] = /^$/
+      options[:pattern] = /.*\.rb/
+      OptionParser.new do |opt|
+        opt.on("-v", "--verbose", "Verbose output") do |o|
+          options[:verbose] = true
+        end
+        opt.on("-d", "--debug", "Log debugging output to file 'dependencytree.log'") do |o|
+          options[:debug] = true
+        end
+        opt.on("-p", "--pattern[=OPTIONAL]", "Pattern to accept source codes with (default: #{options[:pattern].to_s})") do |o|
+          options[:pattern] = /#{o}/
+        end
+        opt.on("-i", "--ignore[=OPTIONAL]", "Paths to not load (default: #{options[:ignore].to_s})") do |o|
+          options[:ignore] = /#{o}/
+        end
+        opt.on("-o", "--output[=OPTIONAL]", "Output path for the JSON file") do |o|
+          options[:output] = o
+        end
+        opt.on_tail("-h", "--help", "Show this message") do
+          puts opt
+          return
+        end
+      end.parse!
+
+      if options[:debug]
+        log = Logger.new('dependencytree.log')
+        log.level = Logger::WARN
+      else
+        log = Logger.new(STDOUT)
+        log.level = Logger::WARN
+      end
+      @@log = log
+
+      treeinterpreter = TreeInterpreter.new(log)
+      ARGV.each do |path|
+        handle_path(options, treeinterpreter, File.absolute_path(path))
+      end
+
+      dependencyresolver = DependencyResolver.new(log, treeinterpreter.classes_and_modules)
+      dependencyresolver.resolve_references
+
+      json = dependencyresolver.classes_and_modules.to_json
+      if options[:output]
+        File.write(options[:output], json)
+      else
+        puts json
+      end
+    end
+  end
+end
+

data/lib/dependencytree/version.rb

@@ -1,3 +1,3 @@
 module Dependencytree
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dependencytree
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Stephan Fuhrmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-09 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +102,7 @@ files:
 - lib/dependencytree/classmodel.rb
 - lib/dependencytree/dependencyresolver.rb
 - lib/dependencytree/treeinterpreter.rb
+- lib/dependencytree/treemain.rb
 - lib/dependencytree/version.rb
 homepage: http://www.1und1.de
 licenses: