tailor 0.1.3 → 0.1.4

data/lib/tailor/file_line.rb

@@ -7,12 +7,12 @@ require 'term/ansicolor'
 module Tailor
 
   # Calling modules will get the Ruby file to check, then read by line.  This
-  #   class allows for checking of line-specific style by Represents a single
-  #   line of a file of Ruby code.  Inherits from String so "self" can be used.
+  # class allows for checking of line-specific style by Represents a single
+  # line of a file of Ruby code.  Inherits from String so "self" can be used.
   #
   # Methods are named such that they check for bad style conditions, and return
-  #   true and print the associated error message when the bad style condition
-  #   is discovered in the file line.
+  # true and print the associated error message when the bad style condition
+  # is discovered in the file line.
   class FileLine < String
     include Tailor::Spacing
     include Tailor::Indentation
@@ -21,7 +21,7 @@ module Tailor
     LINE_LENGTH_MAX = 80
 
     # This passes the line of code to String (the parent) so that it can act
-    #   like a standard string.
+    # like a standard string.
     #
     # @param [String] line_of_code Line from a Ruby file that will be checked
     #   for styling.
@@ -30,7 +30,7 @@ module Tailor
     #   line.
     # @return [String] Returns a String that includes all of the methods
     #   defined here.
-    def initialize line_of_code, file_path, line_number
+    def initialize(line_of_code, file_path, line_number)
       super line_of_code
       @file_path = file_path
       @line_number = line_number
@@ -59,7 +59,7 @@ module Tailor
         return true
       end
 
-      return false
+      false
     end
 
     # Checks to see if the class name is using snake case.
@@ -81,7 +81,7 @@ module Tailor
         return true
       end
 
-      return false
+      false
     end
 
     # Checks to see if the line is the start of a method's definition.
@@ -93,12 +93,11 @@ module Tailor
         return true
       end
 
-      return false
+      false
     end
 
-    ##
     # Returns the name of the method if the line is one that contains a method
-    #   definition.
+    # definition.
     #
     # @return [String] The method name.
     def method_name
@@ -120,12 +119,11 @@ module Tailor
         return true
       end
 
-      return false
+      false
     end
 
-    ##
     # Checks to see if the line is a regular statement (not a class, method, or
-    #   comment).
+    # comment).
     #
     # @return [Boolean] Returns true if the line is not a class, method or
     #   comment.
@@ -134,11 +132,11 @@ module Tailor
         return false
       end
 
-      return true
+      true
     end
 
     # Checks to see if the whole line is a basic comment line.  This doesn't
-    #   check for trailing-line comments (@see #trailing_comment?).
+    # check for trailing-line comments (@see #trailing_comment?).
     #
     # @return [Boolean] Returns true if the line begins with a pound symbol.
     def comment_line?
@@ -146,10 +144,9 @@ module Tailor
         return true
       end
 
-      return false
+      false
     end
 
-    ##
     # Checks to see if the whole line is only space characters.
     #
     # @return [Boolean] Returns true if the line is only space characters.
@@ -158,12 +155,11 @@ module Tailor
         return false
       end
 
-      return true
+      true
     end
 
-    ##
     # Checks to see if the line is greater than the defined max (80 chars is
-    #   default).
+    # default).
     #
     # @return [Boolean] Returns true if the line length exceeds the allowed
     #   length.
@@ -175,7 +171,7 @@ module Tailor
         return true
       end
 
-      return false
+      false
     end
 
     #-----------------------------------------------------------------
@@ -183,8 +179,7 @@ module Tailor
     #-----------------------------------------------------------------
     private
 
-    ##
-    # Prints the file name and line number that the problem occured on.
+    # Prints the file name and line number that the problem occurred on.
     #
     # @param [String] Error message to print.
     def print_problem message
@@ -196,6 +191,7 @@ module Tailor
         puts ""
         puts line_info
       end
+
       puts red("\t"+ message)
     end
 
@@ -207,7 +203,7 @@ module Tailor
         return true
       end
 
-      return false
+      false
     end
 
     # Checks to see if a word begins with an uppercase letter.
@@ -218,7 +214,7 @@ module Tailor
         return true
       end
 
-      return false
+      false
     end
   end
-end
+end

data/lib/tailor/indentation.rb

@@ -48,7 +48,6 @@ module Tailor
       /^[^\[]*\]/     # matches and end ] when no [ appears
       ]
 
-    ##
     # Determines the number of spaces the line is indented.
     #
     # @return [Number] Returns the number of spaces the line is indented.
@@ -60,13 +59,12 @@ module Tailor
         return spaces.length
       end
 
-      return 0
+      0
     end
 
-    ##
     # Determines the level to which the line is indented.  For Ruby, this
