tailor 1.0.0.alpha2 → 1.0.0

data/features/support/file_cases/naming_cases.rb

@@ -49,4 +49,3 @@ end}
 NAMING_1[:two_screaming_snake_module_class] =
   %Q{module Thing_One_Again
 end}
-

data/features/support/file_cases/vertical_spacing_cases.rb

@@ -67,4 +67,3 @@ V_SPACING_1[:parent_method_too_long] =
   def inner_thing; print '1'; end
   puts
 end}
-

data/features/support/legacy/bad_ternary_colon_spacing.rb

@@ -28,4 +28,4 @@ $:.unshift File.dirname(__FILE__)
 
 # Skip when question mark method is followed by a symbol
 if bobo[:thing].eql? :clown
-end
+end

data/features/valid_ruby.feature

@@ -0,0 +1,17 @@
+Feature: Valid Ruby
+  As a Ruby developer, I want to check my project files to make sure they're
+  valid Ruby, so when I see other tailor problems, I know why those problems
+  might be there.
+
+  Scenario: Extra 'end'
+    Given a file named "extra_end.rb" with:
+    """
+    def a_method
+      puts "stuff"
+    end
+    end
+
+    """
+    When I run `tailor -d extra_end.rb`
+    Then the output should match /Total Problems.*1/
+    And the output should match /File contains invalid Ruby/

data/features/vertical_spacing.feature

@@ -2,18 +2,6 @@ Feature: Vertical spacing
   As a Ruby developer
   I want to check my Ruby files for vertical spacing
 
-  Background:
-    Given my configuration file ".tailor" looks like:
-    """
-    Tailor.config do |config|
-      config.file_set do
-        max_code_lines_in_class 5
-        max_code_lines_in_method 3
-        trailing_newlines 0
-      end
-    end
-    """
-
   @bad_files
   Scenario: Detect lack of newlines
     Given a file named "not_enough_newlines.rb" with:
@@ -52,11 +40,20 @@ Feature: Vertical spacing
     When I run `tailor -d .`
     Then the output should match /Total Problems.*0/
 
-  @good_files @class_length
+  @multi_line @good_files
 
-  @multi_line
+  @class_length
   Scenario Outline: Classes/modules with <= configured lines
-    Given <File> exists without a newline at the end
+    Given my configuration file ".tailor" looks like:
+    """
+    Tailor.config do |config|
+      config.file_set do |style|
+        style.max_code_lines_in_class 5
+        style.trailing_newlines 0
+      end
+    end
+    """
+    And <File> exists without a newline at the end
     When I run `tailor -d -c .tailor <File>`
     Then the output should match /Total Problems.*0/
     And the exit status should be 0
@@ -70,7 +67,15 @@ Feature: Vertical spacing
 
   @multi_line
   Scenario Outline: Lines with bad spacing around parens
-    Given <File> exists without a newline at the end
+    Given my configuration file ".tailor" looks like:
+    """
+    Tailor.config do |config|
+      config.file_set do |style|
+        style.max_code_lines_in_class 5
+      end
+    end
+    """
+    And <File> exists without a newline at the end
     When I run `tailor -d -c .tailor <File>`
     Then the output should match /Total Problems.*<Problems>/
     And the output should match /position:  <Position>/
@@ -86,7 +91,16 @@ Feature: Vertical spacing
 
   @multi_line
   Scenario Outline: Methods with <= configured lines
-    Given <File> exists without a newline at the end
+    Given my configuration file ".tailor" looks like:
+    """
+    Tailor.config do |config|
+      config.file_set do |style|
+        style.max_code_lines_in_method 3
+        style.trailing_newlines 0
+      end
+    end
+    """
+    And <File> exists without a newline at the end
     When I run `tailor -d -c .tailor <File>`
     Then the output should match /Total Problems.*0/
     And the exit status should be 0
@@ -100,7 +114,15 @@ Feature: Vertical spacing
 
   @multi_line
   Scenario Outline: Lines with bad spacing around parens
-    Given <File> exists without a newline at the end
+    Given my configuration file ".tailor" looks like:
+    """
+    Tailor.config do |config|
+      config.file_set do |style|
+        style.max_code_lines_in_method 3
+      end
+    end
+    """
+    And <File> exists without a newline at the end
     When I run `tailor -d -c .tailor <File>`
     Then the output should match /Total Problems.*<Problems>/
     And the output should match /position:  <Position>/
