tailor 0.1.5 → 1.0.0.alpha

data/.gitignore

@@ -1,8 +1,16 @@
 .autotest
+.DS_Store
 .loadpath
 .project
 .yardoc/
 logic.txt
 output.txt
+
+.bundle/
+.idea/
+coverage/
+doc/
+pkg/
 tmp/
-ruby-style-checker.rb
+
+*/.DS_Store

data/.rspec

@@ -1 +1,2 @@
---colour --format documentation
+--tty
+--color

data/.tailor

@@ -0,0 +1,6 @@
+Tailor.config do |config|
+  config.formatters "text"
+  config.file_set 'lib/**/*.rb'
+  config.file_set 'spec/**/*.rb'
+  config.file_set 'features/**/*.rb'
+end

data/Gemfile.lock

@@ -1,107 +1,76 @@
 PATH
   remote: .
   specs:
-    tailor (0.1.5)
+    tailor (1.0.0.alpha)
+      log_switch (>= 0.2.0)
       term-ansicolor (>= 1.0.5)
+      text-table (>= 1.2.2)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    Saikuro (1.1.0)
-    activesupport (3.1.0)
-      multi_json (~> 1.0)
+    aruba (0.4.11)
+      childprocess (>= 0.2.3)
+      cucumber (>= 1.1.1)
+      ffi (>= 1.0.11)
+      rspec (>= 2.7.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)
+    childprocess (0.3.1)
+      ffi (~> 1.0.6)
     code_statistics (0.2.13)
-    colored (1.2)
-    cucumber (1.1.0)
+    cucumber (1.1.9)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.2)
-      gherkin (~> 2.5.0)
+      gherkin (~> 2.9.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)
+    fakefs (0.4.0)
+    ffi (1.0.11)
+    gherkin (2.9.3)
       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)
+    json (1.6.6)
+    log_switch (0.3.0)
+    multi_json (1.2.0)
+    rake (0.9.2.2)
     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)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    ruby_parser (2.3.1)
       sexp_processor (~> 3.0)