-    #   should be 2 spaces.  Note that this treats lines that are indented an
-    #   odd number of spaces as a multiple of 0.5 levels of indentation.
+    # should be 2 spaces.  Note that this treats lines that are indented an
+    # odd number of spaces as a multiple of 0.5 levels of indentation.
     #
     # @return [Float] The level.
     def is_at_level
@@ -76,10 +74,9 @@ module Tailor
         return 0.0
       end
 
-      return spaces.to_f / 2.0
+      spaces.to_f / 2.0
     end
 
-    ##
     # Checks to see if the line contains a statement that should be indented.
     #
     # @return [Boolean] True if the line contains one of the statements and
@@ -95,10 +92,9 @@ module Tailor
         end
       end
 
-      return false
+      false
     end
 
-    ##
     # Checks to see if the line contains a statement that should be outdented.
     #
     # @return [Boolean] True if the line contains one of the statements.
@@ -114,12 +110,11 @@ module Tailor
         end
       end
 
-      return false
+      false
     end
 
-    ##
     # Checks to see if the line contains a statement that ends a code chunk:
-    #   end, ], or }.
+    # end, ], or }.
     #
     # @return [Boolean] True if the line contains one of the statements.
     def contains_end?
@@ -135,16 +130,15 @@ module Tailor
         end
       end
 
-      return false
+      false
     end
 
-    ##
     # Simply compares the level the line is at to the parameter that's passed
-    #   in.  The proper level is maintained outside of this module.
+    # in.  The proper level is maintained outside of this module.
     #
     # @return [Boolean] True if level of the line doesn't match the level
     #   passed in.  Also returns true if the line is an empty line, since that
-    #   line doens't need to be checked.
+    #   line doesn't need to be checked.
     def at_improper_level? proper_level
       current_level = self.is_at_level
 
@@ -157,7 +151,7 @@ module Tailor
       @line_problem_count += 1
       print_problem message
 
-      return true
+      true
     end
 
     def ends_with_operator?
@@ -181,7 +175,7 @@ module Tailor
         end
       end
 
-      return result
+      result
     end
 
     def ends_with_comma?
@@ -194,7 +188,7 @@ module Tailor
         return true
       end
 
-      return false
+      false
     end
 
     def ends_with_backslash?
@@ -207,7 +201,7 @@ module Tailor
         return true
       end
 
-      return false
+      false
     end
 
     def unclosed_parenthesis?
@@ -216,11 +210,11 @@ module Tailor
       end
 
       unless self.scan(/\([^\)]*(?!=\))\s*$/).empty?
-        puts "Ends with unclose parenthesis."
+        puts "Ends with unclosed parenthesis."
         return true
       end
 
-      return false
+      false
     end
 
     def only_closed_parenthesis?
@@ -232,7 +226,7 @@ module Tailor
         return true
       end
 
-      return false
+      false
     end
 
     def multi_line_statement?
@@ -245,7 +239,7 @@ module Tailor
         return true
       end
 
-      return false
+      false
     end
   end
-end
+end

data/lib/tailor/spacing.rb

