iterm2_tab_formatter 0.7.3 → 0.8.0

data/README.md

@@ -38,10 +38,21 @@ Or install it yourself as:
 
 Just add the following line to your spec_helper.rb file:
 
-    require 'iterm2_tab_formatter/auto'
+    require 'iterm2_tab_formatter/autoload'
 
 And then your iTerm2 tabs will participate in testing too!
 
+If you want to customize your colors:
+
+    RSpec.configure do |c|
+      # ugly monochrome
+      c.it2tf_neutral = '#7F7F7F' # gray
+      c.it2tf_pass = '#FFFFFF' # white
+      c.it2tf_fail = '#000000' # black
+    end
+
+    require 'iterm2_tab_formatter/autoload' # must be after configuration
+
 ## Contributing
 
 1. Fork it

data/lib/iterm2_tab_formatter.rb

@@ -1,7 +1,9 @@
 require 'iterm2_tab_formatter/base'
-require "iterm2_tab_formatter/version"
-require "iterm2_tab_formatter/controller"
-require "iterm2_tab_formatter/text_formatter"
+require 'iterm2_tab_formatter/version'
+require 'iterm2_tab_formatter/controller'
+require 'iterm2_tab_formatter/text_formatter'
+require 'iterm2_tab_formatter/color_parse'
+require 'iterm2_tab_formatter/rspec_configuration'
 
 class Iterm2TabFormatter
   attr_reader :controller
@@ -9,9 +11,9 @@ class Iterm2TabFormatter
   def initialize(output)
     super
     colors = {
-      suite_start: [128, 128, 128],
-      spec_fail: [255, 0, 0],
-      suite_pass: [0, 255, 0]
+      suite_start: color(:it2tf_neutral),
+      spec_fail: color(:it2tf_fail),
+      suite_pass: color(:it2tf_pass)
     }
     @controller = Iterm2TabFormatter::Controller.new(colors)
   end
@@ -39,13 +41,26 @@ class Iterm2TabFormatter
     pass_ratio = 1 - (1.0 * failure_count / example_count)
     controller.tab_title = "#{pass_ratio * 100}% passed"
 
-    window_title = Iterm2TabFormatter::TextFormatter.status(failure_count)
+    formatter = Iterm2TabFormatter::TextFormatter.new(
+      duration_seconds: duration,
+      example_count: example_count,
+      failure_count: failure_count,
+      pending_count: pending_count,
+      finish_time: Time.now
+    )
+
+    window_title = formatter.status
     window_title << ' - '
-    window_title << Iterm2TabFormatter::TextFormatter.window_title(example_count, failure_count, pending_count)
+    window_title << formatter.window_title
     window_title << ' - '
-    window_title << Iterm2TabFormatter::TextFormatter.duration(duration)
+    window_title << formatter.duration
     window_title << ' - Finished at '
-    window_title << Iterm2TabFormatter::TextFormatter.finished_at(Time.now)
+    window_title << formatter.finished_at
     controller.window_title = window_title
   end
+
+  private
+  def color(name)
+    Iterm2TabFormatter::color_parse(RSpec.configuration.__send__(name))
+  end
 end

data/lib/iterm2_tab_formatter/{auto.rb → autoload.rb}

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

data/lib/iterm2_tab_formatter/color_parse.rb

@@ -0,0 +1,14 @@
+require 'iterm2_tab_formatter/base'
+
+class Iterm2TabFormatter
+  class << self
+    def color_parse(code)
+      regex = /\A#([a-f0-9]{2})([a-f0-9]{2})([a-f0-9]{2})\z/i
+      raise ArgumentError, "Invalid format: #{code}. Use #RRGGBB" unless code.match(regex)
+
+      code.scan(regex) do |red, green, blue|
+        return [red.to_i(16), green.to_i(16), blue.to_i(16)]
+      end
+    end
+  end
+end

data/lib/iterm2_tab_formatter/rspec_configuration.rb

