tailor 1.2.1 → 1.3.0

data/Rakefile

@@ -45,18 +45,10 @@ end
 # yard
 #------------------------------------------------------------------------------
 YARD::Rake::YardocTask.new do |t|
-  t.files = %w(lib/**/*.rb - History.rdoc)
+  t.files = %w(lib/**/*.rb - History.md)
   t.options = %w(--private --protected --verbose)
 end
 
-namespace :yard do
-  YARD::Rake::YardocTask.new(:with_features) do |t|
-    YARD::Config.load_plugin 'cucumber'
-
-    t.files = %w(lib/**/*.rb features/**/*.feature - History.rdoc)
-  end
-end
-
 
 desc "Run RSpec examples and Cucumber features"
 task test: [:spec, :features]

data/lib/ext/string_ext.rb

@@ -7,7 +7,7 @@ class String
     self.gsub(/::/, '/').
       gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
       gsub(/([a-z\d])([A-Z])/, '\1_\2').
-      tr("-", "_").
+      tr('-', '_').
       downcase
   end
 end

data/lib/tailor/cli.rb

@@ -47,7 +47,9 @@ class Tailor
         @reporter.file_report(problems_for_file, label)
       end
 
-      @reporter.summary_report(@critic.problems, output_file: @configuration.output_file)
+      @reporter.summary_report(@critic.problems,
+        output_file: @configuration.output_file)
+
       @critic.problem_count(:error) > 0
     end
 

data/lib/tailor/cli/options.rb

@@ -9,9 +9,11 @@ require_relative '../configuration'
 class Tailor
   class CLI
     class Options
+      INTEGER_OR_OFF = /^(\d+|false|off)$/
       @output_color = true
 
       def self.parse!(args)
+        register_custom_option_types
         options = OpenStruct.new
         options.config_file = ''
         options.output_file = ''
@@ -21,32 +23,32 @@ class Tailor
 
         opts = OptionParser.new do |opt|
           opt.banner = self.banner
-          opt.separator ""
-          opt.separator "  " + ("-" * 73)
-          opt.separator ""
-          opt.separator "Config file options:"
+          opt.separator ''
+          opt.separator '  ' + ('-' * 73)
+          opt.separator ''
+          opt.separator 'Config file options:'
           opt.on('-s', '--show-config', 'Show your current config.') do
             options.show_config = true
           end
 
           opt.on('-c', '--config-file FILE',
-            "Use a specific config file.") do |config|
+            'Use a specific config file.') do |config|
             options.config_file = config
           end
 
           opt.on('-o', '--output-file FILE',
-            "Print result in a output file if using the proper formatter.") do |output|
+            'Print result in a output file if using the proper formatter.') do |output|
             options.output_file = output
           end
 
           opt.on('--create-config', 'Create a new .tailor file') do
             if create_config
-              msg = "Your new tailor config file was created at "
+              msg = 'Your new tailor config file was created at '
               msg << "#{Dir.pwd}/.tailor"
               $stdout.puts msg
               exit
             else
-              $stderr.puts "Creation of .tailor failed!"
+              $stderr.puts 'Creation of .tailor failed!'
               exit 1
             end
           end
@@ -54,14 +56,14 @@ class Tailor
           #---------------------------------------------------------------------
           # Style options
           #---------------------------------------------------------------------
-          opt.separator ""
-          opt.separator "Style Options:"
+          opt.separator ''
+          opt.separator 'Style Options:'
           opt.separator "  (Any option that doesn't have an explicit way of"
-          opt.separator "  turning it off can be done so simply by passing"
+          opt.separator '  turning it off can be done so simply by passing'
           opt.separator "  passing it 'false'.)"
 
-          opt.separator ""
-          opt.separator "  * Horizontal Spacing:"
+          opt.separator ''
+          opt.separator '  * Horizontal Spacing:'
           opt.on('--allow-hard-tabs BOOL',
             'Check for hard tabs?  (default: true)') do |c|
             options.style[:allow_hard_tabs] = c
@@ -73,70 +75,75 @@ class Tailor
             options.style[:allow_trailing_line_spaces] = c
           end
 
