bashcov 0.0.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88c6a87e619ad3f8d9264f845beac5000ebcd7d3
-  data.tar.gz: 205f57915123a4b81ec07b73b36362e1b17a3a4a
+  metadata.gz: d8360ca3ab8a2d06296fbd911a15045bf10257d1
+  data.tar.gz: 9de0f7c886d9ab871d6b17870788bce1925e2b30
 SHA512:
-  metadata.gz: c546c3e593a2fe3679ce71e9a72e17a1296438b5e95de7066f44e843c1a906db861fc7028e82d81ce068eddd25699dcd4c069e76b11f8349ee71ae8660bb13db
-  data.tar.gz: 465f6ff0a51642e534001f7cb81c068a196042f0f4b50d6506f44dbff60e16d7d74d3a5143eb6b91d7afea83a5d9e96174c21e53d03c98bd5b5aaee005a1e04d
+  metadata.gz: cae406036062359b26ddf208eb95dab86d9263aef1a1b04eb37c628300678281b83834183d6c037713a67a648ad9a90e2570ca045f5b75b39380995aeb6852b3
+  data.tar.gz: 18f0ba69db66d6c36b414c8dd0bd6710f5a3d82ec566b3acc9a5d4cdcff6a5bd806ae6f3a79317970869b15dea7ce1f1db2139762478cf002181d9683ddca41e

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v1.0.0...master))
+
+  * TBD
+
+## v1.0.0, 2013-03-16 ([changes](https://github.com/infertux/bashcov/compare/v0.0.9...v1.0.0))
+
+  * First stable release. Enjoy!
+
+## v0.0.1 to v0.0.9, 2012-12-08 to 2013-03-05 ([changes](https://github.com/infertux/bashcov/compare/v0.0.1...v0.0.9))
+
+  * Experimental pre-releases. You should avoid to use these versions.
+

data/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Making Contributions
+
+If you want to contribute, please:
+
+  * Fork the project.
+  * Make your feature addition or bug fix in a new branch.
+  * Add tests for it. This is important so I don't break it in a future version unintentionally.
+  * Send me a pull request on Github.
+

data/Guardfile

@@ -1,6 +1,6 @@
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec', :version => 2 do
+guard 'rspec', cli: '--tag ~speed:slow' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})        { |m| "spec/#{m[1]}_spec.rb" }
   watch(%r{^lib/(.+)/(.+)\.rb$})   { |m| "spec/#{m[1]}/#{m[2]}_spec.rb" }

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Cédric Félizard
+Copyright (c) 2012-2013 Cédric Félizard
 
 MIT License
 

data/README.md

@@ -1,8 +1,27 @@
 # Bashcov [![Build Status](https://secure.travis-ci.org/infertux/bashcov.png?branch=master)](https://travis-ci.org/infertux/bashcov) [![Dependency Status](https://gemnasium.com/infertux/bashcov.png)](https://gemnasium.com/infertux/bashcov) [![Code Climate](https://codeclimate.com/github/infertux/bashcov.png)](https://codeclimate.com/github/infertux/bashcov)
 
