tailor 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41c769db7aa919c9282bf71a4cd1d39b842eb2ca
-  data.tar.gz: 8901a21a9cb5f2caaf88acfdc19efdb4b4ccafd2
+  metadata.gz: 6f1026ecc89830b0c65269c0bd76a2704e5231f6
+  data.tar.gz: 038711b887bb8afcaa7236f214b502a058de9d6c
 SHA512:
-  metadata.gz: 602680b33686b2f8bdc3c2f6321fc45dd7efbaa9a5c49ea96333826ab952291e85fe0ff393fb6364d3e35c70c6b27cf1df92e8b93a3adb18a1839be3f98e9950
-  data.tar.gz: 2eaceca12a737d2f82cef77dc1437c15b3737ca6c5fbf4fea1384debd484d7c85b5423228fc7eb81d9a277484f1f395a8d5a40add7a6261ed1a4d0ff3f221796
+  metadata.gz: e22f50e1f616b69c4c431de2ba6e50021ee4cb03535744307c843ae24876dcdc1fba00da47660ef512fa13a65efbfa5aa844bc095e23051bda60d934b44bade8
+  data.tar.gz: b90cea7791ba0ef3415fadb5497fcc5e340e7f0352e81d3de6da22c391d4d02791ff81c4a279656fd147d65465bf8eeec634f13bc4c560128fc9410c06c458c6

data/.travis.yml

@@ -2,3 +2,4 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0

data/Gemfile.lock

@@ -1,59 +1,61 @@
 PATH
   remote: .
   specs:
-    tailor (1.3.0)
+    tailor (1.3.1)
       log_switch (>= 0.3.0)
+      nokogiri (>= 1.6.0)
       term-ansicolor (>= 1.0.5)
       text-table (>= 1.2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    aruba (0.5.3)
+    aruba (0.5.4)
       childprocess (>= 0.3.6)
       cucumber (>= 1.1.1)
       rspec-expectations (>= 2.7.0)
     builder (3.2.2)
-    childprocess (0.3.9)
+    childprocess (0.4.0)
       ffi (~> 1.0, >= 1.0.11)
-    cucumber (1.3.8)
+    cucumber (1.3.10)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
-      gherkin (~> 2.12.1)
+      gherkin (~> 2.12)
       multi_json (>= 1.7.5, < 2.0)
       multi_test (>= 0.0.2)
-    diff-lcs (1.2.4)
-    fakefs (0.4.3)
-    ffi (1.9.0)
-    ffi (1.9.0-java)
-    gherkin (2.12.1)
-      multi_json (~> 1.3)
-    gherkin (2.12.1-java)
+    diff-lcs (1.2.5)
+    docile (1.1.2)
+    fakefs (0.5.0)
+    ffi (1.9.3)
+    gherkin (2.12.2)
       multi_json (~> 1.3)
     log_switch (0.4.0)
-    multi_json (1.8.0)
-    multi_test (0.0.2)
-    rake (10.1.0)
+    mini_portile (0.5.2)
+    multi_json (1.8.4)
+    multi_test (0.0.3)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    rake (10.1.1)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.5)
-    rspec-expectations (2.14.3)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
+    rspec-mocks (2.14.4)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
     term-ansicolor (1.2.2)
       tins (~> 0.8)
     text-table (1.2.3)
-    tins (0.11.0)
-    yard (0.8.7.2)
+    tins (0.13.1)
+    yard (0.8.7.3)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES

data/History.md