@@ -111,4 +133,3 @@ Feature: Vertical spacing
     | File                               | Position | Position 2 | Problems |
     | v_spacing/1/method_too_long        | 1:0      |            | 1        |
     | v_spacing/1/parent_method_too_long | 1:0      |            | 1        |
-

data/lib/ext/string_ext.rb

@@ -2,4 +2,16 @@ require 'term/ansicolor'
 
 class String
   include Term::ANSIColor
+
+  # Borrowed from ActiveSupport, this converts camel-case Strings to
+  # snake-case.
+  #
+  # @return [String]
+  def underscore
+    self.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+      gsub(/([a-z\d])([A-Z])/, '\1_\2').
+      tr("-", "_").
+      downcase
+  end
 end

data/lib/tailor/cli.rb

@@ -6,8 +6,8 @@ require_relative 'reporter'
 
 class Tailor
 
-  # The Command-Line Interface worker.  Execution from the command line should
-  # come through here.
+  # The Command-Line Interface worker.  Execution from the command line
+  # comes through here.
   class CLI
     include LogSwitch::Mixin
 
@@ -16,6 +16,7 @@ class Tailor
       new(args).execute!
     end
 
+    # @param [Array] args Arguments from the command-line.
     def initialize(args)
       Tailor::Logger.log = false
       options = Options.parse!(args)
@@ -25,19 +26,20 @@ class Tailor
 
       if options.show_config
         @configuration.show
+        exit
       end
 
-      @critic = Critic.new(@configuration.file_sets)
+      @critic = Critic.new
       @reporter = Reporter.new(@configuration.formatters)
     end
 
     # This checks all of the files detected during the configuration gathering
-    # process, then hands results over to the {Reporter} to be reported.
+    # process, then hands results over to the {Tailor::Reporter} to be reported.
     #
     # @return [Boolean] +true+ if no problems were detected; false if there
     #   were.
     def execute!
-      @critic.critique do |problems_for_file, label|
+      @critic.critique(@configuration.file_sets) do |problems_for_file, label|
         @reporter.file_report(problems_for_file, label)
       end
 

data/lib/tailor/cli/options.rb

@@ -19,8 +19,8 @@ class Tailor
 
         opts = OptionParser.new do |opt|
           opt.banner = self.banner
-
           opt.separator ""
+          opt.separator "  " + ("-" * 73)
           opt.separator ""
           opt.separator "Config file options:"
           opt.on('-s', '--show-config', 'Show your current config.') do
@@ -35,7 +35,7 @@ class Tailor
           opt.on('--create-config', 'Create a new .tailor file') do
             if create_config
               msg = "Your new tailor config file was created at "
-              msg << "#{Dir.pwd}."
+              msg << "#{Dir.pwd}/.tailor"
               $stdout.puts msg
               exit
             else
@@ -167,9 +167,11 @@ class Tailor
           opt.separator ""
           opt.separator "Common options:"
 
+=begin
           opt.on('-f', '--format FORMATTER') do |format|
             options.formatters << format
           end
+=end
 
           opt.on('--[no-]color', "Output in color") do |color|
             @output_color = color
@@ -229,7 +231,15 @@ class Tailor
 
       # @return [String]
       def self.usage
-        "  Usage:  tailor [FILE|DIR]"
+        <<-USAGE
+Usage:  tailor [options] [FILE|DIR|GLOB]
+
+Examples:
+tailor
+tailor --no-color -d my_file.rb
+tailor --config-file tailor_config lib/**/*.rb
+tailor --show-config
+        USAGE
       end
 
       def self.create_config

data/lib/tailor/composite_observable.rb

@@ -1,5 +1,18 @@
 class Tailor
+
+  # Used by {Tailor::Lexer} to provide publishing methods for observers.
+  # Any Ruler that wants to subscribe to Lexer events must use the methods
+  # defined here.
   module CompositeObservable
+
+    # Defines three instance methods that provide for observing a
+    # {Tailor::Lexer} object.  If +name+ was passed "test":
+    #
+    # * +#add_test_observer+
+    # * +#test_update+
+    # * +#notify_test_observers+
+    #
+    # @param [String] name The name of event to observe/subscribe to.
     def self.define_observer(name)
       define_method("add_#{name}_observer") do |observer|
         @notifiers = {} unless defined? @notifiers
