tailor 1.0.1 → 1.1.0

data/spec/functional/horizontal_spacing/brackets_spec.rb

@@ -0,0 +1,88 @@
+require_relative '../../spec_helper'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+
+BRACKETS = {}
+BRACKETS[:space_in_empty_array] = %Q{[ ]}
+BRACKETS[:simple_array_space_after_lbracket] = %Q{[ 1, 2, 3]}
+BRACKETS[:simple_array_space_before_rbracket] = %Q{[1, 2, 3 ]}
+BRACKETS[:hash_key_ref_space_before_rbracket] = %Q{thing[:one ]}
+BRACKETS[:hash_key_ref_space_after_lbracket] = %Q{thing[ :one]}
+BRACKETS[:two_d_array_space_after_lbrackets] =
+  %Q{[ [1, 2, 3], [ 'a', 'b', 'c']]}
+BRACKETS[:two_d_array_space_before_rbrackets] =
+  %Q{[[1, 2, 3 ], [ 'a', 'b', 'c'] ]}
+
+
+describe "Detection of spaces around brackets" do
+  before do
+    Tailor::Logger.stub(:log)
+    FakeFS.activate!
+    File.open(file_name.to_s, 'w') { |f| f.write contents }
+    critic.check_file(file_name.to_s, style.to_hash)
+  end
+
+  let(:critic) do
+    Tailor::Critic.new
+  end
+
+  let(:contents) { BRACKETS[file_name]}
+
+  let(:style) do
+    style = Tailor::Configuration::Style.new
+    style.trailing_newlines 0, level: :off
+    style.allow_invalid_ruby true, level: :off
+
+    style
+  end
+
+  context "Arrays" do
+    context "empty with space inside" do
+      let(:file_name) { :space_in_empty_array }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_after_lbracket" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "space after lbracket" do
+      let(:file_name) { :simple_array_space_after_lbracket }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_after_lbracket" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "space before rbracket" do
+      let(:file_name) { :simple_array_space_before_rbracket }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_before_rbracket" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 9 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+  end
+
+  context "Hash key references" do
+    context "space before rbracket" do
+      let(:file_name) { :hash_key_ref_space_before_rbracket }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_before_rbracket" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 11 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "space after lbracket" do
+      let(:file_name) { :hash_key_ref_space_after_lbracket }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_after_lbracket" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 6 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+  end
+end

data/spec/functional/horizontal_spacing/comma_spacing_spec.rb

@@ -0,0 +1,68 @@
+require_relative '../../spec_helper'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+
+COMMA_SPACING = {}
+COMMA_SPACING[:no_space_after_comma] = %Q{[1,2]}
+COMMA_SPACING[:two_spaces_after_comma] = %Q{[1,  2]}
+COMMA_SPACING[:one_space_before_comma] = %Q{[1 , 2]}
+COMMA_SPACING[:two_spaces_before_comma] = %Q{[1  , 2]}
+COMMA_SPACING[:two_spaces_before_comma_twice] = %Q{[1  , 2  , 3]}
+COMMA_SPACING[:two_spaces_after_comma_twice] = %Q{[1,  2,  3]}
+
+COMMA_SPACING[:spaces_before_with_trailing_comments] = %Q{[
+  1 ,   # Comment!
+  2 ,   # Another comment.
+}
+
+
+describe "Spacing around comma detection" do
+  before do
+    Tailor::Logger.stub(:log)
+    FakeFS.activate!
+    File.open(file_name.to_s, 'w') { |f| f.write contents }
+    critic.check_file(file_name.to_s, style.to_hash)
+  end
+
+  let(:critic) do
+    Tailor::Critic.new
+  end
+
+  let(:contents) { COMMA_SPACING[file_name]}
+
+  let(:style) do
+    style = Tailor::Configuration::Style.new
+    style.trailing_newlines 0, level: :off
+    style.allow_invalid_ruby true, level: :off
+
+    style
+  end
+
+  context "no space after a comma" do
+    let(:file_name) { :no_space_after_comma }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "spaces_after_comma" }
+    specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+    specify { critic.problems[file_name.to_s].first[:column].should be 3 }
+    specify { critic.problems[file_name.to_s].first[:level].should be :error }
+  end
+
+  context "two spaces after a comma" do
+    let(:file_name) { :two_spaces_after_comma }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "spaces_after_comma" }
+    specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+    specify { critic.problems[file_name.to_s].first[:column].should be 3 }
+    specify { critic.problems[file_name.to_s].first[:level].should be :error }
+  end
+
+  context "one space before comma" do
+    let(:file_name) { :one_space_before_comma }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "spaces_before_comma" }
+    specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+    specify { critic.problems[file_name.to_s].first[:column].should be 2 }
+    specify { critic.problems[file_name.to_s].first[:level].should be :error }
+  end
+end

