rspec-watcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d56c09fc797e502a6ea38113634a79e2ccdff63d397fa0387b0d6e119daeb3f
+  data.tar.gz: 2ac174f52116b68c12e78d1aa96697d32deca1dd0137406a22b5cc70398f326a
+SHA512:
+  metadata.gz: 21149fae2370cecdb6292e49b2dbc6bce4a6342d48cca8ab58f6f36fe70a58027b0081ca41ad811abc13112195580681c38393ec073e3eb9d409776573b567f5
+  data.tar.gz: f1b7acc4119b35d3bdb39bc9ac73664d1a838e1dbf036a07fbdddd221c6a85d1c150556a35b94ed3fd48ffa76d32cd0c7552c43f9ae4a1304e54d78ab59b498b

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rspec_watcher.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Matous Vokal
+
+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,59 @@
+# RspecWatcher
+
+Automatically runs specs in reaction to changes in files. Loads the project once and uses code reloading to get changes instead of starting a new process for every test run.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rspec-watcher
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rspec-watcher
+
+## Usage
+
+Example configuration for a Rails project in `config/rspec_watcher.rb`:
+
+```ruby
+RSpecWatcher.configure do
+  watch 'spec', only: /_spec\.rb\z/ do |modified, added, _removed|
+    modified + added
+  end
+
+  watch 'spec', ignore: /_spec\.rb\z/
+
+  watch 'app', only: /\.rb\z/, ignore: %r{controllers/} do |modified, added, removed|
+    (modified + added + removed).map do |path|
+      path.sub('app/', 'spec/').sub('.rb', '_spec.rb')
+    end
+  end
+
+  watch 'app/controllers', only: /\.rb\z/ do |modified, added, removed|
+    (modified + added + removed).map do |path|
+      path.sub('app/', 'spec/').sub('controllers/', 'requests/').sub('_controller.rb', '_spec.rb')
+    end
+  end
+
+  watch 'config', only: /routes\.rb\z/
+end
+```
+
+Start the watcher with `RAILS_ENV=test bundle exec rake rspec_watcher:watch`
+
+In order to use trhe watcher without Rails, `path_inferrer` and `reloader` need to be configured. Check `lib/rspec_watcher.rb`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, 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/Sorc96/rspec-watcher.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/rspec-watcher.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative 'rspec_watcher/version'
+require_relative 'rspec_watcher/railtie' if defined?(Rails)
+
+module RSpecWatcher
+  SPEC_INFERRER = ->(_modified, _added, _removed) { [] }
+  PATH_INFERRER = ->(path) { Rails.root.join(path) }
+  RELOADER = -> { Rails.application.reloader.reload! }
+
+  @path_inferrer = PATH_INFERRER
+  @reloader = RELOADER
+
+  class << self
+    attr_accessor :path_inferrer, :reloader
+    attr_reader :rules
+
+    def configure(&block)
+      @rules = []
+      @failed_specs = []
+      instance_exec(&block)
+    end
+
+    def watch(path, **options, &inferrer)
+      inferrer ||= SPEC_INFERRER
+      rules << [path, options, inferrer]
+    end
+
+    def start
+      listeners.each(&:start)
+    end
+
+    private
+
+    def listeners
+      rules.map do |path, options, inferrer|
+        Listen.to(path_inferrer.call(path), **options) do |modified, added, removed|
+          run_specs(inferrer.call(modified, added, removed))
+        end
+      end
+    end
+
+    def run_specs(paths)
+      clear_screen
+      reloader.call
+      RSpec.clear_examples
+      RSpec.world.wants_to_quit = false
+      RSpec::Core::Runner.run(specs_to_run(paths))
+      prepare_failed_specs_for_rerun
+    end
+
+    def clear_screen
+      puts "\e[H\e[2J"
+    end
+
+    # Filter out nonexistent files and paths to specific lines if the whole file will be rerun
+    def specs_to_run(paths)
+      (paths + @failed_specs).reject do |path|
+        file_path = path.split(':').first
+        next true unless File.exist?(file_path)
+
+        path.include?(':') && paths.include?(file_path)
+      end
+    end
+
+    def prepare_failed_specs_for_rerun
+      @failed_specs = RSpec
+        .world
+        .all_examples
+        .select(&:exception)
+        .map(&:location_rerun_argument)
+        .map { |path| File.absolute_path(path) }
+    end
+  end
+end

data/lib/rspec_watcher/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RSpecWatcher
+  class Railtie < Rails::Railtie
+    railtie_name :rspec_watcher
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/rspec_watcher/tasks/watch.rake

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+namespace :rspec_watcher do
+  desc 'Start the watcher with configuration from config/rspec_watcher.rb'
+  task :watch do
+    abort('Not running in test environment') unless Rails.env.test?
+
+    require 'rspec/core'
+    require Rails.root.join('config/rspec_watcher')
+
+    RSpecWatcher.start
+
+    puts 'Watching specs...'
+    sleep
+  end
+end

data/lib/rspec_watcher/version.rb

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

data/rspec_watcher.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/rspec_watcher/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rspec-watcher"
+  spec.version = RSpecWatcher::VERSION
+  spec.authors = ["Matous Vokal"]
+  spec.email = ["matous.vokal@gmail.com"]
+
+  spec.summary = "Instant feedback for awesome TDD experience with RSpec."
+  spec.description = "Automatically runs specs in reaction to changes in files. Loads the project once and uses code reloading to get changes instead of starting a new process for every test run."
+  spec.homepage = "https://github.com/Sorc96/rspec-watcher"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Sorc96/rspec-watcher"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: rspec-watcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matous Vokal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-08-30 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'
+description: Automatically runs specs in reaction to changes in files. Loads the project
+  once and uses code reloading to get changes instead of starting a new process for
+  every test run.
+email:
+- matous.vokal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec-watcher.rb
+- lib/rspec_watcher/railtie.rb
+- lib/rspec_watcher/tasks/watch.rake
+- lib/rspec_watcher/version.rb
+- rspec_watcher.gemspec
+homepage: https://github.com/Sorc96/rspec-watcher
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Sorc96/rspec-watcher
+  source_code_uri: https://github.com/Sorc96/rspec-watcher
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key: 
+specification_version: 4
+summary: Instant feedback for awesome TDD experience with RSpec.
+test_files: []