hot_reloader 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec0e3c1431bef973f80a63c492edc79bae5eb435fd280d8b0594323d10ff0396
-  data.tar.gz: 5496d56ab76af81abbe464317f02c56758a72d297702e47068ebe5375351b35a
+  metadata.gz: 461d4f4d7e55f277ac68ad3757ff3a5de4e854d8f994bf497643cc405ac12da3
+  data.tar.gz: '0399e4aba6fe95c3fb25c4fcd414552859fa1cc8bf530a43a1df465125f8893c'
 SHA512:
-  metadata.gz: a3bd2875289eaf879180477d43b1d924febdcef2dc1caf3aaedda22a43718343cfa2411e425fecd8ac3de4b35d5596d250c55a6b23902f53c6a050b8ee730e30
-  data.tar.gz: 7fff7f4d9b5e4e86a9e72dafc73e795215e661785e13e52577aaa69d089d2454a92abb99bcf18f4a04f9fd975a8284fc65aeebf8b69d114d93922f0d45d1a2ae
+  metadata.gz: 5ad70767d0a9e17bfedb28823ee60bf4dad0fb306a553207008b59a52a37a9136fc9f6143e771f10d0bf246cba5308a4c5c8b600d62aa5fab98d20e484936de5
+  data.tar.gz: 1e0b7f132a276c4b43bc2aa62b81796109c967900226fd579d52cf4b7731aaf3b475073df7d437bcedd3fa7d0db0500fda26b541bf2d44472b7f5d4a36721286

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,34 +20,84 @@ 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.will_listen(__dir__)
-  run ->(env) {
-    App.call(env)
-  }
+  run App.freeze.app
 else
-  run App
+  run ->(env) { App.call(env) }
 end
 ```
 
-Then create app.rb in ROOT directory.
+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"))
+require_relative 'application'
+
+paths = ["#{__dir__}/../app", "#{__dir__}/../app/models"]
 
+if ENV['RACK_ENV'] == 'production'
+  HotReloader.eager_load(*paths)
+else
+  HotReloader.will_listen(*paths)
+end
+```
+
+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
@@ -56,7 +106,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

@@ -1,14 +1,66 @@
+# frozen_string_literal: true
+
 require 'zeitwerk'
 require 'listen'
 
-module HotReloader
-  module_function
+class HotReloader
+  class << self
+    # Listen on folders for file change, and reload changed rb file if necessary.
+    # 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, e.g. method(:puts)
+    # @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
+        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
+
+      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
+    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.
+    #   or only one Zeitwerk::Loader object can be provided.
+    # @param [#call] logger logger or any object should response call, e.g. method(:puts)
+    # @return nil
+    def eager_load(*folders, logger: Logger.new(IO::NULL))
+      folders = folders.flatten
+
+      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
+
+      loader.logger = logger
 
-  def will_listen(*directories, logger: method(:puts))
-    loader = Zeitwerk::Loader.new
-    loader.logger = logger
-    directories.each {|directory| loader.push_dir(directory) }
-    loader.setup
-    Listen.to(*directories) { loader.reload }.start
+      loader.setup
+      loader.eager_load
+    end
   end
 end

data/lib/hot_reloader/version.rb

@@ -1,9 +1,5 @@
-module HotReloader
-  VERSION = [0, 1, 0]
+# frozen_string_literal: true
 
-  class << VERSION
-    def to_s
-      join('.')
-    end
-  end
+class HotReloader
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hot_reloader
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Billy.Zheng(zw963)
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-21 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ homepage: http://github.com/zw963/hot_reloader
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -68,8 +68,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A dead simple ruby code hot reloader wrap around zeitwerk and listen.
 test_files: []