jumanjiman_spec_helper 0.0.2

data/.gitignore

@@ -0,0 +1,26 @@
+*~    # emacs buffer
+*.swp # vim buffer
+
+# some people really do this
+*.orig
+*.bak
+*.old
+
+# from `bundle gem'
+*.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/.travis.yml

@@ -0,0 +1,17 @@
+---
+# http://about.travis-ci.org/docs/user/getting-started/
+
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+
+before_script:
+  - 'bundle install'
+
+script:
+  - 'rake spec'
+
+# http://about.travis-ci.org/docs/user/notifications/#Email-notifications
+notifications:
+  email: false

data/CONTRIBUTING.md

@@ -0,0 +1,18 @@
+## Basics
+
+1. Fork https://github.com/jumanjiman/jumanjiman_spec_helper/fork_select
+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
+
+
+## Contributor agreement
+
+By contributing to this project, you certify that:
+
+* You have the right to contribute the content of your commit,
+  and your contribution complies with legal requirements.
+
+* Your contribution becomes licensed according to LICENSE.txt
+  in this repo.

data/Gemfile

@@ -0,0 +1,5 @@
+# vim: set ts=2 sw=2 ai et syntax=ruby:
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jumanjiman_spec_helper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,16 @@
+Copyright (C) 2013 Paul Morgan
+
+Paul Morgan can be contacted at: jumanjiman@gmail.com
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,47 @@
+# JumanjimanSpecHelper
+
+[![Build Status](https://travis-ci.org/jumanjiman/jumanjiman_spec_helper.png?branch=master)](https://travis-ci.org/jumanjiman/jumanjiman_spec_helper)
+
+This gem provides reusable components that can be helpful when
+writing rspec for [Puppet](https://puppetlabs.com/puppet/what-is-puppet/)
+modules.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jumanjiman_spec_helper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jumanjiman_spec_helper
+
+## Usage
+
+### 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.
+
+* Preserve environment variables that exist *before* rspec examples
+* Discard environment variables created *within* rspec examples
+
+Add to `spec/spec_helper.rb`:
+
+```ruby
+require 'jumanjiman_spec_helper/environment_context'
+RSpec.configure do |c|
+  # your normal config
+  c.include JumanjimanSpecHelper::EnvironmentContext
+end
+```
+
+That's it! Now environment variables will be automatically
+cleaned up between rspec examples.

data/Rakefile

@@ -0,0 +1,28 @@
+# 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
+JumanjimanSpecHelper::Bundle.setup :development
+
+# bundle skeleton
+require "bundler/gem_tasks"
+
+task :default do |t|
+  puts %x!rake -T!
+end
+
+require 'rake/dsl_definition'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = [
+    '--color',
+  ]
+end

data/jumanjiman_spec_helper.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+# vim: set ts=2 sw=2 ai et ruler syntax=ruby:
+#
+# This gemspec was created with `bundle gem jumanjiman_spec_helper'
+# http://net.tutsplus.com/tutorials/ruby/gem-creation-with-bundler/
+#
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jumanjiman_spec_helper/version'
+
+# http://rubygems.rubyforge.org/rubygems-update/Gem/Specification.html
+Gem::Specification.new do |gem|
+  gem.name          = "jumanjiman_spec_helper"
+  gem.version       = JumanjimanSpecHelper::VERSION
+  gem.authors       = ["Paul Morgan"]
+  gem.email         = ["jumanjiman@gmail.com"]
+  gem.description   = %q{Puppet spec helper and common rspec tests}
+  gem.summary       = %q{Provides common rspec tests for Puppet modules}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  # 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'
+  gem.add_development_dependency 'rspec-expectations', '2.12.1'
+  gem.add_development_dependency 'rspec-mocks', '2.12.2'
+  # https://github.com/freerange/mocha#bundler
+  gem.add_development_dependency 'minitest', '4.5.0'
+  gem.add_development_dependency 'mocha', '0.13.2'
+end

data/lib/jumanjiman_spec_helper.rb

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

data/lib/jumanjiman_spec_helper/bundle.rb

@@ -0,0 +1,56 @@
+# vim: set ts=2 sw=2 ai et ruler:
+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
+    def self.setup(envs = [:default], load_early = false)
+      if load_early
+        # load all gems at startup
+        Bundler.require(envs)
+      else
+        # do not load until required
+        Bundler.setup(envs)
+      end
+    rescue Bundler::GemfileNotFound,
+      Bundler::GemNotFound,
+      Bundler::VersionConflict => e
+      # some of us are not ruby experts; we need a reminder
+      print_bundle_error e
+      exit
+    rescue Exception => e
+      puts e.class
+      puts e.message
+      puts e.backtrace
+      exit
+    end
+
+    def self.bundle_config
+      File.join('.bundle', 'config')
+    end
+
+    def self.desired_bundle
+      File.join(ENV['HOME'], '.bundle')
+    end
+
+    def self.actual_bundle
+      path = YAML.load_file(bundle_config)['BUNDLE_PATH']
+      File.expand_path(path) # expand the tilde if necessary
+    rescue
+      ''
+    end
+
+    def self.print_bundle_error(e)
+      puts e.message
+      if File.exist?(bundle_config)
+        puts 'Try running `bundle update`'
+      else
+        puts 'Try running `bundle install --path=%s`' % desired_bundle
+      end
+    end
+  end
+end

data/lib/jumanjiman_spec_helper/environment_context.rb

@@ -0,0 +1,20 @@
+# vim: set ts=2 sw=2 ai et ruler:
+module JumanjimanSpecHelper
+  module EnvironmentContext
+    require 'rspec/core'
+    extend RSpec::SharedContext
+    before :each do
+      # Store environment variables (to be restored later)
+      @env = Hash.new
+      ENV.each {|k,v| @env[k] = v}
+    end
+
+    after :each do
+      # Restore environment variables
+      @env.each {|k,v| ENV[k] = v}
+
+      # remove environment vars that did not exist before test
+      ENV.keys.reject{|k| @env.include?(k)}.each{|k| ENV.delete(k)}
+    end
+  end
+end

data/lib/jumanjiman_spec_helper/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+IDEAL_CONSOLE_WIDTH = 72
+def horizontal_rule(width = 5)
+  '=' * [width, IDEAL_CONSOLE_WIDTH].min
+end
+
+# use the local git version of library for dev
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# common dependencies
+gems = [
+  'test/unit',   # https://github.com/freerange/mocha#bundler
+  'mocha/setup', # http://gofreerange.com/mocha/docs/Mocha/Configuration.html
+  'jumanjiman_spec_helper',
+]
+begin
+  gems.each {|gem| require gem}
+rescue Exception => e
+  # emphasize dependency failures in case a task spews lots of output
+  puts horizontal_rule(e.message.length)
+  puts e.message
+  puts horizontal_rule(e.message.length)
+  exit(1)
+end
+
+RSpec.configure do |c|
+  # https://www.relishapp.com/rspec/rspec-core/v/2-12/docs/mock-framework-integration/mock-with-mocha!
+  c.mock_framework = :mocha
+
+  # see output for all failures
+  c.fail_fast = false
+
+  # show times for 10 slowest examples (unless there are failed examples)
+  c.profile_examples = true
+end

data/spec/unit/environment_context_spec.rb

@@ -0,0 +1,60 @@
+# vim: set ts=2 sw=2 ai et ruler:
+require 'spec_helper'
+describe 'JumanjimanSpecHelper::EnvironmentContext' do
+  # create two keys, each with random name
+  key1 = (0...8).map{(65+rand(26)).chr}.join # exist before examples
+  key2 = (0...8).map{(65+rand(26)).chr}.join # create within examples
+
+  # both keys get this value
+  value = 'boogabooga'
+
+  before :all do
+    ENV[key1] = value
+    @reporter = RSpec::Core::Reporter.new
+  end
+
+  after :all do
+    # remove persistent key
+    ENV.delete(key1)
+  end
+
+  it 'is accessible as JumanjimanSpecHelper::EnvironmentContext' do
+    JumanjimanSpecHelper::EnvironmentContext
+  end
+
+  context 'when included' do
+    it 'preserves environment variable created before example' do
+      group = RSpec::Core::ExampleGroup.describe do
+        include JumanjimanSpecHelper::EnvironmentContext
+      end
+      group.run(@reporter)
+      ENV[key1].should == value
+    end
+
+    it 'discards environment variable created within example' do
+      group = RSpec::Core::ExampleGroup.describe do
+        include JumanjimanSpecHelper::EnvironmentContext
+        it {ENV[key2] = value} # create env var in example
+      end
+      group.run(@reporter)
+      ENV[key2].should be_nil
+    end
+  end
+
+  context 'when not included' do
+    it 'preserves environment variable created before example' do
+      group = RSpec::Core::ExampleGroup.describe do
+      end
+      group.run(@reporter)
+      ENV[key1].should == value
+    end
+
+    it 'preserves environment variable created within example' do
+      group = RSpec::Core::ExampleGroup.describe do
+        it {ENV[key2] = value} # create env var in example
+      end
+      group.run(@reporter)
+      ENV[key2].should == value
+    end
+  end
+end

data/spec/unit/version_spec.rb

@@ -0,0 +1,5 @@
+# vim: set ts=2 sw=2 ai et ruler:
+require 'spec_helper'
+describe 'JumanjimanSpecHelper::VERSION' do
+  it {should be_a(String)}
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: jumanjiman_spec_helper
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Paul Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.2
+description: Puppet spec helper and common rspec tests
+email:
+- jumanjiman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jumanjiman_spec_helper.gemspec
+- lib/jumanjiman_spec_helper.rb
+- lib/jumanjiman_spec_helper/bundle.rb
+- lib/jumanjiman_spec_helper/environment_context.rb
+- lib/jumanjiman_spec_helper/version.rb
+- spec/spec_helper.rb
+- spec/unit/environment_context_spec.rb
+- spec/unit/version_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4202932635494857772
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4202932635494857772
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Provides common rspec tests for Puppet modules
+test_files:
+- spec/spec_helper.rb
+- spec/unit/environment_context_spec.rb
+- spec/unit/version_spec.rb