tailor 0.1.5 → 1.0.0.alpha

data/features/support/file_cases/naming_cases.rb

@@ -0,0 +1,52 @@
+NAMING_OK = {}
+NAMING_1 = {}
+
+NAMING_OK[:single_word_method] =
+  %Q{def thing
+end}
+
+NAMING_OK[:two_word_method] =
+  %Q{def thing_one
+end}
+
+NAMING_1[:one_caps_camel_case_method] =
+  %Q{def thingOne
+end}
+
+NAMING_1[:one_caps_camel_case_method_trailing_comment] =
+  %Q{def thingOne   # comment
+end}
+
+#-------------------------------------------------------------------------------
+NAMING_OK[:single_word_class] =
+  %Q{class Thing
+end}
+
+NAMING_OK[:single_word_module] =
+  %Q{module Thing
+end}
+
+NAMING_OK[:two_word_class] =
+  %Q{class ThingOne
+end}
+
+NAMING_OK[:two_word_module] =
+  %Q{module ThingOne
+end}
+
+NAMING_1[:one_screaming_snake_case_class] =
+  %Q{class Thing_One
+end}
+
+NAMING_1[:one_screaming_snake_module_class] =
+  %Q{module Thing_One
+end}
+
+NAMING_1[:two_screaming_snake_case_class] =
+  %Q{class Thing_One_Again
+end}
+
+NAMING_1[:two_screaming_snake_module_class] =
+  %Q{module Thing_One_Again
+end}
+

data/features/support/file_cases/vertical_spacing_cases.rb

@@ -0,0 +1,70 @@
+V_SPACING_OK = {}
+V_SPACING_1 = {}
+
+#-------------------------------------------------------------------------------
+# Class length
+#-------------------------------------------------------------------------------
+V_SPACING_OK[:class_five_code_lines] =
+  %Q{class Party
+  include Clowns
+
+  def barrel_roll
+  end
+end}
+
+V_SPACING_OK[:embedded_class_five_code_lines] =
+  %Q{class Party
+  class Pizza
+    include Cheese
+  end
+end}
+
+V_SPACING_1[:class_too_long] =
+  %Q{class Party
+  include Clowns
+  include Pizza
+
+  def barrel_roll
+    puts "DOABARRELROLL!"
+  end
+end}
+
+V_SPACING_1[:parent_class_too_long] =
+  %Q{class Party
+
+  class Pizza
+    include Cheese
+    include Yumminess
+  end
+end}
+
+#-------------------------------------------------------------------------------
+# Method length
+#-------------------------------------------------------------------------------
+V_SPACING_OK[:method_3_code_lines] =
+  %Q{def thing
+
+
+  puts 'hi'
+end}
+
+V_SPACING_OK[:embedded_method_3_code_lines] =
+  %Q{def outter_thing
+  def thing; puts 'hi'; end
+
+
+end}
+
+V_SPACING_1[:method_too_long] =
+  %Q{def thing
+  puts
+  puts
+end}
+
+V_SPACING_1[:parent_method_too_long] =
+  %Q{def thing
+  puts
+  def inner_thing; print '1'; end
+  puts
+end}
+

data/features/support/hooks.rb

@@ -0,0 +1,8 @@
+Before do
+  @original_home = ENV['HOME']
+  ENV['HOME'] = '.'
+end
+
+After do
+  ENV['HOME'] = @original_home
+end

data/features/support/{1_long_file_with_indentation/my_project.rb → legacy/long_file_with_indentation.rb}

@@ -53,4 +53,4 @@ module MyModule
       end
     end
   end
-end
+end

data/features/support/world.rb

@@ -1 +1,15 @@
+module IndentationHelpers
 
+  # Used for getting the faked file contexts from the indentation_cases.rb file.
+  #
+  # @param [String] file_name The name of the fake file to get.
+  # @return [String]
+  def get_file_contents(file_name)
+    path_chunks = file_name.split('/')
+    const_name = path_chunks.first(2).each { |c| c.upcase! }.join("_")
+    const = Kernel.const_get(const_name)
+
+    const[path_chunks.last.to_sym]
+  end
+end
+World(IndentationHelpers)

data/features/vertical_spacing.feature

