tailor 0.0.3 → 0.1.0

data/features/support/env.rb

@@ -1,4 +1,5 @@
-require File.dirname(__FILE__) + "/../../lib/tailor"
+$:.unshift File.dirname(__FILE__) + "/../../lib/tailor"
+require "tailor"
 
 gem 'cucumber'
 require 'cucumber'
@@ -9,6 +10,7 @@ Before do
   @tmp_root = File.dirname(__FILE__) + "/../../tmp"
   @home_path = File.expand_path(File.join(@tmp_root, "home"))
   @lib_path  = File.expand_path(File.dirname(__FILE__) + "/../../lib")
+  @features_path = File.dirname(__FILE__) + "/../"
   FileUtils.rm_rf   @tmp_root
   FileUtils.mkdir_p @home_path
   ENV['HOME'] = @home_path

data/features/support/world.rb

@@ -1,53 +1 @@
-$:.unshift(File.dirname(__FILE__) + '/../../lib')
 
-require 'tailor'
-
-include Tailor
-
-
-# Counts keywords in the file provided.
-#
-# @param [String] file Path to the file to check
-# @param [String] keyword Keyword to count
-# @return [Number] Number of keywords counted
-def count_keywords file, keyword
-  ruby_source = File.open(file, 'r')
-
-  count = 0
-  ruby_source.each_line do |line|
-    if line =~ /^#{keyword}/
-      count =+ 1
-    end
-  end
-  ruby_source.close
-  count
-end
-
-
-# Prep for the testing
-Before do
-  @tailor = "#{File.dirname(__FILE__)}/../../bin/tailor"
-end
-
-
-#-----------------------------------------------------------------------------
-# "Given" statements
-#-----------------------------------------------------------------------------
-Given /^I have a project directory "([^\"]*)"$/ do |project_dir|
-  project_dir = "support/#{project_dir}"
-  File.exists?(project_dir).should be_true
-  File.directory?(project_dir).should be_true
-  @project_dir = project_dir
-end
-
-Given /^the file contains only "([^\"]*)" "([^\"]*)" statement$/ do
-  |count_in_spec, keyword|
-  #count_in_file = count_keywords(@ruby_source, keyword)
-  count_in_file = count_keywords(@file_list[0], keyword)
-  count_in_file.should == count_in_spec.to_i
-end
-
-Given /^I have "([^\"]*)" file in my project$/ do |file_count|
-  @file_list = Dir.glob("#{@project_dir}/*")
-  @file_list.length.should == file_count.to_i
-end

data/lib/tailor.rb

@@ -1,24 +1,39 @@
 $:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+  $:.include?(File.dirname(__FILE__)) ||
+  $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 require 'fileutils'
 require 'pathname'
 require 'tailor/file_line'
+require 'tailor/spacing'
 
 module Tailor
-  VERSION = '0.0.3'
-
-  RUBY_KEYWORDS_WITH_END = [
-    'begin',
-    'case',
-    'class',
-    'def',
-    'do',
-    'if',
-    'unless',
-    'until',
-    'while'
-    ]
+  VERSION = '0.1.0'
+
+  # These operators should always have 1 space around them
+  OPERATORS = {
+    :arithmetic => ['+', '-', '*', '/', '%', '++', '--', '**'],
+    :assignment => ['=', '+=', '-=', '*=', '/=', '%=', '*=', '**=', '|', '&=',
+      '&&=', '>>=', '<<=', '||='],
+    :comparison => ['==', '===', '!=', '>', '<', '>=', '<=', '<=>', '!', '~'],
+    :gem_version => ['~>'],
+    :logical => ['&&', '||', 'and', 'or'],
+    :regex => ['^', '|', '!~', '=~'],
+    :shift => ['<<', '>>'],
+    :ternary => ['?', ':']
+  }
+
+  # These operators should never have spaces around them
+  NO_SPACE_AROUND_OPERATORS = {
+    :range => ['..', '...'],
+    :scope_resolution => ['::']
+  }
+
+  # Don't do anything about these ops; they're just here so we know not to do
+  # anything with them.
+  DO_NOTHING_OPS = {
+    :elements => ['[]', '[]=']
+  }
 
   # Check all files in a directory for style problems.
   #
