roodi 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07d949870658795c4a909c32faf4e50b37f29813
-  data.tar.gz: 54f229d5e6901aa1246d5e314ab63fa462acb923
+  metadata.gz: 2eb90b5c384b0916cd61ec2cf8f5a8f950458f23
+  data.tar.gz: 76875cad67471324e5017ea7dd82e28c49307ba6
 SHA512:
-  metadata.gz: 94c41207f62016bd29d2eb1ada674d89772e9594cebd80bf96d750137048b0a9e16451dd54280f145e4a88019da2d9ecf6b56235d57ca4dec87ae1c54ac6ef8f
-  data.tar.gz: 6f31b01a3c5376860ad999fa8d0ff1de82847315f0d8257d19cd26b7c56ef024e725999737aebf9b541830b3fe5b5302a8b87412aaa150c5f22562fe6ddd742b
+  metadata.gz: b68ac64dba9440ef8088cce40aaf71e4a3e2af8b7d9315255191cda7d786ca591862c13a319c5b109cc32c93f05eb17b81a4c3ef42b94962cfb9d31bbc6f92ee
+  data.tar.gz: 57ca381da9ccd33455286ec37a7a0798010ccc744ebba90f23668187470eae1a6d9d28181fcb1204450a59bfdfbae3bf4d5f402fe5b009c14438a6f16f8870c5

data/.gitignore

@@ -1,3 +1,4 @@
 doc
 pkg
 Gemfile.lock
+coverage

data/Gemfile

@@ -4,3 +4,4 @@ gemspec
 
 gem "rake"
 gem "rspec", "~> 2.14.1"
+gem 'coveralls', :require => false

data/History.txt

@@ -1,3 +1,15 @@
+= 3.0.1
+
+* Added brief class level documentation on all checks
+* No longer printing out "Line: 1" every time you run roodi-describe
+* Added code coverage badge from Coverall.io
+* Added code coverage through Coveralls.io
+* Pulled duplicated find_name method up to super class
+* Added Code Climate badge
+* Added info about how to contribute
+* Updated copyright info to be current
+* Re-added tasks for releasing new versions of the gem
+
 = 3.0.0
 
 * Removed MissingForeignKeyIndexCheck, since it is specific to Rails/ActiveRecord and thus doesn't belong in Roodi

data/README.md

