rspec-doom 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d7786f1ff6b902d89bda213599275fa63eb396d3f310ebb6654d46a0ffe197ee
+  data.tar.gz: 8c970f53eb0d8091d8533ccb54970c4c9a89a421dbb1ead9dde9b012b11f4358
+SHA512:
+  metadata.gz: ed87672a16d727a78baf33d43b1b25e258f537227566d5871e93edb3e0f9c7cbaf83d3879f68238a811cca63889b728db8f4cefb42c47141783be75eaa72383f
+  data.tar.gz: 926c19d4b9783be514aa3af0769d4bd3d813899f952f0ff615eac7ed58ab11513ae71d28921b8d51ad957c9b0d3e34eeee446ed0cb803e541f02529955e50c78

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+/.bundle/
+/pkg/
+/tmp/
+/coverage/
+/bin/console
+/bin/setup

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    rspec-doom (0.1.0)
+      cruise
+      logger
+      notiffany
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    cruise (0.3.0)
+    cruise (0.3.0-aarch64-linux-gnu)
+    cruise (0.3.0-aarch64-linux-musl)
+    cruise (0.3.0-arm-linux-gnu)
+    cruise (0.3.0-arm64-darwin)
+    cruise (0.3.0-x86_64-darwin)
+    cruise (0.3.0-x86_64-linux-gnu)
+    cruise (0.3.0-x86_64-linux-musl)
+    diff-lcs (1.6.2)
+    logger (1.7.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    rake (13.4.2)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    shellany (0.0.1)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm64-darwin
+  ruby
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec-doom!
+
+CHECKSUMS
+  cruise (0.3.0) sha256=db75b7c589d1746965708bb82433591647ee32d77690fe7c42582352e0851e43
+  cruise (0.3.0-aarch64-linux-gnu) sha256=99c96550a7d2e740212978770d3867837371de335cd866e4755abd34b8428838
+  cruise (0.3.0-aarch64-linux-musl) sha256=a23e5c415f491a3480eff71f1a07692d7fc1bac39a316c04fb3726faec620d87
+  cruise (0.3.0-arm-linux-gnu) sha256=c266461d7ab6422afd8f3504d9b67ebc0db2c2116750d2b4eb32c7103bf42d3e
+  cruise (0.3.0-arm64-darwin) sha256=6bb8bbef2ab7b4103849e1809435aa1922d07ec5e2c766a525626c41682ab5ff
+  cruise (0.3.0-x86_64-darwin) sha256=5dcf048c20cfcaf208cdcdd6ddfd4410acb431ff18a84bd7441bba0c8b8d6b83
+  cruise (0.3.0-x86_64-linux-gnu) sha256=a7bdd7c72307a450a9d37f3c7a90c118230ea6122663b32b8c8e52cad32adfa8
+  cruise (0.3.0-x86_64-linux-musl) sha256=54ed6809f1d476bf99a3043bc256cca0efed8bbc9df93a55f4e49eac2bbcb7f4
+  diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
+  logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
+  nenv (0.3.0) sha256=d9de6d8fb7072228463bf61843159419c969edb34b3cef51832b516ae7972765
+  notiffany (0.1.3) sha256=d37669605b7f8dcb04e004e6373e2a780b98c776f8eb503ac9578557d7808738
+  rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701
+  rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
+  rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
+  rspec-doom (0.1.0)
+  rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
+  rspec-mocks (3.13.8) sha256=086ad3d3d17533f4237643de0b5c42f04b66348c28bf6b9c2d3f4a3b01af1d47
+  rspec-support (3.13.7) sha256=0640e5570872aafefd79867901deeeeb40b0c9875a36b983d85f54fb7381c47c
+  shellany (0.0.1) sha256=0e127a9132698766d7e752e82cdac8250b6adbd09e6c0a7fbbb6f61964fedee7
+
+BUNDLED WITH
+  4.0.16

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Amalrik Maia
+
+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,76 @@
+# rspec-doom
+
+A standalone RSpec file watcher with Doom-themed notifications. Runs tests
+automatically and shows Doom Guy images based on test results.
+
+Built on [Cruise](https://github.com/marcoroth/cruise), a fast OS-native file
+watcher — no Guard required.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'rspec-doom'
+```
+
+Then:
+
+```bash
+bundle install
+```
+
+Requires Ruby 3.2+ and macOS or Linux (precompiled native gems).
+
+## Usage
+
+From the root of your project:
+
+```bash
+bundle exec rspec-doom
+```
+
+Watches `app/` and `spec/` by default. When a spec changes it runs that spec;
+when a source file changes it runs the matching spec (or the whole suite if
+no matching spec exists).
+
+### Options
+
+```bash
+bundle exec rspec-doom lib spec          # watch extra directories
+bundle exec rspec-doom --cmd 'rspec'     # custom RSpec command
+bundle exec rspec-doom --debounce 0.5    # debounce in seconds
+bundle exec rspec-doom --notify-file n   # write notifications to a file (headless/CI)
+```
+
+Press Ctrl-C to stop.
+
+## Doom Images
+
+The gem includes 5 Doom-themed images (via Notiffany desktop notifications):
+
+- `doom1.png` — All tests passing
+- `doom2.png` — 1-2 failures
+- `doom3.png` — 3-5 failures
+- `doom4.png` — 6-10 failures
+- `doom5.png` — 11+ failures
+
+The images are Doom HUD sprites from id Software, included here as a fan and
+educational homage to the classic *autotest + growl + Doomguy* setup. DOOM and
+its sprites are trademarks of id Software or their respective owners; this
+project is not affiliated with or endorsed by id Software.
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/rspec-doom

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rspec-doom'
+
+exit RSpecDoom::CLI.start(ARGV)

data/lib/rspec/doom/cli.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module RSpecDoom
+  class CLI
+    def self.start(argv)
+      new(argv).run
+    end
+
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def run
+      options = parse_options
+      Watcher.new(options).run
+      0
+    end
+
+    private
+
+    def parse_options
+      options = { directories: [] }
+
+      parser = OptionParser.new do |opts|
+        opts.banner = 'Usage: rspec-doom [options] [dir …]'
+
+        opts.on('-c', '--cmd CMD', 'Command to run RSpec (default: bundle exec rspec)') do |cmd|
+          options[:cmd] = cmd
+        end
+
+        opts.on('-d', '--debounce SECONDS', Float, 'Debounce interval in seconds (default: 0.1)') do |sec|
+          options[:debounce] = sec
+        end
+
+        opts.on('--notify-file PATH', 'Write notifications to a file (useful for headless/CI)') do |path|
+          options[:notifiers] = [[:file, { path: path, format: "%s|%s|%s\n" }]]
+        end
+
+        opts.on('-h', '--help', 'Show this help') do
+          puts opts
+          exit
+        end
+      end
+
+      parser.parse!(@argv)
+      options[:directories] = @argv
+
+      options
+    end
+  end
+end

data/lib/rspec/doom/notifier.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'notiffany'
+
+module RSpecDoom
+  class Notifier
+    MESSAGES = {
+      1 => 'Minor casualties...',
+      2 => 'Taking damage!',
+      3 => 'It\'ll be fine... probably',
+      4 => 'REQUIRED: MORE DAKKA!',
+      5 => 'IMPS EVERYWHERE!'
+    }.freeze
+
+    def initialize(options = {})
+      @options = options
+      @notifier = nil
+    end
+
+    def connect
+      @notifier = Notiffany.connect({ title: 'RSpec Doom' }.merge(@options))
+    end
+
+    def disconnect
+      @notifier&.disconnect
+    end
+
+    def notify(result)
+      return if result[:error]
+
+      level = determine_level(result[:failures])
+      image_path = image_for(level)
+
+      message = build_message(result, level)
+
+      notifier.notify(
+        message,
+        title: 'RSpec Doom',
+        image: image_path
+      )
+    end
+
+    private
+
+    attr_reader :notifier
+
+    def determine_level(failures)
+      case failures
+      when 0 then 1
+      when 1..2 then 2
+      when 3..5 then 3
+      when 6..10 then 4
+      else 5
+      end
+    end
+
+    def images_path
+      File.join(__dir__, 'assets', 'images')
+    end
+
+    def image_for(level)
+      path = File.join(images_path, "doom#{level}.png")
+      return path if File.exist?(path)
+
+      nil
+    end
+
+    def build_message(result, level)
+      examples = result[:examples]
+      failures = result[:failures]
+
+      if result[:success]
+        "#{examples} tests - ALL CLEAR!"
+      else
+        "#{MESSAGES[level]} (#{failures} failures)"
+      end
+    end
+  end
+end

data/lib/rspec/doom/runner.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'shellwords'
+
+module RSpecDoom
+  class Runner
+    RSPEC_ARGS = %w[--no-color --format=progress].freeze
+
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options || {}
+    end
+
+    def run(paths = [])
+      cmd = [options[:cmd] || 'bundle exec rspec', *RSPEC_ARGS].join(' ')
+      cmd += " #{paths.flatten.compact.map { |p| Shellwords.escape(p.to_s) }.join(' ')}" if paths.any?
+
+      stdout, stderr, status = Open3.capture3(cmd)
+
+      parse_result([stdout, stderr].join("\n"), status.exitstatus)
+    end
+
+    private
+
+    def parse_result(output, exit_code)
+      failures = parse_failures(output)
+      examples = parse_examples(output)
+
+      if summary_missing?(output, examples)
+        {
+          success: false,
+          examples: examples,
+          failures: failures,
+          output: output,
+          error: no_summary_reason(output)
+        }
+      else
+        {
+          success: exit_code.zero? && failures.zero?,
+          examples: examples,
+          failures: failures,
+          output: output
+        }
+      end
+    end
+
+    def parse_failures(output)
+      output.scan(/(\d+) failures?/).first&.[](0)&.to_i || 0
+    end
+
+    def parse_examples(output)
+      output.scan(/(\d+) examples?/).first&.[](0)&.to_i || 0
+    end
+
+    def summary_missing?(output, examples)
+      examples.zero? && !output.include?('0 examples')
+    end
+
+    def no_summary_reason(output)
+      if output.include?('No examples found.')
+        'No examples found'
+      else
+        'RSpec failed to boot or produced no summary'
+      end
+    end
+  end
+end

data/lib/rspec/doom/version.rb

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

data/lib/rspec/doom/watcher.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'cruise'
+
+module RSpecDoom
+  class Watcher
+    EVENTS_INTERESTED_IN = %i[modified created renamed changed].freeze
+    DEFAULT_DEBOUNCE = 0.1
+
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    # Watches the configured directories and runs RSpec whenever a spec or a
+    # source file changes. Blocks until interrupted.
+    def run
+      notifier.connect
+      watch_loop
+    rescue Interrupt
+      nil
+    ensure
+      notifier.disconnect
+    end
+
+    # The directories to watch, defaulting to 'app' and 'spec'.
+    def directories
+      dirs = options[:directories]
+      dirs.nil? || dirs.empty? ? %w[app spec] : dirs
+    end
+
+    def debounce
+      options[:debounce] || DEFAULT_DEBOUNCE
+    end
+
+    def cmd
+      options[:cmd] || 'bundle exec rspec'
+    end
+
+    # The list of spec files to run for a changed path.
+    #
+    #   spec/foo_spec.rb            -> ['spec/foo_spec.rb']
+    #   app/models/foo.rb (exists)  -> ['spec/models/foo_spec.rb'] (if exists)
+    #   app/models/foo.rb (no spec) -> [] (run whole suite)
+    def paths_for(event_path)
+      relative = relative_path(event_path)
+
+      if spec_file?(relative)
+        [relative]
+      elsif source_file?(relative)
+        spec_for_source(relative)
+      else
+        []
+      end
+    end
+
+    private
+
+    def watch_loop
+      Cruise.watch(
+        *directories,
+        debounce: debounce,
+        only: EVENTS_INTERESTED_IN
+      ) do |event|
+        run_rspec(paths_for(event.path))
+      end
+    end
+
+    def run_rspec(paths)
+      notifier.notify(runner.run(paths))
+    end
+
+    def notifier
+      @notifier ||= Notifier.new(options)
+    end
+
+    def runner
+      @runner ||= Runner.new(options)
+    end
+
+    def relative_path(event_path)
+      return event_path unless event_path.start_with?(Dir.pwd)
+
+      event_path.sub("#{Dir.pwd}/", '')
+    end
+
+    def spec_file?(relative_path)
+      relative_path.start_with?('spec/') && relative_path.end_with?('_spec.rb')
+    end
+
+    def source_file?(relative_path)
+      directories.any? { |dir| relative_path.start_with?("#{dir}/") } &&
+        relative_path.end_with?('.rb')
+    end
+
+    def spec_for_source(relative_path)
+      candidate = relative_path.sub(%r{\A(app|lib)/}, 'spec/')
+                              .sub(/\.rb\z/, '_spec.rb')
+      File.file?(candidate) ? [candidate] : []
+    end
+  end
+end

data/lib/rspec/doom.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'rspec/doom/version'
+require 'rspec/doom/runner'
+require 'rspec/doom/notifier'
+require 'rspec/doom/watcher'
+require 'rspec/doom/cli'

data/lib/rspec-doom.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'rspec/doom'

data/rspec-doom.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec-doom'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Amalrik Maia']
+  spec.email         = ['amalrik.maia@gmail.com']
+  spec.summary       = 'RSpec file watcher with Doom-themed notifications'
+  spec.description   = 'Watches source and spec files with Cruise and runs RSpec, showing Doom guy notifications based on test results.'
+  spec.homepage      = 'https://github.com/amalrik/rspec-doom'
+  spec.license       = 'MIT'
+  spec.files         = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|\.github|\.ruby-lsp)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = ['rspec-doom']
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 3.2'
+
+  spec.metadata = {
+    'homepage_uri' => spec.homepage,
+    'source_code_uri' => spec.homepage,
+    'rubygems_mfa_required' => 'true'
+  }
+
+  spec.add_dependency 'cruise'
+  spec.add_dependency 'notiffany'
+  spec.add_dependency 'logger'
+
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: rspec-doom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Amalrik Maia
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cruise
+  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: notiffany
+  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: logger
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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: Watches source and spec files with Cruise and runs RSpec, showing Doom
+  guy notifications based on test results.
+email:
+- amalrik.maia@gmail.com
+executables:
+- rspec-doom
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/rspec-doom
+- lib/rspec-doom.rb
+- lib/rspec/doom.rb
+- lib/rspec/doom/assets/images/doom1.png
+- lib/rspec/doom/assets/images/doom2.png
+- lib/rspec/doom/assets/images/doom3.png
+- lib/rspec/doom/assets/images/doom4.png
+- lib/rspec/doom/assets/images/doom5.png
+- lib/rspec/doom/cli.rb
+- lib/rspec/doom/notifier.rb
+- lib/rspec/doom/runner.rb
+- lib/rspec/doom/version.rb
+- lib/rspec/doom/watcher.rb
+- rspec-doom.gemspec
+homepage: https://github.com/amalrik/rspec-doom
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/amalrik/rspec-doom
+  source_code_uri: https://github.com/amalrik/rspec-doom
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: RSpec file watcher with Doom-themed notifications
+test_files: []