rspec-watcher 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9a41ee072bb0c0c9e649e1a1513709ae253e08b8c8032079eed9b59e87f3261
-  data.tar.gz: e405302ba9cdfab0e69f2a0805b2ede9f34df5f5eac4ef3591c210acb317137e
+  metadata.gz: 298785cbb1ce4aa2e1bbd5cf68e6b2e00537cb4395b738f6d10823703de22ed5
+  data.tar.gz: 770ed8be7ea9c8ec239147669b6b4751d436467f30c2f15a825db8c777bee822
 SHA512:
-  metadata.gz: de7843b4b6b91c445d1382269d93cdca4f22b1bf053a0c5bf73dbfdcf3ec799e525a560c1488d4dfca5f3a4a7cc9c2bbc0a8ff7e60b6f45a8b9a9f36cb2762c2
-  data.tar.gz: 1293ed84837d6c56a09a1d04577e8444699f5c2098a4544a0d80e9a77349d47e80238680d55b338b3a86060b4d3a4e9cc5240a8bac9b95497a08ee480b2ae67a
+  metadata.gz: 10868133ea19816f38a8688f35cdf2e586e6ff9cd1a456777f603ba33a5fd575e737f74ada3461a6b266ec1bbe5c9933bbb2719b3eac62d7d496c7fb99e15b49
+  data.tar.gz: dfc02f84e633cd55fd4131b2459f5749235b4189caf01769d0e3c6fc63b67c2db83c0939c601aee0adebf35c7ac27bea34b07774253fa1b9962fe41c8c40a2aa

data/README.md

@@ -1,49 +1,67 @@
-# RspecWatcher
+# 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. Needs to be restarted after changes to files that do not get reloaded.
+Provides an instant feedback loop for TDD with RSpec. Automatically runs specs in reaction to changes in files. Inspired by [Guard](https://github.com/guard/guard), but unlike Guard, the watcher does not start a new process every time. It only loads the project once and uses code reloading to get changes. Needs to be restarted after changes to files that do not get reloaded (just like you would restart a Rails development server).
 
-## Installation
+Specs that fail are remembered and will be rerun until they pass again. This enables a nearly instant TDD feedbeck loop, because every spec we add will be automatically picked up and run until we add the implementation.
 
-Install the gem and add to the application's Gemfile by executing:
+## Installation
 
-    $ bundle add rspec-watcher
+Add `rspec-watcher` to the Gemfile, only needs to exist in the `test` group.
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```ruby
+group :test do
+  gem 'rspec-watcher'
+end
+```
 
-    $ gem install rspec-watcher
+Then run `bundle install`
 
 ## Usage
 
-Start the watcher with `RAILS_ENV=test bundle exec rake rspec_watcher:watch`
+### Configuration
 
-In order to use the watcher without Rails, `path_inferrer` and `reloader` need to be configured. Check `lib/rspec_watcher.rb`. The rake task also assumes usage inside a Rails project.
+Disable caching classes in `config/environments/test.rb` when the watcher is running:
 
-Configuration can be specified in `config/rspec_watcher.rb`, this is the default:
+```ruby
+config.cache_classes = ENV['RSPEC_WATCHER'].nil?
+```
+
+Rules for the watcher and other options can be customized, for example in a Rails initializer. Not passing a block to a `watch` rule will run all specs. The configuration shown here is used by default:
 
 ```ruby
-RSpecWatcher.configure do
-  watch 'spec', only: /_spec\.rb\z/ do |modified, added, _removed|
-    modified + added
-  end
+# config/initializers/rspec_watcher.rb
 
-  watch 'spec', ignore: /_spec\.rb\z/
+if ENV['RSPEC_WATCHER']
+  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')
+    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
-  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')
+    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
-  end
 
-  watch 'config', only: /routes\.rb\z/
+    watch 'config', only: /routes\.rb\z/
+  end
 end
 ```
 
+### Running the watcher
+
+Start the watcher with `RAILS_ENV=test bundle exec rake rspec_watcher:watch`
+
+In order to use the 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.

data/lib/rspec-watcher.rb

@@ -10,6 +10,7 @@ module RSpecWatcher
 
   @path_inferrer = PATH_INFERRER
   @reloader = RELOADER
+  @rules = []
 
   class << self
     attr_accessor :path_inferrer, :reloader

data/lib/rspec_watcher/tasks/watch.rake

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
 namespace :rspec_watcher do
-  desc 'Start the watcher with configuration from config/rspec_watcher.rb'
+  desc 'Start the watcher'
   task :watch do
-    abort('Not running in test environment') unless Rails.env.test?
+    abort('Not running in test environment') if defined?(Rails) && !Rails.env.test?
 
     require 'rspec/core'
 
-    config_path = Rails.root.join('config/rspec_watcher').to_s
-    if File.exist?(config_path)
-      require config_path
-    else
+    ENV['RSPEC_WATCHER'] = 'true'
+
+    if RSpecWatcher.rules.empty?
       require_relative '../default_configuration'
+      puts 'Using default configuration'
     end
 
     RSpecWatcher.start

data/lib/rspec_watcher/version.rb

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

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rspec-watcher
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Matous Vokal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-30 00:00:00.000000000 Z
+date: 2023-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -42,7 +42,6 @@ files:
 - 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

data/rspec_watcher.gemspec

@@ -1,30 +0,0 @@
-# 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