codetree 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d91d00d736664c8259bcf21a68fc5e50393bdfb
+  data.tar.gz: 9ad1aff5a42d9061015a8cf6fa952df6a804e6ef
+SHA512:
+  metadata.gz: 52ac70fe88fbb3e7cf6ba3eb10c02ab0f9d27c018201980dc28c598d6e27e8831108f7e259a5af4292e80e510409686725f4b68f92db2130332cb4cd2ca21d6f
+  data.tar.gz: a6fc3bd8b44e2eb0e591862be65c4398945e73f833f4ba8c5224a3133933bfd6fc85cef7cb50cd5d0a6ff7c72908fcff420feba5144482de0eac7427df6f7f7e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in codetree.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+codetree Copyright (c) 2012-2013 Ultragreen Software, Romain GEORGES
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+ 
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/README.md

@@ -0,0 +1,29 @@
+# Codetree
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'codetree'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install codetree
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,61 @@
+require "bundler/gem_tasks"
+require 'rubygems'
+require 'rspec'
+require 'rake'
+require "rake/clean"
+require "rubygems/package_task"
+require "rdoc/task"
+require 'code_statistics'
+require 'rspec/core/rake_task'
+require 'yard'
+require 'yard/rake/yardoc_task.rb'
+require "rake/tasklib"
+require "roodi"
+require "roodi_task"
+
+
+RoodiTask.new() do | t |
+t.patterns = %w(lib/**/*.rb)
+t.config = "ultragreen_roodi_coding_convention.yml"
+end
+
+
+CLEAN.include('*.tmp','*.old')
+CLOBBER.include('*.tmp', 'build/*','#*#')
+
+
+content = File::readlines(File.join(File.dirname(__FILE__), 'codetree.gemspec')).join
+spec = eval(content)
+
+RSpec::Core::RakeTask.new('spec')
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = [ 'lib/**/*.rb', '-', 'doc/**/*','spec/**/*_spec.rb']
+  t.options += ['--title', "Gem Documentation"]
+  t.options += ['-o', "yardoc"]
+  t.options += ['-r', "doc/manual.rdoc"]
+end
+YARD::Config.load_plugin('yard-rspec')
+
+namespace :yardoc do
+  task :clobber do
+    rm_r "yardoc" rescue nil
+    rm_r ".yardoc" rescue nil
+  end
+end
+task :clobber => "yardoc:clobber"
+
+
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+  pkg.need_zip = true
+end
+
+Rake::RDocTask.new('rdoc') do |d|
+  d.rdoc_files.include('doc/**/*','bin/*')
+  d.main = 'doc/manual.rdoc'
+  d.title = 'Dorsal : Yard'
+  d.options << '--line-numbers' << '--diagram' << '-SHN'
+end
+
+task :default => [:gem]

data/bin/#codetree#

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+require 'codetree'
+require 'optparse'
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: codetree [options]"
+
+  opts.on("-f", "--[no-]flat", "display flat list/tree") do |v|
+    $flat = v || false
+  end
+  opts.on("-d", "--detail", "Specify a detail value [:none,:light,:medium,:full]") do |v|
+    $detail = v || :medium
+  end
+
+end.parse!
+
+
+p $detail
+p $flat
+
+
+codetree = Codetree::ParseTree.new(Dir['lib/*/*/*/*.rb'] + Dir['lib/*/*/*.rb'] + Dir['lib/*/*.rb'] + Dir['lib/*.rb'])
+codetree.print_tree detail: $detail, flat: $flat

data/bin/codetree

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'codetree'
+require 'optparse'
+
+$detail = :medium
+$flat = false
+$quiet = false
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: codetree [options]"
+
+  opts.on("-f", "--[no-]flat", "display flat list/tree") do |v|
+    $flat = v
+  end
+  opts.on("-d", "--detail DETAIL", [:none, :light, :medium , :full],"Specify a detail value ( none, light, medium, full]") do |v|
+    $detail = v.to_sym
+  end
+  opts.on("-q", "--[no-]quiet","Remove node symbols ('*') from output tree/list view") do |v|
+    $quiet = v
+  end
+
+end.parse!
+
+
+
+
+
+codetree = Codetree::ParseTree.new(Dir['lib/*/*/*/*.rb'] + Dir['lib/*/*/*.rb'] + Dir['lib/*/*.rb'] + Dir['lib/*.rb'])
+codetree.print_tree detail: $detail, flat: $flat, quiet: $quiet

