tailor 1.0.0.alpha2 → 1.0.0

data/.gitignore

@@ -5,6 +5,7 @@
 .yardoc/
 logic.txt
 output.txt
+test.rb
 
 .bundle/
 .idea/

data/.tailor

@@ -1,6 +1,14 @@
 Tailor.config do |config|
   config.formatters "text"
   config.file_set 'lib/**/*.rb'
-  config.file_set 'spec/**/*.rb'
-  config.file_set 'features/**/*.rb'
+
+  config.file_set 'features/**/*.rb', :features do |style|
+    style.max_line_length 90, level: :warn
+  end
+
+  config.file_set 'spec/**/*.rb', :spec do |style|
+    style.spaces_after_lbrace 1, level: :warn
+    style.spaces_before_lbrace 1, level: :warn
+    style.spaces_before_rbrace 1, level: :warn
+  end
 end

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    tailor (1.0.0.alpha)
-      log_switch (>= 0.2.0)
+    tailor (1.0.0)
+      log_switch (>= 0.3.0)
       term-ansicolor (>= 1.0.5)
       text-table (>= 1.2.2)
 

data/History.rdoc

@@ -1,3 +1,23 @@
+=== 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.

data/README.rdoc

@@ -4,11 +4,14 @@
 
 == 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
+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
@@ -33,12 +36,15 @@ http://wiki.github.com/turboladen/tailor.
   * 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 sets of files
+  * "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
 
@@ -56,8 +62,8 @@ 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.
+Right now it's mostly a style-checker, but might into a tool for analyzing other
+aspects of your Ruby code.
 
 === Since 0.x...
 
@@ -85,8 +91,61 @@ Run tailor like:
 
   $ 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.  :)
+==== 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:
 
@@ -113,15 +172,15 @@ 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:
+If you want to simply disable a ruler, just pass +off+ to the option:
 
-  $ tailor --max-line-length false lib/
+  $ tailor --max-line-length off 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:
+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
 
