rake_command_filter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b99322995e35812faec4bd062f750776b6b7eea7
+  data.tar.gz: 4768b435d692f5829208ce58dd2c0640cf43bca6
+SHA512:
+  metadata.gz: f53de448bf4b05ad4965f053f477578a02f0cc04a1b8c06f55e6131f92ab478e6c774aa3b1743639a2a8dcda4aa4989a143fb534db37466f80cde802e8394232
+  data.tar.gz: e3c83d48389dbe1a6c96431749878802c0acbf4e5484f2c914c6719e0bb6e6408c749139f5ef543e9c87c20e7736596dc42cbbfbebf0793998f0f7e19e897957

data/.codeclimate.yml

@@ -0,0 +1,26 @@
+engines:
+  rubocop:
+    enabled: true
+    checks:
+      Rubocop/Metrics/LineLength:
+        enabled: true
+        max: 99
+      Rubocop/Style/TrailingWhitespace:
+        enabled: false
+      Rubocop/Style/RedundantReturn:
+        enabled: false
+
+  golint:
+    enabled: true
+  eslint:
+    enabled: true
+  csslint:
+    enabled: true
+ratings:
+  paths:
+  - app/**
+  - lib/**
+  - "**.rb"
+  - "**.go"
+exclude_paths:
+- doc/**/*

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test_files/yard/fail/doc
+/test_files/yard/ok/doc
+/test_files/yard/warn/doc
+/test_files/rspec/ok/coverage

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  Exclude:
+    - Guardfile
+    - test_cases/**/*
+
+Metrics/LineLength:
+  Max: 110
+
+Style/RedundantReturn:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,21 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 2.3.0
+env:
+  # this doesn't do anything for MRI or RBX, but it doesn't hurt them either
+  # for JRuby, it enables us to get more accurate coverage data
+  - JRUBY_OPTS="--debug"
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx-3
+  fast_finish: true
+before_install: gem update --remote bundler
+install:
+  - bundle install --retry=3
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at chris@tripletriangle.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rake_command_filter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chris Jones
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+[![Build Status](https://travis-ci.org/chrisjones-tripletri/rake_command_filter.svg?branch=master)](https://travis-ci.org/chrisjones-tripletri/rake_command_filter)
+[![Code Climate](https://codeclimate.com/github/chrisjones-tripletri/rake_command_filter/badges/gpa.svg)](https://codeclimate.com/github/chrisjones-tripletri/rake_command_filter)
+[![Test Coverage](https://codeclimate.com/github/chrisjones-tripletri/rake_command_filter/badges/coverage.svg)](https://codeclimate.com/github/chrisjones-tripletri/rake_command_filter/coverage)
+
+# RakeCommandFilter
+
+RakeCommandFilter allows you to execute multiple rake commands in subprocesses and filter
+their output for easy review.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rake_command_filter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rake_command_filter
+
+## Purpose
+
+Prior to checking in, I wanted to run all my favored validation tools (rubocop, rspec with simplecov, and yard), 
+and review simple output like this:
+
+```
+OK             rubocop                1.27s     15 files
+OK             spec                   7.97s     11 passed
+OK             spec                   7.97s     96.9 test coverage
+OK             yard                   1.46s     100.0 documented
+```
+
+so that I did not need to dig through the results to determine if I was satisfied.   Only if they failed did I want to see detailed output from a given command.
+
+RakeCommandFilter does this, and can be extended to process the output of other tools.
+
+## Usage
+
+Put this in your Rakefile, then run ```rake full_validation```.
+
+```ruby
+require 'rake_command_filter'
+
+RakeCommandFilter::RakeTask.new(:full_validation) do
+  desc 'Run full validation'
+  run_definition(RakeCommandFilter::RubocopCommandDefinition.new)
+  run_definition(RakeCommandFilter::RSpecCommandDefinition.new)
+  run_definition(RakeCommandFilter::YardCommandDefinition.new)
+end
+```
+
+If you setup a rake command like that above, you can use this as a git pre-commit hook:
+
+```bash
+#!/bin/bash                                                                                                                                        
+rake full_validation
+exit $?
+```
+in order to see the nice output whenever you commit.
+
+## Customization
+
+You can customize rake_command_filter to run and parse the output of other
+commands by implementing your own CommandDefinition subclass.  You can also
+alter an existing version in a block, as in this example from the tests:
+
+```ruby
+task = RakeCommandFilter::RakeTask.new(:test_warn) do
+  desc 'My deployment task'
+  run_definition(RakeCommandFilter::YardCommandDefinition.new) do
+    add_parameter(' doc yard_warn.rb')
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chrisjones-tripletri/rake_command_filter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'rake_command_filter'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+YARD::Rake::YardocTask.new(:yard)
+
+RakeCommandFilter::RakeTask.new(:full_validation) do
+  desc 'Run full validation'
+  run_definition(RakeCommandFilter::RubocopCommandDefinition.new)
+  run_definition(RakeCommandFilter::RSpecCommandDefinition.new)
+  run_definition(RakeCommandFilter::YardCommandDefinition.new)
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rake_command_filter'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/command_definition.rb

@@ -0,0 +1,148 @@
+module RakeCommandFilter
+  # Base class for commands that get executed, and their output filtered
+  # rubocop:disable ClassLength
+  class CommandDefinition
+    attr_accessor :name
+    attr_accessor :default_line_handling
+    attr_accessor :filter
+
+    # if a line doesn't match any of the patterns, then
+    # @param name a name used to identify the command in ouput
+    def initialize(name)
+      @name = name
+      @default_line_handling = LINE_HANDLING_HIDE_UNTIL_ERROR
+      @filters = []
+      @parameters = []
+    end
+
+    # add a new filter for output from this command
+    # @param id [Symbol] an identifier for the filter within the command
+    # @param pattern [RegEx] a regular expression which matches a pattern in a line
+    # @yield yields back an array of matches from the pattern.   The block should return
+    #   a CommmandDefinition#result_... variant
+    def add_filter(id, pattern, &block)
+      filter = LineFilter.new(id, pattern, block)
+      @filters << filter
+    end
+
+    # add a parameter to be passed to the command when executed
+    def add_parameter(param)
+      @parameters << param
+    end
+
+    # override this method
+    def execute
+    end
+
+    # @return the most severe result from an array of results
+    def self.find_worst_result(results)
+      worst = []
+      results.each do |result|
+        if worst.empty? || worst.first.severity < result.severity
+          worst = [result]
+        elsif worst.first.severity == result.severity
+          worst << result
+        end
+      end
+      worst = result_failure('INTERNAL ERROR: no pattern matched a result in the output') if worst.empty?
+      return worst
+    end
+
+    protected
+
+    # @return a result indicating the command was successful
+    def result_success(msg)
+      create_result(RakeCommandFilter::MATCH_SUCCESS, msg)
+    end
+
+    # @return a result indicating the command failed.
+    def result_failure(msg)
+      create_result(RakeCommandFilter::MATCH_FAILURE, msg)
+    end
+
+    # @return a result indicating the command showed a warning.
+    def result_warning(msg)
+      create_result(RakeCommandFilter::MATCH_WARNING, msg)
+    end
+
+    private
+
+    def create_result(result, msg)
+      LineFilterResult.new(@name, result, msg)
+    end
+
+    def execute_system(command)
+      saved_lines = []
+      results = []
+      command_start = Time.now
+      command = add_parameters(command)
+      Open3.popen3(command) do |_stdin, stdout, stderr|
+        process_output(stdout, results, saved_lines)
+        process_output(stderr, results, saved_lines)
+      end
+      output_results(results, saved_lines, command_start)
+      return results
+    end
+
+    def add_parameters(command)
+      @parameters.each do |param|
+        command << " #{param}"
+      end
+      return command
+    end
+
+    def process_output(stdout, results, saved_lines)
+      until stdout.eof?
+        line = stdout.readline
+        match_line(line, results)
+        saved_lines << line
+      end
+    end
+
+    def output_results(results, saved_lines, command_start)
+      worst_results = CommandDefinition.find_worst_result(results)
+      # if the lines
+      if worst_results[0].result != RakeCommandFilter::MATCH_SUCCESS &&
+         @default_line_handling == RakeCommandFilter::LINE_HANDLING_HIDE_UNTIL_ERROR
+        print_lines(saved_lines)
+      end
+      unless @default_line_handling == RakeCommandFilter::LINE_HANDLING_HIDE_ALWAYS
+        worst_results.each do |result|
+          result.output(Time.now - command_start) unless result.result == RakeCommandFilter::MATCH_WARNING
+        end
+      end
+    end
+
+    def match_line(line, results)
+      result = process_filters(line)
+      results << result if result
+      return result
+    end
+
+    def process_filters(line)
+      result = nil
+      @filters.each do |filter|
+        result = filter.match(line)
+
+        # stop processing filters if we found a match.
+        break if result
+      end
+      return result
+    end
+
+    def process_default_line(saved_lines, line)
+      case @default_line_handling
+      when RakeCommandFilter::LINE_HANDLING_HIDE_UNTIL_ERROR
+        saved_lines << line
+      when RakeCommandFilter::LINE_HANDLING_SHOW_ALWAYS
+        puts line
+      when RakeCommandFilter::LINE_HANDLING_HIDE_ALWAYS
+        # do nothing
+      end
+    end
+
+    def print_lines(lines)
+      lines.each { |line| puts line }
+    end
+  end
+end

data/lib/command_failed_error.rb

@@ -0,0 +1,4 @@
+module RakeCommandFilter
+  class CommandFailedError < StandardError
+  end
+end

data/lib/line_filter.rb

@@ -0,0 +1,24 @@
+module RakeCommandFilter
+  # method for filtering a single line of output from a command
+  class LineFilter
+    attr_accessor :id, :pattern
+
+    # Do not call this directly, use {CommandDefinition#add_filter}
+    def initialize(id, pattern, block)
+      @id = id
+      @pattern = pattern
+      @block = block
+    end
+
+    # Called to determine if this filter matches a line.   If it
+    # does, returns the result from the block defined with
+    # {CommandDefinition#add_filter}.
+    # @return [LineFilterResult] or nil if no match occurred
+    def match(source)
+      source.scan(@pattern) do |matches|
+        return @block.call(matches)
+      end
+      return nil
+    end
+  end
+end

data/lib/line_filter_result.rb

@@ -0,0 +1,70 @@
+require 'colorize'
+
+module RakeCommandFilter
+  # returned by line filter block when a command is successful.
+  MATCH_SUCCESS = :success
+
+  # returned by line filter block when a command fails.
+  MATCH_FAILURE = :failure
+
+  # return by a line filter to indicate a warning from the command
+  MATCH_WARNING = :warning
+
+  # returned when a line filter doesn't match the specified line.
+  MATCH_NONE = :none
+
+  # text used to indicate failure
+  FAILED_TEXT = 'FAILED'.freeze
+
+  # text used to indicate success
+  OK_TEXT = 'OK'.freeze
+
+  # sumarizes the result of filtering a single line of command output
+  class LineFilterResult
+    attr_accessor :name, :result, :message
+
+    # Do not create this directly, use the result_... variants in
+    # {CommandDefinition}
+    def initialize(name, result, output)
+      @name = name
+      @result = result
+      @message = output
+    end
+
+    # @return an integer where 0 == success and higher numbers imply more
+    # serious failures.
+    def severity
+      case @result
+      when MATCH_SUCCESS
+        return 0
+      when MATCH_WARNING
+        return 1
+      when MATCH_FAILURE
+        return 2
+      else
+        raise ArgumentError, 'Unknown result'
+      end
+    end
+
+    # Called to output the result to the console.
+    # @param elapsed the time running the command so far
+    # rubocop:disable MethodLength
+    def output(elapsed)
+      case @result
+      when MATCH_SUCCESS
+        color = :green
+        header = 'OK'
+      when MATCH_FAILURE
+        color = :red
+        header = 'FAIL'
+      when MATCH_WARNING
+        color = :light_red
+        header = 'WARN'
+      end
+      header = header.ljust(12).colorize(color)
+      str_elapsed = "#{elapsed.round(2)}s"
+      name = @name.to_s[0..17]
+      puts "#{header}   #{name.ljust(20)}   #{str_elapsed.ljust(9)} #{@message}"
+    end
+  end
+end

data/lib/rake_command_definition.rb

@@ -0,0 +1,21 @@
+module RakeCommandFilter
+  # command that runs a rake task
+  class RakeCommandDefinition < CommandDefinition
+    attr_accessor :test_command
+
+    # @param name will invoke rake <name> to run
+    #   the command
+    def initialize(name, test_command)
+      super(name)
+      @test_command = test_command
+    end
+
+    # Executes a rake task in a subprocess, and
+    # captures and parses the output using the
+    # filters associated with this command
+    def execute
+      command = RakeCommandFilter.testing? ? test_command : "rake #{@name}"
+      return execute_system(command)
+    end
+  end
+end

data/lib/rake_command_filter/version.rb

@@ -0,0 +1,4 @@
+module RakeCommandFilter
+  # version of this gem
+  VERSION = '0.1.0'.freeze
+end