-          opt.on('--indentation-spaces NUMBER',
+          opt.on('--indentation-spaces NUMBER', INTEGER_OR_OFF,
             'Spaces to expect indentation.  (default: 2)') do |c|
             options.style[:indentation_spaces] = c
           end
 
-          opt.on('--max-line-length NUMBER',
+          opt.on('--max-line-length NUMBER', INTEGER_OR_OFF,
             'Max characters in a line. (default: 80)') do |c|
             options.style[:max_line_length] = c
           end
 
-          opt.on('--spaces-after-comma NUMBER',
+          opt.on('--spaces-after-comma NUMBER', INTEGER_OR_OFF,
             'Spaces to expect after a comma.  (default: 1)') do |c|
             options.style[:spaces_after_comma] = c
           end
 
-          opt.on('--spaces-before-comma NUMBER',
+          opt.on('--spaces-before-comma NUMBER', INTEGER_OR_OFF,
             'Spaces to expect before a comma.  (default: 0)') do |c|
             options.style[:spaces_before_comma] = c
           end
 
-          opt.on('--spaces-after-lbrace NUMBER',
+          opt.on('--spaces-after-conditional NUMBER', INTEGER_OR_OFF,
+            'Spaces to expect after a conditional.  (default: 1)') do |c|
+            options.style[:spaces_after_conditional] = c
+          end
+
+          opt.on('--spaces-after-lbrace NUMBER', INTEGER_OR_OFF,
             'Spaces to expect after a {.  (default: 1)') do |c|
             options.style[:spaces_after_lbrace] = c
           end
 
-          opt.on('--spaces-before-lbrace NUMBER',
+          opt.on('--spaces-before-lbrace NUMBER', INTEGER_OR_OFF,
             'Spaces to expect before a {.  (default: 1)') do |c|
             options.style[:spaces_before_lbrace] = c
           end
 
-          opt.on('--spaces-before-rbrace NUMBER', Integer,
+          opt.on('--spaces-before-rbrace NUMBER', INTEGER_OR_OFF,
             'Spaces to expect before a }.  (default: 1)') do |c|
             options.style[:spaces_before_rbrace] = c
           end
 
-          opt.on('--spaces-in-empty-braces NUMBER', Integer,
+          opt.on('--spaces-in-empty-braces NUMBER', INTEGER_OR_OFF,
             'Spaces to expect between a { and }.  (default: 0)') do |c|
             options.style[:spaces_in_empty_braces] = c
           end
 
-          opt.on('--spaces-after-lbracket NUMBER', Integer,
+          opt.on('--spaces-after-lbracket NUMBER', INTEGER_OR_OFF,
             'Spaces to expect after a [.  (default: 0)') do |c|
             options.style[:spaces_after_lbracket] = c
           end
 
-          opt.on('--spaces-before-rbracket NUMBER', Integer,
+          opt.on('--spaces-before-rbracket NUMBER', INTEGER_OR_OFF,
             'Spaces to expect before a ].  (default: 0)') do |c|
             options.style[:spaces_before_rbracket] = c
           end
 
-          opt.on('--spaces-after-lparen NUMBER', Integer,
+          opt.on('--spaces-after-lparen NUMBER', INTEGER_OR_OFF,
             'Spaces to expect after a (.  (default: 0)') do |c|
             options.style[:spaces_after_lparen] = c
           end
 
-          opt.on('--spaces-before-rparen NUMBER', Integer,
+          opt.on('--spaces-before-rparen NUMBER', INTEGER_OR_OFF,
             'Spaces to expect before a ).  (default: 0)') do |c|
             options.style[:spaces_before_rparen] = c
           end
 
-          opt.separator ""
-          opt.separator ""
+          opt.separator ''
+          opt.separator ''
 
-          opt.separator "  * Naming:"
+          opt.separator '  * Naming:'
 
           opt.on('--allow-camel-case-methods BOOL',
             'Check for camel-case method names?', '(default: true)') do |c|
@@ -149,21 +156,21 @@ class Tailor
               instance_eval(c)
           end
 
-          opt.separator ""
-          opt.separator ""
-          opt.separator "  * Vertical Spacing"
+          opt.separator ''
+          opt.separator ''
+          opt.separator '  * Vertical Spacing'
 
-          opt.on('--max-code-lines-in-class NUMBER', Integer,
+          opt.on('--max-code-lines-in-class NUMBER', INTEGER_OR_OFF,
             'Max number lines of code in a class.', '(default: 300)') do |c|
             options.style[:max_code_lines_in_class] = c
           end
 
-          opt.on('--max-code-lines-in-method NUMBER', Integer,
+          opt.on('--max-code-lines-in-method NUMBER', INTEGER_OR_OFF,
             'Max number lines of code in a method.', '(default: 30)') do |c|
             options.style[:max_code_lines_in_method] = c
           end
 
-          opt.on('--trailing-newlines NUMBER', Integer,
+          opt.on('--trailing-newlines NUMBER', INTEGER_OR_OFF,
             'Newlines to expect at the end of the file.', '(default: 1)') do |c|
             options.style[:trailing_newlines] = c
           end
@@ -171,8 +178,8 @@ class Tailor
           #---------------------------------------------------------------------
           # Common options
           #---------------------------------------------------------------------
-          opt.separator ""
-          opt.separator "Common options:"
+          opt.separator ''
+          opt.separator 'Common options:'
 
 =begin
           opt.on('-f', '--format FORMATTER') do |format|
@@ -180,16 +187,16 @@ class Tailor
           end
 =end
 
-          opt.on('--[no-]color', "Output in color") do |color|
+          opt.on('--[no-]color', 'Output in color') do |color|
             @output_color = color
           end
 
-          opt.on_tail('-v', '--version', "Show the version") do
+          opt.on_tail('-v', '--version', 'Show the version') do
             puts version
             exit
           end
 
-          opt.on_tail('-d', '--debug', "Turn on debug logging") do
+          opt.on_tail('-d', '--debug', 'Turn on debug logging') do
             Tailor::Logger.log = true
           end
 
@@ -269,6 +276,19 @@ tailor --show-config
           File.open('.tailor', 'w') { |f| f.write default_config_file }
         end
       end
+
+      def self.register_custom_option_types
+        # We need to be able to mark integer options as :off as zero may be a
+        # valid value.
+        OptionParser.accept(INTEGER_OR_OFF) do |s|
+          raise OptionParser::InvalidArgument unless s =~ INTEGER_OR_OFF
+          if s == false.to_s || s == 'off'
+            :off
+          else
+            s.to_i
+          end
+        end
+      end
     end
   end
 end

data/lib/tailor/configuration.rb

@@ -68,7 +68,7 @@ class Tailor
           get_file_sets_from_config_file
         end
       else
-        log "Creating default file set..."
+        log 'Creating default file set...'
         @file_sets = { default: FileSet.new(@runtime_file_list) }
       end
 
@@ -89,7 +89,8 @@ class Tailor
         log "Loading config from file: #{user_config_file}"
 
         begin
-          @config_from_file = instance_eval(File.read(user_config_file), user_config_file)
+          @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
           raise Tailor::RuntimeError,
@@ -122,7 +123,7 @@ class Tailor
         log "file set style: #{file_set[:style]}"
 
         if @file_sets[label]
-          log "label already exists.  Updating..."
+          log 'label already exists.  Updating...'
           @file_sets[label].update_file_list(file_set[:file_list])
           @file_sets[label].update_style(file_set[:style])
         else
@@ -145,7 +146,7 @@ class Tailor
 
       @options.style.each do |property, value|
         @file_sets.keys.each do |label|
-          if value == :off || value == "off"
+          if value == :off || value == 'off'
             @file_sets[label].style[property][1] = { level: :off }
           else
             @file_sets[label].style[property][0] = value
@@ -213,7 +214,9 @@ class Tailor
     # @param [String] file_expression The expression to match recursively.
     # @param [Symbol] label The file set label to use.
     def recursive_file_set(file_expression, label=:default)
-      file_set("*/**/#{file_expression}", label)
+      file_set("*/**/#{file_expression}", label) do |style|
+        yield style if block_given?
+      end
     end
 
     # Displays the current configuration as a text table.

data/lib/tailor/configuration/file_set.rb

@@ -99,11 +99,9 @@ class Tailor
       # @param [String] base_dir The directory to get the file list for.
       # @return [Array<String>] The List of files.
       def all_files_in_dir(base_dir)
-        files = Dir.glob(File.join(base_dir, '**', '*')).find_all do |file|
+        Dir.glob(File.join(base_dir, '**', '*')).find_all do |file|
           file if File.file?(file)
         end
-
-        files
       end
     end
   end

data/lib/tailor/configuration/style.rb

@@ -35,6 +35,7 @@ class Tailor
       define_property :max_code_lines_in_method
       define_property :max_line_length
       define_property :spaces_after_comma
+      define_property :spaces_after_conditional
       define_property :spaces_after_lbrace
       define_property :spaces_after_lbracket
       define_property :spaces_after_lparen
@@ -58,6 +59,7 @@ class Tailor
         max_code_lines_in_method(30, level: :error)
         max_line_length(80, level: :error)
         spaces_after_comma(1, level: :error)
+        spaces_after_conditional(1, level: :error)
         spaces_after_lbrace(1, level: :error)
         spaces_after_lbracket(0, level: :error)
         spaces_after_lparen(0, level: :error)

data/lib/tailor/critic.rb

@@ -65,7 +65,7 @@ class Tailor
       log "<#{self.class}> Checking style of file: #{file}."
       lexer = Tailor::Lexer.new(file)
       ruler = Ruler.new
-      log "Style:"
+      log 'Style:'
       style.each { |property, values| log "#{property}: #{values}" }
       init_rulers(style, lexer, ruler)
 
@@ -89,7 +89,7 @@ class Tailor
       style.each do |ruler_name, values|
         ruler = "Tailor::Rulers::#{camelize(ruler_name.to_s)}Ruler"
 
-        if values.last[:level] == :off || values.last[:level] == "off"
+        if values.last[:level] == :off || values.last[:level] == 'off'
           msg = "Style option set to '#{values.last[:level]}'; "
           log msg << "skipping init of '#{ruler}'"
           next

data/lib/tailor/formatters/text.rb

@@ -21,7 +21,7 @@ class Tailor
       # @return [String] The portion of the header that displays the file info.
       def file_header(file)
         file = Pathname(file)
-        message = "# "
+        message = '# '
         message << underscore { "File:\n" }
         message << "#   #{file.relative_path_from(@pwd)}\n"
         message << "#\n"
@@ -32,7 +32,7 @@ class Tailor
       # @return [String] The portion of the header that displays the file_set
       #   label info.
       def file_set_header(file_set)
-        message = "# "
+        message = '# '
         message << underscore { "File Set:\n" }
         message << "#   #{file_set}\n"
         message << "#\n"
@@ -43,19 +43,19 @@ class Tailor
       # @return [String] The portion of the report that displays all of the
       #   problems for the file.
       def problems_header(problem_list)
-        message = "# "
+        message = '# '
         message << underscore { "Problems:\n" }
 
         problem_list.each_with_index do |problem, i|
           color = PROBLEM_LEVEL_COLORS[problem[:level]] || 'white'
 
           position = position(problem[:line], problem[:column])
-          message << "#  " + bold { "#{(i + 1)}." } + "\n"
-          message << "#    * position:  "
+          message << '#  ' + bold { "#{(i + 1)}." } + "\n"
+          message << '#    * position:  '
           message << bold { instance_eval("#{color} position") } + "\n"
-          message << "#    * property:  "
+          message << '#    * property:  '
           message << instance_eval("#{color} problem[:type].to_s") + "\n"
-          message << "#    * message:   "
+          message << '#    * message:   '
           message << instance_eval("#{color} problem[:message].to_s") + "\n"
         end
 
@@ -108,14 +108,14 @@ class Tailor
             bold { report_line }
           end
 
-          summary_table << "# " << report_line << reset << "|\n"
+          summary_table << '# ' << report_line << reset << "|\n"
           i += 1
         end
 
         summary_table << line
         summary_table << summary_level_totals(problems)
-        summary_table << "#   " << bold{ summary_first_col('TOTAL', 67) }
-        summary_table << "|"
+        summary_table << '#   ' << bold{ summary_first_col('TOTAL', 67) }
+        summary_table << '|'
         summary_table << bold { total_problems(problems).to_s.rjust(6) }
         summary_table << " |\n"
         summary_table << line
@@ -125,7 +125,7 @@ class Tailor
 
       def summary_header
         summary_table = line
-        summary_table << "# "
+        summary_table << '# '
         summary_table << bold { 'Tailor Summary'.rjust(40)  }
         summary_table << "|\n".rjust(39)
         summary_table << line
@@ -142,7 +142,8 @@ class Tailor
         relative_path = file.relative_path_from(@pwd)
         problem_count = problem_list.size
 
-        "#{summary_first_col(relative_path)} | " + problem_count.to_s.rjust(5) + " "
+        "#{summary_first_col(relative_path)} | " +
+          problem_count.to_s.rjust(5) + ' '
       end
 
       def summary_first_col(path, string_size=MAX_STRING_SIZE)
@@ -155,14 +156,14 @@ class Tailor
       end
 
       def summary_level_totals(problems)
-        return "" if total_problems(problems).zero?
+        return '' if total_problems(problems).zero?
 
-        output = problem_levels(problems).inject("") do |result, level|
+        output = problem_levels(problems).inject('') do |result, level|
           color = PROBLEM_LEVEL_COLORS[level] || 'white'
 
-          result << "#   "
+          result << '#   '
           result << instance_eval("#{color} { summary_first_col(level.capitalize, 67) }")
-          result << "|"
+          result << '|'
           result << instance_eval("#{color} { problems_at_level(problems, level).size.to_s.rjust(6) }")
           result << " |\n"
         end