bones-extras 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2009-11-04
+
+* 1 major enhancement
+  * Birthday!

data/README.txt

@@ -0,0 +1,46 @@
+bones-extras
+    by Tim Pease
+    http://gemcutter.org/gems/bones-extras
+
+== DESCRIPTION:
+
+The extras package for Mr Bones provides some handy Rake tasks for running
+Rcov code coverage on your tests, running Rspec tests, running the Zentest
+autotest package, and uploading gems and generated rdoc to RubyForge.
+
+== REQUIREMENTS:
+
+The extras package for Mr Bones provides some handy Rake tasks for running
+Rcov code coverage on your tests, running Rspec tests, running the Zentest
+autotest package, and uploading gems and generated rdoc to RubyForge. In order
+to use these Rake tasks, the corresponding gems will need to be installed on
+your system: rcov, rspec, zentest, and rubyforge.
+
+== INSTALL:
+
+  sudo gem install bones-extras
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009
+
+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/Rakefile

@@ -0,0 +1,27 @@
+
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
+
+ensure_in_path 'lib'
+task :default => 'test:run'
+
+Bones.plugin :ann, :gem, :git, :notes, :rdoc
+
+Bones {
+  name        'bones-extras'
+  authors     'Tim Pease'
+  email       'tim.pease@gmail.com'
+  url         'http://github.com/TwP/bones-extras'
+  version     '1.0.0'
+  ignore_file '.gitignore'
+
+  depend_on   'bones'
+
+  use_gmail
+  enable_sudo
+}
+
+# EOF

data/lib/bones/plugins/rcov.rb

@@ -0,0 +1,96 @@
+
+module Bones::Plugins::Rcov
+  include ::Bones::Helpers
+  extend self
+
+  def initialize_rcov
+    ::Bones.config {
+      desc 'Configuration settings for the Rcov code coverage tool.'
+      rcov {
+        dir 'coverage', :desc => <<-__
+          Code coverage metrics will be written to this directory.
+        __
+
+        opts %w[--sort coverage -T], :desc => <<-__
+          An array of command line options that will be passed to the rcov
+          command when running your tests. See the Rcov help documentation
+          either online or from the command line by running 'rcov --help'.
+        __
+
+        threshold 90.0, :desc => <<-__
+          The threshold value (in percent) for coverage. If the actual
+          coverage is not greater than or equal to this value, the verify task
+          will raise an exception.
+        __
+
+        threshold_exact false, :desc => <<-__
+          Require the threshold to be met exactly. By default this option is
+          set to false.
+        __
+      }
+    }
+  end
+
+  def post_load
+    require 'rcov'
+    config = ::Bones.config
+    config.exclude << "^#{Regexp.escape(config.rcov.dir)}/"
+    have?(:rcov) { true }
+  rescue LoadError
+    have?(:rcov) { false }
+  end
+
+  def define_tasks
+    return unless have? :rcov
+    config = ::Bones.config
+
+    if have? :test
+      namespace :test do
+        desc 'Run rcov on the unit tests'
+        Rcov::RcovTask.new do |t|
+          t.output_dir = config.rcov.dir
+          t.rcov_opts = config.rcov.opts
+          t.ruby_opts = config.ruby_opts.dup.concat(config.test.opts)
+
+          t.test_files =
+              if test(?f, config.test.file) then [config.test.file]
+              else config.test.files.to_a end
+
+          t.libs = config.libs unless config.libs.empty?
+        end
+
+        task :clobber_rcov do
+          rm_r config.rcov.dir rescue nil
+        end
+      end
+      task :clobber => 'test:clobber_rcov'
+    end
+
+    if have? :spec
+      require 'spec/rake/verify_rcov'
+      namespace :spec do
+        desc 'Run all specs with Rcov'
+        Spec::Rake::SpecTask.new(:rcov) do |t|
+          t.ruby_opts = config.ruby_opts
+          t.spec_opts = config.spec.opts
+          t.spec_files = config.spec.files
+          t.libs += config.libs
+          t.rcov = true
+          t.rcov_dir = config.rcov.dir
+          t.rcov_opts.concat(config.rcov.opts)
+        end
+
+        RCov::VerifyTask.new(:verify) do |t|
+          t.threshold = config.rcov.threshold
+          t.index_html = File.join(config.rcov.dir, 'index.html')
+          t.require_exact_threshold = config.rcov.threshold_exact
+        end
+
+        task :verify => :rcov
+        remove_desc_for_task %w(spec:clobber_rcov)
+      end
+      task :clobber => 'spec:clobber_rcov'
+    end
+  end
+
+end  # module Bones::Plugins::Rcov

data/lib/bones/plugins/rubyforge.rb

