rspec-log_split 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5cfa9a2c014cdb42432ed297b6b897b820439434
+  data.tar.gz: e17667ebffecdc092667bac01fda8b2ac8a12d8c
+SHA512:
+  metadata.gz: a4c517387368117d737aa329c1b80377c0e05fb8fdb48d9bcc7b86c887ac5ca4706c24720618e851074670629628a4aab6eac1c0350fa49c1ec0ab60a925d496
+  data.tar.gz: 067283ce6ab856860ed27152136071d2ce46f847f8b4afbac48aa35f133200e45526363d08771b64fbf8194708185e9168db00e86938cfae89146e85844fa11c

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+log

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--backtrace
+--default_path spec

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rspec"
+gem "pry"
+gem "pry-nav"

data/README.md

@@ -0,0 +1,38 @@
+# Log Splitter for RSpec
+
+This `RSpec` plugin allows you to change the logger for your library for each
+separate example. This gives the ability to see the log output for each
+specific test.
+
+## Usage
+
+Currently you must have a `class` or `module` which responds to two methods.
+For example, `Rails` responds correctly:
+* `Rails.logger`
+* `Rails.logger=`
+
+In your `Gemfile`:
+
+``` ruby
+gem "rspec-log_split"
+```
+
+In your `spec/spec_helper.rb`:
+
+``` ruby
+require "rspec/log_split"
+
+RSpec.configure do |config|
+  config.log_split_dir    = File.expand_path("../../log/#{Time.now.iso8601}", __FILE__)
+  config.log_split_module = Rails
+end
+```
+
+You will get a log file for each example as follows:
+```
+log/2013-10-05T00:47:14+13:00/main
+log/2013-10-05T00:47:14+13:00/spec/demo_spec.rb:5
+log/2013-10-05T00:47:14+13:00/spec/demo_spec.rb:9
+log/2013-10-05T00:47:14+13:00/spec/support/shared_examples/win.rb:2
+log/2013-10-05T00:47:14+13:00/spec/support/shared_examples/win.rb:7
+```

data/lib/rspec/log_split.rb

@@ -0,0 +1,86 @@
+require 'logger'
+require 'pathname'
+
+module RSpec
+  module LogSplit
+    class MyExample
+      def initialize(logger, mod, example, example_logger)
+        @logger = logger
+        @mod = mod
+        @example = example
+        @example_logger = example_logger
+      end
+
+      def run
+        @mod.logger = @example_logger
+        begin
+          error "starting #{description}"
+          yield
+        rescue Exception => e
+          error "error with #{description}: #{e.inspect}"
+          raise e
+        ensure
+          error "finishing #{description}"
+          @mod.logger = nil
+        end
+      end
+
+      def description
+        @example.full_description
+      end
+
+      def error(message)
+        @logger.error message
+        @mod.logger.error message
+      end
+    end
+
+    class Config
+      def initialize(mod, dir)
+        @mod = mod
+
+        @path = Pathname.new(dir)
+        @path.mkpath
+        @logger = logger(@path.join("main"))
+      end
+
+      def run(example, &block)
+        example_path = @path.join(example.location)
+        example_path.parent.mkpath
+        example_logger = logger(example_path.to_path)
+        MyExample.new(@logger, @mod, example, example_logger).run(&block)
+      end
+
+      def logger(path)
+        file = File.open(path, "a")
+        file.sync = true
+        Logger.new(file)
+      end
+    end
+
+    def self.apply
+      RSpec.configure do |config|
+        config.add_setting :log_split_module
+        config.add_setting :log_split_dir
+        config.add_setting :log_split
+
+        config.before(:suite) do
+          RSpec.configuration.log_split= Config.new(
+            RSpec.configuration.log_split_module,
+            RSpec.configuration.log_split_dir,
+          )
+        end
+
+        config.around(:each) do |block|
+          RSpec.configuration.log_split.run(example, &block)
+        end
+
+        config.after(:suite) do
+          MyExample.list_logs if $DEBUG
+        end
+      end
+    end
+  end
+end
+
+RSpec::LogSplit.apply

data/rspec-log_split.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-log_split"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Tim Carey-Smith"]
+  spec.email         = ["tim@spork.in"]
+  spec.description   = %q{A new logger for each example}
+  spec.summary       = %q{Separate the logs between examples to allow for easier understanding}
+  spec.homepage      = "https://github.com/halorgium/rspec-log_split"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+end

data/spec/demo_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe "foo" do
+  context "bar" do
+    it "baz" do
+      Demo.logger.info "bar"
+    end
+
+    it "qux" do
+      Demo.logger.info "qux"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'pry'
+
+require 'rspec/log_split'
+
+Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
+
+RSpec.configure do |config|
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+
+  config.log_split_module = Demo
+  config.log_split_dir = File.expand_path("../../log", __FILE__)
+end

data/spec/support/demo.rb

@@ -0,0 +1,5 @@
+class Demo
+  class << self
+    attr_accessor :logger
+  end
+end

data/spec/support/shared_examples/win.rb

@@ -0,0 +1,11 @@
+shared_examples "win" do
+  it "works" do
+    Demo.logger.info "works"
+  end
+
+  context "mainframe" do
+    it "hacks" do
+      Demo.logger.info "hacks"
+    end
+  end
+end

data/spec/things_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe "things" do
+  include_examples "win"
+end

data/spec/zebra_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe "zebra" do
+  include_examples "win"
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: rspec-log_split
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tim Carey-Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-04 00:00:00.000000000 Z
+dependencies: []
+description: A new logger for each example
+email:
+- tim@spork.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- lib/rspec/log_split.rb
+- rspec-log_split.gemspec
+- spec/demo_spec.rb
+- spec/spec_helper.rb
+- spec/support/demo.rb
+- spec/support/shared_examples/win.rb
+- spec/things_spec.rb
+- spec/zebra_spec.rb
+homepage: https://github.com/halorgium/rspec-log_split
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Separate the logs between examples to allow for easier understanding
+test_files:
+- spec/demo_spec.rb
+- spec/spec_helper.rb
+- spec/support/demo.rb
+- spec/support/shared_examples/win.rb
+- spec/things_spec.rb
+- spec/zebra_spec.rb