tailor 0.0.3 → 0.1.0

data/features/step_definitions/spacing/commas_steps.rb

@@ -0,0 +1,14 @@
+Given /^a file with (\d+) spaces? after a comma in a:$/ do |arg1, table|
+  # table is a Cucumber::Ast::Table
+  pending # express the regexp above with the code you wish you had
+end
+
+Given /^a file with more than (\d+) spaces before a comma in a:$/ do |arg1, table|
+  # table is a Cucumber::Ast::Table
+  pending # express the regexp above with the code you wish you had
+end
+
+Given /^a file with (\d+) spaces before a comma in a:$/ do |arg1, table|
+  # table is a Cucumber::Ast::Table
+  pending # express the regexp above with the code you wish you had
+end

data/features/step_definitions/spacing_steps.rb

@@ -1,18 +1,5 @@
-$:.unshift(File.dirname(__FILE__) + '/../../lib')
-require 'tailor/indentation_checker'
 require 'tailor/file_line'
 
-include Tailor
-include Tailor::IndentationChecker
-
-def check_file
-  ruby_source = File.open(@file_list[0], 'r')
-
-  ruby_source.each_line do |line|
-    yield(line)
-  end
-end
-
 def check_spacing method_name, line_type
   is_line_type = false
   bad_spacing = false
@@ -56,17 +43,6 @@ Given /^that file contains lines with hard tabs$/ do
   contains_hard_tabs.should be_true
 end
 
-Given /^that file does not contain any "([^\"]*)" statements$/ do |keyword|
-  ruby_source = File.open(@file_list[0], 'r')
-
-  count = count_keywords(ruby_source, keyword)
-  count.should == 0
-end
-
-Given /^that file is indented properly$/ do
-  pending
-end
-
 Given /^that file contains lines with trailing whitespace$/ do
   line_number = 1
 
@@ -128,13 +104,6 @@ Given /^that file contains a "([^\"]*)" line with spaces after an open parenthes
   check_spacing("space_before_closed_parenthesis?", line_type)
 end
 
-#-----------------------------------------------------------------------------
-# "When" statements
-#-----------------------------------------------------------------------------
-When "I run the checker on the project" do
-  @result = `#{@tailor} #{@project_dir}`
-end
-
 #-----------------------------------------------------------------------------
 # "Then" statements
 #-----------------------------------------------------------------------------
@@ -142,16 +111,12 @@ Then /^the checker should tell me each line that has a hard tab$/ do
   @result.should include("Line contains hard tabs")
 end
 
-Then "the checker should tell me my indentation is OK" do
-  pending
-end
-
 Then /^the checker should tell me each line has trailing whitespace$/ do
   @result.should include("Line contains #{@whitespace_count} trailing whitespace(s)")
 end
 
 Then /^the checker should tell me each line is too long$/ do
-  message = "Line is greater than #{Tailor::FileLine::LINE_LENGTH_MAX} characters"
+  message = "Line is >#{Tailor::FileLine::LINE_LENGTH_MAX} characters"
   @result.should include(message)
 end
 

data/features/support/1_file_with_bad_comma_spacing/bad_comma_spacing.rb

@@ -1,5 +1,43 @@
-# This is a sample which ,when checked,should show bad-comma errors. Comma errors,  
-# and stuff,   make source difficult to read!
-def do_something this ,that,  other
-  puts "We ,I mean I,am doing,  er, something!"
-end
+# Perfect spacing after a comma, in comment and method
+def do_something this, that, other
+  puts "We, I mean I, am doing, er, something!"
+end
+
+# More than one space,  after a comma,  in a comment & method
+def do_something this,  that,   other
+  puts "We,  I mean I,  am doing,  er, something!"
+end
+
+# No space,after a comma,in a comment & method
+def do_something this,that,other
+  puts "We,I mean I ,am doing,er   ,something!"
+end
+
+# Spaces , before a comma ,in a comment & method
+def do_something this , that ,other
+  puts "We , I mean I ,am doing ,er   , something!"
+end
+
+# Perfect spacing around a comma, in an array
+thing = [ 1,  2,  3 ]
+
+# More than one space, after elements in an array
+thing = [ 1,  2,  3 ]
+
+# No space, after elements in an array
+thing = [ 1,2,3 ]
+
+# Spaces, before elements in an array
+thing = [ 1 , 2  ,3 ]
+
+# Perfect spacing around a comma, in a hash
+thing = { :one => 1, :two => 2, :three => 3 }
+
+# More than one space, after elements in a hash
+thing = { :one => 1,  :two => 2,   :three => 3 }
+
+# No space, after elements in an array
+thing = { :one => 1,:two => 2,:three => 3 }
+
+# Spaces, before elements in an array
+thing = { :one => 1 , :two => 2  , :three => 3 }

