rspec_rake 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15b5689a8f8a84f075fe1c985330520fa919aa00
-  data.tar.gz: fde62b95b326ebdf3b1175bc882b0a12ce429846
+  metadata.gz: 1ff9725133ce6f86b88681df3f4ee5cf4f6f5edc
+  data.tar.gz: 2d84e73eccc3adaed1a6526696756a03343dda37
 SHA512:
-  metadata.gz: 1b78a05645f193f0e8388e93d51a4665780208b7f2d432faa42ad4b68c5b055033cf6bd7976d4bec05ae0550114d54dd989b7cdc33638a488b278ae7c5f5152a
-  data.tar.gz: fe3eba990f82e21f74aa1ba3486b39613c29e702b6b72b12fb49a4acf0e6e5841fd86ebff470634f9c13c72ad69d3ec752edbf36f16b2fbdcbf0dae13eeb625b
+  metadata.gz: 3e559a8915ffccc3939832cbbc5c7e82f215f304c505f46179e2de2ecfe984ea114b11666872ff0bfd4ee16b1236a8c9ae7c83264acf077eba398ee24168b658
+  data.tar.gz: 753e5b1c174c791bb94bb334c3c4fca6d6fe94201f4f0e86870c28667dc0baff1b31398ec92a8937f8d41b4e5d5d5770f42102aab7ccc26ec1af46a8cbb86d6a

data/README.md

@@ -6,29 +6,45 @@
 [![Test Coverage](https://codeclimate.com/github/bakunyo/rspec_rake/badges/coverage.svg)](https://codeclimate.com/github/bakunyo/rspec_rake/coverage)
 
 ## Description
-RSpecRake makes easier to configure rspec of rake tasks.
+RSpecRake makes easier to configure rspec for rake tasks.
 
 ## Installation
-```
+
+```ruby
 gem install rspec_rake
 ```
 
 ## Usage
 Write configuration for rake tests in your `rails_helper.rb` or `spec_helper.rb`
+
 ```ruby
 RSpecRake.configure do |config|
   config.require_tasks(File.join('your', 'rake-task', 'dir-path'))
-  config.auto_reenable = true # Optinal
+  config.auto_reenable = true # Optional
 end
 ```
 
-#### `.auto_reenable` is what?
-`Rake::Task` can invoke task **only 1 time** because it has `#already_invoked` flag.
-But we often want to invoke more in specs.
+### .auto_reenable is what?
+`Rake::Task` can invoke task **only 1 time** because it has `#already_invoked` flag.  
+But we often want to invoke more in specs.  
 So if you want to invoke more than 1 time, use `auto_reenable` option.
 
 Be careful your specs doesn't go infinite loop :smiling_imp:
 
+### With Rails
+```ruby
+# in rails_helper
+RSpecRake.configure do |config|
+  config.require_tasks(File.join(Rails.root, 'lib', 'tasks')) # or Rails.application.load_tasks
+  config.auto_reenable = true # Optional
+end
+
+# in specs, Rake::Task can call everywhere
+before  { Rake::Task['some:task'].invoke }
+subject { Rake::Task['some:task'].invoke }
+after   { Rake::Task['some:task'].invoke }
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/bakunyo/rspec_rake.

data/lib/rspec_rake.rb

@@ -4,14 +4,25 @@ require 'rspec_rake/rake/task'
 
 module RSpecRake
   class << self
+    # Flag for method hook.  
+    # If true, call Rake::Task#reenable after Rake::Task#invoke
     attr_accessor :auto_reenable
 
+    # This method exists only to clarify that these are RSpecRake configurations.
+    # @yield [self] yield RSpecRake module instance.
+    # @example
+    #   RSpecRake.configure do |config|
+    #     config.require_tasks('rake_dir')
+    #     config.auto_reenable = true
+    #   end
     def configure
       yield self
 
       Rake::Task.define_task(:environment)
     end
 
+    # To define rake tasks, put your rake directory path
+    # @param [String] dir Directory path of rake files 
     def require_tasks(dir)
       Dir.glob(File.join(dir, '*.rake')).each do |file|
         application.rake_require(File.basename(file).gsub('.rake', ''), [dir])

data/lib/rspec_rake/version.rb

@@ -1,3 +1,3 @@
 module RSpecRake
-  VERSION = '0.3.0'
+  VERSION = '1.0.0'
 end

data/rspec_rake.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["izuta.hiroyuki@gmail.com"]
 
   spec.summary       = "RSpec settings for Rake task."
-  spec.description   = "Makes easier to configure rspec of rake tasks."
+  spec.description   = "Makes easier to configure rspec for rake tasks."
   spec.homepage      = "https://github.com/bakunyo/rspec_rake"
   spec.license       = "MIT"
 
@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "yard"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_rake
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Izuta Hiroyuki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-06 00:00:00.000000000 Z
+date: 2016-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,7 +66,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Makes easier to configure rspec of rake tasks.
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: Makes easier to configure rspec for rake tasks.
 email:
 - izuta.hiroyuki@gmail.com
 executables: []
@@ -112,3 +126,4 @@ signing_key:
 specification_version: 4
 summary: RSpec settings for Rake task.
 test_files: []
+has_rdoc: