kevinrutherford-reek 1.1.1 → 1.1.2

data/History.txt

@@ -1,3 +1,9 @@
+== 1.2.0 (In progress)
+
+=== Major Enhancements
+* Switched from ParseTree to ruby_parser for source code parsing
+* 'MyClass.should_not reek' now only possible if ParseTree gem installed
+
 == 1.1.1 2009-05-08
 
 === Minor enhancements

data/lib/reek/code_parser.rb

@@ -1,5 +1,4 @@
 require 'rubygems'
-require 'parse_tree'
 require 'sexp_processor'
 require 'reek/block_context'
 require 'reek/class_context'
@@ -22,10 +21,6 @@ module Reek
       return unifier.process(sexp[0])
     end
 
-    def self.parse_tree_for(code)   # :nodoc:
-      unify(ParseTree.new.parse_tree_for_string(code))
-    end
-
     # Creates a new Ruby code checker. Any smells discovered by
     # +check_source+ or +check_object+ will be stored in +report+.
     def initialize(report, smells, ctx = StopContext.new)
@@ -38,21 +33,6 @@ module Reek
       @require_empty = @warn_on_default = false
     end
 
-    # Analyses the given Ruby source +code+ looking for smells.
-    # Any smells found are saved in the +Report+ object that
-    # was passed to this object's constructor.
-    def check_source(code)
-      check_parse_tree(CodeParser.parse_tree_for(code))
-    end
-
-    # Analyses the given Ruby object +obj+ looking for smells.
-    # Any smells found are saved in the +Report+ object that
-    # was passed to this object's constructor.
-    def check_object(obj)
-      sexp = CodeParser.unify(ParseTree.new.parse_tree(obj))
-      check_parse_tree(sexp)
-    end
-
     def process_default(exp)
       exp[0..-1].each { |sub| process(sub) if Array === sub }
       s(exp)
@@ -211,9 +191,5 @@ module Reek
       @element = @element.outer
       s(exp)
     end
-
-    def check_parse_tree(sexp)  # :nodoc:
-      process(sexp)
-    end
   end
 end

data/lib/reek/name.rb

@@ -21,7 +21,7 @@ module Reek
 
     def self.resolve_string(str, context)
       return [context, new(str)] unless str =~ /::/
-      resolve(ParseTree.new.parse_tree_for_string(str)[0], context)
+      resolve(RubyParser.new.parse(str), context)
     end
 
     def initialize(sym)

data/lib/reek/object_source.rb

@@ -0,0 +1,45 @@
+module Reek
+  class Source
+    #
+    # Factory method: creates a +Source+ from obj.
+    # The code is not parsed until +report+ is called.
+    # (This feature is only enabled if you have the ParseTree gem installed.)
+    #
+    def self.from_object(obj)
+      return ObjectSource.new(obj, obj.to_s)
+    end
+  end
+
+  class ObjectSource < Source   # :nodoc:
+    def can_parse_objects?
+      return true if Object.const_defined?(:ParseTree)
+      begin
+        require 'parse_tree'
+        true
+      rescue LoadError
+        false
+      end
+    end
+
+    def check(parser) # :nodoc:
+      if can_parse_objects?
+        sexp = CodeParser.unify(ParseTree.new.parse_tree(@source))
+        parser.process(sexp)
+      else
+        throw ArgumentError.new('You must install the ParseTree gem to use this feature')
+      end
+    end
+  end
+end
+
+class Object
+  #
+  # Constructs a Source representing this object; the source can then be used
+  # to generate an abstract syntax tree for the object, which can in turn then
+  # be examined for code smells.
+  # (This feature is only enabled if you have the ParseTree gem installed.)
+  #
+  def to_source
+    Reek::Source.from_object(self)
+  end
+end

data/lib/reek/source.rb

@@ -1,6 +1,7 @@
 require 'reek/code_parser'
 require 'reek/report'
 require 'reek/smells/smells'
+require 'ruby_parser'
 
 module Reek
 
