nxt_vcr_harness 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e3d32919f7a43d96067c3b626e25de172e17fe0c20f2643987adb0525fc48e0
-  data.tar.gz: 28e91dcf436cf091dc9a8bfe32a3216ce130dba4890451b9cdcb71f7884c5262
+  metadata.gz: 87aa2c86941c590ac6bcc4c0ba154fc14ff61dcf1f8098c8b58ff7d4c4605124
+  data.tar.gz: 7d8dfeac8e114a84883c48edbf18bf4ce6e91db551b2cc3ac2489f98061c2a4e
 SHA512:
-  metadata.gz: 8eddddeaffe85e35f469bf1ce5065fb30eda3d18bd6e0c690546eb1c8c3729159f313b1e47f5e26ee168a0c7f9911bb78f223ebd3c44fa07b51491b1b82f69f6
-  data.tar.gz: 662f6273ae0c845395d020b7eaf0f3deb5fc71e8dbb03cd9c7eed40227c47a318476ad409022dc4f84fc4d8bcd4019de3a68ad2b0f6dc23f87e0d6d7ef7412ce
+  metadata.gz: b7865bb0b8b4f3dd4443711af812563c458c5c79ef8060347f4afcaf930f731ecd03085022694460c12f0e6190996a55d4854f6f5c5e721ac16c652013c4f1a7
+  data.tar.gz: 9085bda4e0030897e6858db9b3e642e18c4a087c581dc61681bdb3bce18e4344de8f936009f5367610246c28087beb50d968e15cfe8f1ea39cc3fd6248e8f147

data/.circleci/config.yml

@@ -0,0 +1,55 @@
+version: 2
+
+jobs:
+  build:
+    working_directory: /home/circleci/app
+    docker:
+      - image: circleci/ruby:2.6.2-node
+    environment:
+      RACK_ENV: test
+      RAILS_ENV: test
+      COVERAGE: true
+      # CC_TEST_REPORTER_ID: YOUR_REPO_CC_TEST_REPORTER_ID # ENV var set in CircleCI user interface
+    steps:
+      - checkout
+      # libpq-dev: required for compiling the `pg` gem
+      # nodejs: required for asset compilation (see https://github.com/rails/execjs)
+      - run:
+          name: Install apt dependencies
+          command: |
+            sudo apt update -q \
+            && sudo apt upgrade -q
+      - restore_cache:
+          key: v3-bundler-{{ checksum "Gemfile.lock" }}-{{ arch }}
+      - run: gem install bundler
+      - run: bundle config build.nokogiri --use-system-libraries
+      - run: bundle install --without staging:production --path=vendor/bundle --jobs=4 --retry=3
+      - save_cache:
+          key: v3-bundler-{{ checksum "Gemfile.lock" }}-{{ arch }}
+          paths:
+            - vendor/bundle
+      - run:
+          name: Collect and filter specs
+          command: |
+            mkdir -p tmp/circleci
+            circleci tests glob "spec/**/*_spec.rb" > tmp/circleci/all_tests.txt
+            circleci tests split --split-by=timings < tmp/circleci/all_tests.txt > tmp/circleci/tests_to_run.txt
+            echo "These specs will be run:"
+            cat tmp/circleci/tests_to_run.txt
+      - run:
+          name: Parallel RSpec
+          command: |
+            bundle exec rspec \
+              --color \
+              --format progress \
+              --require spec_helper \
+              --format RspecJunitFormatter --out /tmp/rspec/junit.xml \
+              $(cat tmp/circleci/tests_to_run.txt)
+      # actually not necessary for test results to be collected, but these files
+      # won't show up in the web UI otherwise
+      - store_artifacts:
+          path: /tmp/rspec/
+          destination: rspec
+
+      - store_test_results:
+          path: /tmp/rspec/

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/Gemfile.lock

@@ -1,14 +1,19 @@
 PATH
   remote: .
   specs:
-    nxt_vcr_harness (0.1.0)
+    nxt_vcr_harness (0.1.1)
       rspec (~> 3.0)
       vcr (~> 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.2)
     diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -23,6 +28,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
     vcr (4.0.0)
 
 PLATFORMS
@@ -31,8 +38,10 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.17)
   nxt_vcr_harness!
