rspec-rcv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b08931127f4e12942b32aa34d5006d18728cc395
+  data.tar.gz: ba816c39170e25462586f6b26b130794ebe223f7
+SHA512:
+  metadata.gz: 100479086b2e3f09d3573c01934d93eb294da1c33b0f89acde87b468a8a3bb0554f3b4b68a16f4df53d05947d1ab9f8cc698aaee8fdb1ad8b742a3dc3bcadae7
+  data.tar.gz: 2c4af36ebf6f81dcbf52d746081fb3e9ca487e1d82c4d068089cebae0448d579eba5431a1eda057c10c2e05b3564b0425c0c984a0a173dd91ef2c39df4573425

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+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,82 @@
+# Purpose
+
+The purpose of this gem is to provide a way to export the results of rspec tests to disk. In this way, a controller test can output the response body of the request, and then a front-end test can read that file in order to have predictable and maintainable front-end fixtures.
+
+This gem currently only applies to the rspec testing framework.
+
+# Usage
+
+The gem is require'd in the rspec loading script, and will take effect from there by using the "fixture" option. For example, the following test would record response.body to spec/fixtures/widgets/index.json"
+
+```ruby
+describe "GET index" do
+  it "is successful", fixture: "widgets/index.json" do
+    get :index
+    expect(response).to be_success
+  end
+end
+```
+
+The test itself does not need to do anything different, it is all in configuration.
+
+If the file already exists, and the new content is not identical, the test will fail with a message indicating that this happened. This will prevent surprises from happening, and can be turned off in a configuration variable.
+
+# Lifecycle
+
+The result of the exportable variable is captured at the end of the test, after everything else has run. Because this is an
+outer `after(:each)`, it will run after all of the other `after` blocks in the suite. This means you can't use the output of
+the file in an after block (not that you should need to). See the spec suite here to understand how you *could* use the output of
+the file in the spec suite.
+
+# Configuration Options
+
+The following options are available to override, as well as their default values:
+
+```ruby
+config.exportable_proc = Proc.new { response.body }
+config.compare_with = Proc.new { |existing, new| existing == new }
+config.export_with = Proc.new do |hash|
+                               begin
+                                 hash[:data] = JSON.parse(hash[:data])
+                               rescue JSON::ParserError
+                               end
+                               JSON.pretty_generate(hash)
+                             end
+config.base_path = nil
+config.fail_on_changed_output = true
+```
+
+`exportable_proc`, `compare_with`, `export_with` must implement `.call`. For `exportable_proc`, the result will be written to disk
+and should be a String. For `compare_with`, the proc should return true when existing and new are considered equal. For `export_with`
+a hash will be passed in and the result will be a String written to disk.
+
+`export_with` by default tries to take hash[:data] (a string) and JSON parse it. If it isn't successful, that is fine and hash[:data] isn't
+changed. If it is JSON, then the pretty print will work more optimally.
+
+Note: This can support things that aren't JSON because you can override Proc's that you need to. However, some of the internal workings assume JSON and so it is recommended to just keep the file as JSON.
+
+# What about fields that change everytime I run the specs?
+
+This is why you can override `compare_with`. For instance, here is a configuration to ignore `id, created_at, updated_at` in a Rails app:
+
+```ruby
+RSpecRcv.configure do |config|
+  config.configure_rspec_metadata!
+
+  filters = [:id, :created_at, :updated_at]
+  config.compare_with = lambda do |existing, new|
+    existing = ActiveSupport::HashWithIndifferentAccess.new(existing)
+    new = ActiveSupport::HashWithIndifferentAccess.new(JSON.parse(new))
+
+    existing.except(*filters) != new.except(*filters)
+  end
+end
+```
+
+# What happens when fields change that shouldn't?
+
+You will get a diff of the output to your console. Here is an example:
+
+![image](https://cloud.githubusercontent.com/assets/1231659/8729785/2a2aaa24-2bbb-11e5-90fe-99572a95ab7f.png)
+
+

data/Rakefile

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

data/lib/rspec-rcv.rb

@@ -0,0 +1,26 @@
+require "rspec-rcv/version"
+require "rspec-rcv/configuration"
+require "rspec-rcv/test_frameworks/rspec"
+
+require "rspec-rcv/handler"
+require "rspec-rcv/data_changed_error"
+
+module RSpecRcv
+  extend self
+
+  module RSpec
+    autoload :Metadata, "rspec-stripe/test_frameworks/rspec"
+  end
+
+  def configure
+    yield configuration
+  end
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def config(overrides=nil)
+    @configuration.opts(overrides)
+  end
+end

data/lib/rspec-rcv/configuration.rb

@@ -0,0 +1,77 @@
+module RSpecRcv
+  class Configuration
+    DEFAULTS = {
+        exportable_proc: Proc.new { response.body },
+        compare_with: Proc.new { |existing, new| existing == new },
+        export_with: Proc.new do |hash|
+          begin
+            hash[:data] = JSON.parse(hash[:data])
+          rescue JSON::ParserError
+          end
+          JSON.pretty_generate(hash)
+        end,
+        fail_on_changed_output: true,
+        base_path: nil,
+        fixture: nil
+    }
+
+    def initialize
+      reset!
+    end
+
+    def configure_rspec_metadata!
+      unless @rspec_metadata_configured
+        RSpecRcv::RSpec::Metadata.configure!
+        @rspec_metadata_configured = true
+      end
+    end
+
+    def reset!
+      @opts = DEFAULTS.dup
+    end
+
+    def opts(overrides={})
+      @opts.merge(overrides)
+    end
+
+    def exportable_proc
+      @opts[:exportable_proc]
+    end
+
+    def exportable_proc=(val)
+      @opts[:exportable_proc] = val
+    end
+
+    def export_with
+      @opts[:export_with]
+    end
+
+    def export_with=(val)
+      @opts[:export_with] = val
+    end
+
+    def compare_with
+      @opts[:compare_with]
+    end
+
+    def compare_with=(val)
+      @opts[:compare_with] = val
+    end
+
+    def base_path
+      @opts[:base_path]
+    end
+
+    def base_path=(val)
+      @opts[:base_path] = val
+    end
+
+    def fail_on_changed_output
+      @opts[:fail_on_changed_output]
+    end
+
+    def fail_on_changed_output=(val)
+      @opts[:fail_on_changed_output] = val
+    end
+  end
+end

data/lib/rspec-rcv/data_changed_error.rb

@@ -0,0 +1,3 @@
+module RSpecRcv
+  DataChangedError = Class.new(StandardError)
+end

data/lib/rspec-rcv/handler.rb

@@ -0,0 +1,63 @@
+require 'json'
+require 'diffy'
+
+module RSpecRcv
+  class Handler
+    def initialize(file_path, data, metadata: {})
+      @file_path = file_path
+      @opts = RSpecRcv.config(metadata)
+      @data = data.call(@opts)
+    end
+
+    def call
+      return if existing_data && existing_data["file"] == file_path && existing_data["data"] == data
+
+      output = { recorded_at: Time.now, file: file_path, data: data }
+      output = opts[:export_with].call(output) + "\n"
+
+      if existing_data
+        eq = opts[:compare_with].call(existing_data["data"], data)
+
+        if !eq && opts[:fail_on_changed_output]
+          diff = Diffy::Diff.new(existing_file, output)
+          raise RSpecRcv::DataChangedError.new("Existing data will be overwritten. Turn off this feature with fail_on_changed_output=false\n\n#{diff}")
+        end
+
+        return if eq
+      end
+
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        file.write(output)
+      end
+    end
+
+    private
+
+    attr_reader :file_path, :data, :opts
+
+    def path
+      if opts[:base_path]
+        File.join(opts[:base_path], opts[:fixture])
+      else
+        opts[:fixture]
+      end
+    end
+
+    def existing_file
+      @existing_file ||= if File.exists?(path)
+                           File.read(path)
+                         end
+    end
+
+    def existing_data
+      @existing_data ||= if File.exists?(path)
+                           begin
+                             JSON.parse(File.read(path))
+                           rescue JSON::ParserError
+                             # The file must not have been valid, so we will overwrite it
+                           end
+                         end
+    end
+  end
+end

data/lib/rspec-rcv/test_frameworks/rspec.rb

@@ -0,0 +1,21 @@
+module RSpecRcv
+  module RSpec
+    module Metadata
+      extend self
+
+      def configure!
+        ::RSpec.configure do |config|
+          when_tagged_with_rcv = { rcv: lambda { |val| !!val } }
+
+          config.after(:each, when_tagged_with_rcv) do |ex|
+            example = ex.respond_to?(:metadata) ? ex : ex.example
+            opts = example.metadata[:rcv]
+            data_proc = lambda { |opts| instance_eval(&opts[:exportable_proc]) }
+
+            Handler.new(ex.file_path, data_proc, metadata: opts).call
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec-rcv/version.rb

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

data/rspec-rcv.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-rcv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-rcv"
+  spec.version       = RSpecRcv::VERSION
+  spec.authors       = ["Stephen Bussey"]
+  spec.email         = ["steve.bussey@salesloft.com"]
+
+  spec.summary       = %q{Export results of rspec tests to disk for integration testing.}
+  spec.homepage      = "https://github.com/SalesLoft/rspec-rcv"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "rspec"
+  spec.add_runtime_dependency "diffy"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: rspec-rcv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Bussey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- steve.bussey@salesloft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec-rcv.rb
+- lib/rspec-rcv/configuration.rb
+- lib/rspec-rcv/data_changed_error.rb
+- lib/rspec-rcv/handler.rb
+- lib/rspec-rcv/test_frameworks/rspec.rb
+- lib/rspec-rcv/version.rb
+- rspec-rcv.gemspec
+homepage: https://github.com/SalesLoft/rspec-rcv
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Export results of rspec tests to disk for integration testing.
+test_files: []