@@ -1,3 +1,39 @@
+### 1.4.0 2014-01-23
+
+* Features
+    * Added Ruby 2.1.0 to the list of tested Rubies.
+    * Overall better indentation checking.
+    * [gh-143](https://github.com/turboladen/tailor/issues/143) and
+      [gh-102](https://github.com/turboladen/tailor/issues/102)
+        * The indentation ruler can now be told, using the `:line_continuations`
+          option, that when a statement spans multiple lines, second and
+          subsequent lines are/are not indented. See [these tests](https://github.com/turboladen/tailor/blob/aca324e449d3814c4473db3c28a7f719c0023750/spec/functional/indentation_spacing/line_continuations_spec.rb)
+          for more info.
+    * [gh-144](https://github.com/turboladen/tailor/issues/143) and
+      [gh-94](https://github.com/turboladen/tailor/issues/94)
+        * Added the `:argument_alignment` option to the indentation ruler,
+          which tells tailor to expect method declarations and calls that span
+          multiple lines to have their params be indented to the same spot
+          as the first param of the first line.  See [these tests](https://github.com/acrmp/tailor/blob/f8f3cb3c69bd4704cf8548d2c119a8d196a92043/spec/functional/indentation_spacing/argument_alignment_spec.rb)
+          for more info.
+    * [gh-148](https://github.com/turboladen/tailor/issues/148)
+        * Added new ruler: `allow_conditional_parentheses`.  This lets you
+          tell tailor to expect parentheses around statements that conditionals
+          check.  Defaults to true.
+    * [gh-149](https://github.com/turboladen/tailor/issues/149)
+        * Added new ruler: `allow_unnecessary_interpolation`.  This lets you
+          tell tailor to check for strings that use interpolation, but do it in
+          a gross way.  Defaults to false.
+    * [gh-150](https://github.com/turboladen/tailor/issues/150)
+        * Added new ruler: `allow_unnecessary_double_quotes`.  This lets you
+          tell tailor to check for strings that use double-quotes but aren't
+          doing interpolation.  Defaults to false.
+* Bug fixes
+    * [gh-154](https://github.com/turboladen/tailor/issues/154)
+        * Fixed indentation when do/end block chained on a {} block.  This
+          change also simplified IndentationManager.  Thanks @hollow!
+
+
 ### 1.3.1 2013-09-29
 
 * Bug fixes

data/README.md

@@ -43,6 +43,10 @@ project, whatever style that may be.
     * Name cases
         * Snake case class & module names
         * Camel case method names
+    * Common syntax
+        * Conditionals wrapped in parentheses
+        * Unnecessary interpolation in strings
+        * Unnecessary use of double-quotes for strings
     * Valid Ruby (warns by default)
 * Configurable
     * Specify style in
@@ -78,9 +82,9 @@ 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
+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,
-with lots of really gnarly regular expression matching, making it a realy bear
+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.
 
@@ -273,7 +277,7 @@ In the default config file, you see a single parameter being passed to
 `config.file_set`--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
+different sets of style properties for different 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.
@@ -374,7 +378,7 @@ Ruler must have:
 #### 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
+can add information about your ruler to your config file.  If you created a
 Ruler:
 
 ```ruby
@@ -449,9 +453,11 @@ tailor.execute!
 * Rubies (tested)
     * 1.9.3
     * 2.0.0
+    * 2.1.0
 
 * Gems
     * log_switch
+    * nokogiri
     * term-ansicolor
     * text-table
 

data/Rakefile

@@ -18,19 +18,19 @@ end
 RSpec::Core::RakeTask.new
 
 namespace :spec do
-  desc "Run specs with Ruby warnings turned on"
+  desc 'Run specs with Ruby warnings turned on'
   RSpec::Core::RakeTask.new(:warn) do |t|
     t.ruby_opts = %w(-w)
   end
 
-  desc "Run unit tests"
+  desc 'Run unit tests'
   RSpec::Core::RakeTask.new(:unit) do |t|
-    t.pattern = "./spec/unit/**/*_spec.rb"
+    t.pattern = './spec/unit/**/*_spec.rb'
   end
 
-  desc "Run functional tests"
+  desc 'Run functional tests'
   RSpec::Core::RakeTask.new(:functional) do |t|
-    t.pattern = "./spec/functional/**/*_spec.rb"
+    t.pattern = './spec/functional/**/*_spec.rb'
   end
 end
 
@@ -50,6 +50,6 @@ YARD::Rake::YardocTask.new do |t|
 end
 
 
-desc "Run RSpec examples and Cucumber features"
+desc 'Run RSpec examples and Cucumber features'
 task test: [:spec, :features]
 task default: [:test]

data/features/support/env.rb

@@ -2,6 +2,6 @@ require 'aruba/cucumber'
 require 'simplecov'
 
 SimpleCov.start do
-  add_group "Features", "features/"
-  add_group "Lib", "lib"
+  add_group 'Features', 'features/'
+  add_group 'Lib', 'lib'
 end

data/features/support/legacy/bad_ternary_colon_spacing.rb

@@ -17,7 +17,7 @@ bobo = true ? true :  false
 bobo = true ? true  : false
 
 # Skip when colon is part of a symbol or namespace operator
-bobo = { :thing => ":clown" }
+bobo = { thing: ":clown" }
 bobo[:thing] == :dog ? bobo[:thing] : Math::PI
 
 # Skip when colon is part of Regexp class

data/features/support/legacy/long_file_with_indentation.rb

@@ -31,8 +31,8 @@ module MyModule
       # This is another comment
       an_array = [1, 2, 3]
       a_hash = {
-        :one => 1,
-        :two => 2
+        one: 1,
+        two: 2
       }
 
       if true

data/features/support/world.rb

@@ -6,7 +6,7 @@ module IndentationHelpers
   # @return [String]
   def get_file_contents(file_name)
     path_chunks = file_name.split('/')
-    const_name = path_chunks.first(2).each { |c| c.upcase! }.join("_")
+    const_name = path_chunks.first(2).each { |c| c.upcase! }.join('_')
     const = Kernel.const_get(const_name)
 
     const[path_chunks.last.to_sym]

data/features/valid_ruby.feature

@@ -7,7 +7,7 @@ Feature: Valid Ruby
     Given a file named "extra_end.rb" with:
     """
     def a_method
-      puts "stuff"
+      puts 'stuff'
     end
     end
 

data/lib/tailor/cli/options.rb

@@ -64,6 +64,12 @@ class Tailor
 
           opt.separator ''
           opt.separator '  * Horizontal Spacing:'
+
+          opt.on('--allow-conditional-parentheses BOOL',
+            'Check for conditionals wrapped in parentheses?  (default: true)') do |c|
+            options.style[:allow_conditional_parentheses] = c
+          end
+
           opt.on('--allow-hard-tabs BOOL',
             'Check for hard tabs?  (default: true)') do |c|
             options.style[:allow_hard_tabs] = c
@@ -75,6 +81,18 @@ class Tailor
             options.style[:allow_trailing_line_spaces] = c
           end
 
+          opt.on('--allow-unnecessary-interpolation BOOL',
+            'Check for unnecessary interpolation in strings?',
+            '(default: false)') do |c|
+            options.style[:allow_unnecessary_interpolation] = c
+          end
+
+          opt.on('--allow-unnecessary-double-quotes BOOL',
+            'Check for unnecessary use of double quotes?',
+            '(default: false)') do |c|
+            options.style[:allow_unnecessary_double_quotes] = c
+          end
+
           opt.on('--indentation-spaces NUMBER', INTEGER_OR_OFF,
             'Spaces to expect indentation.  (default: 2)') do |c|
             options.style[:indentation_spaces] = c
@@ -200,7 +218,7 @@ class Tailor
             Tailor::Logger.log = true
           end
 
-          opt.on_tail('-h', '--help', 'Show this message') do |help|
+          opt.on_tail('-h', '--help', 'Show this message') do |_|
             puts opt
             exit
           end

data/lib/tailor/configuration.rb

@@ -92,7 +92,7 @@ class Tailor
           @config_from_file =
             instance_eval(File.read(user_config_file), user_config_file)
           log "Got new config from file: #{user_config_file}"
-        rescue LoadError => ex
+        rescue LoadError
           raise Tailor::RuntimeError,
             "Couldn't load config file: #{user_config_file}"
         end
@@ -162,7 +162,7 @@ class Tailor
 
       # Only use options set for the :default file set because the user gave
       # a different set of files to measure.
-      @file_sets.delete_if { |k, v| k != :default }
+      @file_sets.delete_if { |k, _| k != :default }
 
       if @file_sets.include? :default
         @file_sets[:default].file_list = @runtime_file_list

data/lib/tailor/configuration/style.rb

@@ -26,10 +26,13 @@ class Tailor
       end
 
       define_property :allow_camel_case_methods
+      define_property :allow_conditional_parentheses
       define_property :allow_hard_tabs
       define_property :allow_screaming_snake_case_classes
       define_property :allow_trailing_line_spaces
+      define_property :allow_unnecessary_double_quotes
       define_property :allow_invalid_ruby
+      define_property :allow_unnecessary_interpolation
       define_property :indentation_spaces
       define_property :max_code_lines_in_class
       define_property :max_code_lines_in_method
@@ -50,9 +53,12 @@ class Tailor
       # Sets up default values.
       def initialize
         allow_camel_case_methods(false, level: :error)
+        allow_conditional_parentheses(false, level: :warn)
         allow_hard_tabs(false, level: :error)
         allow_screaming_snake_case_classes(false, level: :error)
         allow_trailing_line_spaces(false, level: :error)
+        allow_unnecessary_interpolation(false, level: :warn)
+        allow_unnecessary_double_quotes(false, level: :warn)
         allow_invalid_ruby(false, level: :warn)
         indentation_spaces(2, level: :error)
         max_code_lines_in_class(300, level: :error)

data/lib/tailor/lexed_line.rb

@@ -174,7 +174,7 @@ class Tailor
 
     # @param [Fixnum] column Number of the column to get the event for.
     # @return [Array] The event at the given column.
-    def event_at column
+    def event_at(column)
       self.find { |e| e.first.last == column }
     end
 
@@ -186,7 +186,7 @@ class Tailor
     # @param [Fixnum] column Number of the column of which event to get the
     #   index for.
     # @return [Fixnum] The index within +self+ that the event is at.
-    def event_index column
+    def event_index(column)
       column_event = self.event_at column
       self.index(column_event)
     end

data/lib/tailor/lexer/lexer_constants.rb

@@ -49,6 +49,7 @@ class Tailor
       'while' => :while_mod
     }
 
+    #noinspection RubyLiteralArrayInspection
     MULTILINE_OPERATORS = Set.new [
       '+', '-', '*', '**', '/', '%',    # +, -, tSTAR, tPOW, /, %
       '<', '>', '<=', '>=',             # <, >, tLEQ, tGEQ

data/lib/tailor/lexer/token.rb

@@ -7,7 +7,7 @@ class Tailor
 
     # Helper methods for tokens that are parsed by {Tailor::Lexer}.
     class Token < String
-      include LexerConstants
+      include Tailor::LexerConstants
       include Tailor::Logger::Mixin
 
       # @param [String] the_token
@@ -63,7 +63,7 @@ class Tailor
       # @return [Boolean] True if there's a modifier in the current line that
       #   is the same type as +token+.
       def modifier_keyword?
-        return false if not keyword_to_indent?
+        return false unless keyword_to_indent?
 
         line_of_text = @options[:full_line_of_text]
         log "Line of text: #{line_of_text}"

data/lib/tailor/logger.rb

@@ -10,7 +10,7 @@ class Tailor
       return @logger if @logger
       @logger ||= ::Logger.new $stdout
 
-      def @logger.format_message(level, time, progname, msg)
+      def @logger.format_message(_, time, _, msg)
         "[#{time.strftime('%Y-%m-%d %H:%M:%S')}]  #{msg}\n"
       end
 
@@ -20,7 +20,7 @@ class Tailor
     # Provides an .included hook to insert the name of the class for each log
     # message in the class that includes the Mixin.
     module Mixin
-      def self.included(base)
+      def self.included(_)
         define_method :log do |*args|
           class_minus_main_name = self.class.to_s.sub(/^.*::/, '')
           args.first.insert(0, "<#{class_minus_main_name}> ")

data/lib/tailor/rake_task.rb

@@ -133,7 +133,7 @@ class Tailor
     end
 
     # @param [Tailor::Configuration] config
-    def create_recursive_file_sets_for config
+    def create_recursive_file_sets_for(config)
       unless @recursive_file_sets.empty?
         @recursive_file_sets.each do |fs|
           config.recursive_file_set(fs[0], fs[1], &fs[2])
@@ -142,7 +142,7 @@ class Tailor
     end
 
     # @param [Tailor::Configuration] config
-    def create_file_sets_for config
+    def create_file_sets_for(config)
       unless @file_sets.empty?
         @file_sets.each { |fs| config.file_set(fs[0], fs[1], &fs[2]) }
       end