codetree 0.0.1 → 0.0.2

data/bin/codetree

@@ -26,4 +26,4 @@ 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
+codetree.print_tree :detail => $detail, :flat => $flat, :quiet => $quiet

data/codetree.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   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.description   = %q{Scan code to map methods or classes or 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"
@@ -19,14 +19,14 @@ Gem::Specification.new do |spec|
   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')
+  spec.add_runtime_dependency 'ruby_parser', '~> 0'
+  spec.add_development_dependency 'rake', '~> 10.1', '>= 10.1.0'
+  spec.add_development_dependency 'rspec', '~> 2.14', '>= 2.14.1'
+  spec.add_development_dependency 'yard', '~> 0.8', '>= 0.8.7.2'
+  spec.add_development_dependency 'rdoc', '~> 4.0', '>= 4.0.1'
+  spec.add_development_dependency 'roodi', '~> 3.1', '>= 3.1.1'
+  spec.add_development_dependency 'code_statistics', '~> 0.2', '>= 0.2.13'
+  spec.add_development_dependency 'yard-rspec', '~> 0.1'
+
 
 end

data/lib/codetree.rb

@@ -14,18 +14,24 @@ module Codetree
     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
+    def initialize(_options = { :type =>  :defn, :ancestors => [], :scope => :none, :name =>  "", :line => 0 })
+      @type = _options[:type] || :defn
+      @ancestors = _options[:ancestors] || []
+      @scope = _options[:scope] || :none
+      @name = _options[:name] || ""
+      @line = _options[:line] || 0
     end
 
+    # @!group Virtual Scopeors
+
     def ancestor
       return @ancestors.last
     end
+
+    # @!endgroup
     
+
+
     def render
       return name.to_s if self.ancestors == []
       case type
@@ -36,6 +42,7 @@ module Codetree
       end
     end
 
+    # @!endgroup
 
   end
 
@@ -66,8 +73,9 @@ module Codetree
     
     
     
-    def format_operator(name, detail: :full)
+    def format_operator(name, _options = {:detail =>  :full})
       res = ""
+      _options[:detail] ||= :full
       scope = { 
         :private => {   :full => "Private ",   :medium => '-', :light => ''},
         :public => {    :full => "Public ",    :medium => "+", :light => ''}, 
@@ -83,14 +91,17 @@ module Codetree
         operator.ancestors.each do |ancestor|
           res += @operators[ancestor].render
         end
-        res = scope[operator.scope][detail] + type[operator.type][detail] + res +  operator.render
+        res = scope[operator.scope][_options[:detail]] + type[operator.type][_options[: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 )
+    def print_tree(_options = { :detail => :medium, :flat =>  false, :quiet => false})
+      _options[:detail] ||= :medium
+      _options[:flat] ||= false
+      _options[:quiet] ||= false
+     print_subtree(@root,0, _options )
     end
     
     
@@ -116,14 +127,14 @@ module Codetree
     
     
     def register_operator(nodetype, name, linenr, ancestors)
-      @operators[name] =  Codetree::Operator::new(type: nodetype, name: name, line: linenr, ancestors: 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}"
+          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
@@ -157,18 +168,21 @@ module Codetree
 
 
 
-    def print_subtree(item, level, detail: :full, flat: false, quiet: false)
+    def print_subtree(item, level, _options = { :detail => :full, :flat => false, :quiet => false})
+       _options[:flat] ||= false
+      _options[:detail] ||= :full
+      _options[:quiet] ||= false
       items = @tree[item]
       unless items == nil
-        indent = (flat)? '': level > 0 ? sprintf("%#{level * 2}s", " ") : "" 
-        node = (quiet)? "":"* "
+        indent = (_options[:flat])? '': level > 0 ? sprintf("%#{level * 2}s", " ") : "" 
+        node = (_options[:quiet])? "":"* "
         items.each do |operator|
-          if detail == :none then
+          if _options[:detail] == :none then
             puts "#{indent}#{node}#{operator.name}"
           else
-            puts "#{indent}#{node}#{format_operator operator.name, detail: detail}" 
+            puts "#{indent}#{node}#{format_operator operator.name, :detail => _options[:detail]}" 
           end
-          print_subtree(operator, level + 1, detail: detail, flat: flat, quiet: quiet)
+          print_subtree(operator, level + 1, _options)
         end
       end
     end

data/lib/codetree/version.rb

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

data/spec/codetree_spec.rb

@@ -0,0 +1,95 @@
+require './lib/codetree.rb'
+
+
+describe Codetree do
+
+  before :all do
+
+  end
+
+  subject { Codetree }
+  specify { subject.should be_an_instance_of Module }
+  context Codetree::Operator do
+    subject { Codetree::Operator }
+    specify { subject.should be_an_instance_of Class }
+    context "#initialize" do
+      it "should be possible to instanciate an Operator" do
+        $operator = subject.new name: :test, type: :defn, ancestors: [:Module, :Class], line: 10, scope: :public
+        $operator.instance_variable_get(:@name).should eq :test
+        $operator.instance_variable_get(:@type).should eq :defn
+        $operator.instance_variable_get(:@ancestors).should == [:Module, :Class]
+        $operator.instance_variable_get(:@line).should == 10
+        $operator.instance_variable_get(:@scope).should eq :public        
+      end
+    end
+    context "Accessors" do 
+      it "should respond to #name" do 
+        $operator.respond_to?(:name).should be_true
+        $operator.name.should eq :test
+      end
+      it "should not respond to #name=" do 
+        $operator.respond_to?(:name=).should be_false
+      end
+      it "should respond to #type" do 
+        $operator.respond_to?(:type).should be_true
+        $operator.type.should eq :defn
+      end
+      it "should not respond to #type=" do 
+        $operator.respond_to?(:type=).should be_false
+      end
+      it "should respond to #ancestors" do 
+        $operator.respond_to?(:ancestors).should be_true
+        $operator.ancestors.should == [:Module, :Class] 
+      end
+      it "should not respond to #ancestors=" do 
+        $operator.respond_to?(:ancestors=).should be_false
+      end
+      it "should respond to #line" do 
+        $operator.respond_to?(:line).should be_true
+        $operator.line.should == 10
+      end
+      it "should not respond to #line=" do 
+        $operator.respond_to?(:line=).should be_false
+      end
+      it "should respond to #scope" do 
+        $operator.respond_to?(:scope).should be_true
+        $operator.scope.should eq :public
+      end
+      it "should respond to #scope==" do 
+        $operator.respond_to?(:scope=).should be_true
+        $operator.scope = :private
+        $operator.scope.should eq :private
+      end
+    end
+    context "#ancestor" do 
+      it "should return the last ancestor of the instance variable @ancestors" do
+        $operator.ancestor.should eq :Class
+      end
+    end
+    
+    context "#render" do
+      it "should return a correct formatted String depending of the type and if ancestors empty" do
+        subject.new(name: :test, type: :defn, ancestors: [], line: 10, scope: :public).render.should eq 'test'
+        subject.new(name: :test, type: :defs, ancestors: [], line: 10, scope: :public).render.should eq 'test'
+        subject.new(name: :Test, type: :class, ancestors: [], line: 10, scope: :public).render.should eq 'Test'
+        subject.new(name: :Test, type: :module, ancestors: [], line: 10, scope: :public).render.should eq 'Test'
+        subject.new(name: :Test, type: :module, ancestors: [:Module, :Class], line: 10, scope: :public).render.should eq '::Test'
+        subject.new(name: :Test, type: :class, ancestors: [:Module, :Class], line: 10, scope: :public).render.should eq '::Test'
+        subject.new(name: :test, type: :defn, ancestors: [:Module, :Class], line: 10, scope: :public).render.should eq '#test'
+        subject.new(name: :test, type: :defs, ancestors: [:Module, :Class], line: 10, scope: :public).render.should eq '.test'
+      end
+    end
+    
+  end
+  context Codetree::ParseTree do
+    subject { Codetree::ParseTree }
+    specify { subject.should be_an_instance_of Class }
+  end
+  after :all do
+
+  end
+end
+
+
+
+

data/spec/init_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+require 'rubygems'
+require 'rspec'
+
+

metadata

@@ -1,148 +1,186 @@
 --- !ruby/object:Gem::Specification
 name: codetree
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
+  prerelease: 
 platform: ruby
 authors:
 - Romain GEORGES
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-18 00:00:00.000000000 Z
+date: 2014-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '10.1'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 10.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+        version: '10.1'
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7.2
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: roodi
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: code_statistics
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.13
 - !ruby/object:Gem::Dependency
   name: yard-rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-description: Scan code to map methods/ classes/ modules and build tree of modules
+        version: '0.1'
+description: Scan code to map methods or classes or modules and build tree of modules
   namespaces
 email:
 - romain@ultragreen.net
 executables:
 - codetree
-- '#codetree#'
 extensions: []
 extra_rdoc_files: []
 files:
@@ -155,30 +193,37 @@ files:
 - codetree.gemspec
 - lib/codetree.rb
 - lib/codetree/version.rb
+- spec/codetree_spec.rb
+- spec/init_spec.rb
+- spec/spec_helper.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
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 1.8.29
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Usefull tools for code audit commands
-test_files: []
+test_files:
+- spec/codetree_spec.rb
+- spec/init_spec.rb
+- spec/spec_helper.rb
+has_rdoc: 

checksums.yaml

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

data/bin/#codetree#

@@ -1,23 +0,0 @@
-#!/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