tailor 1.3.1 → 1.4.0

data/spec/functional/indentation_spacing/line_continuations_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+require_relative '../../support/line_indentation_cases'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+describe 'Line continuation indentation' do
+  def file_name
+    self.class.description
+  end
+
+  def contents
+    LINE_INDENT[file_name] || begin
+      raise "Example not found: #{file_name}"
+    end
+  end
+
+  before do
+    Tailor::Logger.stub(:log)
+    FakeFS.activate!
+    FileUtils.touch file_name
+    File.open(file_name, 'w') { |f| f.write contents }
+  end
+
+  let(:critic) { Tailor::Critic.new }
+
+  let(:style) do
+    style = Tailor::Configuration::Style.new
+    style.trailing_newlines 0, level: :off
+    style.allow_invalid_ruby true, level: :off
+    style.allow_unnecessary_double_quotes true, level: :off
+
+    style
+  end
+
+  context :line_continues_further_indented do
+
+    it 'warns when line continuation spacing is not specified' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [{
+        type: 'indentation_spaces',
+        line: 2,
+        column: 4,
+        message: "Line is indented to column 4, but should be at 2.",
+        level: :error
+      }]
+    end
+
+    it 'warns when line continuation spacing is disabled' do
+      style.indentation_spaces 2, level: :error, line_continuations: :off
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [{
+        type: 'indentation_spaces',
+        line: 2,
+        column: 4,
+        message: "Line is indented to column 4, but should be at 2.",
+        level: :error
+      }]
+    end
+
+    it 'does not warn when line continuation spacing is enabled' do
+      style.indentation_spaces 2, level: :error, line_continuations: true
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+
+  end
+
+  context :line_continues_at_same_indentation do
+
+    it 'does not warn when line continuation spacing is not specified' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+
+    it 'does not warn when line continuation spacing is disabled' do
+      style.indentation_spaces 2, level: :error, line_continuations: :off
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+
+    it 'warns when line continuation spacing is enabled' do
+      style.indentation_spaces 2, level: :error, line_continuations: true
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [{
+        type: 'indentation_spaces',
+        line: 2,
+        column: 2,
+        message: "Line is indented to column 2, but should be at 4.",
+        level: :error
+      }]
+    end
+
+  end
+
+  context :parameters_continuation_indent_across_lines do
+    it 'warns when line continuation spacing is not specified' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [{
+        type: 'indentation_spaces',
+        line: 2,
+        column: 4,
+        message: "Line is indented to column 4, but should be at 2.",
+        level: :error
+      }]
+    end
+
+    it 'warns when line continuation spacing is disabled' do
+      style.indentation_spaces 2, level: :error, line_continuations: :off
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [{
+        type: 'indentation_spaces',
+        line: 2,
+        column: 4,
+        message: "Line is indented to column 4, but should be at 2.",
+        level: :error
+      }]
+    end
+
+    it 'warns when line continuation spacing is enabled' do
+      style.indentation_spaces 2, level: :error, line_continuations: true
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+
+  end
+
+  context :parameters_no_continuation_indent_across_lines do
+    it 'warns when line continuation spacing is not specified' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+
+    it 'warns when line continuation spacing is disabled' do
+      style.indentation_spaces 2, level: :error, line_continuations: :off
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+
+    it 'warns when line continuation spacing is enabled' do
+      style.indentation_spaces 2, level: :error, line_continuations: true
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [{
+        type: 'indentation_spaces',
+        line: 2,
+        column: 2,
+        message: "Line is indented to column 2, but should be at 4.",
+        level: :error
+      }]
+    end
+
+  end
+
+  [
+    :hash_spans_lines,
+    :if_else,
+    :line_continues_without_nested_statements,
+    :minitest_test_cases,
+    :nested_blocks,
+    :one_assignment_per_line
+  ].each do |never_warns_example|
+      context never_warns_example do
+
+        it 'does not warn when line continuation spacing is not specified' do
+          critic.check_file(file_name, style.to_hash)
+          expect(critic.problems[file_name]).to be_empty
+        end
+
+        it 'does not warn when line continuation spacing is disabled' do
+          style.indentation_spaces 2, level: :error, line_continuations: :off
+          critic.check_file(file_name, style.to_hash)
+          expect(critic.problems[file_name]).to be_empty
+        end
+
+        it 'does not warn when line continuation spacing is enabled' do
+          style.indentation_spaces 2, level: :error, line_continuations: true
+          critic.check_file(file_name, style.to_hash)
+          expect(critic.problems[file_name]).to be_empty
+        end
+      end
+    end
+end