@@ -0,0 +1,88 @@
+
+module Bones::Plugins::Rubyforge
+
+  def initialize_rubyforge
+    ::Bones.config {
+      desc 'Configuration settings for RubyForge publishing.'
+      rubyforge {
+        name nil, :desc => <<-__
+          The RubyForge project name where your code will be published. If not
+          supplied, the RubyForge name will default to the base 'name' of your
+          gem. The RubyForge name is used when your gem name differs from the
+          registered project name; for example if you release multiple gems
+          under the same project.
+        __
+      }
+
+      rdoc {
+        remote_dir nil, :desc => <<-__
+          This is the remote directory to use when publishing RDoc HTML
+          documentation to your RubyForge project page. If not specified, this
+          defaults to the root of the project page.
+        __
+      }
+    }
+  end
+
+  def post_load
+    require 'rubyforge'
+    require 'rake/contrib/sshpublisher'
+    config = ::Bones.config
+    have?(:rubyforge) { true }
+  rescue LoadError
+    have?(:rubyforge) { false }
+  end
+
+  def define_tasks
+    return unless have? :rubyforge
+    config = ::Bones.config
+
+    if have? :gem
+      namespace :gem do
+        desc 'Package and upload to RubyForge'
+        task :release => [:clobber, 'gem'] do |t|
+          v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+          abort "Versions don't match #{v} vs #{config.version}" if v != config.version
+          pkg = "pkg/#{config.gem._spec.full_name}"
+
+          rf = RubyForge.new
+          rf.configure rescue nil
+          puts 'Logging in'
+          rf.login
+
+          c = rf.userconfig
+          c['release_notes'] = config.description if config.description
+          c['release_changes'] = config.changes if config.changes
+          c['preformatted'] = true
+
+          files = Dir.glob("#{pkg}*.*")
+
+          puts "Releasing #{config.name} v. #{config.version}"
+          rf.add_release config.rubyforge.name, config.name, config.version, *files
+        end
+      end
+    end  # have? :gem
+
+    if have? :rdoc
+      namespace :doc do
+        desc 'Publish RDoc to RubyForge'
+        task :release => %w(doc:clobber_rdoc doc:rdoc) do
+          config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+          )
+
+          host = "#{config['username']}@rubyforge.org"
+          remote_dir = "/var/www/gforge-projects/#{config.rubyforge.name}/"
+          remote_dir << config.rdoc.remote_dir if config.rdoc.remote_dir
+          local_dir = config.rdoc.dir
+
+          Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+        end
+      end  # namespace :doc
+    end  # have? :rdoc
+
+  end
+
+end  # module Bones::Plugins::Rubyforge
+
+# EOF

data/lib/bones/plugins/spec.rb

@@ -0,0 +1,60 @@
+
+module Bones::Plugins::Spec
+  include ::Bones::Helpers
+  extend self
+
+  def initialize_spec
+    ::Bones.config {
+      desc 'Configuration settings for the RSpec test framework.'
+      spec {
+        files  FileList['spec/**/*_spec.rb'], :desc => <<-__
+          The list of spec files to run. This defaults to all the ruby fines
+          in the 'spec' directory that end with '_spec.rb' as their filename.
+        __
+
+        opts [], :desc => <<-__
+          An array of command line options that will be passed to the spec
+          command when running your tests. See the RSpec help documentation
+          either online or from the command line by running 'spec --help'.
+        __
+      }
+    }
+  end
+
+  def post_load
+    require 'spec/rake/spectask'
+    config = ::Bones.config
+    have?(:spec) { !config.spec.files.to_a.empty?  }
+  rescue LoadError
+    have?(:spec) { false }
+  end
+
+  def define_tasks
+    return unless have? :spec
+    config = ::Bones.config
+
+    namespace :spec do
+      desc 'Run all specs with basic output'
+      Spec::Rake::SpecTask.new(:run) do |t|
+        t.ruby_opts = config.ruby_opts
+        t.spec_opts = config.spec.opts
+        t.spec_files = config.spec.files
+        t.libs += config.libs
+      end
+
+      desc 'Run all specs with text output'
+      Spec::Rake::SpecTask.new(:specdoc) do |t|
+        t.ruby_opts = config.ruby_opts
+        t.spec_opts = config.spec.opts + ['--format', 'specdoc']
+        t.spec_files = config.spec.files
+        t.libs += config.libs
+      end
+    end  # namespace :spec
+
+    desc 'Alias to spec:run'
+    task :spec => 'spec:run'
+  end
+
+end  # module Bones::Plugins::Spec
+
+# EOF

data/lib/bones/plugins/zentest.rb

@@ -0,0 +1,43 @@
+
+module Bones::Plugins::Zentest
+  include ::Bones::Helpers
+  extend self
+
+  def post_load
+    require 'zentest'
+    have?(:zentest) { true }
+  rescue LoadError
+    have?(:zentest) { false }
+  end
+
+  def define_tasks
+    return unless have? :zentest
+
+    if have? :test
+      require 'autotest'
+      namespace :test do
+        task :autotest do
+          load '.autotest' if test(?f, '.autotest')
+          Autotest.run
+        end
+      end
+
+      desc 'Run the autotest loop'
+      task :autotest => 'test:autotest'
+    end
+
+    if have? :spec
+      require 'autotest/rspec'
+      namespace :spec do
+        task :autotest do
+          load '.autotest' if test(?f, '.autotest')
+          Autotest::Rspec.run
+        end
+      end
+
+      desc 'Run the autotest loop'
+      task :autotest => 'spec:autotest'
+    end
+  end
+
+end  # module Bones::Plugins::Zentest

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: bones-extras
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tim Pease
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-04 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bones
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: bones
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+    version: 
+description: |-
+  The extras package for Mr Bones provides some handy Rake tasks for running
+  Rcov code coverage on your tests, running Rspec tests, running the Zentest
+  autotest package, and uploading gems and generated rdoc to RubyForge.
+email: tim.pease@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.txt
+files: 
+- History.txt
+- README.txt
+- Rakefile
+- lib/bones/plugins/rcov.rb
+- lib/bones/plugins/rubyforge.rb
+- lib/bones/plugins/spec.rb
+- lib/bones/plugins/zentest.rb
+has_rdoc: true
+homepage: http://github.com/TwP/bones-extras
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: bones-extras
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: The extras package for Mr Bones provides some handy Rake tasks for running Rcov code coverage on your tests, running Rspec tests, running the Zentest autotest package, and uploading gems and generated rdoc to RubyForge
+test_files: []
+