bashcov 0.0.2 → 0.0.3

data/.rspec

@@ -1,3 +1,4 @@
 --color
 --format d
 --order random
+--profile

data/README.md

@@ -1,4 +1,4 @@
-# Bashcov [![Build Status](https://secure.travis-ci.org/infertux/bashcov.png?branch=master)](https://travis-ci.org/infertux/bashcov)
+# Bashcov [![Build Status](https://secure.travis-ci.org/infertux/bashcov.png?branch=master)](https://travis-ci.org/infertux/bashcov) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/infertux/bashcov)
 
 [bashcov] is [simplecov] for Bash.
 

data/Rakefile

@@ -1,7 +1,9 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts = '-w'
+end
 
 task :default => :spec
 

data/bashcov.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency 'simplecov'
+  gem.add_dependency 'open4'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'

data/bin/bashcov

@@ -5,14 +5,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'bashcov'
 
-if ARGV.size != 1
-  $stderr.puts "#{File.basename(__FILE__)} takes exactly one argument."
-  exit 1
-end
+Bashcov.parse_options! ARGV
 
-filename = ARGV[0]
-
-runner = Bashcov::Runner.new filename
+runner = Bashcov::Runner.new Bashcov.options.filename
 runner.run
 coverage = runner.result
 

data/lib/bashcov/lexer.rb

@@ -26,7 +26,7 @@ module Bashcov
 
     # Lines containing only one of these keywords are irrelevant for coverage
     def is
-      %w(esac fi then do done else { })
+      %w(esac fi then do done else { } ;;)
     end
 
     # Lines starting with one of these tokens are irrelevant for coverage

data/lib/bashcov/runner.rb

@@ -1,24 +1,46 @@
-require 'open3'
+require 'open4'
 
 module Bashcov
   class Runner
-    attr_reader :output
+    attr_reader :stdout, :stderr
 
     def initialize filename
       @filename = File.expand_path(filename)
     end
 
     def run
-      inject_shellopts_flags
-
-      env = { 'PS4' => Xtrace.ps4 }
-      stdin, stdout, stderr, wait_thr = Open3.popen3(env, @filename)
-      exit_status = wait_thr.value # block until process returns
-      @output = stderr.dup
+      setup
+
+      Open4::popen4(@command) do |pid, stdin, stdout, stderr|
+        stdin = $stdin # bind stdin
+
+        [ # we need threads here to stream output in realtime
+          Thread.new { # stdout
+            stdout.each do |line|
+              $stdout.puts line unless Bashcov.options.mute
+              @stdout << line
+            end
+          },
+          Thread.new { # stderr
+            stderr.each do |line|
+              unless Bashcov.options.mute
+                xtrace = Xtrace.new [line]
+                $stderr.puts line if xtrace.xtrace_output.empty?
+              end
+              @stderr << line
+            end
+          }
+        ].map(&:join)
+      end
     end
 
     def result
-      files = find_bash_files "#{Bashcov.root_directory}/**/*.sh"
+      if Bashcov.options.skip_uncovered
+        files = {}
+      else
+        files = find_bash_files "#{Bashcov.root_directory}/**/*.sh"
+      end
+
       files = add_coverage_result files
       files = ignore_irrelevant_lines files
     end
@@ -27,7 +49,7 @@ module Bashcov
       files = {}
 
       # grab all bash files in project root and mark them uncovered
-      (Dir[directory] - [@filename]).each do |file|
+      Dir[directory].each do |file|
         absolute_path = File.expand_path(file)
         next unless File.file?(absolute_path)
 
@@ -38,12 +60,11 @@ module Bashcov
     end
 
     def add_coverage_result files
-      xtraced_files = Xtrace.new(@output).files
-      xtraced_files.delete @filename # drop the test suite file
+      xtraced_files = Xtrace.new(@stderr).files
 
       xtraced_files.each do |file, lines|
         lines.each_with_index do |line, lineno|
-          files[file] ||= Bashcov.coverage_array(file) # non .sh files but executed though
+          files[file] ||= Bashcov.coverage_array(file)
           files[file][lineno] = line if line
         end
       end
@@ -62,18 +83,20 @@ module Bashcov
 
   private
 
-    def inject_shellopts_flags
-      # SHELLOPTS must be exported so we use Ruby's ENV variable
-      existing_flags = (ENV['SHELLOPTS'] || '').split(shellopts_separator)
-      ENV['SHELLOPTS'] = (existing_flags | shellopts_flags).join(shellopts_separator)
-    end
+    def setup
+      inject_xtrace_flag
+
+      @stdout = []
+      @stderr = []
 
-    def shellopts_flags
-      %w(verbose xtrace)
+      @command = "PS4='#{Xtrace.ps4}' #{@filename}"
     end
 
