rspec-versioned 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTYxOGQ0MTBmOTVlZjNjYmI5NzU5MDc0YWEwNDcyODg1YThkNDVmMQ==
+  data.tar.gz: !binary |-
+    MTMwNzYzNmJlY2EwYjZmOTZiZThhMzA1YmRkOGFiYzhiZjYwZGU3ZA==
+SHA512:
+  metadata.gz: !binary |-
+    YTg3YzkyMmFiNjFkZTI4MmJlZGVjOGRlNDhhMGUyOTNiMmQ2NDAzY2I5NGJi
+    MTFhMDgwOWU2ODVjNGM5OGY0NDQ0ZThlMGFiYzBmZTczZGE2YTlmNTQzZDg0
+    ZGU4OGMwYzdjNGMwNmVmY2JjZGYyMWQ0ZjFjOGFiMzVjMjU4ZTI=
+  data.tar.gz: !binary |-
+    YWQzMTdhNjBlMzk2NWZhNTBlZWFkZGEyZWNmMDEyYjMyNGFjYjA4MzFmZjQy
+    MTNmM2FjOTZlZjNjNjgwZjZhM2Q5MTNmYTY1MTY1MWZhMmU3MTEyMzljZDg5
+    NzllNjYxMjU0ODI4NTI5ZGRmMDcxNWQzMGYwMDRlZGZhMjE5NmQ=

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 ddayal-fiksu
+
+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,51 @@
+# RSpec::Versioned
+
+Inspired by [RSpec::Retry](https://github.com/y310/rspec-retry), Rspec::Versioned allows RSpec examples and example groups to easily be repeated over different API versions using the [versioned_blocks](https://github.com/devend711/versioned_blocks) gem. Just add the `:versions` option to an example:
+
+	it 'tests multiple API versions', versions:{from:2, to:4} do |example|
+       expect(example.version.uri).to include example.version.number.to_s
+    end
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-versioned'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-versioned
+
+## Usage
+
+See [versioned_blocks' documentation](https://github.com/devend711/versioned_blocks) for info about how to set a base URI and define ranges for the versions you want to test. Simply pass those options to an RSpec example group or a specific example, like this:
+
+	VersionedBlocks.base_uri = 'http://www.api.com'
+
+	it 'tests multiple API versions', versions:{to:3} do |example|
+		...
+
+	context 'when the API version is between 2 and 4', versions:{from:2, to:4} do
+		it 'tests multiple API versions' do |example|
+			...
+
+	it 'tests a different base URI', versions:{only:1, base_uri:'http://www.api2.com', override:true} do |example|
+		...
+
+Examples returned from the block will respond to `version.number` and a `version.uri` where `version.uri` will be the string `"#{VersionedBlocks.base_uri}/v#{version.number}"`
+
+Rspec::Versioned can add the version it's currently testing to RSpec's output messages. Just add this line to your RSpec config:
+
+	config.notify_version_number = true
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rspec-versioned/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rspec/versioned/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module Versioned
+    VERSION = "1.0.0"
+  end
+end

data/lib/rspec/versioned.rb

@@ -0,0 +1,103 @@
+require "rspec/versioned/version"
+require 'rspec/core'
+require 'rspec_ext/rspec_ext'
+require 'versioned_blocks'
+
+module RSpec
+  class Versioned
+    def self.apply
+      RSpec.configure do |config|
+        config.add_setting :notify_version_number, :default => false
+        config.add_setting :clear_lets_on_failure, :default => true
+
+        fetch_current_example = RSpec.respond_to?(:current_example) ?
+          proc { RSpec.current_example } : proc { |context| context.example }
+
+        config.around(:each) do |ex| # ex is a Procsy
+          notify_version_number = ex.metadata[:notify_version_number] || RSpec.configuration.notify_version_number
+
+          example = fetch_current_example.call(self)
+          example.new_version_info
+
+          run_example = Proc.new do |v, uri|
+            example.clear_exception
+            example.version.set(v, uri)
+            ex.run
+            RSpec.configuration.reporter.message("RSpec::Versioned testing /v#{v}") if notify_version_number
+          end
+
+          if ex.metadata.has_key?(:versions)
+            if ex.metadata[:versions][:base_uri] || (VersionedBlocks.base_uri && VersionedBlocks.base_uri!='') # we have a URI
+              versioned_block(ex.metadata[:versions]) do |v, uri|
+                run_example.call v,uri
+              end
+            else # we don't have a URI
+              versioned_block(ex.metadata[:versions]) do |v|
+                run_example.call v
+              end
+            end
+          else # didn't specify any versions...just run the test!
+            ex.run
+          end
+          self.clear_lets if clear_lets
+        end
+      end
+    end
+  end
+end
+
+module HasVersionInfo
+  def new_version_info
+    @version_info = VersionInfoHolder.new
+  end
+
+  def version
+    @version_info
+  end
+
+  def clear_exception
+    @exception = nil
+  end
+end
+
+module RSpec
+  module Core
+    class Example
+      @version_info
+
+      include HasVersionInfo
+
+      class Procsy
+        @version_info
+
+        include HasVersionInfo
+      end
+    end
+  end
+end
+
+class VersionInfoHolder
+  attr_reader :number
+
+  def uri
+    return @uri if !@uri.nil?
+    raise VersionedBlocksException, "Undefined URI!"
+  end
+
+  def set(v_number, uri=nil)
+    @number = v_number
+    @uri = uri
+  end
+end
+
+module RSpec
+  module Core
+    class ExampleGroup
+      def clear_lets
+        @__memoized = {}
+      end
+    end
+  end
+end
+
+RSpec::Versioned.apply

data/rspec-versioned.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/versioned/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-versioned"
+  spec.version       = Rspec::Versioned::VERSION
+  spec.authors       = ["devend711"]
+  spec.email         = ["devend711@gmail.com"]
+  spec.summary       = "Run tests over whatever API versions you want"
+  #spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = "https://github.com/devend711/rspec-versioned"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "versioned_blocks"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require_relative '../lib/rspec/versioned'
+
+RSpec.configure do |config|
+  config.color = true
+  config.notify_version_number = true
+  config.formatter = 'documentation'
+end

data/spec/versioned_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe 'rspec/versioned' do
+  it 'can run a normal example' do
+    expect(1).to eq 1
+  end
+
+  context 'without asking for URI' do
+    before :all do
+      @count = 1
+    end
+
+    it 'can run an example and get a version number', versions:{only:1} do |ex|
+      expect(ex.version.number).to eq 1
+    end
+
+    it 'can run an example and get version numbers for a range of versions', versions:{to:3} do |ex|
+      expect(ex.version.number).to eq(@count)
+      @count += 1
+    end
+  end
+
+  context 'after setting a URI' do
+    before :all do
+      @count = 1
+      VersionedBlocks.base_uri = "http://api.com"
+    end
+
+    it 'can run an example and get a version number', versions:{only:1} do |ex|
+      expect(ex.version.uri).to include ex.version.number.to_s
+    end
+
+    it 'can override base_uri', versions:{only:1, base_uri:'http://api2.com', override:true} do |ex|
+      expect(ex.version.uri).to include 'http://api2.com'
+    end
+
+    it 'can run an example and get version numbers and URIs for a range of versions', versions:{to:3} do |ex|
+      expect(ex.version.uri).to include('api.com')
+      expect(ex.version.uri).to include(ex.version.number.to_s)
+      expect(ex.version.number).to eq(@count)
+      @count += 1
+    end
+  end
+
+  context 'nested examples' do
+    before :all do
+      @outer_count = 1
+      @always_1 = 1
+    end
+
+    context 'nested', versions:{from:2, to:4} do
+      it 'runs the correct amount of times' do |ex|
+        @outer_count += 1
+        expect(@outer_count).to eq ex.version.number
+      end
+
+      it 'only runs once for this one', versions:{only:1} do
+        expect(@always_1).to eq 1
+        @always_1 += 1
+      end
+
+      context 'another nested' do
+        before :all do
+          @inner_count = 1
+        end
+
+        it 'runs the correct amount of times' do |ex|
+          @inner_count += 1
+          expect(@inner_count).to eq ex.version.number
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: rspec-versioned
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- devend711
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: versioned_blocks
+  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: 
+email:
+- devend711@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/versioned.rb
+- lib/rspec/versioned/version.rb
+- rspec-versioned.gemspec
+- spec/spec_helper.rb
+- spec/versioned_spec.rb
+homepage: https://github.com/devend711/rspec-versioned
+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.2
+signing_key: 
+specification_version: 4
+summary: Run tests over whatever API versions you want
+test_files:
+- spec/spec_helper.rb
+- spec/versioned_spec.rb