data/features/support/1_file_with_bad_curly_brace_spacing/bad_curly_brace_spacing.rb

@@ -0,0 +1,60 @@
+# Blocks...
+# No space after {
+1..10.times {|number| puts number }
+
+# No space before {
+1..10.times{ |number| puts number }
+
+# No space before or after {
+1..10.times{|number| puts number }
+
+# No space before }
+1..10.times { |number| puts number}
+
+# No space before or after { and }
+1..10.times{|number| puts number}
+
+# >1 space before {
+1..10.times  { |number| puts number }
+
+# >1 space after {
+1..10.times {  |number| puts number }
+
+# >1 space before, no spaces after {
+1..10.times  {|number| puts number }
+
+# >1 space after, no spaces before {
+1..10.times{  |number| puts number }
+
+# >1 space before }
+1..10.times { |number| puts number  }
+
+# Perfect
+1..10.times { |number| puts number }
+
+
+# Hashes...
+# No space after {
+thing = {:one => 1 }
+
+# No space before {
+thing ={ :one => 1 }
+
+# No space before or after {
+thing ={:one => 1 }
+
+# No space before }
+thing = { :one => 1}
+
+# No space before or after { and }
+thing ={:one => 1}
+
+# Perfect
+thing = { :one => 1 }
+
+# Skip on default params in methods...
+def a_method; one={}; end;
+
+# Skip on strings...
+a_string = "This is a #{thing}..."
+b_string = "This has #{Class.methods}"

data/features/support/1_file_with_bad_operator_spacing/bad_op_spacing.rb

@@ -0,0 +1,31 @@
+# Comment with a +
+# Comment with a -
+# Comment with a *
+# Comment with a /
+# Comment with a =
+# Comment with a +=
+# Comment with a -=
+# Comment with a *=
+# Comment with a /=
+# Comment with a %=
+# Comment with a **=
+# Comment with a ||=
+# Comment with a &&=
+# Comment with a ==
+# Comment with a ===
+# Comment with a !=
+# Comment with a >
+# Comment with a <
+# Comment with a >=
+# Comment with a <=
+# Comment with a <=>
+# Comment with a &&
+# Comment with a ||
+# Comment with a ?
+# Comment with a :
+# Comment with a =~
+
+class BadOps
+  def +@
+  end
+end

data/features/support/1_file_with_bad_parenthesis/bad_parenthesis.rb

@@ -1,6 +1,4 @@
-# This is a comment; this should get caught: ( me, you )
-# This is a comment; this should also get caught: [ us, them ]
+# Spaces after open and before closed parentheses in a comment: ( me, you )
 def do_something( hello, and_hi=[ "me", "you" ] )
-  test = [ "one", "two" ]
   File.expand_path( File.dirname (__FILE__) )
 end

data/features/support/1_file_with_bad_square_brackets/bad_square_brackets.rb

@@ -0,0 +1,62 @@
+# Arrays...
+# Perfect
+thing = []
+
+# 1 space after [
+thing = [ ]
+
+# Perfect with element
+one = 'won'
+thing = [one]
+
+# 1 space after [ with element
+thing = [ one]
+
+# 1 space before ] with element
+thing = [one ]
+
+# 1 space before and after [ and ]
+thing = [ one ]
+
+# Perfect element reference
+thing[0]
+
+# 1 space after [ with element reference
+thing[ 0]
+
+# 1 space before [ with element reference
+thing [0]
+
+# 1 space before ] with element reference
+thing[0 ]
+
+# Pefect multi-line
+two = 'too'
+thing = [
+  one,
+  two
+]
+
+# Perfect multi-line, indented
+def thing
+  a_thing = [
+    one,
+    two
+  ]
+end
+
+
+# Hash references...
+thing = { :one => 1 }
+
+# Perfect element reference
+thing[:one]
+
+# 1 space after [ with element reference
+thing[ :one]
+
+# 1 space before [ with element reference
+thing [:one]
+
+# 1 space before ] with element reference
+thing[:one ]

data/features/support/1_file_with_bad_ternary_colon_spacing/bad_ternary_colon_spacing.rb

