simplecov 0.4.2 → 0.5.2

data/.gitignore

@@ -3,6 +3,7 @@ Gemfile.lock
 
 ## MAC OS
 .DS_Store
+.document
 
 ## TEXTMATE
 *.tmproj
@@ -20,8 +21,10 @@ tmtags
 coverage
 rdoc
 pkg
+tmp
+capybara*.html
 
 ## PROJECT::SPECIFIC
 
 .yardoc
-doc
+doc

data/.rvmrc

@@ -1 +1 @@
-rvm use 1.9.2
+rvm use 1.9.2

data/.travis.yml

@@ -0,0 +1,9 @@
+script: "bundle exec rake test && bundle exec cucumber features"
+rvm:
+#  - 1.8.6 # Has trouble with rake 0.9+ :(
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree
+  - rbx
+#  - jruby

data/CHANGELOG.md

@@ -0,0 +1,64 @@
+v0.5.2 (2011-09-12)
+===================
+
+  * Another fix for a bug in JSON processing introduced with MultiJSON in 0.5.1
+    (see https://github.com/colszowka/simplecov/pull/75, thanks @sferik)
+
+v0.5.1 (2011-09-12)
+===================
+**Note: Yanked 2011-09-12 because the MultiJSON-patch had a crucial bug**
+
+  * Fix for invalid gemspec dependency string (see https://github.com/colszowka/simplecov/pull/70,
+    http://blog.rubygems.org/2011/08/31/shaving-the-yaml-yacc.html, thanks @jspradlin)
+    
+  * Added JSON in the form of the multi_json gem as dependency for those cases when built-in JSON
+    is unavailable (see https://github.com/colszowka/simplecov/issues/72 
+    and https://github.com/colszowka/simplecov/pull/74, thanks @sferik)
+
+v0.5.0 (2011-09-09)
+===================
+**Note: Yanked 2011-09-09 because of trouble with the gemspec.**
+
+  * JSON is now used instead of YAML for resultset caching (used for merging). Should resolve
+    a lot of problems people used to have because of YAML parser errors.
+
+  * There's a new adapter 'test_frameworks'. Use it outside of Rails to remove `test/`,
+    `spec/`, `features/` and `autotest/` dirs from your coverage reports, either directly
+    with `SimpleCov.start 'test_frameworks'` or with `SimpleCov.load_adapter 'test_frameworks'`
+
+  * SimpleCov configuration can now be placed centrally in a text file `.simplecov`, which will
+    be automatically read on `require 'simplecov'`. This makes using custom configuration like
+    groups and filters across your test suites much easier as you only have to specify your config
+    once. Just put the whole `SimpleCov.start (...)` code into `APP_ROOT/.simplecov`
+
+  * Lines can now be skipped by using the :nocov: flag in comments that wrap the code that should be
+    skipped, like in this example (thanks @phillipkoebbe)
+
+    <pre>
+      #:nocov:
+      def skipped
+    	  @foo * 2
+      end
+      #:nocov:
+    </pre>
+
+  * Moved file set coverage analytics from simplecov-html to SimpleCov::FileList, a new subclass
+    of Array that is always returned for SourceFile lists (i.e. in groups) and can now be used
+    in all formatters without the need to roll your own.
+
+  * The exceptions you used to get after removing some code and re-running your tests because SimpleCov
+    couldn't find the cached source lines should be resolved (thanks @goneflyin)
+
+  * Coverage strength metric: Average hits/line per source file and result group (thanks @trans)
+
+  * Finally, SimpleCov has an extensive Cucumber test suite
+
+  * Full compatibility with Ruby 1.9.3.preview1
+
+HTML Formatter:
+---------------
+
+  * The display of source files has been improved a lot. Weird scrolling trouble, out-of-scope line hit counts
+    and such should be a thing of the past. Also, it is prettier now.
+  * Source files are now syntax highlighted
+  * File paths no longer have that annoying './' in front of them

data/Gemfile

@@ -1,2 +1,9 @@
 source "http://rubygems.org"
 gemspec
+
+# Use local copy of simplecov-html in development when checked out
+if File.directory?(File.dirname(__FILE__) + '/../simplecov-html')
+  gem 'simplecov-html', :path => File.dirname(__FILE__) + '/../simplecov-html'
+else
+  gem 'simplecov-html', :git => 'https://github.com/colszowka/simplecov-html'
+end

data/README.rdoc

@@ -1,8 +1,13 @@
-= SimpleCov
+= SimpleCov http://travis-ci.org/colszowka/simplecov.png
+
+* Source code: https://github.com/colszowka/simplecov
+* API documentation: http://rubydoc.info/gems/simplecov/frames
+* Changelog: https://github.com/colszowka/simplecov/blob/master/CHANGELOG.md
+* Rubygems: http://rubygems.org/gems/simplecov
 
 SimpleCov is a code coverage analysis tool for Ruby 1.9. It uses 1.9's built-in Coverage library to gather code
-coverage data, but makes processing it's results much easier by providing a clean API to filter, group, merge, format
-and display those results, thus giving you a complete code coverage suite that can be set up with just a couple lines of 
+coverage data, but makes processing its results much easier by providing a clean API to filter, group, merge, format
+and display those results, thus giving you a complete code coverage suite that can be set up with just a couple lines of
 code.
 
 In most cases, you'll want overall coverage results for your projects, including all types of tests, cucumber features
@@ -16,7 +21,7 @@ automatically when you launch SimpleCov. If you're curious, you can find it at h
 
 Update your Gemfile with this and do a bundle install:
 
-  gem 'simplecov', '>= 0.4.0', :require => false, :group => :test
+  gem 'simplecov', '>= 0.5.2', :require => false, :group => :test
 
 Then, add the following to your test/test_helper.rb (right at the top, line 00) or spec_helper.rb or cucumber env.rb or whatever
 test framework you prefer, really - just make sure simplecov is loaded and started BEFORE your app code is loaded:
@@ -48,7 +53,7 @@ Other test frameworks should work accordingly.
 
   require 'simplecov'
   SimpleCov.start 'rails'
-  
+
 You could even track what kind of code your UI testers are touching if you want to go overboard with things. SimpleCov does not
 care what kind of framework it is running in, it just looks at what code is being executed and generates a report about it.
 
@@ -59,7 +64,7 @@ Configuration settings can be applied in three formats.
 The 'direct' way:
 
   SimpleCov.some_config_option 'foo'
-  
+
 Using a block:
 
   SimpleCov.configure do
@@ -71,9 +76,25 @@ Using a block and automatically starting the coverage:
   SimpleCov.start do
     some_config_option 'foo'
   end
-  
+
 Most times, you'll want to use the latter, so loading and setting up simplecov is in one place at the top of your test helper.
 
+== Running coverage only on demand
+
+The Ruby STDLIB Coverage library that SimpleCov builds upon is *very* fast (i.e. on a ~10 min Rails test suite, the speed drop was
+only a couple seconds for me), and therefore it's SimpleCov's policy to just generate coverage every time you run your tests because
+it doesn't do your test speed any harm and you're always equipped with the latest and greatest coverage results.
+
+Because of this, SimpleCov has no explicit built-in mechanism to run coverage only on demand.
+
+However, you can still accomplish this very easily by introducing a ENV variable conditional into your SimpleCov setup block, like this:
+
+  SimpleCov.start if ENV["COVERAGE"]
+
+Then, SimpleCov will only run if you execute your tests like this:
+
+  $ COVERAGE=true rake test
+
 == Filters
 
 Filters can be used to remove selected files from your coverage data. By default, a filter is applied that removes all files
@@ -81,7 +102,7 @@ OUTSIDE of your project's root directory - otherwise you'd end up with a billion
 gems you are using.
 
 Of course you can define your own to remove things like configuration files, tests or whatever you don't need in your coverage
-report. 
+report.
 
 === Defining custom filters
 
@@ -89,13 +110,13 @@ You can currently define a filter using either a String (that will then be Regex
 a block or by passing in your own Filter class.
 
 ==== String filter
-  
+
   SimpleCov.start do
     add_filter "/test/"
   end
-  
+
 This simple string filter will remove all files that match "/test/" in their path.
-  
+
 ==== Block filter
 
   SimpleCov.start do
@@ -103,11 +124,11 @@ This simple string filter will remove all files that match "/test/" in their pat
       source_file.lines.count < 5
     end
   end
-  
+
 Block filters receive a SimpleCov::SourceFile instance and expect your block to return either true (if the file is to be removed
 from the result) or false (if the result should be kept). Please check out the RDoc for SimpleCov::SourceFile to learn about the
 methods available to you. In the above example, the filter will remove all files that have less then 5 lines of code.
-  
+
 ==== Custom filter class
 
   class LineFilter < SimpleCov::Filter
@@ -115,9 +136,9 @@ methods available to you. In the above example, the filter will remove all files
       source_file.lines.count < filter_argument
     end
   end
-  
+
   SimpleCov.add_filter LineFilter.new(5)
-  
+
 Defining your own filters is pretty easy: Just inherit from SimpleCov::Filter and define a method 'passes?(source_file)'. When running
 the filter, a true return value from this method will result in the removal of the given source_file. The filter_argument method
 is being set in the SimpleCov::Filter initialize method and thus is set to 5 in this example.
@@ -157,27 +178,27 @@ Simplecov tries to guess the name of the currently running test suite based upon
 on (from v0.3.2+). This should work fine for Unit Tests, RSpec and Cucumber. If it fails, it will use the shell command
 that invoked the test suite as a command name.
 
-If you have some non-standard setup and still want nicely labeled test suites, you have to give Simplecov a cue what the 
-name of the currently running test suite is. You can do so by specifying SimpleCov.command_name in one test file that is 
+If you have some non-standard setup and still want nicely labeled test suites, you have to give Simplecov a cue what the
+name of the currently running test suite is. You can do so by specifying SimpleCov.command_name in one test file that is
 part of your specific suite.
 
 So, to customize the suite names on a Rails app (yeah, sorry for being Rails biased, but everyone knows what
-the structure of those projects is. You can apply this accordingly to the RSpecs in your Outlook-WebDAV-Calendar-Sync gem), 
+the structure of those projects is. You can apply this accordingly to the RSpecs in your Outlook-WebDAV-Calendar-Sync gem),
 you could do something like this:
 
   # test/unit/some_test.rb
   SimpleCov.command_name 'test:units'
-  
+
   # test/functionals/some_controller_test.rb
   SimpleCov.command_name "test:functionals"
-  
+
   # test/integration/some_integration_test.rb
   SimpleCov.command_name "test:integration"
-  
+
   # features/steps/web_steps.rb
   SimpleCov.command_name "features"
-  
-Note that this has only to be invoked ONCE PER TEST SUITE, so even if you have 200 unit test files, specifying it in 
+
+Note that this has only to be invoked ONCE PER TEST SUITE, so even if you have 200 unit test files, specifying it in
 some_test.rb is fair enough.
 
 simplecov-html prints the used test suites in the footer of the generated coverage report.
@@ -195,32 +216,32 @@ You can deactivate merging altogether with "SimpleCov.use_merging false".
 
 By default, Simplecov's only config assumption is that you only want coverage reports for files inside your project
 root. To save you from repetitive configuration, you can use predefined blocks of configuration, called 'adapters',
-or define your own. 
+or define your own.
 
-You can then pass the name of the adapter to be used as the first argument to SimpleCov.start. For example, simplecov 
+You can then pass the name of the adapter to be used as the first argument to SimpleCov.start. For example, simplecov
 comes bundled with a 'rails' adapter. It looks somewhat like this:
 
   SimpleCov.adapters.define 'rails' do
     add_filter '/test/'
     add_filter '/config/'
-  
+
     add_group 'Controllers', 'app/controllers'
     add_group 'Models', 'app/models'
     add_group 'Helpers', 'app/helpers'
     add_group 'Libraries', 'lib'
     add_group 'Plugins', 'vendor/plugins'
   end
-  
+
 As you can see, it's just a glorified SimpleCov.configure block. In your test_helper.rb, launch simplecov with:
 
   SimpleCov.start 'rails'
-  
+
     OR
 
   SimpleCov.start 'rails' do
     # additional config here
   end
-  
+
 === Custom adapters
 
 You can load additional adapters with the SimpleCov.load_adapter('xyz') method. This allows you to build upon an existing
@@ -232,15 +253,15 @@ adapter and customize it so you can reuse it in unit tests and cucumber features
     load_adapter 'rails'
     add_filter 'vendor' # Don't include vendored stuff
   end
-  
+
   # features/support/env.rb
   require 'simplecov_custom_adapter'
   SimpleCov.start 'myadapter'
-  
+
   # test/test_helper.rb
   require 'simplecov_custom_adapter'
   SimpleCov.start 'myadapter'
-  
+
 == Customizing exit behaviour
 
 You can define what simplecov should do when your test suite finishes by customizing the at_exit hook:
@@ -248,16 +269,16 @@ You can define what simplecov should do when your test suite finishes by customi
   SimpleCov.at_exit do
     SimpleCov.result.format!
   end
-  
+
 Above is the default behaviour. Do whatever you like instead!
 
 == Using your own formatter
 
-You can use your own formatter with: 
+You can use your own formatter with:
 
   SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
 
-When calling SimpleCov.result.format!, it will be invoked with SimpleCov::Formatter::YourFormatter.new.format(result), "result" 
+When calling SimpleCov.result.format!, it will be invoked with SimpleCov::Formatter::YourFormatter.new.format(result), "result"
 being an instance of SimpleCov::Result. Do whatever your wish with that!
 
 == Using multiple formatters
@@ -274,21 +295,21 @@ There is currently no built-in support for this, but you could help yourself wit
 Then configure the formatter to use the new merger:
 
   SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
-  
+
 == Available formatters
 
 Apart from the direct companion simplecov-html (https://github.com/colszowka/simplecov-html), there are other formatters
 available:
 
-==== simplecov_rcov 
-by Fernando Guillen 
+==== simplecov_rcov
+by Fernando Guillen
 
 https://github.com/fguillen/simplecov-rcov
 
 "The target of this formatter is to cheat on Hudson so I can use the Ruby metrics plugin with SimpleCov."
 
-==== simplecov_csv 
-by Fernando Guillen 
+==== simplecov_csv
+by Fernando Guillen
 
 https://github.com/fguillen/simplecov-csv
 
@@ -296,44 +317,40 @@ CSV formatter for SimpleCov code coverage tool for ruby 1.9+
 
 == Configuration options
 
-=== SimpleCov.root '/some/path/to/coverage'
-
-The root directory for the project coverage is being generated for. This defaults to the current working directory
-and should be just fine. Note that by default, all files outside of root will be filtered and thus not included in your
-coverage report, so you'll probably rarely want to adjust this setting other than specifying an absolute path here.
-
-=== SimpleCov.coverage_dir 'coverage'
-
-The name of the subdirectory of root that coverage will be generated to. Defaults to 'coverage'.
-
-=== ...TODO...
+Please have a look at our documentation[http://rubydoc.info/gems/simplecov/frames], specifically the Configuration class.
 
 == Kudos
 
 Thanks to Aaron Patterson (http://engineering.attinteractive.com/2010/08/code-coverage-in-ruby-1-9/) for the original idea
 for this!
 
-== TODO
+== Ruby version compatibility
+
+http://travis-ci.org/colszowka/simplecov.png
+
+Only Ruby 1.9+ ships with the coverage library that SimpleCov depends upon. SimpleCov is built against various other Rubies,
+including Rubinius and JRuby, in {continuous integration}[http://travis-ci.org/colszowka/simplecov], but this happens only to
+ensure that SimpleCov does not make your test suite crash right now. Whether SimpleCov will support JRuby/Rubinius in the future
+depends solely on whether those Ruby interpreters add the coverage library.
 
-* Improve on tests (integration tests)
+SimpleCov is built in {continuous integration}[http://travis-ci.org/colszowka/simplecov] on 1.8.6, 1.8.7, 1.9.2, ree, ruby-head,
+rbx and jruby.
 
-== Developer notes
+== Contributions
 
-The test suite is built for execution on multiple versions of Ruby to ensure that SimpleCov keeps quiet on Ruby 1.8.
+To fetch & test the library for development, do:
 
-RVM is used for that, and let me tell you that you probably want to install it if you haven't yet.
+  $ git clone https://github.com/colszowka/simplecov
+  $ cd simplecov
+  $ bundle
+  $ bundle exec rake test && bundle exec cucumber features
 
-In CI, SimpleCov is built against 1.8.7, REE, 1.9.1, 1.9.2 and JRuby 1.6
+If you wont to contribute, please:
 
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+  * Fork the project.
+  * Make your feature addition or bug fix.
+  * 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.
 
 == Copyright
 

data/Rakefile

@@ -4,15 +4,11 @@ Bundler::GemHelper.install_tasks
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
+  test.test_files = FileList['test/test_*.rb']
   test.verbose = true
 end
 
 task :default => :test
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new