@@ -1,10 +1,12 @@
 # roodi
 
 [![Build Status](https://travis-ci.org/roodi/roodi.png?branch=master)](https://travis-ci.org/roodi/roodi)
+[![Code Climate](https://codeclimate.com/repos/5204c3fc7e00a47bf7015e4e/badges/44ede0c56a53ff100012/gpa.png)](https://codeclimate.com/repos/5204c3fc7e00a47bf7015e4e/feed)
+[![Coverage Status](https://coveralls.io/repos/roodi/roodi/badge.png?branch=master)](https://coveralls.io/r/roodi/roodi?branch=master)
 
 ## Description
 
-Roodi stands for Ruby Object Oriented Design Inferometer.  It parses your Ruby code and warns you about design issues you have based on the checks that is has configured.
+Roodi stands for Ruby Object Oriented Design Inferometer. It parses your Ruby code and warns you about design issues you have based on the checks that is has configured.
 
 ## Install
 
@@ -86,11 +88,24 @@ To change the set of checks included, or to change the default values of the che
 
 * BlockVariableShadowCheck - Check that a block variable does not have the same name as a method parameter or local variable.  It may be mistakenly referenced within the block.
 
+## Contributing
+
+### Bug reporting
+Please use the GitHub issue tracker.
+
+### Want to submit some code?
+Fantastic! Please follow this procedure:
+- Fork the repository
+- Create a well-named topic branch
+- Add specs for any changes you make
+- Write meaningful commit messages explaining why this change is needed
+- Create a pull request.
+
 ## License
 
 (The MIT License)
 
-Copyright (c) 2008 Marty Andrews
+Copyright (c) 2013 Peter Evjan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -2,6 +2,7 @@ require 'rake'
 require 'rspec/core/rake_task'
 require 'bundler'
 require 'roodi'
+require 'bundler/gem_tasks'
 
 def roodi(ruby_files)
   roodi = Roodi::Core::Runner.new

data/lib/roodi/checks/abc_metric_method_check.rb

@@ -2,17 +2,13 @@ require 'roodi/checks/check'
 
 module Roodi
   module Checks
-    # TODO:  Add summary
-    #
-    # TODO:  Add detail
+    # The ABC metric method check calculates the number of Assignments,
+    # Branches and Conditionals in your code. It is similar to
+    # cyclomatic complexity, so the lower the better.
     class AbcMetricMethodCheck < Check
-      # ASSIGNMENTS = [:attrasgn, :attrset, :dasgn_curr, :iasgn, :lasgn, :masgn]
       ASSIGNMENTS = [:lasgn]
-      # BRANCHES = [:if, :else, :while, :until, :for, :rescue, :case, :when, :and, :or]
       BRANCHES = [:vcall, :call]
-      # CONDITIONS = [:and, :or]
       CONDITIONS = [:==, :"!=", :<=, :>=, :<, :>]
-      #  =  *=  /=  %=  +=  <<=  >>=  &=  |=  ^=
       OPERATORS = [:*, :/, :%, :+, :<<, :>>, :&, :|, :^]
       DEFAULT_SCORE = 10
 

data/lib/roodi/checks/check.rb

@@ -2,12 +2,13 @@ require 'roodi/core/error'
 
 module Roodi
   module Checks
+    # Base class for all the checks
     class Check
 
       NODE_TYPES = [:defn, :module, :resbody, :lvar, :cvar, :class, :if, :while, :until, :for, :rescue, :case, :when, :and, :or]
 
       class << self
-      
+
         def make(options = nil)
           check = new
           if options
@@ -23,7 +24,7 @@ module Roodi
       def initialize
         @errors = []
       end
-  
+
       NODE_TYPES.each do |node|
         start_node_method = "evaluate_start_#{node}"
         end_node_method = "evaluate_end_#{node}"
@@ -37,10 +38,10 @@ module Roodi
 
       def start_file(filename)
       end
-      
+
       def end_file(filename)
       end
-      
+
       def evaluate_start(node)
       end
 
@@ -57,17 +58,17 @@ module Roodi
         evaluate_node(:start, node)
         evaluate_start(node)
       end
-  
+
       def evaluate_node_end(node)
         evaluate_node(:end, node)
         evaluate_end(node)
       end
-  
+
       def add_error(error, filename = @node.file, line = @node.line)
         @errors ||= []
         @errors << Roodi::Core::Error.new("#{filename}", "#{line}", error)
       end
-  
+
       def errors
         @errors
       end

data/lib/roodi/checks/class_name_check.rb

@@ -3,17 +3,17 @@ require 'roodi/checks/name_check'
 module Roodi
   module Checks
     # Checks a class name to make sure it matches the specified pattern.
-    # 
+    #
     # Keeping to a consistent naming convention makes your code easier to read.
     class ClassNameCheck < NameCheck
 
       DEFAULT_PATTERN = /^[A-Z][a-zA-Z0-9]*$/
-      
+
       def initialize
         super()
         self.pattern = DEFAULT_PATTERN
       end
-      
+
       def interesting_nodes
         [:class]
       end
@@ -22,10 +22,6 @@ module Roodi
         'Class'
       end
 
-      def find_name(node)
-        node[1].class == Symbol ? node[1] : node[1].last
-      end
-
     end
   end
 end

data/lib/roodi/checks/control_coupling_check.rb

@@ -2,6 +2,10 @@ require 'roodi/checks/check'
 
 module Roodi
   module Checks
+    # Checks if a method uses an argument to decide on what execution path to take
+    #
+    # It is a kind of duplication, since the caller knows what path should be taken.
+    # Also, it means the method has more than one responsibility.
     class ControlCouplingCheck < Check
       def interesting_nodes
         [:defn, :lvar]
@@ -11,7 +15,7 @@ module Roodi
         @method_name = node[1]
         @arguments = node[2][1..-1]
       end
-        
+
       def evaluate_start_lvar(node)
         add_error "Method \"#{@method_name}\" uses the argument \"#{node[1]}\" for internal control." if @arguments.detect {|each| each == node[1]}
       end

data/lib/roodi/checks/cyclomatic_complexity_check.rb

@@ -2,8 +2,13 @@ require 'roodi/checks/check'
 
 module Roodi
   module Checks
+    # Cyclomatic complexity counts the number of linearly independent paths in
+    # the code. The lower the score, the better.
+    #
+    # Read more in the inventor Thomas J. McCabe's original research
+    # paper: www.literateprogramming.com/mccabe.pdf
     class CyclomaticComplexityCheck < Check
-      
+
       COMPLEXITY_NODE_TYPES = [:if, :while, :until, :for, :rescue, :case, :when, :and, :or]
 
       attr_accessor :complexity
@@ -13,19 +18,19 @@ module Roodi
         @count = 0
         @counting = 0
       end
-      
+
       COMPLEXITY_NODE_TYPES.each do |type|
         define_method "evaluate_start_#{type}" do |node|
           @count = @count + 1 if counting?
         end
       end
-      
+
       protected
-      
+
       def count_complexity(node)
         count_branches(node) + 1
       end
-      
+
       def increase_depth
         @count = 1 unless counting?
         @counting = @counting + 1
@@ -38,9 +43,9 @@ module Roodi
           evaluate_matching_end
         end
       end
-      
+
       private
-      
+
       def counting?
         @counting > 0
       end

data/lib/roodi/checks/line_count_check.rb

@@ -2,6 +2,7 @@ require 'roodi/checks/check'
 
 module Roodi
   module Checks
+    # Checks how many lines there are in a ruby_parser node
     class LineCountCheck < Check
 
       attr_accessor :line_count

data/lib/roodi/checks/module_name_check.rb

@@ -3,12 +3,12 @@ require 'roodi/checks/name_check'
 module Roodi
   module Checks
     # Checks a module name to make sure it matches the specified pattern.
-    # 
+    #
     # Keeping to a consistent nameing convention makes your code easier to read.
     class ModuleNameCheck < NameCheck
 
       DEFAULT_PATTERN = /^[A-Z][a-zA-Z0-9]*$/
-      
+
       def initialize
         super()
         self.pattern = DEFAULT_PATTERN
@@ -22,10 +22,6 @@ module Roodi
         'Module'
       end
 
-      def find_name(node)
-        node[1].class == Symbol ? node[1] : node[1].last
-      end
-
     end
   end
 end

data/lib/roodi/checks/name_check.rb

@@ -2,6 +2,7 @@ require 'roodi/checks/check'
 
 module Roodi
   module Checks
+    # Checking that a node's name matches a pattern
     class NameCheck < Check
 
       attr_accessor :pattern
@@ -11,6 +12,10 @@ module Roodi
         add_error "#{message_prefix} name \"#{name}\" should match pattern #{@pattern.inspect}" unless name.to_s =~ @pattern
       end
 
+      def find_name(node)
+        node[1].class == Symbol ? node[1] : node[1].last
+      end
+
     end
   end
 end

data/lib/roodi/checks/npath_complexity_check.rb

@@ -2,6 +2,11 @@ require 'roodi/checks/check'
 
 module Roodi
   module Checks
+    # Checks NPATH complexity of a node
+    #
+    # NPATH counts acyclic execution paths in a piece of code.
+    # Here is an article by Brian A. Nejmeh that explains it in more detail:
+    # http://www.accessmylibrary.com/article-1G1-6242192/npath-measure-execution-path.html
     class NpathComplexityCheck < Check
       # , :when, :and, :or
       MULTIPLYING_NODE_TYPES = [:if, :while, :until, :for, :case]
@@ -9,18 +14,18 @@ module Roodi
       COMPLEXITY_NODE_TYPES = MULTIPLYING_NODE_TYPES + ADDING_NODE_TYPES
 
       attr_accessor :complexity
-      
+
       def initialize(complexity)
         super()
         @complexity = complexity
         @value_stack = []
         @current_value = 1
       end
-      
+
       def evalute_start_if(node)
         push_value
       end
-      
+
       def evalute_start_while(node)
         push_value
       end
@@ -40,7 +45,7 @@ module Roodi
       def evalute_start_rescue(node)
         push_value
       end
-      
+
       MULTIPLYING_NODE_TYPES.each do |type|
         define_method "evaluate_end_#{type}" do |node|
           leave_multiplying_conditional
@@ -52,9 +57,9 @@ module Roodi
           leave_multiplying_conditional
         end
       end
-      
+
       protected
-      
+
       def push_value
         @value_stack.push @current_value
         @current_value = 1
@@ -64,7 +69,7 @@ module Roodi
         pop = @value_stack.pop
         @current_value = (@current_value + 1) * pop
       end
-      
+
       def leave_adding_conditional
         pop = @value_stack.pop
         puts "#{type}, so adding #{pop}"

data/lib/roodi/checks/npath_complexity_method_check.rb

@@ -2,15 +2,15 @@ require 'roodi/checks/npath_complexity_check'
 
 module Roodi
   module Checks
-    # Checks Npath complexity of a method against a specified limit. 
+    # Checks NPATH complexity of a method against a specified limit.
     class NpathComplexityMethodCheck < NpathComplexityCheck
 
       DEFAULT_COMPLEXITY = 8
-      
+
       def initialize
         super(DEFAULT_COMPLEXITY)
       end
-      
+
       def interesting_nodes
         [:defn] + COMPLEXITY_NODE_TYPES
       end

data/lib/roodi/core/runner.rb

@@ -9,14 +9,14 @@ module Roodi
   module Core
     class Runner
       DEFAULT_CONFIG = File.join(File.dirname(__FILE__), "..", "..", "..", "roodi.yml")
-      
+
       attr_writer :config
-      
+
       def initialize(*checks)
         @config = DEFAULT_CONFIG
         @checks = checks unless checks.empty?
       end
-      
+
       def check(filename, content)
         @checks ||= load_checks
         @checker ||= CheckingVisitor.new(@checks)
@@ -29,34 +29,33 @@ module Roodi
       def check_content(content, filename = "dummy-file.rb")
         check(filename, content)
       end
-  
+
       def check_file(filename)
         return unless File.exists?(filename)
         check(filename, File.read(filename))
       end
-  
+
       def print(filename, content)
         node = parse(filename, content)
-        puts "Line: #{node.line}"
         pp node
       end
 
       def print_content(content)
         print("dummy-file.rb", content)
       end
-  
+
       def print_file(filename)
         print(filename, File.read(filename))
       end
-  
+
       def errors
         @checks ||= []
         all_errors = @checks.collect {|check| check.errors}
         all_errors.flatten
       end
-      
+
       private
-      
+
       def parse(filename, content)
         begin
           Parser.new.parse(content, filename)

data/lib/roodi/version.rb

@@ -1,3 +1,3 @@
 module Roodi
-  VERSION = '3.0.0'
+  VERSION = '3.0.1'
 end

data/roodi.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |gem|
 
   gem.name = "roodi"
   gem.summary = "Roodi stands for Ruby Object Oriented Design Inferometer"
-  gem.description = "Roodi stands for Ruby Object Oriented Design Inferometer"
+  gem.description = "Roodi parses your Ruby code and warns you about design issues you have based on the checks that is has configured"
   gem.homepage = "http://github.com/roodi/roodi"
   gem.authors = ["Marty Andrews", "Peter Evjan"]
   gem.email = "peter.evjan@gmail.com"

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
 require 'roodi'
 require 'rspec'
+require 'coveralls'
+Coveralls.wear!
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roodi
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Marty Andrews
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-14 00:00:00.000000000 Z
+date: 2013-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_parser
@@ -25,7 +25,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.2
-description: Roodi stands for Ruby Object Oriented Design Inferometer
+description: Roodi parses your Ruby code and warns you about design issues you have
+  based on the checks that is has configured
 email: peter.evjan@gmail.com
 executables:
 - roodi