tailor 1.0.1 → 1.1.0

data/spec/functional/naming/camel_case_methods_spec.rb

@@ -0,0 +1,56 @@
+require_relative '../../spec_helper'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+
+CAMEL_CASE_METHODS = {}
+
+CAMEL_CASE_METHODS[:one_caps_camel_case_method] =
+  %Q{def thingOne
+end}
+
+CAMEL_CASE_METHODS[:one_caps_camel_case_method_trailing_comment] =
+  %Q{def thingOne   # comment
+end}
+
+
+describe "Detection of camel case methods" 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) { CAMEL_CASE_METHODS[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 "standard camel case method" do
+    let(:file_name) { :one_caps_camel_case_method }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "allow_camel_case_methods" }
+    specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+    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 "standard camel case method, trailing comment" do
+    let(:file_name) { :one_caps_camel_case_method_trailing_comment }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "allow_camel_case_methods" }
+    specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+    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

data/spec/functional/naming/screaming_snake_case_classes_spec.rb

@@ -0,0 +1,83 @@
+require_relative '../../spec_helper'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+
+SCREAMING_SNAKE_CASE_CLASSES = {}
+
+SCREAMING_SNAKE_CASE_CLASSES[:one_screaming_snake_case_class] =
+  %Q{class Thing_One
+end}
+
+SCREAMING_SNAKE_CASE_CLASSES[:one_screaming_snake_case_module] =
+  %Q{module Thing_One
+end}
+
+SCREAMING_SNAKE_CASE_CLASSES[:double_screaming_snake_case_class] =
+  %Q{class Thing_One_Again
+end}
+
+SCREAMING_SNAKE_CASE_CLASSES[:double_screaming_snake_case_module] =
+  %Q{module Thing_One_Again
+end}
+
+
+
+describe "Detection of camel case methods" 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) { SCREAMING_SNAKE_CASE_CLASSES[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 "standard screaming snake case class" do
+    let(:file_name) { :one_screaming_snake_case_class }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "allow_screaming_snake_case_classes" }
+    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 "standard screaming snake case module" do
+    let(:file_name) { :one_screaming_snake_case_module }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "allow_screaming_snake_case_classes" }
+    specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+    specify { critic.problems[file_name.to_s].first[:column].should be 7 }
+    specify { critic.problems[file_name.to_s].first[:level].should be :error }
+  end
+
+  context "double screaming snake case class" do
+    let(:file_name) { :double_screaming_snake_case_class }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "allow_screaming_snake_case_classes" }
+    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 "double screaming snake case module" do
+    let(:file_name) { :double_screaming_snake_case_module }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "allow_screaming_snake_case_classes" }
+    specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+    specify { critic.problems[file_name.to_s].first[:column].should be 7 }
+    specify { critic.problems[file_name.to_s].first[:level].should be :error }
+  end
+end

data/spec/functional/naming_spec.rb

@@ -0,0 +1,35 @@
+require_relative '../spec_helper'
+require_relative '../support/naming_cases'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+describe "Naming 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
+
+  NAMING_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
+end

data/spec/functional/vertical_spacing/class_length_spec.rb

@@ -0,0 +1,67 @@
+require_relative '../../spec_helper'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+
+CLASS_LENGTH = {}
+CLASS_LENGTH[:class_too_long] =
+  %Q{class Party
+  include Clowns
+  include Pizza
+
+  def barrel_roll
+    puts "DOABARRELROLL!"
+  end
+end}
+
+CLASS_LENGTH[:parent_class_too_long] =
+  %Q{class Party
+
+  class Pizza
+    include Cheese
+    include Yumminess
+  end
+end}
+
+
+describe "Detection of class 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) { CLASS_LENGTH[file_name] }
+
+  let(:style) do
+    style = Tailor::Configuration::Style.new
+    style.trailing_newlines 0, level: :off
+    style.allow_invalid_ruby true, level: :off
+    style.max_code_lines_in_class 5
+
+    style
+  end
+
+  context "single class" do
+    let(:file_name) { :class_too_long }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "max_code_lines_in_class" }
+    specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+    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 "class in a class" do
+    let(:file_name) { :parent_class_too_long }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "max_code_lines_in_class" }
+    specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+    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
+end

data/spec/functional/vertical_spacing/method_length_spec.rb

