tailor 0.1.3 → 0.1.4

data/.gitignore

@@ -0,0 +1,7 @@
+.autotest
+.loadpath
+.project
+.yardoc/
+logic.txt
+output.txt
+tmp/

data/.infinity_test

@@ -0,0 +1,4 @@
+infinity_test do
+  use :rubies => %w(1.8.7 1.9.2 1.9.3), :test_framework => :rspec
+  notifications :growl
+end

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/ChangeLog.rdoc

@@ -0,0 +1,48 @@
+=== 0.1.4 2011-09-27
+
+* gh-81: Return exit status of 1 if problems were found.
+* Fixed Rakefile and .gemspec. [sergio-fry]
+* Removed dependency on jeweler for gem building.
+* Added -v/--version to bin/tailor.
+* Fixed documenatation indentation.
+
+=== 0.1.3 2010-12-14
+
+* Added check for .erb files.
+
+=== 0.1.2 2010-09-01
+
+* Added ability to check a single file.
+
+=== 0.1.0 2010-05-21
+
+* Added checks for spacing around { and }.
+* Added check for spacing around ternary ':'.
+* Colorized error messages to be red.
+* Problem message are now grouped by file line (when multiple problems per line).
+* Temporarily removed reporting of # of trailing whitespaces.
+
+=== 0.0.3 2010-04-26
+
+* Added checks for spacing around commas.
+* Added checks for spacing around open/closed parenthesis/brackets.
+
+=== 0.0.2 2010-04-23
+
+* Renamed project from ruby_style_checker to Tailor.
+* Added check for lines > 80 characters.
+
+=== 0.0.1 2010-04-22
+
+* Initial release!
+* Command-line executable takes a directory and checks all files, recursively.
+* Checks for:
+  * Indentation
+    * Hard-tabs in indentation
+  * Name cases
+    * Snake case class & module names
+    * Camel case method names
+  * Extra whitespace
+    * At the end of lines
+    * On empty lines
+    * After commas

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    tailor (0.1.4)
+      term-ansicolor (>= 1.0.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    Saikuro (1.1.0)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    chronic (0.3.0)
+    churn (0.0.13)
+      chronic (>= 0.2.3)
+      hirb
+      json_pure
+      main
+      ruby_parser (~> 2.0.4)
+      sexp_processor (~> 3.0.3)
+    code_statistics (0.2.13)
+    colored (1.2)
+    cucumber (1.1.0)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.5.0)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.6)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    flay (1.4.3)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    flog (2.5.3)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    gherkin (2.5.1)
+      json (>= 1.4.6)
+    haml (3.1.3)
+    hirb (0.5.0)
+    i18n (0.6.0)
+    json (1.6.1)
+    json_pure (1.6.1)
+    main (4.7.1)
+    metric_fu (2.1.1)
+      Saikuro (>= 1.1.0)
+      activesupport (>= 2.0.0)
+      chronic (~> 0.3.0)
+      churn (>= 0.0.7)
+      flay (>= 1.2.1)
+      flog (>= 2.3.0)
+      rails_best_practices (>= 0.6.4)
+      rcov (>= 0.8.3.3)
+      reek (>= 1.2.6)
+      roodi (>= 2.1.0)
+      syntax
+    multi_json (1.0.3)
+    rails_best_practices (1.0.1)
+      activesupport
+      colored
+      erubis
+      haml
+      i18n
+      ruby-progressbar
+      ruby_parser
+    rcov (0.9.10)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    roodi (2.1.0)
+      ruby_parser
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    ruby-progressbar (0.0.10)
+    ruby2ruby (1.3.1)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.0.6)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.7)
+    simplecov (0.5.3)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    syntax (1.0.0)
+    term-ansicolor (1.0.6)
+    yard (0.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  code_statistics (~> 0.2.13)
+  cucumber (>= 0.10.2)
+  metric_fu (>= 2.0.0)
+  rspec (>= 2.5.0)
+  simplecov (>= 0.4.0)
+  tailor!
+  yard (>= 0.6.8)

data/README.rdoc

@@ -10,7 +10,7 @@ here http://wiki.github.com/turboladen/tailor.
 
 == FEATURES/PROBLEMS:
 
-* Checks for bad style in Ruby files
+* Checks for bad style in .rb and .erb files
   * Recursively in a directory, or...
   * A given file
 * Checks for:
@@ -44,7 +44,12 @@ working on solving this.
 
 == REQUIREMENTS:
 
-* Ruby 1.8.7 or 1.9.1 (haven't tested on others)
+* Rubies (tested)
+ * 1.8.7
+ * 1.9.2
+ * 1.9.3-preview1
+* Gems
+  * term-ansicolor
 
 == INSTALL:
 
@@ -54,7 +59,7 @@ working on solving this.
 
 (The MIT License)
 
-Copyright (c) 2010 Steve Loveless
+Copyright (c) 2010-2011 Steve Loveless
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -73,4 +78,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,81 +1,16 @@
-require 'rubygems'
-gem 'hoe', '>= 2.1.0'
-require 'hoe'
-require 'fileutils'
-require './lib/tailor'
-
-# Load rakefile extensions
-Dir["#{File.dirname(__FILE__)}/lib/tasks/*.rake"].each { |ext| load ext }
-
-Hoe.plugin :newgem
-Hoe.plugin :yard
-# Hoe.plugin :website
-Hoe.plugin :cucumberfeatures
-Hoe.plugins.delete :rubyforge
-
-# Gets the description from the main README file
-def get_descr_from_readme
-  paragraph_count = 0
-  File.readlines('README.rdoc', '').each do |paragraph|
-    paragraph_count += 1
-    if paragraph_count == 4
-      return paragraph
-    end
-  end
-end
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec 'tailor' do
-  self.summary      = "Utility for checking style of Ruby files."
-  self.developer('Steve Loveless', 'steve.loveless@gmail.com')
-  self.post_install_message = File.readlines 'PostInstall.txt'
-  self.rubyforge_name = self.name
-  self.version        = Tailor::VERSION
-  self.url            = 'http://github.com/turboladen/tailor'
-  self.description    = get_descr_from_readme
-  self.readme_file    = 'README.rdoc'
-  self.history_file   = 'History.txt'
-  self.rspec_options  += ['--color', '--format', 'specdoc']
-  self.extra_deps     += [
-    ['term-ansicolor']
-  ]
-  self.extra_dev_deps += [
-    ['rspec'],
-    ['yard', '>=0.5.3'],
-    ['hoe-yard', '>=0.1.2'],
-    ['cucumber', '>=0.6.3']
-  ]
-
-  self.test_globs   = 'spec/*.rb'
-
-  # Extra Yard options
-  self.yard_title   = "#{self.name} Documentation (#{self.version})"
-  self.yard_markup  = :rdoc
-  self.yard_opts    += ['--main', self.readme_file]
-  self.yard_opts    += ['--output-dir', 'doc']
-  self.yard_opts    += ['--private']
-  self.yard_opts    += ['--protected']
-  self.yard_opts    += ['--verbose']
-  self.yard_opts    += ['--files', 
-    ['Manifest.txt', 'History.txt']
-  ]
-end
-
-#-------------------------------------------------------------------------------
-# Overwrite the :clobber_docs Rake task so that it doesn't destroy our docs
-#   directory.
-#-------------------------------------------------------------------------------
-class Rake::Task
-  def overwrite(&block)
-    @actions.clear
-    enhance(&block)
-  end
-end
-
-Rake::Task[:clobber_docs].overwrite do
-end
-
-# Now define the tasks
-require 'newgem/tasks'
-
+require 'bundler/gem_tasks'
+
+# Load rakefile extensions
+Dir["tasks/*.rake"].each { |ext| load ext }
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+desc "Run RSpec code examples"
+task :test => :spec

data/bin/tailor

@@ -7,35 +7,66 @@ $:.unshift(File.dirname(__FILE__) + '/../lib/') unless
 require 'tailor'
 
 def usage
-  puts "Usage:"
-  puts "\t#{__FILE__} [directory with .rb files]"
-  puts "\t -OR-"
-  puts "\t#{__FILE__} [single .rb file]"
+  <<USEAGE
+  Usage:
+    $ #{File.basename(__FILE__)} [directory with .rb files]"
+      -OR-
+    $ #{File.basename(__FILE__)} [single .rb file]"
+
+USEAGE
+end
+
+def version
+  <<VERSION
+tailor (v#{Tailor::VERSION})
+  A Ruby style checker by @turboladen.
+  http://github.com/turboladen/tailor
+VERSION
+
 end
 
 if ARGV[0].nil?
+  puts version
+  puts
   puts usage
+elsif ARGV[0] =~ /^--version|-v$/
+  puts <<-VERSION
+#{version}
+  _________________________________________________________________________
+  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |  |
+  |     |     |     |     |     |     |     |     |     |     |     |     |
+  |           |           |           |           |           |           |
+  |           1           2           3           4           5           |
+  |                                                                       |
+  -------------------------------------------------------------------------
+
+  VERSION
+
 else
   begin
     path_to_check = ARGV[0]
-    
+
     # Check to make sure we got a file or directory
     unless File.file?(path_to_check) or File.directory?(path_to_check)
       raise "Invalid file or directory: #{path_to_check}"
     end
 
-    if File.file?(path_to_check)
-      files_and_problems = Tailor.check_file path_to_check
+    files_and_problems = if File.file?(path_to_check)
+      Tailor.check_file path_to_check
     elsif File.directory?(path_to_check)
       # Check the requested files/dirs for problems
-      files_and_problems = Tailor.check path_to_check
+      Tailor.check path_to_check
     end
 
+    problem_count = files_and_problems.values.inject(:+)
+
     # Print summary of the problems we found
     Tailor.print_report files_and_problems
-  rescue Exception => ex
+  rescue RuntimeError => ex
     puts ex.message
     puts ex.backtrace
     puts
+  ensure
+    exit(1) if problem_count > 0
   end
-end
+end

data/features/step_definitions/spacing_steps.rb

@@ -153,4 +153,4 @@ end
 Then /^the checker should tell me each line has closed brackets with spaces before them$/ do
   message = "Line has a closed bracket with spaces before it"
   @result.should include(message)
-end
+end

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

@@ -53,7 +53,7 @@ thing ={:one => 1}
 thing = { :one => 1 }
 
 # Skip on default params in methods...
-def a_method; one={}; end;
+def a_method; one={}; end
 
 # Skip on strings...
 a_string = "This is a #{thing}..."

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

@@ -30,7 +30,7 @@ thing [0]
 # 1 space before ] with element reference
 thing[0 ]
 
-# Pefect multi-line
+# Perfect multi-line
 two = 'too'
 thing = [
   one,

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

@@ -45,7 +45,7 @@ module MyModule
       end
 
       # Now how about a block...
-      1..10.each do |number|
+      1..10.times do |number|
         begin
         rescue
         ensure

data/features/support/env.rb

@@ -4,7 +4,7 @@ require "tailor"
 gem 'cucumber'
 require 'cucumber'
 gem 'rspec'
-require 'spec'
+require 'rspec'
 
 Before do
   @tmp_root = File.dirname(__FILE__) + "/../../tmp"

data/lib/tailor.rb

@@ -4,11 +4,11 @@ $:.unshift(File.dirname(__FILE__)) unless
 
 require 'fileutils'
 require 'pathname'
+require 'tailor/version'
 require 'tailor/file_line'
 require 'tailor/spacing'
 
 module Tailor
-  VERSION = '0.1.3'
 
   # These operators should always have 1 space around them
   OPERATORS = {
@@ -23,7 +23,7 @@ module Tailor
     :ternary => ['?', ':']
   }
 
-  # These operators should never have spaces around them
+  # These operators should never have spaces around them.
   NO_SPACE_AROUND_OPERATORS = {
     :range => ['..', '...'],
     :scope_resolution => ['::']
@@ -73,8 +73,8 @@ module Tailor
   # path in order to alleviate any possible confusion.
   #
   # @param [String] base_dir Directory to start recursing from to look for .rb
-  #   files
-  # @return [Array] Sorted list of absolute file paths in the project
+  #   files.
+  # @return [Array] Sorted list of absolute file paths in the project.
   def self.project_file_list base_dir
     if File.directory? base_dir
       FileUtils.cd base_dir
@@ -104,7 +104,7 @@ module Tailor
     source = File.open(file_name, 'r')
     file_path = Pathname.new(file_name)
 
-    puts
+    puts ""
     puts "#-------------------------------------------------------------------"
     puts "# Looking for bad style in:"
     puts "# \t'#{file_path}'"
@@ -193,7 +193,7 @@ end
 
       # If this is the last line of the multi-line statement...
       if multi_line == true and multi_line_statement
-        puts "Assinging current (#{current_level}) to multi_next (#{multi_line_next_level})"
+        puts "Assigning current (#{current_level}) to multi_next (#{multi_line_next_level})"
         current_level = multi_line_next_level
       elsif multi_line == true and !multi_line_statement
         multi_line = false
@@ -232,13 +232,12 @@ end
     @problem_count
   end
 
-  ##
   # Prints a summary report that shows which files had how many problems.
   #
   # @param [Hash] files_and_problems Returns a hash that contains
   #   file_name => problem_count.
   def self.print_report files_and_problems
-    puts
+    puts ""
     puts "The following files are out of style:"
 
     files_and_problems.each_pair do |file, problem_count|