hot_reloader 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 461d4f4d7e55f277ac68ad3757ff3a5de4e854d8f994bf497643cc405ac12da3
-  data.tar.gz: '0399e4aba6fe95c3fb25c4fcd414552859fa1cc8bf530a43a1df465125f8893c'
+  metadata.gz: 9421c166738e6fafb613ca2dac2bc28bd99b53a6229d4c0720db14f2e0c0ae25
+  data.tar.gz: a5677eaf835907fc683a591bd5e746008aa9fe42f296fa0585372482f2df92fd
 SHA512:
-  metadata.gz: 5ad70767d0a9e17bfedb28823ee60bf4dad0fb306a553207008b59a52a37a9136fc9f6143e771f10d0bf246cba5308a4c5c8b600d62aa5fab98d20e484936de5
-  data.tar.gz: 1e0b7f132a276c4b43bc2aa62b81796109c967900226fd579d52cf4b7731aaf3b475073df7d437bcedd3fa7d0db0500fda26b541bf2d44472b7f5d4a36721286
+  metadata.gz: 14c1d5918b46577369366f01912de5b1b61907195eedf2c182b87022c1d33796a65ec43a90efe21e72d3211b341b29a247c24383f2da499ed5a7a98116dc136b
+  data.tar.gz: f6668adecc4df04439245a41d5b7327ec03b0f3e14b8bee313ec529b9275ebc5b57a4667d93c85e1e21118a54b33169d77765bb83eca73e8c24491eeb2091e0a

data/README.md

