fsr 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47ae417bf5a363655b2f31478d055e40e9c0ba5b74f6ced67b125c6104ca1400
-  data.tar.gz: 79bb260e4510283cda5b5a9c76e815cccf42cc35d722818e932e778d8d793c88
+  metadata.gz: 1007a1152ea79f91d7a34ae1ae49c0ca727f09249853e2c780345a44e9214f4e
+  data.tar.gz: 946ca1428e3d97e367b7f01b8f0bcff27849ae474b251f60c67437a9a7befee0
 SHA512:
-  metadata.gz: 73e9b6ab1ccede691b6a376e6f4ace4c672f179329776789843ce45a60ed233b49271860045ef9835a016990764a1cd2d5b255dc7f2d4112b7546a368171e699
-  data.tar.gz: d885c18291751204ffd5c2136aebe7e026d7f0e7fe1e5f2199e22e098eac5e265f641d3984546f4d1b674b2f6310bc897e50cc2353f565e2b491604cbf2405c8
+  metadata.gz: 96abacca6384358efdef8853019a10af4e15de3a3166d572ed4658feac5d406caf9322c39915020e7b7697889a350d2f5d69975d8b1e66c6b32b0ec564d39d11
+  data.tar.gz: b784142527032e170b5894a1a3052d4a9a5865aeb9ae72e2134d95758024d32fd29a2f10e2fa1374cf102f719bd3c74270f2e8072bd2eadee547fc5417c5a1fe

data/.ruby-version

@@ -0,0 +1 @@
+3.4.2

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    fsr (0.1.6)
+    fsr (0.1.7)
       listen
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    ffi (1.17.0-arm64-darwin)
+    ffi (1.17.0)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
     listen (3.9.0)
@@ -46,6 +46,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-22
+  x86_64-darwin-23
 
 DEPENDENCIES
   fsr!

data/README.md

@@ -1,34 +1,67 @@
-# Fsr
+# *fsr - fast spec runner*
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fsr`. To experiment with that code, run `bin/console` for an interactive prompt.
+`fsr` listens for file change events and runs RSpecs automatically in rails console avoiding the rails boot process and provides instant feedback which is crucial for Test Driven Development (TDD).
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
+1. Add `fsr` to your app’s `Gemfile` in `test`:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+   ```ruby
+   group :test do
+     gem 'fsr'
+   end
+   ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+2. Then, in your project directory:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+   ```sh
+   $ bundle install
+   ```
 
 ## Usage
 
-TODO: Write usage instructions here
+Open rails console in test environment.
+
+```rb
+ RAILS_ENV=test bundle exec rails c
+```
+
+All following examples should be run in this console.
+
+```rb
+listener = Fsr.listen(['spec/models/user_spec.rb'])
+listener.start
+```
+
+This will listen to any file change events, automatically load the changed file and run the given spec.
+
+To stop the listener,
+
+```rb
+listener.stop
+```
+
+By default, it listens for file change events on `app/`, `lib/`, `spec/` directories. This can be overriden with `listen` option.
+
+```rb
+Fsr.listen(['spec/models/user_spec.rb'], listen: ['dir/'])
+```
+
+You can pass any RSpec command line arguments. For example, to run based on line number.
 
-## Development
+```rb
+Fsr.listen(['spec/models/user_spec.rb:12'])
+```
 
-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 run based on line number.
 
-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).
+```rb
+Fsr.listen(['spec/models/user_spec.rb', 'spec/models/admin_spec.rb'])
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fsr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/fsr/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/elamaranae/fsr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/elamaranae/fsr/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -36,4 +69,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Fsr project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fsr/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Fsr project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/elamaranae/fsr/blob/master/CODE_OF_CONDUCT.md).

data/lib/fsr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fsr
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

data/lib/fsr.rb

@@ -2,7 +2,6 @@
 
 require_relative 'fsr/version'
 require 'listen'
-require 'rspec/core'
 
 $LOAD_PATH.push('spec')
 
@@ -18,22 +17,42 @@ $LOAD_PATH.push('spec')
 #   listener.stop
 # ```
 module Fsr
-  def self.listen(
-    run,
-    load: [],
-    listen:
-      [
-        "#{`pwd`.strip}/app",
-        "#{`pwd`.strip}/lib",
-        "#{`pwd`.strip}/spec"
-      ].select { |dir| Dir.exist?(dir) }
-  )
-    Listen.to(*listen) do |modified, added|
-      files = [modified, added].compact.flatten if load.empty?
-      Fsr::Runner.new(run, load: files).run
+  @listener = nil
+
+  LISTEN_DIRS = [
+    "#{`pwd`.strip}/app",
+    "#{`pwd`.strip}/api",
+    "#{`pwd`.strip}/components",
+    "#{`pwd`.strip}/lib",
+    "#{`pwd`.strip}/spec",
+    "#{`pwd`.strip}/db"
+  ].select { |dir| Dir.exist?(dir) }
+
+  def self.listen(run, load: [], listen: [])
+    require 'rspec/core'
+    ActiveRecord::Base.connection.reconnect!
+    @listener.stop rescue 'error'
+    @listener = build_listener(run, load: load, listen: listen)
+    @listener.start
+  end
+
+  def self.build_listener(run, load: [], listen: [])
+    listen = (listen.empty? ? LISTEN_DIRS : listen).select { |dir| Dir.exist?(dir) }
+    @listener = Listen.to(*listen) do |modified, added|
+      begin
+        files = [modified, added, load].compact.flatten
+        Fsr::Runner.new(run, load: files).run
+      rescue => e
+        puts "Something went wrong while loading the files or running the spec, #{e.message}, #{e.backtrace}"
+      end
     end
   end
 
+  def self.run(run, load: [])
+    ActiveRecord::Base.connection.reconnect!
+    Fsr::Runner.new(run, load: load).run
+  end
+
   def self.sandboxed
     orig_world   = RSpec.world
     orig_example = RSpec.current_example

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: fsr
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Elamaran Angusamy Elango
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-08 00:00:00.000000000 Z
+date: 2025-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: listen
@@ -24,7 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - maran@maran.dev
 executables: []
@@ -32,6 +30,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -50,7 +49,6 @@ metadata:
   homepage_uri: https://maran.dev
   source_code_uri: https://github.com/elamaranae/fsr
   changelog_uri: https://github.com/elamaranae/fsr/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -65,8 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Run RSpec fast by avoiding full app boot
 test_files: []