tailor 1.0.1 → 1.1.0

data/spec/functional/horizontal_spacing_spec.rb

@@ -0,0 +1,59 @@
+require_relative '../spec_helper'
+require_relative '../support/horizontal_spacing_cases'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+describe "Horizontal Space problem detection" do
+  before do
+    Tailor::Logger.stub(:log)
+    FakeFS.activate!
+  end
+
+  let(:critic) do
+    Tailor::Critic.new
+  end
+
+  let(:style) do
+    style = Tailor::Configuration::Style.new
+    style.trailing_newlines 0, level: :off
+    style.allow_invalid_ruby true, level: :off
+
+    style
+  end
+
+  H_SPACING_OK.each do |file_name, contents|
+    before do
+      FileUtils.touch file_name.to_s
+      File.open(file_name.to_s, 'w') { |f| f.write contents }
+    end
+
+    it "should be OK" do
+      critic.check_file(file_name.to_s, style.to_hash)
+      critic.problems.should == { file_name.to_s =>  [] }
+    end
+  end
+
+  context "line ends with a backslash" do
+    let(:file_name) { :line_split_by_backslash }
+
+    let(:contents) do
+      %Q{execute 'myscript' do
+  command \\
+    '/some/really/long/path/that/would/be/over/eighty/chars.sh'
+  only_if { something }
+end}
+    end
+
+    before do
+      FileUtils.touch file_name.to_s
+      File.open(file_name.to_s, 'w') { |f| f.write contents }
+    end
+
+    it "is OK" do
+      pending "Fix of gh-101"
+
+      critic.check_file(file_name.to_s, style.to_hash)
+      critic.problems.should == { file_name.to_s =>  [] }
+    end
+  end
+end

data/spec/functional/indentation_spacing/bad_indentation_spec.rb

@@ -0,0 +1,372 @@
+require_relative '../../spec_helper'
+require_relative '../../support/bad_indentation_cases'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+
+describe "Detection of method length" 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) { INDENT_1[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 "simple classes" do
+    context "empty with an indented end" do
+      let(:file_name) { :class_indented_end }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      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 "body extra indented" do
+      let(:file_name) { :class_indented_single_statement }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      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 "body extra indented, trailing comment" do
+      let(:file_name) { :class_indented_single_statement_trailing_comment }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      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 "body extra outdented" do
+      let(:file_name) { :class_outdented_single_statement }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      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
+  end
+
+  context "simple methods" do
+    context "empty with an indented end" do
+      let(:file_name) { :def_indented_end }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      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 "body and end extra indented" do
+      let(:file_name) { :def_content_indented_end }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 3 }
+      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 "in a class, end outdented" do
+      let(:file_name) { :class_def_content_outdented_end }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 4 }
+      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 "in a class, body outdented" do
+      let(:file_name) { :class_def_outdented_content }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 3 }
+      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 "class method outdented, in a class" do
+      let(:file_name) { :class_method_def_using_self_outdented }
+      specify do
+        pending "Fix of gh-109"
+        critic.problems[file_name.to_s].size.should be 1
+      end
+=begin
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      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
+    end
+  end
+
+  context "case statements" do
+    context "case extra indented" do
+      let(:file_name) { :case_indented_whens_level }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      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 "case extra indented, trailing comment" do
+      let(:file_name) { :case_indented_whens_level_trailing_comment }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      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 "case extra outdented" do
+      let(:file_name) { :case_outdented_whens_level }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      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 "when extra intdented" do
+      let(:file_name) { :case_when_indented_whens_level }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 3 }
+      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 "when extra outdented" do
+      let(:file_name) { :case_when_outdented_whens_level }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 3 }
+      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 "case extra indented" do
+      pending "Implementation of option to allow whens in"
+
+=begin
+      let(:file_name) { :case_indented_whens_in }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      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
+    end
+  end
+
+  context "while/do loops" do
+    context "while/do indented" do
+      let(:file_name) { :while_do_indented }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      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 "while/do outdented" do
+      let(:file_name) { :while_do_outdented }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      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 "while/do content outdented" do
+      let(:file_name) { :while_do_content_outdented }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 3 }
+      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 "while/do content indented" do
+      let(:file_name) { :while_do_content_indented }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 3 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 5 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "another while/do indented" do
+      let(:file_name) { :while_do_indented2 }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 4 }
+      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 "another while/do indented, trailing comment" do
+      let(:file_name) { :while_do_indented2_trailing_comment }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 4 }
+      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
+  end
+
+  context "until/do loops" do
+    context "until indented" do
+      let(:file_name) { :until_do_indented }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 4 }
+      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
+  end
+
+  context "for/do loops" do
+    context "for indented" do
+      let(:file_name) { :for_do_indented }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      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
+  end
+
+  context "loop/do loops" do
+    context "loop indented" do
+      let(:file_name) { :loop_do_indented }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      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
+  end
+
+  context "if statements" do
+    context "first line extra indented" do
+      let(:file_name) { :if_line_indented }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      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 "first line extra indented, trailing comment" do
+      let(:file_name) { :if_line_indented_trailing_comment }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      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
+  end
+
+  context "multi_line_tstring" do
+    let(:file_name) { :multi_line_tstring }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+    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 }
+  end
+
+  context "operators" do
+    context "multi-line &&, first line indented" do
+      let(:file_name) { :multi_line_andop_first_line_indented }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      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 "multi-line &&, first line indented, trailing comment" do
+      let(:file_name) { :multi_line_andop_first_line_indented_trailing_comment }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      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 "multi-line &&, second line indented" do
+      let(:file_name) { :multi_line_andop_second_line_indented }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 3 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 5 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "multi-line string concat, second line outdented" do
+      let(:file_name) { :multi_line_string_concat_with_plus_out }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 2 }
+      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
+  end
+
+  context "combinations of stuff" do
+    context "multi-line if with end in" do
+      let(:file_name) { :multi_line_method_call_end_in }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 5 }
+      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 "multi-line chained methods with 2nd line in" do
+      let(:file_name) { :multi_line_method_call_ends_with_period_2nd_line_in }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 4 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 5 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "multi-line chained methods with 3rd line in" do
+      let(:file_name) { :multi_line_method_call_ends_with_many_periods_last_in }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 3 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 4 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+
+    context "multi-line chained methods with 3rd line in, trailing comment" do
+      let(:file_name) { :multi_line_method_call_ends_with_many_periods_last_in_trailing_comment }
+      specify { critic.problems[file_name.to_s].size.should be 1 }
+      specify { critic.problems[file_name.to_s].first[:type].should == "indentation_spaces" }
+      specify { critic.problems[file_name.to_s].first[:line].should be 3 }
+      specify { critic.problems[file_name.to_s].first[:column].should be 4 }
+      specify { critic.problems[file_name.to_s].first[:level].should be :error }
+    end
+  end
+end

