bashcov 0.0.1 → 0.0.2

data/.gitignore

@@ -4,6 +4,7 @@
 .bundle
 .config
 .yardoc
+.rbx/
 Gemfile.lock
 InstalledFiles
 _yardoc

data/Guardfile

@@ -0,0 +1,10 @@
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 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" }
+  watch('spec/spec_helper.rb')     { "spec" }
+  watch(%r{^spec/support/.+\.rb$}) { "spec" }
+end
+

data/README.md

@@ -2,6 +2,8 @@
 
 [bashcov] is [simplecov] for Bash.
 
+**[Demo](http://infertux.github.com/bashcov/test_app/)**
+
 ## Installation
 
 `$ gem install bashcov`
@@ -12,8 +14,6 @@
 
 This will create a directory named `coverage/` containing HTML files.
 
-Example output: [demo](http://infertux.github.com/bashcov/test_app/)
-
 ## Rationale
 
 I'm a big fan of both Ruby's _simplecov_ and Bash.

data/bashcov.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'rb-inotify'
 end

data/lib/bashcov/lexer.rb

@@ -2,6 +2,7 @@ module Bashcov
   class Lexer
     def initialize filename
       @filename = File.expand_path(filename)
+      raise "#{@filename} is not a file" unless File.file?(@filename)
     end
 
     def irrelevant_lines
@@ -18,7 +19,7 @@ module Bashcov
       line.strip!
       return true if line.empty?
       return true if start_with.any? { |token| line.start_with? token }
-      return true if is.any? { |keyword| line =~ /\A#{keyword}\Z/ }
+      return true if is.any? { |keyword| line == keyword }
       return true if line =~ /\A\w+\(\) {/ # function declared like this: "foo() {"
       false
     end
@@ -28,7 +29,7 @@ module Bashcov
       %w(esac fi then do done else { })
     end
 
-    # Lines starting with one of these keywords are irrelevant for coverage
+    # Lines starting with one of these tokens are irrelevant for coverage
     def start_with
       %w(# function)
     end

data/lib/bashcov/line.rb

@@ -1,5 +1,7 @@
 module Bashcov
   module Line
+    # see http://www.ruby-doc.org/stdlib-1.9.3/libdoc/coverage/rdoc/Coverage.html
+
     UNCOVERED = 0
     IGNORED = nil
   end

data/lib/bashcov/runner.rb

@@ -9,50 +9,71 @@ module Bashcov
     end
 
     def run
-      # SHELLOPTS must be exported so we use Ruby's ENV variable
-      ENV['SHELLOPTS'] = 'braceexpand:hashall:interactive-comments:posix:verbose:xtrace'
+      inject_shellopts_flags
 
-      command = "PS4='#{Xtrace.ps4}' #{@filename}"
-      _, _, @output = Open3.popen3(command)
+      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
     end
 
     def result
-      # 1. Grab all bash files in project root and mark them uncovered
-      @files = find_bash_files
+      files = find_bash_files "#{Bashcov.root_directory}/**/*.sh"
+      files = add_coverage_result files
+      files = ignore_irrelevant_lines files
+    end
+
+    def find_bash_files directory
+      files = {}
+
+      # grab all bash files in project root and mark them uncovered
+      (Dir[directory] - [@filename]).each do |file|
+        absolute_path = File.expand_path(file)
+        next unless File.file?(absolute_path)
 
-      # 2. Add coverage information from run
+        files[absolute_path] = Bashcov.coverage_array(absolute_path)
+      end
+
+      files
+    end
+
+    def add_coverage_result files
       xtraced_files = Xtrace.new(@output).files
+      xtraced_files.delete @filename # drop the test suite file
+
       xtraced_files.each do |file, lines|
-        next if file == @filename
-        lines.each_with_index do |line, index|
-          @files[file] ||= Bashcov.coverage_array(file) # non .sh files but executed though
-          @files[file][index] = line if line
+        lines.each_with_index do |line, lineno|
+          files[file] ||= Bashcov.coverage_array(file) # non .sh files but executed though
+          files[file][lineno] = line if line
         end
       end
 
-      # 3. Ignore irrelevant lines
-      @files.each do |filename, lines|
-        warn filename unless File.file?(filename)
-        next unless File.file?(filename)
+      files
+    end
+
+    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
+          files[filename][lineno] = Bashcov::Line::IGNORED
         end
       end
     end
 
-    def find_bash_files
-      files = {}
-
-      (Dir["#{Bashcov.root_directory}/**/*.sh"] - [@filename]).each do |file|
-        absolute_path = File.expand_path(file)
-        next unless File.file?(absolute_path)
+  private
 
-        files[absolute_path] = Bashcov.coverage_array(absolute_path)
-      end
+    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
 
-      files
+    def shellopts_flags
+      %w(verbose xtrace)
     end
 
+    def shellopts_separator
+      ':'
+    end
   end
 end

data/lib/bashcov/version.rb

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

data/lib/bashcov/xtrace.rb

@@ -11,7 +11,8 @@ module Bashcov
         next unless match = line.match(Xtrace.line_regexp)
 
         filename = File.expand_path(match[:filename], Bashcov.root_directory)
-        next unless File.file? filename
+        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

data/lib/bashcov.rb

@@ -16,7 +16,7 @@ module Bashcov
     end
 
     def link
-      '<a href="https://github.com/infertux/bashcov">bashcov</a>'
+      %Q|<a href="https://github.com/infertux/bashcov">bashcov</a> v#{VERSION}|
     end
   end
 end

data/spec/bashcov/lexer_spec.rb

@@ -1,20 +1,28 @@
 require 'spec_helper'
 
-describe Bashcov::Lexer do
+shared_examples "a bash file" do
   describe "#irrelevant_lines" do
-    [
-      ['simple.sh', [0, 1, 2, 3, 6, 8, 9, 11, 12]],
-      ['function.sh', [0, 1, 2, 4, 5, 6, 9, 10, 13]],
-      ['sourced.txt', [0, 1, 3]]
-
-    ].each do |filename, lines|
-      context "for #{filename}" do
-        it "returns irrelevant lines" do
-          lexer = Bashcov::Lexer.new File.join(scripts, filename)
-          lexer.irrelevant_lines.should =~ lines
-        end
-      end
+    it "returns irrelevant lines" do
+      lexer = Bashcov::Lexer.new File.join(scripts, 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] }
+  end
+end
+

data/spec/bashcov/runner_spec.rb

@@ -1,27 +1,81 @@
 require 'spec_helper'
 
 describe Bashcov::Runner do
-  before do
-    @runner ||= Bashcov::Runner.new test_suite
+  let(:runner) { Bashcov::Runner.new test_suite }
+  let(:bash_files_glob) { "#{Bashcov.root_directory}/**/*.sh" }
+
+  describe "#run" do
+    context "without a SHELLOPTS variable" do
+      before do
+        ENV['SHELLOPTS'] = nil
+      end
+
+      it "adds the flags" do
+        runner.run
+        ENV['SHELLOPTS'].should == 'verbose:xtrace'
+      end
+    end
+
+    context "with an existing SHELLOPTS variable" do
+      before do
+        ENV['SHELLOPTS'] = 'posix:verbose'
+      end
+
+      it "merges the flags" do
+        runner.run
+        ENV['SHELLOPTS'].should == 'posix:verbose:xtrace'
+      end
+    end
   end
 
   describe "#find_bash_files" do
-    it "returns the list of .sh files in the root directory" do
-      files = @runner.find_bash_files
-      files.class.should == Hash
-      files.values.each do |lines|
+    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) {
+      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 =~ all_files
+    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 hash" do
-      @runner.run
-      result = @runner.result
+    it "returns a valid coverage hash" do
+      runner.run
 
-      result.class.should == Hash
-      result.size.should == 8 # FIXME
+      runner.result.should == expected_coverage
     end
   end
 end

data/spec/bashcov/xtrace_spec.rb

@@ -1,18 +1,20 @@
 require 'spec_helper'
 
 describe Bashcov::Xtrace do
-  before do
-    @runner ||= Bashcov::Runner.new test_suite
-    @runner.run
-
-    @xtrace ||= Bashcov::Xtrace.new @runner.output
-  end
+  let(:xtrace) {
+    runner = Bashcov::Runner.new test_suite
+    runner.run
+    Bashcov::Xtrace.new runner.output
+  }
 
   describe "#files" do
-    it "returns a list of executed files" do
-      files = @xtrace.files
-      files.class.should == Hash
-      files.keys.should =~ executed_files + [test_suite]
+    let(:files) { xtrace.files }
+    subject { files }
+
+    it { should be_a Hash }
+
+    it "contains expected files" do
+      subject.keys.should =~ executed_files | [test_suite]
     end
   end
 end

data/spec/bashcov_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Bashcov do
+  describe ".link" do
+    it "includes the version" do
+      Bashcov.link.should include Bashcov::VERSION
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 unless RUBY_ENGINE == 'rbx' # coverage support is broken on rbx
   require 'simplecov'
   SimpleCov.start do
-    minimum_coverage 98
+    minimum_coverage 100
     add_group "Sources", "lib"
     add_group "Tests", "spec"
   end
@@ -9,19 +9,5 @@ end
 
 require 'bashcov'
 
-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
-
-def executed_files
-  Dir["#{scripts}/**/*"].select { |file| File.file? file }
-end
+Dir["./spec/support/**/*.rb"].each { |file| require file }
 

data/spec/support/test_app.rb

@@ -0,0 +1,41 @@
+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
+
+def executed_files
+  files_in("#{scripts}/**/*")
+end
+
+def bash_files
+  files_in("#{test_app}/**/*.sh") - [test_suite]
+end
+
+def all_files
+  files_in("#{test_app}/**/*") - [test_suite]
+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/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]
+  }
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bashcov
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-08 00:00:00.000000000 Z
+date: 2012-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -59,6 +59,38 @@ dependencies:
     - - ! '>='
       - !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'
 description: Code coverage tool for Bash
 email:
 - cedric@felizard.fr
@@ -71,6 +103,7 @@ files:
 - .rspec
 - .travis.yml
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -86,7 +119,9 @@ 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/test_app.rb
 - spec/test_app/.simplecov
 - spec/test_app/never_called.sh
 - spec/test_app/scripts/function.sh
@@ -125,7 +160,9 @@ 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/test_app.rb
 - spec/test_app/.simplecov
 - spec/test_app/never_called.sh
 - spec/test_app/scripts/function.sh