spring-watcher-listen 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 561c71a39a3fed50f39fa8342ff3433a7fd38850
-  data.tar.gz: 6e7968fb40f74c0aa54f97f2890c925a3f8c7614
+SHA256:
+  metadata.gz: eead46e2623bf2ec3e1183ddfa664c23ed056e8e2c7722331ecc3d926888b762
+  data.tar.gz: 124e38605687859f9af1c4311a6ff3343c4e05b3720ded7a5c7258b3eda80586
 SHA512:
-  metadata.gz: 2bae5dcf527456279dc77d878a1b0d9e63ef93a182158add2acd673ba40999697adcf245af75a6b66da8a96a11a0fb82ccb980c30c164381e2658dc3ddfc1a28
-  data.tar.gz: 3748230009113fcee8f0cdbbcaf9e06f88785c9899fbbf7e2af80b778138532784db7d1703922240316913bfda7e0e209cad219f54633b62b3d7054405a22509
+  metadata.gz: 5579c3c246d29215cce0fd03f46270f88a3360e7b2aacaa4ac818329f8264a2ea5de7ab99b9a622c5f8cec1ce20f0e0ffd80f704b2560d4be635628c301d176a
+  data.tar.gz: 5cdd6f014c586cb628906e4bbed8a425c4dc357992dea33ace3fbf2cf0e929f084b1dfff8944bcc6f98c0f35bf5d713c49bf4d19cd2a3f40f3821ccf3f834913