@@ -12,14 +13,6 @@ module Reek
   #
   class Source
 
-    #
-    # Factory method: creates a +Source+ from obj.
-    # The code is not parsed until +report+ is called.
-    #
-    def self.from_object(obj)
-      return ObjectSource.new(obj, obj.to_s)
-    end
-
     #
     # Factory method: creates a +Source+ object by reading Ruby code from
     # the +IO+ stream. The stream is consumed upto end-of-file, but the
@@ -73,7 +66,8 @@ module Reek
     end
 
     def check(parser) # :nodoc:
-      parser.check_source(@source)
+      sexp = RubyParser.new.parse(@source, @desc)
+      parser.process(sexp)
     end
 
     #
@@ -128,13 +122,6 @@ module Reek
       ReportList.new(@sources)
     end
   end
-
-  #
-  # Represents an in-memory object that will be checked for smells.
-  #
-  class ObjectSource < Source
-    def check(parser) # :nodoc:
-      parser.check_object(@source)
-    end
-  end
 end
+
+require 'reek/object_source'

data/lib/reek/spec.rb

@@ -113,12 +113,6 @@ module Reek
   end
 end
 
-class Object
-  def to_source
-    Reek::Source.from_object(self)
-  end
-end
-
 class File
   def to_source
     Reek::Source.from_f(self)

data/lib/reek.rb

@@ -1,5 +1,5 @@
 $:.unshift File.dirname(__FILE__)
 
 module Reek # :doc:
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end

data/reek.gemspec

@@ -2,18 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reek}
-  s.version = "1.1.1"
+  s.version = "1.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kevin Rutherford"]
-  s.date = %q{2009-05-08}
+  s.date = %q{2009-05-18}
   s.default_executable = %q{reek}
   s.description = %q{Code smell detector for Ruby}
   s.email = ["kevin@rutherford-software.com"]
   s.executables = ["reek"]
   s.extra_rdoc_files = ["History.txt", "README.txt"]
