tailor 0.0.3 → 0.1.0

data/History.txt

@@ -1,3 +1,11 @@
+=== 0.1.0 2010-05-21
+
+* Added checks for spacing around { and }
+* Added check for spacing around ternary ':'
+* Colorized error messages to be red
+* Problem message are now grouped by file line (when multiple problems per line)
+* Temporarily removed reporting of # of trailing whitespaces
+
 === 0.0.3 2010-04-26
 
 * Added checks for spacing around commas

data/Manifest.txt

@@ -7,12 +7,20 @@ Rakefile
 bin/tailor
 features/case_checking.feature
 features/development.feature
+features/indentation.feature
 features/spacing.feature
+features/spacing/commas.feature
 features/step_definitions/case_checking_steps.rb
 features/step_definitions/common_steps.rb
+features/step_definitions/indentation_steps.rb
+features/step_definitions/spacing/commas_steps.rb
 features/step_definitions/spacing_steps.rb
 features/support/1_file_with_bad_comma_spacing/bad_comma_spacing.rb
+features/support/1_file_with_bad_curly_brace_spacing/bad_curly_brace_spacing.rb
+features/support/1_file_with_bad_operator_spacing/bad_op_spacing.rb
 features/support/1_file_with_bad_parenthesis/bad_parenthesis.rb
+features/support/1_file_with_bad_square_brackets/bad_square_brackets.rb
+features/support/1_file_with_bad_ternary_colon_spacing/bad_ternary_colon_spacing.rb
 features/support/1_file_with_camel_case_class/camel_case_class.rb
 features/support/1_file_with_camel_case_method/camel_case_method.rb
 features/support/1_file_with_hard_tabs/hard_tab.rb
@@ -20,19 +28,31 @@ features/support/1_file_with_long_lines/long_lines.rb
 features/support/1_file_with_snake_case_class/snake_case_class.rb
 features/support/1_file_with_snake_case_method/snake_case_method.rb
 features/support/1_file_with_trailing_whitespace/trailing_whitespace.rb
-features/support/1_good_simple_file/my_project.rb
+features/support/1_good_simple_file/simple_project.rb
+features/support/1_long_file_with_indentation/my_project.rb
 features/support/common.rb
 features/support/env.rb
 features/support/matchers.rb
 features/support/world.rb
 lib/tailor.rb
 lib/tailor/file_line.rb
-lib/tailor/indentation_checker.rb
+lib/tailor/indentation.rb
+lib/tailor/spacing.rb
+lib/tasks/metrics.rake
+lib/tasks/stats.rake
+logic.txt
 ruby-style-checker.rb
 script/console
 script/destroy
 script/generate
 spec/file_line_spec.rb
+spec/indentation_spec.rb
+spec/spacing/colon_spacing_spec.rb
+spec/spacing/comma_spacing_spec.rb
+spec/spacing/curly_brace_spacing_spec.rb
+spec/spacing/parentheses_spacing_spec.rb
+spec/spacing/square_bracket_spacing_spec.rb
+spec/spacing_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
 spec/tailor_spec.rb

data/PostInstall.txt

@@ -1,2 +1,6 @@
 
+Thanks for checking out Tailor.  To run, simply do:
+  # tailor [directory to check]
+
+
 For more information on tailor, see http://github.com/turboladen/tailor

data/README.rdoc

@@ -4,9 +4,8 @@
 
 == DESCRIPTION:
 
-tailor is an executable that recursively parses Ruby files in a 
-directory and checks them for bad style.  Rules for judging style are based on 
-a number of style guides that are popular in the Ruby community.  More on this
+tailor recursively parses Ruby files in a directory and checks them for bad 
+style.  Rules for judging style are based on a number of style guides that are popular in the Ruby community.  More on this
 here http://wiki.github.com/turboladen/tailor.
 
 == FEATURES/PROBLEMS:
@@ -21,9 +20,11 @@ here http://wiki.github.com/turboladen/tailor.
   * Extra whitespace
     * At the end of lines
     * On empty lines
-    * Before & after commas
-    * Before & after open/closed parentheses
-    * Before & after open/closed square brackets
+    * Around commas
+    * Around open/closed parentheses
+    * Around open/closed square brackets
+    * Around open/closed curly braces
+    * Around colons in ternary statements
   * Line length
     * Should be <= 80 characters
 