data/codetree.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'codetree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "codetree"
+  spec.version       = Codetree::VERSION
+  spec.authors       = ["Romain GEORGES"]
+  spec.email         = ["romain@ultragreen.net"]
+  spec.description   = %q{Scan code to map methods/ classes/ modules and build tree of modules namespaces}
+  spec.summary       = %q{Usefull tools for code audit commands}
+  spec.homepage      = "http://www.ultragreen.net"
+  spec.license       = "BSD"
+  spec.require_paths << 'bin'
+  spec.bindir = 'bin'
+  spec.executables = Dir["bin/*"].map!{|item| item.gsub("bin/","")}
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_dependency "ruby_parser"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('yard')
+  spec.add_development_dependency('rdoc')
+  spec.add_development_dependency('roodi')
+  spec.add_development_dependency('code_statistics')
+  spec.add_development_dependency('yard-rspec')
+
+end

data/lib/codetree.rb

@@ -0,0 +1,200 @@
+#require "codetree/version"
+require 'rubygems'
+require 'ruby_parser'
+require 'pp'
+
+
+module Codetree
+
+
+  class Operator
+    attr_reader :type
+    attr_reader :ancestors
+    attr_accessor :scope
+    attr_reader :line
+    attr_reader :name
+
+    def initialize(type: :defn, ancestors: [], scope: :none, name: "", line: 0 )
+      @type = type
+      @ancestors = ancestors
+      @scope = scope
+      @name = name
+      @line = line
+    end
+
+    def ancestor
+      return @ancestors.last
+    end
+    
+    def render
+      return name.to_s if self.ancestors == []
+      case type
+      when :defn then return "##{name.to_s}"
+      when :defs then return ".#{name.to_s}"
+      when :class then return "::#{name.to_s}"
+      when :module then return "::#{name.to_s}"
+      end
+    end
+
+
+  end
+
+
+  class ParseTree
+    attr_reader :operators    
+    attr_reader :ast
+    attr_reader :lines
+
+    def initialize(files)
+      @lines = Array::new
+      files.each do |file|
+        require "./#{file}"
+        @lines << File::readlines(file)        
+      end
+
+      @lines.flatten!
+      @lines = @lines.collect(&:strip!)
+      @lines.delete_if {|line| line =~ /^\s*#/}
+      @code = @lines.join("\n")
+      @ast = RubyParser.new.process @code, "code"
+      @operators = {} # positions of interest
+      @operators_index = Hash::new
+      @curr_position = []
+      map_operators!
+      generate_tree!
+    end
+    
+    
+    
+    def format_operator(name, detail: :full)
+      res = ""
+      scope = { 
+        :private => {   :full => "Private ",   :medium => '-', :light => ''},
+        :public => {    :full => "Public ",    :medium => "+", :light => ''}, 
+        :protected => { :full => "Protected ", :medium => "#", :light => ''},  
+        :none => {      :full => "",           :medium => " ",  :light => ''} }
+      type = { 
+        :defn => {    :full => "Instance method ", :medium => '(m):', :light => ''},
+        :defs => {    :full => "Class method ",    :medium => "(m) ",  :light => ''}, 
+        :class => {   :full => "Class ",           :medium => "(C) ",  :light => ''},  
+        :module => {  :full => "Module ",          :medium => "(M) ",  :light => ''} }
+      if @operators.include?(name) then
+        operator = @operators[name]
+        operator.ancestors.each do |ancestor|
+          res += @operators[ancestor].render
+        end
+        res = scope[operator.scope][detail] + type[operator.type][detail] + res +  operator.render
+      end
+      return res
+    end
+    
+    
+    def print_tree(detail: :medium, flat: false, quiet: false)
+      print_subtree(@root,0, detail: detail, flat: flat, quiet: quiet )
+    end
+    
+    
+    private
+
+    def map_operators!
+      process_ast_level @ast
+      define_scopes!
+    end    
+
+    def generate_tree!
+      @root = {:name => '', :ancestor => nil}
+      @tree = {}
+      @operators.values.each do |operator|
+        ancestor = operator.ancestor 
+        if ancestor == nil || !@operators.has_key?(ancestor)
+          (@tree[@root] ||= []) << operator
+        else
+          (@tree[@operators[ancestor]] ||= []) << operator
+        end
+      end
+    end
+    
+    
+    def register_operator(nodetype, name, linenr, ancestors)
+      @operators[name] =  Codetree::Operator::new(type: nodetype, name: name, line: linenr, ancestors: ancestors )
+      @operators_index[@curr_position.to_s] = [nodetype, name]
+    end
+
+    def define_scopes!
+      @operators.each do |name,item|
+        unless item.ancestor.nil? then
+          klass = eval "#{format_operator item.ancestor, detail: :light}"
+          if item.type == :defn then
+            item.scope = :private if klass.private_method_defined? name
+            item.scope = :protected if klass.protected_method_defined? name
+            item.scope = :public if klass.public_method_defined? name
+           elsif item.type == :defs and @operators[item.ancestor].type == :class then
+             item.scope = :private if klass.private_method_defined? name
+             item.scope = :protected if klass.protected_method_defined? name
+             item.scope = :public if klass.public_method_defined? name
+          end
+        end
+      end
+
+    end
+
+
+
+    def process_ast_level sub_astree
+      return if sub_astree.empty?
+      case sub_astree[0]
+      when :module, :class, :defn, :private
+        register_operator sub_astree[0], sub_astree[1], sub_astree.line, find_where_nested(@curr_position.clone)
+      when :defs
+        register_operator sub_astree[0], sub_astree[2], sub_astree.line, find_where_nested(@curr_position.clone)
+      end
+      sub_astree.each_with_index do |sae, i|
+        @curr_position.push i
+        process_ast_level(sae) if sae.is_a?(Sexp)
+        ex_i = @curr_position.pop
+      end
+    end
+
+
+
+    def print_subtree(item, level, detail: :full, flat: false, quiet: false)
+      items = @tree[item]
+      unless items == nil
+        indent = (flat)? '': level > 0 ? sprintf("%#{level * 2}s", " ") : "" 
+        node = (quiet)? "":"* "
+        items.each do |operator|
+          if detail == :none then
+            puts "#{indent}#{node}#{operator.name}"
+          else
+            puts "#{indent}#{node}#{format_operator operator.name, detail: detail}" 
+          end
+          print_subtree(operator, level + 1, detail: detail, flat: flat, quiet: quiet)
+        end
+      end
+    end
+    
+      
+    NESTING_NODES = [:module, :class ] unless const_defined? :NESTING_NODES
+    def find_where_nested(position)
+      result = []
+      for ep in 0..position.size-2 do
+        chunk = position[0..ep]
+        el = @operators_index[chunk.to_s]
+        if el
+          eltype, elname = el
+          result << elname if NESTING_NODES.include?(eltype)
+        end
+      end
+      result
+    end
+    
+
+
+
+  end
+
+
+
+
+end
+

data/lib/codetree/version.rb

@@ -0,0 +1,3 @@
+module Codetree
+  VERSION = "0.0.1"
+end

data/ultragreen_roodi_coding_convention.yml

@@ -0,0 +1,25 @@
+AssignmentInConditionalCheck:
+CaseMissingElseCheck:
+ClassLineCountCheck:             
+  line_count: 300
+ClassNameCheck:                  
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+#ClassVariableCheck:
+CyclomaticComplexityBlockCheck:  
+  complexity: 5
+CyclomaticComplexityMethodCheck: 
+  complexity: 10
+EmptyRescueBodyCheck:
+ForLoopCheck:
+MethodLineCountCheck:            
+  line_count: 30 
+MethodNameCheck:                 
+  pattern: !ruby/regexp /^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/ 
+# MissingForeignKeyIndexCheck:
+ModuleLineCountCheck:            
+  line_count: 500
+ModuleNameCheck:          
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ParameterNumberCheck:            
+  parameter_count: 5
+ 

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: codetree
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Romain GEORGES
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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'
+- !ruby/object:Gem::Dependency
+  name: roodi
+  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'
+- !ruby/object:Gem::Dependency
+  name: code_statistics
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard-rspec
+  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: Scan code to map methods/ classes/ modules and build tree of modules
+  namespaces
+email:
+- romain@ultragreen.net
+executables:
+- codetree
+- '#codetree#'
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/codetree
+- codetree.gemspec
+- lib/codetree.rb
+- lib/codetree/version.rb
+- ultragreen_roodi_coding_convention.yml
+- bin/#codetree#
+homepage: http://www.ultragreen.net
+licenses:
+- BSD
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Usefull tools for code audit commands
+test_files: []