data/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.7', '3.0', '3.1', 'head' ]
+        rails: [ '6.0', '6.1', '7.0', 'edge' ]
+        exclude:
+          - ruby: '3.1'
+            rails: '6.0'
+          - ruby: '3.1'
+            rails: '6.1'
+
+    env:
+      RAILS_VERSION: ${{ matrix.rails }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run unit tests
+        run: bundle exec rake test:unit
+        timeout-minutes: 3
+
+      - name: Run acceptance tests
+        run: bundle exec rake test:acceptance
+        timeout-minutes: 10
+        if: ${{ matrix.rails != 'edge' && matrix.ruby != 'head' }} # Acceptance tests use `gem install rails && rails new`

data/Gemfile

@@ -1,6 +1,13 @@
 source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 # Specify your gem's dependencies in spring-watcher-listen.gemspec
 gemspec
 
-gem "spring", github: "rails/spring"
+if ENV["RAILS_VERSION"] == "edge"
+  gem "activesupport", github: "rails/rails", branch: "main"
+elsif ENV["RAILS_VERSION"]
+  gem "activesupport", "~> #{ENV["RAILS_VERSION"]}.0"
+end
+
+gem "spring", github: "rails/spring", branch: "main"

data/README.md

@@ -1,15 +1,23 @@
 # Listen watcher for Spring
 
-[![Build Status](https://travis-ci.org/jonleighton/spring-watcher-listen.png?branch=master)](https://travis-ci.org/jonleighton/spring-watcher-listen)
+[![Build Status](https://app.travis-ci.com/rails/spring-watcher-listen.svg?branch=master)](https://app.travis-ci.com/github/rails/spring-watcher-listen)
 [![Gem Version](https://badge.fury.io/rb/spring-watcher-listen.png)](http://badge.fury.io/rb/spring-watcher-listen)
 
 This gem makes [Spring](https://github.com/rails/spring) watch the
 filesystem for changes using [Listen](https://github.com/guard/listen)
 rather than by polling the filesystem.
 
-Currently only Listen 1 is supported. However there is [an
-effort](https://github.com/jonleighton/spring-watcher-listen/issues/1)
-to implement Listen 2 support.
+On larger projects this means spring will be more responsive, more accurate and use less cpu on local filesystems.
+
+(NFS, shared VM folders and user file systems will still need polling)
+
+Listen 2.7 and higher and 3.0 are supported.
+If you rely on Listen 1 you can use v1.0.0 of this gem.
+
+## Environment variables
+
+* `DISABLE_SPRING_WATCHER_LISTEN` - If set, this disables the loading of this gem. This can be useful for projects where
+    some configurations do not support inotify (e.g. Docker on M1 Macs).
 
 ## Installation
 

data/Rakefile

@@ -1,10 +1,21 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.test_files = FileList["test/*_test.rb"]
-  t.verbose = true
+namespace :test do
+  Rake::TestTask.new(:unit) do |t|
+    t.libs << "test"
+    t.test_files = FileList["test/unit_test.rb"]
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:acceptance) do |t|
+    t.libs << "test"
+    t.test_files = FileList["test/acceptance_test.rb"]
+    t.verbose = true
+  end
 end
 
+desc 'Run tests'
+task test: ['test:unit', 'test:acceptance']
+
 task default: :test

data/lib/spring/watcher/listen.rb

@@ -1,3 +1,5 @@
+return if ENV['DISABLE_SPRING_WATCHER_LISTEN']
+
 require "spring/watcher"
 require "spring/watcher/abstract"
 
@@ -21,11 +23,16 @@ module Spring
 
       attr_reader :listener
 
+      def initialize(*)
+        super
+        @listener = nil
+      end
+
       def start
-        unless @listener
-          @listener = ::Listen.to(*base_directories, latency: latency, &method(:changed))
-          @listener.start
-        end
+        return if @listener
+
+        @listener = ::Listen.to(*base_directories, latency: latency, &method(:changed))
+        @listener.start
       end
 
       def stop
@@ -35,6 +42,10 @@ module Spring
         end
       end
 
+      def running?
+        @listener && @listener.processing?
+      end
+
       def subjects_changed
         return unless @listener
         return unless @listener.respond_to?(:directories)
@@ -43,7 +54,7 @@ module Spring
       end
 
       def watching?(file)
-        files.include?(file) || file.start_with?(*directories)
+        files.include?(file) || file.start_with?(*directories.keys)
       end
 
       def changed(modified, added, removed)
@@ -54,10 +65,18 @@ module Spring
         end
       end
 
+      def mark_stale
+        super
+
+        # May be called from listen thread which won't be happy
+        # about stopping itself, so stop from another thread.
+        Thread.new { stop }.join
+      end
+
       def base_directories
         ([root] +
-          files.reject       { |f| f.start_with? "#{root}/" }.map { |f| File.expand_path("#{f}/..") } +
-          directories.reject { |d| d.start_with? "#{root}/" }
+          files.keys.reject       { |f| f.start_with? "#{root}/" }.map { |f| File.expand_path("#{f}/..") } +
+          directories.keys.reject { |d| d.start_with? "#{root}/" }
         ).uniq.map { |path| Pathname.new(path) }
       end
     end

data/spring-watcher-listen.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "spring-watcher-listen"
-  spec.version       = "2.0.0"
+  spec.version       = "2.1.0"
   spec.authors       = ["Jon Leighton"]
   spec.email         = ["j@jonathanleighton.com"]
   spec.summary       = %q{Makes spring watch files using the listen gem.}
@@ -14,10 +14,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "activesupport"
 
-  spec.add_dependency "spring", "~> 1.2"
+  spec.add_dependency "spring", ">= 4"
   spec.add_dependency "listen", ">= 2.7", '< 4.0'
 end

data/test/helper.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 
 require "bundler/setup"
-require "spring/test"
+require File.dirname(Gem::Specification.find_by_name("spring").loaded_from) + "/test/support/test"
 require "minitest/autorun"
 
 if defined?(Celluloid)

data/test/unit_test.rb

@@ -1,5 +1,4 @@
 require "helper"
-require "spring/test/watcher_test"
 require "spring/watcher/listen"
 
 class ListenWatcherTest < Spring::Test::WatcherTest
@@ -7,6 +6,9 @@ class ListenWatcherTest < Spring::Test::WatcherTest
     Spring::Watcher::Listen
   end
 
+  # this test, as currently written, can only run against polling implementations
+  undef :test_add_directory_with_dangling_symlink
+
   setup do
     Celluloid.boot if defined?(Celluloid)
   end
@@ -27,8 +29,8 @@ class ListenWatcherTest < Spring::Test::WatcherTest
       dirs = [dir, other_dir_1, other_dir_2].sort.map { |path| Pathname.new(path) }
       assert_equal dirs, watcher.base_directories.sort
     ensure
-      FileUtils.rmdir other_dir_1
-      FileUtils.rmdir other_dir_2
+      FileUtils.rm_rf other_dir_1
+      FileUtils.rm_rf other_dir_2
     end
   end
 
@@ -49,8 +51,26 @@ class ListenWatcherTest < Spring::Test::WatcherTest
       dirs = [dir, other_dir_1, other_dir_2].sort.map { |path| Pathname.new(path) }
       assert_equal dirs, watcher.base_directories.sort
     ensure
-      FileUtils.rmdir other_dir_1
-      FileUtils.rmdir other_dir_2
+      FileUtils.rm_rf other_dir_1
+      FileUtils.rm_rf other_dir_2
     end
   end
+
+  test "stops listening when already stale" do
+    # Track when we're marked as stale.
+    on_stale_count = 0
+    watcher.on_stale { on_stale_count += 1 }
+
+    # Add a file to watch and start listening.
+    file = "#{@dir}/omg"
+    touch file, Time.now - 2.seconds
+    watcher.add file
+    watcher.start
+    assert watcher.running?
+
+    # Touch bumps mtime and marks as stale which stops listener.
+    touch file, Time.now - 1.second
+    Timeout.timeout(1) { sleep 0.1 while watcher.running? }
+    assert_equal 1, on_stale_count
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spring-watcher-listen
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Jon Leighton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-27 00:00:00.000000000 Z
+date: 2022-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: spring
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -93,8 +93,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -123,8 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Makes spring watch files using the listen gem.

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.2