@@ -33,7 +48,7 @@ module Tailor
 
     # Process each file
     ruby_files_in_project.each do |file_name|
-      problems = find_problems file_name
+      problems = find_problems_in file_name
       files_and_problems[file_name] = problems
     end
 
@@ -68,7 +83,7 @@ module Tailor
   #
   # @param [String] file_name Path to a file to check styling on.
   # @return [Number] Returns the number of errors on the file.
-  def self.find_problems file_name
+  def self.find_problems_in file_name
     source = File.open(file_name, 'r')
     file_path = Pathname.new(file_name)
 
@@ -80,11 +95,100 @@ module Tailor
 
     @problem_count = 0
     line_number = 1
+=begin
+    current_level = 0.0
+    next_level = 0.0
+    multi_line_next_level = 0.0
+    multi_line = false
+=end
+
     source.each_line do |source_line|
       line = FileLine.new(source_line, file_path, line_number)
 
-      # Check for indenting by spaces only
-      @problem_count += 1 if line.hard_tabbed?
+=begin
+      puts "line num: #{line_number}"
+if line.ends_with_comma?
+  puts "COMMA"
+end
+if line.ends_with_backslash?
+  puts "BACKSLASH"
+end
+if line.ends_with_operator?
+  puts "OPERATOR"
+end
+if line.unclosed_parenthesis?
+  puts "PARENTHESIS"
+end
+
+      multi_line_statement = line.multi_line_statement?
+
+      # If we're not in a multi-line statement, but this is the beginning of
+      # one...
+      if multi_line == false and multi_line_statement
+        multi_line = true
+        multi_line_next_level = current_level + 1.0
+        puts ":multi-line: current = #{current_level}; next = #{next_level}" +
+          "; multi_line_next = #{multi_line_next_level}"
+      # If we're already in a multi-line statement...
+      elsif multi_line == true and multi_line_statement
+        puts ":multi-line: current = #{current_level}; next = #{next_level}" +
+          "; multi_line_next = #{multi_line_next_level}"
+        # Keep current_line and next_line the same
+      elsif multi_line == true and !multi_line_statement and line.indent?
+        #next_level -= 1.0
+        puts ":multi-line: current = #{current_level}; next = #{next_level}" +
+          "; multi_line_next = #{multi_line_next_level}"
+      else
+        multi_line = false
+      end
+
+      if line.outdent?
+        current_level -= 1.0
+        next_level = current_level + 1.0
+        puts ":outdent: current = #{current_level}; next = #{next_level}" +
+          "; multi_line_next = #{multi_line_next_level}"
+      end
+
+      if line.contains_end?
+        current_level -= 1.0
+        next_level = current_level
+        puts ":end: current = #{current_level}; next = #{next_level}" +
+          "; multi_line_next = #{multi_line_next_level}"
+      end
+
+      if multi_line == true and !multi_line_statement and line.indent?
+      elsif line.indent?
+        next_level = current_level + 1.0
+        puts ":indent: current = #{current_level}; next = #{next_level}" +
+          "; multi_line_next = #{multi_line_next_level}"
+      end
+
+      if !line.indent? and !line.outdent? and !line.contains_end?
+        puts ":same: current = #{current_level}; next = #{next_level}" +
+          "; multi_line_next = #{multi_line_next_level}"
+      end
+
+      #if line.indent? or line.outdent? or line.contains_end?
+        if line.at_improper_level? current_level
+          @problem_count += 1
+        end
+      #end
+
+      # If this is the last line of the multi-line statement...
+      if multi_line == true and multi_line_statement
+        puts "Assinging current (#{current_level}) to multi_next (#{multi_line_next_level})"
+        current_level = multi_line_next_level
+      elsif multi_line == true and !multi_line_statement
+        multi_line = false
+        puts "Assigning current (#{current_level}) = next (#{next_level}) "
+        current_level = next_level
+      #elsif multi_line == false
+      else
+        puts "Assigning current (#{current_level}) = next (#{next_level}) "
+        current_level = next_level
+      end
+=end
+      @problem_count += line.spacing_problems
 
       # Check for camel-cased methods
       @problem_count += 1 if line.method_line? and line.camel_case_method?