data/spec/functional/horizontal_spacing/hard_tabs_spec.rb

@@ -0,0 +1,110 @@
+require_relative '../../spec_helper'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+#-------------------------------------------------------------------------------
+# Hard tabs
+#-------------------------------------------------------------------------------
+HARD_TABS = {}
+
+HARD_TABS[:hard_tab] =
+  %Q{def something
+\tputs "something"
+end}
+
+HARD_TABS[:hard_tab_with_spaces] =
+  %Q{class Thing
+  def something
+\t  puts "something"
+  end
+end}
+
+# This only reports the hard tab problem (and not the indentation problem)
+# because a hard tab is counted as 1 space; here, this is 4 spaces, so it
+# looks correct to the parser.  I'm leaving this behavior, as detecting the
+# hard tab should signal the problem.  If you fix the hard tab and don't
+# fix indentation, tailor will flag you on the indentation on the next run.
+HARD_TABS[:hard_tab_with_1_indented_space] =
+  %Q{class Thing
+  def something
+\t   puts "something"
+  end
+end}
+
+HARD_TABS[:hard_tab_with_2_indented_spaces] =
+  %Q{class Thing
+  def something
+\t    puts "something"
+  end
+end}
+
+describe "Hard tab detection" do
+  before do
+    Tailor::Logger.stub(:log)
+    FakeFS.activate!
+    File.open(file_name.to_s, 'w') { |f| f.write contents }
+    critic.check_file(file_name.to_s, style.to_hash)
+  end
+
+  let(:critic) do
+    Tailor::Critic.new
+  end
+
+  let(:contents) { HARD_TABS[file_name]}
+
+  let(:style) do
+    style = Tailor::Configuration::Style.new
+    style.trailing_newlines 0, level: :off
+    style.allow_invalid_ruby true, level: :off
+
+    style
+  end
+
+  context "1 hard tab" do
+    let(:file_name) { :hard_tab }
+    specify { critic.problems[file_name.to_s].size.should be 2 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "allow_hard_tabs"  }
+    specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+    specify { critic.problems[file_name.to_s].first[:column].should be 0 }
+    specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    specify { critic.problems[file_name.to_s].last[:type].should == "indentation_spaces"  }
+    specify { critic.problems[file_name.to_s].last[:line].should be 2 }
+    specify { critic.problems[file_name.to_s].last[:column].should be 1 }
+    specify { critic.problems[file_name.to_s].last[:level].should be :error }
+  end
+
+  context "1 hard tab with 2 spaces after it" do
+    let(:file_name) { :hard_tab_with_spaces }
+    specify { critic.problems[file_name.to_s].size.should be 2 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "allow_hard_tabs"  }
+    specify { critic.problems[file_name.to_s].first[:line].should be 3 }
+    specify { critic.problems[file_name.to_s].first[:column].should be 0 }
+    specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    specify { critic.problems[file_name.to_s].last[:type].should == "indentation_spaces"  }
+    specify { critic.problems[file_name.to_s].last[:line].should be 3 }
+    specify { critic.problems[file_name.to_s].last[:column].should be 3 }
+    specify { critic.problems[file_name.to_s].last[:level].should be :error }
+  end
+
+  context "1 hard tab with 3 spaces after it" do
+    let(:file_name) { :hard_tab_with_1_indented_space }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "allow_hard_tabs"  }
+    specify { critic.problems[file_name.to_s].first[:line].should be 3 }
+    specify { critic.problems[file_name.to_s].first[:column].should be 0 }
+    specify { critic.problems[file_name.to_s].first[:level].should be :error }
+  end
+
+  context "1 hard tab with 4 spaces after it" do
+    let(:file_name) { :hard_tab_with_2_indented_spaces }
+    specify { critic.problems[file_name.to_s].size.should be 2 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "allow_hard_tabs"  }
+    specify { critic.problems[file_name.to_s].first[:line].should be 3 }
+    specify { critic.problems[file_name.to_s].first[:column].should be 0 }
+    specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    specify { critic.problems[file_name.to_s].last[:type].should == "indentation_spaces"  }
+    specify { critic.problems[file_name.to_s].last[:line].should be 3 }
+    specify { critic.problems[file_name.to_s].last[:column].should be 5 }
+    specify { critic.problems[file_name.to_s].last[:level].should be :error }
+  end
+end