-[bashcov] is [simplecov] for Bash.
-
-Check out the **[demo](http://infertux.github.com/bashcov/test_app/)** - it's worth a thousand words.
+**Code coverage for Bash**
+
+  * [Source Code]
+  * [Bug Tracker]
+  * [API Documentation]
+  * [Changelog]
+  * [Rubygem]
+  * [Continuous Integration]
+  * [Dependencies]
+  * [SimpleCov]
+
+[Source Code]: https://github.com/infertux/bashcov "Source Code on Github"
+[Bug Tracker]: https://github.com/infertux/bashcov/issues "Bug Tracker on Github"
+[API documentation]: http://rubydoc.info/gems/bashcov/frames "API Documentation on Rubydoc"
+[Changelog]: https://github.com/infertux/bashcov/blob/master/CHANGELOG.md "Project Changelog"
+[Rubygem]: https://rubygems.org/gems/bashcov "Bashcov on Rubygems"
+[Continuous Integration]: https://travis-ci.org/infertux/bashcov "Bashcov on Travis-CI"
+[Dependencies]: https://gemnasium.com/infertux/bashcov "Bashcov dependencies on Gemnasium"
+[Bashcov]: https://github.com/infertux/bashcov
+[SimpleCov]: https://github.com/colszowka/simplecov "Bashcov is backed by SimpleCov to generate awesome coverage report"
+
+You should check out the **[demo](http://infertux.github.com/bashcov/test_app/)** -- it's worth a thousand words.
 
 ## Installation
 
@@ -10,40 +29,31 @@ Check out the **[demo](http://infertux.github.com/bashcov/test_app/)** - it's wo
 
 ## Usage
 
-`bashcov ./test_suite.sh`
-
-This will create a directory named `coverage/` containing HTML files.
-
-## Rationale
-
-I'm a big fan of both Ruby's _simplecov_ and Bash.
-_bashcov_ is my dream to have in Bash what _simplecov_ is to Ruby :).
+`bashcov --help` prints all available options.
+Here are some examples:
 
-Oddly enough, I didn't find any coverage tool for Bash except [shcov] but as stated [there](http://stackoverflow.com/questions/7188081/code-coverage-tools-for-validating-the-scripts), _shcov_ is:
+    bashcov ./script.sh
+    bashcov --skip-uncovered ./script.sh
+    bashcov -- ./script.sh --some --flags
+    bashcov --skip-uncovered -- ./script.sh --some --flags
 
-> somewhat simplistic and doesn't handle all possible cases very well (especially when we're talking about long and complex lines)
+`script.sh` can be a mere Bash script or typically your CI script.
+Bashcov will keep track of all executed scripts.
 
-Indeed, it doesn't work very well for me.
-I have covered lines marked as uncovered and some files completely missed although executed through another script.
+Then it will create a directory named `./coverage/` containing nice HTML files.
+Open `./coverage/index.html` to browse the coverage report.
 
-_bashcov_ aims to be a neat and working coverage tool backed by _simplecov_ and [simplecov-html].
+### SimpleCov integration
 
-## How does it work?
+You can take great advantage 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)).
+See [SimpleCov README](https://github.com/colszowka/simplecov#readme) for more information.
 
-Ruby has a [coverage module](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/coverage/rdoc/Coverage.html) which computes the coverage on demand.
-Unfortunately, Bash doesn't have such niceties but we can use the [xtrace feature](http://www.gnu.org/software/bash/manual/bashref.html#index-BASH_005fXTRACEFD-178) which prints every line executed using [PS4](http://www.gnu.org/software/bash/manual/bashref.html#index-PS4).
+## Contributing
 
-After a bit of parsing, it sends results through _simplecov_ which generates an awesome HTML report.
-
-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)).
+Bug reports and patches are most welcome.
+See the [contribution guidelines](https://github.com/infertux/bashcov/blob/master/CONTRIBUTING.md).
 
 ## License
 
 MIT
 
-
-[bashcov]: https://github.com/infertux/bashcov
-[simplecov]: https://github.com/colszowka/simplecov
-[simplecov-html]: https://github.com/colszowka/simplecov-html
-[shcov]: http://code.google.com/p/shcov/source/browse/trunk/scripts/shcov
-

data/bashcov.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'simplecov'
+  gem.add_dependency 'simplecov', '~> 0.7.1'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'

data/bin/bashcov

@@ -14,6 +14,6 @@ coverage = runner.result
 require 'simplecov'
 
 SimpleCov.command_name Bashcov.name
-# SimpleCov.filters = [] # TODO make sure default filters are okay
+SimpleCov.filters = [] # remove default filters
 SimpleCov::Result.new(coverage).format!
 

data/lib/bashcov.rb

@@ -10,9 +10,15 @@ require 'bashcov/xtrace'
 # @note Keep it short!
 module Bashcov
   class << self
+
     # @return [OpenStruct] Bashcov settings
     attr_reader :options
 
+    # @return [String] The project's root directory inferred from the command
+    def root_directory
+      @root_directory ||= File.dirname(File.absolute_path(@options.command))
+    end
+
     # Sets default options overriding any existing ones.
     # @return [void]
     def set_default_options!
@@ -35,51 +41,35 @@ module Bashcov
       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]