@@ -92,32 +196,18 @@ module Tailor
       # Check for non-camel-cased classes
       @problem_count += 1 if line.class_line? and line.snake_case_class?
 
-      # Check for trailing whitespace
-      @problem_count += 1 if line.trailing_whitespace?
-
       # Check for long lines
       @problem_count += 1 if line.too_long?
 
-      # Check for spacing after commas
-      @problem_count += 1 if line.more_than_one_space_after_comma?
-
-      # Check for spacing after commas
-      @problem_count += 1 if line.no_space_after_comma?
-
-      # Check for spacing after commas
-      @problem_count += 1 if line.space_before_comma?
-
-      # Check for spacing after open parentheses
-      @problem_count += 1 if line.space_after_open_parenthesis?
-
-      # Check for spacing after open brackets
-      @problem_count += 1 if line.space_after_open_bracket?
-
-      # Check for spacing after closed parentheses
-      @problem_count += 1 if line.space_before_closed_parenthesis?
-
-      # Check for spacing after closed brackets
-      @problem_count += 1 if line.space_before_closed_bracket?
+      # Check for spacing around operators
+=begin
+      OPERATORS.each_pair do |op_group, op_values|
+        op_values.each do |op|
+          @problem_count += 1 if line.no_space_before? op
+          @problem_count += 1 if line.no_space_after? op
+        end
+      end
+=end
 
       line_number += 1
     end
@@ -125,6 +215,7 @@ module Tailor
     @problem_count
   end
 
+  ##
   # Prints a summary report that shows which files had how many problems.
   #
   # @param [Hash] files_and_problems Returns a hash that contains

data/lib/tailor/file_line.rb

@@ -1,4 +1,7 @@
-require 'pathname'
+require 'tailor/spacing'
+require 'tailor/indentation'
+require 'logger'
+require 'term/ansicolor'
 
 module Tailor
 
@@ -10,6 +13,9 @@ module Tailor
   #   true and print the associated error message when the bad style condition
   #   is discovered in the file line.
   class FileLine < String
+    include Tailor::Spacing
+    include Tailor::Indentation
+    include Term::ANSIColor
 
     LINE_LENGTH_MAX = 80
 
@@ -27,33 +33,10 @@ module Tailor
       super line_of_code
       @file_path = file_path
       @line_number = line_number
-    end
-
-    # Determines the number of spaces the line is indented.
-    #
-    # @return [Number] Returns the number of spaces the line is indented.
-    def indented_spaces
-      # Find out how many spaces exist at the beginning of the line
-      spaces = self.scan(/^\x20+/).first
-
-      unless spaces.nil?
-        return spaces.length
-      else
-        return 0
-      end
-    end
-
-    # Checks to see if the source code line contains any hard tabs.
-    #
-    # @return [Boolean] Returns true if the file line contains hard tabs.
-    #   false if the line contains only spaces.
-    def hard_tabbed?
-      if self.scan(/\t/).empty?
-        return false
-      else
-        print_problem "Line contains hard tabs:"
-        return true
-      end
+      @line_problem_count = 0
+      @logger = ::Logger.new(STDOUT)
+      #@logger.datetime_format = "%H:%M:%S"
+      @logger.datetime_format = ""
     end
 
     # Checks to see if the method name is using camel case.
@@ -70,11 +53,12 @@ module Tailor
 
       # The 2nd word is the method name, so evaluate that for caps chars.
       if words[1] =~ /[A-Z]/