data/spec/functional/horizontal_spacing/long_lines_spec.rb

@@ -0,0 +1,51 @@
+require_relative '../../spec_helper'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+
+LONG_LINE = {}
+LONG_LINE[:long_line_no_newline] = %Q{'#{'#' * 79}'}
+LONG_LINE[:long_line_newline_at_82] = %Q{'#{'#' * 79}'
+}
+
+
+describe "Long line detection" do
+  before do
+    Tailor::Logger.stub(:log)
+    FakeFS.activate!
+    File.open(file_name.to_s, 'w') { |f| f.write contents }
+    critic.check_file(file_name.to_s, style.to_hash)
+  end
+
+  let(:critic) do
+    Tailor::Critic.new
+  end
+
+  let(:contents) { LONG_LINE[file_name]}
+
+  let(:style) do
+    style = Tailor::Configuration::Style.new
+    style.trailing_newlines 0, level: :off
+    style.allow_invalid_ruby true, level: :off
+
+    style
+  end
+
+  context "line is 81 chars, no newline" do
+    let(:file_name) { :long_line_no_newline }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "max_line_length" }
+    specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+    specify { critic.problems[file_name.to_s].first[:column].should be 81 }
+    specify { critic.problems[file_name.to_s].first[:level].should be :error }
+  end
+
+  context "line is 81 chars, plus a newline" do
+    let(:file_name) { :long_line_newline_at_82 }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "max_line_length" }
+    specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+    specify { critic.problems[file_name.to_s].first[:column].should be 81 }
+    specify { critic.problems[file_name.to_s].first[:level].should be :error }
+  end
+end

data/spec/functional/horizontal_spacing/parens_spec.rb