data/spec/functional/indentation_spacing_spec.rb

@@ -83,4 +83,21 @@ end}
       pending
     end
   end
+
+  context 'block chained on a block' do
+    let(:file_name) { 'block_chain' }
+
+    let(:contents) do
+      %Q{{
+  a: 1
+}.each do |k, v|
+  puts k, v
+end}
+    end
+
+    it 'is OK' do
+      critic.check_file(file_name, style.to_hash)
+      critic.problems.should == { file_name =>  [] }
+    end
+  end
 end

data/spec/functional/string_interpolation_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+require_relative '../support/string_interpolation_cases'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+describe 'String interpolation cases' do
+  def file_name
+    self.class.description
+  end
+
+  def contents
+    INTERPOLATION[file_name] || begin
+      raise "Example not found: #{file_name}"
+    end
+  end
+
+  before do
+    Tailor::Logger.stub(:log)
+    FakeFS.activate!
+    FileUtils.touch file_name
+    File.open(file_name, 'w') { |f| f.write contents }
+  end
+
+  let(:critic) { Tailor::Critic.new }
+
+  let(:style) do
+    style = Tailor::Configuration::Style.new
+    style.trailing_newlines 0, level: :off
+    style.allow_invalid_ruby true, level: :off
+    style.allow_unnecessary_double_quotes true, level: :off
+
+    style
+  end
+
+  context :one_variable_interpolated_only do
+    it 'warns when interpolation is used unnecessarily' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [{
+        type: 'unnecessary_string_interpolation',
+        line: 1,
+        column: 6,
+        message: 'Variable interpolated unnecessarily',
+        level: :warn
+      }]
+    end
+  end
+
+  context :mixed_content_and_expression do
+    it 'does not warn' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+  end
+
+  context :no_string do
+    it 'does not warn' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+  end
+
+  context :two_variables do
+    it 'does not warn' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+  end
+
+  context :two_strings_with_unnecessary_interpolation do
+    it 'warns against both strings' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [
+        {
+          type: 'unnecessary_string_interpolation',
+          line: 1,
+          column: 6,
+          message: 'Variable interpolated unnecessarily',
+          level: :warn
+        },
+        {
+          type: 'unnecessary_string_interpolation',
+          line: 1,
+          column: 17,
+          message: 'Variable interpolated unnecessarily',
+          level: :warn
+        }
+      ]
+    end
+  end
+
+  context :multiline_string_with_unnecessary_interpolation do
+    it 'warns against the first line' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [{
+        type: 'unnecessary_string_interpolation',
+        line: 1,
+        column: 6,
+        message: 'Variable interpolated unnecessarily',
+        level: :warn
+      }]
+    end
+  end
+
+  context :multiline_word_list do
+    it 'does not warn' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+  end
+
+  context :nested_interpolation do
+    it 'does not warn' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+  end
+end

data/spec/functional/string_quoting_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+require_relative '../support/string_quoting_cases'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+describe 'String Quoting' do
+
+  def file_name
+    self.class.description
+  end
+
+  def contents
+    QUOTING[file_name] || begin
+      raise "Example not found: #{file_name}"
+    end
+  end
+
+  before do
+    Tailor::Logger.stub(:log)
+    FakeFS.activate!
+    FileUtils.touch file_name
+    File.open(file_name, 'w') { |f| f.write contents }
+  end
+
+  let(:critic) { Tailor::Critic.new }
+
+  let(:style) do
+    style = Tailor::Configuration::Style.new
+    style.trailing_newlines 0, level: :off
+    style.allow_invalid_ruby true, level: :off
+    style
+  end
+
+  context :single_quotes_no_interpolation do
+    it 'does not warn' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+  end
+
+  context :double_quotes_with_interpolation do
+    it 'does not warn' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+  end
+
+  context :double_quotes_no_interpolation do
+    it 'warns that double quotes are unnecessary' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [{
+        type: 'unnecessary_double_quotes',
+        line: 1,
+        column: 6,
+        message: 'Unnecessary double quotes at column 6, expected single quotes.',
+        level: :warn
+      }]
+    end
+  end
+
+  context :double_quotes_no_interpolation_twice do
+    it 'warns that double quotes are unnecessary' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to eql [
+        {
+          type: 'unnecessary_double_quotes',
+          line: 1,
+          column: 6,
+          message: 'Unnecessary double quotes at column 6, expected single quotes.',
+          level: :warn
+        },
+        {
+          type: 'unnecessary_double_quotes',
+          line: 1,
+          column: 14,
+          message: 'Unnecessary double quotes at column 14, expected single quotes.',
+          level: :warn
+        }
+      ]
+    end
+  end
+
+  context :nested_quotes do
+    it 'does not warn' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+  end
+
+  context :escape_sequence do
+    it 'does not warn when a double quoted string contains a newline' do
+      critic.check_file(file_name, style.to_hash)
+      expect(critic.problems[file_name]).to be_empty
+    end
+  end
+
+end

