rspec-pubsub-formatter 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rspec-pubsub-formatter.gemspec
+gemspec

data/README.md

@@ -0,0 +1,16 @@
+rspec-pubsub-formatter
+======================
+
+Publishes a json serialized hash to a redis pubsub channel (`pubsub_formatter`
+by default)  with the following data:
+
+      {
+        :total_example_count => 4,
+        :run_example_count   => 2,
+        :failure_count       => 1,
+        :pending_count       => 0,
+        :percent_complete    => 50
+      }
+
+The formatter inherits from the `RSpec::Core::Formatters::ProgressFormatter` and
+maintains its behavior of reporting, in addition to publishing to redis.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec]

data/lib/rspec-pubsub-formatter.rb

@@ -0,0 +1,89 @@
+require 'rspec/core/formatters/progress_formatter'
+require 'redis'
+require 'json'
+
+module RSpecPubsub
+  class Formatter < RSpec::Core::Formatters::ProgressFormatter
+    attr_reader :channel
+
+    def initialize(output)
+      super
+      @channel = Channel.new
+    end
+
+    def start(example_count)
+      super
+      publish_status
+    end
+
+    def example_passed(example)
+      super
+      publish_status
+    end
+
+    def example_pending(example)
+      super
+      publish_status
+    end
+
+    def example_failed(example)
+      super
+      publish_status
+    end
+
+    private
+
+    def status
+      {
+        :total_example_count => example_count,
+        :run_example_count   => run_example_count,
+        :failure_count       => failure_count,
+        :pending_count       => pending_count,
+        :percent_complete    => percent_complete
+      }
+    end
+
+    def run_example_count
+      examples.length
+    end
+
+    def failure_count
+      failed_examples.length
+    end
+
+    def pending_count
+      pending_examples.length
+    end
+
+    def percent_complete
+      begin
+        ((run_example_count / example_count.to_f ) * 100).to_i
+      rescue FloatDomainError
+        0
+      end
+    end
+
+    def publish_status
+      channel.publish(status)
+    end
+  end
+
+  class Channel
+    attr_reader :redis
+
+    class << self
+      attr_writer :channel_name
+      def channel_name
+        @channel_name || "pubsub_formatter"
+      end
+    end
+
+    def initialize
+      @redis = Redis.new
+    end
+
+    def publish(status)
+      redis.publish(self.class.channel_name, status.to_json)
+    end
+  end
+end

data/lib/rspec-pubsub-formatter/version.rb

@@ -0,0 +1,7 @@
+module Rspec
+  module Pubsub
+    module Formatter
+      VERSION = "0.0.1"
+    end
+  end
+end

data/rspec-pubsub-formatter.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "rspec-pubsub-formatter/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rspec-pubsub-formatter"
+  s.version     = Rspec::Pubsub::Formatter::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brendon Murphy"]
+  s.email       = ["xternal1+github@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Publish rspec status from a spec run into redis}
+  s.description = s.summary
+
+  s.rubyforge_project = "rspec-pubsub-formatter"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rspec", ">= 2"
+  s.add_dependency "redis", "~> 2.2.2"
+  s.add_dependency "json"
+end

data/spec/rspec_pubsub_channel_spec.rb

@@ -0,0 +1,21 @@
+require 'rspec-pubsub-formatter'
+
+describe RSpecPubsub::Channel do
+  let(:redis) { stub("Redis") }
+  let(:status) { { :foo => "bar", :fizz => "buzz" } }
+
+  before do
+    Redis.stub(:new).and_return(redis)
+  end
+
+  it "publishes the provided hash to redis as json" do
+    redis.should_receive(:publish).with("pubsub_formatter", status.to_json)
+    subject.publish(status)
+  end
+
+  it "allows changing the channel name via the class" do
+    RSpecPubsub::Channel.channel_name = "blam"
+    redis.should_receive(:publish).with("blam", status.to_json)
+    subject.publish(status)
+  end
+end

data/spec/rspec_pubsub_formatter_spec.rb

@@ -0,0 +1,49 @@
+require 'rspec-pubsub-formatter'
+
+describe RSpecPubsub::Formatter do
+  let(:output) { StringIO.new }
+  let(:channel) { stub("Channel", :publish => true) }
+  subject{ RSpecPubsub::Formatter.new(output) }
+
+  before do
+    RSpecPubsub::Channel.stub(:new).and_return(channel)
+  end
+
+  it "publishes its status with example count on start" do
+    channel.should_receive(:publish).with(hash_including(:total_example_count => 5))
+    subject.start(5)
+  end
+
+  it "publishes the count of failed examples" do
+    channel.should_receive(:publish).with(hash_including(:failure_count => 1))
+    channel.should_receive(:publish).with(hash_including(:failure_count => 2))
+    2.times { subject.example_failed(stub) }
+  end
+
+  it "publishes the count of pending examples" do
+    channel.should_receive(:publish).with(hash_including(:pending_count => 1))
+    channel.should_receive(:publish).with(hash_including(:pending_count => 2))
+    2.times { subject.example_pending(stub) }
+  end
+
+  it "publishes the count of examples run so far" do
+    channel.should_receive(:publish).with(hash_including(:run_example_count => 1))
+    channel.should_receive(:publish).with(hash_including(:run_example_count => 2))
+    2.times do
+      example = stub
+      subject.example_started(example)
+      subject.example_failed(example)
+    end
+  end
+
+  it "publishes the percentage of examples completed" do
+    subject.start(2)
+    channel.should_receive(:publish).with(hash_including(:percent_complete => 50))
+    channel.should_receive(:publish).with(hash_including(:percent_complete => 100))
+    2.times do
+      example = stub
+      subject.example_started(example)
+      subject.example_passed(example)
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: rspec-pubsub-formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-27 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157375380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157375380
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &2157374880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157374880
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2157396260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157396260
+description: Publish rspec status from a spec run into redis
+email:
+- xternal1+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/rspec-pubsub-formatter.rb
+- lib/rspec-pubsub-formatter/version.rb
+- rspec-pubsub-formatter.gemspec
+- spec/rspec_pubsub_channel_spec.rb
+- spec/rspec_pubsub_formatter_spec.rb
+homepage: ''
+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: rspec-pubsub-formatter
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Publish rspec status from a spec run into redis
+test_files: []