webspec 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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Grzesiek Kolodziejczyk
+
+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,3 @@
+# Webspec
+
+Reports RSpec results to a web api for online browsing.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "run specs"
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]

data/lib/webspec.rb

@@ -0,0 +1,26 @@
+require "webspec/version"
+require "webspec/formatter"
+require "httparty"
+require "json"
+
+module Webspec
+  include HTTParty
+
+  class << self
+    attr_accessor :api_key
+
+    def base_url
+      ENV['WEBSPEC_URL'] || "https://webspec.shellyapp.com"
+    end
+
+    def configure_rspec
+      RSpec.configuration.add_formatter(Webspec::Formatter)
+    end
+
+    def report(output_hash)
+      FakeWeb.allow_net_connect = true if defined?(FakeWeb)
+      url = "#{base_url}/projects/#{api_key}/runs.json"
+      post(url, :body => {:run => output_hash})
+    end
+  end
+end

data/lib/webspec/formatter.rb

@@ -0,0 +1,112 @@
+require 'rspec/core/formatters/base_formatter'
+
+class Webspec::Formatter < RSpec::Core::Formatters::BaseFormatter
+  attr_reader :output_hash
+
+  def initialize(output)
+    super
+    @output_hash = {:elements => []}
+    @example_group_stack = []
+    @parent_example_group = nil
+  end
+
+  def message(message)
+    (@output_hash[:messages] ||= []) << message
+  end
+
+  def example_group_started(example_group)
+    @example_group_stack.push(@parent_example_group) if @parent_example_group
+    @parent_example_group = @example_group
+    @example_group = {
+      :type => "example_group",
+      :description => example_group.description,
+      :elements => []
+    }
+  end
+
+  def example_group_finished(example_group)
+    return unless @example_group
+    if @parent_example_group
+      @parent_example_group[:elements] << @example_group
+    else
+      @output_hash[:elements] << @example_group
+    end
+
+    @example_group = @parent_example_group
+    @parent_example_group = @example_group_stack.pop
+  end
+
+  def example_passed(example)
+    example_finished(example)
+  end
+
+  def example_failed(example)
+    example_finished(example)
+  end
+
+  def example_pending(example)
+    example_finished(example)
+  end
+
+  def example_finished(example)
+    @example_group[:elements] << example_metadata(example)
+  end
+
+  def dump_summary(duration, example_count, failure_count, pending_count)
+    super(duration, example_count, failure_count, pending_count)
+    @output_hash[:summary] = {
+      :duration => duration,
+      :example_count => example_count,
+      :failure_count => failure_count,
+      :pending_count => pending_count
+    }
+    @output_hash[:summary_line] = summary_line(example_count, failure_count, pending_count)
+
+    # Don't print out profiled info if there are failures, it just clutters the output
+    dump_profile if profile_examples? && failure_count == 0
+  end
+
+  def summary_line(example_count, failure_count, pending_count)
+    summary = pluralize(example_count, "example")
+    summary << ", " << pluralize(failure_count, "failure")
+    summary << ", #{pending_count} pending" if pending_count > 0
+    summary
+  end
+
+  def example_metadata(example)
+    {
+      :type => "example",
+      :description => example.description,
+      :full_description => example.full_description,
+      :status => example.execution_result[:status],
+      :example_group => example.example_group.description,
+      :execution_result => example.execution_result,
+      :file_path => example.file_path,
+      :line_number  => example.metadata[:line_number],
+    }.tap do |hash|
+      if e=example.exception
+        hash[:exception] =  {
+          :class => e.class.name,
+          :message => e.message,
+          :backtrace => e.backtrace,
+        }
+      end
+    end
+  end
+
+  def stop
+    super
+  end
+
+  def close
+    @output_hash[:env] = {
+      :user => ENV['USER'],
+      :ruby_platform => RUBY_PLATFORM,
+      :ruby_engine => RUBY_ENGINE,
+      :ruby_version => RUBY_VERSION,
+      :ruby_patchlevel => RUBY_PATCHLEVEL
+    }
+
+    Webspec.report(@output_hash)
+  end
+end

data/lib/webspec/version.rb

@@ -0,0 +1,3 @@
+module Webspec
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'webspec'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

data/spec/webspec_formatter_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Webspec::Formatter do
+  let(:formatter) { Webspec::Formatter.new(nil) }
+
+  it "should initialize empty output hash" do
+    formatter.output_hash.should == {:elements => []}
+  end
+
+  it "should add message to output_hash" do
+    formatter.message("test message")
+    formatter.output_hash[:messages].should == ["test message"]
+  end
+
+  it "should add summary to output hash" do
+    formatter.dump_summary(1.5, 10, 1, 2)
+    formatter.output_hash[:summary].should eql({
+      :duration => 1.5,
+      :example_count => 10,
+      :failure_count => 1,
+      :pending_count => 2
+    })
+    formatter.output_hash[:summary_line].should
+      eql("10 examples, 1 failure, 2 pending")
+  end
+
+  it "should add examples to output hash"
+
+  describe "on close" do
+    it "should report the run to Webspec" do
+      Webspec.should_receive(:report).with(formatter.output_hash)
+      formatter.close
+    end
+  end
+end

data/spec/webspec_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Webspec do
+  describe "configure_rspec" do
+    it "should add Webspec::Formatter to RSpec configuration" do
+      configuration = mock
+      RSpec.should_receive(:configuration).and_return(configuration)
+      configuration.should_receive(:add_formatter).with(Webspec::Formatter)
+      Webspec.configure_rspec
+    end
+  end
+
+  describe "report" do
+    it "should send output_hash to webspec web app" do
+      Webspec.stub(:api_key => "abc123")
+      Webspec.should_receive(:post).
+        with("https://webspec.shellyapp.com/projects/abc123/runs.json",
+          {:body => {:run => {:a => :b}}}).and_return(true)
+      Webspec.report({:a => :b})
+    end
+  end
+end

data/webspec.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webspec/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "webspec"
+  gem.version       = Webspec::VERSION
+  gem.authors       = ["Grzesiek Kołodziejczyk"]
+  gem.email         = ["gk@code-fu.pl"]
+  gem.summary       = "Report rspec results to webspec"
+  gem.homepage      = "https://github.com/grk/webspec/"
+
+  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 "rspec-core", "~> 2.11"
+  gem.add_runtime_dependency "httparty"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 2.11"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: webspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Grzesiek Kołodziejczyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: 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: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+description: 
+email:
+- gk@code-fu.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/webspec.rb
+- lib/webspec/formatter.rb
+- lib/webspec/version.rb
+- spec/spec_helper.rb
+- spec/webspec_formatter_spec.rb
+- spec/webspec_spec.rb
+- webspec.gemspec
+homepage: https://github.com/grk/webspec/
+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: 726502925257515232
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 726502925257515232
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Report rspec results to webspec
+test_files:
+- spec/spec_helper.rb
+- spec/webspec_formatter_spec.rb
+- spec/webspec_spec.rb