rake_command_filter 0.1.0

data/lib/rake_command_filter.rb

@@ -0,0 +1,111 @@
+require 'open3'
+require 'rake'
+require 'rake/tasklib'
+require 'rake_command_filter/version'
+require_relative './line_filter_result'
+require_relative './line_filter'
+require_relative './command_definition'
+require_relative './rake_command_definition'
+require_relative './rubocop_command_definition'
+require_relative './rspec_command_definition'
+require_relative './yard_command_definition'
+require_relative './command_failed_error'
+
+# A rake task that filters the output of other rake tasks so you can see
+# what you care about.
+module RakeCommandFilter
+  # Always hide the line, no matter what
+  LINE_HANDLING_HIDE_ALWAYS      = :hide_always
+
+  # Show the line only after an error pattern line has been matched
+  LINE_HANDLING_HIDE_UNTIL_ERROR = :hide_until_error
+
+  # Show the line
+  LINE_HANDLING_SHOW_ALWAYS      = :show_always
+
+  @@testing = false # rubocop:disable Style/ClassVars
+
+  # set to true if we are in at test context
+  def self.testing=(_val)
+    @@testing = true # rubocop:disable Style/ClassVars
+  end
+
+  # @return true if we are in a test context.
+  def self.testing?
+    return @@testing
+  end
+
+  # Provides a custom rake task.
+  #
+  # require 'rake_command_filter'
+  # RakeCommandFilter::RakeTask.new
+  class RakeTask < Rake::TaskLib
+    attr_accessor :name
+    attr_accessor :verbose
+    attr_accessor :fail_on_error
+    attr_accessor :patterns
+    attr_accessor :formatters
+    attr_accessor :requires
+    attr_accessor :options
+
+    # default rake task initializer
+    def initialize(*args, &task_block)
+      @name = args.shift || :filter_tasks
+      @verbose = true
+      @commands = []
+
+      desc 'TODO: FILL THIS IN THE BLOCK WHERE YOU CREATE THE TASK'
+
+      instance_eval(&task_block)
+      run_task(name, *args)
+    end
+
+    # call this to run a {CommandDefinition} subclass
+    # @param defin an instance of a command definition subclass
+    # @yield in the block, you can modify the internal state of the command,
+    #   using desc, add_filter, etc.
+    def run_definition(defin, &block)
+      command = defin
+      defin.instance_eval(&block) if block
+      add_command(command)
+    end
+
+    # run all the tasks that have been added via {#run_definition}.
+    def run_main_task(verbose)
+      run_tasks(verbose)
+    end
+
+    private
+
+    def run_task(name, *args)
+      task(name, *args) do |_, _task_args|
+        RakeFileUtils.send(:verbose, verbose) do
+          begin
+            run_main_task(verbose)
+          rescue
+            exit 1
+          end
+        end
+      end
+    end
+
+    def add_command(command)
+      @commands << command
+    end
+
+    def run_tasks(_verbose)
+      failure = nil
+      @commands.each do |command|
+        results = command.execute
+        worst = CommandDefinition.find_worst_result(results)
+        if !worst.empty? && worst[0].severity > 0
+          failure = worst[0]
+          break
+        end
+      end
+
+      # raise an error so that the rake task will return 1 to the shell
+      raise CommandFailedError, failure.message if failure
+    end
+  end
+end

data/lib/rspec_command_definition.rb

