spec_marker 0.0.1

data/.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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,10 @@
+script: "rake spec"
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-18mode
+  - jruby-19mode
+  - ruby-head
+  - 1.8.7
+  - ree

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Shota Fukumori
+
+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,86 @@
+# SpecMarker - RSpec formatter that useful for profiling
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spec_marker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spec_marker
+
+## Usage
+
+### Basic
+
+```
+# to STDOUT
+$ rspec --format SpecMarker ...
+
+# to a File
+$ rspec --format SpecMarker --out spec_marker.log ...
+$ cat spec_marker.log
+```
+
+### Log File
+
+Log file is like this:
+
+```
+[suite:start][1355121779.69578] {"tag":"suite","at":1355121779.6957781,"meta":{},"kind":"start"}
+[example_group:start][1355121779.69596] {"tag":"example_group","at":1355121779.695959,"meta":{"description":"foo"},"kind":"start"}
+[example:start][1355121779.69616] {"tag":"example","at":1355121779.6961558,"meta":{"location":"./a_spec.rb:2","description":"hello"},"kind":"start"}
+[example:end][1355121781.69764 (2.00148)] {"tag":"example","at":1355121781.6976361,"meta":{"location":"./a_spec.rb:2","description":"hello","result":"passed"},"kind":"end","elapsed":2.0014803409576416}
+...
+```
+
+Each line is:
+
+```
+[TAG][TIMESTAMP (ELAPSED TIME)] JSON
+```
+
+### Marking
+
+``` ruby
+describe "foo" do
+  it "hello" do
+    sleep 2
+  end
+
+  context "bar" do
+    it "hello" do
+      # Use SpecMarker.mark to mark the time on the log.
+      SpecMarker.mark :foo
+      #=> [foo][1355121541.62746] {"tag":"foo","at":1355121541.627462,"meta":{},"kind":null}
+
+      # You can pass additional data to record in JSON.
+      SpecMarker.mark :foo, meta: :data
+      #=> [foo][1355121541.62750] {"tag":"foo","at":1355121541.627502,"meta":{"meta":"data"},"kind":null}
+    end
+
+    it "hello" do
+      # You can record an elapsed time of any parts.
+      SpecMarker.mark :bar, :start
+      #=> [bar:start][1355121781.69903] {"tag":"bar","at":1355121781.699029,"meta":{},"kind":"start"}
+      sleep 1
+
+      # Then call with :end to record elapsed time.
+      SpecMarker.mark :bar, :end
+      #=> [bar:end][1355121782.70022 (1.00119)] {"tag":"bar","at":1355121782.700217,"meta":{},"kind":"end","elapsed":1.001188039779663}
+      sleep 1
+    end
+
+    it "hello" do
+      # You can also pass the metadata.
+      SpecMarker.mark :bar, {meta: :data}, :start
+      SpecMarker.mark :bar, {meta: :data}, :end
+    end
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+

data/lib/spec_marker.rb

@@ -0,0 +1,102 @@
+require 'rubygems'
+require 'rspec/core/formatters/base_formatter'
+require 'json'
+
+class SpecMarker < RSpec::Core::Formatters::BaseFormatter
+  VERSION = "0.0.1"
+
+  class << self
+    def mark(*args)
+      @listeners.each do |listener|
+        listener.mark *args
+      end
+      self
+    end
+
+    def _join(formatter)
+      @listeners ||= []
+      @listeners << formatter unless @listeners.include?(formatter)
+    end
+
+    def _leave(formatter)
+      (@listeners ||= []).delete formatter
+    end
+  end
+
+  def initialize(*args)
+    super
+    @marks = []
+  end
+
+  def start(example_count)
+    super
+    self.class._join(self)
+    mark :suite, :start
+  end
+
+  def stop
+    super
+    self.class._leave(self)
+    mark :suite, :end
+  end
+
+  def mark(tag, meta_or_kind={}, kind=nil, meta_for_search=nil)
+    if meta_or_kind.is_a?(Hash)
+      meta = meta_or_kind
+    elsif kind.nil? && meta_or_kind.is_a?(Symbol)
+      meta = {}
+      kind = meta_or_kind
+    end
+
+    m = {:tag => tag, :at => Time.now.to_f, :meta => meta, :kind => kind}
+    if kind == :end
+      start = @marks.reverse_each.find { |mark| mark[:kind] == :start && mark[:tag] == tag && mark[:meta] == (meta_for_search || meta)}
+      if start
+        m[:elapsed] = m[:at] - start[:at]
+      end
+    end
+
+    @marks << m
+    output.puts "[#{tag}#{kind && ":#{kind}"}][#{"%.5f" % m[:at]}#{m[:elapsed] && (" (%.5f)" % m[:elapsed])}] #{m.to_json}"
+  end
+
+  def example_group_started(group)
+    super
+    mark :example_group, example_group_meta(group), :start
+  end
+
+  def example_started(example)
+    super
+    mark :example, example_meta(example), :start
+  end
+
+  def example_passed(example)
+    super
+    mark :example, example_meta(example, :passed), :end, example_meta(example)
+  end
+
+  def example_pending(example)
+    super
+    mark :example, example_meta(example, :pending), :end, example_meta(example)
+  end
+
+  def example_failed(example)
+    super
+    mark :example, example_meta(example, :failed), :end, example_meta(example)
+  end
+
+  def example_group_finished(group)
+    super
+    mark :example_group, example_group_meta(group), :end
+  end
+
+  private
+
+  def example_group_meta(group)
+    {:description => group.description}
+  end
+
+  def example_meta(example, result = nil)
+    {:location => example.location, :description => example.description}.merge(result ? {:result => result} : {})
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/spec_marker_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+require 'spec_marker'
+require 'stringio'
+require 'json'
+
+describe SpecMarker do
+  let(:output) { StringIO.new }
+  let(:formatter) do
+    SpecMarker.new(output).tap do |formatter|
+      formatter.start(2)
+    end
+  end
+
+  let(:time) { Time.now }
+
+  before do
+    Time.stub(now: time)
+  end
+
+  subject { output.string.split(/\n/) }
+
+  describe "marking" do
+    let(:example_group1) { RSpec::Core::ExampleGroup.describe }
+    let(:example1_1) { RSpec::Core::ExampleGroup.example }
+    let(:example1_2) { RSpec::Core::ExampleGroup.example }
+
+    let(:example_group2) { RSpec::Core::ExampleGroup.describe }
+    let(:example2_1) { RSpec::Core::ExampleGroup.example }
+
+    before do
+      formatter.example_group_started(example_group1)
+      formatter.example_started(example1_1)
+      Time.stub(now: Time.now + 10)
+      formatter.example_passed(example1_1)
+      formatter.example_started(example1_2)
+      formatter.example_failed(example1_1)
+      formatter.example_group_finished(example_group1)
+      formatter.example_group_started(example_group2)
+      formatter.example_started(example2_1)
+      formatter.example_pending(example2_1)
+      formatter.example_group_finished(example_group2)
+    end
+
+    it { should have(10).lines }
+
+    it "records JSON per line" do
+      expect {
+        subject.each { |line| JSON.parse(line) }
+      }.to_not raise_error
+    end
+
+    it "records timestamp" do
+      json = JSON.parse(subject[0])
+      json['at'].should == time.to_f
+      json['elapsed'].should == 10
+    end
+  end
+
+  describe "data" do
+    before do
+      formatter.example_group_started(example_group)
+      formatter.example_started(example)
+      SpecMarker.mark(:foo, {meta: :data})
+      SpecMarker.mark(:bar, {meta: :meta}, :start)
+      SpecMarker.mark(:bar, {meta: :meta}, :end)
+      SpecMarker.mark(:bar, {meta: :foo}, :start)
+      SpecMarker.mark(:bar, {meta: :foo}, :end)
+      SpecMarker.mark(:bar) do
+      end
+      formatter.example_passed(example)
+      formatter.example_group_finished(example_group)
+    end
+
+    it { should have(11).lines }
+  end
+end

data/spec_marker.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+#require 'spec_marker'
+
+Gem::Specification.new do |gem|
+  gem.name          = "spec_marker"
+  gem.version       = "0.0.1"
+  gem.authors       = ["Shota Fukumori (sora_h)"]
+  gem.email         = ["sorah@tubusu.net"]
+  gem.description   = %q{Mark the timestamp of RSpec example starts/ends, and log other stuff for profiling}
+  gem.summary       = %q{Mark the timestamp of RSpec example starts/ends, and log other stuff for profiling.}
+  gem.homepage      = "https://github.com/sorah/spec_marker"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency 'rspec'
+  gem.add_dependency 'json'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: spec_marker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Shota Fukumori (sora_h)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mark the timestamp of RSpec example starts/ends, and log other stuff
+  for profiling
+email:
+- sorah@tubusu.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spec_marker.rb
+- spec/spec_helper.rb
+- spec/spec_marker_spec.rb
+- spec_marker.gemspec
+homepage: https://github.com/sorah/spec_marker
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Mark the timestamp of RSpec example starts/ends, and log other stuff for
+  profiling.
+test_files:
+- spec/spec_helper.rb
+- spec/spec_marker_spec.rb