-        print_problem "Method name uses camel case:"
+        @line_problem_count += 1
+        print_problem "Method name uses camel case"
         return true
-      else
-        return false
       end
+
+      return false
     end
 
     # Checks to see if the class name is using snake case.
@@ -91,23 +75,38 @@ module Tailor
 
       # The 2nd word is the class name, so check that.
       if words[1] =~ /_/
-        print_problem "Class name does NOT use camel case:"
+        @line_problem_count += 1
+        print_problem "Class name does NOT use camel case"
         return true
-      else
-        return false
       end
+
+      return false
     end
 
     # Checks to see if the line is the start of a method's definition.
     #
     # @return [Boolean] Returns true if the line starts with 'def'.
     def method_line?
-      words = self.split(/ /)
+      words = self.strip.split(/ /)
       if words[0].eql? "def"
         return true
-      else
-        return false
       end
+
+      return false
+    end
+
+    ##
+    # Returns the name of the method if the line is one that contains a method
+    #   definition.
+    #
+    # @return [String] The method name.
+    def method_name
+      unless self.method_line?
+        return nil
+      end
+
+      words = self.strip.split(/ /)
+      words[1]
     end
 
     # Checks to see if the line is the start of a class's definition.
@@ -118,9 +117,9 @@ module Tailor
       words = self.split(/ /)
       if words[0].eql? "class" and starts_with_uppercase?(words[1])
         return true
-      else
-        return false
       end
+
+      return false
     end
 
     ##
@@ -132,9 +131,9 @@ module Tailor
     def statement_line?
       if self.method_line? or self.class_line? or self.comment_line?
         return false
-      else
-        return true
       end
+
+      return true
     end
 
     # Checks to see if the whole line is a basic comment line.  This doesn't
@@ -142,142 +141,23 @@ module Tailor
     #
     # @return [Boolean] Returns true if the line begins with a pound symbol.
     def comment_line?
