iterm2_tab_formatter 0.7.0

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/.travis.yml

@@ -0,0 +1,7 @@
+before_install: gem install bundler -v 1.3.2
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in iterm2_tab_formatter.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rake'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mark Rushakoff
+
+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,47 @@
+# Iterm2TabFormatter
+
+[![Build Status](https://travis-ci.org/mark-rushakoff/iterm2_tab_formatter.png)](https://travis-ci.org/mark-rushakoff/iterm2_tab_formatter)
+[![Code Climate](https://codeclimate.com/github/mark-rushakoff/iterm2_tab_formatter.png)](https://codeclimate.com/github/mark-rushakoff/iterm2_tab_formatter)
+
+An RSpec2 formatter that uses your iTerm2 tabs' color and titles to inform you of your spec status.
+
+iTerm2 Tab Formatter communicates your RSpec status through your iTerm2 tabs.
+By default, here's what it does:
+* Tab chrome color:
+  * Gray while spec is running/pending
+  * Red once a spec has failed
+  * Green if all the specs pass
+* Tab title:
+  * Index of current spec and total number of specs
+  * Percentage of specs that passed, after specs finish
+* Window title:
+  * Full spec name for the current spec
+  * Summary, duration, and finish time after specs finish
+
+(iterm2_tab_formatter is in no way affiliated with [iTerm2](https://github.com/gnachman/iTerm2) -- it was just made by a fan.)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'iterm2_tab_formatter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iterm2_tab_formatter
+
+## 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 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = %w(--format documentation --color)
+end
+
+task :default => :spec

data/iterm2_tab_formatter.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'iterm2_tab_formatter/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "iterm2_tab_formatter"
+  gem.version       = Iterm2TabFormatter::VERSION
+  gem.authors       = ["Mark Rushakoff"]
+  gem.email         = ["mark.rushakoff@gmail.com"]
+  gem.description   = %q{An RSpec2 formatter that uses your iTerm2 tabs' color and titles to inform you of your spec status.}
+  gem.summary       = <<-SUMMARY
+                        iTerm2 Tab Formatter communicates your RSpec status through your iTerm2 tabs.
+                        By default, here's what it does:
+                        * Tab chrome color:
+                          * Gray while spec is running/pending
+                          * Red once a spec has failed
+                          * Green if all the specs pass
+                        * Tab title:
+                          * Index of current spec and total number of specs
+                        * Window title:
+                          * Full spec name for the current spec
+                         SUMMARY
+  gem.homepage      = "https://github.com/mark-rushakoff/iterm2_tab_formatter"
+
+  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_runtime_dependency 'iterm2_escape', '~> 1.0'
+  gem.add_runtime_dependency 'rspec', '~> 2.13'
+end

data/lib/iterm2_tab_formatter.rb

@@ -0,0 +1,49 @@
+require 'iterm2_tab_formatter/base'
+require "iterm2_tab_formatter/version"
+require "iterm2_tab_formatter/controller"
+require "iterm2_tab_formatter/text_formatter"
+
+class Iterm2TabFormatter
+  attr_reader :controller
+
+  def initialize(output)
+    super
+    colors = {
+      suite_start: [128, 128, 128],
+      spec_fail: [255, 0, 0],
+      suite_pass: [0, 255, 0]
+    }
+    @controller = Iterm2TabFormatter::Controller.new(colors)
+  end
+
+  def start(example_count)
+    super
+    controller.apply_start_color
+  end
+
+  def example_failed(example)
+    super
+    controller.apply_fail_color
+  end
+
+  def example_started(example)
+    super
+
+    controller.window_title = example.description
+    controller.tab_title = "#{examples.size - 1}/#{example_count}"
+  end
+
+  def dump_summary(duration, example_count, failure_count, pending_count)
+    controller.apply_pass_color if failure_count == 0 && example_count > 0
+
+    pass_ratio = 1 - (1.0 * failure_count / example_count)
+    controller.tab_title = "#{pass_ratio * 100}% passed"
+
+    window_title = Iterm2TabFormatter::TextFormatter.window_title(8, 1, 2)
+    window_title << ' - '
+    window_title << Iterm2TabFormatter::TextFormatter.duration(duration)
+    window_title << ' - Finished at '
+    window_title << Iterm2TabFormatter::TextFormatter.finished_at(Time.now)
+    controller.window_title = window_title
+  end
+end

data/lib/iterm2_tab_formatter/auto.rb

@@ -0,0 +1,6 @@
+require 'iterm2_tab_formatter'
+require 'rspec/core/configuration'
+
+RSpec.configure do |c|
+  c.add_formatter(Iterm2TabFormatter)
+end

data/lib/iterm2_tab_formatter/base.rb

@@ -0,0 +1,9 @@
+# This file exists only so that we don't have to declare the base class
+# anywhere else.  This is why modules are usually used for the top level, but
+# in this case I think it has to be a class for RSpec to load the formatter
+# properly.
+
+require 'rspec/core/formatters/base_formatter'
+
+class Iterm2TabFormatter < RSpec::Core::Formatters::BaseFormatter
+end

data/lib/iterm2_tab_formatter/controller.rb

@@ -0,0 +1,30 @@
+require 'iterm2_tab_formatter/base'
+require 'iterm2_escape'
+
+class Iterm2TabFormatter
+  class Controller
+    def initialize(colors)
+      @colors = colors
+    end
+
+    def apply_start_color
+      Iterm2Escape::Tab.set_color(*@colors.fetch(:suite_start))
+    end
+
+    def apply_fail_color
+      Iterm2Escape::Tab.set_color(*@colors.fetch(:spec_fail))
+    end
+
+    def apply_pass_color
+      Iterm2Escape::Tab.set_color(*@colors.fetch(:suite_pass))
+    end
+
+    def tab_title=(title)
+      Iterm2Escape::Tab.title = title
+    end
+
+    def window_title=(title)
+      Iterm2Escape::Tab.window_title = title
+    end
+  end
+end

data/lib/iterm2_tab_formatter/text_formatter.rb

@@ -0,0 +1,35 @@
+require 'iterm2_tab_formatter/base'
+require 'time'
+
+class Iterm2TabFormatter
+  module TextFormatter
+    class << self
+      def window_title(example_count, failure_count, pending_count)
+        window_title = "#{example_count} example"
+        window_title << 's' unless example_count == 1
+
+        window_title << ", #{failure_count} failure" if failure_count > 0
+        window_title << 's' if failure_count > 1
+
+        window_title << ", #{pending_count} pending" if pending_count > 0
+
+        window_title
+      end
+
+      def finished_at(time)
+        time.iso8601
+      end
+
+      def duration(seconds)
+        text_minutes = (seconds / 60).to_i
+        text_seconds = (seconds % 60)
+
+        text = ''
+        text << "#{text_minutes}m" if text_minutes > 0
+        text << ("%.1fs" % text_seconds)
+
+        text
+      end
+    end
+  end
+end

data/lib/iterm2_tab_formatter/version.rb

@@ -0,0 +1,9 @@
+begin
+require 'iterm2_tab_formatter/base'
+rescue LoadError
+  warn "Couldn't load base class for Iterm2TabFormatter.  This might be okay if reading from the gemspec before running bundle install."
+end
+
+class Iterm2TabFormatter
+  VERSION = "0.7.0"
+end

data/sandbox/slow_spec.rb

@@ -0,0 +1,17 @@
+require 'rspec'
+require 'iterm2_tab_formatter/auto'
+
+RSpec.configure do |c|
+  c.add_formatter('documentation')
+end
+
+describe 'A slow test suite' do
+  it 'starts off gray' do
+    sleep 1
+  end
+
+  it 'turns green if ENV["PASS"] is set' do
+    sleep 1
+    expect(ENV['PASS'].to_s).not_to eq('')
+  end
+end

data/spec/controller_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'iterm2_tab_formatter/controller'
+
+describe Iterm2TabFormatter::Controller do
+  describe 'colors' do
+    let(:colors) do
+      {
+        suite_start: [128, 128, 128],
+        spec_fail: [255, 0, 0],
+        suite_pass: [0, 0, 255]
+      }
+    end
+
+    let(:controller) { described_class.new(colors) }
+
+    it 'sets the tab color to suite_start when starting suite' do
+      Iterm2Escape::Tab.should_receive(:set_color).with(128, 128, 128)
+      controller.apply_start_color
+    end
+
+    it 'sets the tab color to spec_fail on fail' do
+      Iterm2Escape::Tab.should_receive(:set_color).with(255, 0, 0)
+      controller.apply_fail_color
+    end
+
+    it 'sets the tab color to suite_pass when suite passed' do
+      Iterm2Escape::Tab.should_receive(:set_color).with(0, 0, 255)
+      controller.apply_pass_color
+    end
+  end
+  describe 'titles' do
+    let(:controller) { described_class.new({}) }
+
+    it 'sets the tab title' do
+      Iterm2Escape::Tab.should_receive('title=').with('foo bar')
+      controller.tab_title = 'foo bar'
+    end
+
+    it 'sets the window title' do
+      Iterm2Escape::Tab.should_receive('window_title=').with('foo bar')
+      controller.window_title = 'foo bar'
+    end
+  end
+end

data/spec/iterm2_tab_formatter_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'iterm2_tab_formatter'
+
+describe Iterm2TabFormatter do
+  let(:formatter) { described_class.new(nil).tap { |f| f.stub(:controller).and_return(controller) } }
+  let(:controller) { double }
+
+  it 'makes a controller when initialized' do
+    expect(described_class.new(nil).controller).to be_an(Iterm2TabFormatter::Controller)
+  end
+
+  it 'uses the start color when starting suite' do
+    controller.should_receive(:apply_start_color).with(no_args)
+
+    formatter.start(100)
+  end
+
+  it 'uses the fail color when a spec fails' do
+    controller.should_receive(:apply_fail_color).with(no_args)
+
+    formatter.example_failed(double)
+  end
+
+  describe 'at the end of the suite' do
+    before do
+      controller.stub(:apply_pass_color)
+      controller.stub(:tab_title=)
+      controller.stub(:window_title=)
+    end
+
+    describe 'color' do
+      it 'uses the pass color when the suite passes' do
+        controller.should_receive(:apply_pass_color).with(no_args)
+
+        formatter.dump_summary(1, 10, 0, 0)
+      end
+
+      it 'does not use the pass color when there are failures in the suite' do
+        controller.should_not_receive(:apply_pass_color)
+
+        formatter.dump_summary(1, 10, 1, 0)
+      end
+
+      it 'does not use the pass color if there were no examples' do
+        controller.should_not_receive(:apply_pass_color)
+
+        formatter.dump_summary(1, 0, 0, 0)
+      end
+    end
+
+    describe 'text' do
+      it 'sets the tab title to a summary of the specs' do
+        controller.should_receive(:tab_title=).with('87.5% passed')
+
+        formatter.dump_summary(1, 8, 1, 2)
+      end
+
+      it 'sets the window title through TextFormatter' do
+        Time.should_receive(:now).and_return('time_now')
+        Iterm2TabFormatter::TextFormatter.should_receive(:duration).with(5).and_return('the_duration')
+        Iterm2TabFormatter::TextFormatter.should_receive(:window_title).with(8, 1, 2).and_return('window_title')
+        Iterm2TabFormatter::TextFormatter.should_receive(:finished_at).with('time_now').and_return('finish_time')
+        controller.should_receive(:window_title=).with('window_title - the_duration - Finished at finish_time')
+
+        formatter.dump_summary(5, 8, 1, 2)
+      end
+    end
+  end
+
+  it 'sets the window title to the description of a spec' do
+    example = double("example", description: 'an example description')
+
+    controller.should_receive(:window_title=).with('an example description')
+    controller.should_receive(:tab_title=).with('0/100')
+
+    formatter.stub(example_count: 100)
+    formatter.example_started(example)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/text_formatter_spec.rb

@@ -0,0 +1,37 @@
+require 'iterm2_tab_formatter/text_formatter'
+
+describe Iterm2TabFormatter::TextFormatter do
+  describe '.window_title' do
+    ({
+      '1 example' => [1, 0, 0],
+      '3 examples' => [3, 0, 0],
+      '3 examples, 2 failures' => [3, 2, 0],
+      '8 examples, 1 failure, 2 pending' => [8, 1, 2],
+      '8 examples, 2 failures, 1 pending' => [8, 2, 1],
+      '8 examples, 1 pending' => [8, 0, 1],
+      '8 examples, 2 pending' => [8, 0, 2],
+    }).each do |expected_message, counts|
+      example_count, failure_count, pending_count = counts
+
+      it "is correct for #{example_count}/#{failure_count}/#{pending_count}" do
+        expect(described_class.window_title(example_count, failure_count, pending_count)).to eq(expected_message)
+      end
+    end
+  end
+
+  describe '.finished_at' do
+    it 'formats as ISO-8601 datetime' do
+      date = DateTime.new(2013, 3, 17, 19, 25, 0, '-7')
+      expect(described_class.finished_at(date)).to eq('2013-03-17T19:25:00-07:00')
+    end
+  end
+
+  describe '.duration' do
+    it 'correctly prints the time under a minute' do
+      expect(described_class.duration(1.1)).to eq('1.1s')
+    end
+    it 'correctly prints time over a minute' do
+      expect(described_class.duration(65)).to eq('1m5.0s')
+    end
+  end
+end

data/spec/version_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'iterm2_tab_formatter'
+
+describe Iterm2TabFormatter do
+  it "has a version" do
+    expect(Iterm2TabFormatter::VERSION).not_to be_nil
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: iterm2_tab_formatter
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+  prerelease: 
+platform: ruby
+authors:
+- Mark Rushakoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: iterm2_escape
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: An RSpec2 formatter that uses your iTerm2 tabs' color and titles to inform
+  you of your spec status.
+email:
+- mark.rushakoff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- iterm2_tab_formatter.gemspec
+- lib/iterm2_tab_formatter.rb
+- lib/iterm2_tab_formatter/auto.rb
+- lib/iterm2_tab_formatter/base.rb
+- lib/iterm2_tab_formatter/controller.rb
+- lib/iterm2_tab_formatter/text_formatter.rb
+- lib/iterm2_tab_formatter/version.rb
+- sandbox/slow_spec.rb
+- spec/controller_spec.rb
+- spec/iterm2_tab_formatter_spec.rb
+- spec/spec_helper.rb
+- spec/text_formatter_spec.rb
+- spec/version_spec.rb
+homepage: https://github.com/mark-rushakoff/iterm2_tab_formatter
+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'
+      segments:
+      - 0
+      hash: -928581428121591177
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -928581428121591177
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ! 'iTerm2 Tab Formatter communicates your RSpec status through your iTerm2
+  tabs. By default, here''s what it does: * Tab chrome color: * Gray while spec is
+  running/pending * Red once a spec has failed * Green if all the specs pass * Tab
+  title: * Index of current spec and total number of specs * Window title: * Full
+  spec name for the current spec'
+test_files:
+- spec/controller_spec.rb
+- spec/iterm2_tab_formatter_spec.rb
+- spec/spec_helper.rb
+- spec/text_formatter_spec.rb
+- spec/version_spec.rb