@@ -0,0 +1,114 @@
+Feature: Vertical spacing
+  As a Ruby developer
+  I want to check my Ruby files for vertical spacing
+
+  Background:
+    Given my configuration file ".tailor" looks like:
+    """
+    Tailor.config do |config|
+      config.file_set do
+        max_code_lines_in_class 5
+        max_code_lines_in_method 3
+        trailing_newlines 0
+      end
+    end
+    """
+
+  @bad_files
+  Scenario: Detect lack of newlines
+    Given a file named "not_enough_newlines.rb" with:
+    """
+    def a_method
+      puts 'hi'
+    end
+    """
+    When I run `tailor -d .`
+    Then the output should match /Total Problems.*1/
+    And the output should contain "0 trailing newlines, but should have 1"
+
+  @bad_files
+  Scenario: Detect too many newlines
+    Given a file named "too_many_newlines.rb" with:
+    """
+    def a_method
+      puts 'hi'
+    end
+
+
+    """
+    When I run `tailor -d .`
+    Then the output should match /Total Problems.*1/
+    And the output should contain "2 trailing newlines, but should have 1"
+
+  @good_files
+  Scenario: Doesn't report problem when meeting criteria
+    Given a file named "good_file.rb" with:
+    """
+    def a_method
+      puts 'hi'
+    end
+
+    """
+    When I run `tailor -d .`
+    Then the output should match /Total Problems.*0/
+
+  @good_files @class_length
+
+  @multi_line
+  Scenario Outline: Classes/modules with <= configured lines
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*0/
+    And the exit status should be 0
+
+  Scenarios:
+    | File                                        |
+    | v_spacing/ok/class_five_code_lines          |
+    | v_spacing/ok/embedded_class_five_code_lines |
+
+  @bad_files @class_length
+
+  @multi_line
+  Scenario Outline: Lines with bad spacing around parens
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*<Problems>/
+    And the output should match /position:  <Position>/
+    And the output should match /position:  <Position 2>/
+    And the exit status should be 1
+
+  Scenarios:
+    | File                              | Position | Position 2 | Problems |
+    | v_spacing/1/class_too_long        | 1:0      |            | 1        |
+    | v_spacing/1/parent_class_too_long | 1:0      |            | 1        |
+
+  @good_files @method_length
+
+  @multi_line
+  Scenario Outline: Methods with <= configured lines
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*0/
+    And the exit status should be 0
+
+  Scenarios:
+    | File                                      |
+    | v_spacing/ok/method_3_code_lines          |
+    | v_spacing/ok/embedded_method_3_code_lines |
+
+  @bad_files @method_length
+
+  @multi_line
+  Scenario Outline: Lines with bad spacing around parens
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*<Problems>/
+    And the output should match /position:  <Position>/
+    And the output should match /position:  <Position 2>/
+    And the exit status should be 1
+
+  Scenarios:
+    | File                               | Position | Position 2 | Problems |
+    | v_spacing/1/method_too_long        | 1:0      |            | 1        |
+    | v_spacing/1/parent_method_too_long | 1:0      |            | 1        |
+

data/lib/ext/string_ext.rb

@@ -0,0 +1,5 @@
+require 'term/ansicolor'
+
+class String
+  include Term::ANSIColor
+end

data/lib/tailor.rb

@@ -1,256 +1,10 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) ||
-  $:.include?(File.expand_path(File.dirname(__FILE__)))
+require_relative 'tailor/configuration'
 
-require 'fileutils'
-require 'pathname'
-require 'tailor/version'
-require 'tailor/file_line'
-require 'tailor/spacing'
+class Tailor
+  def self.config
+    configuration = Tailor::Configuration.new
+    yield configuration if block_given?
 
-module Tailor
-
-  # 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.
-  #
-  # @param [String] project_base_dir Path to a directory to recurse into and
-  #   look for problems in.
-  # @return [Hash] Returns a hash that contains file_name => problem_count.
-  def self.check project_base_dir
-    # Get the list of files to process
-    ruby_files_in_project = project_file_list(project_base_dir)
-
-    files_and_problems = Hash.new
-
-    # Process each file
-    ruby_files_in_project.each do |file_name|
-      problems = find_problems_in file_name
-      files_and_problems[file_name] = problems
-    end
-
-    files_and_problems
-  end
-
-
-  # Check a single file for style problems.
-  #
-  # @param [String] file_name Path to a file to check style on.
-  # @return [Hash] Returns a hash that contains file_name => problem_count.
-  def self.check_file file_name
-    files_and_problems = Hash.new
-
-    problems = find_problems_in File.expand_path(file_name)
-    files_and_problems[file_name] = problems
-
-    files_and_problems
-  end
-
-  # Gets a list of .rb files in the project.  This gets each file's absolute
-  # path in order to alleviate any possible confusion.
-  #
-  # @param [String] base_dir Directory to start recursing from to look for .rb
-  #   files.
-  # @return [Array] Sorted list of absolute file paths in the project.
-  def self.project_file_list base_dir
-    if File.directory? base_dir
-      FileUtils.cd base_dir
-    end
-
-    # Get the .rb files
-    ruby_files_in_project = Dir.glob(File.join('*', '**', '*.rb'))
-    Dir.glob(File.join('*.rb')).each { |file| ruby_files_in_project << file }
-
-    # Get the .erb files
-    Dir.glob(File.join('*.erb')).each { |file| ruby_files_in_project << file }
-
-    # Expand paths to all files in the list
-    list_with_absolute_paths = Array.new
-    ruby_files_in_project.each do |file|
-      list_with_absolute_paths << File.expand_path(file)
-    end
-
-    list_with_absolute_paths.sort
-  end
-
-  # Checks a sing file for all defined styling parameters.
-  #
-  # @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_in file_name
-    source = File.open(file_name, 'r')
-    file_path = Pathname.new(file_name)
-
-    puts ""
-    puts "#-------------------------------------------------------------------"
-    puts "# Looking for bad style in:"
-    puts "# \t'#{file_path}'"
-    puts "#-------------------------------------------------------------------"
-
-    @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)
-
-=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 "Assigning 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?
-
-      # Check for non-camel-cased classes
-      @problem_count += 1 if line.class_line? and line.snake_case_class?
-
-      # Check for long lines
-      @problem_count += 1 if line.too_long?
-
-      # 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
-
-    @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
-  #   file_name => problem_count.
-  def self.print_report files_and_problems
-    puts ""
-    puts "The following files are out of style:"
-
-    files_and_problems.each_pair do |file, problem_count|
-      file_path = Pathname.new(file)
-
-      unless problem_count == 0
-        print "\t#{problem_count} problems in: "
-        if files_and_problems.size > 1
-          puts "#{file_path.relative_path_from(Pathname.pwd)}"
-        else
-          puts "#{file_path}"
-        end
-      end
-    end
+    configuration
   end
 end