roodi 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2eb90b5c384b0916cd61ec2cf8f5a8f950458f23
-  data.tar.gz: 76875cad67471324e5017ea7dd82e28c49307ba6
+  metadata.gz: 5fe93f143f769ff54f5113a656f2069c9e608070
+  data.tar.gz: e816fefa85c0c9294d8e2370eb7cd5f9715f8c02
 SHA512:
-  metadata.gz: b68ac64dba9440ef8088cce40aaf71e4a3e2af8b7d9315255191cda7d786ca591862c13a319c5b109cc32c93f05eb17b81a4c3ef42b94962cfb9d31bbc6f92ee
-  data.tar.gz: 57ca381da9ccd33455286ec37a7a0798010ccc744ebba90f23668187470eae1a6d9d28181fcb1204450a59bfdfbae3bf4d5f402fe5b009c14438a6f16f8870c5
+  metadata.gz: 7c7142c98fcb6fffb1c48038118c46da45168d12f95eb9517b4b77e69b38e29c5aadeffdb01fb3679a837704323a312507542e2ec7806e2105f9927b987a5862
+  data.tar.gz: 9e8e8147ccc6d25e5a3866a2eb536122c6bfdec6c8b1a166047937e99618416c327f523c887e93a56390ce30ed7fb672e02f9bb75924a21df13119fd0ebba3dc

data/History.txt

@@ -1,3 +1,8 @@
+= 3.1.0
+* Loosen ruby_parser version dependency (PR from Benjamin Fleischer)
+* Files that can't be parsed are no longer silently skipped
+* Empty rescue body check not failing when block contains empty arrays etc
+
 = 3.0.1
 
 * Added brief class level documentation on all checks

data/lib/roodi/checks/empty_rescue_body_check.rb

@@ -3,30 +3,19 @@ require 'roodi/checks/check'
 module Roodi
   module Checks
     # Checks the body of a rescue block to make sure it's not empty..
-    # 
+    #
     # When the body of a rescue block is empty, exceptions can get caught and swallowed without
     # any feedback to the user.
     class EmptyRescueBodyCheck < Check
-      STATEMENT_NODES = [:fcall, :return, :attrasgn, :vcall, :nil, :call, :lasgn, :true, :false, :next]
-      
+
       def interesting_nodes
         [:resbody]
       end
 
       def evaluate_start(node)
-        add_error("Rescue block should not be empty.") unless has_statement?(node.children[1])
-      end
-  
-      private
-  
-      def has_statement?(node)
-        false unless node
-        has_local_statement?(node) or node.children.any? { |child| has_statement?(child) } if node
+        add_error("Rescue block should not be empty.") if node.children[1].nil?
       end
 
-      def has_local_statement?(node)
-        STATEMENT_NODES.include?(node.node_type)
-      end
     end
   end
 end

data/lib/roodi/checks/line_count_check.rb

@@ -16,14 +16,6 @@ module Roodi
 
       def count_lines(node)
         node.last.respond_to?(:line) ? node.last.line - node.line : 0
-
-        rescue NoMethodError => e
-          #TODO: Add spec for this, nothing breaks when removing it.
-          if ENV['DEBUG'] =~ /true/i
-            STDERR.puts "!! line counting error #{e.message}\t #{node.inspect}"
-            STDERR.puts "!! Does the node have any lines?"
-          end
-          0
       end
 
     end

data/lib/roodi/core/runner.rb

@@ -52,6 +52,7 @@ module Roodi
         @checks ||= []
         all_errors = @checks.collect {|check| check.errors}
         all_errors.flatten
+        all_errors.flatten + parsing_errors
       end
 
       private
@@ -60,11 +61,15 @@ module Roodi
         begin
           Parser.new.parse(content, filename)
         rescue Exception => e
-          puts "#{filename} looks like it's not a valid Ruby file.  Skipping..." if ENV["ROODI_DEBUG"]
+          parsing_errors << "#{filename} looks like it's not a valid Ruby file."
           nil
         end
       end
 
+      def parsing_errors
+        @parsing_errors ||= []
+      end
+
       def load_checks
         check_objects = []
         checks = YAML.load_file @config

data/lib/roodi/version.rb

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

data/roodi.gemspec

@@ -8,16 +8,16 @@ Gem::Specification.new do |gem|
   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"
+  gem.email = "hello@peterevjan.com"
   gem.files = Dir['lib/**/*.rb'] + Dir['bin/*'] + Dir['[A-Za-z]*'] + Dir['spec/**/*']
   gem.version = Roodi::VERSION.dup
   gem.platform = Gem::Platform::RUBY
-  gem.add_runtime_dependency("ruby_parser", "~> 3.2.2")
+  gem.add_runtime_dependency("ruby_parser", [">= 3.2.2", "~> 3.2"])
   gem.executables = ["roodi", "roodi-describe"]
-  gem.files              = `git ls-files`.split($\)
-  gem.test_files         =  gem.files.grep(%r{^(test|spec|features)/})
-  gem.executables        =  gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files = `git ls-files`.split($\)
+  gem.test_files =  gem.files.grep(%r{^(test|spec|features)/})
+  gem.executables =  gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.require_paths = ["lib"]
-  gem.license     = 'MIT'
+  gem.license = 'MIT'
 
 end

