tailor 0.0.3 → 0.1.0

data/spec/indentation_spec.rb

@@ -0,0 +1,259 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'tailor/file_line'
+require 'pathname'
+
+include Tailor
+
+def strip_regex regexp
+  original_regexp = regexp.source
+
+  case original_regexp
+  when /\\b\w+\\b/
+    return original_regexp.gsub!("\\b", '')
+  when /\w+{2,}/
+    return original_regexp.scan(/\w+{2,}/).first
+  when /\\\{\[/
+    return '{'
+  when /\*\\\}/
+    return '}'
+  when /\\\[\[/
+    return '['
+  when /\*\\\]/
+    return ']'
+  end
+end
+
+describe Tailor::Indentation do
+  include Tailor::Indentation
+  
+  context "should return the number of leading spaces in a line" do
+    it "when the line is not indented" do
+      line = create_file_line "def do_something", __LINE__
+      line.indented_spaces.should == 0
+    end
+
+    it "when the line is indented 1 space" do
+      line = create_file_line " def do_something", __LINE__
+      line.indented_spaces.should == 1
+    end
+
+    it "when the line is indented 1 space and a hard tab" do
+      line = create_file_line " \tdef do_something", __LINE__
+      line.indented_spaces.should == 1
+    end
+  end
+
+  context "should know what level of indentation a line is at" do
+    context "for indent expressions" do
+      INDENT_EXPRESSIONS.each do |regexp|
+        expression = strip_regex(regexp)
+
+        it "when the '#{expression }' line is not indented" do
+          line = create_file_line "#{expression}", __LINE__
+          line.is_at_level.should == 0.0
+        end
+
+        it "when the '#{expression}' line is indented only 1 space" do
+          line = create_file_line " #{expression}", __LINE__
+          line.is_at_level.should == 0.5
+        end
+
+        it "when the '#{expression}' line is indented 2 spaces" do
+          line = create_file_line "  #{expression}", __LINE__
+          line.is_at_level.should == 1.0
+        end
+      end
+    end
+
+    context "for outdent expressions" do
+      OUTDENT_EXPRESSIONS.each do |regexp|
+        expression = strip_regex(regexp)
+
+        it "when the '#{expression }' line is not indented" do
+          line = create_file_line "#{expression}", __LINE__
+          line.is_at_level.should == 0.0
+        end
+
+        it "when the '#{expression}' line is indented only 1 space" do
+          line = create_file_line " #{expression}", __LINE__
+          line.is_at_level.should == 0.5
+        end
+
+        it "when the '#{expression}' line is indented 2 spaces" do
+          line = create_file_line "  #{expression}", __LINE__
+          line.is_at_level.should == 1.0
+        end
+      end
+    end
+
+    context "for end expressions" do
+      END_EXPRESSIONS.each do |regexp|
+        expression = strip_regex(regexp)
+
+        it "when the '#{expression }' line is not indented" do
+          line = create_file_line "#{expression}", __LINE__
+          line.is_at_level.should == 0.0
+        end
+
+        it "when the '#{expression}' line is indented only 1 space" do
+          line = create_file_line " #{expression}", __LINE__
+          line.is_at_level.should == 0.5
+        end
+
+        it "when the '#{expression}' line is indented 2 spaces" do
+          line = create_file_line "  #{expression}", __LINE__
+          line.is_at_level.should == 1.0
+        end
+      end
+    end
+  end
+
+  context "#indent?" do
+    INDENT_EXPRESSIONS.each do |regexp|
+      expression = strip_regex(regexp)
+
+      it "should return true if the line contains #{expression}" do
+        line = create_file_line "#{expression}", __LINE__
+        line.indent?.should be_true
+      end
+    end
+  end
+
+  context "#outdent?" do
+    OUTDENT_EXPRESSIONS.each do |regexp|
+      expression = strip_regex(regexp)
+
+      it "should return true if the line contains #{expression}" do
+        line = create_file_line "#{expression}", __LINE__
+        line.outdent?.should be_true
+      end
+    end
+  end
+
+  context "#contains_end?" do
+    END_EXPRESSIONS.each do |regexp|
+      expression = strip_regex(regexp)
+
+      it "should return true if the line contains #{expression}" do
+        line = create_file_line "#{expression}", __LINE__
+        line.contains_end?.should be_true
+      end
+    end
+  end
+  
+  context "#at_improper_level?" do
+    it "should return true if the line is at the wrong level" do
+      proper_level = 1.0
+      line = create_file_line "class SomeClass", __LINE__
+      line.at_improper_level?(proper_level).should be_true
+    end
+
+    it "should return false if the line is at the right level" do
+      proper_level = 0.0
+      line = create_file_line "class SomeClass", __LINE__
+      line.at_improper_level?(proper_level).should be_false
+    end
+  end
+
+  context "#ends_with_operator?" do
+    OPERATORS.each_pair do |op_family, op_values|
+      op_values.each do |op|
+        it "should return true if the line ends with a #{op}" do
+          line = create_file_line "1 #{op}", __LINE__
+          line.ends_with_operator?.should be_true
+        end
+
+        it "should return true if the line ends with a #{op} plus spaces" do
+          line = create_file_line "1 #{op}  ", __LINE__
+          line.ends_with_operator?.should be_true
+        end
+
+        it "should return true if the line ends with a #{op} plus tabs" do
+          line = create_file_line "1 #{op}\t\t", __LINE__
+          line.ends_with_operator?.should be_true
+        end
+
+        it "should return true if the line only has spaces plus a #{op}" do
+          line = create_file_line "    #{op}", __LINE__
+          line.ends_with_operator?.should be_true
+        end
+      end
+    end
+
+    it "should return false if the line doesn't contain an operator" do
+      line = create_file_line "  def some_method(thing)", __LINE__
+      line.ends_with_operator?.should be_false
+    end
+  end
+
+  context "#ends_with_comma?" do
+    it "should return true if it ends with a ," do
+      line = create_file_line "  def some_method(thing,", __LINE__
+      line.ends_with_comma?.should be_true
+    end
+
+    it "should return true if it ends with a , and spaces" do
+      line = create_file_line "  def some_method(thing,  ", __LINE__
+      line.ends_with_comma?.should be_true
+    end
+
+    it "should return true if it ends with a , and tabs" do
+      line = create_file_line "  def some_method(thing,\t", __LINE__
+      line.ends_with_comma?.should be_true
+    end
+
+    it "should return false if it doesn't end with a ," do
+      line = create_file_line "  def some_method(thing)", __LINE__
+      line.ends_with_comma?.should be_false
+    end
+
+    it "should return false if it has a , but doesn't end with one" do
+      line = create_file_line "  def some_method(thing, other)", __LINE__
+      line.ends_with_comma?.should be_false
+    end
+  end
+
+  context "#ends_with_backslash?" do
+    it "should return true if it ends with a \\" do
+      line = create_file_line "  def some_method(thing,\\", __LINE__
+      line.ends_with_backslash?.should be_true
+    end
+
+    it "should return true if it ends with a \\ and spaces" do
+      line = create_file_line "  def some_method(thing,\\  ", __LINE__
+      line.ends_with_backslash?.should be_true
+    end
+
+    it "should return true if it ends with a \\ and tabs" do
+      line = create_file_line "  def some_method(thing,\\\t", __LINE__
+      line.ends_with_backslash?.should be_true
+    end
+
+    it "should return false if it doesn't end with a \\" do
+      line = create_file_line "  def some_method(thing)", __LINE__
+      line.ends_with_backslash?.should be_false
+    end
+  end
+
+  context "#unclosed_parenthesis?" do
+    it "should return true if it has a ( but no )" do
+      line = create_file_line "  def some_method(thing,", __LINE__
+      line.unclosed_parenthesis?.should be_true
+    end
+
+    it "should return true if it has a ( but no ) and spaces" do
+      line = create_file_line "  def some_method(thing,  ", __LINE__
+      line.unclosed_parenthesis?.should be_true
+    end
+
+    it "should return true if it has a ( but no ) and tabs" do
+      line = create_file_line "  def some_method(thing,\t\t", __LINE__
+      line.unclosed_parenthesis?.should be_true
+    end
+
+    it "should return false if it has a ( and a )" do
+      line = create_file_line "  def some_method(thing)", __LINE__
+      line.unclosed_parenthesis?.should be_false
+    end
+  end
+end

data/spec/spacing/colon_spacing_spec.rb

@@ -0,0 +1,71 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+require 'tailor/file_line'
+
+include Tailor
+
+describe Tailor::FileLine, "spacing around colons" do
+  context "in ternary statments" do
+    it "should be OK with 1 space around colon" do
+      line = create_file_line "  bobo = true ? true : false", __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should detect 0 space after colon" do
+      line = create_file_line "  bobo = true ? true :false", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 0 space before colon" do
+      line = create_file_line "  bobo = true ? true: false", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 0 space before and after colon" do
+      line = create_file_line "  bobo = true ? true:false", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 2 spaces after colon" do
+      line = create_file_line "  bobo = true ? true :  false", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 2 spaces before colon" do
+      line = create_file_line "  bobo = true ? true  : false", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 2 spaces before and after colon" do
+      line = create_file_line "  bobo = true ? true  :  false", __LINE__
+      line.spacing_problems.should == 1
+    end
+  end
+
+  context "in symbols" do
+    it "should be OK with 1 space before" do
+      line = create_file_line "  bobo = { :thing => :clown }", __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should be OK when Hash key, method with ? and symbol" do
+      line = create_file_line "  bobo[:thing].eql? :clown", __LINE__
+      line.spacing_problems.should == 0
+    end
+  end
+
+  it "should be OK in namespace operators" do
+    line = create_file_line "bobo[:thing] == :dog ? bobo[:thing] : Class::String",
+      __LINE__
+    line.spacing_problems.should == 0
+  end
+
+  it "should be OK in Regexp classes" do
+    line = create_file_line "bobo[:thing].scan(/[:alpha:]/)", __LINE__
+    line.spacing_problems.should == 0
+  end
+
+  it "should be OK in setting the global load path" do
+    line = create_file_line "$:.unshift File.dirname(__FILE__)", __LINE__
+    line.spacing_problems.should == 0
+  end
+end

data/spec/spacing/comma_spacing_spec.rb

@@ -0,0 +1,159 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+require 'tailor/file_line'
+
+include Tailor
+
+describe Tailor::FileLine, "spacing around commas" do
+  it "should be OK when followed by a \\ to signify line-continue" do
+    line = create_file_line "string = 'One, two, three,'\\", __LINE__
+    line.spacing_problems.should == 0
+  end
+
+  context "in a method line" do
+    it "should be OK when no commas" do
+      line = create_file_line "  def do_something this", __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should be OK when 0 spaces before and 1 space after a comma" do
+      line = create_file_line "  def do_something this, that", __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should detect 2 spaces after a comma" do
+      line = create_file_line "  def do_something this,  that", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 0 spaces after a comma" do
+      line = create_file_line "  def do_something this,that", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 1 space before a comma" do
+      line = create_file_line "  def do_something this , that", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 1 space before a comma and 0 spaces after" do
+      line = create_file_line "  def do_something this ,that", __LINE__
+      line.spacing_problems.should == 2
+    end
+  end
+
+  context "in a comment line" do
+    it "should be OK when no commas" do
+      line = create_file_line "  # Comment line", __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should be OK when 1 space after a comma" do
+      line = create_file_line "  # Comment line, and stuff", __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should detect 2 spaces after a comma" do
+      line = create_file_line "  # Comment line,  and stuff", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 0 spaces after a comma" do
+      line = create_file_line "  # Comment line,and stuff", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 1 space before a comma" do
+      line = create_file_line "  # Comment line , and stuff", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 1 space before a comma and 0 spaces after" do
+      line = create_file_line "  # Comment line ,and stuff", __LINE__
+      line.spacing_problems.should == 2
+    end
+
+    it "should be OK when 0 spaces after a comma, but end of the line" do
+      line = create_file_line "  # This is a comment that,\n", __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should detect 2 spaces after a comma when at the end of a line" do
+      line = create_file_line "  # This is a comment that,  \n", __LINE__
+      line.spacing_problems.should == 1   # 1 for whitespace
+    end
+
+    it "should detect 2 spaces after a comma" do
+      line = create_file_line "  # This is a comment that,  meows", __LINE__
+      line.spacing_problems.should == 1
+    end
+  end
+
+  context "in a statement with an Array" do
+    it "should be OK when no commas" do
+      line = create_file_line "  bobo = ['hi']", __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should be OK when 1 space after a comma" do
+      line = create_file_line "  bobo = ['hi', 'meow']", __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should detect 2 spaces after a comma" do
+      line = create_file_line "  bobo = ['hi',  'meow']", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 0 spaces after a comma" do
+      line = create_file_line "  bobo = ['hi','meow']", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 1 space before a comma" do
+      line = create_file_line "  bobo = ['hi' , 'meow']", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 1 space before a comma and 0 spaces after" do
+      line = create_file_line "  bobo = ['hi' ,'meow']", __LINE__
+      line.spacing_problems.should == 2
+    end
+  end
+
+  context "in a statement with a Hash" do
+    it "should be OK when no commas" do
+      line = create_file_line "bobo = { :hi => 'meow' }", __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should be OK when 1 space after a comma" do
+      line = create_file_line "bobo = { :hi => 'meow', :bye => 'meow' }",
+        __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should detect 2 spaces after a comma" do
+      line = create_file_line "bobo = { :hi => 'meow',  :bye => 'meow' }",
+        __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 0 spaces after a comma" do
+      line = create_file_line "bobo = { :hi => 'meow',:bye => 'meow' }",
+        __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 1 space before a comma" do
+      line = create_file_line "bobo = { :hi => 'meow' , :bye => 'meow' }",
+        __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 1 space before a comma and 0 spaces after" do
+      line = create_file_line "bobo = { :hi => 'meow' ,:bye => 'meow' }",
+        __LINE__
+      line.spacing_problems.should == 2
+    end
+  end
+end