-  s.files = ["History.txt", "README.txt", "Rakefile", "bin/reek", "config/defaults.reek", "lib/reek.rb", "lib/reek/block_context.rb", "lib/reek/class_context.rb", "lib/reek/code_context.rb", "lib/reek/code_parser.rb", "lib/reek/exceptions.reek", "lib/reek/if_context.rb", "lib/reek/method_context.rb", "lib/reek/module_context.rb", "lib/reek/name.rb", "lib/reek/object_refs.rb", "lib/reek/options.rb", "lib/reek/rake_task.rb", "lib/reek/report.rb", "lib/reek/sexp_formatter.rb", "lib/reek/singleton_method_context.rb", "lib/reek/smell_warning.rb", "lib/reek/smells/control_couple.rb", "lib/reek/smells/duplication.rb", "lib/reek/smells/feature_envy.rb", "lib/reek/smells/large_class.rb", "lib/reek/smells/long_method.rb", "lib/reek/smells/long_parameter_list.rb", "lib/reek/smells/long_yield_list.rb", "lib/reek/smells/nested_iterators.rb", "lib/reek/smells/smell_detector.rb", "lib/reek/smells/smells.rb", "lib/reek/smells/uncommunicative_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/source.rb", "lib/reek/spec.rb", "lib/reek/stop_context.rb", "lib/reek/yield_call_context.rb", "reek.gemspec", "spec/reek/block_context_spec.rb", "spec/reek/class_context_spec.rb", "spec/reek/code_context_spec.rb", "spec/reek/code_parser_spec.rb", "spec/reek/config_spec.rb", "spec/reek/if_context_spec.rb", "spec/reek/method_context_spec.rb", "spec/reek/module_context_spec.rb", "spec/reek/name_spec.rb", "spec/reek/object_refs_spec.rb", "spec/reek/options_spec.rb", "spec/reek/report_spec.rb", "spec/reek/sexp_formatter_spec.rb", "spec/reek/singleton_method_context_spec.rb", "spec/reek/smells/control_couple_spec.rb", "spec/reek/smells/duplication_spec.rb", "spec/reek/smells/feature_envy_spec.rb", "spec/reek/smells/large_class_spec.rb", "spec/reek/smells/long_method_spec.rb", "spec/reek/smells/long_parameter_list_spec.rb", "spec/reek/smells/nested_iterators_spec.rb", "spec/reek/smells/smell_spec.rb", "spec/reek/smells/uncommunicative_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/slow/inline_spec.rb", "spec/slow/optparse_spec.rb", "spec/slow/redcloth_spec.rb", "spec/slow/reek_source_spec.rb", "spec/slow/samples/inline.rb", "spec/slow/samples/optparse.rb", "spec/slow/samples/redcloth.rb", "spec/slow/script_spec.rb", "spec/slow/source_list_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/reek.rake", "tasks/rspec.rake"]
-  s.has_rdoc = true
+  s.files = ["History.txt", "README.txt", "Rakefile", "bin/reek", "config/defaults.reek", "lib/reek.rb", "lib/reek/block_context.rb", "lib/reek/class_context.rb", "lib/reek/code_context.rb", "lib/reek/code_parser.rb", "lib/reek/exceptions.reek", "lib/reek/if_context.rb", "lib/reek/method_context.rb", "lib/reek/module_context.rb", "lib/reek/name.rb", "lib/reek/object_refs.rb", "lib/reek/object_source.rb", "lib/reek/options.rb", "lib/reek/rake_task.rb", "lib/reek/report.rb", "lib/reek/sexp_formatter.rb", "lib/reek/singleton_method_context.rb", "lib/reek/smell_warning.rb", "lib/reek/smells/control_couple.rb", "lib/reek/smells/duplication.rb", "lib/reek/smells/feature_envy.rb", "lib/reek/smells/large_class.rb", "lib/reek/smells/long_method.rb", "lib/reek/smells/long_parameter_list.rb", "lib/reek/smells/long_yield_list.rb", "lib/reek/smells/nested_iterators.rb", "lib/reek/smells/smell_detector.rb", "lib/reek/smells/smells.rb", "lib/reek/smells/uncommunicative_name.rb", "lib/reek/smells/utility_function.rb", "lib/reek/source.rb", "lib/reek/spec.rb", "lib/reek/stop_context.rb", "lib/reek/yield_call_context.rb", "reek.gemspec", "spec/reek/block_context_spec.rb", "spec/reek/class_context_spec.rb", "spec/reek/code_context_spec.rb", "spec/reek/code_parser_spec.rb", "spec/reek/config_spec.rb", "spec/reek/if_context_spec.rb", "spec/reek/method_context_spec.rb", "spec/reek/module_context_spec.rb", "spec/reek/name_spec.rb", "spec/reek/object_refs_spec.rb", "spec/reek/options_spec.rb", "spec/reek/report_spec.rb", "spec/reek/singleton_method_context_spec.rb", "spec/reek/smells/control_couple_spec.rb", "spec/reek/smells/duplication_spec.rb", "spec/reek/smells/feature_envy_spec.rb", "spec/reek/smells/large_class_spec.rb", "spec/reek/smells/long_method_spec.rb", "spec/reek/smells/long_parameter_list_spec.rb", "spec/reek/smells/nested_iterators_spec.rb", "spec/reek/smells/smell_spec.rb", "spec/reek/smells/uncommunicative_name_spec.rb", "spec/reek/smells/utility_function_spec.rb", "spec/slow/inline_spec.rb", "spec/slow/optparse_spec.rb", "spec/slow/redcloth_spec.rb", "spec/slow/reek_source_spec.rb", "spec/slow/samples/inline.rb", "spec/slow/samples/optparse.rb", "spec/slow/samples/redcloth.rb", "spec/slow/script_spec.rb", "spec/slow/source_list_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/reek.rake", "tasks/rspec.rake"]
   s.homepage = %q{http://wiki.github.com/kevinrutherford/reek}
   s.post_install_message = %q{
 For more information on reek, see http://wiki.github.com/kevinrutherford/reek
@@ -21,7 +20,7 @@ For more information on reek, see http://wiki.github.com/kevinrutherford/reek
   s.rdoc_options = ["--main", "README.txt"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{reek}
-  s.rubygems_version = %q{1.3.2}
+  s.rubygems_version = %q{1.3.3}
   s.summary = %q{Code smell detector for Ruby}
 
   if s.respond_to? :specification_version then
@@ -29,16 +28,16 @@ For more information on reek, see http://wiki.github.com/kevinrutherford/reek
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<ParseTree>, ["~> 3.0"])
+      s.add_runtime_dependency(%q<ruby_parser>, ["~> 2.0"])
       s.add_runtime_dependency(%q<ruby2ruby>, ["~> 1.2"])
       s.add_runtime_dependency(%q<sexp_processor>, ["~> 3.0"])
     else
-      s.add_dependency(%q<ParseTree>, ["~> 3.0"])
+      s.add_dependency(%q<ruby_parser>, ["~> 2.0"])
       s.add_dependency(%q<ruby2ruby>, ["~> 1.2"])
       s.add_dependency(%q<sexp_processor>, ["~> 3.0"])
     end
   else
-    s.add_dependency(%q<ParseTree>, ["~> 3.0"])
+    s.add_dependency(%q<ruby_parser>, ["~> 2.0"])
     s.add_dependency(%q<ruby2ruby>, ["~> 1.2"])
     s.add_dependency(%q<sexp_processor>, ["~> 3.0"])
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kevinrutherford-reek
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors: 
 - Kevin Rutherford
@@ -9,18 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-08 00:00:00 -07:00
+date: 2009-05-18 00:00:00 -07:00
 default_executable: reek
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: ParseTree
+  name: ruby_parser
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "3.0"
+        version: "2.0"
     version: 
 - !ruby/object:Gem::Dependency 
   name: ruby2ruby
@@ -69,6 +69,7 @@ files:
 - lib/reek/module_context.rb
 - lib/reek/name.rb
 - lib/reek/object_refs.rb
+- lib/reek/object_source.rb
 - lib/reek/options.rb
 - lib/reek/rake_task.rb
 - lib/reek/report.rb
@@ -104,7 +105,6 @@ files:
 - spec/reek/object_refs_spec.rb
 - spec/reek/options_spec.rb
 - spec/reek/report_spec.rb
-- spec/reek/sexp_formatter_spec.rb
 - spec/reek/singleton_method_context_spec.rb
 - spec/reek/smells/control_couple_spec.rb
 - spec/reek/smells/duplication_spec.rb
@@ -129,7 +129,7 @@ files:
 - spec/spec_helper.rb
 - tasks/reek.rake
 - tasks/rspec.rake
-has_rdoc: true
+has_rdoc: false
 homepage: http://wiki.github.com/kevinrutherford/reek
 post_install_message: |
   

data/spec/reek/sexp_formatter_spec.rb

@@ -1,32 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
-
-require 'reek/code_parser'
-require 'reek/sexp_formatter'
-
-include Reek
-
-def should_print(example)
-  it "should format #{example} correctly" do
-    sexp = CodeParser.parse_tree_for(example)
-    SexpFormatter.format(sexp).should == example
-  end
-end
-
-describe SexpFormatter do
-  should_print 'self'
-  should_print 'Alpha'
-  should_print 'Alpha::Beta'
-  should_print '@@fred'
-  should_print '`ls`'
-  should_print 'array[0]'
-  should_print 'array[0, 1, 2]'
-  should_print 'obj.method(arg1, arg2)'
-  should_print 'obj.method'
-  should_print '$1'
-  should_print 'o = q.downcase'
-  should_print 'true'
-  should_print '"-#{q}xxx#{z.size}"'
-  should_print '(0..5)'
-  should_print '(0..temp)'
-  should_print 'result[opt] = false'
-end