@@ -0,0 +1,61 @@
+require_relative '../../spec_helper'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+
+METHOD_LENGTH = {}
+METHOD_LENGTH[:method_too_long] =
+  %Q{def thing
+  puts
+  puts
+end}
+
+METHOD_LENGTH[:parent_method_too_long] =
+  %Q{def thing
+  puts
+  def inner_thing; print '1'; end
+  puts
+end}
+
+
+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) { METHOD_LENGTH[file_name] }
+
+  let(:style) do
+    style = Tailor::Configuration::Style.new
+    style.trailing_newlines 0, level: :off
+    style.allow_invalid_ruby true, level: :off
+    style.max_code_lines_in_method 3
+
+    style
+  end
+
+  context "single class too long" do
+    let(:file_name) { :method_too_long }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "max_code_lines_in_method" }
+    specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+    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 "method in a method" do
+    let(:file_name) { :method_too_long }
+    specify { critic.problems[file_name.to_s].size.should be 1 }
+    specify { critic.problems[file_name.to_s].first[:type].should == "max_code_lines_in_method" }
+    specify { critic.problems[file_name.to_s].first[:line].should be 1 }
+    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
+end

data/spec/functional/vertical_spacing_spec.rb

@@ -0,0 +1,35 @@
+require_relative '../spec_helper'
+require_relative '../support/vertical_spacing_cases'
+require 'tailor/critic'
+require 'tailor/configuration/style'
+
+describe "Vertical 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
+
+  V_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
+end

data/spec/support/bad_indentation_cases.rb