-      if self.scan(/\s*#/).empty?
-        return false
-      else
-        return true
-      end
-    end
-
-    ##
-    # Checks to see if there's whitespace at the end of the line.  Prints the
-    #   number of whitespaces at the end of the line.
-    #
-    # @return [Boolean] Returns true if theres whitespace at the end of the
-    #   line.
-    def trailing_whitespace?
-      count = self.trailing_whitespace_count
-
-      if count > 0
-        print_problem "Line contains #{count} trailing whitespace(s):"
-        return true
-      else
-        return false
-      end
-    end
-
-    # Checks to see if the line has trailing whitespace at the end of it. Note
-    #   that this excludes empty lines that have spaces on them!
-    #
-    # @return [Number] Returns the number of trailing spaces at the end of the
-    #   line.
-    def trailing_whitespace_count
-      spaces = self.scan(/(\x20+|\x09+)$/)
-      if spaces.first.eql? nil
-        return 0
-      else
-        return spaces.first.first.length
-      end
-    end
-
-    ##
-    # Checks to see if there's more than one one space after a comma.
-    #
-    # @return [Boolean] Returns true if there is more than one space after
-    #   a comma.
-    def more_than_one_space_after_comma?
-      if self.scan(/\,\x20{2,}/).first.nil?
-        return false
-      elsif self.scan(/\,\x20{2,}/)
-        print_problem "Line has a comma with > 1 space after it:"
+      unless self.scan(/^\s*#/).empty?
         return true
       end
-    end
 
-    ##
-    # Checks to see if there's no spaces after a comma and the next word.
-    #
-    # @return [Boolean] Returns true if there's no spaces between a comma and
-    #   the next word.
-    def no_space_after_comma?
-      if self.scan(/\w\x20?\,\w/).first.nil?
-        return false
-      elsif self.scan(/\w\x20?\,\w/)
-        print_problem "Line has a comma with 0 spaces after it:"
-        return true
-      end
+	    return false
     end
 
     ##
-    # Checks to see if there's spaces before a comma.
+    # Checks to see if the whole line is only space characters.
     #
-    # @return [Boolean] Returns true if there's any spaces before a comma.
-    #   Returns nil if the line doesn't contain a comma.
-    def space_before_comma?
-      if self.scan(/\w\x20+\,/).first.nil?
+    # @return [Boolean] Returns true if the line is only space characters.
+    def empty_line?
+      if self.scan(/^\s*$/).empty?
         return false
-      elsif self.scan(/\w\x20+\,/)
-        print_problem "Line has at least one space before a comma:"
-        return true
-      else
-        return nil
       end
-    end
 
-    ##
-    # Checks to see if there's spaces after an open parenthesis.
-    # 
-    # @return [Boolean] Returns true if there's spaces after an open
-    #   parenthesis.
-    def space_after_open_parenthesis?
-      if self.scan(/\(\x20+/).first.nil?
-        return false
-      elsif self.scan(/\(\x20+/)
-        print_problem "Line has an open parenthesis with spaces after it:"
-        return true
-      end
-    end
-
-    ##
-    # Checks to see if there's spaces after an open bracket.
-    # 
-    # @return [Boolean] Returns true if there's spaces after an open
-    #   bracket.
-    def space_after_open_bracket?
-      if self.scan(/\[\x20+/).first.nil?
-        return false
-      elsif self.scan(/\[\x20+/)
-        print_problem "Line has an open bracket with spaces after it:"
-        return true
-      end
-    end
-
-    ##
-    # Checks to see if there's spaces before a closed parenthesis.
-    # 
-    # @return [Boolean] Returns true if there's spaces before a closed
-    #   parenthesis.
-    def space_before_closed_parenthesis?
-      if self.scan(/\x20+\)/).first.nil?
-        return false
-      elsif self.scan(/\x20+\)/)
-        print_problem "Line has a closed parenthesis with spaces before it:"
-        return true
-      end
-    end
-
-    ##
-    # Checks to see if there's spaces before a closed brackets.
-    # 
-    # @return [Boolean] Returns true if there's spaces before a closed
-    #   bracket.
-    def space_before_closed_bracket?
-      if self.scan(/\x20+\]/).first.nil?
-        return false
-      elsif self.scan(/\x20+\]/)
-        print_problem "Line has a closed bracket with spaces before it:"
-        return true
-      end
+      return true
     end
 
     ##
@@ -287,12 +167,14 @@ module Tailor
     # @return [Boolean] Returns true if the line length exceeds the allowed
     #   length.
     def too_long?
-      if self.length > LINE_LENGTH_MAX
-        print_problem "Line is greater than #{LINE_LENGTH_MAX} characters:"
+      length = self.length
+      if length > LINE_LENGTH_MAX
+        @line_problem_count += 1
+        print_problem "Line is >#{LINE_LENGTH_MAX} characters (#{length})"
         return true
-      else
-        return false
       end
+
+      return false
     end
 
     #-----------------------------------------------------------------
@@ -305,8 +187,15 @@ module Tailor
     #
     # @param [String] Error message to print.
     def print_problem message
-      puts message
-      puts "\t#{@file_path.relative_path_from(Pathname.pwd)}: #{@line_number}"
+      if @line_problem_count == 1
+        line_info = "Problems in"
+        line_info += " #{@file_path.relative_path_from(Pathname.pwd)}"
+        line_info += " [#{@line_number}]:"
+
+        puts ""
+        puts line_info
+      end
+      puts red("\t"+ message)
     end
 
     # Checks to see if a word begins with a lowercase letter.
@@ -315,9 +204,9 @@ module Tailor
     def starts_with_lowercase? word
       if word =~ /^[a-z]/
         return true
-      else
-        return false
       end
+
+      return false
     end
 
     # Checks to see if a word begins with an uppercase letter.
@@ -326,9 +215,9 @@ module Tailor
     def starts_with_uppercase? word
       if word =~ /^[A-Z]/
         return true
-      else
-        return false
       end
+
+      return false
     end
   end
 end