@@ -8,7 +21,8 @@ class Tailor
         call_back = "#{name}_update".to_sym
 
         unless observer.respond_to? call_back
-          raise NoMethodError, "observer does not respond to '#{call_back}'"
+          raise NoMethodError,
+            "observer '#{observer}' does not respond to '#{call_back}'"
         end
 
         @notifiers[name][observer] = call_back
@@ -37,7 +51,8 @@ class Tailor
     define_observer :const
     define_observer :embexpr_beg
     define_observer :embexpr_end
-    define_observer :file
+    define_observer :file_beg
+    define_observer :file_end
     define_observer :ident
     define_observer :ignored_nl
     define_observer :kw

data/lib/tailor/configuration.rb

@@ -1,6 +1,7 @@
 require_relative '../tailor'
-require_relative 'runtime_error'
 require_relative 'logger'
+require_relative 'runtime_error'
+require_relative 'configuration/style'
 
 class Tailor
 
@@ -17,27 +18,6 @@ class Tailor
     DEFAULT_GLOB = 'lib/**/*.rb'
     DEFAULT_RC_FILE = Dir.home + '/.tailorrc'
     DEFAULT_PROJECT_CONFIG = Dir.pwd + '/.tailor'
-    DEFAULT_STYLE = {
-      allow_camel_case_methods: false,
-      allow_hard_tabs: false,
-      allow_screaming_snake_case_classes: false,
-      allow_trailing_line_spaces: false,
-      indentation_spaces: 2,
-      max_code_lines_in_class: 300,
-      max_code_lines_in_method: 30,
-      max_line_length: 80,
-      spaces_after_comma: 1,
-      spaces_before_comma: 0,
-      spaces_before_lbrace: 1,
-      spaces_after_lbrace: 1,
-      spaces_before_rbrace: 1,
-      spaces_in_empty_braces: 0,
-      spaces_after_lbracket: 0,
-      spaces_before_rbracket: 0,
-      spaces_after_lparen: 0,
-      spaces_before_rparen: 0,
-      trailing_newlines: 1
-    }
 
     # @return [Hash]
     def self.default
@@ -53,11 +33,12 @@ class Tailor
     # @option options [Array] formatters
     # @option options [Hash] style
     def initialize(runtime_file_list=nil, options=nil)
+      @style = Style.new
       @formatters = ['text']
       @file_sets = {
         default: {
           file_list: file_list(DEFAULT_GLOB),
-          style: DEFAULT_STYLE
+          style: @style.to_hash
         }
       }
 
@@ -75,48 +56,72 @@ class Tailor
 
       if @config_file
         if @rc_file_config
-          # Get formatters from config file
-          unless @rc_file_config.formatters.empty?
-            @formatters = @rc_file_config.formatters
-            log "@formatters is now #{@formatters}"
-          end
+          get_formatters_from_config_file
+          get_files_sets_from_config_file
+        end
+      end
+
+      get_formatters_from_cli_opts
+      get_files_sets_from_cli_opts
+      get_style_from_cli_opts
+
+      if @file_sets[:default][:file_list].empty?
+        @file_sets[:default][:file_list] = file_list(DEFAULT_GLOB)
+      end
+    end
+
+    def get_files_sets_from_config_file
+      unless @rc_file_config.file_sets.empty?
+        @rc_file_config.file_sets.each do |label, file_set|
+          log "file set: #{file_set}"
 
-          # Get file sets from config file
-          unless @rc_file_config.file_sets.empty?
-            @rc_file_config.file_sets.each do |label, file_set|
-              unless @file_sets[label]
-                @file_sets[label] = { style: DEFAULT_STYLE }
-              end
-
-              @file_sets[label][:file_list].concat file_set[:file_list]
-              @file_sets[label][:file_list].uniq!
-              @file_sets[label][:style].merge! file_set[:style]
-            end
+          if @file_sets[label]
+            @file_sets[label][:file_list].concat file_set[:file_list]
+            @file_sets[label][:file_list].uniq!
+            @file_sets[label][:style].merge! file_set[:style]
+          else
+            @file_sets[label] = {
+              file_list: file_set[:file_list],
+              style: @style.to_hash.merge(file_set[:style])
+            }
           end
         end
       end
+    end
 