data/Rakefile

@@ -4,10 +4,14 @@ require 'hoe'
 require 'fileutils'
 require './lib/tailor'
 
+# Load nsm5200 rakefile extensions
+Dir["#{File.dirname(__FILE__)}/lib/tasks/*.rake"].each { |ext| load ext }
+
 Hoe.plugin :newgem
 Hoe.plugin :yard
 # Hoe.plugin :website
-# Hoe.plugin :cucumberfeatures
+Hoe.plugin :cucumberfeatures
+Hoe.plugins.delete :rubyforge
 
 # Gets the description from the main README file
 def get_descr_from_readme
@@ -76,3 +80,5 @@ Dir['tasks/**/*.rake'].each { |t| load t }
 # TODO - want other tests/tasks run by default? Add them to the list
 # remove_task :default
 # task :default => [:spec, :features]
+
+

data/bin/tailor

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
 
-$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib/')
+$:.unshift(File.dirname(__FILE__) + '/../lib/') unless
+  $:.include?(File.dirname(__FILE__) + '/../lib/') ||
+  $:.include?(File.expand_path(File.dirname(__FILE__) + '/../lib/'))
 
 require 'tailor'
 
@@ -11,8 +13,22 @@ end
 if ARGV[0].nil?
   puts usage
 else
-  path_to_check = ARGV[0]
-  files_and_problems = Tailor.check path_to_check
-  Tailor.print_report files_and_problems
-end
+  begin
+    path_to_check = ARGV[0]
+    
+    # Check to make sure we got a file or directory
+    unless File.file?(path_to_check) or File.directory?(path_to_check)
+      raise "Invalid file or directory: #{path_to_check}"
+    end
+
+    # Check the requested files/dirs for problems
+    files_and_problems = Tailor.check path_to_check
 
+    # Print summary of the problems we found
+    Tailor.print_report files_and_problems
+  rescue Exception => ex
+    puts ex.message
+    puts ex.backtrace
+    puts
+  end
+end

data/features/indentation.feature

@@ -0,0 +1,22 @@
+Feature: Indentation
+
+  Scenario: A single file project with every in/outdent expression, indented properly
+    Given I have a project directory "1_long_file_with_indentation"
+      And I have 1 file in my project
+      And that file is indented properly
+    When I run the checker on the project
+    Then the checker should tell me my indentation is OK
+
+  Scenario: A single file that's indented properly
+    Given I have a project directory "1_good_simple_file"
+      And I have 1 file in my project
+      And the indentation of that file starts at level 0
+      And the line 1 is a "class" statement
+      And the line 2 is a "def" statement
+    When I run the checker on the project
+    Then the level of line 1 should be 0.0
+      And the level of line 2 should be 1.0
+      And the level of line 3 should be 2.0
+      And the level of line 4 should be 1.0
+      And the level of line 5 should be 0.0
+    

data/features/spacing.feature

@@ -6,15 +6,6 @@ Feature: Spacing
     which lines those problems occur on,
     and what type of spacing they're missing
 
-  Scenario: A single class-less file in a project; 1 method, indented properly
-    Given I have a project directory "1_good_simple_file"
-      And I have "1" file in my project
-      And that file does not contain any "class" statements
-      And the file contains only "1" "def" statement
-      And that file is indented properly
-    When I run the checker on the project
-    Then the checker should tell me my indentation is OK
-  
   Scenario: A single class-less file with hard tabs
     Given I have a project directory "1_file_with_hard_tabs"
       And I have "1" file in my project
@@ -26,21 +17,21 @@ Feature: Spacing
 
   Scenario: A single file that has all lines with trailing whitespace
     Given I have a project directory "1_file_with_trailing_whitespace"
-      And I have "1" file in my project
+      And I have 1 file in my project
       And that file contains lines with trailing whitespace
     When I run the checker on the project
     Then the checker should tell me each line has trailing whitespace
 
   Scenario: A single file that has a comment and a code line 90 characters long
     Given I have a project directory "1_file_with_long_lines"
-      And I have "1" file in my project
+      And I have 1 file in my project
       And that file contains lines longer than 80 characters
     When I run the checker on the project
     Then the checker should tell me each line is too long
   
   Scenario: A single file that has a comment, method name, and statement without spaces after the commas
     Given I have a project directory "1_file_with_bad_comma_spacing"
