shouldertap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1740819d2d08afff3bb94be8afc2c5839c7f46bb
+  data.tar.gz: a17ba1b2455024e4931478f5e6355aed30db9feb
+SHA512:
+  metadata.gz: 634501df32217504032e74cf39da0100629939a08c5d66912bc38a02b3d88d9f32d2674de7e7ec911b402b70ba4e20988ab87989700e581f733c3ba3ab09fb01
+  data.tar.gz: f1f0d26ab679d0fea9a2c3becc63f61c612783365cebf64276773a194449c640e4cd888abed129dc0c4e19e22ff1a55a2d98c74553d1c662309994bebb73ff64

data/.gitignore

@@ -0,0 +1,2 @@
+**/.*.swp
+pkg/*

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+language: ruby
+bundler_args: "--without system"
+script: "bundle exec rspec --color --format documentation spec/"
+notifications:
+  email: false
+rvm:
+  - "2.1.0"
+  - "2.0.0"
+  - "1.9.3"
+  - "1.8.7"

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    shouldertap (0.0.1)
+      notify
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    notify (0.5.2)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.1)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  rake
+  rspec
+  shouldertap!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryan Doyle
+
+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,65 @@
+ShoulderTap gives desktop notifications from the output of [TAP](http://testanything.org/) (Test Anything Protocol)
+
+## Example
+
+Using [Bats](https://github.com/sstephenson/bats) as a TAP Producer, we pipe its output into ShoulderTap
+
+    bats test.bats | shouldertap
+
+![](https://github.com/ryandoyle/shouldertap/blob/master/doc/assets/shouldertap-passed.png)
+
+And for failing tests:
+
+    bats failing.bats | shouldertap
+
+![](https://github.com/ryandoyle/shouldertap/blob/master/doc/assets/shouldertap-failed.png)
+
+ShoulderTap also supports changing the name of the notification with the `-n` switch 
+
+    bats tests.bats | shouldertap -n 'My Project'
+
+![](https://github.com/ryandoyle/shouldertap/blob/master/doc/assets/shouldertap-passed-custom-name.png)
+
+There are a bunch of other producers available at the [Test Anything website](http://testanything.org/producers.html)
+
+## Advanced Usage
+
+With some simple shell scripting, we can run tests every time we save changes to our code. Here we are using [Bacon](https://github.com/chneukirchen/bacon) as our test harness.
+
+    while true; do
+      find . | xargs -- inotifywait --event modify
+      bacon --tap tests/* | shouldertap
+    done
+
+## Installation
+
+    gem install shouldertap 
+
+## Contributing
+
+Please fork and issue a pull request.
+
+## License
+
+Copyright (c) 2014 Ryan Doyle
+
+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/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)

data/bin/shouldertap

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'shouldertap/cli'
+
+ShoulderTap::CLI.new(ARGV, $stdin).run

data/lib/shouldertap/cli.rb

@@ -0,0 +1,44 @@
+require 'optparse'
+
+require 'shouldertap/testsuite'
+require 'shouldertap/notification'
+
+module ShoulderTap
+  class CLI
+
+    def initialize(arguments, tap_output)
+      @arguments = arguments
+      @tap_output = tap_output
+    end
+
+    def run
+      testsuite = ShoulderTap::Testsuite.new @tap_output
+      ShoulderTap::Notification.new(testsuite, options[:name]).send
+    end
+
+    private
+
+    def options
+      @options ||= parse_options
+    end
+ 
+    def parse_options
+      options = {}
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: shouldertap [-h] [-r NAME] < TAP_OUTPUT"
+        opts.on '-h', '--help', 'Print help' do 
+          STDERR.puts opts
+          exit 1
+        end
+        opts.on '-n', '--name NAME', 'Name of the test that ShoulderTap will report as. Defaults to "ShoulderTap"' do |n|
+          options[:name] = n
+        end
+      end
+      parser.parse! @arguments
+      options
+    end
+
+  end
+end
+
+

data/lib/shouldertap/notification.rb

@@ -0,0 +1,43 @@
+require 'notify'
+
+module ShoulderTap
+  class Notification
+
+    SUCCESS_ICON = "dialog-information.png"
+    FAILURE_ICON = "dialog-error.png"
+    DEFAULT_SENDER = 'ShoulderTap'
+
+    def initialize(testsuite, sender = nil)
+      @testsuite = testsuite
+      @sender = sender.nil? ? DEFAULT_SENDER : sender
+    end
+
+    def send
+      Notify.notify title, message, :app_name => 'ShoulderTap', :icon => icon
+    end
+
+    def title
+      @sender + " - " + (@testsuite.success? ? "Passed" : "Failed")
+    end
+
+    def message
+      success_ratio + ' tests passed'
+    end
+
+    def icon
+      resources + (@testsuite.success? ? SUCCESS_ICON : FAILURE_ICON)
+    end
+
+    private
+
+    def success_ratio
+      "#{@testsuite.success_count}/#{@testsuite.size}"
+    end
+
+    def resources
+      File.dirname(__FILE__) + '/resources/'
+    end
+
+  end
+
+end

data/lib/shouldertap/test.rb

@@ -0,0 +1,32 @@
+module ShoulderTap
+
+  class Test
+
+    def initialize(tap_line)
+      @tap_line = tap_line
+      parse_tap_line
+    end
+
+    attr_reader :number, :message
+
+    def success?
+      @success
+    end
+
+    def failed?
+      ! @success
+    end
+    
+    private
+
+    def parse_tap_line
+      @success = @tap_line[/^ok \d/] ? true : false
+      @number  = @tap_line[/ok (\d)/,1].to_i
+      @message = @tap_line[/ok \d (.*)/, 1]
+    end
+
+
+  end
+
+end
+

data/lib/shouldertap/testsuite.rb

@@ -0,0 +1,53 @@
+require 'shouldertap/test'
+
+module ShoulderTap
+  class Testsuite
+    
+    def initialize(tap_output)
+      @tap_output = tap_output
+    end
+
+    def failed?
+      result.any? {|test| test.failed? }
+    end
+
+    def success?
+      ! failed?
+    end
+
+    def result
+      @result ||= parse_tap
+    end
+
+    def size
+      result.size
+    end
+
+    def failures
+      result.select { |test| test.failed? }
+    end
+
+    def failed_count
+      failures.size
+    end
+
+    def successes
+      result.select { |test| test.success? }
+    end
+
+    def success_count 
+      successes.size
+    end
+
+    private
+
+    def parse_tap
+      @tap_output.each_line.collect do |line|
+        if line[/^ok/] or line[/^not ok/]
+          Test.new line        
+        end
+      end.compact
+    end
+
+  end
+end

data/lib/shouldertap/version.rb

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

data/shouldertap.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shouldertap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shouldertap"
+  spec.version       = ShoulderTap::VERSION
+  spec.authors       = ["Ryan Doyle"]
+  spec.email         = ["ryan@doylenet.net"]
+  spec.summary       = %q{Get desktop notifications of builds fed by TAP output (Test Anything Protocol)}
+  spec.description   = %q{ShoulderTap receives TAP-compliant (http://testanything.org/) output via STDIN and will display pop-up notifications once the test is complete}
+  spec.homepage      = "https://github.com/ryandoyle/shouldertap"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "notify"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/shouldertap/cli_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+require 'shouldertap/cli'
+
+describe ShoulderTap::CLI do
+
+  let(:options)      { ['--help', '--name', 'foops'] }
+  let(:tap_output)   { "foops" }
+  let(:notification) { double('notification' ) } 
+  let(:testsuite)    { double('testsuite') }
+
+  before do
+    allow(ShoulderTap::Testsuite).to receive(:new).and_return testsuite
+    allow(ShoulderTap::Notification).to receive(:new).and_return notification
+    allow(notification).to receive(:send)
+  end
+
+  describe '#run' do
+    it 'exits when --help is passed' do
+      cli = new_cli_with '--help'
+      allow(STDERR).to receive(:puts)
+      expect(cli).to receive(:exit).with 1
+      cli.run
+    end
+    describe '--name' do
+      it 'runs shouldertap with the name if present' do
+        cli = new_cli_with '--name foops'
+        expect(ShoulderTap::Notification).to receive(:new).with(testsuite, 'foops')
+        cli.run
+      end
+      it 'runs shouldertap with the default name if absent' do
+        cli = new_cli_with ''
+        expect(ShoulderTap::Notification).to receive(:new).with(testsuite, nil)
+        cli.run
+      end
+
+    end
+  end
+
+  def new_cli_with(args)
+    described_class.new(args.split(" "),tap_output)
+  end
+
+
+end 

data/spec/shouldertap/notification_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+require 'shouldertap/notification'
+
+describe ShoulderTap::Notification do
+
+
+  let(:test_suite) { double('test_suite') }
+  let(:notification) { described_class.new test_suite  }
+
+
+  describe '#title' do
+    it 'is a successful message if there were no failures' do
+      allow(test_suite).to receive(:success?).and_return true
+      expect(notification.title).to eql 'ShoulderTap - Passed'
+    end
+    it 'is a failing message if there were failures' do
+      allow(test_suite).to receive(:success?).and_return false
+      expect(notification.title).to eql 'ShoulderTap - Failed'
+    end
+  end
+
+  describe '#message' do
+    it 'displays the amount of successful tests' do
+      allow(test_suite).to receive(:success_count).and_return 3
+      allow(test_suite).to receive(:size).and_return 6
+      expect(notification.message).to eql '3/6 tests passed'
+    end
+  end
+  
+  describe '#icon' do
+
+    before do
+      allow(File).to receive(:dirname).and_return '/dir'
+    end
+
+    it 'is the success icon when the testsuite is successful' do
+      allow(test_suite).to receive(:success?).and_return true
+      expect(notification.icon).to eql '/dir/resources/dialog-information.png'
+    end
+    it 'is the error icon when the testsuite has failure' do
+      allow(test_suite).to receive(:success?).and_return false
+      expect(notification.icon).to eql '/dir/resources/dialog-error.png'
+    end
+  end
+
+end

data/spec/shouldertap/test_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+require 'shouldertap/test'
+
+describe ShoulderTap::Test do 
+
+  let(:test) { described_class.new 'ok 3 testing foo bats' }
+
+  describe '#success?' do
+
+    let(:failing_test) { described_class.new "not ok 2 true should equal false" }
+
+    it 'is true for a successful test' do
+      expect(test.success?).to eql true
+    end
+
+    it 'is false for a failed test' do
+      expect(failing_test.success?).to eql false 
+    end
+    
+  end
+
+
+  describe '#number' do
+    it 'is the number of the test' do
+      expect(test.number).to eql 3
+    end
+  end
+
+  describe 'message' do
+    it 'is the extra message that goes with the test' do
+      expect(test.message).to eql 'testing foo bats'
+    end
+  end
+  
+
+
+end
+
+

data/spec/shouldertap/testsuite_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+require 'shouldertap/testsuite'
+
+describe ShoulderTap::Testsuite do
+
+
+  let(:failing_output) { "1..4\n" +
+                        "ok 1 testing foo bats\n" +
+                        "not ok 2 the exit code: defaults to 0\n" +
+                        "# (in test file /home/ryan/code/stubish/stub.bats, line 12)\n" +
+                        "ok 3 stubbing a command to give an exit code of 1 returns 1 when the stub is called\n" +
+                        "ok 4 stubbing returns an error when the stubbing arguments do not match\n"
+                      }
+  let(:successful_output) { "1..3\n" +
+                        "ok 1 testing foo bats\n" +
+                        "ok 2 stubbing a command to give an exit code of 1 returns 1 when the stub is called\n" +
+                        "ok 3 stubbing returns an error when the stubbing arguments do not match\n"
+                      }
+  let(:nothing_output) { "someoutput that has no tests" }
+
+  let(:successful_test) { ShoulderTap::Testsuite.new successful_output }
+  let(:failing_test)    { ShoulderTap::Testsuite.new failing_output    }
+  let(:nothing_test)    { ShoulderTap::Testsuite.new nothing_output }
+
+  describe '#success?' do
+
+    it 'is true if all the tests passed' do 
+      expect(successful_test.success?).to eql true
+    end
+
+    it 'is false if any tests failed' do
+      expect(failing_test.success?).to eql false
+    end
+
+    it 'is true if there are no tests' do
+      expect(nothing_test.success?).to eql true
+    end
+
+  end
+
+  describe '#size' do
+    it 'is a count of the number of tests that ran' do
+      expect(failing_test.size).to eql 4
+    end
+  end
+
+  describe '#failed_count' do
+    it 'is the number of failed tests' do
+      expect(failing_test.failed_count).to eql 1
+    end
+  end
+
+  describe '#success_count' do
+    it 'is the number of successful tests' do
+      expect(failing_test.success_count).to eql 3
+    end
+  end
+
+
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$:.unshift File.expand_path(File.dirname(__FILE__) + '../')

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: shouldertap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Doyle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: notify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ShoulderTap receives TAP-compliant (http://testanything.org/) output
+  via STDIN and will display pop-up notifications once the test is complete
+email:
+- ryan@doylenet.net
+executables:
+- shouldertap
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/shouldertap
+- doc/assets/shouldertap-failed.png
+- doc/assets/shouldertap-passed-custom-name.png
+- doc/assets/shouldertap-passed.png
+- lib/shouldertap/cli.rb
+- lib/shouldertap/notification.rb
+- lib/shouldertap/resources/dialog-error.png
+- lib/shouldertap/resources/dialog-information.png
+- lib/shouldertap/resources/dialog-question.png
+- lib/shouldertap/resources/dialog-warning.png
+- lib/shouldertap/test.rb
+- lib/shouldertap/testsuite.rb
+- lib/shouldertap/version.rb
+- shouldertap.gemspec
+- spec/shouldertap/cli_spec.rb
+- spec/shouldertap/notification_spec.rb
+- spec/shouldertap/test_spec.rb
+- spec/shouldertap/testsuite_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ryandoyle/shouldertap
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Get desktop notifications of builds fed by TAP output (Test Anything Protocol)
+test_files:
+- spec/shouldertap/cli_spec.rb
+- spec/shouldertap/notification_spec.rb
+- spec/shouldertap/test_spec.rb
+- spec/shouldertap/testsuite_spec.rb
+- spec/spec_helper.rb
+has_rdoc: