tailor 1.2.1 → 1.3.0

data/spec/unit/tailor/rulers_spec.rb

@@ -1,8 +1,8 @@
-require_relative '../../spec_helper'
+require 'spec_helper'
 require 'tailor/rulers'
 
 describe Tailor::Rulers do
-  it "requires all of its children" do
+  it 'requires all of its children' do
     # if it does one, it'll have done them all.
     subject.const_get('AllowCamelCaseMethodsRuler').should be_true
   end

data/spec/unit/tailor/version_spec.rb

@@ -3,5 +3,5 @@ require 'tailor/version'
 
 
 describe Tailor::VERSION do
-  it { should == '1.2.1' }
+  it { should == '1.3.0' }
 end

data/spec/unit/tailor_spec.rb

@@ -1,16 +1,16 @@
-require_relative '../spec_helper'
+require 'spec_helper'
 require 'tailor'
 
 describe Tailor do
   before { Tailor::Logger.log = false }
 
-  describe "::config" do
-    it "creates a new Configuration object" do
+  describe '.config' do
+    it 'creates a new Configuration object' do
       Tailor::Configuration.should_receive(:new)
       Tailor.config
     end
 
-    it "returns a Configuration object" do
+    it 'returns a Configuration object' do
       Tailor.config.should be_a Tailor::Configuration
     end
   end

data/tailor.gemspec

@@ -20,7 +20,7 @@ project, whatever style that may be.
   s.email = "steve.loveless@gmail.com"
   s.homepage = "http://github.com/turboladen/tailor"
 
