hot_reloader 0.7.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9421c166738e6fafb613ca2dac2bc28bd99b53a6229d4c0720db14f2e0c0ae25
-  data.tar.gz: a5677eaf835907fc683a591bd5e746008aa9fe42f296fa0585372482f2df92fd
+  metadata.gz: 60fe9c1bc640e084227e44fe285fd940790c3e4425a36a3494414eb6a6cf93d7
+  data.tar.gz: fbe788f0e5da017499b2780ce934e00ef27c02301aa446e3eac3991c28a93935
 SHA512:
-  metadata.gz: 14c1d5918b46577369366f01912de5b1b61907195eedf2c182b87022c1d33796a65ec43a90efe21e72d3211b341b29a247c24383f2da499ed5a7a98116dc136b
-  data.tar.gz: f6668adecc4df04439245a41d5b7327ec03b0f3e14b8bee313ec529b9275ebc5b57a4667d93c85e1e21118a54b33169d77765bb83eca73e8c24491eeb2091e0a
+  metadata.gz: 5ed01f7515b65f43cf4a07b1665de7c7bf023158ff1b2f4cca85a567cbb20d9647a0a82618c13a51d8cc81dbafcd4d0a7b1ec68a3c003e517b43558591d464e2
+  data.tar.gz: da50e1402b1b1410309c71d5d1290a7308f2682df1e9179980306240ce2dd3b0cb3562b1fca2a1cc8f96f2208d6d3eea31b92b0bd95be496dc1df9e99563d6e0

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`.
 
@@ -112,7 +98,7 @@ newest code in `routes/blog.rb` from the Dir each loop.
 
 For achieve this, you only need pass listened folders to will_listen method as secondary arg.
 
-```
+```rb
 loader = Zeitwerk::Loader.new
 loader.push_dir("#{__dir__}/../app")
 
@@ -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/version.rb

@@ -1,5 +1,13 @@
 # frozen_string_literal: true
 
-class HotReloader
-  VERSION = '0.7.0'
+module HotReloader
+  VERSION = [0, 8, 2]
+
+  class << VERSION
+    include Comparable
+
+    def to_s
+      join('.')
+    end
+  end
 end

data/lib/hot_reloader.rb

@@ -10,10 +10,13 @@ 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.
+    # @yield [] ruby code will be run after Zeitwerk loader get reloaded.
     # @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 +42,14 @@ 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) do
+        loader.reload
+        yield if block_given?
+      end.start
     end
 
     # Enable autoload ruby file based on default Zeitwerk rule.
@@ -47,7 +57,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hot_reloader
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Billy.Zheng(zw963)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-14 00:00:00.000000000 Z
+date: 2022-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: ritual
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 description: A dead simple ruby code hot reloader wrap around zeitwerk and listen.
 email:
 - vil963@gmail.com
@@ -68,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: A dead simple ruby code hot reloader wrap around zeitwerk and listen.