@@ -9,15 +9,15 @@ module Tailor
     # TODO: Add skipping of comment lines.
     SPACING_CONDITIONS = {
       :more_than_one_space_after_comma => [
-        /\,\x20{2,}(\w|'|"|:).*((?:(?!#\s*)).)*$/,
+        /,\x20{2,}(\w|'|"|:).*((?:(?!#\s*)).)*$/,
         "[Spacing]  Line has a comma with > 1 space after it"
         ],
       :no_space_after_comma => [
-        /\,\x20{0}\S/,
+        /,\x20{0}\S/,
         "[Spacing]  Line has a comma with 0 spaces after it"
         ],
       :space_before_comma => [
-        /\S\x20+\,/,
+        /\S\x20+,/,
         "[Spacing]  Line has at least one space before a comma"
         ],
       :space_after_open_parenthesis => [
@@ -67,7 +67,6 @@ module Tailor
         ]
       }
 
-    ##
     # Detect spacing problems around all predefined bad cases.
     #
     # @return [Number] The number of problems discovered during detection.
@@ -85,12 +84,12 @@ module Tailor
           print_problem values[1]
         end
       end
+
       problem_count
     end
 
-    ##
     # Checks to see if there's whitespace at the end of the line.  Prints the
-    #   number of whitespaces at the end of the line.
+    # number of whitespaces at the end of the line.
     #
     # @return [Boolean] Returns true if there's whitespace at the end of the
     #   line.
@@ -107,9 +106,8 @@ module Tailor
       return false
     end
 =end
-    ##
     # Checks to see if the line has trailing whitespace at the end of it. Note
-    #   that this excludes empty lines that have spaces on them!
+    # that this excludes empty lines that have spaces on them!
     #
     # @return [Number] Returns the number of trailing spaces at the end of the
     #   line.
@@ -120,14 +118,13 @@ module Tailor
         return 0
       end
 
-      return spaces.first.first.length
+      spaces.first.first.length
     end
     module_function :trailing_whitespace_count
 
-    ##
     # Checks to see if there's no spaces before a given string.  If the line
-    #   being checked is a method with a question mark at the end of it, this
-    #   skips checking the line.
+    # being checked is a method with a question mark at the end of it, this
+    # skips checking the line.
     #
     # @param [String] string The string to check for spaces before.
     # @return [Boolean] True if there are no spaces before the string.
@@ -162,7 +159,6 @@ module Tailor
       result
     end
 
-    ##
     # Checks to see if there's no spaces after a given string.
     #
     # @param [String] string The string to check for spaces after.
@@ -203,7 +199,6 @@ module Tailor
       result
     end
 
-    ##
     # Gets the number of spaces after a string.
     #
     # @param [String] string The string to check for spaces after.
@@ -217,10 +212,10 @@ module Tailor
 
       right_side_match = Regexp.new(Regexp.escape(string) + '\x20*')
 
-      occurences = self.scan(right_side_match)
+      occurrences = self.scan(right_side_match)
 
       results = []
-      occurences.each do |o|
+      occurrences.each do |o|
         string_spaces = o.sub(string, '')
         results << string_spaces.size
       end
@@ -228,7 +223,6 @@ module Tailor
       results
     end
 
-    ##
     # Checks to see if the line contains a method name with a ?.
     #
     # @return [Boolean] True if the line contains a method line include?.
@@ -237,7 +231,7 @@ module Tailor
         return false
       end
 
-      return true
+      true
     end
   end
-end
+end

data/lib/tailor/version.rb

@@ -0,0 +1,3 @@
+module Tailor
+  VERSION = '0.1.4'
+end

data/spec/file_line_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'tailor/file_line'
 require 'pathname'
 
@@ -67,4 +67,4 @@ describe Tailor::FileLine do
       line.too_long?.should be_false
     end
   end
-end
+end

data/spec/indentation_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require_relative 'spec_helper'
 require 'tailor/file_line'
 require 'pathname'
 
@@ -25,7 +25,7 @@ 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__
@@ -45,7 +45,7 @@ describe Tailor::Indentation do
 
   context "should know what level of indentation a line is at" do
     context "for indent expressions" do
-      INDENT_EXPRESSIONS.each do |regexp|
+      Tailor::Indentation::INDENT_EXPRESSIONS.each do |regexp|
         expression = strip_regex(regexp)
 
         it "when the '#{expression }' line is not indented" do
@@ -66,7 +66,7 @@ describe Tailor::Indentation do
     end
 
     context "for outdent expressions" do
-      OUTDENT_EXPRESSIONS.each do |regexp|
+      Tailor::Indentation::OUTDENT_EXPRESSIONS.each do |regexp|
         expression = strip_regex(regexp)
 
         it "when the '#{expression }' line is not indented" do
@@ -87,7 +87,7 @@ describe Tailor::Indentation do
     end
 
     context "for end expressions" do
-      END_EXPRESSIONS.each do |regexp|
+      Tailor::Indentation::END_EXPRESSIONS.each do |regexp|
         expression = strip_regex(regexp)
 
         it "when the '#{expression }' line is not indented" do
@@ -109,7 +109,7 @@ describe Tailor::Indentation do
   end
 
   context "#indent?" do
-    INDENT_EXPRESSIONS.each do |regexp|
+    Tailor::Indentation::INDENT_EXPRESSIONS.each do |regexp|
       expression = strip_regex(regexp)
 
       it "should return true if the line contains #{expression}" do
@@ -120,7 +120,7 @@ describe Tailor::Indentation do
   end
 
   context "#outdent?" do
-    OUTDENT_EXPRESSIONS.each do |regexp|
+    Tailor::Indentation::OUTDENT_EXPRESSIONS.each do |regexp|
       expression = strip_regex(regexp)
 
       it "should return true if the line contains #{expression}" do
@@ -131,7 +131,7 @@ describe Tailor::Indentation do
   end
 
   context "#contains_end?" do
-    END_EXPRESSIONS.each do |regexp|
+    Tailor::Indentation::END_EXPRESSIONS.each do |regexp|
       expression = strip_regex(regexp)
 
       it "should return true if the line contains #{expression}" do
@@ -140,7 +140,7 @@ describe Tailor::Indentation do
       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
@@ -256,4 +256,4 @@ describe Tailor::Indentation do
       line.unclosed_parenthesis?.should be_false
     end
   end
-end
+end