jumanjiman_spec_helper 0.0.2 → 0.1.0

data/CONTRIBUTING.md

@@ -5,6 +5,7 @@
 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
+6. Check https://travis-ci.org/jumanjiman/jumanjiman_spec_helper/pull_requests
 
 
 ## Contributor agreement

data/Gemfile

@@ -3,3 +3,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in jumanjiman_spec_helper.gemspec
 gemspec
+
+# Before extending this, make sure you read:
+# http://guides.rubygems.org/patterns/

data/README.md

@@ -22,15 +22,74 @@ Or install it yourself as:
 
 ## Usage
 
+### Use all or parts of the gem's functionality
+
+This gem uses [Bundler](http://gembundler.com/) for setup.
+The simplest way is to `require 'jumanjiman_spec_helper'`,
+which includes *all* functionality.
+
+The other way is to include just the specific functionality
+you want or need. The sections below assume you want to use
+targeted functionality. Each example demonstrates how to include
+and activate the specific functionality for each example.
+
+### Bundler
+
+This gem can wrap bundler functionality. If you want your
+`Rakefile` to bundle gem dependencies, the easiest way is to
+add at the top of your `Rakefile`:
+
+```ruby
+require 'bundler/setup'
+require 'jumanjiman_spec_helper/bundle'
+# lazy-load default gem environment
+JumanjimanSpecHelper::Bundle.setup
+```
+
+With the above code in place, it will suggest the correct bundler
+commands whenever gem dependencies need to be updated according
+to the Gemfile or gemspec in your project. The default action
+shown above is to use `Bundler.setup :default`, which locks
+dependencies and load paths, but delays loading any given gem
+until it is actually required. This speeds startup time.
+I call this *lazy-loading*.
+
+An alternative is to *early-load* all gems at startup time.
+To early-load your gems, use:
+
+```ruby
+require 'bundler/setup'
+require 'jumanjiman_spec_helper/bundle'
+# early-load default gem environment
+JumanjimanSpecHelper::Bundle.setup :default, true
+```
+
+You can also specify different gem groups, such as:
+
+```ruby
+require 'bundler/setup'
+require 'jumanjiman_spec_helper/bundle'
+# early-load development gem environment
+JumanjimanSpecHelper::Bundle.setup :development, true
+```
+
 ### Shared contexts
 
 #### Environment variables
 
 Environment variables created in one rspec example can invalidate
 other examples, giving either false positives or false failures.
-This module cleans up your environment between examples.
+
+The default rspec configuration shows three behaviors:
+
+* Preserve environment variables that exist *before* rspec examples
+* Clobber environment variables modified *within* rspec examples
+* Preserve environment variables created *within* rspec examples
+
+This module cleans up your environment between examples:
 
 * Preserve environment variables that exist *before* rspec examples
+* Restore environment variables modified *within* rspec examples
 * Discard environment variables created *within* rspec examples
 
 Add to `spec/spec_helper.rb`:
@@ -43,5 +102,5 @@ RSpec.configure do |c|
 end
 ```
 
-That's it! Now environment variables will be automatically
+That's it! Now environment variables are automatically
 cleaned up between rspec examples.

data/Rakefile

@@ -1,13 +1,8 @@
 # vim: set ts=2 sw=2 ai et ruler:
 
-# use the local git version of library for dev
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-# library of useful (to me) utils
-require 'jumanjiman_spec_helper'
-
 # lock dependencies and load paths, but lazy-load gems
+require 'bundler/setup'
+require 'jumanjiman_spec_helper/bundle'
 JumanjimanSpecHelper::Bundle.setup :development
 
 # bundle skeleton

data/jumanjiman_spec_helper.gemspec

@@ -23,7 +23,11 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  # == Dependencies ==
+  # http://guides.rubygems.org/patterns/
+  # http://docs.rubygems.org/read/chapter/20#dependencies
   # http://docs.rubygems.org/read/chapter/20#development_dependencies
+
   gem.add_development_dependency 'rake', '>= 10.0'
   gem.add_development_dependency 'rspec-core', '2.12.2'
   gem.add_development_dependency 'rspec', '2.12.0'

data/lib/jumanjiman_spec_helper.rb

@@ -1,7 +1,7 @@
 # vim: set ts=2 sw=2 ai et ruler:
 require "jumanjiman_spec_helper/version"
+require 'jumanjiman_spec_helper/bundle'
+require 'jumanjiman_spec_helper/environment_context'
 
 module JumanjimanSpecHelper
-  require 'jumanjiman_spec_helper/bundle'
-  require 'jumanjiman_spec_helper/environment_context'
 end

data/lib/jumanjiman_spec_helper/bundle.rb

@@ -1,10 +1,17 @@
 # vim: set ts=2 sw=2 ai et ruler:
+dependencies = [
+  'bundler',
+  'yaml',
+]
+begin
+  dependencies.each {|gem| require gem}
+rescue
+  require 'rubygems' # ugh, support older distros
+  retry
+end
+
 module JumanjimanSpecHelper
   module Bundle
-    require 'rubygems' # ugh, support older distros
-    require 'bundler'
-    require 'yaml'
-
     # lock dependencies and setup load paths
     # http://myronmars.to/n/dev-blog/2012/12/5-reasons-to-avoid-bundler-require
     # http://anti-pattern.com/bundler-setup-vs-bundler-require

data/lib/jumanjiman_spec_helper/version.rb

@@ -1,4 +1,4 @@
 # vim: set ts=2 sw=2 ai et ruler:
 module JumanjimanSpecHelper
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/spec/unit/environment_context_spec.rb

@@ -23,7 +23,7 @@ describe 'JumanjimanSpecHelper::EnvironmentContext' do
   end
 
   context 'when included' do
-    it 'preserves environment variable created before example' do
+    it 'preserves pre-existing env var' do
       group = RSpec::Core::ExampleGroup.describe do
         include JumanjimanSpecHelper::EnvironmentContext
       end
@@ -31,7 +31,16 @@ describe 'JumanjimanSpecHelper::EnvironmentContext' do
       ENV[key1].should == value
     end
 
-    it 'discards environment variable created within example' do
+    it 'restores pre-existing env var if changed within example' do
+      group = RSpec::Core::ExampleGroup.describe do
+        include JumanjimanSpecHelper::EnvironmentContext
+        it {ENV[key1] = value.reverse} # change env var in example
+      end
+      group.run(@reporter)
+      ENV[key1].should == value
+    end
+
+    it 'discards env var if created within example' do
       group = RSpec::Core::ExampleGroup.describe do
         include JumanjimanSpecHelper::EnvironmentContext
         it {ENV[key2] = value} # create env var in example
@@ -41,15 +50,23 @@ describe 'JumanjimanSpecHelper::EnvironmentContext' do
     end
   end
 
-  context 'when not included' do
-    it 'preserves environment variable created before example' do
+  context 'when not included (i.e., default rspec behavior)' do
+    it 'preserves pre-existing env var' do
       group = RSpec::Core::ExampleGroup.describe do
       end
       group.run(@reporter)
       ENV[key1].should == value
     end
 
-    it 'preserves environment variable created within example' do
+    it 'clobbers env var if changed within example' do
+      group = RSpec::Core::ExampleGroup.describe do
+        it {ENV[key1] = value.reverse} # change env var in example
+      end
+      group.run(@reporter)
+      ENV[key1].should == value.reverse
+    end
+
+    it 'persists env var if created within example' do
       group = RSpec::Core::ExampleGroup.describe do
         it {ENV[key2] = value} # create env var in example
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jumanjiman_spec_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-12 00:00:00.000000000 Z
+date: 2013-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -159,7 +159,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4202932635494857772
+      hash: 1737154054071565292
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -168,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4202932635494857772
+      hash: 1737154054071565292
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25