-    sexp_processor (3.0.7)
-    simplecov (0.5.3)
-      multi_json (~> 1.0.3)
+    sexp_processor (3.1.0)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
-    syntax (1.0.0)
-    term-ansicolor (1.0.6)
-    yard (0.7.2)
+    term-ansicolor (1.0.7)
+    text-table (1.2.2)
+    yard (0.7.5)
+    yard-cucumber (2.1.7)
+      cucumber (>= 0.7.5)
+      gherkin (>= 2.2.9)
+      yard (>= 0.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  code_statistics (~> 0.2.13)
-  cucumber (>= 0.10.2)
-  metric_fu (>= 2.0.0)
+  aruba
+  bundler
+  code_statistics
+  cucumber (>= 1.0.2)
+  fakefs (>= 0.4.0)
+  rake
+  roodi (>= 2.1.0)
   rspec (>= 2.5.0)
   simplecov (>= 0.4.0)
   tailor!
-  yard (>= 0.6.8)
+  yard (>= 0.7.0)
+  yard-cucumber (>= 2.1.7)

data/README.rdoc

@@ -5,51 +5,184 @@
 == DESCRIPTION:
 
 tailor recursively parses Ruby files in a directory and checks them for bad 
-style.  Rules for judging style are based on a number of style guides that are popular in the Ruby community.  More on this
-here http://wiki.github.com/turboladen/tailor.
+style.  Rules for judging style are based on a number of style guides that are
+popular in the Ruby community.  More on this here
+http://wiki.github.com/turboladen/tailor.
 
 == FEATURES/PROBLEMS:
 
-* Checks for bad style in .rb and .erb files
+* Checks for bad style in Ruby files
   * Recursively in a directory, or...
-  * A given file
+  * A given file, or...
+  * A glob ('lib/**/*.rb')
 * Checks for:
-  * Indentation
-    * Hard-tabs in indentation
+  * Horizontal spacing
+    * Indentation
+    * Use of hard-tabs
+    * Line length
+    * Trailing spaces at the end of lines
+    * Spacing after commas
+    * Spacing before commas
+    * Spacing around { and before }
+    * Spacing after [ and before ]
+    * Spacing after ( and before )
+  * Vertical spacing
+    * Trailing newlines (at the end of the file)
+    * Max code lines in a class/module
+    * Max code lines in a method
   * Name cases
     * Snake case class & module names
     * Camel case method names
-  * Extra whitespace
-    * At the end of lines
-    * On empty lines
-    * Around commas
-    * Around open/closed parentheses
-    * Around open/closed square brackets
-    * Around open/closed curly braces
-    * Around colons in ternary statements
-  * Line length
-    * Should be <= 80 characters
+* Configurable
+  * Specify style in
+    * ~./tailorrc
+    * PROJECT_ROOT + .tailor
+    * as CLI options
+  * "File sets" allow for applying different styles to different sets of files
+* CI/Build Integration
+  * (Well, this may be stretching things a bit, but...) Exit 1 on failures
 
 == SYNOPSIS:
 
+=== Why style check?
+
+If you're reading this, there's a good chance you already have your own reasons
+for doing so.  If you're not familiar with static analysis, give tailor a go
+for a few days and see if you think it improves your code's readability.
+
+=== What's it do?
+
+At tailor's inception, there were some other static analysis tools for Ruby,
+but none which checked style stuff; tailor started off as a means to fill this
+gap.  Since then, a number of those tools have dropped by the wayside due to
+various Ruby 1.9 incompatibilities, and left a bigger tool gap for Rubyists.
+Right now it's mostly a style-checker, but might also have a future role in
+analyzing other aspects of your Ruby code.
+
+=== Since 0.x...
+
+tailor 1.x is a marked improvment over 0.x.  While 0.x provided a few (pretty
+inconsistent) style checks, its design made the code get all spaghetti-like,
+with lots of really gnarly regular expression matching, making it a realy bear
+to add new features and fix bugs.  tailor 1.x is completely redesigned to make
+that whole process much easier.
+
+=== Measure Stuff
+
 Run tailor like:
 
   $ tailor path/to/check/
+
 ...or...
-  $ tail file_to_check.rb
 
-There are a number of false-positives and false-negatives in detection of the
-above rules, so please don't expect perfection in this detection.  :)  I'm
-working on solving this.
+  $ tailor file_to_check.rb
+
+...or...
+
+  $ tailor test/**/*.rb
+
+...or... (defaults to lib/**/*.rb):
+
+  $ tailor
+
+There are still a number of false-positives and false-negatives in detection of
+the above rules, so please don't expect perfection in this detection.  :)
+
+=== Configurable:
+
+Not everyone prefers the same style of, well, anything really.  tailor is
+configurable to allow you to check your code against the style measurements
+that you want.
+
+It has default values for each of the "rulers" it uses, but if you want to
+customize these, there are a number of ways you can do so.
+
+==== CLI
+
+At any time, you can tell tailor to show you the configuration that it's going
+to use by doing:
+
+  $ tailor --show-config
+
+To see, amongst other options, the style options that you can pass in, do
+
+  $ tailor --help
+
+If, for example, you want to tell tailor to warn you if any of your code lines
+are > 100 chars (instead of the default of 80):
+
+  $ tailor --max-line-length 100 lib/
+
+If you want to simply disable a ruler, just pass +false+ to the option:
+
+  $ tailor --max-line-length false lib/
+
+==== Configuration File
+
+Configuration files allow for some more flexibility with style rulers, file
+lists, and (eventually) report formatters.  To create one with default
+settings, do:
+
+  $ tailor --create-config
+
+With the documentation that's provided in the file, the settings should be
+straightforward (if they're not, please let me know!).  You don't have to specify
+all of those settings in your config file--those are just rendered so you have
+a starting ground to tweak with.  If you only want to override a single value,
+you can delete the rest of the code from your config.  This would accomplish
+the same as the --max-line-length example above:
+
+  # .tailor
+  Tailor.config do |config|
+    config.file_set :default do
+      max_line_length 100
+    end
+  end
+
+This brings us to the concept of "file sets"...
+
+===== File Sets
+
+File sets allow you to use different style rulers against different groups of
+files.  You may, for example, want your Rails app code to allow for longer
+lines, or fewer code lines in methods... You may want your RSpec code to be
+more lenient with curly-brace usage... You may just want to specify a few file
+globs to use the default set of rulers...  File sets allow for those sorts of
+things.
+
+In the default config file, you see a single parameter being passed to
+<tt>config.file_set</tt>--this is the _label_ for that file set.  The label is
+simply just a name to refer to that file set by; it will show in your report
+(in the case that problems were found, of course) so you know what set of
+rulers caused the problem to be found.  <tt>config.file_set</tt> also takes
+a second paramter: the file/directory/glob to apply the style to.
+
+  # .tailor
+  Tailor.config do |config|
+    config.file_set :rails_app, 'app/**/*.rb' do
+      max_line_length 100
+      # All other rulers will use default values
+    end
+
+    config.file_set :features, 'features/**/*.rb'     # Uses default style
+
+    config.file_set :rspec, 'spec/**/*.rb' do
+      spaces_after_lbrace false
+      spaces_before_lbrace false
+      spaces_before_rbrace false
+      # All other rulers will use default values
+    end
+  end
 
 == REQUIREMENTS:
 
 * Rubies (tested)
- * 1.8.7
- * 1.9.2
- * 1.9.3-preview1
+  * 1.9.2
+  * 1.9.3
 * Gems
+  * log_switch
   * term-ansicolor
+  * text-table
 
 == INSTALL:
 
@@ -59,7 +192,7 @@ working on solving this.
 
 (The MIT License)
 
-Copyright (c) 2010-2011 Steve Loveless
+Copyright (c) 2010-2012 Steve Loveless
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -3,14 +3,5 @@ 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

@@ -1,72 +1,19 @@
 #!/usr/bin/env ruby
 
-$:.unshift(File.dirname(__FILE__) + '/../lib/') unless
-  $:.include?(File.dirname(__FILE__) + '/../lib/') ||
-  $:.include?(File.expand_path(File.dirname(__FILE__) + '/../lib/'))
-
-require 'tailor'
-
-def usage
-  <<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
-
-    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
-      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 RuntimeError => ex
-    puts ex.message
-    puts ex.backtrace
-    puts
-  ensure
-    exit(1) if problem_count > 0
-  end
+require_relative '../lib/tailor/cli'
+require_relative '../lib/tailor/runtime_error'
+
+
+begin
+  failure = Tailor::CLI.run(ARGV.dup)
+  exit(1) if failure
+rescue Tailor::RuntimeError => ex
+  STDERR.puts ex.message
+  STDERR.puts ex.backtrace.join("\n")
+rescue SystemExit => ex
+  exit(ex.status)
+rescue Exception => ex
+  STDERR.puts("#{ex.message} (#{ex.class})")
+  STDERR.puts(ex.backtrace.join("\n"))
+  exit(1)
 end