From d29ece1ee2738929481f9282c837b938a7442ae7 Mon Sep 17 00:00:00 2001 From: John Bintz Date: Fri, 20 Jan 2012 21:08:13 -0500 Subject: [PATCH] initial commit --- .gitignore | 17 +++++ Gemfile | 4 ++ LICENSE | 22 ++++++ README.md | 38 ++++++++++ Rakefile | 2 + capybara-rails-log-inspection.gemspec | 19 +++++ lib/capybara-rails-log-inspection.rb | 2 + lib/capybara-rails-log-inspection/version.rb | 8 +++ lib/capybara/rails-log-inspection.rb | 71 +++++++++++++++++++ lib/capybara/rails-log-inspection/cucumber.rb | 15 ++++ 10 files changed, 198 insertions(+) create mode 100644 .gitignore create mode 100644 Gemfile create mode 100644 LICENSE create mode 100644 README.md create mode 100644 Rakefile create mode 100644 capybara-rails-log-inspection.gemspec create mode 100644 lib/capybara-rails-log-inspection.rb create mode 100644 lib/capybara-rails-log-inspection/version.rb create mode 100644 lib/capybara/rails-log-inspection.rb create mode 100644 lib/capybara/rails-log-inspection/cucumber.rb diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d87d4be --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ +*.gem +*.rbc +.bundle +.config +.yardoc +Gemfile.lock +InstalledFiles +_yardoc +coverage +doc/ +lib/bundler/man +pkg +rdoc +spec/reports +test/tmp +test/version_tmp +tmp diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..3e51fa7 --- /dev/null +++ b/Gemfile @@ -0,0 +1,4 @@ +source 'https://rubygems.org' + +# Specify your gem's dependencies in capybara-rails-log-inspection.gemspec +gemspec diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..87b491e --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +Copyright (c) 2012 John Bintz + +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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..b845bb9 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# Capybara::RailsLogInspection + +Errors not bubbling up from your Rails app to Cucumber? Use this! + +``` ruby +# features/support/env.rb + +require 'capybara/rails-log-inspection/cucumber' +``` + +Exceptions and Rails logging (either `Rails.logger.warn` or `Rails.logger <<`) will pass through to Cucumber. +No more watching logs or any other nonsense! + +## Installation + +Add this line to your application's Gemfile: + + gem 'capybara-rails-log-inspection' + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install capybara-rails-log-inspection + +## Usage + +TODO: Write usage instructions here + +## Contributing + +1. Fork it +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Added some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create new Pull Request diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..f57ae68 --- /dev/null +++ b/Rakefile @@ -0,0 +1,2 @@ +#!/usr/bin/env rake +require "bundler/gem_tasks" diff --git a/capybara-rails-log-inspection.gemspec b/capybara-rails-log-inspection.gemspec new file mode 100644 index 0000000..1371b9d --- /dev/null +++ b/capybara-rails-log-inspection.gemspec @@ -0,0 +1,19 @@ +# -*- encoding: utf-8 -*- +require File.expand_path('../lib/capybara-rails-log-inspection/version', __FILE__) + +Gem::Specification.new do |gem| + gem.authors = ["John Bintz"] + gem.email = ["john@coswellproductions.com"] + gem.description = %q{TODO: Write a gem description} + gem.summary = %q{TODO: Write a gem summary} + gem.homepage = "" + + gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) } + gem.files = `git ls-files`.split("\n") + gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n") + gem.name = "capybara-rails-log-inspection" + gem.require_paths = ["lib"] + gem.version = Capybara::Rails::LogInspection::VERSION + + gem.add_runtime_dependency 'term-ansicolor' +end diff --git a/lib/capybara-rails-log-inspection.rb b/lib/capybara-rails-log-inspection.rb new file mode 100644 index 0000000..0bad394 --- /dev/null +++ b/lib/capybara-rails-log-inspection.rb @@ -0,0 +1,2 @@ +require "capybara-rails-log-inspection/version" + diff --git a/lib/capybara-rails-log-inspection/version.rb b/lib/capybara-rails-log-inspection/version.rb new file mode 100644 index 0000000..00f150c --- /dev/null +++ b/lib/capybara-rails-log-inspection/version.rb @@ -0,0 +1,8 @@ +module Capybara + module Rails + module LogInspection + VERSION = "0.0.1" + end + end +end + diff --git a/lib/capybara/rails-log-inspection.rb b/lib/capybara/rails-log-inspection.rb new file mode 100644 index 0000000..0723739 --- /dev/null +++ b/lib/capybara/rails-log-inspection.rb @@ -0,0 +1,71 @@ +require 'term/ansicolor' + +module Capybara + module RailsLogInspection + class << self + def logger_target + @logger_target ||= StringIO.new + end + + def logger(level = nil) + logger = Logger.new(logger_target) + logger.level = level || default_log_level + logger + end + + attr_writer :backtrace_clean_patterns, :default_log_level, :rack_log_level + + def default_log_level + Logger::WARN + end + + def rack_log_level + Logger::WARN + end + + def backtrace_clean_patterns + @backtrace_clean_patterns ||= [ %r{/gems/}, %r{/ruby/1} ] + end + + def clean_backtrace(exception) + exception.backtrace.reject { |line| line.empty? || backtrace_clean_patterns.any? { |pattern| line[pattern] } } + end + + def add_backtrace(exception) + clean_backtrace(exception).each { |line| logger_target << " #{line}\n" } + logger_target << "\n" + end + end + + def reset_logs + Capybara::RailsLogInspection.logger_target.rewind + Capybara::RailsLogInspection.logger_target.truncate(0) + end + + def output_logs(target = $stderr) + Capybara::RailsLogInspection.logger_target.rewind + + data = Capybara::RailsLogInspection.logger_target.read + target.print(Term::ANSIColor.red, data, Term::ANSIColor.reset) if !data.empty? + + reset_logs + end + end +end + +Rails.logger = Capybara::RailsLogInspection.logger + +Capybara.server do |app, port| + require 'rack/handler/webrick' + + responder = lambda { |request, response| + class << response + def set_error(ex, backtrace = false) + Capybara::RailsLogInspection.add_backtrace(ex) + end + end + } + + Rack::Handler::WEBrick.run(app, :Port => port, :AccessLog => [], :Logger => Capybara::RailsLogInspection.logger(Capybara::RailsLogInspection.rack_log_level), :RequestCallback => responder) +end + diff --git a/lib/capybara/rails-log-inspection/cucumber.rb b/lib/capybara/rails-log-inspection/cucumber.rb new file mode 100644 index 0000000..21ae9bd --- /dev/null +++ b/lib/capybara/rails-log-inspection/cucumber.rb @@ -0,0 +1,15 @@ +require 'capybara/rails-log-inspection' + +World(Capybara::RailsLogInspection) + +Before do + reset_logs +end + +AfterStep do + output_logs +end + +After do + output_logs +end