rspec-rotten 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8baf4e11c797e50c69cd91a3f187f3822dbfb7d9
+  data.tar.gz: 1f1eb1f40760ccd5145abe0021ee322b2cac70c0
+SHA512:
+  metadata.gz: baed89376e63e2dde843531bd0f389b31483965dc17b68eb5e3ccab4c583cbb55cf4f4dc3b4d0738036b80f8829802fe1c7b38856c33a44e88f4a39dac2e0662
+  data.tar.gz: b47adb41ae5f03bda358ad5781d71991a6e93f9f2af3e988ad3f8c91a56ec5009bad6b993e2022eba787fc6042751b2416d1d7a1a39174c4e43c21062125018a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Simon Bagreev
+
+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,90 @@
+# Rspec::Rotten
+
+According to [pronounced James O Coplien essay](http://www.rbcs-us.com/documents/Why-Most-Unit-Testing-is-Waste.pdf),
+most unit tests are waste. Particulary, James says:
+
+>If you want to reduce your test mass, the number one
+>thing you should do is look at the tests that have never
+>failed in a year and consider throwing them away. They are
+>producing no information for you — or at least very little
+>information. The value of the information they produce may
+>not be worth the expense of maintaining and running the
+>tests. This is the first set of tests to throw away — whether
+>they are unit tests, integration tests, or system tests.
+
+This gem lets you track tests that haven't failed for given period of time,
+and prompts you to "reduce test mass" by removing them.
+
+## Installation
+
+### Step 1
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-rotten'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-rotten
+
+### Step 2
+
+Create initializer and specify path to a file that will be storing stats of your
+test runs, and, most importantly, _time period after which specs will be considered
+"rotten"_, given they didn't change status(failed/passed/became pending):
+
+```ruby
+# config/initializers/rspec-rotten.rb
+Rspec::Rotten::Configuration.configure do |config|
+  config.results_file = Rails.root.join('output.json')
+  config.time_to_rotten = 1.year
+end
+```
+
+Also add this line to RSpec config in spec_helper/rails_helper:
+
+```ruby
+# spec/rails_helper.rb
+RSpec.configure do |config|
+  ...
+  config.add_formatter(Rspec::Rotten::Formatters::RottenReportFormatter)
+  ...
+end
+```
+
+### Step 3
+
+Run **the entire suite** to genreate initial spec report:
+
+```
+rake spec
+```
+_**NOTE:**_ This will create the report that will reflect the status of your specs,
+and will be updated every time you run specs. It's recommended to check this file
+under source control, to share this data with your co-workers.
+
+## VIOLA!
+
+Now, every time you run specs, you will get an annoying message _if you have
+"rotten" specs_ (it's easy to turn OFF by commenting out Formatter in step 2).
+
+## TODO
+
+* create rake task / installer to generate initial report
+* notify only about the examples currently executed (not the whole suite)
+* allow user to use Formatter from CLI like `rspec --format RottenFormatter spec/`
+* give user a chance to only track unit/integration/acceptance specs
+
+## Contributions welcomed
+
+1. Fork it ( https://github.com/[my-github-username]/rspec-rotten/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rspec/rotten/configuration.rb

@@ -0,0 +1,15 @@
+module Rspec
+  module Rotten
+    class Configuration
+      include Singleton
+
+      class << self
+        attr_accessor :results_file, :time_to_rotten
+
+        def configure
+          yield self
+        end
+      end
+    end
+  end
+end

data/lib/rspec/rotten/example_store.rb

@@ -0,0 +1,64 @@
+require 'json'
+require 'time'
+require 'rspec/core/formatters/console_codes'
+require 'rspec/rotten/configuration'
+
+module Rspec
+  module Rotten
+    class ExampleStore
+      # 1 year duration when AS is not available
+      ROTTEN_DURATION = Time.parse("2016-01-01") - Time.parse("2015-01-01")
+
+      attr_accessor :file_path, :records
+
+      def initialize()
+        @file_path = Rspec::Rotten::Configuration.results_file
+        @records = File.exists?(@file_path) ? JSON.parse(read_example_data) : []
+      end
+
+      def find(example)
+        @records.find{ |x| x['id'] == example.id }
+      end
+
+      def delete(example)
+        @records.delete example
+      end
+
+      def save
+        f = File.open(@file_path,"w")
+        f.truncate(0)
+        f.write(@records.to_json)
+        f.close
+      end
+
+      # use config for date
+      def rotten
+        rotten_duration = Rspec::Rotten::Configuration.time_to_rotten || ROTTEN_TIME
+        @rotten ||= @records.select {|x| !x['date'].nil? && x['date'] < Time.now() - rotten_duration }
+      end
+
+      def notify_rotten
+        if @rotten.any?
+          @message = %Q{
+          \n\nYou have #{@rotten.count} specs that haven't failed for extended period of time.\n\t
+          \n\nYou may want to consider removing them:\n\t
+          #{@records.map {|example| example['description'] + " - " + example['location'] }.join("\n\t")}
+          \n
+          }
+          RSpec::Core::Formatters::ConsoleCodes.wrap(@message, :pending)
+        end
+      end
+
+      private
+
+      def read_example_data
+        if File.exists? @file_path
+          f = File.open(@file_path, 'r')
+          data = f.read
+          f.close
+          data
+        end
+      end
+    end
+  end
+end

data/lib/rspec/rotten/formatters/initial_report_formatter.rb

@@ -0,0 +1,38 @@
+require 'rspec/core/formatters'
+module Rspec
+  module Rotten
+    module Formatters
+      class InitialReportFormatter
+        RSpec::Core::Formatters.register self, :example_passed, :example_failed, :example_pending, :close
+
+        def initialize(output)
+          @output = output
+          @arr = []
+        end
+
+        def example_passed(notification)
+          @arr << example_data(notification.example, :passed)
+        end
+
+        def example_failed(notification)
+          @arr << example_data(notification.example, :failed)
+        end
+
+        def example_pending(notification)
+          @arr << example_data(notification.example, :pending)
+        end
+
+        def close(notification)
+          @output.write @arr.to_json
+          @output.close if IO === @output && @output != $stdout
+        end
+
+        private
+
+        def example_data(example, status)
+          { id: example.id, state: status, date: Time.now, location: example.location, description: example.description }
+        end
+      end
+    end
+  end
+end

data/lib/rspec/rotten/formatters/rotten_report_formatter.rb

@@ -0,0 +1,61 @@
+require 'rspec/core/formatters'
+require 'json'
+require 'rspec/rotten/example_store'
+
+module Rspec
+  module Rotten
+    module Formatters
+      class RottenReportFormatter
+        RSpec::Core::Formatters.register self, :example_passed, :example_failed, :example_pending, :close
+
+        def initialize(output)
+          @output = output
+          @store = ExampleStore.new
+        end
+
+        def example_passed(notification)
+          record = @store.find(notification.example)
+          if record && record['state'] != 'passed'
+            @store.delete record
+            @store.records << example_data(notification.example, :passed)
+          elsif record.nil?
+            @store.records << example_data(notification.example, :passed)
+          end
+        end
+
+        def example_failed(notification)
+          record = @store.find(notification.example)
+          if record && record['state'] != 'failed'
+            @store.delete record
+            @store.records << example_data(notification.example, :failed)
+          elsif record.nil?
+            @store.records << example_data(notification.example, :failed)
+          end
+        end
+
+        def example_pending(notification)
+          record = @store.find(notification.example)
+          if record && record['state'] != 'pending'
+            @store.delete record
+            @store.records << example_data(notification.example, :pending)
+          elsif record.nil?
+            @store.records << example_data(notification.example, :pending)
+          end
+        end
+
+        # write into a file
+        # generate a report into STDOUT what specs haven't failed for a year
+        def close(notification)
+          @store.save
+          @output << @store.notify_rotten if @store.rotten.any?
+        end
+
+        private
+
+        def example_data(example, status)
+          { id: example.id, state: status, date: Time.now, location: example.location, description: example.description }
+        end
+      end
+    end
+  end
+end

data/lib/rspec/rotten/initial_report_creator.rb

@@ -0,0 +1,28 @@
+require 'rspec'
+require 'rspec/rotten/formatters/initial_report_formatter'
+
+module Rspec
+  module Rotten
+    class InitialReportCreator
+      def self.create_report
+        unless File.exist?(Rspec::Rotten::Configuration.results_file)
+          config = RSpec.configuration
+
+          formatter = Rspec::Rotten::Formatters::InitialReportFormatter.new(Rspec::Rotten::Configuration.results_file)
+
+          reporter =  RSpec::Core::Reporter.new(config)
+          config.instance_variable_set(:@reporter, reporter)
+
+          # internal hack
+          # api may not be stable, make sure lock down Rspec version
+          loader = config.send(:formatter_loader)
+          notifications = loader.send(:notifications_for, Rspec::Rotten::Formatters::InitialReportFormatter)
+
+          reporter.register_listener(formatter, *notifications)
+
+          RSpec::Core::Runner.run([config.default_path])
+        end
+      end
+    end
+  end
+end

data/lib/rspec/rotten/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module Rotten
+    VERSION = "0.0.2"
+  end
+end

data/lib/rspec/rotten.rb

@@ -0,0 +1,6 @@
+require "rspec/rotten/version"
+require "rspec/rotten/example_store"
+require "rspec/rotten/configuration"
+require "rspec/rotten/initial_report_creator"
+require "rspec/rotten/formatters/initial_report_formatter"
+require "rspec/rotten/formatters/rotten_report_formatter"

data/rspec-rotten.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/rotten/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-rotten"
+  spec.version       = Rspec::Rotten::VERSION
+  spec.authors       = ["Simon Bagreev"]
+  spec.email         = ["sbagreev@gmail.com"]
+  spec.summary       = %q{Detects rotten specs}
+  spec.description   = %q{Tracks the specs that haven't changed status
+                        (failed/passed/pending) for given period of time, and
+                        signals you to remove them}
+  spec.homepage      = ""
+  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 "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: rspec-rotten
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Simon Bagreev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: |-
+  Tracks the specs that haven't changed status
+                          (failed/passed/pending) for given period of time, and
+                          signals you to remove them
+email:
+- sbagreev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/rotten.rb
+- lib/rspec/rotten/configuration.rb
+- lib/rspec/rotten/example_store.rb
+- lib/rspec/rotten/formatters/initial_report_formatter.rb
+- lib/rspec/rotten/formatters/rotten_report_formatter.rb
+- lib/rspec/rotten/initial_report_creator.rb
+- lib/rspec/rotten/version.rb
+- rspec-rotten.gemspec
+homepage: ''
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Detects rotten specs
+test_files: []