@@ -0,0 +1,31 @@
+# Perfect spacing around ternary colon
+bobo = true ? true : false
+
+# No space after ternary colon
+bobo = true ? true :false
+
+# No space before ternary colon
+bobo = true ? true: false
+
+# No space before or after ternary colon
+bobo = true ? true:false
+
+# 2 spaces after ternary colon
+bobo = true ? true :  false
+
+# 2 spaces before ternary colon
+bobo = true ? true  : false
+
+# Skip when colon is part of a symbol or namespace operator
+bobo = { :thing => ":clown" }
+bobo[:thing] == :dog ? bobo[:thing] : Math::PI
+
+# Skip when colon is part of Regexp class
+bobo[:thing].scan(/[:alpha:]/)
+
+# Skip when setting load path
+$:.unshift File.dirname(__FILE__)
+
+# Skip when question mark method is followed by a symbol
+if bobo[:thing].eql? :clown
+end

data/features/support/1_good_simple_file/simple_project.rb

@@ -0,0 +1,5 @@
+class Something
+  def a_method
+    puts "hi"
+  end
+end

data/features/support/1_long_file_with_indentation/my_project.rb

@@ -0,0 +1,56 @@
+# This file contains 1 method, no class, and is properly indented
+#   in order to test a related scenario.
+module MyModule
+
+  # This is a class!
+  class AnotherThing
+
+    # This is a method!
+    def a_method
+      case
+      when 1
+        1..10.each { |num| puts num }
+      when 2
+      else
+        while false
+          # Don't do anything
+          # And stuff
+          "meow".scan(/woem/)
+          array = [1 ,2 ,3]
+          other_thing = [
+            4,
+            5,
+            6
+          ]
+        end
+      end
+
+      an_array = Array.new
+      a_hash = Hash.new
+
+      # This is another comment
+      an_array = [1, 2, 3]
+      a_hash = {
+        :one => 1,
+        :two => 2
+      }
+
+      if true
+        # Let's return!
+        return true
+      elsif false
+        return false
+      else
+        return nil
+      end
+
+      # Now how about a block...
+      1..10.each do |number|
+        begin
+        rescue
+        ensure
+        end
+      end
+    end
+  end
+end

data/features/support/common.rb

@@ -1,3 +1,9 @@
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+
+require 'tailor'
+
+include Tailor
+
 module CommonHelpers
   def in_tmp_folder(&block)
     FileUtils.chdir(@tmp_root, &block)
@@ -26,4 +32,71 @@ module CommonHelpers
   end
 end
 
-World(CommonHelpers)
+World(CommonHelpers)
+
+# Counts keywords in the file provided.
+#
+# @param [String] file Path to the file to check
+# @param [String] keyword Keyword to count
+# @return [Number] Number of keywords counted
+def count_keywords file, keyword
+  ruby_source = File.open(file, 'r')
+
+  count = 0
+  ruby_source.each_line do |line|
+    if line =~ /^#{keyword}/
+      count =+ 1
+    end
+  end
+  ruby_source.close
+  count
+end
+
+def check_file
+  ruby_source = File.open(@file_list[0], 'r')
+
+  ruby_source.each_line do |line|
+    yield(line)
+  end
+end
+
+# Prep for the testing
+Before do
+  @tailor = "#{File.dirname(__FILE__)}/../../bin/tailor"
+end
+
+#-----------------------------------------------------------------------------
+# "Given" statements
+#-----------------------------------------------------------------------------
+Given /^I have a project directory "([^\"]*)"$/ do |project_dir|
+  project_dir = "#{@features_path}/support/#{project_dir}"
+  File.exists?(project_dir).should be_true
+  File.directory?(project_dir).should be_true
+  @project_dir = project_dir
+end
+
+Given /^the file contains only "([^\"]*)" "([^\"]*)" statement$/ do
+  |count_in_spec, keyword|
+  #count_in_file = count_keywords(@ruby_source, keyword)
+  count_in_file = count_keywords(@file_list[0], keyword)
+  count_in_file.should == count_in_spec.to_i
+end
+
+Given /^I have 1 file in my project$/ do
+  @file_list = Dir.glob("#{@project_dir}/*")
+  @file_list.length.should == 1
+end
+
+Given /^that file does not contain any "([^\"]*)" statements$/ do |keyword|
+  ruby_source = File.open(@file_list[0], 'r')
+
+  count = count_keywords(ruby_source, keyword)
+  count.should == 0
+end
+
+#-----------------------------------------------------------------------------
+# "When" statements
+#-----------------------------------------------------------------------------
+When "I run the checker on the project" do
+  @result = `#{@tailor} #{@project_dir}`
+end