@@ -0,0 +1,7 @@
+require 'rspec/core'
+
+RSpec.configure do |c|
+  c.add_setting(:it2tf_neutral, default: '#7F7F7F')
+  c.add_setting(:it2tf_pass, default: '#00FF00')
+  c.add_setting(:it2tf_fail, default: '#FF0000')
+end

data/lib/iterm2_tab_formatter/text_formatter.rb

@@ -2,37 +2,52 @@ 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
+  class TextFormatter
+    def initialize(options)
+      @options = options.dup
+    end
 
-        window_title << ", #{failure_count} failure" if failure_count > 0
-        window_title << 's' if failure_count > 1
+    def window_title
+      window_title = "#{example_count} example"
+      window_title << 's' unless example_count == 1
 
-        window_title << ", #{pending_count} pending" if pending_count > 0
+      window_title << ", #{failure_count} failure" if failure_count > 0
+      window_title << 's' if failure_count > 1
 
-        window_title
-      end
+      window_title << ", #{pending_count} pending" if pending_count > 0
 
-      def finished_at(time)
-        time.iso8601
-      end
+      window_title
+    end
+
+    def finished_at
+      finish_time.iso8601
+    end
 
-      def duration(seconds)
-        text_minutes = (seconds / 60).to_i
-        text_seconds = (seconds % 60)
+    def duration
+      text_minutes = (duration_seconds / 60).to_i
+      text_seconds = (duration_seconds % 60)
 
-        text = ''
-        text << "#{text_minutes}m" if text_minutes > 0
-        text << ("%.1fs" % text_seconds)
+      text = ''
+      text << "#{text_minutes}m" if text_minutes > 0
+      text << ("%.1fs" % text_seconds)
 
-        text
-      end
+      text
+    end
+
+    def status
+      failure_count == 0 ? 'PASS' : 'FAIL'
+    end
 
-      def status(failure_count)
-        failure_count == 0 ? 'PASS' : 'FAIL'
+    private
+    %w(
+      example_count
+      failure_count
+      pending_count
+      finish_time
+      duration_seconds
+    ).map(&:to_sym).each do |attr|
+      define_method(attr) do
+        @options.fetch(attr)
       end
     end
   end

data/lib/iterm2_tab_formatter/version.rb

@@ -5,5 +5,5 @@ rescue LoadError
 end
 
 class Iterm2TabFormatter
-  VERSION = "0.7.3"
+  VERSION = "0.8.0"
 end

data/sandbox/slow_spec.rb

@@ -1,5 +1,5 @@
 require 'rspec'
-require 'iterm2_tab_formatter/auto'
+require 'iterm2_tab_formatter/autoload'
 
 RSpec.configure do |c|
   c.add_formatter('documentation')

data/spec/color_parse_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'iterm2_tab_formatter/color_parse'
+
+describe Iterm2TabFormatter do
+  describe '.color_parse' do
+    ({
+      '#000000' => [0, 0, 0],
+      '#FF0000' => [255, 0, 0],
+      '#00FF00' => [0, 255, 0],
+      '#0000FF' => [0, 0, 255],
+      '#123456' => [0x12, 0x34, 0x56],
+    }).each do |code, values|
+      it "correctly parses #{code}" do
+        expect(Iterm2TabFormatter.color_parse(code)).to eq(values)
+      end
+    end
+
+    it 'raises on invalid code' do
+      expect {
+        Iterm2TabFormatter.color_parse('whatever')
+      }.to raise_error(/RRGGBB/)
+    end
+  end
+end

data/spec/iterm2_tab_formatter_spec.rb

@@ -21,6 +21,16 @@ describe Iterm2TabFormatter do
     formatter.example_failed(double)
   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
+
   describe 'at the end of the suite' do
     before do
       controller.stub(:apply_pass_color)
@@ -56,25 +66,25 @@ describe Iterm2TabFormatter do
       end
 
       it 'sets the window title through TextFormatter' do