-    def shellopts_separator
-      ':'
+    def inject_xtrace_flag
+      # SHELLOPTS must be exported so we use Ruby's ENV variable
+      existing_flags = (ENV['SHELLOPTS'] || '').split(':')
+      ENV['SHELLOPTS'] = (existing_flags | ['xtrace']).join(':')
     end
   end
 end
+

data/lib/bashcov/version.rb

@@ -1,3 +1,3 @@
 module Bashcov
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/bashcov/xtrace.rb

@@ -1,15 +1,19 @@
 module Bashcov
   class Xtrace
     def initialize output
-      @output = output
+      raise "#{output} must be an array" unless output.is_a? Array
+      @lines = output
+    end
+
+    def xtrace_output
+      @lines.select { |line| line =~ Xtrace.line_regexp }
     end
 
     def files
       files = {}
 
-      @output.readlines.each do |line|
-        next unless match = line.match(Xtrace.line_regexp)
-
+      xtrace_output.each do |line|
+        match = line.match(Xtrace.line_regexp)
         filename = File.expand_path(match[:filename], Bashcov.root_directory)
         next if File.directory? filename
         raise "#{filename} is not a file" unless File.file? filename

data/lib/bashcov.rb

@@ -1,11 +1,58 @@
-require "bashcov/version"
-require "bashcov/lexer"
-require "bashcov/line"
-require "bashcov/runner"
-require "bashcov/xtrace"
+require 'optparse'
+require 'ostruct'
+require 'bashcov/version'
+require 'bashcov/lexer'
+require 'bashcov/line'
+require 'bashcov/runner'
+require 'bashcov/xtrace'
 
 module Bashcov
   class << self
+    attr_reader :options
+
+    def set_default_options!
+      @options ||= OpenStruct.new
+      @options.skip_uncovered = false
+      @options.mute = false
+    end
+
+    def parse_options! args
+      OptionParser.new do |opts|
+        opts.banner = "Usage: #{opts.program_name} [options] <filename>"
+        opts.version = Bashcov::VERSION
+
+        opts.separator ""
+        opts.separator "Specific options:"
+
+        opts.on("-s", "--skip-uncovered", "Do not report uncovered files") do |s|
+          @options.skip_uncovered = s
+        end
+
+        opts.on("-m", "--mute", "Do not print script output") do |m|
+          @options.mute = m
+        end
+
+        opts.separator ""
+        opts.separator "Common options:"
+
+        opts.on_tail("-h", "--help", "Show this message") do
+          abort(opts.help)
+        end
+
+        opts.on_tail("--version", "Show version") do
+          puts opts.ver
+          exit
+        end
+
+      end.parse!(args)
+
+      if args.one?
+        @options.filename = args.shift
+      else
+        abort("You must give exactly one file to execute.")
+      end
+    end
+
     def root_directory
       Dir.getwd
     end
@@ -20,3 +67,6 @@ module Bashcov
     end
   end
 end
+
+Bashcov.set_default_options!
+

data/spec/bashcov/lexer_spec.rb

@@ -3,26 +3,24 @@ require 'spec_helper'
 shared_examples "a bash file" do
   describe "#irrelevant_lines" do
     it "returns irrelevant lines" do
-      lexer = Bashcov::Lexer.new File.join(scripts, filename)
+      coverage = expected_coverage[filename]
+      irrelevant_lines = 0.upto(coverage.size - 1).select do |idx|
+        coverage[idx].nil?
+      end
+
+      lexer = Bashcov::Lexer.new filename
       lexer.irrelevant_lines.should =~ irrelevant_lines
     end
   end
 end
 
 describe Bashcov::Lexer do
-  it_behaves_like "a bash file" do
-    let(:filename) { 'simple.sh' }
-    let(:irrelevant_lines) { [0, 1, 2, 3, 6, 8, 9, 11, 12] }
-  end
-
-  it_behaves_like "a bash file" do
-    let(:filename) { 'function.sh' }
-    let(:irrelevant_lines) { [0, 1, 2, 4, 5, 6, 9, 10, 13] }
-  end
-
-  it_behaves_like "a bash file" do
-    let(:filename) { 'sourced.txt' }
-    let(:irrelevant_lines) { [0, 1, 3] }
+  expected_coverage.keys.each do |filename|
+    context filename do
+      it_behaves_like "a bash file" do
+        let(:filename) { filename }
+      end
+    end
   end
 end
 

data/spec/bashcov/runner_spec.rb

@@ -12,18 +12,18 @@ describe Bashcov::Runner do
 
       it "adds the flags" do
         runner.run
-        ENV['SHELLOPTS'].should == 'verbose:xtrace'
+        ENV['SHELLOPTS'].should == 'xtrace'
       end
     end
 
     context "with an existing SHELLOPTS variable" do
       before do