data/spec/functional/vertical_spacing/class_length_spec.rb

@@ -10,7 +10,7 @@ CLASS_LENGTH['class_too_long'] =
   include Pizza
 
   def barrel_roll
-    puts "DOABARRELROLL!"
+    puts 'DOABARRELROLL!'
   end
 end}
 

data/spec/spec_helper.rb

@@ -3,6 +3,12 @@ require 'simplecov'
 
 SimpleCov.start
 
-RSpec.configure do |conf|
-  conf.include FakeFS::SpecHelpers
+RSpec.configure do |config|
+  config.include FakeFS::SpecHelpers
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
 end

data/spec/support/argument_alignment_cases.rb

@@ -0,0 +1,93 @@
+ARG_INDENT = {}
+
+ARG_INDENT['def_no_arguments'] =
+  %q{def foo
+  true
+end}
+
+ARG_INDENT['def_arguments_fit_on_one_line'] =
+  %q{def foo(foo, bar, baz)
+  true
+end}
+
+ARG_INDENT['def_arguments_aligned'] =
+  %q{def something(waka, baka, bing,
+              bla, goop, foop)
+  stuff
+end
+}
+
+ARG_INDENT['def_arguments_indented'] =
+  %q{def something(waka, baka, bing,
+  bla, goop, foop)
+  stuff
+end
+}
+
+ARG_INDENT['call_no_arguments'] =
+  %q{bla = method()}
+
+ARG_INDENT['call_arguments_fit_on_one_line'] =
+  %q{bla = method(foo, bar, baz, bing, ding)}
+
+ARG_INDENT['call_arguments_aligned'] =
+  %q{bla = Something::SomethingElse::SomeClass.method(foo, bar, baz,
+                                                 bing, ding)
+}
+
+ARG_INDENT['call_arguments_aligned_args_are_integer_literals'] =
+  %q{bla = Something::SomethingElse::SomeClass.method(1, 2, 3,
+                                                 4, 5)
+}
+
+ARG_INDENT['call_arguments_aligned_args_are_string_literals'] =
+  %q{bla = Something::SomethingElse::SomeClass.method('foo', 'bar', 'baz',
+                                                 'bing', 'ding')
+}
+
+ARG_INDENT['call_arguments_aligned_args_have_parens'] =
+  %q{bla = Something::SomethingElse::SomeClass.method(foo, bar(), baz,
+                                                 bing, ding)
+}
+
+ARG_INDENT['call_arguments_aligned_no_parens'] =
+  %q{bla = Something::SomethingElse::SomeClass.method foo, bar, baz,
+                                                 bing, ding
+}
+
+ARG_INDENT['call_arguments_aligned_multiple_lines'] =
+  %q{bla = Something::SomethingElse::SomeClass.method(foo, bar, baz,
+                                                 bing, ding,
+                                                 ginb, gind)
+}
+
+ARG_INDENT['call_arguments_indented'] =
+  %q{bla = Something::SomethingElse::SomeClass.method(foo, bar, baz,
+  bing, ding)
+}
+
+ARG_INDENT['call_arguments_indented_separate_line'] =
+  %q{bla = Something::SomethingElse::SomeClass.method(
+  foo, bar, baz,
+  bing, ding
+)}
+
+ARG_INDENT['call_arguments_on_next_line'] =
+  %q{some_long_method_that_goes_out_to_the_end_of_the_line(
+  foo, bar)
+}
+
+ARG_INDENT['call_arguments_on_next_line_nested'] =
+  %q{if some_long_method_that_goes_out_to_the_end_of_the_line(
+    foo, bar)
+  my_nested_expression
+end}
+
+ARG_INDENT['call_arguments_on_next_line_multiple'] =
+  %q{some_long_method_that_goes_out_to_the_end_of_the_line(
+  foo, bar)
+
+if diff_long_method_that_goes_out_to_the_end_of_the_line(
+    foo, bar)
+  my_nested_expression
+end}