example_group_timer 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+pkg

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/HISTORY.md

@@ -0,0 +1,5 @@
+# HISTORY
+
+## 0.0.1
+
+* First release.

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Arjan van der Gaag
+
+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,98 @@
+# ExampleGroupTimer
+
+A very simple formatter for RSpec 2 that outputs the time it took to run each
+example and example group in your spec suite, including its share in the total
+duration of its parent example group. Results are output sorted by share of
+total runtime. This allows you to find what parts of the spec suite take a long
+time to run, and where you should focus your efforts to optimize them.
+
+This gem is still very much a work-in-progress and I am still looking into a
+suitable report format. Also, the timing results are not as accurate as they
+could be, but exact timing or profiling is not really the point -- the point is
+to find spec suite bottlenecks.
+
+## Example output
+
+This is the output from using this formatter to run the specs of the
+[Rpub](http://avdgaag.github.com/rpub) gem. For brevity's sake, the output has
+been trimmed a little with `...`.
+
+    Total suite: 0.44007
+      Rpub::Epub::Content                                        0.10308 23.4%
+        with an empty book                                       0.05358 52.0%
+          should have xpath "/xmlns:package/xmlns:metadata/dc:ri 0.02777 51.8%
+          should have xpath "/xmlns:package[@unique-identifier=\ 0.00328  6.1%
+          should have xpath "/xmlns:package/xmlns:metadata/dc:ti 0.00325  6.1%
+          should have xpath "/xmlns:package/xmlns:metadata/dc:pu 0.00320  6.0%
+          ...
+        when the book has a cover                                0.02155 20.9%
+          should have xpath "/xmlns:package/xmlns:metadata/xmlns 0.00440 20.4%
+          should have xpath "/xmlns:package/xmlns:guide/xmlns:re 0.00433 20.1%
+          should have xpath "/xmlns:package/xmlns:manifest/xmlns 0.00431 20.0%
+          ...
+        when the book has chapters                               0.00813  7.9%
+          should have xpath "/xmlns:package/xmlns:manifest/xmlns 0.00412 50.7%
+          should have xpath "/xmlns:package/xmlns:spine[@toc=\"n 0.00386 47.5%
+        ...
+      Rpub::Chapter                                              0.10110 23.0%
+        markdown parsing                                         0.07441 73.6%
+          to_html                                                0.07436 99.9%
+            should == "<p>foo</p>\n"                             0.07425 99.9%
+        #outline                                                 0.00912  9.0%
+          when there are no headings                             0.00487 53.4%
+            outline                                              0.00374 76.8%
+              should be empty                                    0.00364 97.3%
+            outline                                              0.00105 21.6%
+              should have 0 elements                             0.00097 92.4%
+      ...
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+    group :test do
+      gem 'example_group_timer'
+    end
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install example_group_timer
+
+## Usage
+
+From the command line or in your `.rspec` file, if you have added it to your Gemfile:
+
+    bundle exec rspec -f ExampleGroupTimer::Formatter
+
+If installed manually, you will need to require the gem first:
+
+    rspec -r example_group_timer -f ExampleGroupTimer::Formatter
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+### Issues
+
+Please report any issues, defects or suggestions in the [Github issue
+tracker](https://github.com/avdgaag/example_group_timer/issues).
+
+### What has changed?
+
+See the [HISTORY](https://github.com/avdgaag/example_group_timer/blob/master/HISTORY.md) file for a detailed changelog.
+
+### Credits
+
+Created by: Arjan van der Gaag  
+URL: [http://arjanvandergaag.nl](http://arjanvandergaag.nl)  
+Project homepage: [https://github.com/avdgaag/example_group_timer](https://github.com/avdgaag/example_group_timer)  
+Date: april 2012  
+License: [MIT-license](https://github.com/avdgaag/example_group_timer/blob/master/LICENSE) (same as Ruby)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/example_group_timer.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'example_group_timer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'example_group_timer'
+  gem.version       = ExampleGroupTimer::VERSION
+  gem.authors       = ['Arjan van der Gaag']
+  gem.email         = ['arjan@arjanvandergaag.nl']
+  gem.description   = %q{RSpec formatter to measure run times of individual example groups}
+  gem.summary       = <<-EOS
+Report the time it takes to run each example group in your spec suite, and what
+share of its parent group runtime it represents. Useful for finding where to
+optimize your spec suite first.
+EOS
+  gem.homepage      = 'https://github.com/avdgaag/example_group_timer'
+
+  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_development_dependency 'rake'
+  gem.add_dependency 'rspec'
+end

data/lib/example_group_timer/formatter.rb

@@ -0,0 +1,53 @@
+module ExampleGroupTimer
+  class Formatter < RSpec::Core::Formatters::ProgressFormatter
+    attr_reader :groups
+    attr_accessor :current_group
+
+    def initialize(output)
+      super
+      self.current_group = RootTimedGroup.new
+    end
+
+    def example_group_started(group)
+      super
+      g = current_group.add_group(group)
+      self.current_group = g
+    end
+
+    def example_group_finished(group)
+      super
+      current_group.finish
+      self.current_group = current_group.parent
+    end
+
+    def example_started(example)
+      super
+      current_group.add_example example
+    end
+
+    def example_pending(example)
+      super
+      current_group.finish_current_example
+    end
+
+    def example_failed(example)
+      super
+      current_group.finish_current_example
+    end
+
+    def example_passed(example)
+      super
+      current_group.finish_current_example
+    end
+
+    def stop
+      super
+      current_group.finish
+    end
+
+    def dump_summary(*args)
+      current_group.report
+      super
+    end
+  end
+end

data/lib/example_group_timer/root_timed_group.rb

@@ -0,0 +1,15 @@
+module ExampleGroupTimer
+  class RootTimedGroup < TimedGroup
+    def initialize
+      super(nil)
+    end
+
+    def indent
+      0
+    end
+
+    def report_header
+      puts "Total suite: #{duration}"
+    end
+  end
+end

data/lib/example_group_timer/timed_group.rb

@@ -0,0 +1,32 @@
+module ExampleGroupTimer
+  class TimedGroup < TimedItem
+    attr_reader :subgroups, :examples, :current_example
+
+    def initialize(*args)
+      super
+      @subgroups, @examples = [], []
+    end
+
+    def add_group(group)
+      g = TimedGroup.new(group, self)
+      @subgroups << g
+      g
+    end
+
+    def add_example(example)
+      @current_example = TimedItem.new(example, self)
+      examples << @current_example
+    end
+
+    def finish_current_example
+      @current_example.finish
+      @current_example = nil
+    end
+
+    def report
+      report_header
+      examples.sort_by { |o| o.duration }.reverse.each(&:report_header)
+      subgroups.sort_by { |o| o.duration }.reverse.each(&:report)
+    end
+  end
+end

data/lib/example_group_timer/timed_item.rb

@@ -0,0 +1,35 @@
+module ExampleGroupTimer
+  class TimedItem
+    attr_reader :item, :parent
+
+    def initialize(item, parent = nil)
+      @item, @parent = item, parent
+      start
+    end
+
+    def start
+      @started_at = Time.now
+    end
+
+    def finish
+      @finished_at = Time.now
+    end
+
+    def duration
+      '%.5f' % [@finished_at - @started_at]
+    end
+
+    def indent
+      parent.indent + 1
+    end
+
+    def percentage
+      ('%.1f%' % [(duration.to_f / parent.duration.to_f) * 100]).rjust(5)
+    end
+
+    def report_header
+      truncated = (('  ' * indent) + item.description.strip)[0..59].ljust(60)
+      puts "#{truncated} #{duration} #{percentage}"
+    end
+  end
+end

data/lib/example_group_timer/version.rb

@@ -0,0 +1,3 @@
+module ExampleGroupTimer
+  VERSION = '0.0.1'
+end

data/lib/example_group_timer.rb

@@ -0,0 +1,8 @@
+require 'rspec/core/formatters/progress_formatter'
+require 'example_group_timer/version'
+require 'example_group_timer/timed_item'
+require 'example_group_timer/timed_group'
+require 'example_group_timer/root_timed_group'
+
+module ExampleGroupTimer
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: example_group_timer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Arjan van der Gaag
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: RSpec formatter to measure run times of individual example groups
+email:
+- arjan@arjanvandergaag.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- HISTORY.md
+- LICENSE
+- README.md
+- Rakefile
+- example_group_timer.gemspec
+- lib/example_group_timer.rb
+- lib/example_group_timer/formatter.rb
+- lib/example_group_timer/root_timed_group.rb
+- lib/example_group_timer/timed_group.rb
+- lib/example_group_timer/timed_item.rb
+- lib/example_group_timer/version.rb
+homepage: https://github.com/avdgaag/example_group_timer
+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: Report the time it takes to run each example group in your spec suite, and
+  what share of its parent group runtime it represents. Useful for finding where to
+  optimize your spec suite first.
+test_files: []
+has_rdoc: