rcov_plugin 3.0.0

data/README.md

@@ -0,0 +1,85 @@
+rcov_plugin
+===========
+
+This is a simple rails plugin for Rails 3 that adds some useful rcov rake tasks.
+
+    rake test:coverage                # Tests coverage on the entire application
+    rake test:coverage:units          # Tests coverage for unit tests
+    rake test:coverage:functionals    # Tests coverage for functional tests
+    rake test:coverage:integration    # Tests coverage for integration tests
+
+The task ends up creating a coverage folder with an html coverage report in it.
+
+SHOW_ONLY is a comma-separated list of the files you'd like to see (although
+you can only run functionals, you still see all the models and helpers which 
+are 'touched'). Right now there are four types of files rake test:coverage 
+recognizes: models, helpers, controllers, and lib. These can be abbreviated 
+to their first letters:
+
+    rake test:coverage SHOW_ONLY=models
+    rake test:coverage SHOW_ONLY=helpers,controllers
+    rake test:coverage SHOW_ONLY=h,c
+
+Installing
+=============
+As of Rails 3, rake tasks can be distributed easily in plugins packaged as gems, and that's what we do here. So, to install rcov_plugin, simply do:
+
+gem install rcov_plugin
+
+or add the gem to your bundler Gemspec
+
+gem "rcov_plugin"
+
+JRuby Support
+=============
+rcov_plugin works great with JRuby.
+
+If using JRuby, remember to run rake with it, like this:
+    jruby -S rake test:coverage
+
+Special thanks go to Leonard Borges ([http://www.leonardoborges.com](http://www.leonardoborges.com)) for getting the plugin working with JRuby.
+
+Requirements
+============
+
+This plugin requires rails 3 and 
+
+Using With Rails 2
+============
+This plugin worked with Rails 2 back in the day, and I've got a tag on the repo that you can use to install the old Rails 2 version. Use the following command:
+
+    script/plugin install -r rails_2 git://github.com/commondream/rcov_plugin.git
+
+Contributors
+============
+Special thanks go to all of the contributors to this plugin:
+
+* leonardoborges
+* dovadi
+* baldowl
+* archfear
+* nragaz
+
+License
+=======
+Copyright (c) 2008 Alan Johnson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/lib/rcov_plugin.rb

@@ -0,0 +1,3 @@
+module RcovPlugin
+  require 'rcov_plugin/railtie' if defined?(Rails)
+end

data/lib/rcov_plugin/railtie.rb

@@ -0,0 +1,13 @@
+require 'rcov_plugin'
+require 'rails'
+
+puts "Loaded rcov_plugin"
+
+module RcovPlugin
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      puts "Loading rake tasks"
+      load "tasks/rcov.rake"
+    end
+  end
+end

data/lib/rcov_plugin/version.rb

@@ -0,0 +1,3 @@
+module RcovPlugin
+  VERSION = "3.0.0"
+end

data/lib/tasks/rcov.rake

@@ -0,0 +1,77 @@
+def run_coverage(files)
+  rm_f "coverage"
+  rm_f "coverage.data"
+  
+  # turn the files we want to run into a string
+  if files.empty?
+    puts "No files were specified for testing"
+    return
+  end
+  
+  files = files.join(" ")
+
+  if RUBY_PLATFORM =~ /darwin/
+    exclude = '--exclude "gems/*" --exclude "Library/Frameworks/*"'
+  elsif RUBY_PLATFORM =~ /java/
+    exclude = '--exclude "rubygems/*,jruby/*,parser*,gemspec*,_DELEGATION*,eval*,recognize_optimized*,yaml,yaml/*,fcntl"'
+  else
+    exclude = '--exclude "rubygems/*"'
+  end
+  # rake test:units:rcov SHOW_ONLY=models,controllers,lib,helpers
+  # rake test:units:rcov SHOW_ONLY=m,c,l,h
+  if ENV['SHOW_ONLY']
+    params = String.new
+    show_only = ENV['SHOW_ONLY'].to_s.split(',').map{|x|x.strip}
+    if show_only.any?
+      reg_exp = []
+      for show_type in show_only
+        reg_exp << case show_type
+        when 'm', 'models' then 'app\/models'
+        when 'c', 'controllers' then 'app\/controllers'
+        when 'h', 'helpers' then 'app\/helpers'
+        when 'l', 'lib' then 'lib'
+        else
+          show_type
+        end
+      end
+      reg_exp.map!{ |m| "(#{m})" }
+      params << " --exclude \"^(?!#{reg_exp.join('|')})\""
+    end
+    exclude = exclude + params
+  end
+
+  rcov_bin = RUBY_PLATFORM =~ /java/ ? "jruby -S bundle exec rcov" : "bundle exec rcov"
+  rcov = "#{rcov_bin} --rails -Ilib:test --sort coverage --text-report #{exclude}"
+  puts
+  puts
+  puts "Running tests..."
+  cmd = "#{rcov} #{files}"
+  puts cmd
+  sh cmd
+end
+
+namespace :test do
+  
+  desc "Measures unit, functional, and integration test coverage"
+  task :coverage do
+    run_coverage Dir["test/unit/**/*.rb", "test/functional/**/*.rb", "test/integration/**/*.rb"]
+  end
+  
+  namespace :coverage do
+    desc "Runs coverage on unit tests"
+    task :units do
+      run_coverage Dir["test/unit/**/*.rb"]
+    end
+    
+    desc "Runs coverage on functional tests"
+    task :functionals do
+      run_coverage Dir["test/functional/**/*.rb"]
+    end
+    
+    desc "Runs coverage on integration tests"
+    task :integration do
+      run_coverage Dir["test/integration/**/*.rb"]
+    end
+  end
+end
+

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: rcov_plugin
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 3
+  - 0
+  - 0
+  version: 3.0.0
+platform: ruby
+authors: 
+- Alan Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-16 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta2
+        version: 3.0.0.beta2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 6
+        version: 0.9.6
+  type: :runtime
+  version_requirements: *id002
+description: rcov_plugin adds the rake tasks that you need to measure coverage in your Rails project
+email: 
+- alan@commondream.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/rcov_plugin/railtie.rb
+- lib/rcov_plugin/version.rb
+- lib/rcov_plugin.rb
+- lib/tasks/rcov.rake
+- README.md
+has_rdoc: true
+homepage: http://github.com/commondream/rcov_plugin
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: The easiest way to measure coverage for your Rails project
+test_files: []
+