rspec-rake 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1192ef82b6d2f2ed8d3f53986fc3c4ad08d61f16
+  data.tar.gz: abc1cf70bf660e96a478e140a7362f8444b5bcba
+SHA512:
+  metadata.gz: 5908679322a3a5cc18e17baa0edc580f1049726ac7c0132da5f7e0e431ef5a7d024ddea3e867c2fb309f52e9ee32af5124ba099d35622d3c51210c641e118cdb
+  data.tar.gz: b995a437c9346f01cbbf4fc9d9e4d1680d3660fbeeb87620c79c83aebfc938b3790d74e15d63a5edaac7cbb5edb3917f2639bf90528226aaec0b7797a8d44341

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-rake.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Stas SUȘCOV
+
+MIT License
+
+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/README.md

@@ -0,0 +1,66 @@
+# RSpec Rake Support
+
+You can test you Rake files like you test your Rails app.
+
+This gem adds an example group and configures RSpec so we can write tests for our Rake tasks easily.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-rake'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-rake
+
+## Usage
+
+Require `rspec/rake` in your `spec_helper.rb`
+
+```ruby
+require 'rspec/rake'
+```
+
+And start writing tests in your `spec/tasks` directory.
+
+Normally `RSpec::Rake` will detect a **task** test and will try loading it from your `lib/tasks/*.rake` directory.
+
+You can manually specify the rake file location and file name by using metadata:
+
+```ruby
+describe 'task:subtask', :rakefile => 'my_task' do
+  # Spot the :rakefile metadata value
+  # This will tell `RSpec::Test` to load `lib/tasks/my_task.rake`
+end
+```
+
+```ruby
+describe 'task:subtask', :rakefile => 'my_task', :tasks_path => 'lib/capistrano/tasks' do
+  # Same with the :tasks_path metadata value
+  # This will tell `RSpec::Test` to load `lib/capistrano/task/my_task.rake`
+end
+```
+
+### Limitations
+
+Due to how `Rake::Application#rake_require` works, only files with `.rake` extension can be tests.
+
+## Plagiarism alert
+
+My tentative to provide RSpec support for testing Rake tasks in a convenient and idiomatic way is not new.
+Previously [Thoughtbot](http://robots.thoughtbot.com/test-rake-tasks-like-a-boss) and [Tyler Hunt](http://devoh.com/blog/2010/11/testing-rake-tasks-with-rspec) wrote about this.
+
+Although I picked a different approach to handle the same problem, it is pretty much the same solution. All I did is tried to put it all together and provide it the way you see it now.
+
+## Contributing
+
+1. Fork it ( http://github.com/stas/rspec-rake/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rspec/rake.rb

@@ -0,0 +1,10 @@
+require 'rspec/rake/version'
+require 'rspec/rake/example_group'
+
+RSpec.configure do |config|
+  config.include RSpec::Rake::ExampleGroup,
+    :type => :task,
+    :example_group => lambda { |example_group, metadata|
+      metadata[:type].nil? && %r{spec/tasks}.match(example_group[:file_path])
+    }
+end

data/lib/rspec/rake/example_group.rb

@@ -0,0 +1,33 @@
+require 'rake'
+
+module RSpec::Rake
+
+  module ExampleGroup
+
+    def self.included(base)
+      base.instance_eval do
+
+        metadata[:type] = :task
+        metadata[:tasks_path] ||= File.join('../', 'lib', 'tasks')
+        metadata[:rakefile] ||= nil
+
+        subject(:task)  { Rake.application[self.class.top_level_description] }
+
+        before(:all) do
+          metadata = self.class.metadata
+          task_name = self.class.top_level_description
+
+          rakefile = metadata[:rakefile] || task_name.split(':').first
+          task_path = File.join(metadata[:tasks_path], rakefile)
+
+          Rake.application = Rake::Application.new
+          # We are sending an empty list of loaded files
+          # in order to force loading of existing files
+          Rake.application.rake_require(task_path, $LOAD_PATH, [])
+        end
+      end
+
+    end
+
+  end
+end

data/lib/rspec/rake/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module Rake
+    VERSION = "0.0.1"
+  end
+end

data/rspec-rake.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/rake/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-rake"
+  spec.version       = Rspec::Rake::VERSION
+  spec.authors       = ["Stas SUȘCOV"]
+  spec.email         = ["stas@net.utcluj.ro"]
+  spec.summary       = %q{Test Rake tasks with RSpec.}
+  spec.description   = %q{RSpec support for testing Rake tasks.}
+  spec.homepage      = "https://github.com/stas/rspec-rake"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rake"
+  spec.add_dependency "rspec-core"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rspec"
+end

data/spec/fixtures/example.rake

@@ -0,0 +1,9 @@
+namespace :example do
+  namespace :subexample do
+    task :task do
+      Kernel.puts 'OK'
+    end
+  end
+end
+
+task :default => 'example:subexample:task'

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rspec/rake'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/tasks/rake_task_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe 'default', :rakefile => 'example', :tasks_path => './fixtures' do
+  it 'task lists another task as the prerequisite' do
+    expect(task.prerequisites).to include('example:subexample:task')
+  end
+
+  it 'task calls `puts`' do
+    expect(Kernel).to receive(:puts).with('OK')
+    task.invoke
+  end
+end
+
+describe 'example:subexample:task', :tasks_path => 'fixtures' do
+  it 'has no prerequisites' do
+    expect(task.prerequisites).to be_empty
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: rspec-rake
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stas SUȘCOV
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rspec
+  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'
+description: RSpec support for testing Rake tasks.
+email:
+- stas@net.utcluj.ro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/rake.rb
+- lib/rspec/rake/example_group.rb
+- lib/rspec/rake/version.rb
+- rspec-rake.gemspec
+- spec/fixtures/example.rake
+- spec/spec_helper.rb
+- spec/tasks/rake_task_spec.rb
+homepage: https://github.com/stas/rspec-rake
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Test Rake tasks with RSpec.
+test_files:
+- spec/fixtures/example.rake
+- spec/spec_helper.rb
+- spec/tasks/rake_task_spec.rb