+    # @return [String] Program name including version for easy consistent output
     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 help program_name
+      <<-HELP.gsub!(/^ +/, '').gsub!("\t", ' ' * 4)
+        Usage: #{program_name} [options] [--] <command> [options]
+        Examples:
+        \t#{program_name} ./script.sh
+        \t#{program_name} --skip-uncovered ./script.sh
+        \t#{program_name} -- ./script.sh --some --flags
+        \t#{program_name} --skip-uncovered -- ./script.sh --some --flags
+      HELP
+    end
+
     def option_parser
       OptionParser.new do |opts|
         opts.program_name = 'bashcov'
         opts.version = Bashcov::VERSION
-        opts.banner = <<-HELP.gsub!(/^ +/, '').gsub!("\t", ' ' * 4)
-          Usage: #{opts.program_name} [options] -- <command> [options]
-          Examples:
-          \t#{opts.program_name} ./script.sh
-          \t#{opts.program_name} --skip-uncovered ./script.sh
-          \t#{opts.program_name} -- ./script.sh --some --flags
-          \t#{opts.program_name} --skip-uncovered -- ./script.sh --some --flags
-        HELP
+        opts.banner = help opts.program_name
 
         opts.separator "\nSpecific 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
@@ -89,7 +79,6 @@ module Bashcov
         opts.on_tail("-h", "--help", "Show this message") do
           abort(opts.help)
         end
-
         opts.on_tail("--version", "Show version") do
           puts opts.ver
           exit

data/lib/bashcov/lexer.rb

@@ -2,50 +2,50 @@ module Bashcov
   # Simple lexer which analyzes Bash files in order to get information for
   # coverage
   class Lexer
