tailor 1.1.5 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f695173027042af6a56e7cada6e1b408a9b5ce5a
+  data.tar.gz: 516aaac032622983b31d33148f14240b1be63d1b
+SHA512:
+  metadata.gz: 98bd7768f8d97ffdeead10bbff2010c25236873499eb2eb62f0ecf6a94b1c0b921ad3e088e722752cbbd7c965c6b54b05e23bb5e01e1cb3bf9eea60eb30efecc
+  data.tar.gz: da3a3b39e51d1542cc86d975b209352d883e3b1569300f46f1387b569426cd945393ba0b7aa789ba2785e46efd1e53f69fc6f62772728f24dc96ca55bc6218e9

data/.gitignore

@@ -2,6 +2,7 @@
 .DS_Store
 .loadpath
 .project
+.ruby-version
 .yardoc/
 logic.txt
 output.txt

data/.travis.yml

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

data/Gemfile

@@ -1,2 +1,2 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec

data/Gemfile.lock

@@ -1,54 +1,54 @@
 PATH
   remote: .
   specs:
-    tailor (1.1.5)
+    tailor (1.2.0)
       log_switch (>= 0.3.0)
       term-ansicolor (>= 1.0.5)
       text-table (>= 1.2.2)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     aruba (0.5.1)
       childprocess (~> 0.3.6)
       cucumber (>= 1.1.1)
       rspec-expectations (>= 2.7.0)
-    builder (3.1.4)
-    childprocess (0.3.7)
-      ffi (~> 1.0, >= 1.0.6)
-    cucumber (1.2.1)
+    builder (3.2.0)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    cucumber (1.2.2)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
-      gherkin (~> 2.11.0)
-      json (>= 1.4.6)
-    diff-lcs (1.1.3)
+      gherkin (~> 2.11.6)
+      multi_json (~> 1.3)
+    diff-lcs (1.2.1)
     fakefs (0.4.2)
-    ffi (1.3.1)
-    ffi (1.3.1-java)
+    ffi (1.4.0)
+    ffi (1.4.0-java)
     gherkin (2.11.6)
       json (>= 1.7.6)
     gherkin (2.11.6-java)
       json (>= 1.7.6)
-    json (1.7.6)
-    json (1.7.6-java)
+    json (1.7.7)
+    json (1.7.7-java)
     log_switch (0.4.0)
-    multi_json (1.5.0)
+    multi_json (1.6.1)
     rake (10.0.3)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.2)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.0)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
     term-ansicolor (1.0.7)
     text-table (1.2.2)
-    yard (0.8.3)
+    yard (0.8.5.2)
 
 PLATFORMS
   java

data/History.rdoc

