bashcov 0.0.6 → 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6613eed0d116984da22b7fb51ddd45617e148928
+  data.tar.gz: 289ef645df22d964dbe8275837458fe5e044d110
+SHA512:
+  metadata.gz: 6e461f96cde82d60a97f7458cdf40cfcaac55621c4cf0c0c028ac859880f1d3c3b569b5270331ef7754da2d9cfe77bea3ec892c5e80df27ebeb72a432ab6be3d
+  data.tar.gz: 5c4af2c0ad3e0c51e6d7cb5b4ca5288326781b6ef068d22b63ec32abe4cf1898ab518c7bd16dc2ee1709d9f16e1e1dcef3e0b699259dca31478d33771d459893

data/.travis.yml

@@ -10,3 +10,4 @@ rvm:
 matrix:
   allow_failures:
     - rvm: ruby-head
+    - rvm: rbx-19mode

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) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/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/github/infertux/bashcov.png)](https://codeclimate.com/github/infertux/bashcov)
 
 [bashcov] is [simplecov] for Bash.
 
@@ -37,10 +37,6 @@ After a bit of parsing, it sends results through _simplecov_ which generates an
 
 And of course, you can take the most of _simplecov_ by adding a `.simplecov` file in your project's root (like [this](https://github.com/infertux/bashcov/blob/master/spec/test_app/.simplecov)).
 
-## Todo
-
-- semver
-
 ## License
 
 MIT

data/bashcov.gemspec

@@ -19,7 +19,6 @@ 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/lib/bashcov.rb

@@ -26,6 +26,42 @@ module Bashcov
     # @raise [SystemExit] if invalid arguments are given
     # @return [void]
     def parse_options! args
+      option_parser.parse!(args)
+
+      if args.empty?
+        abort("You must give exactly one command to execute.")
+      else
+        @options.command = args.join(' ')
+      end
+    end
+
+    # @return [String] The project's root directory
+    def root_directory
+      Dir.getwd
+    end
+
+    # Program name including version for easy consistent output
+    # @return [String]
+    def name
+      "bashcov v#{VERSION}"
+    end
+
+    # Helper to get a pre-filled coverage array for a given file
+    # @todo This is generic and should be moved in some helpers file.
+    # @api private
+    # @param [String] filename The file to cover.
+    # @param [nil, Integer] fill Value to fill the array with.
+    # @return [Array] An array of the size of the given file.
+    # @example
+    #   coverage_array('file.rb') #=> [0, 0, 0] # assuming file.rb has 3 lines
+    def coverage_array(filename, fill = Line::UNCOVERED)
+      lines = File.readlines(filename).size
+      [fill] * lines
+    end
+
+  private
+
+    def option_parser
       OptionParser.new do |opts|
         opts.program_name = 'bashcov'
         opts.version = Bashcov::VERSION
@@ -58,39 +94,8 @@ module Bashcov
           puts opts.ver
           exit
         end
-
-      end.parse!(args)
-
-      if args.empty?
-        abort("You must give exactly one command to execute.")
-      else
-        @options.command = args.join(' ')
       end
     end
-
-    # @return [String] The project's root directory
-    def root_directory
-      Dir.getwd
-    end
-
-    # Program name including version for easy consistent output
-    # @return [String]
-    def name
-      "bashcov v#{VERSION}"
-    end
-
-    # Helper to get a pre-filled coverage array for a given file
-    # @todo This is generic and should be moved in some helpers file.
-    # @api private
-    # @param [String] filename The file to cover.
-    # @param [nil, Integer] fill Value to fill the array with.
-    # @return [Array] An array of the size of the given file.
-    # @example
-    #   coverage_array('file.rb') #=> [0, 0, 0] # assuming file.rb has 3 lines
-    def coverage_array(filename, fill = Line::UNCOVERED)
-      lines = File.readlines(filename).size
-      [fill] * lines
-    end
   end
 end
 

data/lib/bashcov/lexer.rb

@@ -28,6 +28,7 @@ module Bashcov
 
       line.empty? or
       start_with.any? { |token| line.start_with? token } or
+      end_with.any? { |token| line.end_with? token } or
       is.any? { |keyword| line == keyword } or
       line =~ /\A\w+\(\) {/ # function declared like this: "foo() {"
     end
@@ -41,5 +42,10 @@ module Bashcov
     def start_with
       %w(# function)
     end
+
+    # Lines ending with one of these tokens are irrelevant for coverage
+    def end_with
+      %w(\()
+    end
   end
 end

data/lib/bashcov/runner.rb

@@ -1,47 +1,27 @@
-require 'open4'
-
 module Bashcov
-  # Runs a given command capturing output then computes code coverage.
+  # Runs a given command with xtrace enabled then computes code coverage.
   class Runner
-    # @return [Array] +stdout+ from the last run
-    attr_reader :stdout
-
-    # @return [Array] +stderr+ from the last run
-    attr_reader :stderr
-
     # @param [String] command Command to run
     def initialize command
       @command = command
     end
 
-    # Runs the command capturing +stdout+ and +stderr+.
+    # Runs the command with appropriate xtrace settings.
     # @note Binds Bashcov +stdin+ to the program executed.
-    # @note Uses two threads to stream +stdout+ and +stderr+ output in
-    #   realtime.
-    # @return [void]
+    # @return [Process::Status] Status of the executed command
     def run
-      setup
+      inject_xtrace_flag!
 
-      Open4::popen4(@command) do |pid, stdin, stdout, stderr|
-        stdin = $stdin # bind stdin
+      @xtrace = Xtrace.new
+      fd = @xtrace.file_descriptor
+      @command = "BASH_XTRACEFD=#{fd} PS4='#{Xtrace.ps4}' #{@command}"
+      options = {:in => :in, fd => fd} # bind fds to the child process
+      options.merge!({out: '/dev/null', err: '/dev/null'}) if Bashcov.options.mute
 
-        [
-          Thread.new { # stdout
-            stdout.each do |line|
-              @stdout << line
-              $stdout.puts line unless Bashcov.options.mute
-            end
-          },
-          Thread.new { # stderr
-            stderr.each do |line|
-              @stderr << line
-              next if Bashcov.options.mute
-              xtrace = Xtrace.new [line]
-              $stderr.puts line if xtrace.xtrace_output.empty?
-            end
-          }
-        ].map(&:join)
-      end
+      pid = Process.spawn @command, options
+      Process.wait pid
+
+      $?
     end
 
     # @return [Hash] Coverage hash of the last run
@@ -72,9 +52,7 @@ module Bashcov
     # @return [Hash] Given hash including coverage result from {Xtrace}
     # @see Xtrace
     def add_coverage_result files
-      xtraced_files = Xtrace.new(@stderr).files
-
-      xtraced_files.each do |file, lines|
+      @xtrace.files.each do |file, lines|
         lines.each_with_index do |line, lineno|
           files[file] ||= Bashcov.coverage_array(file)
           files[file][lineno] = line if line
@@ -98,16 +76,7 @@ module Bashcov
 
   private
 
-    def setup
-      inject_xtrace_flag
-
-      @stdout = []
-      @stderr = []
-
-      @command = "PS4='#{Xtrace.ps4}' #{@command}"
-    end
-
-    def inject_xtrace_flag
+    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(':')

data/lib/bashcov/version.rb

@@ -1,4 +1,4 @@
 module Bashcov
   # Bashcov version
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/bashcov/xtrace.rb

@@ -1,19 +1,19 @@
+require 'tempfile'
+
 module Bashcov
   # This class manages +xtrace+ output.
   #
   # @see Runner
   class Xtrace
-    # @param [Array] output Array of output lines.
-    # @raise [ArgumentError] if the given +output+ is not an array
-    def initialize output
-      raise ArgumentError, "#{output} must be an array" unless output.is_a? Array
-      @lines = output
+    # Creates a temporary file for xtrace output
+    def initialize
+      @xtrace_file = Tempfile.new 'xtrace_output'
+      @xtrace_file.unlink # unlink on create so other programs cannot access it
     end
 
-    # Filters out non-xtrace lines.
-    # @return [Array] xtrace output
-    def xtrace_output
-      @lines.select { |line| line =~ Xtrace.line_regexp }
+    # @return [Fixnum] File descriptor of the output file
+    def file_descriptor
+      @xtrace_file.fileno
     end
 
     # Parses xtrace output and computes coverage
@@ -22,17 +22,17 @@ module Bashcov
     def files
       files = {}
 
-      xtrace_output.each do |line|
-        match = line.match(Xtrace.line_regexp)
+      @xtrace_file.rewind
+      @xtrace_file.read.each_line do |line|
+        match = line.match(self.class.line_regexp)
+        next if match.nil? # multiline instruction
+
         filename = File.expand_path(match[:filename], Bashcov.root_directory)
         next if File.directory? filename
         raise "#{filename} is not a file" unless File.file? filename
 
-        lineno = match[:lineno].to_i
-        lineno -= 1 if lineno > 0
-
+        lineno = match[:lineno].to_i - 1
         files[filename] ||= Bashcov.coverage_array(filename)
-
         files[filename][lineno] += 1
       end
 
@@ -46,7 +46,7 @@ module Bashcov
       # character in filenames on Unix and Windows.
 
       # http://stackoverflow.com/questions/59895/can-a-bash-script-tell-what-directory-its-stored-in
-      %Q{#{prefix}$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/$(basename "${BASH_SOURCE[0]}")/${LINENO} BASHCOV}
+      %Q{#{prefix}$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/$(basename "${BASH_SOURCE[0]}")/${LINENO} BASHCOV: }
     end
 
   private
@@ -62,7 +62,7 @@ module Bashcov
     end
 
     def self.line_regexp
-      /\A#{depth_character}+#{prefix[1..-1]}(?<filename>.+)\/(?<lineno>\d+) BASHCOV/
+      /\A#{depth_character}+#{prefix[1..-1]}(?<filename>.+)\/(?<lineno>\d+) BASHCOV: /
     end
   end
 end

data/spec/bashcov/runner_spec.rb

@@ -93,14 +93,14 @@ describe Bashcov::Runner do
       end
     end
 
-    context "with options.mute = false" do
+    context "with options.mute = true" do
       before do
-        Bashcov.options.mute = false
+        Bashcov.options.mute = true
       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
+      it "does not print the command output" do
+        [$stdout, $stderr].each do |io|
+          io.should_not_receive :write
         end
 
         runner.run

data/spec/support/test_app.rb

@@ -29,7 +29,7 @@ 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/case.sh" => [nil, nil, nil, 6, 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],
@@ -37,10 +37,9 @@ def expected_coverage
     "#{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/stdin.sh" => [nil, nil, 1, 1, 1, nil],
-    "#{test_app}/scripts/multiline.sh" => [nil, nil, 1, 2, 1, 1, 0, nil],
+    "#{test_app}/scripts/multiline.sh" => [nil, nil, 1, 2, 1, 1, 0, nil, nil, 0, 1, 2], # XXX the 3 last lines should be [1, 1, 1] - Bash bug
     "#{test_app}/scripts/executable" => [nil, nil, 1, nil],
-    "#{test_app}/test_suite.sh" => [nil, nil, 2, nil, nil, 2, nil]
+    "#{test_app}/test_suite.sh" => [nil, nil, 2, nil, 1, nil]
   }
 end
 

data/spec/test_app/scripts/multiline.sh

@@ -6,3 +6,7 @@
   echo 'what?' || \
   echo 'no!'
 
+variable=($(
+  echo hi
+))
+echo after

data/spec/test_app/test_suite.sh

@@ -2,6 +2,5 @@
 
 cd $(dirname $0)
 
-# `date` is sent on stdin for each file
-date | find scripts -type f -executable -exec '{}' \;
+find scripts -type f -executable -exec '{}' \;
 

metadata

@@ -1,142 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: bashcov
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 0.0.7
 platform: ruby
 authors:
 - Cédric Félizard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   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: 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
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-inotify
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: cane
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Code coverage tool for Bash
@@ -165,7 +134,6 @@ files:
 - lib/bashcov/xtrace.rb
 - spec/bashcov/lexer_spec.rb
 - spec/bashcov/runner_spec.rb
-- spec/bashcov/xtrace_spec.rb
 - spec/bashcov_spec.rb
 - spec/spec_helper.rb
 - spec/support/common.rb
@@ -184,37 +152,34 @@ 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:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Code coverage tool for Bash
 test_files:
 - spec/bashcov/lexer_spec.rb
 - spec/bashcov/runner_spec.rb
-- spec/bashcov/xtrace_spec.rb
 - spec/bashcov_spec.rb
 - spec/spec_helper.rb
 - spec/support/common.rb
@@ -233,6 +198,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
 has_rdoc: 

data/spec/bashcov/xtrace_spec.rb

@@ -1,20 +0,0 @@
-require 'spec_helper'
-
-describe Bashcov::Xtrace do
-  let(:xtrace) {
-    runner = Bashcov::Runner.new test_suite
-    runner.run
-    Bashcov::Xtrace.new runner.stderr
-  }
-
-  describe "#files" do
-    let(:files) { xtrace.files }
-    subject { files }
-
-    it { should be_a Hash }
-
-    it "contains expected files" do
-      subject.keys.should =~ executed_files
-    end
-  end
-end

data/spec/test_app/scripts/stdin.sh

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