@@ -130,12 +189,12 @@ straightforward (if they're not, please let me know!).  You don't have to specif
 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:
+the same as the <tt>--max-line-length</tt> example above:
 
   # .tailor
   Tailor.config do |config|
-    config.file_set 'lib/**/*.rb' do
-      max_line_length 100
+    config.file_set 'lib/**/*.rb' do |style|
+      style.max_line_length 100
     end
   end
 
@@ -151,29 +210,120 @@ 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
+<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.  <tt>config.file_set</tt> also takes
-a second paramter: the file/directory/glob to apply the style to.
+rulers caused the problem to be found.
 
   # .tailor
   Tailor.config do |config|
-    config.file_set :rails_app, 'app/**/*.rb' do
-      max_line_length 100
+
+    # 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
 
-    config.file_set :features, 'features/**/*.rb'     # Uses default style
+    # Uses default style, but labelled in the report with "features"
+    config.file_set 'features/**/*.rb', :features
 
-    config.file_set :rspec, 'spec/**/*.rb' do
-      spaces_after_lbrace false
-      spaces_before_lbrace false
-      spaces_before_rbrace false
+    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
 
+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
+
+
+=== 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.
+
 == REQUIREMENTS:
 
 * Rubies (tested)

data/features/configurable.feature

@@ -1,55 +1,35 @@
-@wip
 Feature: Configurable
   As a Ruby developer
   I want to be able to configure tailor to my style likings
   So that tailor only detects the problems that I care about.
 
-  Scenario: No config file exists
-    Given a file named ".tailorrc" should not exist
+  Scenario: Print configuration when no config file exists
+    Given a file named ".tailor" should not exist
     When I successfully run `tailor --show-config`
-    Then the output should contain:
-      """
-      +---------------------------+------------------+
-      |                Configuration                 |
-      +---------------------------+------------------+
-      |    Indentation                               |
-      +---------------------------+------------------+
-      |    spaces                 |    2             |
-      |    allow_hard_tabs        |    false         |
-      |    continuation_spaces    |    2             |
-      +---------------------------+------------------+
-      |    Vertical whitespace                       |
-      +---------------------------+------------------+
-      |    trailing_newlines      |    1             |
-      +---------------------------+------------------+
-      """
+    Then the output should match /Configuration/
+    And the output should match /Formatters.+|.+text.+|/
+    And the output should match /Label.+|.+default.+|/
+    And the output should match /Style.+|/
+    And the output should match /File List.+|/
     And the exit status should be 0
 
-  Scenario: Configuration file at ~/.tailorrc is valid YAML
+  Scenario: Print configuration when .tailor exists
     Given a file named ".tailorrc" with:
       """
-      ---
-      :indentation:
-        :spaces: 5
-      :vertical_whitespace:
-        :trailing_newlines: 11
+      Tailor::Configuration::Style.define_property :some_ruler
+
+      Tailor.config do |config|
+        config.formatters 'test'
+        config.file_set 'test/**/*.rb' do |style|
+          style.some_ruler 1234
+        end
+      end
       """
     When I successfully run `tailor --show-config`
-    Then the output should contain:
-      """
-      +-------------------------+------------------+
-      |               Configuration                |
-      +-------------------------+------------------+
-      |    Indentation                             |
-      +-------------------------+------------------+
-      |    spaces               |    5             |
-      +-------------------------+------------------+
-      |    Vertical whitespace                     |
-      +-------------------------+------------------+
-      |    trailing_newlines    |    11            |
-      +-------------------------+------------------+
-      """
+    Then the output should match /Formatters.+|.+test.+|/
+    And the output should match /some_ruler.+|.+1234.+|/
 
+  @wip
   Scenario: Pass in configuration file at runtime
     Given a file named "some_config.yml" with:
       """

data/features/horizontal_spacing.feature

@@ -6,8 +6,8 @@ Feature: Horizontal spacing detection
     Given my configuration file ".tailor" looks like:
     """
     Tailor.config do |config|
-      config.file_set do
-        trailing_newlines 0
+      config.file_set do |style|
+        style.trailing_newlines 0
       end
     end
     """
@@ -104,6 +104,7 @@ Feature: Horizontal spacing detection
     | h_spacing/ok/space_after_comma_in_array           |
     | h_spacing/ok/trailing_comma                       |
     | h_spacing/ok/trailing_comma_with_trailing_comment |
+    | h_spacing/ok/line_ends_with_backslash             |
 
   @good_files @braces
 

data/features/indentation.feature

@@ -8,8 +8,8 @@ Feature: Indentation check
     Given my configuration file ".tailor" looks like:
     """
     Tailor.config do |config|
-      config.file_set do
-        trailing_newlines 0
+      config.file_set do |style|
+        style.trailing_newlines 0
       end
     end
     """

data/features/indentation/bad_files_with_no_trailing_newline.feature

@@ -5,8 +5,8 @@ Feature: Indentation check on bad fails without trailing newlines
     Given my configuration file ".tailor" looks like:
     """
     Tailor.config do |config|
-      config.file_set do
-        trailing_newlines 0
+      config.file_set do |style|
+        style.trailing_newlines 0
       end
     end
     """
@@ -19,14 +19,14 @@ Feature: Indentation check on bad fails without trailing newlines
     And the output should match /position:  <Position>/
     And the exit status should be 1
 
-  @multi_line
+  @multi_line @keywords
   Scenarios: 1 problem with classes
     | File                                           | Position |
     | indent/1/class_indented_end                    | 2:1      |
     | indent/1/class_method_def_using_self_outdented | 2:1      |
 
 
-  @multi_line
+  @single_line @keywords
   Scenarios: 1 problem with single-line statement
     | File                                                     | Position |
     | indent/1/class_indented_singlestatement                  | 2:3      |
@@ -34,14 +34,14 @@ Feature: Indentation check on bad fails without trailing newlines
     | indent/1/class_outdented_singlestatement                 | 2:1      |
     | indent/1/class_def_outdented_content                     | 3:3      |
 
-  @multi_line
+  @multi_line @keywords
   Scenarios: 1 problem with def
     | File                                     | Position |
     | indent/1/def_indented_end                | 2:1      |
     | indent/1/def_content_indented_end        | 3:1      |
     | indent/1/class_def_content_outdented_end | 4:1      |
 
-  @multi_line
+  @multi_line @keywords @continuations
   Scenarios: 1 problem with case
     | File                                                | Position |
     | indent/1/case_indented_whens_level                  | 2:3      |
@@ -51,7 +51,7 @@ Feature: Indentation check on bad fails without trailing newlines
     | indent/1/case_when_outdented_whens_level            | 3:1      |
     | indent/1/case_indented_whens_in                     | 2:3      |
 
-  @multi_line
+  @multi_line @keywords
   Scenarios: 1 problem with 'do' loop
     | File                                         | Position |
     | indent/1/while_do_indented                   | 1:1      |
@@ -64,11 +64,12 @@ Feature: Indentation check on bad fails without trailing newlines
     | indent/1/for_do_indented                     | 1:1      |
     | indent/1/loop_do_indented                    | 1:1      |
 
-  @multi_line
+  @multi_line @strings
   Scenarios: 1 problem with multi-line string
     | File                                                            | Position |
     | indent/1/multi_line_string_first_line_indented                  | 2:3      |
     | indent/1/multi_line_string_first_line_indented_trailing_comment | 2:3      |
+    | indent/1/multi_line_tstring                                     | 2:0      |
 
   @multi_line
   Scenarios: 1 problem with multi-line operator use