-      # Get formatters from CLI options
-      unless @options.formatters.empty? || @options.formatters.nil?
-        @formatters = @options.formatters
+    def get_formatters_from_config_file
+      unless @rc_file_config.formatters.empty?
+        @formatters = @rc_file_config.formatters
         log "@formatters is now #{@formatters}"
       end
+    end
+
+    def get_style_from_cli_opts
+      if @options.style
+        @options.style.each do |property, value|
+          if value == :off || value == "off"
+            @file_sets[:default][:style][property][1] = { level: :off }
+          else
+            @file_sets[:default][:style][property][0] = value
+          end
+        end
+      end
+    end
 
-      # Get file sets from CLI options
+    def get_files_sets_from_cli_opts
       unless @runtime_file_list.nil? || @runtime_file_list.empty?
         # 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[:default][:file_list] = file_list(@runtime_file_list)
       end
+    end
 
-      # Get style overrides from CLI options
-      @file_sets[:default][:style].merge!(@options.style)
-
-      if @file_sets[:default][:file_list].empty?
-        @file_sets[:default][:file_list] = file_list(DEFAULT_GLOB)
+    def get_formatters_from_cli_opts
+      unless @options.formatters.empty? || @options.formatters.nil?
+        @formatters = @options.formatters
+        log "@formatters is now #{@formatters}"
       end
-
     end
 
     # @return [String] Name of the config file to use.
@@ -139,42 +144,36 @@ class Tailor
       @formatters
     end
 
+    # Adds a file set to the list of file sets in the Configuration object.
+    #
     # @param [String] file_glob The String that represents the file set.  This
     #   can be a file, directory, or a glob.
     # @param [Symbol] label The label that represents the file set.
-    def file_set(file_glob=DEFAULT_GLOB, label=:default, &block)
+    def file_set(file_glob=DEFAULT_GLOB, label=:default)
+      log "file sets before: #{@file_sets}"
       log "file set label #{label}"
 
-      @temp_style = {}
-      instance_eval(&block) if block_given?
+      new_style = Style.new
+
+      if block_given?
+        yield new_style
+
+        if @file_sets[label]
+          @file_sets[label][:style].merge! new_style
+        end
+      end
 
       if @file_sets[label]
         @file_sets[label][:file_list].concat file_list(file_glob)
-        log "file set: #{@file_sets}"
         @file_sets[label][:file_list].uniq!
-        @file_sets[label][:style].merge @temp_style
       else
         @file_sets[label] = {
           file_list: file_list(file_glob),
-          style: DEFAULT_STYLE.merge(@temp_style)
+          style: @style.to_hash.merge(new_style)
         }
       end
 
-      @temp_style = {}
-    end
-
-    # Implemented for {file_set}, this converts the config file lines that look
-    # like methods into a Hash.
-    #
-    # @return [Hash] The new style as defined by the config file.
-    def method_missing(meth, *args, &blk)
-      ok_methods = DEFAULT_STYLE.keys
-
-      if ok_methods.include? meth
-        @temp_style[meth] = args.first
-      else
-        super(meth, args, blk)
-      end
+      log "file sets after: #{@file_sets}"
     end
 
     # Tries to open the file at the path given at +config_file+ and read in
@@ -186,6 +185,7 @@ class Tailor
 
       if File.exists? user_config_file
         log "Loading config from file: #{user_config_file}"
+
         begin
           config = instance_eval File.read(user_config_file)
         rescue LoadError => ex
@@ -248,14 +248,25 @@ class Tailor
       list_with_absolute_paths.sort
     end
 
+    # Displays the current configuration as a text table.
     def show
       table = Text::Table.new(horizontal_padding: 4)
       table.head = [{ value: 'Configuration', colspan: 2, align: :center }]
       table.rows << :separator
-      table.rows << ['Style', @file_sets.inspect]
-      table.rows << :separator
       table.rows << ['Formatters', @formatters]
 
+      @file_sets.each do |label, file_set|
+        table.rows << :separator
+        table.rows << ['Label', label]
+        table.rows << ['Style', '']
+        file_set[:style].each do |k, v|
+          table.rows << ['', "#{k}: #{v}"]
+        end
+
+        table.rows << ['File List', '']
+        file_set[:file_list].each { |file| table.rows << ['', file] }
+      end
+
       puts table
     end
   end