From 6d2a3096b156df05cca9efd0ce7be774d9162e4d Mon Sep 17 00:00:00 2001 From: Hunter Haugen Date: Thu, 5 Dec 2013 10:02:41 -0800 Subject: [PATCH] Clarify instructions for new usage --- CHANGEFILE | 6 ++++++ README.md | 7 ++----- lib/rspec-system-serverspec/helpers.rb | 7 +++++++ rspec-system-serverspec.gemspec | 2 +- 4 files changed, 16 insertions(+), 6 deletions(-) diff --git a/CHANGEFILE b/CHANGEFILE index e40365c..4fe3fd0 100644 --- a/CHANGEFILE +++ b/CHANGEFILE @@ -1,3 +1,9 @@ +2013-12-05 2.0.1 +- Update readme for breaking changes and deprecation notice. If you previously + had `include Serverspec::Helper::RSpecSystem` or `include + Serverspec::Helper::DetectOS` in `spec/spec_helper_system.rb` then these + should be removed. + 2013-12-03 2.0.0 - Update for new specinfra gem diff --git a/README.md b/README.md index 1524124..2121919 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,9 @@ ## Quick Start * Have a module that is configured to use rspec-system -* `gem install serverspec` -* Add the `serverspec` and `rspec-system-serverspec` gems to your module's `Gemfile` -* Add these lines to your `spec/spec_helper_system.rb` file: +* Add the `rspec-system-serverspec` gem to your module's `Gemfile` +* Add the following line to your `spec/spec_helper_system.rb` file: ```ruby require 'rspec-system-serverspec/helpers' -include Serverspec::Helper::RSpecSystem -include Serverspec::Helper::DetectOS ``` diff --git a/lib/rspec-system-serverspec/helpers.rb b/lib/rspec-system-serverspec/helpers.rb index 8ddb1c7..8690329 100644 --- a/lib/rspec-system-serverspec/helpers.rb +++ b/lib/rspec-system-serverspec/helpers.rb @@ -6,3 +6,10 @@ include SpecInfra::Helper::RSpecSystem include SpecInfra::Helper::DetectOS + +module Serverspec::Helper::RSpecSystem + def self.included(base) + # Deprecated in 2.0.0 + warn "[DEPRECATED] Serverspec::Helper::RSpecSystem is deprecated and should no longer be included. See the README for information." + end +end diff --git a/rspec-system-serverspec.gemspec b/rspec-system-serverspec.gemspec index 9fba536..c3576b0 100644 --- a/rspec-system-serverspec.gemspec +++ b/rspec-system-serverspec.gemspec @@ -2,7 +2,7 @@ Gem::Specification.new do |s| # Metadata s.name = 'rspec-system-serverspec' - s.version = '2.0.0' + s.version = '2.0.1' s.authors = ['Hunter Haugen'] s.email = ['h.haugen@gmail.com'] s.summary = 'Serverspec rspec-system plugin'