-        Time.should_receive(:now).and_return('time_now')
-        Iterm2TabFormatter::TextFormatter.should_receive(:status).with(3).and_return('PASS_OR_FAIL')
-        Iterm2TabFormatter::TextFormatter.should_receive(:duration).with(5).and_return('the_duration')
-        Iterm2TabFormatter::TextFormatter.should_receive(:window_title).with(10, 3, 4).and_return('window_title')
-        Iterm2TabFormatter::TextFormatter.should_receive(:finished_at).with('time_now').and_return('finish_time')
+        now = Time.now
+        Time.should_receive(:now).and_return(now)
+        Iterm2TabFormatter::TextFormatter.should_receive(:new).with(
+          duration_seconds: 5,
+          example_count: 10,
+          failure_count: 3,
+          pending_count: 4,
+          finish_time: now
+        ).and_return(double(
+          status: 'PASS_OR_FAIL',
+          duration: 'the_duration',
+          window_title: 'window_title',
+          finished_at: 'finish_time'
+        ))
+
         controller.should_receive(:window_title=).with('PASS_OR_FAIL - window_title - the_duration - Finished at finish_time')
 
         formatter.dump_summary(5, 10, 3, 4)
       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/text_formatter_spec.rb

@@ -14,7 +14,9 @@ describe Iterm2TabFormatter::TextFormatter do
       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)
+        opts = {example_count: example_count, failure_count: failure_count, pending_count: pending_count}
+        formatter = described_class.new(opts)#example_count, failure_count, pending_count)
+        expect(formatter.window_title).to eq(expected_message)
       end
     end
   end
@@ -22,26 +24,32 @@ describe Iterm2TabFormatter::TextFormatter do
   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')
+      formatter = described_class.new(finish_time: date)
+      expect(formatter.finished_at).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')
+      formatter = described_class.new(duration_seconds: 1.1)
+      expect(formatter.duration).to eq('1.1s')
     end
+
     it 'correctly prints time over a minute' do
-      expect(described_class.duration(65)).to eq('1m5.0s')
+      formatter = described_class.new(duration_seconds: 65)
+      expect(formatter.duration).to eq('1m5.0s')
     end
   end
 
   describe '.status' do
     it 'is "PASS" when there are 0 failures' do
-      expect(described_class.status(0)).to eq('PASS')
+      formatter = described_class.new(failure_count: 0)
+      expect(formatter.status).to eq('PASS')
     end
 
     it 'is "FAIL" when there are >0 failures' do
-      expect(described_class.status(1)).to eq('FAIL')
+      formatter = described_class.new(failure_count: 1)
+      expect(formatter.status).to eq('FAIL')
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iterm2_tab_formatter
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-19 00:00:00.000000000 Z
+date: 2013-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iterm2_escape
@@ -59,12 +59,15 @@ files:
 - Rakefile
 - iterm2_tab_formatter.gemspec
 - lib/iterm2_tab_formatter.rb
-- lib/iterm2_tab_formatter/auto.rb
+- lib/iterm2_tab_formatter/autoload.rb
 - lib/iterm2_tab_formatter/base.rb
+- lib/iterm2_tab_formatter/color_parse.rb
 - lib/iterm2_tab_formatter/controller.rb
+- lib/iterm2_tab_formatter/rspec_configuration.rb
 - lib/iterm2_tab_formatter/text_formatter.rb
 - lib/iterm2_tab_formatter/version.rb
 - sandbox/slow_spec.rb
+- spec/color_parse_spec.rb
 - spec/controller_spec.rb
 - spec/iterm2_tab_formatter_spec.rb
 - spec/spec_helper.rb
@@ -84,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3358931275503651157
+      hash: 235173726208200768
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -93,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3358931275503651157
+      hash: 235173726208200768
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -105,6 +108,7 @@ summary: ! 'iTerm2 Tab Formatter communicates your RSpec status through your iTe
   title: * Index of current spec and total number of specs * Window title: * Full
   spec name for the current spec'
 test_files:
+- spec/color_parse_spec.rb
 - spec/controller_spec.rb
 - spec/iterm2_tab_formatter_spec.rb
 - spec/spec_helper.rb