-        ENV['SHELLOPTS'] = 'posix:verbose'
+        ENV['SHELLOPTS'] = 'posix'
       end
 
       it "merges the flags" do
         runner.run
-        ENV['SHELLOPTS'].should == 'posix:verbose:xtrace'
+        ENV['SHELLOPTS'].should == 'posix:xtrace'
       end
     end
   end
@@ -56,7 +56,7 @@ describe Bashcov::Runner do
     it { should be_a Hash }
 
     it "contains all files" do
-      subject.keys.should =~ all_files
+      subject.keys.should =~ bash_files | executed_files
     end
 
     it "adds correct coverage results" do
@@ -77,5 +77,31 @@ describe Bashcov::Runner do
 
       runner.result.should == expected_coverage
     end
+
+    context "with options.skip_uncovered = true" do
+      before do
+        Bashcov.options.skip_uncovered = true
+      end
+
+      it "does not include uncovered files" do
+        runner.run
+        (runner.result.keys & uncovered_files).should be_empty
+      end
+    end
+
+    context "with options.mute = false" do
+      before do
+        Bashcov.options.mute = false
+      end
+
+      it "does not print xtrace output" do
+        $stderr.should_receive(:puts).at_least(:once) do |line|
+          line.should_not match Bashcov::Xtrace.line_regexp
+        end
+
+        runner.run
+      end
+    end
   end
 end
+

data/spec/bashcov/xtrace_spec.rb

@@ -4,7 +4,7 @@ describe Bashcov::Xtrace do
   let(:xtrace) {
     runner = Bashcov::Runner.new test_suite
     runner.run
-    Bashcov::Xtrace.new runner.output
+    Bashcov::Xtrace.new runner.stderr
   }
 
   describe "#files" do
@@ -14,7 +14,7 @@ describe Bashcov::Xtrace do
     it { should be_a Hash }
 
     it "contains expected files" do
-      subject.keys.should =~ executed_files | [test_suite]
+      subject.keys.should =~ executed_files
     end
   end
 end

data/spec/bashcov_spec.rb

@@ -1,6 +1,74 @@
 require 'spec_helper'
 
+shared_examples "a fatal error" do
+  it "outputs to stderr" do
+    $stderr.should_receive(:write).at_least(:once)
+    ignore_exception { subject }
+  end
+
+  it "exits with non-zero" do
+    expect { subject }.to raise_error { |error|
+      error.should be_a SystemExit
+      error.status.should_not == 0
+    }
+  end
+end
+
 describe Bashcov do
+  describe ".parse_options!" do
+    before { @args = [] }
+
+    subject { Bashcov.parse_options! @args }
+
+    context "without any options" do
+      it_behaves_like "a fatal error"
+    end
+
+    context "with a filename" do
+      before { @args << 'script.sh' }
+
+      context "with the --skip-uncovered flag" do
+        before { @args << '--skip-uncovered' }
+
+        it "sets it properly" do
+          subject
+          Bashcov.options.skip_uncovered.should be_true
+        end
+      end
+
+      context "with the --mute flag" do
+        before { @args << '--mute' }
+
+        it "sets it properly" do
+          subject
+          Bashcov.options.mute.should be_true
+        end
+      end
+
+      context "with the --help flag" do
+        before { @args << '--help' }
+
+        it_behaves_like "a fatal error"
+      end
+
+      context "with the --version flag" do
+        before { @args << '--version' }
+
+        it "outputs to stdout" do
+          $stdout.should_receive(:write).at_least(:once)
+          ignore_exception { subject }
+        end
+
+        it "exits with zero" do
+          expect { subject }.to raise_error { |error|
+            error.should be_a SystemExit
+            error.status.should == 0
+          }
+        end
+      end
+    end
+  end
+
   describe ".link" do
     it "includes the version" do
       Bashcov.link.should include Bashcov::VERSION

data/spec/spec_helper.rb

@@ -11,3 +11,10 @@ require 'bashcov'
 
 Dir["./spec/support/**/*.rb"].each { |file| require file }
 
+RSpec.configure do |config|
+  config.before(:each) do
+    Bashcov.set_default_options!
+    Bashcov.options.mute = true # don't print testsuite output
+  end
+end
+

data/spec/support/common.rb

@@ -0,0 +1,10 @@
+# Common helpers
+
+def ignore_exception
+  begin
+    yield
+  rescue Exception
+    # silently ignore the exception
+  end
+end
+

data/spec/support/test_app.rb

@@ -10,16 +10,16 @@ def test_suite
   "#{test_app}/test_suite.sh"
 end
 
-def executed_files
-  files_in("#{scripts}/**/*")
+def uncovered_files
+  ["#{test_app}/never_called.sh"]
 end
 
