test_assistant 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c14c4c6d990513adb024b4571090c7fc85dca59
+  data.tar.gz: 1ab16e504b25feca6a2d2ab443684d4512e4a67e
+SHA512:
+  metadata.gz: 8361c96e295b176daf5c9aba592217be43174ba39876094fc5f7423e9f2ddfe14db46fc8e7b424b8ede85c8035c8f5b78074222f10a6be8631aea60a74e59577
+  data.tar.gz: 33107a1cc37d9ffd6d645b02206699c0d8f6afdb392fbf76b1e2a72cbc1fb7d0efa49294c010f58a6a8da415b72962bb72d6f9a74a5126ceff09c95fb30c2fcf

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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Aleck Greenham
+
+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,93 @@
+# TestAssistant
+
+A collection of testing tools, hacks, and utilities for writing and fixing tests faster
+
+## Stability
+
+TestAssistant is in its infancy and should be considered unstable. The API and behaviour is likely to change. 
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    group :test do
+      gem 'test_assistant'
+    end
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install test_assistant
+
+## Usage
+
+Test assistant requires access to the RSpec configuration object, so add the following to either `rails_helper.rb` or `spec_helper.rb`:
+
+```ruby
+RSpec.configure do |config|
+  # other rspec configuration
+  
+  TestAssistant.configure(config) do |ta_config|
+    # test assistant configuration here
+  end
+end
+```
+
+### Rendering a response context when a test fails
+
+Test assistant can automatically render the server response in your browser when a test fails and you have applied a nominated tag. 
+
+```ruby
+TestAssistant.configure(config) do |ta_config|
+  ta_config.render_failed_responses tag: :focus, type: :request
+end
+```
+
+```ruby
+RSpec.describe 'making some valid request', type: :request do
+  context 'some important context' do
+    it 'should return a correct result', focus: true do
+      # failing assertions
+    end
+  end
+end
+```
+
+### Invoking a debugger when a test fails
+
+It's possible to invoke a debugger (`pry` is default, but fallback is to `byebug` and then `debugger`) if a test fails. This gives you access to some of the scope that the failing test ran in, allowing you to inspect objects and test variations of the failing assertion.
+
+The `debug_failed_responses` accepts a the following options:
+
+* `tag: :<tag_name>` (default is `:debugger`) 
+* `type: :<spec_type>` (default: nil - matches all test types) options. 
+
+```ruby
+TestAssistant.configure(config) do |ta_config|
+    ta_config.include_json_helpers type: :request
+
+    ta_config.debug_failed_responses tag: :debugger
+  end
+```
+
+```ruby
+RSpec.describe 'making some valid request', type: :request do
+  context 'some important context' do
+    it 'should return a correct result', debugger: true do
+      # failing assertions
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/test_assistant/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/test_assistant/configuration.rb

@@ -0,0 +1,51 @@
+module TestAssistant
+  autoload :JSONHelpers, 'test_assistant/json_helpers'
+  autoload :FailureReporter, 'test_assistant/failure_reporter'
+
+  class Configuration
+    def initialize(rspec_config)
+      @rspec_config = rspec_config
+    end
+
+    def include_json_helpers(options = {})
+      @rspec_config.include JSONHelpers, options
+    end
+
+    def render_failed_responses(options = {})
+      tag_filter = options[:tag]
+      no_tag_filter = !tag_filter
+      type_filter = options[:type]
+      no_type_filter = !type_filter
+
+      @rspec_config.after(:each) do |example|
+        if example.exception
+          if (example.metadata[tag_filter] || no_tag_filter) && (example.metadata[:type] == type_filter || no_type_filter)
+            reporter = FailureReporter.report(request, response)
+            reporter.write
+            reporter.open
+          end
+        end
+      end
+    end
+
+    def debug_failed_responses(options = {})
+      tag_filter = options.fetch(:tag, :debugger)
+      type_filter = options[:type]
+      no_type_filter = !type_filter
+
+      @rspec_config.after(:each) do |example|
+        if example.exception
+          if (example.metadata[tag_filter]) && (example.metadata[:type] == type_filter || no_type_filter)
+            if defined? binding
+              binding.pry
+            elsif defined? byebug
+              byebug
+            else
+              debugger
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_assistant/failure_reporter.rb

@@ -0,0 +1,95 @@
+module TestAssistant
+  class FailureReporter
+    class SummaryReporter
+      attr_accessor :next, :file_extension
+
+      def initialize(request, response, extension = file_extension)
+        @request, @response, @extension = request, response, extension
+      end
+
+      def write
+        File.open(file_path, 'w') do |file|
+          file.write(summary)
+        end
+      end
+
+      def open
+        system "open #{file_path}"
+      end
+
+      def summary
+        @response.body
+      end
+
+      protected
+
+      def file_path
+        @file_path ||= "#{Rails.root}/tmp/#{DateTime.now.to_i}.#{@extension}"
+      end
+    end
+
+    class JsonReporter < SummaryReporter
+      protected
+
+      def summary
+        parsed_json =
+          begin
+            JSON.parse(@response.body)
+          rescue JSON::ParserError
+            @response.body
+          end
+
+        {
+            request: {
+                path: @request.path,
+                cookies: @request.cookies,
+                content_type: @request.content_type,
+                format: @request.format,
+                referrer: @request.referrer
+            },
+            response: {
+                status: "#{@response.status} #{@response.status_message}",
+                cookies: @response.cookies,
+                redirect_url: @response.redirect_url
+            },
+            headers: @response.headers.to_h,
+            body: parsed_json
+        }.to_json
+      end
+
+      def file_extension
+        'json'.freeze
+      end
+    end
+
+    class TextReporter < SummaryReporter
+      protected
+
+      def summary
+        "<pre>#{@response.body}</pre>"
+      end
+
+      def file_extension
+        'html'.freeze
+      end
+    end
+
+    def self.report(request, response)
+      extension = file_extension(response.content_type)
+
+      case extension
+        when 'txt'
+          TextReporter.new(request, response)
+        when 'json'
+          JsonReporter.new(request, response)
+        else
+          SummaryReporter.new(request, response, extension)
+      end
+    end
+
+    def self.file_extension(content_type)
+      MIME::Types[content_type].first.extensions.first
+    end
+
+  end
+end

data/lib/test_assistant/json_helpers.rb

@@ -0,0 +1,9 @@
+module TestAssistant::JSONHelpers
+  def json_response
+    begin
+      JSON.parse(response.body)
+    rescue JSON::ParserError
+      '< INVALID JSON RESPONSE >'.freeze
+    end
+  end
+end

data/lib/test_assistant/version.rb

@@ -0,0 +1,3 @@
+module TestAssistant
+  VERSION = "0.0.1"
+end

data/lib/test_assistant.rb

@@ -0,0 +1,17 @@
+require "test_assistant/version"
+require 'test_assistant/configuration'
+
+module TestAssistant
+  class << self
+    def configure(rspec_config)
+      configuration = Configuration.new(rspec_config)
+
+      if block_given?
+        yield(configuration)
+      end
+    end
+
+    alias :config :configure
+  end
+
+end

data/test_assistant.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'test_assistant/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "test_assistant"
+  spec.version       = TestAssistant::VERSION
+  spec.authors       = ["Aleck Greenham"]
+  spec.email         = ["greenhama13@gmail.com"]
+  spec.summary       = "A toolbox for increased testing efficiency with RSpec"
+  spec.description   = "A collection of testing tools, hacks, and utilities for writing and fixing tests faster"
+  spec.homepage      = "https://github.com/greena13/test_assistant"
+  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_dependency "rspec-rails", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: test_assistant
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aleck Greenham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: 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'
+description: A collection of testing tools, hacks, and utilities for writing and fixing
+  tests faster
+email:
+- greenhama13@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/test_assistant.rb
+- lib/test_assistant/configuration.rb
+- lib/test_assistant/failure_reporter.rb
+- lib/test_assistant/json_helpers.rb
+- lib/test_assistant/version.rb
+- test_assistant.gemspec
+homepage: https://github.com/greena13/test_assistant
+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: A toolbox for increased testing efficiency with RSpec
+test_files: []