tailor 1.4.0 → 1.4.1

data/README.md

@@ -1,14 +1,14 @@
-# tailor
+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)
+alt="Build Status" />](http://travis-ci.org/turboladen/tailor) [![Code Climate](https://codeclimate.com/github/turboladen/tailor.png)](https://codeclimate.com/github/turboladen/tailor)
 
-## DESCRIPTION:
+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
@@ -18,7 +18,8 @@ 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:
+FEATURES/PROBLEMS:
+------------------
 
 * Checks for bad style in Ruby files
     * Recursively in a directory, or...
@@ -61,17 +62,17 @@ project, whatever style that may be.
     * (Well, this may be stretching things a bit, but...) Exit 1 on failures
 
 
+SYNOPSIS:
+---------
 
-## SYNOPSIS:
-
-### Why style check?
+### 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?
+### 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
@@ -80,7 +81,7 @@ 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...
+### Since 0.x... ###
 
 tailor 1.x is a marked improvement over 0.x.  While 0.x provided a few (pretty
 inconsistent) style checks, its design made the code get all spaghetti-like,
@@ -88,7 +89,7 @@ with lots of really gnarly regular expression matching, making it a really bear
 to add new features and fix bugs.  tailor 1.x is completely redesigned to make
 that whole process much easier.
 
-### Measure Stuff
+### Measure Stuff ###
 
 Check *all* files in a directory:
 
@@ -131,7 +132,7 @@ require 'tailor/rake_task'
 Tailor::RakeTask.new
 ```
 
-#### On style...
+#### 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
@@ -199,7 +200,7 @@ 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:
+### 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
@@ -208,7 +209,7 @@ 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
+#### CLI ####
 
 At any time, you can tell tailor to show you the configuration that it's going
 to use by doing:
@@ -236,7 +237,7 @@ If you want to simply disable a ruler, just pass `off` to the option:
 $ tailor --max-line-length off lib/
 ```
 
-#### Configuration File
+#### 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
@@ -264,7 +265,7 @@ end
 
 This brings us to the concept of "file sets"...
 
-##### 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
@@ -330,7 +331,7 @@ Tailor.config do |config|
 end
 ```
 
-##### Formatters
+##### 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
@@ -346,36 +347,36 @@ Tailor.config do |config|
 end
 ```
 
-### Define A Custom Ruler
+### 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
+#### 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
+* 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_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
+#### Add the Ruler to the list of Styles ####
 
 Internally, this all happens in `lib/tailor/configuration/style.rb`, but you
 can add information about your ruler to your config file.  If you created a
@@ -427,7 +428,7 @@ end
 
 Next time you run tailor, your Ruler will get initialized and used.
 
-### Using the lib
+### Using the lib ###
 
 Sometimes you could use tailor as a lib, getting the results as a hash and
 manipulate them according your domain.
@@ -448,13 +449,12 @@ tailor = Tailor::CLI.new %w(--output-file=results.yaml)
 tailor.execute!
 ```
 
-## REQUIREMENTS:
+REQUIREMENTS:
+-------------
 
 * Rubies (tested)
-    * 1.9.3
-    * 2.0.0
-    * 2.1.0
-
+    * ruby-2.0.0
+    * ruby-2.1.4
 * Gems
     * log_switch
     * nokogiri
@@ -462,16 +462,29 @@ tailor.execute!
     * text-table
 
 
-
-## INSTALL:
+INSTALL:
+--------
 
     $ (sudo) gem install tailor
 
-## LICENSE:
+
+RELATED PROJECTS:
+-----------------
+
+* [rubocop](https://github.com/bbatsov/rubocop). *A robust Ruby code analyzer, based on the community Ruby style guide.*
+* [cane](https://github.com/square/cane). *Code quality threshold checking as part of your build*
+* [roodi](https://github.com/roodi/roodi).  *Ruby Object Oriented Design Inferometer*
+* [reek](https://github.com/troessner/reek/wiki). *Code smell detector for Ruby*
+* [flog](http://ruby.sadi.st/Ruby_Sadist.html). *Flog shows you the most torturous code you wrote. The more painful the code, the higher the score.*
+* [foodcritic](http://www.foodcritic.io).  *Foodcritic is a helpful lint tool you can use to check your Chef cookbooks for common problems.*
+* [metric_fu](https://github.com/metricfu/metric_fu).  *A fist full of code metrics*
+
+LICENSE:
+--------
 
 (The MIT License)
 
-Copyright (c) 2010-2013 Steve Loveless
+Copyright (c) 2010-2014 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

data/features/step_definitions/indentation_steps.rb

@@ -1,6 +1,6 @@
 Given /^(.+) exists with(\w*) a newline at the end$/ do |file_name, no_newline|
   file_contents = get_file_contents(file_name)
-  file_contents.should_not be_nil
+  expect(file_contents).to_not be_nil
 
   if no_newline.empty?
     file_contents << "\n" unless file_contents[-1] == "\n"

data/lib/tailor/reporter.rb

@@ -1,5 +1,4 @@
 class Tailor
-
   # Objects of this type are responsible for sending the right data to report
   # formatters.
   class Reporter
@@ -11,13 +10,26 @@ class Tailor
     #
     # @param [Array] formats A list of formatters to use for generating reports.
     def initialize(*formats)
-      @formatters = []
-      formats = %w[text] if formats.nil? || formats.empty?
+      formats = %w(text) if formats.nil? || formats.empty?
 
-      formats.flatten.each do |formatter|
-        require_relative "formatters/#{formatter}"
-        @formatters << eval("Tailor::Formatters::#{formatter.capitalize}.new")
-      end
+      @formatters = formats.flatten.map do |formatter|
+        retried = false
+
+        begin
+          Tailor::Formatters.const_get(formatter.capitalize).new
+        rescue NameError
+          require_relative "formatters/#{formatter}"
+
+          if retried
+            next
+          else
+            retried = true
+            retry
+          end
+        end
+      end.uniq
+
+      @formatters.compact!
     end
 
     # Sends the data to each +@formatters+ to generate the report of problems

data/lib/tailor/rulers/spaces_before_lbrace_ruler.rb

@@ -2,7 +2,6 @@ require_relative '../ruler'
 
 class Tailor
   module Rulers
-
     # Detects spaces before a +{+ as given by +@config+.  It skips checking
     # when:
     # * it's the first char in the line.

data/lib/tailor/rulers/spaces_before_rbrace_ruler.rb

@@ -2,7 +2,6 @@ require_relative '../ruler'
 
 class Tailor
   module Rulers
-
     # Checks for spaces before a +}+ as given by +@config+.  It skips checking
     # when:
     # * it's the first char in the line.

data/lib/tailor/rulers/spaces_in_empty_braces_ruler.rb

@@ -2,7 +2,6 @@ require_relative '../ruler'
 
 class Tailor
   module Rulers
-
     # Checks for spaces that exist between a +{+ and +}+ when there is only
     # space in between them.
     class SpacesInEmptyBracesRuler < Tailor::Ruler

data/lib/tailor/version.rb

@@ -1,3 +1,3 @@
 class Tailor
-  VERSION = '1.4.0'
+  VERSION = '1.4.1'
 end

data/spec/functional/conditional_parentheses_spec.rb

@@ -16,7 +16,7 @@ describe 'Conditional parentheses' do
   end
 
   before do
-    Tailor::Logger.stub(:log)
+    allow(Tailor::Logger).to receive(:log)
     FakeFS.activate!
     FileUtils.touch file_name
     File.open(file_name, 'w') { |f| f.write contents }

data/spec/functional/conditional_spacing_spec.rb

@@ -16,7 +16,7 @@ describe 'Conditional spacing' do
   end
 
   before do
-    Tailor::Logger.stub(:log)
+    allow(Tailor::Logger).to receive(:log)
     FakeFS.activate!
     FileUtils.touch file_name
     File.open(file_name, 'w') { |f| f.write contents }

data/spec/functional/configuration_spec.rb

@@ -1,10 +1,9 @@
 require 'spec_helper'
 require 'tailor/configuration'
 
-
 describe 'Config File' do
   before do
-    Tailor::Logger.stub(:log)
+    allow(Tailor::Logger).to receive(:log)
     FakeFS.deactivate!
   end
 
@@ -22,22 +21,24 @@ describe 'Config File' do
 
     context '.tailor does not exist' do
       before do
-        Tailor::Configuration.any_instance.stub(:config_file).and_return false
+        allow_any_instance_of(Tailor::Configuration).to receive(:config_file).
+          and_return false
       end
 
       it "sets formatters to 'text'" do
-        config.formatters.should == %w(text)
+        expect(config.formatters).to eq %w(text)
       end
 
       it 'sets file_sets[:default].style to the default style' do
-        config.file_sets[:default].style.should_not be_nil
-        config.file_sets[:default].style.should == Tailor::Configuration::Style.new.to_hash
+        expect(config.file_sets[:default].style).to_not be_nil
+        expect(config.file_sets[:default].style).
+          to eq Tailor::Configuration::Style.new.to_hash
       end
 
       it 'sets file_sets[:default].file_list to the files in lib/**/*.rb' do
-        config.file_sets[:default].file_list.all? do |path|
+        expect(config.file_sets[:default].file_list.all? do |path|
           path =~ /tailor\/lib/
-        end.should be_true
+        end).to eq true
       end
     end
 
@@ -56,23 +57,25 @@ end
         end
 
         before do
-          File.should_receive(:read).and_return config_file
+          expect(File).to receive(:read).and_return config_file
         end
 
         it 'creates the default file set' do
-          config.file_sets[:default].style.should == Tailor::Configuration::Style.new.to_hash
-          config.file_sets[:default].file_list.all? do |path|
+          expect(config.file_sets[:default].style).
+            to eq Tailor::Configuration::Style.new.to_hash
+
+          expect(config.file_sets[:default].file_list.all? do |path|
             path =~ /tailor\/lib/
-          end.should be_true
+          end).to eq true
         end
 
         it 'creates the :features file set' do
           style = Tailor::Configuration::Style.new
           style.max_line_length(90, level: :warn)
-          config.file_sets[:features].style.should == style.to_hash
-          config.file_sets[:features].file_list.all? do |path|
+          expect(config.file_sets[:features].style).to eq style.to_hash
+          expect(config.file_sets[:features].file_list.all? do |path|
             path =~ /features/
-          end.should be_true
+          end).to eq true
         end
       end
     end
@@ -89,15 +92,15 @@ end
       end
 
       before do
-        File.should_receive(:read).and_return config_file
+        expect(File).to receive(:read).and_return config_file
       end
 
       it 'does not create a :default file set' do
-        config.file_sets.should_not include :default
+        expect(config.file_sets).to_not include :default
       end
 
       it 'creates the non-default file set' do
-        config.file_sets.should include :features
+        expect(config.file_sets).to include :features
       end
     end
 
@@ -113,17 +116,17 @@ end
       end
 
       before do
-        File.should_receive(:read).and_return config_file
+        expect(File).to receive(:read).and_return config_file
       end
 
       it 'creates a :default file set' do
-        config.file_sets.keys.should == [:default]
+        expect(config.file_sets.keys).to eq [:default]
       end
 
       it 'has files in the file list levels deep' do
-        config.file_sets[:default].file_list.all? do |file|
+        expect(config.file_sets[:default].file_list.all? do |file|
           file =~ /spec\.rb$/
-        end.should be_true
+        end).to eq true
       end
 
       it 'applies the nested configuration within the fileset' do
@@ -144,21 +147,24 @@ end
 
     context '.tailor does not exist' do
       before do
-        Tailor::Configuration.any_instance.stub(:config_file).and_return false
+        allow_any_instance_of(Tailor::Configuration).
+          to receive(:config_file).and_return false
       end
 
       it "sets formatters to 'text'" do
-        config.formatters.should == %w(text)
+        expect(config.formatters).to eq %w(text)
       end
 
       it 'sets file_sets[:default].style to the default style' do
-        config.file_sets[:default].style.should_not be_nil
-        config.file_sets[:default].style.should == Tailor::Configuration::Style.new.to_hash
+        expect(config.file_sets[:default].style).to_not be_nil
+        expect(config.file_sets[:default].style).
+          to eq Tailor::Configuration::Style.new.to_hash
       end
 
       it 'sets file_sets[:default].file_list to the runtime files' do
-        config.file_sets[:default].file_list.size.should be 1
-        config.file_sets[:default].file_list.first.match /lib\/tailor\.rb$/
+        expect(config.file_sets[:default].file_list.size).to eq 1
+        expect(config.file_sets[:default].file_list.first).
+          to match(/lib\/tailor\.rb$/)
       end
     end
 
@@ -179,19 +185,20 @@ end
         end
 
         before do
-          File.should_receive(:read).and_return config_file
+          expect(File).to receive(:read).and_return config_file
         end
 
         it 'creates the default file set using the runtime files' do
           style = Tailor::Configuration::Style.new
           style.max_line_length 85
-          config.file_sets[:default].style.should == style.to_hash
-          config.file_sets[:default].file_list.size.should be 1
-          config.file_sets[:default].file_list.first.match /lib\/tailor\.rb$/
+          expect(config.file_sets[:default].style).to eq style.to_hash
+          expect(config.file_sets[:default].file_list.size).to eq 1
+          expect(config.file_sets[:default].file_list.first).
+            to match(/lib\/tailor\.rb$/)
         end
 
         it 'does not create the :features file set' do
-          config.file_sets.should_not include :features
+          expect(config.file_sets).to_not include :features
         end
       end
     end
@@ -208,17 +215,19 @@ end
       end
 
       before do
-        File.should_receive(:read).and_return config_file
+        expect(File).to receive(:read).and_return config_file
       end
 
-      it 'creates a :default file set with the runtime file and default style' do
-        config.file_sets[:default].style.should == Tailor::Configuration::Style.new.to_hash
-        config.file_sets[:default].file_list.size.should be 1
-        config.file_sets[:default].file_list.first.match /lib\/tailor\.rb$/
+      it 'creates a :default file set with the runtime file & default style' do
+        expect(config.file_sets[:default].style).
+          to eq Tailor::Configuration::Style.new.to_hash
+        expect(config.file_sets[:default].file_list.size).to eq 1
+        expect(config.file_sets[:default].file_list.first).
+          to match(/lib\/tailor\.rb$/)
       end
 
       it 'does not create the non-default file set' do
-        config.file_sets.should_not include :features
+        expect(config.file_sets).to_not include :features
       end
     end
 
@@ -234,20 +243,21 @@ end
       end
 
       before do
-        File.should_receive(:read).and_return config_file
+        expect(File).to receive(:read).and_return config_file
       end
 
       it 'creates a :default file set' do
-        config.file_sets.keys.should == [:default]
+        expect(config.file_sets.keys).to eq [:default]
       end
 
-      it 'creates a :default file set with the runtime file and default style' do
-        style = Tailor::Configuration::Style.new.tap do |style|
-          style.max_line_length 90, level: :warn
+      it 'creates a :default file set with the runtime file & default style' do
+        style = Tailor::Configuration::Style.new.tap do |s|
+          s.max_line_length 90, level: :warn
         end.to_hash
-        config.file_sets[:default].style.should == style
-        config.file_sets[:default].file_list.size.should be 1
-        config.file_sets[:default].file_list.first.match /lib\/tailor\.rb$/
+        expect(config.file_sets[:default].style).to eq style
+        expect(config.file_sets[:default].file_list.size).to eq 1
+        expect(config.file_sets[:default].file_list.first).
+          to match(/lib\/tailor\.rb$/)
       end
     end
 
@@ -261,11 +271,11 @@ end
       end
 
       before do
-        File.should_receive(:read).and_return config_file
+        expect(File).to receive(:read).and_return config_file
       end
 
       it "sets formatters to 'yaml'" do
-        config.formatters.should == %w(yaml)
+        expect(config.formatters).to eq %w(yaml)
       end
     end
 
@@ -279,13 +289,12 @@ end
       end
 
       before do
-        File.should_receive(:read).and_return config_file
+        expect(File).to receive(:read).and_return config_file
       end
 
       it 'sets formatters to the defined' do
-        config.formatters.should == %w(yaml text)
+        expect(config.formatters).to eq %w(yaml text)
       end
-
     end
   end
 end