tailor 1.0.1 → 1.1.0

data/.tailor

@@ -7,6 +7,7 @@ Tailor.config do |config|
   end
 
   config.file_set 'spec/**/*.rb', :spec do |style|
+    style.max_line_length 105, level: :warn
     style.spaces_after_lbrace 1, level: :warn
     style.spaces_before_lbrace 1, level: :warn
     style.spaces_before_rbrace 1, level: :warn

data/Gemfile.lock

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

data/History.rdoc

@@ -1,3 +1,37 @@
+=== 1.1.0 2012-05-07
+
+* gh-89[https://github.com/turboladen/tailor/issues/89]
+  * You can now use {Tailor::RakeTask} to create a Rake task.
+* gh-100[https://github.com/turboladen/tailor/issues/100]
+  * Added {Tailor::Configuration#recursive_file_set}.  This lets you do the
+    following in your config file, which will recursively match all files in
+    your current path that end with '_spec.rb':
+
+      Tailor.config do |config|
+        config.recursive_file_set '*_spec.rb', :unit_tests do |style|
+          style.max_line_length 90, level: :warn
+        end
+      end
+
+    ...which is equivalent to:
+
+      Tailor.config do |config|
+        config.file_set '*/**/*_spec.rb', :unit_tests do |style|
+          style.max_line_length 90, level: :warn
+        end
+      end
+
+* gh-107[https://github.com/turboladen/tailor/issues/107]
+  * Fixed --no-color option.
+* gh-108[https://github.com/turboladen/tailor/issues/108]
+  * Fixed --create-config, which created style level options with a missing ':'
+    for the Hash value.
+* Configuration files now don't force you to use the :default file set.  If you
+  don't specify any file sets, then the default is used; if you specify file
+  sets, it uses what you specify.
+* CLI options now override config file options for all file sets (previously,
+  only the :default file set's option would get overridden by the CLI option).
+
 === 1.0.1 2012-04-23
 
 * gh-104: Fixed incorrect rendering of config file when using

data/README.rdoc

@@ -92,6 +92,12 @@ Check only files ending in .rb under the 'test' directory:
 Check defaults (lib/**/*.rb):
 
   $ tailor
+  
+Use defaults via a Rake task:
+
+  require 'tailor/rake_task'
+  
+  Tailor::RakeTask.new
 
 ==== On style...
 
@@ -224,7 +230,7 @@ rulers caused the problem to be found.
   Tailor.config do |config|
 
     # All defaults; implies "default" label
-    config.file_set 'lib/**/*.rb
+    config.file_set 'lib/**/*.rb'
 
     config.file_set 'app/**/*.rb', :rails_app do |style|
       style.max_line_length 100
@@ -242,6 +248,16 @@ rulers caused the problem to be found.
     end
   end
 
+If it suits you better, use "recursive file sets" to get all matching files
+in your current path.  If you wanted to critique all .rb files:
+
+  # .tailor
+  Tailor.config do |config|
+
+    # All defaults; implies "default" label
+    config.recursive_file_set '*.rb'
+  end
+
 Similarly to the CLI, if you want to turn off a default Ruler, set its problem
 level to +:off+:
 

data/features/valid_ruby.feature

@@ -13,5 +13,5 @@ Feature: Valid Ruby
 
     """
     When I run `tailor -d extra_end.rb`
-    Then the output should match /Total Problems.*1/
+    Then the output should match /TOTAL.*1/
     And the output should match /File contains invalid Ruby/

data/lib/ext/string_ext.rb

@@ -1,8 +1,4 @@
-require 'term/ansicolor'
-
 class String
-  include Term::ANSIColor
-
   # Borrowed from ActiveSupport, this converts camel-case Strings to
   # snake-case.
   #

data/lib/tailor/cli/options.rb

@@ -1,6 +1,7 @@
 require 'erb'
 require 'optparse'
 require 'ostruct'
+require 'term/ansicolor'
 require 'text-table'
 require_relative '../version'
 require_relative '../configuration'
@@ -193,11 +194,17 @@ class Tailor
         end
 
         opts.parse!(args)
-        require_relative '../../ext/string_ext' if @output_color
+        colorize
 
         options
       end
 
+      # Sets colors based on --[no-]color.  If the terminal doesn't support
+      # colors, it turns colors off, despite the CLI setting.
+      def self.colorize
+        Term::ANSIColor.coloring = @output_color ? STDOUT.isatty : false
+      end
+
       # @return [String]
       def self.banner
         ruler + about + "\r\n" + usage + "\r\n"
@@ -251,7 +258,7 @@ tailor --show-config
             File.dirname(__FILE__) + '/../tailorrc.erb')
           formatters = Tailor::Configuration.default.formatters
           file_list = 'lib/**/*.rb'
-          style = Tailor::Configuration.default.file_sets[:default][:style]
+          style = Tailor::Configuration::Style.new.to_hash
           default_config_file = ERB.new(File.read(erb_file)).result(binding)
           File.open('.tailor', 'w') { |f| f.write default_config_file }
         end

data/lib/tailor/configuration.rb

@@ -2,6 +2,7 @@ require_relative '../tailor'
 require_relative 'logger'
 require_relative 'runtime_error'
 require_relative 'configuration/style'
+require_relative 'configuration/file_set'
 
 class Tailor
 
@@ -12,10 +13,13 @@ class Tailor
   #
   # It then basically represents a list of "file sets" and the rulers that
   # should be applied against each file set.
+  #
+  # If a file list is given from the CLI _and_ a configuration file is
+  # given/found, tailor uses the style settings for the default file set and
+  # only checks the default file set.
   class Configuration
     include Tailor::Logger::Mixin
 
-    DEFAULT_GLOB = 'lib/**/*.rb'
     DEFAULT_RC_FILE = Dir.home + '/.tailorrc'
     DEFAULT_PROJECT_CONFIG = Dir.pwd + '/.tailor'
 
@@ -33,110 +37,138 @@ 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: @style.to_hash
-        }
-      }
-
+      @file_sets = {}
       @runtime_file_list = runtime_file_list
       log "Got runtime file list: #{@runtime_file_list}"
+
       @options = options
       log "Got options: #{@options}"
+
+      unless @options.nil?
+        @config_file = @options.config_file unless @options.config_file.empty?
+      end
     end
 
     # Call this to load settings from the config file and from CLI options.
     def load!
-      # Get config file settings
-      @config_file = @options.config_file unless @options.config_file.empty?
-      load_from_config_file(config_file) if config_file
+      if config_file
+        load_from_config_file(config_file)
 
-      if @config_file
-        if @rc_file_config
+        if @config_from_file
           get_formatters_from_config_file
-          get_files_sets_from_config_file
+          #get_file_sets_from_config_file unless @runtime_file_list
+          get_file_sets_from_config_file
         end
+      else
+        log "Creating default file set..."
+        @file_sets = { default: FileSet.new(@runtime_file_list) }
       end
 
       get_formatters_from_cli_opts
-      get_files_sets_from_cli_opts
+      get_file_sets_from_cli_opts
       get_style_from_cli_opts
+    end
+
+    # Tries to open the file at the path given at +config_file+ and read in
+    # the configuration given there.
+    #
+    # @param [String] config_file Path to the config file to use.
+    def load_from_config_file(config_file)
+      user_config_file = File.expand_path(config_file)
 
-      if @file_sets[:default][:file_list].empty?
-        @file_sets[:default][:file_list] = file_list(DEFAULT_GLOB)
+      if File.exists? user_config_file
+        log "Loading config from file: #{user_config_file}"
+
+        begin
+          @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,
+            "Couldn't load config file: #{user_config_file}"
+        end
+      else
+        log "No config file found at #{user_config_file}."
       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}"
+    # @return [String] Name of the config file to use.
+    def config_file
+      return @config_file if @config_file
 
-          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
+      if File.exists?(DEFAULT_PROJECT_CONFIG)
+        return @config_file = DEFAULT_PROJECT_CONFIG
+      end
+
+      if File.exists?(DEFAULT_RC_FILE)
+        return @config_file = DEFAULT_RC_FILE
+      end
+    end
+
+    def get_file_sets_from_config_file
+      return if @config_from_file.file_sets.empty?
+
+      @config_from_file.file_sets.each do |label, file_set|
+        log "label: #{label}"
+        log "file set file list: #{file_set[:file_list]}"
+        log "file set style: #{file_set[:style]}"
+
+        if @file_sets[label]
+          log "label already exists.  Updating..."
+          @file_sets[label].update_file_list(file_set[:file_list])
+          @file_sets[label].update_style(file_set[:style])
+        else
+          log "Creating new label..."
+          @file_sets[label] =
+            FileSet.new(file_set[:file_list], file_set[:style])
         end
       end
     end
 
     def get_formatters_from_config_file
-      unless @rc_file_config.formatters.empty?
-        @formatters = @rc_file_config.formatters
-        log "@formatters is now #{@formatters}"
-      end
+      return if @config_from_file.formatters.empty?
+
+      @formatters = @config_from_file.formatters
+      log "@formatters is now #{@formatters}"
     end
 
     def get_style_from_cli_opts
-      if @options.style
-        @options.style.each do |property, value|
+      return unless @options && @options.style
+
+      @options.style.each do |property, value|
+        @file_sets.keys.each do |label|
           if value == :off || value == "off"
-            @file_sets[:default][:style][property][1] = { level: :off }
+            @file_sets[label].style[property][1] = { level: :off }
           else
-            @file_sets[:default][:style][property][0] = value
+            @file_sets[label].style[property][0] = value
           end
         end
       end
     end
 
-    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)
+    # If any files are given from the CLI, this gets that list of files and
+    # replaces those in any :default file set.
+    def get_file_sets_from_cli_opts
+      return if @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 }
+
+      if @file_sets.include? :default
+        @file_sets[:default].file_list = @runtime_file_list
+      else
+        @file_sets = { default: FileSet.new(@runtime_file_list) }
       end
     end
 
     def get_formatters_from_cli_opts
-      unless @options.formatters.empty? || @options.formatters.nil?
+      unless @options.nil? || @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.
-    def config_file
-      return @config_file if @config_file
-
-      if File.exists?(DEFAULT_PROJECT_CONFIG)
-        return @config_file = DEFAULT_PROJECT_CONFIG
-      end
-
-      if File.exists?(DEFAULT_RC_FILE)
-        return @config_file = DEFAULT_RC_FILE
-      end
-    end
-
     # @return [Array] The list of formatters.
     def formatters(*new_formatters)
       @formatters = new_formatters unless new_formatters.empty?
@@ -146,106 +178,27 @@ class Tailor
 
     # 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 [String] file_expression The String that represents the file set.  This
+    #   can be a file, directory, or a (Ruby Dir) glob.
     # @param [Symbol] label The label that represents the file set.
-    def file_set(file_glob=DEFAULT_GLOB, label=:default)
+    def file_set(file_expression='lib/**/*.rb', label=:default)
       log "file sets before: #{@file_sets}"
       log "file set label #{label}"
-
       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)
-        @file_sets[label][:file_list].uniq!
-      else
-        @file_sets[label] = {
-          file_list: file_list(file_glob),
-          style: @style.to_hash.merge(new_style)
-        }
-      end
+      yield new_style if block_given?
 
+      @file_sets[label] = FileSet.new(file_expression, new_style)
       log "file sets after: #{@file_sets}"
     end
 
-    # Tries to open the file at the path given at +config_file+ and read in
-    # the configuration given there.
-    #
-    # @param [String] config_file Path to the config file to use.
-    def load_from_config_file(config_file)
-      user_config_file = File.expand_path(config_file)
-
-      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
-          raise Tailor::RuntimeError,
-            "Couldn't load config file: #{user_config_file}"
-        end
-      else
-        log "No config file found at #{user_config_file}."
-      end
-
-      if config
-        log "Got new config from file: #{config}"
-        @rc_file_config = config
-      end
-    end
-
-    # Gets a list of only files that are in +base_dir+.
-    #
-    # @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|
-        file if File.file?(file)
-      end
-
-      files
-    end
-
-    # The list of the files in the project to check.
+    # A helper to #file_set that allows you to specify '*.rb' to get all files
+    # ending with +.rb+ in your current path and deeper.
     #
-    # @param [String] glob Path to the file, directory or glob to check.
-    # @return [Array] The list of files to check.
-    def file_list(glob)
-      files_in_project = if glob.is_a? Array
-        log "Configured glob is an Array: #{glob}"
-
-        glob.map do |e|
-          if File.directory?(e)
-            all_files_in_dir(e)
-          else
-            e
-          end
-        end.flatten.uniq
-      elsif File.directory? glob
-        log "Configured glob is an directory: #{glob}"
-        all_files_in_dir(glob)
-      else
-        log "Configured glob is a glob/single-file: #{glob}"
-        Dir.glob glob
-      end
-
-      list_with_absolute_paths = []
-
-      files_in_project.each do |file|
-        list_with_absolute_paths << File.expand_path(file)
-      end
-
-      log "All files: #{list_with_absolute_paths}"
-
-      list_with_absolute_paths.sort
+    # @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)
     end
 
     # Displays the current configuration as a text table.