@@ -0,0 +1,265 @@
+#-------------------------------------------------------------------------------
+# INDENT_1 (1 problem)
+#-------------------------------------------------------------------------------
+INDENT_1 = {}
+
+INDENT_1[:class_indented_end] =
+  %Q{class MyClass
+ end}
+
+INDENT_1[:class_indented_single_statement] =
+  %Q{class MyClass
+   include Something
+end}
+
+INDENT_1[:class_indented_single_statement_trailing_comment] =
+  %Q{class MyClass
+   include Something     # comment
+end}
+
+INDENT_1[:class_outdented_single_statement] =
+  %Q{class MyClass
+ include Something
+end}
+
+INDENT_1[:def_indented_end] =
+  %Q{def a
+ end}
+
+INDENT_1[:def_content_indented_end] =
+  %Q{def a
+  puts "stuff"
+ end}
+
+INDENT_1[:class_def_content_outdented_end] =
+  %Q{class A
+  def a
+    puts "stuff"
+ end
+end}
+
+INDENT_1[:class_def_outdented_content] =
+  %Q{class A
+  def a
+   puts "stuff"
+  end
+end}
+
+INDENT_1[:class_method_def_using_self_outdented] =
+  %Q{class A
+ self.my_method
+    puts 'stuff'
+  end
+end}
+
+INDENT_1[:case_indented_whens_level] =
+  %Q{def my_method
+   case true
+  when true
+    puts "stuff"
+  when false
+    puts "blah blah"
+  end
+end}
+
+INDENT_1[:case_indented_whens_level_trailing_comment] =
+  %Q{def my_method
+   case true        # comment
+  when true
+    puts "stuff"
+  when false
+    puts "blah blah"
+  end
+end}
+
+INDENT_1[:case_outdented_whens_level] =
+  %Q{def my_method
+ case true
+  when true
+    puts "stuff"
+  when false
+    puts "blah blah"
+  end
+end}
+
+INDENT_1[:case_when_indented_whens_level] =
+  %Q{def my_method
+  case true
+   when true
+    puts "stuff"
+  when false
+    puts "blah blah"
+  end
+end}
+
+INDENT_1[:case_when_outdented_whens_level] =
+  %Q{def my_method
+  case true
+ when true
+    puts "stuff"
+  when false
+    puts "blah blah"
+  end
+end}
+
+INDENT_1[:case_indented_whens_in] =
+  %Q{def my_method
+   case true
+    when true
+      puts "stuff"
+    when false
+      puts "blah blah"
+  end
+end}
+
+INDENT_1[:while_do_indented] =
+  %Q{ while true do
+  puts "something"
+end}
+
+INDENT_1[:while_do_outdented] =
+  %Q{def my_method
+ while true do
+    puts "something"
+  end
+end}
+
+INDENT_1[:while_do_content_outdented] =
+  %Q{def my_method
+  while true do
+   puts "something"
+  end
+end}
+
+INDENT_1[:while_do_content_indented] =
+  %Q{def my_method
+  while true do
+     puts "something"
+  end
+end}
+
+INDENT_1[:while_do_indented2] =
+  %Q{i = 0;
+num = 5;
+
+ while i < num do
+  puts("Inside the loop i = \#{i}");
+  i +=1;
+end}
+
+INDENT_1[:while_do_indented2_trailing_comment] =
+  %Q{i = 0;
+num = 5;
+
+ while i < num do        # comment
+  puts("Inside the loop i = \#{i}");
+  i +=1;
+end}
+
+INDENT_1[:until_do_indented] =
+  %Q{i = 0;
+num = 5;
+
+ until i > num  do
+  puts("Inside the loop i = \#{i}");
+  i +=1;
+end}
+
+INDENT_1[:for_do_indented] =
+  %Q{ for i in 1..100 do
+  puts i
+end}
+
+INDENT_1[:loop_do_indented] =
+  %Q{ loop do
+  puts 'looping'
+end}
+
+INDENT_1[:if_line_indented] =
+  %Q{def a_method
+   if defined? Term::ANSIColor
+    message << %Q{#  \#{(i + 1).to_s.bold}.
+#    * position:  \#{position}
+#    * type:      \#{problem[:type].to_s.red}
+#    * message:   \#{problem[:message].red}
+}
+  else
+    message << %Q{#  \#{(i + 1)}.
+#    * position:  \#{position}
+#    * type:      \#{problem[:type]}
+#    * message:   \#{problem[:message]}
+}
+  end
+end}
+
+INDENT_1[:if_line_indented_trailing_comment] =
+  %Q{def a_method
+   if defined? Term::ANSIColor     # comment
+    message << %Q{#  \#{(i + 1).to_s.bold}.
+#    * position:  \#{position}
+#    * type:      \#{problem[:type].to_s.red}
+#    * message:   \#{problem[:message].red}
+}
+  else
+    message << %Q{#  \#{(i + 1)}.
+#    * position:  \#{position}
+#    * type:      \#{problem[:type]}
+#    * message:   \#{problem[:message]}
+}
+  end
+end}
+
+INDENT_1[:multi_line_tstring] =
+  %Q{INDENT_OK[:class] =
+%Q{class MyClass
+end}}
+
+#-------------------------------------------------------------------------------
+# Operators
+#-------------------------------------------------------------------------------
+INDENT_1[:multi_line_andop_first_line_indented] =
+  %Q{def end_of_multiline_string?(lexed_line_output)
+   lexed_line_output.any? { |e| e[1] == :on_tstring_end } &&
+    lexed_line_output.none? { |e| e[1] == :on_tstring_beg }
+end}
+
+INDENT_1[:multi_line_andop_first_line_indented_trailing_comment] =
+  %Q{def end_of_multiline_string?(lexed_line_output)
+   lexed_line_output.any? { |e| e[1] == :on_tstring_end } && # comment
+    lexed_line_output.none? { |e| e[1] == :on_tstring_beg }
+end}
+
+INDENT_1[:multi_line_andop_second_line_indented] =
+  %Q{def end_of_multiline_string?(lexed_line_output)
+  lexed_line_output.any? { |e| e[1] == :on_tstring_end } &&
+     lexed_line_output.none? { |e| e[1] == :on_tstring_beg }
+end}
+
+INDENT_1[:multi_line_string_concat_with_plus_out] =
+  %Q{DVR_SSDP_NOTIFICATION_TEMPLATE = File.dirname(__FILE__) +
+ '/profiles/DVR5000/ssdp_notification.erb'}
+
+INDENT_1[:multi_line_method_call_end_in] =
+  %Q{def initialize(raw_response)
+  if raw_response.nil? || raw_response.empty?
+    raise RTSP::Error,
+      "#{self.class} received nil string--this shouldn't happen."
+   end
+end}
+
+INDENT_1[:multi_line_method_call_ends_with_period_2nd_line_in] =
+  %Q{unless streamer == MulticastStreamer.instance
+  streamer.state = :DISCONNECTED
+  UnicastStreamer.pool << streamer unless UnicastStreamer.pool.
+     member? streamer
+end}
+
+INDENT_1[:multi_line_method_call_ends_with_many_periods_last_in] =
+  %Q{my_hashie.first_level.
+  second_level.
+    third_level}
+
+INDENT_1[:multi_line_method_call_ends_with_many_periods_last_in_trailing_comment] =
+  %Q{my_hashie.first_level.
+  second_level.
+    third_level  # comment}