data/spec/functional/indentation_spacing_spec.rb

@@ -0,0 +1,85 @@
+require_relative '../spec_helper'
+require_relative '../support/good_indentation_cases'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+describe "Indentation spacing problem detection" do
+  before do
+    Tailor::Logger.stub(:log)
+    FakeFS.activate!
+  end
+
+  let(:critic) do
+    Tailor::Critic.new
+  end
+
+  let(:style) do
+    style = Tailor::Configuration::Style.new
+    style.trailing_newlines 0, level: :off
+    style.allow_invalid_ruby true, level: :off
+
+    style
+  end
+
+  let(:contents) { INDENT_1[file_name] }
+
+  INDENT_OK.each do |file_name, contents|
+    before do
+      FileUtils.touch file_name.to_s
+      File.open(file_name.to_s, 'w') { |f| f.write contents }
+    end
+
+    it "should be OK" do
+      critic.check_file(file_name.to_s, style.to_hash)
+      critic.problems.should == { file_name.to_s =>  [] }
+    end
+  end
+
+  context "case statement with indented whens" do
+    let(:file_name) { :case_whens_in }
+
+    let(:contents) do
+      %Q{def my_method
+  case true
+    when true
+      puts "stuff"
+    when false
+      puts "blah blah"
+  end
+end}
+    end
+
+    it "is OK" do
+      pending "Implementation of the option to allow for this"
+    end
+  end
+
+  context "method with rparen on following line" do
+    let(:file_name) { :method_closing_lonely_paren }
+
+    let(:contents) do
+      %Q{def your_thing(one
+  )
+end}
+    end
+
+    it "is OK" do
+      pending
+    end
+  end
+
+  context "lonely rparen and do on the same line" do
+    let(:file_name) { :rparen_and_do_same_line }
+
+    let(:contents) do
+      %Q{opt.on('-c', '--config-file FILE',
+  "Use a specific config file.") do |config|
+  options.config_file = config
+end}
+    end
+
+    it "is OK" do
+      pending
+    end
+  end
+end