@@ -27,15 +27,16 @@ Following is a example for use hot_reloader with [Roda](https://github.com/jerem
 
 require_relative './config/environment'
 
-if ENV['RACK_ENV'] == 'production'
-  run App.freeze.app
-else
+if ENV['RACK_ENV'] == 'development'
   run ->(env) { App.call(env) }
+else
+  run App.freeze.app
 end
 ```
 
 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`.
 
 ```rb
 # config/environment.rb
@@ -44,20 +45,17 @@ require 'bundler'
 Bundler.require(:default, ENV.fetch('RACK_ENV', "development"))
 require_relative 'application'
 
-loader = Zeitwerk::Loader.new
-loader.push_dir("#{__dir__}/../app")
-loader.push_dir("#{__dir__}/../app/models")
-loader.inflector.inflect "ar" => "AR"
+paths = ["#{__dir__}/../app", "#{__dir__}/../app/models"]
 
-if ENV['RACK_ENV'] == 'production'
-  HotReloader.eager_load(loader)
+if ENV['RACK_ENV'] == 'development'
+  HotReloader.will_listen(*paths)
 else
-  HotReloader.will_listen(loader)
+  HotReloader.eager_load(*paths)
 end
 ```
 
-Or use more simple form (if you don't need setup Zeitwerk loader youself)
-
+For more advanced case(e.g. you need setup zeitwerk loader instance yourself), you
+can pass this instance to HotReloader methods too.
 
 ```rb
 # config/environment.rb
@@ -66,12 +64,64 @@ require 'bundler'
 Bundler.require(:default, ENV.fetch('RACK_ENV', "development"))
 require_relative 'application'
 
-paths = ["#{__dir__}/../app", "#{__dir__}/../app/models"]
+loader = Zeitwerk::Loader.new
+loader.push_dir("#{__dir__}/../app")
+loader.push_dir("#{__dir__}/../app/models")
 
-if ENV['RACK_ENV'] == 'production'
-  HotReloader.eager_load(*paths)
+if ENV['RACK_ENV'] == 'development'
+  HotReloader.will_listen(loader)
 else
-  HotReloader.will_listen(*paths)
+  HotReloader.eager_load(loader)
+end
+```
+
+When you change root directories files(app/*.rb or app/models/*.rb for above case), 
+all monitored files will be reload.
+
+it is possible to trigger reload from any `.rb` files, even this file not follow constant 
+lookup name convention, and this file folder not add to root directories use `push_dir` method.
+
+Following is a example.
+
+```rb
+# app/app.rb
+
+class App < Roda
+  plugin :hash_routes
+  
+  Dir["routes/**/*.rb"].each do |route_file|
+    load route_file
+  end
+end
+```
+
+```rb
+# routes/blog.rb
+
+class App
+  hash_routes.on "blog" do |r|
+    "blog"
+  end
+end
+```
+
+`routes/blog.rb` is not follow constant lookup name convention, so, `routes/` folder can't be
+add to root directories use push_dir method, but you can always trigger with `loader.reload`
+if `routes/blog.rb` was changed, then when `app/app.rb` reloaded, it will load the
+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.
+
+```
+loader = Zeitwerk::Loader.new
+loader.push_dir("#{__dir__}/../app")
+
+listened_folders = ["#{__dir__}/../routes"]
+
+if ENV['RACK_ENV'] == 'development'
+  HotReloader.will_listen(loader, listened_folders)
+else
+  HotReloader.eager_load(loader)
 end
 ```
 
@@ -80,7 +130,9 @@ Write whatever application initialize code which need add into application.rb
 ```rb
 # config/application.rb
 
-DB = Sequel.connect(ENV.fetch("DATABASE_URL"), timeout: 10000)
+DB = Sequel.connect(ENV.fetch("#{ENV.fetch('RACK_ENV', "development").upcase}_DATABASE_URL"), timeout: 10000)
+Sequel::Model.plugin :timestamps
+Sequel.extension :symbol_aref
 ```
 
 Add roda code into app/app.rb
@@ -114,7 +166,9 @@ Directory structure is like this:
 └── Gemfile.lock
 ```
 
-Change code in app.rb, **all constant get removed from memory, and app.rb evaluated again**!
+After change code in app.rb, **all constant get removed from memory, and app.rb evaluated again**!
+
+For a more rich WIP sample project, please check my another project [marketbet_crawler](https://github.com/zw963/marketbet_crawler).
 
 ## Support
 

data/lib/hot_reloader.rb

@@ -10,31 +10,36 @@ 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)
+    # @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.
     # @return nil
     def will_listen(*folders, logger: Logger.new(IO::NULL), ignore: [])
       folders = folders.flatten
 
       if folders.first.is_a? Zeitwerk::Loader
-        loader = folders.first
+        loader, *listened_folders = folders
         folders = loader.root_dirs.keys
+        # `folders' will add to zeitwerk root directories and listened.
+        # `reloadable_folder' listened only, it can be reload dynamically.
+        # but not constant lookup use name convention.
       else
         loader = Zeitwerk::Loader.new
 
-        raise 'you must set the root folders from which you want to load watched files.' if folders&.empty?
+        raise 'you must set the root directories from which you want to load watched files.' if folders&.empty?
         raise 'ignore: only accept an array of glob patterns string or Pathname objects.' unless ignore.is_a? Array
 
         folders.each {|folder| loader.push_dir(folder) }
+        listened_folders = []
       end
 
       loader.enable_reloading if loader.respond_to? :enable_reloading
       loader.logger = logger
-
       loader.ignore(ignore) unless ignore.empty?
-
       loader.setup
-      Listen.to(*folders, wait_for_delay: 1) { loader.reload }.start
+
+      Listen.logger = logger
+
+      Listen.to(*(folders + listened_folders), wait_for_delay: 1, ignore: /\.#.*/) { loader.reload }.start
     end
 
     # Enable autoload ruby file based on default Zeitwerk rule.
@@ -42,9 +47,9 @@ 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)
+    # @param [#call] logger logger or any object should response call, e.g. method(:puts), $stdout, $stderr.
     # @return nil
-    def eager_load(*folders, logger: Logger.new(IO::NULL))
+    def eager_load(*folders, logger: Logger.new(IO::NULL), ignore: [])
       folders = folders.flatten
 
       if folders.first.is_a? Zeitwerk::Loader
@@ -52,12 +57,15 @@ class HotReloader
         folders = loader.root_dirs.keys
       else
         loader = Zeitwerk::Loader.new
-        raise 'you must set the root folders from which you want to load watched files.' if folders&.empty?
+
+        raise 'you must set the root directories from which you want to load watched files.' if folders&.empty?
+        raise 'ignore: only accept an array of glob patterns string or Pathname objects.' unless ignore.is_a? Array
 
         folders.each {|folder| loader.push_dir(folder) }
       end
 
       loader.logger = logger
+      loader.ignore(ignore) unless ignore.empty?
 
       loader.setup
       loader.eager_load

data/lib/hot_reloader/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hot_reloader
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Billy.Zheng(zw963)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-08 00:00:00.000000000 Z
+date: 2021-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: A dead simple ruby code hot reloader wrap around zeitwerk and listen.