nxt_vcr_harness 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3aca026840674f9396cfd43479e3ed694a5269d5aeb7e60e18454477fbd88e11
+  data.tar.gz: 21c4b9e33c2fee21820d4d528deb6875816cc633ae7111dd8f8f64ad43b696c2
+SHA512:
+  metadata.gz: 246948e4309eba51c83d40e0d83c9606192821ed44b77d0b3d601de785a0bcaed87118634dd10b9961eff63985a394cfac6a85f6f7af64172b0255ff2702b7a3
+  data.tar.gz: 8a78e3940884d2efc47f726241b7aff5d58d0b7bd117dd72c7713756b4d1348f2088d94467b0b168af808c7927207eeee2d5cdb977c671fd87e4855e704be8ee

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+!/**/.keep
+/storage/
+.idea/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nxt_vcr_harness.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    nxt_vcr_harness (0.1.0)
+      rspec (~> 3.0)
+      vcr (~> 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    vcr (4.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  nxt_vcr_harness!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Andreas Robecke
+
+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,39 @@
+# NxtVcrHarness
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/nxt_vcr_harness`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nxt_vcr_harness'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nxt_vcr_harness
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nxt_vcr_harness.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nxt_vcr_harness"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nxt_vcr_harness.rb

@@ -0,0 +1,19 @@
+require "nxt_vcr_harness/version"
+require 'nxt_vcr_harness/cassette_name_by_example'
+
+module NxtVcrHarness
+  def configure(tag_name = :vcr_cassette)
+    RSpec.configure do |config|
+      config.around(:each, tag_name) do |example|
+        cassette_path = CassetteNameByExample.new(example).call
+        vcr_options = example.metadata[tag_name].is_a?(TrueClass) ? { } : example.metadata[tag_name]
+
+        VCR.use_cassette(cassette_path, **vcr_options) do
+          example.call
+        end
+      end
+    end
+  end
+
+  module_function :configure
+end

data/lib/nxt_vcr_harness/cassette_name_by_example.rb

@@ -0,0 +1,57 @@
+class CassetteNameByExample
+  def initialize(example)
+    @example = example
+  end
+
+  attr_reader :example
+
+  def call
+    cassette_name_and_path
+  end
+
+  def cassette_name_and_path
+    spec_path = example.file_path.gsub(/\.rb$/, '').gsub('./spec/', '/')
+    [spec_path, cassette_name_from_descriptions].join('/')
+  end
+
+  def cassette_name_from_descriptions
+    descriptions = context_hierarchy_with_vcr_cassette_tags.map { |c| c[:description] }
+    descriptions.map(&method(:gsub_whitespace)).map(&method(:remove_hash_tags))
+  end
+
+  def gsub_whitespace(name)
+    name.gsub(/\s+/, '_')
+  end
+
+  def remove_hash_tags(name)
+    name.delete('#')
+  end
+
+  def context_hierarchy_with_vcr_cassette_tags
+    @context_hierarchy_with_vcr_cassette_tags ||= begin
+      context_hierarchy.reverse.inject([]) do |acc, context|
+        acc << context
+        break acc if context[:vcr_cassette]
+
+        acc
+      end
+    end
+  end
+
+  def context_hierarchy
+    @context_hierarchy ||= begin
+      context_hierarchy = [example.metadata]
+      example_group = example.metadata[:example_group]
+      context_hierarchy << example_group
+
+      while parent_example_group = example_group[:parent_example_group] do
+        context_hierarchy << parent_example_group
+        example_group = parent_example_group
+      end
+
+      context_hierarchy
+    rescue StandardError => e
+      raise StandardError, "Failed to build context hierarchy for example: #{example} - Error was: #{e.inspect}"
+    end
+  end
+end

data/lib/nxt_vcr_harness/version.rb

@@ -0,0 +1,3 @@
+module NxtVcrHarness
+  VERSION = "0.1.0"
+end

data/nxt_vcr_harness.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nxt_vcr_harness/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nxt_vcr_harness"
+  spec.version       = NxtVcrHarness::VERSION
+  spec.authors       = ["Andreas Robecke", "Nils Sommer", "Raphael Kallensee"]
+  spec.email         = ["a.robecke@getsafe.de"]
+
+  spec.summary       = %q{Intuitive VCR cassette naming}
+  spec.description   = %q{Names your vcr cassettes based on your rspec examples and let's you pass in options on the fly}
+  spec.homepage      = "https://github.com/nxt-insurance"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/nxt-insurance/nxt_vcr_harness"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec", "~> 3.0"
+  spec.add_dependency "vcr", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: nxt_vcr_harness
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andreas Robecke
+- Nils Sommer
+- Raphael Kallensee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Names your vcr cassettes based on your rspec examples and let's you pass
+  in options on the fly
+email:
+- a.robecke@getsafe.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nxt_vcr_harness.rb
+- lib/nxt_vcr_harness/cassette_name_by_example.rb
+- lib/nxt_vcr_harness/version.rb
+- nxt_vcr_harness.gemspec
+homepage: https://github.com/nxt-insurance
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/nxt-insurance
+  source_code_uri: https://github.com/nxt-insurance/nxt_vcr_harness
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Intuitive VCR cassette naming
+test_files: []