quarantini 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ec96ce7df969c893d2b8d8fae9c051894b7a298d80c0b59f9f1a88c31ec0d6d
+  data.tar.gz: a34f4253edeae3bbf24d6ee505493f47fff2fa2bb657f9cae8f9d126dbb53d0a
+SHA512:
+  metadata.gz: b5959da1f23d40469c41972f95d96ac618e4306c71a6c3ca720dc774f251261f4247204d3e7e10e1366180463dd15a97ea69f11f5264dfaba74314153133b34c
+  data.tar.gz: 94a604e4a6812707affd9b434ffdbdd3e1f1f9e90d024e0d750bb5405ce23ac48e39cb119105b28a1ebadb4d33e7a9af01d03a2fe86ff6e938a57013e5d97d5c

data/.rubocop.yml

@@ -0,0 +1,35 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Style/Documentation:
+  Enabled: false
+
+# Will lean on CodeClimate for these
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-10-03 21:34:50 UTC using RuboCop version 1.56.4.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in quarantini.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2023 Phil Phillips
+
+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,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'quarantini'
+
+# 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/quarantini/quarantine.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module Quarantini
+  class Released
+    def skip?
+      false
+    end
+  end
+
+  RELEASED = Released.new
+
+  class Quarantine
+    class << self
+      def skip?(quarantine_data)
+        quarantine = mix_quarantini(quarantine_data)
+        quarantine.skip?
+      end
+
+      def mix_quarantini(quarantine_data)
+        if quarantine_data.nil?
+          RELEASED
+        elsif quarantine_data == true
+          new
+        else
+          new(quarantine_data)
+        end
+      end
+    end
+
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        send("#{name}=", value)
+      end
+    end
+
+    def skip?
+      !Quarantini.config.run_all && expires_at >= Date.today
+    end
+
+    def expires_at
+      case @expires_at
+      when nil
+        Date.today.next
+      when String
+        Date.parse(@expires_at)
+      when Date
+        @expires_at
+      else
+        raise ArgumentError, "Unknown expiry type #{@expires_at.class.name}.  Expecting one of (nil|String|Date)"
+      end
+    end
+
+    private
+
+    attr_writer :expires_at
+  end
+end

data/lib/quarantini/reporters/minitest_reporter.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+if defined? Minitest
+  module Quarantini
+    module Reporters
+      class MinitestReporter < Minitest::Reporters::BaseReporter
+        def initialize(options = {})
+          super
+          @quarantine_results = []
+          reports_dir = options.fetch(:reports_dir)
+          output_filename = options.fetch(:output_filename)
+          @reports_path = File.absolute_path(reports_dir)
+          @output_file_path = File.join(@reports_path, output_filename)
+        end
+
+        def record(test)
+          super
+
+          if test.error? || test.failure
+            register_result(test, false)
+          elsif test.skipped?
+            register_result(test, nil)
+          elsif test.passed?
+            register_result(test, true)
+          end
+        end
+
+        def report
+          super
+          FileUtils.mkdir_p(@reports_path)
+          File.write(@output_file_path, @quarantine_results.to_json)
+        end
+
+        private
+
+        def register_result(test, passed)
+          test_metadata = (Kernel.const_get(test.klass).test_metadata || {}).dig(test.name.to_sym, :quarantine)
+          return unless test_metadata
+
+          @quarantine_results << QuarantineResult.new(name: test.name, test_path: test.location, passes: passed, date: Time.now.utc)
+        end
+      end
+    end
+  end
+
+end

data/lib/quarantini/reporters/quarantine_result.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'dry-struct'
+require_relative '../types'
+
+module Quarantini
+  module Reporters
+    class QuarantineResult < Dry::Struct
+      # {
+      #   "name": "some test",
+      #   "passes": false,
+      #   "testPath": "/path/to/spec.rb",
+      #   "date": "2022-01-30T19:20:40.950Z"
+      # }
+      attribute :name, Quarantini::Types::String
+      attribute :passes, Quarantini::Types::Bool.optional
+      attribute :test_path, Quarantini::Types::String
+      attribute :date, Quarantini::Types::Time
+    end
+  end
+end

data/lib/quarantini/reporters/rspec_reporter.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+if defined? RSpec
+  require 'rspec/core/formatters/base_formatter'
+  require_relative 'quarantine_result'
+
+  module Quarantini
+    module Reporters
+      class RspecReporter < ::RSpec::Core::Formatters::BaseFormatter
+        ::RSpec::Core::Formatters.register self, :close, :example_passed, :example_failed, :example_pending
+
+        def initialize(output)
+          super
+          @quarantine_results = []
+        end
+
+        def example_passed(passed)
+          example = passed.example
+          register_result(example, true) if example.metadata[:quarantine]
+        end
+
+        def example_pending(skipped)
+          example = skipped.example
+          register_result(example, nil) if example.metadata[:quarantine]
+        end
+
+        def example_failed(failure)
+          example = failure.example
+          register_result(example, false) if example.metadata[:quarantine]
+        end
+
+        def close(_notification)
+          output.write @quarantine_results.to_json
+        end
+
+        private
+
+        def register_result(example, passed)
+          @quarantine_results << QuarantineResult.new(name: example.full_description, test_path: example.file_path, passes: passed,
+                                                      date: Time.now.utc)
+        end
+      end
+    end
+  end
+end

data/lib/quarantini/types.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'dry-types'
+module Quarantini
+  module Types
+    include Dry.Types()
+  end
+end

data/lib/quarantini/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Quarantini
+  VERSION = '0.1.0'
+end

data/lib/quarantini.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'dry-configurable'
+require_relative 'quarantini/version'
+require_relative 'quarantini/quarantine'
+require_relative 'quarantini/reporters/rspec_reporter'
+require_relative 'quarantini/reporters/minitest_reporter'
+
+module Quarantini
+  class Error < StandardError; end
+
+  extend Dry::Configurable
+  setting :run_all, default: false
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: quarantini
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Phil Phillips
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  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: dry-struct
+  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: dry-types
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.56'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.56'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.19.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.19.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.24.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.24.1
+description:
+email:
+- irving.phillips@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- LICENSE
+- Rakefile
+- bin/console
+- bin/setup
+- lib/quarantini.rb
+- lib/quarantini/quarantine.rb
+- lib/quarantini/reporters/minitest_reporter.rb
+- lib/quarantini/reporters/quarantine_result.rb
+- lib/quarantini/reporters/rspec_reporter.rb
+- lib/quarantini/types.rb
+- lib/quarantini/version.rb
+homepage: https://github.com/irphilli/quarantini
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/irphilli/quarantini
+  source_code_uri: https://github.com/irphilli/quarantini
+  changelog_uri: https://github.com/irphilli/quarantini/releases
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A set of tools to remove tests from circulation
+test_files: []