+    # Lines starting with one of these tokens are irrelevant for coverage
+    IGNORE_START_WITH = %w|# function|
+
+    # Lines ending with one of these tokens are irrelevant for coverage
+    IGNORE_END_WITH = %w|(|
+
+    # Lines containing only one of these keywords are irrelevant for coverage
+    IGNORE_IS = %w|esac if then fi while do done else { } ;;|
+
     # @param [String] filename File to analyze
+    # @param [Hash] coverage Coverage with executed lines marked
     # @raise [ArgumentError] if the given +filename+ is invalid.
-    def initialize filename
+    def initialize filename, coverage
       @filename = File.expand_path(filename)
+      @coverage = coverage
 
       unless File.file?(@filename)
         raise ArgumentError, "#{@filename} is not a file"
       end
     end
 
-    # @return [Array] Irrelevant lines
-    def irrelevant_lines
-      lines = []
-      IO.readlines(@filename).each_with_index do |line, lineno|
-        lines << lineno if is_irrevelant? line
+    # Yields uncovered relevant lines.
+    # @note Uses +@coverage+ to avoid wasting time parsing executed lines.
+    # @return [void]
+    def uncovered_relevant_lines
+      lineno = 0
+      File.open(@filename, 'rb').each_line do |line|
+        if @coverage[lineno] == Bashcov::Line::IGNORED and is_revelant? line
+          yield lineno
+        end
+        lineno +=1
       end
-      lines
     end
 
   private
 
-    def is_irrevelant? line
+    def is_revelant? line
       line.strip!
 
-      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
-
-    # Lines containing only one of these keywords are irrelevant for coverage
-    def is
-      %w(esac fi then do done else { } ;;)
-    end
-
-    # Lines starting with one of these tokens are irrelevant for coverage
-    def start_with
-      %w(# function)
-    end
-
-    # Lines ending with one of these tokens are irrelevant for coverage
-    def end_with
-      %w(\()
+      !line.empty? and
+      !IGNORE_IS.include? line and
+      !line.start_with?(*IGNORE_START_WITH) and
+      !line.end_with?(*IGNORE_END_WITH) and
+      line !~ /\A\w+\(\)/ # function declared without the 'function' keyword
     end
   end
 end

data/lib/bashcov/line.rb

@@ -1,5 +1,5 @@
 module Bashcov
-  # {Line} represents a line of code
+  # {Line} represents a line of code.
   module Line
     # Uncovered line
     # @see http://www.ruby-doc.org/stdlib-1.9.3/libdoc/coverage/rdoc/Coverage.html

data/lib/bashcov/runner.rb

@@ -7,80 +7,79 @@ module Bashcov
     end
 
     # Runs the command with appropriate xtrace settings.
-    # @note Binds Bashcov +stdin+ to the program executed.
+    # @note Binds Bashcov +stdin+ to the program being executed.
     # @return [Process::Status] Status of the executed command
     def run
       inject_xtrace_flag!
 
       @xtrace = Xtrace.new
       fd = @xtrace.file_descriptor
-      @command = "BASH_XTRACEFD=#{fd} PS4='#{Xtrace.ps4}' #{@command}"
+      @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
 
-      pid = Process.spawn @command, options
-      Process.wait pid
+      command_pid = Process.spawn @command, options # spawn the command
+      xtrace_thread = Thread.new { @xtrace.read } # start processing the xtrace output
+
+      Process.wait command_pid
+      @xtrace.close
+
+      @coverage = xtrace_thread.value # wait for the thread to return
 
       $?
     end
 
     # @return [Hash] Coverage hash of the last run
+    # @note The result is memoized.
     def result
-      files = if Bashcov.options.skip_uncovered
-        {}
-      else
-        find_bash_files "#{Bashcov.root_directory}/**/*.sh"
+      @result ||= begin
+        find_bash_files!
+        expunge_invalid_files!
+        mark_relevant_lines!
+
+        @coverage
       end
+    end
 
-      files = add_coverage_result files
-      files = ignore_irrelevant_lines files
+  private
+
+    # @note +SHELLOPTS+ must be exported so we use Ruby's {ENV} variable
+    # @return [void]
+    def inject_xtrace_flag!
+      existing_flags = (ENV['SHELLOPTS'] || '').split(':')
+      ENV['SHELLOPTS'] = (existing_flags | ['xtrace']).join(':')
     end
 
-    # @param [String] directory Directory to scan
-    # @return [Hash] Coverage hash of Bash files in the given +directory+. All
-    #   files are marked as uncovered.
-    def find_bash_files directory
-      Dir[directory].inject({}) do |files, file|
-        absolute_path = File.expand_path(file)
-        next unless File.file?(absolute_path)
+    # Add files which have not been executed at all (i.e. with no coverage)
+    # @return [void]
+    def find_bash_files!
+      return if Bashcov.options.skip_uncovered
 
-        files.merge!(absolute_path => Bashcov.coverage_array(absolute_path))
+      Dir["#{Bashcov.root_directory}/**/*.sh"].each do |file|
+        @coverage[file] ||= [] # empty coverage array
       end
     end
 
-    # @param [Hash] files Initial coverage hash
-    # @return [Hash] Given hash including coverage result from {Xtrace}
-    # @see Xtrace
-    def add_coverage_result files
-      @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
+    # @return [void]
+    def expunge_invalid_files!
+      @coverage.each_key do |file|
+        unless File.file? file
+          @coverage.delete file
+          warn "Warning: #{file} was executed but has been deleted since then - it won't be reported in coverage."
         end
       end
-
-      files
     end
 
-    # @param [Hash] files Initial coverage hash
-    # @return [Hash] Given hash ignoring irrelevant lines
     # @see Lexer
-    def ignore_irrelevant_lines files
-      files.each do |filename, lines|
-        lexer = Lexer.new(filename)
-        lexer.irrelevant_lines.each do |lineno|
-          files[filename][lineno] = Bashcov::Line::IGNORED
+    # @return [void]
+    def mark_relevant_lines!
+      @coverage.each do |filename, coverage|
+        lexer = Lexer.new(filename, coverage)
+        lexer.uncovered_relevant_lines do |lineno|
+          @coverage[filename][lineno] = Bashcov::Line::UNCOVERED
         end
       end
     end
-
-  private
-
-    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,4 +1,4 @@
 module Bashcov
-  # Bashcov version
-  VERSION = "0.0.9"
+  # [String] Bashcov version
+  VERSION = '1.0.0'
 end

data/lib/bashcov/xtrace.rb

@@ -1,70 +1,61 @@
-require 'tempfile'
-
 module Bashcov
   # This class manages +xtrace+ output.
   #
   # @see Runner
   class Xtrace
-    # Creates a temporary file for xtrace output
+    # Prefix used for PS4.
+    # @note The first caracter ('+') will be repeated to indicate the nesting
+    #   level.
+    PREFIX = '+BASHCOV> '
+
+    # [String] +PS4+ variable used for xtrace output
+    # @see http://www.gnu.org/software/bash/manual/bashref.html#index-PS4
+    # @see http://stackoverflow.com/questions/59895/can-a-bash-script-tell-what-directory-its-stored-in
+    # @note We use a forward slash as delimiter since it's the only forbidden
+    #   character in filenames on Unix and Windows.
+    PS4 = %Q{#{PREFIX}${BASH_SOURCE[0]}/${LINENO}: }
+
+    # Regexp to match xtrace elements.
+    LINE_REGEXP = /\A#{Regexp.escape(PREFIX[0])}+#{PREFIX[1..-1]}(?<filename>.+)\/(?<lineno>\d+): /
+
+    # @return [Hash] Coverage of executed files
+    attr_reader :coverage
+
+    # Creates a temporary file for xtrace output.
+    # @see http://stackoverflow.com/questions/6977561/pipe-vs-temporary-file
     def initialize
-      @xtrace_file = Tempfile.new 'xtrace_output'
-      @xtrace_file.unlink # unlink on create so other programs cannot access it
+      @read, @write = IO.pipe
     end
 
-    # @return [Fixnum] File descriptor of the output file
+    # @return [Fixnum] File descriptor of the write end of the pipe
     def file_descriptor
-      @xtrace_file.fileno
+      @write.fileno
+    end
+
+    # Closes the pipe for writing.
+    # @return [void]
+    def close
+      @write.close
     end
 
-    # Parses xtrace output and computes coverage
+    # Parses xtrace output and computes coverage.
     # @return [Hash] Hash of executed files with coverage information
-    def files
-      files = {}
+    def read
+      @files = {}
 
-      @xtrace_file.rewind
-      @xtrace_file.read.each_line do |line|
-        match = line.match(self.class.line_regexp)
-        next if match.nil? # multiline instruction
+      @read.each_line do |line|
+        match = line.match(LINE_REGEXP)
+        next if match.nil? # garbage line from multiline instruction
 
         filename = File.expand_path(match[:filename], Bashcov.root_directory)
-        next if File.directory? filename
-        unless File.file? filename
-          warn "Warning: #{filename} was executed but has been deleted since then - skipping it."
-          next
-        end
 
         lineno = match[:lineno].to_i - 1
-        files[filename] ||= Bashcov.coverage_array(filename)
-        files[filename][lineno] += 1
+        @files[filename] ||= []
+        @files[filename][lineno] ||= 0
+        @files[filename][lineno] += 1
       end
 
-      files
-    end
-
-    # @see http://www.gnu.org/software/bash/manual/bashref.html#index-PS4
-    # @return [String] +PS4+ variable used for xtrace output
-    def self.ps4
-      # We use a forward slash as delimiter since it's the only forbidden
-      # 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: }
-    end
-
-  private
-
-    def self.prefix
-      # Note that the first caracter (+) will be repeated to indicate the
-      # nesting level (see depth_character).
-      '+BASHCOV> '
-    end
-
-    def self.depth_character
-      Regexp.escape(prefix[0])
-    end
-
-    def self.line_regexp
-      /\A#{depth_character}+#{prefix[1..-1]}(?<filename>.+)\/(?<lineno>\d+) BASHCOV: /
+      @files
     end
   end
 end

data/spec/bashcov/lexer_spec.rb

@@ -1,34 +1,12 @@
 require 'spec_helper'
 
-shared_examples "a bash file" do
-  describe "#irrelevant_lines" do
-    it "returns irrelevant lines" do
-      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
   describe "#initialize" do
     it "raises if the file is invalid" do
       expect {
-        Bashcov::Lexer.new 'inexistent_file.exe'
+        Bashcov::Lexer.new 'inexistent_file.exe', nil
       }.to raise_error ArgumentError
     end
   end
-
-  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

@@ -1,14 +1,41 @@
 require 'spec_helper'
+require 'benchmark'
 
 describe Bashcov::Runner do
   let(:runner) { Bashcov::Runner.new test_suite }
-  let(:bash_files_glob) { "#{Bashcov.root_directory}/**/*.sh" }
+
+  before do
+    # 'Bashcov.options.command' is normally set through 'Bashcov.parse_options!'
+    # so we need to stub it
+    Bashcov.options.stub(:command).and_return(test_suite)
+  end
 
   describe "#run" do
     it "finds commands in $PATH" do
       Bashcov::Runner.new('ls -l').run.should be_success
     end
 
+    it "is fast", speed: :slow do
+      ratio = 0
+
+      3.times do |iteration|
+        t0 = Benchmark.realtime {
+          pid = Process.spawn test_suite, out: '/dev/null', err: '/dev/null'
+          Process.wait pid
+        }
+        $?.should be_success
+
+        run = nil
+        t1 = Benchmark.realtime { run = Bashcov::Runner.new(test_suite).run }
+        run.should be_success
+
+        ratio = (ratio * iteration + t1 / t0) / (iteration + 1)
+      end
+
+      puts "#{ratio} times longer with Bashcov"
+      # XXX no proper assertion - just outputs the ratio
+    end
+
     context "without a SHELLOPTS variable" do
       before do
         ENV['SHELLOPTS'] = nil
@@ -32,54 +59,18 @@ describe Bashcov::Runner do
     end
   end
 
-  describe "#find_bash_files" do
-    let(:files) { runner.find_bash_files bash_files_glob }
-    subject { files }
-
-    it { should be_a Hash }
-
-    it "contains bash files" do
-      subject.keys.should =~ bash_files
-    end
-
-    it "marks files as uncovered" do
-      subject.values.each do |lines|
-        lines.each { |line| line.should == Bashcov::Line::UNCOVERED }
-      end
-    end
-  end
-
-  describe "#add_coverage_result" do
-    let(:files) {
+  describe "#result" do
+    it "returns the expected coverage hash" do
       runner.run
-      files = runner.find_bash_files bash_files_glob
-      runner.add_coverage_result files
-    }
-    subject { files }
-
-    it { should be_a Hash }
-
-    it "contains all files" do
-      subject.keys.should =~ bash_files | executed_files
+      runner.result.should eq expected_coverage
     end
 
-    it "adds correct coverage results" do
-      subject.each do |file, lines|
-        lines.each_with_index do |line, lineno|
-          [
-            Bashcov::Line::UNCOVERED,
-            expected_coverage[file][lineno]
-          ].should include line
-        end
-      end
-    end
-  end
-
-  describe "#result" do
-    it "returns a valid coverage hash" do
+    it "returns the correct coverage hash" do
       runner.run
 
-      runner.result.should == expected_coverage
+      pending "need a context-aware lexer to parse multiline instructions" do
+        runner.result.should eq correct_coverage
+      end
     end
 
     context "with options.skip_uncovered = true" do

data/spec/spec_helper.rb

@@ -9,7 +9,7 @@ end
 
 require 'bashcov'
 
-Dir["./spec/support/**/*.rb"].each { |file| require file }
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |file| require file }
 
 RSpec.configure do |config|
   config.before(:each) do

data/spec/support/test_app.rb

@@ -2,10 +2,6 @@ def test_app
   File.expand_path("../../test_app", __FILE__)
 end
 
-def scripts
-  "#{test_app}/scripts"
-end
-
 def test_suite
   "#{test_app}/test_suite.sh"
 end
@@ -14,33 +10,28 @@ def uncovered_files
   ["#{test_app}/never_called.sh"]
 end
 
-def executed_files
-  bash_files - uncovered_files + ["#{scripts}/sourced.txt", "#{scripts}/executable"]
-end
-
-def bash_files
-  files_in("#{test_app}/**/*.sh")
-end
-
-def files_in directory
-  Dir[directory].select { |file| File.file? file }
-end
-
 def expected_coverage
   {
-    "#{test_app}/never_called.sh" => [nil, nil, 0, nil],
-    "#{test_app}/scripts/case.sh" => [nil, nil, nil, 6, 1, nil, 0, 0, 1, nil, nil, nil, 1, 1, nil],
+    "#{test_app}/never_called.sh" => [nil, nil, 0],
+    "#{test_app}/scripts/case.sh" => [nil, nil, nil, 2, 1, nil, 0, 0, 1, nil, nil, nil, 1, 1],
     "#{test_app}/scripts/delete.sh" => [nil, nil, 1, nil, 0, 0, nil, 1, 1],
-    "#{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/function.sh" => [nil, nil, nil, 2, nil, nil, nil, 1, 1, nil, nil, nil, nil, 1, nil, nil, 1, 1, 1],
+    "#{test_app}/scripts/long_line.sh" => [nil, nil, 1, 1, 1, 0],
+    "#{test_app}/scripts/nested/simple.sh" => [nil, nil, nil, nil, 1, 1, nil, 0, nil, nil, 1],
+    "#{test_app}/scripts/one_liner.sh" => [nil, nil, 2, nil, 1, nil, 0],
+    "#{test_app}/scripts/simple.sh" => [nil, nil, nil, nil, 1, 1, nil, 0, nil, nil, 1],
+    "#{test_app}/scripts/source.sh" => [nil, nil, 1, nil, 2],
+    "#{test_app}/scripts/sourced.txt" => [nil, nil, 1],
+    "#{test_app}/scripts/unicode.sh" => [nil, nil, nil, 1],
     "#{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, 1, nil]
+    "#{test_app}/scripts/executable" => [nil, nil, 1],
+    "#{test_app}/test_suite.sh" => [nil, nil, 2, nil, 1]
   }
 end
 
+def correct_coverage
+  expected_coverage.merge!({
+    "#{test_app}/scripts/multiline.sh" => [nil, nil, 1, 2, 1, 1, 0, nil, nil, 1, 1, 1]
+  })
+end
+

data/spec/test_app/scripts/function.sh

@@ -9,6 +9,12 @@ f2() {
     echo f2
 }
 
+__a_bc()
+{
+    echo __a_bc
+}
+
 f1
 f2
+__a_bc
 

data/spec/test_app/scripts/unicode.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+# ¹²³
+echo 'I am full of unicode characters! äéíóúü¿æ'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bashcov
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Cédric Félizard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-05 00:00:00.000000000 Z
+date: 2013-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +119,8 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -153,6 +155,7 @@ files:
 - spec/test_app/scripts/simple.sh
 - spec/test_app/scripts/source.sh
 - spec/test_app/scripts/sourced.txt
+- spec/test_app/scripts/unicode.sh
 - spec/test_app/test_suite.sh
 homepage: https://github.com/infertux/bashcov
 licenses:
@@ -200,5 +203,6 @@ test_files:
 - spec/test_app/scripts/simple.sh
 - spec/test_app/scripts/source.sh
 - spec/test_app/scripts/sourced.txt
+- spec/test_app/scripts/unicode.sh
 - spec/test_app/test_suite.sh
 has_rdoc: