hot_reloader 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 653d3d0ea04c00516d19cbccfbc434c065dfbfc6bc0a2da9b4b6a48c21c9a8e4
-  data.tar.gz: cfa179f1a802f6585ed42ae2a6dc5b3a3b89ce23cdedf33444a7750e6e8311b7
+  metadata.gz: c2bf9cabe1a8e3383c6fcdaaa3530f249a5df5742918831bc414aa30ae9b251f
+  data.tar.gz: c4e1a3e0ddbc2332b16be27c4758d015e602b3cb9c4ddad70f257144c7004440
 SHA512:
-  metadata.gz: 4a8b390f967df6eca1ed620508f2144e96dc89d52019232f108b2813dc22bb4f0af516220699af28347e95e96ec318170976d7cabf66150a9a3de033431b06b2
-  data.tar.gz: 8408367dc5eadf1fc7278bd9ad40a10ae557c842b53f32df5faeb1726e6f80fbdc7ba73614fc9f74762238a2eceb34042be4fbbb983c6ffdd2cab48c5d6baebf
+  metadata.gz: c8d4d1580458d66f0a03fdeb252f57074776d6dd07dd6711f805e537ff87267f8c3b24cc289e44d62657a8308e41e56e6233f0e5e7600516684490412dd0432a
+  data.tar.gz: d2708191113c9441b7a8a769463ce5c6bd1967323703440d654de2e84e54625e289b2ffc920d52506b9045d16bdb7ca6171fe8f3f99aa79c9b614309b5f58975

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,85 @@ 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 'roda'
-require 'hot_reloader'
+require_relative './config/environment'
 
 if ENV['RACK_ENV'] == 'production'
-  HotReloader.eager_load('path1', 'path2')
-  run App
+  run App.freeze.app
 else
-  HotReloader.will_listen('path1',  'path2'')
   run ->(env) { App.call(env) }
 end
 ```
 
+Add loader initialize code into `config/environment.rb`
+
+
 ```rb
-# app.rb
+# config/environment.rb
 
-class App < Roda
-  articles = []
+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"
+
+if ENV['RACK_ENV'] == 'production'
+  HotReloader.eager_load(loader)
+else
+  HotReloader.will_listen(loader)
+end
+```
+
+Or use more simple form (if you don't need setup Zeitwerk loader youself)
+
+
+```rb
+# config/environment.rb
+
+require 'bundler'
+Bundler.require(:default, ENV.fetch('RACK_ENV', "development"))
+
+paths = ["#{__dir__}/../app", "#{__dir__}/../app/models"]
 
+if ENV['RACK_ENV'] == 'production'
+  HotReloader.eager_load(*paths)
+else
+  HotReloader.will_listen(*paths)
+end
+
+require_relative 'application'
+```
+
+Write whatever application initialize code which need add into application.rb
+
+```rb
+# config/application.rb
+
+DB = Sequel.connect(ENV.fetch("DATABASE_URL"), timeout: 10000)
+```
+
+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,7 +107,9 @@ end
 Directory structure is like this:
 
 ```
-├── app.rb
+├── app/app.rb
+├── config/environment.rb
+├── config/application.rb
 ├── config.ru
 ├── Gemfile
 └── Gemfile.lock

data/lib/hot_reloader.rb

@@ -9,17 +9,25 @@ 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.
+    #   or only one Zeitwerk::Loader object can be provided.
     # @param [#call] logger logger or any object should response call.
     # @param [Array<String>] ignore Glob patterns or Pathname object which should be excluded.
     # @return nil
     def will_listen(*folders, logger: method(:puts), ignore: [])
-      loader = Zeitwerk::Loader.new
       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 = folders.first
+        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 '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.enable_reloading if loader.respond_to? :enable_reloading
       loader.logger = logger
 
@@ -33,15 +41,22 @@ class HotReloader
     # More rule see https://github.com/fxn/zeitwerk
     #
     # @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.
     # @return nil
     def eager_load(*folders, logger: method(:puts))
-      loader = Zeitwerk::Loader.new
       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 folders from which you want to load watched files.' if folders&.empty?
+
+        folders.each {|folder| loader.push_dir(folder) }
+      end
 
-      folders.each {|folder| loader.push_dir(folder) }
       loader.logger = logger
 
       loader.setup

data/lib/hot_reloader/version.rb

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

metadata

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