hot_reloader 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9421c166738e6fafb613ca2dac2bc28bd99b53a6229d4c0720db14f2e0c0ae25
-  data.tar.gz: a5677eaf835907fc683a591bd5e746008aa9fe42f296fa0585372482f2df92fd
+  metadata.gz: 2662bca54aa2c3c8037bba0968b11b55ed697649fd4db820605db4a691d87e24
+  data.tar.gz: 7233061e421dfffb81445cdd11b2f23a9cfe8ad0b7f713a6c999a673790e5342
 SHA512:
-  metadata.gz: 14c1d5918b46577369366f01912de5b1b61907195eedf2c182b87022c1d33796a65ec43a90efe21e72d3211b341b29a247c24383f2da499ed5a7a98116dc136b
-  data.tar.gz: f6668adecc4df04439245a41d5b7327ec03b0f3e14b8bee313ec529b9275ebc5b57a4667d93c85e1e21118a54b33169d77765bb83eca73e8c24491eeb2091e0a
+  metadata.gz: 95f5e16fe369b17f8fd9ec71a8fb32cc285f94b6b18ad1cc4c6b9ef4088863cc4aab229beede4e18a0f49b3e715ddd095eb018f0540cb9c1ffb432ef2d46cba9
+  data.tar.gz: 91921b33d2ddb6218452dbcf5ab9069dbd44584fe390dd2c03d25eb28b587d6c6db01f67bb3a15ef1d459c5da8bcb1404eed1306fd44b2f8a8cd13df28fbcaae

data/README.md

@@ -20,21 +20,7 @@ Add to your Gemfile
 
 Following is a example for use hot_reloader with [Roda](https://github.com/jeremyevans/roda):
 
-`config.ru` which used to start rack based web server with `command rackup -o 0.0.0.0 -p 9393`
-
-```rb
-# config.ru
-
-require_relative './config/environment'
-
-if ENV['RACK_ENV'] == 'development'
-  run ->(env) { App.call(env) }
-else
-  run App.freeze.app
-end
-```
-
-Add loader initialize code into `config/environment.rb`
+### Add loader initialize code into `config/environment.rb`
 
 For simple use case, you just need pass paths to `HotReloader.eager_load` or `HotReloader.will_listen`.
 
@@ -125,7 +111,23 @@ else
 end
 ```
 
-Write whatever application initialize code which need add into application.rb
+### Add other app files
+
+`config.ru` which used to start rack based web server with `command rackup -o 0.0.0.0 -p 9393`
+
+```rb
+# config.ru
+
+require_relative './config/environment'
+
+if ENV['RACK_ENV'] == 'development'
+  run ->(env) { App.call(env) }
+else
+  run App.freeze.app
+end
+```
+
+Write whatever application needed initialize code into config/application.rb
 
 ```rb
 # config/application.rb
@@ -177,8 +179,9 @@ For a more rich WIP sample project, please check my another project [marketbet_c
 
 ## Dependency
 
-zeitwerk https://github.com/fxn/zeitwerk
-listen https://github.com/guard/listen
+[zeitwerk](https://github.com/fxn/zeitwerk) https://github.com/fxn/zeitwerk
+
+[listen](https://github.com/guard/listen) https://github.com/guard/listen
 
 ## Contributing
 

data/lib/hot_reloader.rb

@@ -10,10 +10,12 @@ class HotReloader
     #
     # @param [*String, Array<String>] folders Folders which should be monitor, can be multi-args or array.
     #   or only one Zeitwerk::Loader object can be provided.
-    # @param [#call] logger logger or any object should response call, e.g. method(:puts), $stdout, $stderr.
-    # @param [Array<String>] ignore Glob patterns or Pathname object which should be excluded.
+    # @param [#call] logger logger object, e.g. Logger.new($stdout).
+    # @param [Array<String>, Array<Pathname>] ignore File names, Glob patterns or Pathname object which should be excluded for zeitwerk.
+    # @param [Integer] wait_for_delay Set the delay (in seconds) before call loader.reload when changes exist.
+    # @param [Array<Regexp>] listen_ignore The regexp pattern which don't want listen on.
     # @return nil
-    def will_listen(*folders, logger: Logger.new(IO::NULL), ignore: [])
+    def will_listen(*folders, logger: Logger.new(IO::NULL), ignore: [], wait_for_delay: nil, listen_ignore: [])
       folders = folders.flatten
 
       if folders.first.is_a? Zeitwerk::Loader
@@ -39,7 +41,11 @@ class HotReloader
 
       Listen.logger = logger
 
-      Listen.to(*(folders + listened_folders), wait_for_delay: 1, ignore: /\.#.*/) { loader.reload }.start
+      listen_options = {ignore: [/\A\.?#/]}
+      listen_options.merge!({wait_for_delay: wait_for_delay}) if wait_for_delay
+      listen_options[:ignore].concat listen_ignore if listen_ignore
+
+      Listen.to(*(folders + listened_folders), listen_options) { loader.reload }.start
     end
 
     # Enable autoload ruby file based on default Zeitwerk rule.
@@ -47,7 +53,8 @@ class HotReloader
     #
     # @param [*String, Array<String>] folders folders which should be autoload, can be multi-args or array.
     #   or only one Zeitwerk::Loader object can be provided.
-    # @param [#call] logger logger or any object should response call, e.g. method(:puts), $stdout, $stderr.
+    # @param [#call] logger logger object, e.g. Logger.new($stdout)
+    # @param [Array<String>, Array<Pathname>] ignore File names, Glob patterns or Pathname object which should be excluded for zeitwerk.
     # @return nil
     def eager_load(*folders, logger: Logger.new(IO::NULL), ignore: [])
       folders = folders.flatten

data/lib/hot_reloader/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class HotReloader
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hot_reloader
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Billy.Zheng(zw963)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-14 00:00:00.000000000 Z
+date: 2021-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk