hot_reloader 0.4.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 653d3d0ea04c00516d19cbccfbc434c065dfbfc6bc0a2da9b4b6a48c21c9a8e4
-  data.tar.gz: cfa179f1a802f6585ed42ae2a6dc5b3a3b89ce23cdedf33444a7750e6e8311b7
+  metadata.gz: 2662bca54aa2c3c8037bba0968b11b55ed697649fd4db820605db4a691d87e24
+  data.tar.gz: 7233061e421dfffb81445cdd11b2f23a9cfe8ad0b7f713a6c999a673790e5342
 SHA512:
-  metadata.gz: 4a8b390f967df6eca1ed620508f2144e96dc89d52019232f108b2813dc22bb4f0af516220699af28347e95e96ec318170976d7cabf66150a9a3de033431b06b2
-  data.tar.gz: 8408367dc5eadf1fc7278bd9ad40a10ae557c842b53f32df5faeb1726e6f80fbdc7ba73614fc9f74762238a2eceb34042be4fbbb983c6ffdd2cab48c5d6baebf
+  metadata.gz: 95f5e16fe369b17f8fd9ec71a8fb32cc285f94b6b18ad1cc4c6b9ef4088863cc4aab229beede4e18a0f49b3e715ddd095eb018f0540cb9c1ffb432ef2d46cba9
+  data.tar.gz: 91921b33d2ddb6218452dbcf5ab9069dbd44584fe390dd2c03d25eb28b587d6c6db01f67bb3a15ef1d459c5da8bcb1404eed1306fd44b2f8a8cd13df28fbcaae

data/README.md

@@ -1,4 +1,4 @@
-# HotReloader [![Build Status](https://travis-ci.org/zw963/hot_reloader.svg?branch=master)](https://travis-ci.org/zw963/hot_reloader) [![Gem Version](https://badge.fury.io/rb/hot_reloader.svg)](http://badge.fury.io/rb/hot_reloader)
+# HotReloader [![Build Status](https://travis-ci.com/zw963/hot_reloader.svg?branch=master)](https://travis-ci.com/zw963/hot_reloader) [![Gem Version](https://badge.fury.io/rb/hot_reloader.svg)](http://badge.fury.io/rb/hot_reloader)
 
 A dead simple ruby code hot reloader wrap around [zeitwerk](https://github.com/fxn/zeitwerk) and [listen](https://github.com/guard/listen).
 
@@ -20,31 +20,138 @@ Add to your Gemfile
 
 Following is a example for use hot_reloader with [Roda](https://github.com/jeremyevans/roda):
 
+### 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.ru
+# config/environment.rb
+
+require 'bundler'
+Bundler.require(:default, ENV.fetch('RACK_ENV', "development"))
+require_relative 'application'
 
-require 'roda'
-require 'hot_reloader'
+paths = ["#{__dir__}/../app", "#{__dir__}/../app/models"]
 
-if ENV['RACK_ENV'] == 'production'
-  HotReloader.eager_load('path1', 'path2')
-  run App
+if ENV['RACK_ENV'] == 'development'
+  HotReloader.will_listen(*paths)
 else
-  HotReloader.will_listen('path1',  'path2'')
-  run ->(env) { App.call(env) }
+  HotReloader.eager_load(*paths)
 end
 ```
 
+For more advanced case(e.g. you need setup zeitwerk loader instance yourself), you
+can pass this instance to HotReloader methods too.
+
 ```rb
-# app.rb
+# config/environment.rb
+
+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")
+
+if ENV['RACK_ENV'] == 'development'
+  HotReloader.will_listen(loader)
+else
+  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
-  articles = []
+  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
+```
+
+### 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
+
+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
+
+```rb
+# app/app.rb
+
+class App < Roda
+  articles = ['programming ruby', 'programming rust']
   route do |r|
     r.post "articles" do
-    articles << r.params["content"]
-    "Count: #{articles.count}"
+      articles << r.params["content"]
+      "Count: #{articles.count}"
+    end
+	
+	r.get "articles" do
+      articles.join(', ')
     end
   end
 end
@@ -53,13 +160,17 @@ end
 Directory structure is like this:
 
 ```
-├── app.rb
+├── app/app.rb
+├── config/environment.rb
+├── config/application.rb
 ├── config.ru
 ├── Gemfile
 └── 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
 
@@ -68,8 +179,9 @@ Change code in app.rb, **all constant get removed from memory, and app.rb evalua
 
 ## 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

@@ -9,40 +9,70 @@ class HotReloader
     # Should be used for development mode only.
     #
     # @param [*String, Array<String>] folders Folders which should be monitor, can be multi-args or array.
-    # @param [#call] logger logger or any object should response call.
-    # @param [Array<String>] ignore Glob patterns or Pathname object which should be excluded.
+    #   or only one Zeitwerk::Loader object can be provided.
+    # @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: method(:puts), ignore: [])
-      loader = Zeitwerk::Loader.new
+    def will_listen(*folders, logger: Logger.new(IO::NULL), ignore: [], wait_for_delay: nil, listen_ignore: [])
       folders = folders.flatten
 
-      raise 'you must set the root folders 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
+      if folders.first.is_a? Zeitwerk::Loader
+        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 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
 
-      folders.each {|folder| loader.push_dir(folder) }
       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_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.
     # More rule see https://github.com/fxn/zeitwerk
     #
     # @param [*String, Array<String>] folders folders which should be autoload, can be multi-args or array.
-    # @param [#call] logger logger or any object should response call.
+    #   or only one Zeitwerk::Loader object can be provided.
+    # @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: method(:puts))
-      loader = Zeitwerk::Loader.new
+    def eager_load(*folders, logger: Logger.new(IO::NULL), ignore: [])
       folders = folders.flatten
 
-      raise 'you must set the root folders from which you want to load watched files.' if folders&.empty?
+      if folders.first.is_a? Zeitwerk::Loader
+        loader = folders.first
+        folders = loader.root_dirs.keys
+      else
+        loader = Zeitwerk::Loader.new
+
+        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
 
-      folders.each {|folder| loader.push_dir(folder) }
       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.4.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.4.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Billy.Zheng(zw963)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2021-08-06 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.