rspec-percentage-formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73e6362a0ae2c63ba4afba32c67c972e4d042087
+  data.tar.gz: e9ed34719cb52ce74aa38f6bc864303ba743504c
+SHA512:
+  metadata.gz: fdf0ff8c8d72ee71cbaf95a3cae5fd91c8524294075d1c26058d50654626add375b76dadb3750cd4d7f94bb70801ef1d0d06f183e99962f52aa696a3bc29bb7e
+  data.tar.gz: d14ab696adbcbd507352774e2a0c374da117dbefe5f53e000a2f09d9ff3a69b9cafbf255d1b6ceb9f5edb19d20a5031a1daf950fe592967bc7c58975e005df95

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,40 @@
+# PercentageFormatter
+
+This is a RSpec formatter that outputs the spec run progress in percentages (increments of 5%).
+
+Each increment is printed on a new line, so Jenkins will keep up with the output.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-percentage-formatter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-percentage-formatter
+
+## Usage
+
+`rspec --format PercentageFormatter`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lmeijvogel/rspec-percentage-formatter.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/percentage_formatter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/percentage_formatter.rb

@@ -0,0 +1,28 @@
+require 'rspec/core/formatters/base_text_formatter'
+require 'percentage_formatter/output.rb'
+
+class PercentageFormatter < RSpec::Core::Formatters::BaseTextFormatter
+  RSpec::Core::Formatters.register self, :start, :example_started, :example_failed
+
+  attr_accessor :outputter
+
+  def initialize(output)
+    super
+
+    self.outputter = PercentageFormatter::Output.new(output)
+  end
+
+  def start(notification)
+    super
+
+    outputter.start(notification.count)
+  end
+
+  def example_started(notification)
+    outputter.increment
+  end
+
+  def example_failed(notification)
+    outputter.failure(notification)
+  end
+end

data/lib/percentage_formatter/output.rb

@@ -0,0 +1,66 @@
+require 'rspec/instafail'
+
+class PercentageFormatter < RSpec::Core::Formatters::BaseTextFormatter
+  class Output
+    attr_accessor :rspec_output, :number_of_examples_executed, :last_printed_percentage
+
+    def initialize(rspec_output)
+      self.rspec_output = rspec_output
+
+      self.number_of_examples_executed = 0
+      self.last_printed_percentage = -1
+    end
+
+    def start(example_count)
+      @example_count = example_count
+
+      rspec_output.puts
+      rspec_output.puts("Running ~ #{example_count} specs")
+      rspec_output.puts
+    end
+
+    def increment
+      self.number_of_examples_executed += 1
+
+      print_percentage_if_needed
+    end
+
+    def failure(notification)
+      instafail.example_failed(notification)
+      rspec_output.puts
+    end
+
+    private
+    def print_percentage_if_needed
+      percentage_to_print = floor_to_printable_percentage(percentage_done)
+
+      if self.last_printed_percentage != percentage_to_print
+        rspec_output.puts( "specs at #{ percentage_to_print }%" )
+
+        self.last_printed_percentage = percentage_to_print
+      end
+    end
+
+    def floor_to_printable_percentage(number)
+      ((number / percentage_segment_size).floor * percentage_segment_size).to_i
+    end
+
+    def percentage_segment_size
+      @percentage_segment_size ||= if @example_count < 75
+                                     20
+                                   elsif @example_count < 200
+                                     10
+                                   else
+                                     5
+                                   end
+    end
+
+    def percentage_done
+      (self.number_of_examples_executed.to_f / @example_count) * 100
+    end
+
+    def instafail
+      @instafail ||= RSpec::Instafail.new(rspec_output)
+    end
+  end
+end

data/rspec-percentage-formatter.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-percentage-formatter"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Lennaert Meijvogel"]
+  spec.email         = ["l.meijvogel@yahoo.co.uk"]
+
+  spec.summary       = %q{RSpec formatter that prints progress as a percentage of total number of specs}
+  spec.homepage      = "https://github.com/lmeijvogel/rspec-percentage-formatter"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rspec", "~> 3.5"
+  spec.add_runtime_dependency "rspec-instafail", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: rspec-percentage-formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lennaert Meijvogel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-instafail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- l.meijvogel@yahoo.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/percentage_formatter.rb
+- lib/percentage_formatter/output.rb
+- rspec-percentage-formatter.gemspec
+homepage: https://github.com/lmeijvogel/rspec-percentage-formatter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: RSpec formatter that prints progress as a percentage of total number of specs
+test_files: []