-      And I have "1" file in my project
+      And I have 1 file in my project
       And that file contains a "comment" line without spaces after commas
       And that file contains a "method" line without spaces after commas
       And that file contains a "statement" line without spaces after commas
@@ -49,7 +40,7 @@ Feature: Spacing
   
   Scenario: A single file that has a comment, method name, and statement with > 1 spaces after the commas
     Given I have a project directory "1_file_with_bad_comma_spacing"
-      And I have "1" file in my project
+      And I have 1 file in my project
       And that file contains a "comment" line with > 1 spaces after commas
       And that file contains a "method" line with > 1 spaces after commas
       And that file contains a "statement" line with > 1 spaces after commas
@@ -58,7 +49,7 @@ Feature: Spacing
   
   Scenario: A single file that has a comment, method name, and statement with spaces before the commas
     Given I have a project directory "1_file_with_bad_comma_spacing"
-      And I have "1" file in my project
+      And I have 1 file in my project
       And that file contains a "comment" line with spaces before commas
       And that file contains a "method" line with spaces before commas
       And that file contains a "statement" line with spaces before commas
@@ -67,7 +58,7 @@ Feature: Spacing
 
   Scenario: A single file that has a comment, method, and statement with spaces after open parentheses
     Given I have a project directory "1_file_with_bad_parenthesis"
-      And I have "1" file in my project
+      And I have 1 file in my project
       And that file contains a "comment" line with spaces after an open parenthesis
       And that file contains a "method" line with spaces after an open parenthesis
       And that file contains a "statement" line with spaces after an open parenthesis
@@ -76,7 +67,7 @@ Feature: Spacing
 
   Scenario: A single file that has a comment, method, and statement with spaces after open brackets
     Given I have a project directory "1_file_with_bad_parenthesis"
-      And I have "1" file in my project
+      And I have 1 file in my project
       And that file contains a "comment" line with spaces after an open bracket
       And that file contains a "method" line with spaces after an open bracket
       And that file contains a "statement" line with spaces after an open bracket
@@ -85,7 +76,7 @@ Feature: Spacing
 
   Scenario: A single file that has a comment, method, and statement with spaces before closed parentheses
     Given I have a project directory "1_file_with_bad_parenthesis"
-      And I have "1" file in my project
+      And I have 1 file in my project
       And that file contains a "comment" line with spaces after an open parenthesis
       And that file contains a "method" line with spaces after an open parenthesis
       And that file contains a "statement" line with spaces after an open parenthesis
@@ -94,9 +85,13 @@ Feature: Spacing
 
   Scenario: A single file that has a comment, method, and statement with spaces before closed brackets
     Given I have a project directory "1_file_with_bad_parenthesis"
-      And I have "1" file in my project
+      And I have 1 file in my project
       And that file contains a "comment" line with spaces after an open bracket
       And that file contains a "method" line with spaces after an open bracket
       And that file contains a "statement" line with spaces after an open bracket
     When I run the checker on the project
     Then the checker should tell me each line has closed brackets with spaces before them
+
+  Scenario: A single file that has a comment, method, and statement with each operator
+    Given I have a project directory "1_file_with_bad_operator_spacing"
+      And I have 1 file in my project

data/features/spacing/commas.feature

@@ -0,0 +1,44 @@
+Feature: Detect bad spacing around commas
+  As a Ruby developer
+  I want to detect bad spacing around commas in my code
+  So that it's easy to read and maintain
+
+  Scenario: More than 1 space after a comma
+    Given a file with 1 space after a comma in a:
+      | Type    |
+      | comment |
+      | method  |
+      | Array   |
+      | Hash    |
+  
+  Scenario: 0 spaces after a comma
+    Given a file with 0 spaces after a comma in a:
+      | Type    |
+      | comment |
+      | method  |
+      | Array   |
+      | Hash    |
+
+  Scenario: 1 space after a comma
+    Given a file with 1 space after a comma in a:
+      | Type    |
+      | comment |
+      | method  |
+      | Array   |
+      | Hash    |
+
+  Scenario: More than 0 spaces before a comma
+    Given a file with more than 0 spaces before a comma in a:
+      | Type    |
+      | comment |
+      | method  |
+      | Array   |
+      | Hash    |
+
+  Scenario: 0 spaces before a comma
+    Given a file with 0 spaces before a comma in a:
+      | Type    |
+      | comment |
+      | method  |
+      | Array   |
+      | Hash    |

data/features/step_definitions/indentation_steps.rb

@@ -0,0 +1,139 @@
+require 'tailor/indentation'
+require 'tailor/file_line'
+
+Given /^that file is indented properly$/ do
+  pending
+  current_line = 1
+  
+  file_path = Pathname.new(File.expand_path(@file_list[0]))
+
+  current_level = 0.0
+  problem_count = 0
+  next_proper_level = 0.0
+
+  check_file do |line|
+    line = Tailor::FileLine.new(line, file_path, current_line)
+
+    puts '----'
+    puts "line = #{current_line}"
+    puts "current = #{current_level}"
+    actual_level = line.is_at_level
+    puts "actual = #{actual_level}"
+    should_be_at = line.should_be_at_level(current_level)
+    puts "should = #{should_be_at}"
+
+    problem_count += 1 if line.at_proper_level?(actual_level, should_be_at)
+    next_proper_level = line.next_line_should_be_at_level current_level
+    puts "next proper = #{next_proper_level}"
+    current_level = next_proper_level
+
+    current_line += 1
+  end
+end
+
+Given /^the indentation of that file starts at level (\d*)$/ do |level|
+  current_line = 1
+  result = nil
+  
+  file_path = Pathname.new(File.expand_path(@file_list[0]))
+
+  check_file do |line|
+    line = FileLine.new(line, file_path, current_line)
+    result = line.is_at_level
+    break line
+  end
+
+  result.should == 0
+end
+
+Given /^the line (\d*) is a "([^\"]*)" statement$/ do |line_num, statement_type|
+  current_line = 1
+  result = nil
+
+  check_file do |line|
+    result = line.strip =~ /^#{statement_type}/
+    current_line == line_num.to_i ? (break line) : current_line += 1
+  end
+  result.should_not be_nil 
+end
+
+Then "the checker should tell me my indentation is OK" do
+  pending
+end
+
+=begin
+Then /^the level of line 1 should be 0.0$/ do
+  file_path = Pathname.new(File.expand_path(@file_list[0]))
+  @current_level = nil
+
+  check_file do |line|
+    line = FileLine.new(line, file_path, 1)
+
+    @current_level = line.is_at_level
+    @level_change = @current_level + line.next_line_level_change
+    break line
+  end
+  @current_level.should.eql? 0.0
+end
+=end
+
+
+Then /^the level of line (\d*) should be (\d+\.\d+)$/ do |line_num_to_check, level_to_check|
+  file_path = Pathname.new(File.expand_path(@file_list[0]))
+  current_line_num = 1
+  next_proper_level = 0.0
+  current_proper_level = 0.0
+ 
+  check_file do |line|
+    line = FileLine.new(line, file_path, current_line_num)
+
+    if current_line_num == line_num_to_check
+      line.is_at_level.should == level_to_check.to_f
+    
+      # Determine what the next line's level should be at, based on the current line's
+      # level.
+      next_proper_level = current_proper_level + line.indent_next_line_by
+    end
+
+    current_line_num += 1
+  end
+end
+
+=begin
+Then /^the level of line (\d*) should be (\d+\.\d+)$/ do |line_num_to_check, level_to_check|
+  file_path = Pathname.new(File.expand_path(@file_list[0]))
+  current_line = 1
+  actual_level = nil
+  current_level = 0.0   # new
+  level_change = nil    # new
+
+  check_file do |line|
+    line = FileLine.new(line, file_path, current_line)
+
+    # If the first line of the file, 
+    if current_line == 1    # new
+      level_change = current_level + line.next_line_level_change  #new
+      break line    #new
+    else  # new
+      actual_level = line.is_at_level
+    end  # new
+
+    # Only check the line specified; skip if it's the first line.
+    if (current_line == line_num_to_check) and (line_num_to_check > 1)
+      this_level = current_level + level_change   # new
+      this_level < 0.0 ? (this_level = 0.0) : this_level  # new
+      this_level.should == level_to_check    # new
+      actual_level.should == this_level
+      level_change = line.next_line_level_change
+      break line
+    else
+      current_line += 1
+    end
+  end
+  if current_line == 1
+    current_level.should.eql? level_to_check
+  else
+    current_level += level_change  #new
+  end
+end
+=end