+  pry
   rake (~> 10.0)
   rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.4.1)
 
 BUNDLED WITH
-   1.17.2
+   1.17.3

data/README.md

@@ -1,8 +1,6 @@
 # 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
+NxtVcrHarness helps you with vcr cassette handling in RSpec.  
 
 ## Installation
 
@@ -22,7 +20,17 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+NxtVcrHarness currently has two features. You can use it to find vcr cassettes that are not being used when you 
+run your test suite. Enable it by calling `NxtVcrHarness.track_cassettes`. Note that the output only makes sense when
+you run your complete test suite. If you run only a subset all cassettes that are used by your other test will be included too.
+
+The second feature is that you can enable your custom :vcr tag by calling `NxtVcrHarness.enable_vcr_tag`. This will 
+automatically name your vcr cassettes based on the your rspec example and the surrounding contexts. You can also 
+setup default cassette options for your vcr tag. 
+
+```ruby
+NxtVcrHarness.enable_vcr_tag(tag_name: :my_vcr_tag, default_cassette_options: { ... })
+```
 
 ## Development
 
@@ -32,7 +40,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nxt_vcr_harness.
+Bug reports and pull requests are welcome on GitHub at https://github.com/nxt-insurance/nxt_vcr_harness.
 
 ## License
 

data/lib/nxt_vcr_harness.rb

@@ -3,13 +3,32 @@ require 'nxt_vcr_harness/cassette_name_by_example'
 require 'nxt_vcr_harness/cassette_tracker'
 
 module NxtVcrHarness
+  module VcrCassetteHelper
+    def with_vcr_cassette(example, **options, &block)
+      cassette_by_example_options = %i[prefix suffix]
+      cassette_path = CassetteNameByExample.new(example).call(options.slice(*cassette_by_example_options))
+
+      vcr_options = options.reject { |k,_| k.in?(cassette_by_example_options) }
+
+      ::VCR.use_cassette(cassette_path, **vcr_options) do
+        block.call
+      end
+    end
+
+    def hash_from_example(example, **options)
+      cassette_by_example_options = %i[prefix suffix]
+      name = CassetteNameByExample.new(example).call(options.slice(*cassette_by_example_options))
+      Digest::MD5.hexdigest(name)
+    end
+  end
+
   def enable_vcr_tag(options = {})
     tag_name = options.fetch(:tag_name, :vcr_cassette)
     default_cassette_options = options.fetch(:default_cassette_options, {})
 
     RSpec.configure do |config|
       config.around(:each, tag_name) do |example|
-        cassette_path = CassetteNameByExample.new(example).call
+        cassette_path = CassetteNameByExample.new(example).call(options.slice(:prefix, :suffix))
         cassette_options = example.metadata[tag_name].is_a?(TrueClass) ? {} : example.metadata[tag_name]
         cassette_options = default_cassette_options.merge(cassette_options)
 
@@ -20,11 +39,22 @@ module NxtVcrHarness
     end
   end
 
+  def enable_vcr_cassette_helper
+    RSpec.configure do |config|
+      config.include VcrCassetteHelper
+    end
+  end
+
+  def track_cassettes_if(condition)
+    return unless condition
+    track_cassettes
+  end
+
   def track_cassettes
     RSpec.configure do |config|
       config.after(:suite) do
         CassetteTracker.instance.stats
-        CassetteTracker.instance.reveal_unused_cassettes(VCR.configuration.cassette_library_dir)
+        CassetteTracker.instance.reveal_unused_cassettes(::VCR.configuration.cassette_library_dir)
       end
     end
 
@@ -35,5 +65,5 @@ module NxtVcrHarness
     end
   end
 
-  module_function :enable_vcr_tag, :track_cassettes
+  module_function :enable_vcr_tag, :track_cassettes, :enable_vcr_cassette_helper
 end

data/lib/nxt_vcr_harness/cassette_name_by_example.rb

@@ -1,57 +1,67 @@
-class CassetteNameByExample
-  def initialize(example)
-    @example = example
-  end
+module NxtVcrHarness
+  class CassetteNameByExample
+    def initialize(example)
+      @example = example
+    end
 
-  attr_reader :example
+    attr_reader :example
 