@@ -0,0 +1,102 @@
+require_relative '../../spec_helper'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+
+PARENS = {}
+PARENS[:simple_method_call_space_after_lparen] = %Q{thing( one, two)}
+PARENS[:simple_method_call_space_before_rparen] = %Q{thing(one, two )}
+PARENS[:method_call_space_after_lparen_trailing_comment] =
+  %Q{thing( one, two)    # comment}
+PARENS[:method_call_space_after_lparen_before_rparen_trailing_comment] =
+  %Q{thing( one, two )    # comment}
+
+PARENS[:multi_line_method_call_space_after_lparen] = %Q{thing( one,
+  two)}
+PARENS[:multi_line_method_call_space_after_lparen_trailing_comment] =
+  %Q{thing( one,
+  two)}
+
+describe "Detection of spaces around brackets" do
+  before do
+    Tailor::Logger.stub(:log)
+    FakeFS.activate!
+    File.open(file_name.to_s, 'w') { |f| f.write contents }
+    critic.check_file(file_name.to_s, style.to_hash)
+  end
+
+  let(:critic) do
+    Tailor::Critic.new
+  end
+
+  let(:contents) { PARENS[file_name]}
+
+  let(:style) do
+    style = Tailor::Configuration::Style.new
+    style.trailing_newlines 0, level: :off
+    style.allow_invalid_ruby true, level: :off
+
+    style
+  end
+
+  context "methods" do
+    context "space after lparen" do
+      let(:file_name) { :simple_method_call_space_after_lparen }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_after_lparen" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 6 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "space before rparen" do
+      let(:file_name) { :simple_method_call_space_before_rparen }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_before_rparen" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 15 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "space after lparen, trailing comment" do
+      let(:file_name) { :method_call_space_after_lparen_trailing_comment }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_after_lparen" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 6 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "space after lparen, before rparen, trailing comment" do
+      let(:file_name) { :method_call_space_after_lparen_before_rparen_trailing_comment }
+      specify { critic.problems[file_name.to_s].size.should be 2 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_after_lparen" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 6 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+      specify { critic.problems[file_name.to_s].last[:type].should == "spaces_before_rparen" }
+      specify { critic.problems[file_name.to_s].last[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].last[:column].should be 16 }
+      specify { critic.problems[file_name.to_s].last[:level].should be :error }
+    end
+  end
+
+  context "multi-line method calls" do
+    context "space after lparen" do
+      let(:file_name) { :multi_line_method_call_space_after_lparen }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_after_lparen" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 6 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+    context "space after lparen, trailing comment" do
+      let(:file_name) { :multi_line_method_call_space_after_lparen_trailing_comment }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "spaces_after_lparen" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 6 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+  end
+end

data/spec/functional/horizontal_spacing/trailing_whitespace_spec.rb

@@ -0,0 +1,66 @@
+require_relative '../../spec_helper'
+require_relative '../../support/horizontal_spacing_cases'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+
+TRAILING_WHITESPACE = {}
+TRAILING_WHITESPACE[:empty_line_with_spaces] = %Q{  }
+TRAILING_WHITESPACE[:empty_line_with_spaces_in_method] = %Q{def thing
+  
+  puts 'something'
+end}
+
+TRAILING_WHITESPACE[:trailing_spaces_on_def] = %Q{def thing  
+  puts 'something'
+end}
+
+describe "Trailing whitespace detection" do
+  before do
+    Tailor::Logger.stub(:log)
+    FakeFS.activate!
+    File.open(file_name.to_s, 'w') { |f| f.write contents }
+    critic.check_file(file_name.to_s, style.to_hash)
+  end
+
+  let(:critic) do
+    Tailor::Critic.new
+  end
+
+  let(:contents) { TRAILING_WHITESPACE[file_name]}
+
+  let(:style) do
+    style = Tailor::Configuration::Style.new
+    style.trailing_newlines 0, level: :off
+    style.allow_invalid_ruby true, level: :off
+
+    style
+  end
+
+  context "line is empty spaces" do
+    let(:file_name) { :empty_line_with_spaces }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "allow_trailing_line_spaces" }
+    specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+    specify { critic.problems[file_name.to_s].first[:column].should be 2 }
+    specify { critic.problems[file_name.to_s].first[:level].should be :error }
+  end
+
+  context "method contains an empty line with spaces" do
+    let(:file_name) { :empty_line_with_spaces_in_method }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "allow_trailing_line_spaces" }
+    specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+    specify { critic.problems[file_name.to_s].first[:column].should be 2 }
+    specify { critic.problems[file_name.to_s].first[:level].should be :error }
+  end
+
+  context "def line ends with spaces" do
+    let(:file_name) { :trailing_spaces_on_def }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "allow_trailing_line_spaces" }
+    specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+    specify { critic.problems[file_name.to_s].first[:column].should be 11 }
+    specify { critic.problems[file_name.to_s].first[:level].should be :error }
+  end
+end