-def bash_files
-  files_in("#{test_app}/**/*.sh") - [test_suite]
+def executed_files
+  bash_files - uncovered_files + ["#{scripts}/sourced.txt"]
 end
 
-def all_files
-  files_in("#{test_app}/**/*") - [test_suite]
+def bash_files
+  files_in("#{test_app}/**/*.sh")
 end
 
 def files_in directory
@@ -29,13 +29,16 @@ end
 def expected_coverage
   {
     "#{test_app}/never_called.sh" => [nil, nil, 0, nil],
+    "#{test_app}/scripts/case.sh" => [nil, nil, nil, 2, 1, nil, 0, 0, 1, nil, nil, nil, 1, 1, nil],
     "#{test_app}/scripts/function.sh" => [nil, nil, nil, 2, nil, nil, nil, 1, 1, nil, nil, 1, 1, nil],
     "#{test_app}/scripts/long_line.sh" => [nil, nil, 1, 1, 1, 0, nil],
     "#{test_app}/scripts/nested/simple.sh" => [nil, nil, nil, nil, 1, 1, nil, 0, nil, nil, 1, nil, nil],
     "#{test_app}/scripts/one_liner.sh" => [nil, nil, 2, nil, 1, nil, 0, nil, nil],
     "#{test_app}/scripts/simple.sh" => [nil, nil, nil, nil, 1, 1, nil, 0, nil, nil, 1, nil, nil],
     "#{test_app}/scripts/source.sh" => [nil, nil, 1, nil, 2, nil],
-    "#{test_app}/scripts/sourced.txt" => [nil, nil, 1, nil]
+    "#{test_app}/scripts/sourced.txt" => [nil, nil, 1, nil],
+    "#{test_app}/scripts/stdin.sh" => [nil, nil, 1, 1, 1, nil],
+    "#{test_app}/test_suite.sh" => [nil, nil, 2, nil, nil, 2, nil]
   }
 end
 

data/spec/test_app/README.md

@@ -0,0 +1 @@
+I'm just a README, I shouldn't interfere with anything.

data/spec/test_app/scripts/README.md

@@ -0,0 +1 @@
+I'm just a README, I shouldn't interfere with anything.

data/spec/test_app/scripts/case.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+function switch() {
+    case $1 in
+        -h|--help) echo help
+        ;;
+        -v|--version)
+        echo version;;
+        *) echo "what?";;
+    esac
+}
+
+switch -h
+switch bug
+

data/spec/test_app/scripts/stdin.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+echo "What's your input?"
+read
+echo "All right, you entered \`${REPLY}'."
+

data/spec/test_app/test_suite.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
 cd $(dirname $0)
-find scripts -name "*.sh" -exec "{}" \;
+
+# `date` is sent on stdin for each file
+date | find scripts -name "*.sh" -exec '{}' \;
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bashcov
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-13 00:00:00.000000000 Z
+date: 2012-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: open4
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -121,9 +137,13 @@ files:
 - spec/bashcov/xtrace_spec.rb
 - spec/bashcov_spec.rb
 - spec/spec_helper.rb
+- spec/support/common.rb
 - spec/support/test_app.rb
 - spec/test_app/.simplecov
+- spec/test_app/README.md
 - spec/test_app/never_called.sh
+- spec/test_app/scripts/README.md
+- spec/test_app/scripts/case.sh
 - spec/test_app/scripts/function.sh
 - spec/test_app/scripts/long_line.sh
 - spec/test_app/scripts/nested/simple.sh
@@ -131,6 +151,7 @@ files:
 - spec/test_app/scripts/simple.sh
 - spec/test_app/scripts/source.sh
 - spec/test_app/scripts/sourced.txt
+- spec/test_app/scripts/stdin.sh
 - spec/test_app/test_suite.sh
 homepage: https://github.com/infertux/bashcov
 licenses: []
@@ -162,9 +183,13 @@ test_files:
 - spec/bashcov/xtrace_spec.rb
 - spec/bashcov_spec.rb
 - spec/spec_helper.rb
+- spec/support/common.rb
 - spec/support/test_app.rb
 - spec/test_app/.simplecov
+- spec/test_app/README.md
 - spec/test_app/never_called.sh
+- spec/test_app/scripts/README.md
+- spec/test_app/scripts/case.sh
 - spec/test_app/scripts/function.sh
 - spec/test_app/scripts/long_line.sh
 - spec/test_app/scripts/nested/simple.sh
@@ -172,4 +197,5 @@ test_files:
 - spec/test_app/scripts/simple.sh
 - spec/test_app/scripts/source.sh
 - spec/test_app/scripts/sourced.txt
+- spec/test_app/scripts/stdin.sh
 - spec/test_app/test_suite.sh