tailor 0.0.3 → 0.1.0

data/spec/spacing/curly_brace_spacing_spec.rb

@@ -0,0 +1,258 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+require 'tailor/file_line'
+
+include Tailor
+
+describe Tailor::FileLine, "with curly braces" do
+  context "as a block" do
+    it "should be OK with 1 space before, 1 after {, 1 before }" do
+      line = create_file_line "  5.times { |num| puts num }", __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should detect 0 spaces before a {" do
+      line = create_file_line "  5.times{ |num| puts num }", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 0 spaces after a {" do
+      line = create_file_line "  5.times {|num| puts num }", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 0 spaces before and after a {" do
+      line = create_file_line "  5.times{|num| puts num }", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should be OK with 1 space around a }" do
+      line = create_file_line "  5.times { |num| puts num } ", __LINE__
+      line.spacing_problems.should == 1 # Trailing whitespace
+    end
+
+    it "should detect 0 spaces before a }" do
+      line = create_file_line "  5.times { |num| puts num}", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 0 spaces before & after {, before a }" do
+      line = create_file_line "  5.times{|num| puts num}", __LINE__
+      line.spacing_problems.should == 2
+    end
+
+    it "should detect >1 space after a {" do
+      line = create_file_line " 5.times {  |num| puts num }", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect >1 space before a {" do
+      line = create_file_line " 5.times  { |num| puts num }", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect >1 space before, no spaces after a {" do
+      line = create_file_line " 5.times  {|num| puts num }", __LINE__
+      line.spacing_problems.should == 2
+    end
+
+    it "should detect >1 space after, no spaces before a {" do
+      line = create_file_line " 5.times{  |num| puts num }", __LINE__
+      line.spacing_problems.should == 2
+    end
+
+    it "should detect >1 space before }" do
+      line = create_file_line " 5.times { |num| puts num  }", __LINE__
+      line.spacing_problems.should == 1
+    end
+  end
+
+  context "in Hashes" do
+    context "with symbol keys" do
+      it "should be OK when declaring a new Hash" do
+        line = create_file_line "  thing = {}", __LINE__
+        line.spacing_problems.should == 0
+      end
+
+      it "should be OK with 1 space before, 1 after {, 1 before }" do
+        line = create_file_line "  thing = { :one => 1 }", __LINE__
+        line.spacing_problems.should == 0
+      end
+
+      it "should be OK with proper spacing and a space at the end" do
+        line = create_file_line "  thing = { :one => 1 } ", __LINE__
+        line.spacing_problems.should == 1  # Trailing whitespace
+      end
+
+      it "should detect 0 spaces after {" do
+        line = create_file_line "  thing = {:one => 1 }", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 0 spaces before {" do
+        line = create_file_line "  thing ={ :one => 1 }", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 0 spaces before and after {" do
+        line = create_file_line "  thing ={:one => 1 }", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 0 spaces before }" do
+        line = create_file_line "  thing = { :one => 1}", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 0 spaces before and after { and }" do
+        line = create_file_line "  thing ={:one => 1}", __LINE__
+        line.spacing_problems.should == 2
+      end
+    end
+
+    context "with single-quote string keys" do
+      it "should be OK with 1 space before, 1 after {, 1 before }" do
+        line = create_file_line "  thing = { 'one' => 1 }", __LINE__
+        line.spacing_problems.should == 0
+      end
+
+      it "should be OK with proper spacing and a space at the end" do
+        line = create_file_line "  thing = { 'one' => 1 } ", __LINE__
+        line.spacing_problems.should == 1  # Trailing whitespace
+      end
+
+      it "should detect 0 spaces after {" do
+        line = create_file_line "  thing = {'one' => 1 }", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 0 spaces before {" do
+        line = create_file_line "  thing ={ 'one' => 1 }", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 0 spaces before and after {" do
+        line = create_file_line "  thing ={'one' => 1 }", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 0 spaces before }" do
+        line = create_file_line "  thing = { 'one' => 1}", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 0 spaces before and after { and }" do
+        line = create_file_line "  thing ={'one' => 1}", __LINE__
+        line.spacing_problems.should == 2
+      end
+    end
+
+    context "with double-quote string keys" do
+      it "should be OK with 1 space before, 1 after {, 1 before }" do
+        line = create_file_line "  thing = { \"one\" => 1 }", __LINE__
+        line.spacing_problems.should == 0
+      end
+
+      it "should be OK with proper spacing and a space at the end" do
+        line = create_file_line "  thing = { \"one\" => 1 } ", __LINE__
+        line.spacing_problems.should == 1  # Trailing whitespace
+      end
+
+      it "should detect 0 spaces after {" do
+        line = create_file_line "  thing = {\"one\" => 1 }", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 0 spaces before {" do
+        line = create_file_line "  thing ={ \"one\" => 1 }", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 0 spaces before and after {" do
+        line = create_file_line "  thing ={\"one\" => 1 }", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 0 spaces before }" do
+        line = create_file_line "  thing = { \"one\" => 1}", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 0 spaces before and after { and }" do
+        line = create_file_line "  thing ={\"one\" => 1}", __LINE__
+        line.spacing_problems.should == 2
+      end
+    end
+
+    context "with string substituted value" do
+      before do
+        @value = 1
+      end
+
+      it "should be OK with 1 space before, 1 after {, 1 before }" do
+        line = create_file_line "  thing = { \"one\" => \"#{@value}\" }", __LINE__
+        line.spacing_problems.should == 0
+      end
+
+      it "should be OK with proper spacing and a space at the end" do
+        line = create_file_line "  thing = { \"one\" => \"#{@value}\" } ", __LINE__
+        line.spacing_problems.should == 1  # Trailing whitespace
+      end
+
+      it "should detect 0 spaces after {" do
+        line = create_file_line "  thing = {\"one\" => \"#{@value}\" }", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 0 spaces before {" do
+        line = create_file_line "  thing ={ \"one\" => \"#{@value}\" }", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 0 spaces before and after {" do
+        line = create_file_line "  thing ={\"one\" => \"#{@value}\" }", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 0 spaces before }" do
+        line = create_file_line "  thing = { \"one\" => \"#{@value}\"}", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 0 spaces before and after { and }" do
+        line = create_file_line "  thing ={\"one\" => \"#{@value}\"}", __LINE__
+        line.spacing_problems.should == 2
+      end
+
+      it "should detect 0 spaces after { and  before }" do
+        line = create_file_line "thing = {'id'=>\"#{@value}\", " +
+          "'attributes' => { 'friendly-name' => \"#{@value}\"}}",
+          __LINE__
+        line.spacing_problems.should == 2
+      end
+    end
+  end
+
+  context "in Strings" do
+    it "should be OK when substituting a variable" do
+      thing = ""
+      line = create_file_line "  a_string = \"This is a #{thing}\"", __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should be OK when substituting a method call" do
+      line = create_file_line "  a_string = \"This has #{Class.methods}\"", __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should be OK when substituting in a heredoc" do
+      line = create_file_line "#{Class.methods}", __LINE__
+      line.spacing_problems.should == 0
+    end
+  end
+
+  it "should be OK when used as default params in a method definition" do
+    thing = ""
+    line = create_file_line "def a_method one={}", __LINE__
+    line.spacing_problems.should == 0
+  end
+end

data/spec/spacing/parentheses_spacing_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+require 'tailor/file_line'
+
+include Tailor
+
+describe Tailor::FileLine, "spacing around parentheses" do
+  context "in a method" do
+    it "should be OK with no space before ) and none after (" do
+      line = create_file_line "  def do_something(that, this)", __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should be OK with no parameters" do
+      line = create_file_line "  def do_something()", __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should detect a space after (" do
+      line = create_file_line "  def do_something( that, this)", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect a space before )" do
+      line = create_file_line "  def do_something(that, this )", __LINE__
+      line.spacing_problems.should == 1
+    end
+  end
+end

data/spec/spacing/square_bracket_spacing_spec.rb

@@ -0,0 +1,116 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+require 'tailor/file_line'
+
+include Tailor
+
+describe Tailor::FileLine, "with square brackets" do
+  context "in an Array" do
+    context "with 0 elements" do
+      it "should be OK with 0 spaces" do
+        line = create_file_line "bobo = []", __LINE__
+        line.spacing_problems.should == 0
+      end
+
+      it "should detect 1 space after [" do
+        line = create_file_line "bobo = [ ]", __LINE__
+        line.spacing_problems.should == 2 # 1 after, 1 before
+      end
+    end
+
+    context "when assigning elements" do
+      it "should be OK with 0 spaces" do
+        line = create_file_line "bobo = ['clown']", __LINE__
+        line.spacing_problems.should == 0
+      end
+
+      it "should be OK when beginning of multi-line array" do
+        line = create_file_line "  bobo = [", __LINE__
+        line.spacing_problems.should == 0
+      end
+
+      it "should be OK when end of multi-line array" do
+        line = create_file_line "  ]", __LINE__
+        line.spacing_problems.should == 0
+      end
+
+      it "should detect 1 space after [" do
+        line = create_file_line "bobo = [ 'clown']", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 1 space before ]" do
+        line = create_file_line "bobo = ['clown' ]", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 1 space after [ and 1 before ]" do
+        line = create_file_line "bobo = [ 'clown' ]", __LINE__
+        line.spacing_problems.should == 2
+      end
+    end
+
+    context "when referencing elements" do
+      it "should be OK with 0 spaces" do
+        line = create_file_line "bobo['clown']", __LINE__
+        line.spacing_problems.should == 0
+      end
+
+      it "should detect 1 space after [" do
+        line = create_file_line "bobo[ 'clown']", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 1 space before [" do
+        line = create_file_line "bobo ['clown']", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 1 space before ]" do
+        line = create_file_line "bobo['clown' ]", __LINE__
+        line.spacing_problems.should == 1
+      end
+
+      it "should detect 1 space after [ and 1 before ]" do
+        line = create_file_line "bobo[ 'clown' ]", __LINE__
+        line.spacing_problems.should == 2
+      end
+
+      it "should detect 1 space before and after [ and 1 before ]" do
+        line = create_file_line "bobo [ 'clown' ]", __LINE__
+        line.spacing_problems.should == 2
+      end
+    end
+  end
+
+  context "in Hash references" do
+    it "should be OK with 0 spaces" do
+      line = create_file_line "bobo[:clown]", __LINE__
+      line.spacing_problems.should == 0
+    end
+
+    it "should detect 1 space after [" do
+      line = create_file_line "bobo[ :clown]", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 1 space before [" do
+      line = create_file_line "bobo [:clown]", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 1 space before ]" do
+      line = create_file_line "bobo[:clown ]", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should detect 1 space after [ and 1 before ]" do
+      line = create_file_line "bobo[ :clown ]", __LINE__
+      line.spacing_problems.should == 2
+    end
+
+    it "should detect 1 space before and after [ and 1 before ]" do
+      line = create_file_line "bobo [ :clown ]", __LINE__
+      line.spacing_problems.should == 2
+    end
+  end
+end

data/spec/spacing_spec.rb

@@ -0,0 +1,167 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'tailor/file_line'
+require 'pathname'
+
+include Tailor
+
+describe Tailor::FileLine do
+
+# Commenting out until we fix the whitespace count problem
+=begin
+  it "should detect the number of trailing whitespace(s)" do
+    line = create_file_line "  puts 'This is a line.'  \n", __LINE__
+    line.trailing_whitespace_count.should == 2
+  end
+=end
+  
+=begin
+  describe "with operators" do
+    Tailor::OPERATORS.each_pair do |op_group, op_values|
+      op_values.each do |op|
+        context "#no_space_after?" do
+          it "should detect 0 spaces around a #{op} sign" do
+            line = create_file_line "  1#{op}1", __LINE__
+            line.no_space_after?(op).should be_true
+          end
+
+          it "should be OK with 0 spaces before but 1 space after a #{op} sign" do
+            line = create_file_line "  1#{op} 1", __LINE__
+            line.no_space_after?(op).should be_false
+          end
+
+          it "should report 0 spaces after a #{op} sign" do
+            line = create_file_line "  1 #{op}1", __LINE__
+            line.no_space_after?(op).should be_true
+          end
+
+          it "should be OK with 1 space around a #{op} sign" do
+            line = create_file_line "  1 #{op} 1", __LINE__
+            line.no_space_after?(op).should be_false
+          end
+
+          it "should be OK an #{op} sign isn't in the string" do
+            line = create_file_line "  1 plus 1", __LINE__
+            line.no_space_after?(op).should be_false
+          end
+        end
+
+        context "#spaces_after" do
+          it "should report 0 spaces after a #{op} sign" do
+            line = create_file_line "  1 #{op}1", __LINE__
+            line.spaces_after(op).first.should == 0
+          end
+
+          it "should report 1 space after a #{op} sign" do
+            line = create_file_line "  1 #{op} 1", __LINE__
+            line.spaces_after(op).first.should == 1
+          end
+        end
+        
+        context "#no_space_before?" do
+          it "should detect 0 spaces around a #{op} sign" do
+            line = create_file_line "  1#{op}1", __LINE__
+            line.no_space_before?(op).should be_true
+          end
+
+          it "should be OK with 0 spaces after but 1 space before a #{op} sign" do
+            line = create_file_line "  1 #{op}1", __LINE__
+            line.no_space_before?(op).should be_false
+          end
+
+          it "should report 0 spaces before a #{op} sign" do
+            line = create_file_line "  1#{op} 1", __LINE__
+            line.no_space_before?(op).should be_true
+          end
+
+          it "should be OK with 1 space around a #{op} sign" do
+            line = create_file_line "  1 #{op} 1", __LINE__
+            line.no_space_before?(op).should be_false
+          end
+
+          it "should be OK an #{op} sign isn't in the string" do
+            line = create_file_line "  1 plus 1", __LINE__
+            line.no_space_before?(op).should be_false
+          end
+        end
+
+        context "#spaces_before" do
+          it "should report 0 spaces before a #{op} sign" do
+            line = create_file_line "  1#{op} 1", __LINE__
+            line.spaces_before(op).first.should == 0
+          end
+
+          it "should report 1 space before a #{op} sign" do
+            line = create_file_line "  1 #{op} 1", __LINE__
+            line.spaces_before(op).first.should == 1
+          end
+        end
+
+        context "#word_is_in_string?" do
+          it "should report that the #{op} is in a string" do
+            line = create_file_line "'  1 #{op} 1'", __LINE__
+            line.word_is_in_string?(op).should be_true
+          end
+
+          it "should report that the #{op} is NOT in a string" do
+            line = create_file_line "  1 #{op} 1", __LINE__
+            line.word_is_in_string?(op).should be_false
+          end
+        end
+
+        context "#word_is_in_regexp?" do
+          it "should report that the #{op} is in a Regexp" do
+            line = create_file_line "/\\" + op + "$/", __LINE__
+            line.word_is_in_regexp?(op).should be_true
+          end
+
+          it "should report that the #{op} is NOT in a Regexp" do
+            line = create_file_line "\\" + op + "$", __LINE__
+            line.word_is_in_regexp?(op).should be_false
+          end
+        end
+      end
+    end
+
+    it "should be OK if the line is a method with a ?" do
+      line = create_file_line "  def hungry?", __LINE__
+      line.question_mark_method?.should be_true
+      line.no_space_before?('?').should be_false
+    end
+
+    it "should be OK if the line is a known method with a ?" do
+      line = create_file_line "  'string'.include?(thing)", __LINE__
+      line.question_mark_method?.should be_true
+      line.no_space_before?('?').should be_false
+    end
+  end
+=end
+
+  context "question marks" do
+    it "should detect a word with a ?" do
+      line = create_file_line "  thing.nil?", __LINE__
+      line.question_mark_method?.should be_true
+    end
+
+    it "should skip a word without a ?" do
+      line = create_file_line "  thing.strip!", __LINE__
+      line.question_mark_method?.should be_false
+    end
+  end
+
+  context "indenting by hardtabs" do
+    it "should find when indented by 1 hard tab" do
+      line = create_file_line "\tdef do_something", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should find when indented with a space and 1 hard tab" do
+      line = create_file_line " \tdef do_something", __LINE__
+      line.spacing_problems.should == 1
+    end
+
+    it "should be OK when the line is not indented" do
+      line = create_file_line "def do_something", __LINE__
+      line.spacing_problems.should == 0
+    end
+  end
+end