bashcov 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac9d65de9da45a8b6f30348d6f4b66c111ea5e4c
-  data.tar.gz: 16238fa1596b3f2e744509427b133bc97448307b
+  metadata.gz: 4e4f73a217009bf88f987dba5058c178ae1c9971
+  data.tar.gz: 2877c76c643179f05f0a453df690e11879f273b2
 SHA512:
-  metadata.gz: 89908a21eabba58ec5a03f48005d9953e3ab9e06fff4ca6c34a1a5ada7631f7e053032ea21ebe52c20c77ca1c197b174eb1fe0bc4ffddd7e9593d75193bf04c8
-  data.tar.gz: b8d8d6891ea6ecf039f3e3b06fab85f9224e10af4b91982d845bd49dc326f95063d5bd08a25d2e4ac77e39c17e48c115501cdda47817e2c806dd2d2c93330e16
+  metadata.gz: 77cd74423bb960f8afb99fa4ce7fd36f9c7751ae352dc23f88a1de077a07a9de29fbaa0dae1a5500d673f271c33bc3e10481642dbde24e7e174a3f967cfe14d4
+  data.tar.gz: ea991103cb285f83f74931c5a7ed1c867a72e86e4c6a8f16ec92506017e4053bd9666e4c12e9234d2b24ab5f1c0e43dee3c9d477223378d76299b6b41efc58cd

data/.rubocop.yml

@@ -0,0 +1,24 @@
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+  Exclude: [spec/**/*]
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -8,11 +8,13 @@ rvm:
   - 2.1
   - 2.2
   - ruby-head
-  - rbx-19mode
+  - rbx
+  - rbx-head
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: rbx-19mode
+    - rvm: rbx
+    - rvm: rbx-head
 notifications:
   email:
     on_success: always

data/CHANGELOG.md

@@ -1,7 +1,13 @@
-## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v1.1.0...master))
+## Unreleased ([changes](https://github.com/infertux/bashcov/compare/v1.2.0...master))
 
   * TBD
 