@@ -0,0 +1,49 @@
+module RakeCommandFilter
+  # default way to run rubocop and parse its output
+  class RSpecCommandDefinition < RakeCommandDefinition
+    # for testing
+    def self.failure_msg(failures)
+      "#{failures} failed"
+    end
+
+    # for testing
+    def self.success_msg(success)
+      "#{success} passed"
+    end
+
+    # for testing
+    def self.coverage_msg(percent)
+      "#{percent} test coverage"
+    end
+
+    # Default parser for rspec output.
+    # @param id override this if you want to do something other than 'rake spec'
+    def initialize(coverage_threshold = 95, id = :spec)
+      super(id, 'rspec')
+      # just use sensible defaults here.
+      add_rspec
+      add_simplecov(coverage_threshold)
+    end
+
+    private
+
+    def add_rspec
+      add_filter(:rspec_filter, /(\d+)\s+example[s]?,\s+(\d+)\s+failure/) do |matches|
+        failures = matches[1].to_i
+        if failures > 0
+          result_failure(RSpecCommandDefinition.failure_msg(failures))
+        else
+          result_success(RSpecCommandDefinition.success_msg(matches[0]))
+        end
+      end
+    end
+
+    def add_simplecov(coverage_threshold)
+      add_filter(:simplecov_filter, /Coverage.+LOC\s+\((\d+[\.]?\d+)%/) do |matches|
+        percent = matches[0].to_f
+        msg = RSpecCommandDefinition.coverage_msg(percent)
+        (percent >= coverage_threshold) ? result_success(msg) : result_failure(msg)
+      end
+    end
+  end
+end

data/lib/rubocop_command_definition.rb

@@ -0,0 +1,29 @@
+module RakeCommandFilter
+  # default way to run rubocop and parse its output
+  class RubocopCommandDefinition < RakeCommandDefinition
+    # used for testing
+    def self.failure_msg(offenses, files)
+      "#{offenses} offenses in #{files} files"
+    end
+
+    # used for testing
+    def self.success_msg(files)
+      "#{files} files"
+    end
+
+    # Default parser for rubocop output.
+    # @param id override this if you want to do something other than 'rake rubocop'
+    def initialize(id = :rubocop)
+      super(id, 'rubocop')
+
+      # just use sensible defaults here.
+      add_filter(:offenses_filter, /(\d+)\s+file.*,\s+(\d+)\s+offense/) do |matches|
+        result_failure(RubocopCommandDefinition.failure_msg(matches[1], matches[0]))
+      end
+
+      add_filter(:no_offenses_filter, /(\d+)\s+file.*,\s+no\s+offenses/) do |matches|
+        result_success(RubocopCommandDefinition.success_msg(matches[0]))
+      end
+    end
+  end
+end

data/lib/yard_command_definition.rb

@@ -0,0 +1,32 @@
+module RakeCommandFilter
+  # default way to run rubocop and parse its output
+  class YardCommandDefinition < RakeCommandDefinition
+    attr_accessor :threshold
+
+    # for testing
+    def self.percent_msg(percent)
+      "#{percent} documented"
+    end
+
+    # for testing
+    def self.warning_msg
+      'One or more yard warnings, see above'
+    end
+
+    # Default parser for yard output.
+    # @param threshold override this if you want to require less than 95% documentation
+    # @param id override this if you want to do something other than 'rake spec'
+    def initialize(threshold = 95, id = :yard)
+      super(id, 'yard')
+      # just use sensible defaults here.
+      add_filter(:yard_percentage, /(\d+.?\d+)%\s+document/) do |matches|
+        percent = matches[0].to_f
+        msg = YardCommandDefinition.percent_msg(percent)
+        (percent >= threshold) ? result_success(msg) : result_failure(msg)
+      end
+      add_filter(:yard_warning, /\[warn\]:(.*)/) do |_matches|
+        result_warning(YardCommandDefinition.warning_msg)
+      end
+    end
+  end
+end

data/rake_command_filter.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rake_command_filter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rake_command_filter'
+  spec.version       = RakeCommandFilter::VERSION
+  spec.authors       = ['Chris Jones']
+  spec.email         = ['chris@tripletriangle.com']
+
+  spec.summary       = 'Runs several rake tasks or system commands, and filters their output for easy review'
+  spec.description   = 'Runs several rake tasks or system commands, and filters their output for easy review'
+  spec.homepage      = 'https://github.com/chrisjones-tripletri/rake_command_filter'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'colorize'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.37.0'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+  spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

data/test_cases/rspec/fail/coverage/.last_run.json

@@ -0,0 +1,5 @@
+{
+  "result": {
+    "covered_percent": 100.0
+  }
+}

data/test_cases/rspec/fail/coverage/.resultset.json

@@ -0,0 +1,7 @@
+{
+  "RSpec": {
+    "coverage": {
+    },
+    "timestamp": 1455141533
+  }
+}