@@ -1,3 +1,17 @@
+=== 1.2.0 2013-03-06
+
+* gh-119[https://github.com/turboladen/tailor/issues/119]
+  * AllowInvalidRubyRuler now uses Gem.ruby to use the ruby that tailor was
+    run with.
+* gh-130[https://github.com/turboladen/tailor/issues/130]
+  * AllowInvalidRubyRuler now handles file names with spaces in them.
+* gh-131[https://github.com/turboladen/tailor/issues/131]
+  * Added YAML output formatter.  Thanks @leandronsp!
+* gh-133[https://github.com/turboladen/tailor/issues/133]
+  * Added support for Ruby 2.0.0-p0.  ...which is actually just accounting for
+    a {fix to Ripper}[https://bugs.ruby-lang.org/issues/6211] that finally got
+    merged in to a Ruby release.
+
 === 1.1.5 2013-01-30
 
 * gh-127[https://github.com/turboladen/tailor/issues/127]

data/README.rdoc

@@ -93,11 +93,16 @@ Check only files ending in .rb under the 'test' directory:
 Check defaults (lib/**/*.rb):
 
   $ tailor
-  
+
+Printing the results in a output file (if using a formatter that accepts output files, like 'yaml'):
+
+  $ tailor path/to/check --output-file=my-results.yaml
+  $ tailor --output-file=my-results-from-defaults.yaml
+
 Use defaults via a Rake task (if you have a .tailor file, it'll use those settings):
 
   require 'tailor/rake_task'
-  
+
   Tailor::RakeTask.new
 
 ==== On style...
@@ -270,6 +275,21 @@ level to +:off+:
   end
 
 
+===== 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 the option
+--output-file=*.yaml
+
+  # .tailor
+  Tailor.config do |config|
+    config.formatters 'text', 'yaml'
+
+    # just one
+    config.formatters 'text'
+  end
+
+
 === Define A Custom Ruler
 
 While tailor provides a number of Rulers for checking style, it also provides a
@@ -343,10 +363,30 @@ add infomation about your ruler to your config file.  If you created a Ruler:
 
 Next time you run tailor, your Ruler will get initialized and used.
 
+=== Using the lib
+
+Sometimes you could use tailor as a lib, getting the results as a hash
+and manipulate them according your domain.
+
+  require 'tailor/cli'
+
+  # only results from a specific path
+  tailor = Tailor::CLI.new %w(app/controllers)
+  tailor.result # result should be a hash {"filename" => [problems]}
+
+  # using other file config (hiding path, it'll use from default config)
+  Tailor::CLI.new %w(--config-file=.other-config)
+  Tailor::CLI.new [] # uses file set from .tailor file config
+
+  # printing the results in a output file
+  tailor = Tailor::CLI.new %w(--output-file=results.yaml)
+  tailor.execute!
+
 == REQUIREMENTS:
 
 * Rubies (tested)
   * 1.9.3
+  * 2.0.0
 * Gems
   * log_switch
   * term-ansicolor

data/Rakefile

@@ -3,6 +3,13 @@ require 'cucumber'
 require 'cucumber/rake/task'
 require 'rspec/core/rake_task'
 require 'yard'
+require_relative 'lib/tailor/rake_task'
+
+
+Tailor::RakeTask.new do |task|
+  task.formatters = %w[yaml]
+  task.tailor_opts = %w[--output-file=output.yml]
+end
 
 
 #------------------------------------------------------------------------------

data/features/continuous_integration.feature

@@ -92,6 +92,34 @@ Feature: Continuous Integration
     And the output should not match /SystemExit/
     And the exit status should be 1
 
+  Scenario: Rake task, override config file
+    Given a file named "errors.rb" with:
+    """
+    puts 'hi'
+
+
+    """
+    And my configuration file ".tailor" looks like:
+    """
+    Tailor.config do |config|
+      config.file_set 'errors.rb' do |style|
+        style.trailing_newlines 0, level: :error
+      end
+    end
+    """
+    And a file named "Rakefile" with:
+    """
+    require 'tailor/rake_task'
+
+    Tailor::RakeTask.new do |task|
+      task.file_set 'errors.rb' do |style|
+        style.trailing_newlines 2, level: :error
+      end
+    end
+    """
+    When I successfully run `rake tailor`
+    Then the output should match /errors\.rb\s+|\s+0/
+
   Scenario: Rake task, missing config file
     Given a file named "errors.rb" with:
     """

data/lib/tailor/cli.rb

@@ -4,6 +4,7 @@ require_relative 'cli/options'
 require_relative 'logger'
 require_relative 'reporter'
 
+
 class Tailor
 
   # The Command-Line Interface worker.  Execution from the command line
@@ -11,16 +12,19 @@ class Tailor
   class CLI
     include LogSwitch::Mixin
 
+    # @return [Tailor::Configuration]
+    attr_reader :configuration
+
     # The main method of execution from the command line.
+    #
+    # @param [Array] args Arguments from the command-line.
     def self.run(args)
       new(args).execute!
     end
 
     # @param [Array] args Arguments from the command-line.
     def initialize(args)
-      Tailor::Logger.log = false
       options = Options.parse!(args)
-
       @configuration = Configuration.new(args, options)
       @configuration.load!
 
@@ -43,9 +47,18 @@ class Tailor
         @reporter.file_report(problems_for_file, label)
       end
 
-      @reporter.summary_report(@critic.problems)
-
+      @reporter.summary_report(@critic.problems, output_file: @configuration.output_file)
       @critic.problem_count(:error) > 0
     end
+
+    # Critiques all file sets, then returns the problems found as a result.
+    #
+    # @return [Hash{String => Array}] The list of problems, where the keys are
+    #   the file names in which the problems were found, and the values are the
+    #   respective lists of problems for each file.
+    def result
+      @critic.critique(@configuration.file_sets)
+      @critic.problems
+    end
   end
 end

data/lib/tailor/cli/options.rb

@@ -14,6 +14,7 @@ class Tailor
       def self.parse!(args)
         options = OpenStruct.new
         options.config_file = ''
+        options.output_file = ''
         options.formatters = []
         options.show_config = false
         options.style = {}
@@ -33,6 +34,11 @@ class Tailor
             options.config_file = config
           end
 
+          opt.on('-o', '--output-file FILE',
+            "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 "

data/lib/tailor/configuration.rb

@@ -28,17 +28,24 @@ class Tailor
       new
     end
 
+    # @return [Hash]
     attr_reader :file_sets
+
+    # @return [Array]
     attr_reader :formatters
 
+    # @return [String]
+    attr_reader :output_file
+
     # @param [Array] runtime_file_list
     # @param [OpenStruct] options
     # @option options [String] config_file
     # @option options [Array] formatters
     # @option options [Hash] style
     def initialize(runtime_file_list=nil, options=nil)
-      @formatters = ['text']
+      @formatters = %w[text]
       @file_sets = {}
+      @output_file = ''
       @runtime_file_list = runtime_file_list
       log "Got runtime file list: #{@runtime_file_list}"
 
@@ -65,6 +72,7 @@ class Tailor
         @file_sets = { default: FileSet.new(@runtime_file_list) }
       end
 
+      get_output_file_from_cli_opts
       get_formatters_from_cli_opts
       get_file_sets_from_cli_opts
       get_style_from_cli_opts
@@ -118,7 +126,7 @@ class Tailor
           @file_sets[label].update_file_list(file_set[:file_list])
           @file_sets[label].update_style(file_set[:style])
         else
-          log "Creating new label..."
+          log "Creating new label: #{label}"
           @file_sets[label] =
             FileSet.new(file_set[:file_list], file_set[:style])
         end
@@ -162,10 +170,17 @@ class Tailor
       end
     end
 
+    def get_output_file_from_cli_opts
+      unless @options.nil? || @options.output_file.empty? || @options.output_file.nil?
+        @output_file = @options.output_file
+        log "@output_file is now: '#{@output_file}'"
+      end
+    end
+
     def get_formatters_from_cli_opts
       unless @options.nil? || @options.formatters.empty? || @options.formatters.nil?
         @formatters = @options.formatters
-        log "@formatters is now #{@formatters}"
+        log "@formatters is now: '#{@formatters}'"
       end
     end
 
@@ -207,6 +222,7 @@ class Tailor
       table.head = [{ value: 'Configuration', colspan: 2, align: :center }]
       table.rows << :separator
       table.rows << ['Formatters', @formatters]
+      table.rows << ['Output File', @output_file]
 
       @file_sets.each do |label, file_set|
         table.rows << :separator

data/lib/tailor/configuration/style.rb

@@ -80,6 +80,13 @@ class Tailor
           result
         end
       end
+
+      # Yields each property and values.
+      def each
+        to_hash.each do |property, values|
+          yield property, values
+        end
+      end
     end
   end
 end

data/lib/tailor/critic.rb

@@ -10,7 +10,7 @@ class Tailor
   # files.  It handles initializing the Ruler objects it needs based on the
   # configuration given to it.
   class Critic
-    include Tailor::Logger::Mixin
+    include LogSwitch::Mixin
     include Tailor::Rulers
 
     # The instance method that starts the process of looking for problems in
@@ -41,7 +41,9 @@ class Tailor
       end
     end
 
-    # @return [Hash]
+    # @return [Hash{String => Array}] The list of problems, where the keys are
+    #   the file names in which the problems were found, and the values are the
+    #   respective lists of problems for each file.
     def problems
       @problems ||= {}
     end

data/lib/tailor/formatters/yaml.rb

@@ -0,0 +1,51 @@
+require 'pathname'
+require 'yaml'
+require_relative '../formatter'
+
+class Tailor
+  module Formatters
+    class Yaml < Tailor::Formatter
+      attr_reader :accepts_output_file
+
+      def initialize
+        @accepts_output_file = true
+        super
+      end
+
+      # Prints the report on all of the files that just got checked.
+      #
+      # @param [Hash] report Values are filenames; keys are problems for each
+      #   of those files.
+      def summary_report(report)
+        build_hash(report).to_yaml
+      end
+
+      private
+
+      # @param [Hash] report The list of problems found by Tailor::CLI.
+      # @return [Hash] The Hash of problems to be converted to YAML.
+      def build_hash(report)
+        report.reject! { |_, v| v.empty? }
+
+        report.inject({}) do |result, problem_set|
+          file_name = problem_set.first
+          problems = problem_set.last
+
+          problems.each do |problem|
+            result[file_name] ||= []
+
+            result[file_name] << {
+              type: problem[:type],
+              line: problem[:line],
+              column: problem[:column],
+              message: problem[:message],
+              level: problem[:level]
+            }
+          end
+
+          result
+        end
+      end
+    end
+  end
+end