data/spec/roodi/checks/class_line_count_check_spec.rb

@@ -4,7 +4,7 @@ describe Roodi::Checks::ClassLineCountCheck do
   before(:each) do
     @roodi = Roodi::Core::Runner.new(Roodi::Checks::ClassLineCountCheck.make({'line_count' => 1}))
   end
-  
+
   it "should accept classes with less lines than the threshold" do
     content = <<-END
     class ZeroLineClass
@@ -16,7 +16,7 @@ describe Roodi::Checks::ClassLineCountCheck do
 
   it "should accept classes with the same number of lines as the threshold" do
     content = <<-END
-    Class OneLineClass
+    class OneLineClass
       @foo = 1
     end
     END

data/spec/roodi/checks/empty_rescue_body_check_spec.rb

@@ -4,7 +4,7 @@ describe Roodi::Checks::EmptyRescueBodyCheck do
   before(:each) do
     @roodi = Roodi::Core::Runner.new(Roodi::Checks::EmptyRescueBodyCheck.make)
   end
-  
+
   it "should accept a rescue body with content and no parameter" do
     content = <<-END
     begin
@@ -151,4 +151,62 @@ describe Roodi::Checks::EmptyRescueBodyCheck do
     errors.should be_empty
   end
 
+  it "should accept a rescue block that has only an empty array" do
+    content = <<-END
+    begin
+      @path.dirname.children
+    rescue Errno::ENOENT
+      []
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should be_empty
+  end
+
+  it "should accept a rescue block that has only the argument passed to the method" do
+    content = <<-END
+    def method_name(text)
+      begin
+        processed_text = text.some.processing.on.it
+      rescue
+        text
+      end
+    end
+    END
+
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should be_empty
+  end
+
+  it "should accept a rescue block without a starting begin block" do
+    content = <<-RUBY
+    def process_text(text)
+      processed_text = text.some.processing.on.it
+    rescue
+      text
+    end
+    RUBY
+
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should be_empty
+  end
+
+  it "should reject a rescue block that only contains a comment" do
+    content = <<-END
+    begin
+      @path.dirname.children
+    rescue Errno::ENOENT
+      # Comment
+    end
+    END
+
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should match(/dummy-file.rb:[5] - Rescue block should not be empty./)
+  end
+
 end

data/spec/roodi/checks/method_name_check_spec.rb

@@ -4,7 +4,7 @@ describe Roodi::Checks::MethodNameCheck do
   before(:each) do
     @roodi = Roodi::Core::Runner.new(Roodi::Checks::MethodNameCheck.make)
   end
-  
+
   it "should accept method names with underscores" do
     content = <<-END
     def good_method_name
@@ -40,7 +40,7 @@ describe Roodi::Checks::MethodNameCheck do
     @roodi.check_content(content)
     @roodi.errors.should be_empty
   end
-  
+
   it "should accept method names ending an equals sign" do
     content = <<-END
     def good_method_name=
@@ -51,7 +51,7 @@ describe Roodi::Checks::MethodNameCheck do
   end
 
   describe "when processing non-text based method names" do
-    ['<<', '>>', '==', '=', '<', '<=', '>', '>=', '[]', '[]='].each do |each|
+    ['<<', '>>', '==', '<', '<=', '>', '>=', '[]', '[]='].each do |each|
       it "should accept #{each} as a method name" do
         content = <<-END
         def #{each}

data/spec/roodi/core/runner_spec.rb

@@ -1,15 +1,14 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Core::Runner do
-  
+  subject { Roodi::Core::Runner.new }
+
   describe "given a custom config file" do
     before do
-      @runner = Roodi::Core::Runner.new
-      @runner.config= File.expand_path(File.dirname(__FILE__) + '/../roodi.yml')
+      subject.config= File.expand_path(File.dirname(__FILE__) + '/../roodi.yml')
     end
-    
+
     it "uses check from it" do
-      # @runner.check_file(File.expand_path(File.dirname(__FILE__) + '/../fixtures/test_class.rb'))
       content = <<-RUBY
         class TestClass
 
@@ -18,8 +17,21 @@ describe Roodi::Core::Runner do
           end
         end
       RUBY
-      @runner.check_content(content)
-      @runner.errors.should be_empty
+      subject.check_content(content)
+      subject.errors.should be_empty
+    end
+  end
+
+  describe "running against a file" do
+    it "adds an error if file is not valid ruby" do
+      content = <<-END
+        <html>
+        </html>
+      END
+      subject.check_content(content)
+      expect(subject.errors).to_not be_empty
+      expect(subject.errors[0]).to eq "dummy-file.rb looks like it's not a valid Ruby file."
     end
   end
-end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roodi
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Marty Andrews
@@ -9,25 +9,31 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-16 00:00:00.000000000 Z
+date: 2013-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.2
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.2
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
 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
+email: hello@peterevjan.com
 executables:
 - roodi
 - roodi-describe