+## v1.2.0, 2015-05-04 ([changes](https://github.com/infertux/bashcov/compare/v1.1.0...v1.2.0))
+
+  * [FEATURE] Enforce coherent coding style with Rubocop
+  * [FEATURE] Upgrade dependencies (#11)
+  * [FEATURE] Improve OS X compatibility (#10)
+
 ## v1.1.0, 2015-02-20 ([changes](https://github.com/infertux/bashcov/compare/v1.0.1...v1.1.0))
 
   * [FEATURE] Upgrade dependencies

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # gem 'simplecov', path: '../simplecov'
 

data/Guardfile

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

data/Rakefile

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

data/bashcov.gemspec

@@ -1,30 +1,31 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'bashcov/version'
+require "bashcov/version"
 
 Gem::Specification.new do |gem|
   gem.name          = "bashcov"
   gem.version       = Bashcov::VERSION
   gem.authors       = ["Cédric Félizard"]
   gem.email         = ["cedric@felizard.fr"]
-  gem.description   = %q{Code coverage tool for Bash}
+  gem.description   = "Code coverage tool for Bash"
   gem.summary       = gem.description
   gem.homepage      = "https://github.com/infertux/bashcov"
-  gem.license       = 'MIT'
+  gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'simplecov', '~> 0.9.1'
+  gem.add_dependency "simplecov", "~> 0.10.0"
 
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec', '~> 3'
-  gem.add_development_dependency 'guard-rspec'
-  gem.add_development_dependency 'rb-inotify'
-  gem.add_development_dependency 'cane'
-  gem.add_development_dependency 'yard'
-  gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 3"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "rb-inotify"
+  gem.add_development_dependency "cane"
+  gem.add_development_dependency "rubocop"
+  gem.add_development_dependency "yard"
+  gem.add_development_dependency "coveralls"
 end

data/bin/bashcov

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 
-lib = File.expand_path('../../lib', __FILE__)
+lib = File.expand_path("../../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'bashcov'
+require "bashcov"
 
 Bashcov.parse_options! ARGV
 
@@ -11,9 +11,8 @@ runner = Bashcov::Runner.new Bashcov.options.command
 runner.run
 coverage = runner.result
 
-require 'simplecov'
+require "simplecov"
 
 SimpleCov.command_name Bashcov.name
 SimpleCov.root Bashcov.root_directory
 SimpleCov::Result.new(coverage).format!
-

data/lib/bashcov/lexer.rb

@@ -3,24 +3,22 @@ module Bashcov
   # coverage
   class Lexer
     # Lines starting with one of these tokens are irrelevant for coverage
-    IGNORE_START_WITH = %w|# function|
+    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 else elif fi while do done { } ;;|
+    IGNORE_IS = %w(esac if then else elif fi while do done { } ;;)
 
     # @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, coverage
+    def initialize(filename, coverage)
       @filename = File.expand_path(filename)
       @coverage = coverage
 
-      unless File.file?(@filename)
-        raise ArgumentError, "#{@filename} is not a file"
-      end
+      raise ArgumentError, "#{@filename} is not a file" unless File.file?(@filename)
     end
 
     # Yields uncovered relevant lines.
@@ -28,24 +26,24 @@ module Bashcov
     # @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
+      File.open(@filename, "rb").each_line do |line|
+        if @coverage[lineno] == Bashcov::Line::IGNORED && revelant?(line)
           yield lineno
         end
-        lineno +=1
+        lineno += 1
       end
     end
 
   private
 
-    def is_revelant? line
+    def revelant?(line)
       line.strip!
 
       !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
+        !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/runner.rb

@@ -2,7 +2,7 @@ module Bashcov
   # Runs a given command with xtrace enabled then computes code coverage.
   class Runner
     # @param [String] command Command to run
-    def initialize command
+    def initialize(command)
       @command = command
     end
 
@@ -15,8 +15,8 @@ module Bashcov
       @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
+      options = { :in => :in, fd => fd } # bind fds to the child process
+      options.merge!(out: "/dev/null", err: "/dev/null") if Bashcov.options.mute
 
       command_pid = Process.spawn @command, options # spawn the command
       xtrace_thread = Thread.new { @xtrace.read } # start processing the xtrace output
@@ -46,8 +46,8 @@ module Bashcov
     # @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(':')
+      existing_flags = (ENV["SHELLOPTS"] || "").split(":")
+      ENV["SHELLOPTS"] = (existing_flags | ["xtrace"]).join(":")
     end
 
     # Add files which have not been executed at all (i.e. with no coverage)
@@ -63,10 +63,10 @@ module Bashcov
     # @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
+        next if 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
 
@@ -82,4 +82,3 @@ module Bashcov
     end
   end
 end
-

data/lib/bashcov/version.rb

@@ -1,4 +1,4 @@
+# :nodoc:
 module Bashcov
-  # [String] Bashcov version
-  VERSION = '1.1.0'
+  VERSION = "1.2.0".freeze
 end

data/lib/bashcov/xtrace.rb

@@ -6,17 +6,19 @@ module Bashcov
     # Prefix used for PS4.
     # @note The first caracter ('+') will be repeated to indicate the nesting
     #   level.
-    PREFIX = '+BASHCOV> '
+    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}: }
+    GET_ABS_DIR = "$(cd $(dirname ${BASH_SOURCE[0]}); pwd)"
+    GET_BASE = "$(basename ${BASH_SOURCE[0]})"
+    PS4 = %(#{PREFIX}#{GET_ABS_DIR}/#{GET_BASE}/${LINENO}: )
 
     # Regexp to match xtrace elements.
-    LINE_REGEXP = /\A#{Regexp.escape(PREFIX[0])}+#{PREFIX[1..-1]}(?<filename>.+)\/(?<lineno>\d+): /
+    LINE_REGEXP = %r{\A#{Regexp.escape(PREFIX[0])}+#{PREFIX[1..-1]}(?<filename>.+)\/(?<lineno>\d+): }
 
     # @return [Hash] Coverage of executed files
     attr_reader :coverage
@@ -59,4 +61,3 @@ module Bashcov
     end
   end
 end
-

data/lib/bashcov.rb

@@ -1,16 +1,15 @@
-require 'optparse'
-require 'ostruct'
-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"
 
 # Bashcov default module
 # @note Keep it short!
 module Bashcov
   class << self
-
     # @return [OpenStruct] Bashcov settings
     attr_reader :options
 
@@ -31,13 +30,13 @@ module Bashcov
     # @param [Array] args list of arguments
     # @raise [SystemExit] if invalid arguments are given
     # @return [void]
-    def parse_options! args
+    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(' ')
+        @options.command = args.join(" ")
       end
     end
 
@@ -48,8 +47,8 @@ module Bashcov
 
   private
 
-    def help program_name
-      <<-HELP.gsub!(/^ +/, '').gsub!("\t", ' ' * 4)
+    def help(program_name)
+      <<-HELP.gsub!(/^ +/, "").gsub!("\t", " " * 4)
         Usage: #{program_name} [options] [--] <command> [options]
         Examples:
         \t#{program_name} ./script.sh
@@ -61,7 +60,7 @@ module Bashcov
 
     def option_parser
       OptionParser.new do |opts|
-        opts.program_name = 'bashcov'
+        opts.program_name = "bashcov"
         opts.version = Bashcov::VERSION
         opts.banner = help opts.program_name
 
@@ -90,4 +89,3 @@ end
 
 # Make sure default options are set
 Bashcov.set_default_options!
-

data/spec/bashcov/lexer_spec.rb

@@ -1,12 +1,11 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Bashcov::Lexer do
   describe "#initialize" do
     it "raises if the file is invalid" do
-      expect {
-        Bashcov::Lexer.new 'inexistent_file.exe', nil
-      }.to raise_error ArgumentError
+      expect do
+        Bashcov::Lexer.new "inexistent_file.exe", nil
+      end.to raise_error ArgumentError
     end
   end
 end
-

data/spec/bashcov/runner_spec.rb

@@ -1,8 +1,8 @@
-require 'spec_helper'
-require 'benchmark'
+require "spec_helper"
+require "benchmark"
 
 describe Bashcov::Runner do
-  let(:runner) { Bashcov::Runner.new test_suite }
+  let(:runner) { Bashcov::Runner.new "bash #{test_suite}" }
 
   before :all do
     Dir.chdir File.dirname(test_suite)
@@ -10,17 +10,17 @@ describe Bashcov::Runner do
 
   describe "#run" do
     it "finds commands in $PATH" do
-      expect(Bashcov::Runner.new('ls -l').run).to be_success
+      expect(Bashcov::Runner.new("ls -l").run).to 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'
+        t0 = Benchmark.realtime do
+          pid = Process.spawn test_suite, out: "/dev/null", err: "/dev/null"
           Process.wait pid
-        }
+        end
         expect($?).to be_success
 
         run = nil
@@ -36,23 +36,23 @@ describe Bashcov::Runner do
 
     context "without a SHELLOPTS variable" do
       before do
-        ENV['SHELLOPTS'] = nil
+        ENV["SHELLOPTS"] = nil
       end
 
       it "adds the flags" do
         runner.run
-        expect(ENV['SHELLOPTS']).to eq('xtrace')
+        expect(ENV["SHELLOPTS"]).to eq("xtrace")
       end
     end
 
     context "with an existing SHELLOPTS variable" do
       before do
-        ENV['SHELLOPTS'] = 'posix'
+        ENV["SHELLOPTS"] = "posix"
       end
 
       it "merges the flags" do
         runner.run
-        expect(ENV['SHELLOPTS']).to eq('posix:xtrace')
+        expect(ENV["SHELLOPTS"]).to eq("posix:xtrace")
       end
     end
   end
@@ -96,4 +96,3 @@ describe Bashcov::Runner do
     end
   end
 end
-

data/spec/bashcov_spec.rb

@@ -1,9 +1,9 @@
-require 'spec_helper'
+require "spec_helper"
 
 shared_examples "a fatal error" do
   it "outputs to stderr" do
     expect($stderr).to receive(:write).at_least(:once)
-    ignore_exception { subject }
+    ignore_exception(SystemExit) { subject }
   end
 
   it "exits with non-zero" do
@@ -25,10 +25,10 @@ describe Bashcov do
     end
 
     context "with a filename" do
-      before { @args << 'script.sh' }
+      before { @args << "script.sh" }
 
       context "with the --skip-uncovered flag" do
-        before { @args << '--skip-uncovered' }
+        before { @args << "--skip-uncovered" }
 
         it "sets it properly" do
           subject
@@ -37,7 +37,7 @@ describe Bashcov do
       end
 
       context "with the --mute flag" do
-        before { @args << '--mute' }
+        before { @args << "--mute" }
 
         it "sets it properly" do
           subject
@@ -46,17 +46,17 @@ describe Bashcov do
       end
 
       context "with the --help flag" do
-        before { @args << '--help' }
+        before { @args << "--help" }
 
         it_behaves_like "a fatal error"
       end
 
       context "with the --version flag" do
-        before { @args << '--version' }
+        before { @args << "--version" }
 
         it "outputs to stdout" do
           expect($stdout).to receive(:write).at_least(:once)
-          ignore_exception { subject }
+          ignore_exception(SystemExit) { subject }
         end
 
         it "exits with zero" do
@@ -75,4 +75,3 @@ describe Bashcov do
     end
   end
 end
-

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
-unless RUBY_ENGINE == 'rbx' # coverage support is broken on rbx
-  require 'simplecov'
-  require 'coveralls'
+unless RUBY_ENGINE == "rbx" # coverage support is broken on rbx
+  require "simplecov"
+  require "coveralls"
 
   SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
     SimpleCov::Formatter::HTMLFormatter,
@@ -13,7 +13,7 @@ unless RUBY_ENGINE == 'rbx' # coverage support is broken on rbx
   end
 end
 
-require 'bashcov'
+require "bashcov"
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |file| require file }
 
@@ -23,4 +23,3 @@ RSpec.configure do |config|
     Bashcov.options.mute = true # don't print testsuite output
   end
 end
-

data/spec/support/common.rb

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

data/spec/support/test_app.rb

@@ -13,7 +13,7 @@ end
 def expected_coverage
   {
     "#{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/case.sh" => [nil, nil, nil, 6, 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, nil, nil, 1, nil, nil, 1, 1, 1],
     "#{test_app}/scripts/long_line.sh" => [nil, nil, 1, 1, 1, 0],
@@ -30,8 +30,5 @@ def expected_coverage
 end
 
 def correct_coverage
-  expected_coverage.merge!({
-    "#{test_app}/scripts/multiline.sh" => [nil, nil, 1, 2, 1, 1, 0, nil, nil, 1, 1, 1]
-  })
+  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/test_suite.sh

@@ -2,5 +2,4 @@
 
 cd $(dirname $0)
 
-find scripts -type f -executable -exec '{}' \;
-
+find scripts -type f -perm -111 -exec bash '{}' \;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashcov
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Cédric Félizard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-20 00:00:00.000000000 Z
+date: 2015-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +146,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -191,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Code coverage tool for Bash