-  s.extra_rdoc_files = %w(History.rdoc README.rdoc)
+  s.extra_rdoc_files = %w(History.md README.md)
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- {spec,features}/*`.split("\n")
   s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tailor
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Steve Loveless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-12 00:00:00.000000000 Z
+date: 2013-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log_switch
@@ -177,8 +177,8 @@ executables:
 - tailor
 extensions: []
 extra_rdoc_files:
-- History.rdoc
-- README.rdoc
+- History.md
+- README.md
 files:
 - .gemtest
 - .gitignore
@@ -188,8 +188,8 @@ files:
 - .travis.yml
 - Gemfile
 - Gemfile.lock
-- History.rdoc
-- README.rdoc
+- History.md
+- README.md
 - Rakefile
 - bin/tailor
 - features/configurable.feature
@@ -236,6 +236,7 @@ files:
 - lib/tailor/rulers/max_code_lines_in_method_ruler.rb
 - lib/tailor/rulers/max_line_length_ruler.rb
 - lib/tailor/rulers/spaces_after_comma_ruler.rb
+- lib/tailor/rulers/spaces_after_conditional_ruler.rb
 - lib/tailor/rulers/spaces_after_lbrace_ruler.rb
 - lib/tailor/rulers/spaces_after_lbracket_ruler.rb
 - lib/tailor/rulers/spaces_after_lparen_ruler.rb
@@ -249,12 +250,14 @@ files:
 - lib/tailor/runtime_error.rb
 - lib/tailor/tailorrc.erb
 - lib/tailor/version.rb
+- spec/functional/conditional_spacing_spec.rb
 - spec/functional/configuration_spec.rb
 - spec/functional/horizontal_spacing/braces_spec.rb
 - spec/functional/horizontal_spacing/brackets_spec.rb
 - spec/functional/horizontal_spacing/comma_spacing_spec.rb
 - spec/functional/horizontal_spacing/hard_tabs_spec.rb
 - spec/functional/horizontal_spacing/long_lines_spec.rb
+- spec/functional/horizontal_spacing/long_methods_spec.rb
 - spec/functional/horizontal_spacing/parens_spec.rb
 - spec/functional/horizontal_spacing/trailing_whitespace_spec.rb
 - spec/functional/horizontal_spacing_spec.rb
@@ -269,12 +272,14 @@ files:
 - spec/functional/vertical_spacing_spec.rb
 - spec/spec_helper.rb
 - spec/support/bad_indentation_cases.rb
+- spec/support/conditional_spacing_cases.rb
 - spec/support/good_indentation_cases.rb
 - spec/support/horizontal_spacing_cases.rb
 - spec/support/naming_cases.rb
 - spec/support/rake_task_config_no_problems.rb
 - spec/support/rake_task_config_problems.rb
 - spec/support/vertical_spacing_cases.rb
+- spec/unit/tailor/cli/options_spec.rb
 - spec/unit/tailor/cli_spec.rb
 - spec/unit/tailor/composite_observable_spec.rb
 - spec/unit/tailor/configuration/file_set_spec.rb
@@ -286,7 +291,6 @@ files:
 - spec/unit/tailor/lexed_line_spec.rb
 - spec/unit/tailor/lexer/token_spec.rb
 - spec/unit/tailor/lexer_spec.rb
-- spec/unit/tailor/options_spec.rb
 - spec/unit/tailor/problem_spec.rb
 - spec/unit/tailor/reporter_spec.rb
 - spec/unit/tailor/ruler_spec.rb
@@ -319,7 +323,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A Ruby style & complexity measurer
@@ -335,12 +339,14 @@ test_files:
 - features/support/legacy/long_file_with_indentation.rb
 - features/support/world.rb
 - features/valid_ruby.feature
+- spec/functional/conditional_spacing_spec.rb
 - spec/functional/configuration_spec.rb
 - spec/functional/horizontal_spacing/braces_spec.rb
 - spec/functional/horizontal_spacing/brackets_spec.rb
 - spec/functional/horizontal_spacing/comma_spacing_spec.rb
 - spec/functional/horizontal_spacing/hard_tabs_spec.rb
 - spec/functional/horizontal_spacing/long_lines_spec.rb
+- spec/functional/horizontal_spacing/long_methods_spec.rb
 - spec/functional/horizontal_spacing/parens_spec.rb
 - spec/functional/horizontal_spacing/trailing_whitespace_spec.rb
 - spec/functional/horizontal_spacing_spec.rb
@@ -355,12 +361,14 @@ test_files:
 - spec/functional/vertical_spacing_spec.rb
 - spec/spec_helper.rb
 - spec/support/bad_indentation_cases.rb
+- spec/support/conditional_spacing_cases.rb
 - spec/support/good_indentation_cases.rb
 - spec/support/horizontal_spacing_cases.rb
 - spec/support/naming_cases.rb
 - spec/support/rake_task_config_no_problems.rb
 - spec/support/rake_task_config_problems.rb
 - spec/support/vertical_spacing_cases.rb
+- spec/unit/tailor/cli/options_spec.rb
 - spec/unit/tailor/cli_spec.rb
 - spec/unit/tailor/composite_observable_spec.rb
 - spec/unit/tailor/configuration/file_set_spec.rb
@@ -372,7 +380,6 @@ test_files:
 - spec/unit/tailor/lexed_line_spec.rb
 - spec/unit/tailor/lexer/token_spec.rb
 - spec/unit/tailor/lexer_spec.rb
-- spec/unit/tailor/options_spec.rb
 - spec/unit/tailor/problem_spec.rb
 - spec/unit/tailor/reporter_spec.rb
 - spec/unit/tailor/ruler_spec.rb

data/History.rdoc

@@ -1,189 +0,0 @@
-=== 1.2.1 2013-03-12
-
-* gh-134[https://github.com/turboladen/tailor/issues/134]
-  * Turned logging off by default when using bin/tailor.  This was a regression
-    introduced in 1.2.0.
-
-=== 1.2.0 2013-03-06
-
-* gh-119[https://github.com/turboladen/tailor/issues/119]
-  * AllowInvalidRubyRuler now uses Gem.ruby to use the ruby that tailor was
-    run with.
-* gh-130[https://github.com/turboladen/tailor/issues/130]
-  * AllowInvalidRubyRuler now handles file names with spaces in them.
-* gh-131[https://github.com/turboladen/tailor/issues/131]
-  * Added YAML output formatter.  Thanks @leandronsp!
-* gh-133[https://github.com/turboladen/tailor/issues/133]
-  * Added support for Ruby 2.0.0-p0.  ...which is actually just accounting for
-    a {fix to Ripper}[https://bugs.ruby-lang.org/issues/6211] that finally got
-    merged in to a Ruby release.
-
-=== 1.1.5 2013-01-30
-
-* gh-127[https://github.com/turboladen/tailor/issues/127]
-  * The last fix had SystemExit being displayed to the user at all times (since
-    it should've been getting rescued from when the program exits).  Properly
-    rescuing this now for Rake tasks, so it now behaves just like bin/tailor in
-    this respect.
-
-=== 1.1.4 2013-01-29
-
-* gh-127[https://github.com/turboladen/tailor/issues/127]
-  * RakeTask now actually does something (works).
-* tailor should now abort (and let you know) when it can't find the config file
-  that you told it to use.  Previously, it would just fall back to default
-  settings.
-
-=== 1.1.3 2013-01-28
-
-* gh-121[https://github.com/turboladen/tailor/issues/121]
-  * Camel case methods are now detected properly when used inside of a class.
-    Thanks @jasonku!
-
-=== 1.1.2 2012-06-01
-
-* gh-101[https://github.com/turboladen/tailor/issues/101]
-  * Tailor now handles code that uses backslashes to break up statements to
-    multiple lines.  Note that this is somewhat of a hack, since Ripper does not
-    tokenize these backslashes--it actually just treats what we see as 2 lines
-    of code as a single line of code.  In order to preserve line numbering and
-    indentation tracking, tailor replaces the backslash with a special comment
-    that it can detect and handle accordingly.  While this isn't ideal, given
-    the current design, it seemed like the way to deal with this.
-* gh-103[https://github.com/turboladen/tailor/issues/103]
-  * Tailor now properly handles string interpolation inside string
-    interpolation.
-  
-=== 1.1.1 2012-05-31
-
-* gh-110[https://github.com/turboladen/tailor/issues/110]
-  * Tailor now exits with 0 if non-error problems are found.
-  
-=== 1.1.0 2012-05-07
-
-* gh-89[https://github.com/turboladen/tailor/issues/89]
-  * You can now use {Tailor::RakeTask} to create a Rake task.
-* gh-100[https://github.com/turboladen/tailor/issues/100]
-  * Added {Tailor::Configuration#recursive_file_set}.  This lets you do the
-    following in your config file, which will recursively match all files in
-    your current path that end with '_spec.rb':
-
-      Tailor.config do |config|
-        config.recursive_file_set '*_spec.rb', :unit_tests do |style|
-          style.max_line_length 90, level: :warn
-        end
-      end
-
-    ...which is equivalent to:
-
-      Tailor.config do |config|
-        config.file_set '*/**/*_spec.rb', :unit_tests do |style|
-          style.max_line_length 90, level: :warn
-        end
-      end
-
-* gh-107[https://github.com/turboladen/tailor/issues/107]
-  * Fixed --no-color option.
-* gh-108[https://github.com/turboladen/tailor/issues/108]
-  * Fixed --create-config, which created style level options with a missing ':'
-    for the Hash value.
-* Configuration files now don't force you to use the :default file set.  If you
-  don't specify any file sets, then the default is used; if you specify file
-  sets, it uses what you specify.
-* CLI options now override config file options for all file sets (previously,
-  only the :default file set's option would get overridden by the CLI option).
-
-=== 1.0.1 2012-04-23
-
-* gh-104[https://github.com/turboladen/tailor/issues/104]:
-  * Fixed incorrect rendering of config file when using `tailor --create-config`.
-
-=== 1.0.0 2012-04-17
-
-* Big update to config file.
-* Fix for indentation checking on nested Hashes.
-* Fix for overriding default style in config files.
-* Fix to exit after --show-config.
-* gh-99[https://github.com/turboladen/tailor/issues/99]
-  * Now warns by default if `ruby -c [file]` fails.
-* gh-93[https://github.com/turboladen/tailor/issues/93]
-  * 2 'end's on the same line don't cause an indentation error.
-* gh-92[https://github.com/turboladen/tailor/issues/92]
-  * Users can now turn off a ruler...
-    * CLI: <tt>--my-option off</tt>
-    * Config file: <tt>my_option 1, level: :off</tt>
-* gh-86[https://github.com/turboladen/tailor/issues/86]
-  * Indentation checking implemented.
-* gh-68[https://github.com/turboladen/tailor/issues/68]
-  * Spaces aren't improperly detected after a token when the line ends with a
-    backslash.
-
-=== 1.0.0.alpha2 2012-04-09
-
-* Fix for when not using a config file.
-
-=== 1.0.0.alpha 2012-04-09
-
-* Complete rewrite.
-* New style checks:
-  * Indentation.
-  * LOC count in a class.
-  * LOC count in a method.
-  * Trailing newlines at EOF.
-* Other new features:
-  * Configuration file use--both .tailor and ~/.tailorrc--lets you specify
-    groups of files.
-  * Turn checks off via CLI options.
-
-=== 0.1.5 2011-09-27
-
-* Fixed post install message to use heredoc instead of %w (<-wth was I thinking?)
-
-=== 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 hoe 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/README.rdoc

@@ -1,422 +0,0 @@
-= tailor
-
-* http://github.com/turboladen/tailor
-
-{<img src="https://secure.travis-ci.org/turboladen/tailor.png?branch=master" alt="Build Status" />}[http://travis-ci.org/turboladen/tailor]
-{<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/turboladen/tailor]
-
-== DESCRIPTION:
-
-tailor parses Ruby files and measures them with some style and static analysis
-"rulers".  Default values for the Rulers are based on a number of style guides
-in the Ruby community as well as what seems to be common.  More on this here
-http://wiki.github.com/turboladen/tailor.
-
-tailor's goal is to help you be consistent with your style, throughout your
-project, whatever style that may be.
-
-== FEATURES/PROBLEMS:
-
-* Checks for bad style in Ruby files
-  * Recursively in a directory, or...
-  * A given file, or...
-  * A glob ('lib/**/*.rb')
-* Checks for:
-  * 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
-  * Valid Ruby (warns by default)
-* Configurable
-  * Specify style in
-    * ~./tailorrc
-    * PROJECT_ROOT + .tailor
-    * as CLI options
-  * "File sets" allow for applying different styles to different groups of files
-  * Set problems to :warn or :off instead of :fail
-* Define custom "Rulers"
-* 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 into a tool for 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
-
-Check _all_ files in a directory:
-
-  $ tailor path/to/check/
-
-Check a single file:
-
-  $ tailor file_to_check.rb
-
-Check only files ending in .rb under the 'test' directory:
-
-  $ tailor test/**/*.rb
-
-Check defaults (lib/**/*.rb):
-
-  $ tailor
-
-Printing the results in a output file (if using a formatter that accepts output files, like 'yaml'):
-
-  $ tailor path/to/check --output-file=my-results.yaml
-  $ tailor --output-file=my-results-from-defaults.yaml
-
-Use defaults via a Rake task (if you have a .tailor file, it'll use those settings):
-
-  require 'tailor/rake_task'
-
-  Tailor::RakeTask.new
-
-==== On style...
-
-The features list, above, shows some aspects of style that should be fairly
-straightforward (as to their meaning and reason), however, others make some big
-assumptions--particularly the indentation checking "ruler".  There are a number
-of popular indenting conventions...  In the case of multi-line parameters to a
-method, some like do this:
-
-  def a_really_freakin_long_method_name(my_really_long_first_parameter,
-    my_next_param)
-    # ...
-  end
-
-...while others prefer:
-
-  def a_really_freakin_long_method_name(my_really_long_first_parameter,
-      my_next_param)
-    # ...
-  end
-
-...and yet some others prefer:
-
-  def a_really_freakin_long_method_name(my_really_long_first_parameter,
-                                        my_next_param)
-    # ...
-  end
-
-At this point, tailor only supports the style used in the first example.  If
-this style isn't to your liking, then definitely take a look at the
-Configurable section here to see how to turn this off.  Other styles will
-probably be supported in the future.
-
-All that to say, though, that this isn't the only case where tailor makes style
-assumptions.  Another discrepancy in popular styles is with regard to aligning
-operators in different lines.  Some like:
-
-  my_hash[:first][:thing] = 1
-  my_hash[:eleventy][:thing] = 2
-
-...while others prefer:
-
-  my_hash[:first][:thing]    = 1
-  my_hash[:eleventy][:thing] = 2
-
-...and yet some others prefer:
-
-  my_hash[:first][:thing] =    1
-  my_hash[:eleventy][:thing] = 2
-
-Again, tailor only supports the first example here.
-
-The goal is certainly not to force you to use the style that tailor currently
-uses; it just might not support your style yet.  If tailor doesn't support your
-style, please feel free to take a look at the issues list and make a request.
-...or fork away!
-
-=== 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 +off+ to the option:
-
-  $ tailor --max-line-length off lib/
-
-==== Configuration File
-
-While you can drive most tailor options from the command line, 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 <tt>--max-line-length</tt> example above:
-
-  # .tailor
-  Tailor.config do |config|
-    config.file_set 'lib/**/*.rb' do |style|
-      style.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 glob that defines the list of files for
-that file set.  While you don't see it, +config.file_set+ takes a second
-optional parameter that allows you to _label_ your style properties, and thus
-use different sets of style properties for differet sets of files.  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.
-
-  # .tailor
-  Tailor.config do |config|
-
-    # All defaults; implies "default" label
-    config.file_set 'lib/**/*.rb'
-
-    config.file_set 'app/**/*.rb', :rails_app do |style|
-      style.max_line_length 100
-      # All other rulers will use default values
-    end
-
-    # Uses default style, but labelled in the report with "features"
-    config.file_set 'features/**/*.rb', :features
-
-    config.file_set 'spec/**/*.rb', :rspec do |style|
-      style.spaces_after_lbrace false
-      style.spaces_before_lbrace false
-      style.spaces_before_rbrace false
-      # All other rulers will use default values
-    end
-  end
-
-If it suits you better, use "recursive file sets" to get all matching files
-in your current path.  If you wanted to critique all .rb files:
-
-  # .tailor
-  Tailor.config do |config|
-
-    # All defaults; implies "default" label
-    config.recursive_file_set '*.rb'
-  end
-
-Similarly to the CLI, if you want to turn off a default Ruler, set its problem
-level to +:off+:
-
-  # .tailor
-  Tailor.config do |config|
-    config.file_set 'lib/**/*.rb do |style|
-      style.indentation_spaces 2, level: :off
-    end
-  end
-
-
-===== Formatters
-
-By default Tailor uses the text formatter, printing the results on console. Tailor
-also provides a YAML formatter, that accepts an output file if using the option
---output-file=*.yaml
-
-  # .tailor
-  Tailor.config do |config|
-    config.formatters 'text', 'yaml'
-
-    # just one
-    config.formatters 'text'
-  end
-
-
-=== Define A Custom Ruler
-
-While tailor provides a number of Rulers for checking style, it also provides a
-way for you to add your own rulers without having to delve into its innards.  To
-do this, you need to do the following.
-
-==== Create the Ruler
-
-Before jumping in to this, take a look at {Tailor::Ruler} and any of the
-existing Rulers in +lib/tailor/rulers/+.  There are some key things a new Ruler
-must have:
-
-* the class name ends with "Ruler"
-* it inherits {Tailor::Ruler}
-* it's defined within the {Tailor::Rulers} module
-* +#initialize+ defines two parameters:
-  1. +config+ sets +@config+ to the "golden rule" value for what you're measuring
-  2. +options+ is a Hash, that should at least be passed the :level => you want
-     the problem to be logged as
-* +#add_lexer_observers+ gets passed a list of {Tailor::Lexer} event types that
-  the ruler should get notified on
-* it defines call-back methods for {Tailor::Lexer} to call when it comes across
-  an event of interest
-* it calls +#measure+ to assess if the criteria it's checking has been met
-* it adds a {Tailor::Problem} to +@problems+ when one is found in +#measure+
-
-==== Add the Ruler to the list of Styles
-
-Internally, this all happens in +lib/tailor/configuration/style.rb+, but you can
-add infomation about your ruler to your config file.  If you created a Ruler:
-
-  # max_lines_in_block.rb
-  class Tailor
-    module Rulers
-      class MaxLinesInBlockRuler < Tailor::Ruler
-        def initialize(config, options)
-          super(config, options)
-          add_lexer_observers :ignored_nl, :kw
-        end
-
-        def ignored_nl_update(lexed_line, lineno, column)
-          # ...
-        end
-
-        def kw_update(token, lexed_line, lineno, column)
-          # ...
-        end
-
-        def measure
-          # ...
-        end
-
-        # ...
-      end
-    end
-  end
-
-...then require this and add it to the Style list of properties:
-
-  # .tailor
-  require 'tailor/configuration/style'
-  require 'max_lines_in_block'
-
-  Tailor::Configuration::Style.define_property :max_lines_in_block
-
-  Tailor.config do |config|
-    config.file_set 'lib/**/*.rb' do |style|
-      style.max_lines_in_block 10, level: :error
-    end
-  end
-
-Next time you run tailor, your Ruler will get initialized and used.
-
-=== Using the lib
-
-Sometimes you could use tailor as a lib, getting the results as a hash
-and manipulate them according your domain.
-
-  require 'tailor/cli'
-
-  # only results from a specific path
-  tailor = Tailor::CLI.new %w(app/controllers)
-  tailor.result # result should be a hash {"filename" => [problems]}
-
-  # using other file config (hiding path, it'll use from default config)
-  Tailor::CLI.new %w(--config-file=.other-config)
-  Tailor::CLI.new [] # uses file set from .tailor file config
-
-  # printing the results in a output file
-  tailor = Tailor::CLI.new %w(--output-file=results.yaml)
-  tailor.execute!
-
-== REQUIREMENTS:
-
-* Rubies (tested)
-  * 1.9.3
-  * 2.0.0
-* Gems
-  * log_switch
-  * term-ansicolor
-  * text-table
-
-== INSTALL:
-
-  $ (sudo) gem install tailor
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2010-2013 Steve Loveless
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-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.