-  def call
-    cassette_name_and_path
-  end
+    def call(**options)
+      cassette_name_and_path(options)
+    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_and_path(options)
+      path = []
 
-  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
+      path << options[:prefix]
+      spec_path = example.file_path.gsub(/\.rb$/, '').gsub('./spec/', '')
 
-  def gsub_whitespace(name)
-    name.gsub(/\s+/, '_')
-  end
+      path << spec_path
+      path << cassette_name_from_descriptions
+      path << options[:suffix]
 
-  def remove_hash_tags(name)
-    name.delete('#')
-  end
+      "/#{path.flatten.compact.join('/')}"
+    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]
+    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
 
-        acc
-      end
+    def gsub_whitespace(name)
+      name.gsub(/\s+/, '_')
+    end
+
+    def remove_hash_tags(name)
+      name.delete('#')
     end
-  end
 
-  def context_hierarchy
-    @context_hierarchy ||= begin
-      context_hierarchy = [example.metadata]
-      example_group = example.metadata[:example_group]
-      context_hierarchy << example_group
+    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]
 
-      while parent_example_group = example_group[:parent_example_group] do
-        context_hierarchy << parent_example_group
-        example_group = parent_example_group
+          acc
+        end
       end
+    end
+
+    def context_hierarchy
+      @context_hierarchy ||= begin
+        context_hierarchy = [example.metadata]
+        example_group = example.metadata[:example_group]
+        context_hierarchy << example_group
 
-      context_hierarchy
-    rescue StandardError => e
-      raise StandardError, "Failed to build context hierarchy for example: #{example} - Error was: #{e.inspect}"
+        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
 end

data/lib/nxt_vcr_harness/cassette_tracker.rb

@@ -1,37 +1,41 @@
-class CassetteTracker
-  include Singleton
+require 'singleton'
 
-  def initialize
-    @cassettes = []
-  end
+module NxtVcrHarness
+  class CassetteTracker
+    include Singleton
 
-  def stats
-    puts '.'
-    puts "Stubbed #{playback_count} HTTP requests using #{cassette_file_names_from_used_cassettes.count} cassettes"
-  end
+    def initialize
+      @cassettes = []
+    end
 
-  def reveal_unused_cassettes(library_dir)
-    all_cassette_paths = Dir.glob("#{library_dir}/**/*.yml")
-    unused_cassettes = (all_cassette_paths - cassette_file_names_from_used_cassettes)
-    if unused_cassettes.any?
-      puts "The following cassettes are unused: "
-      puts unused_cassettes.join(' ')
-    else
-      puts "There are no unused cassettes"
+    def stats
+      puts '.'
+      puts "Stubbed #{playback_count} HTTP requests using #{cassette_file_names_from_used_cassettes.count} cassettes"
     end
-  end
 
-  def cassette_file_names_from_used_cassettes
-    cassettes.map(&:file).uniq
-  end
+    def reveal_unused_cassettes(library_dir)
+      all_cassette_paths = Dir.glob("#{library_dir}/**/*.yml")
+      unused_cassettes = (all_cassette_paths - cassette_file_names_from_used_cassettes)
+      if unused_cassettes.any?
+        puts "The following cassettes are unused: "
+        puts unused_cassettes.join(' ')
+      else
+        puts "There are no unused cassettes"
+      end
+    end
 
-  def playback_count
-    cassettes.count
-  end
+    def cassette_file_names_from_used_cassettes
+      cassettes.map(&:file).uniq
+    end
 
-  def track(cassette)
-    cassettes << cassette
-  end
+    def playback_count
+      cassettes.count
+    end
 
-  attr_accessor :cassettes
+    def track(cassette)
+      cassettes << cassette
+    end
+
+    attr_accessor :cassettes
+  end
 end

data/lib/nxt_vcr_harness/version.rb

@@ -1,3 +1,3 @@
 module NxtVcrHarness
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/nxt_vcr_harness.gemspec

@@ -41,4 +41,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_vcr_harness
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andreas Robecke
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-20 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -82,6 +82,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 description: Names your vcr cassettes based on your rspec examples and let's you pass
   in options on the fly
 email:
@@ -90,8 +118,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -127,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Intuitive VCR cassette naming