auto_reloader 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b42889c4bcc15ca1ea692a102bcb218407d0c035
-  data.tar.gz: 691c8f940b95e40ecb067b51d86bcd7f479589d0
+  metadata.gz: 3e68a0ebbf63e459d5a910ec3a989a23967ee950
+  data.tar.gz: 9a92639f3c1d818f35bcce6bcf7d51d1e5c1aa6e
 SHA512:
-  metadata.gz: d5bfbc0440e93e598cd4c433564e570bdfcfc7b0d9e37aa7aad9bf14135b5ba0b25a9a1b2478729a937654373a736701428c654125bb9e6e5d51a3f2c8de9130
-  data.tar.gz: 23ba39d8a90edb4b96da5facb262bba884f02a86aa6be21271230e24d580c9735ec78444dd13fb99360da88265ca119010821dfbda62874f9d98fb7a09db2e82
+  metadata.gz: ef00d96db1f52fcf5e36776b8b0fbb0ceeba146440a4eae3ac11a19f7750a7a99907fce687e2442a80647d6992955e69534c4e9db9317b1eed4f04c4889f1feb
+  data.tar.gz: 0b025c02a9ddc94bb2e23db839cb079e112d89bc577152ab4a5d327d528e66c520deb9513da7ee333b0541f82e06d2652ff33f8bff33aee97e3693aecce43a18

data/README.md

@@ -98,6 +98,12 @@ encouraged to call `AutoReloader.sync_require!`. Or pass `sync_require: true` to
 The sync behavior will ensure no race conditions that would break the automatic detection
 mechanism would ever happen.
 
+Also, it may be dangerous to unload classes while some requests are being processed. So, since
+version 0.4, the default is to await for all blocks executed by `reload!` to finish running before
+unloading. In case you prefer the old behavior because some requests may never return, which
+could happen with some implementations of websocket connections handled by the same process
+for example, just set the `await_before_unload` to `false` on `activate` or `reload!` calls.
+
 ## Known Caveats
 
 In order to work transparently AutoReloader will override `require` and `require_relative` when

data/lib/auto_reloader.rb

@@ -12,7 +12,12 @@ class AutoReloader
   include Singleton
   extend SingleForwardable
 
-  attr_reader :reloadable_paths, :default_onchange, :default_delay
+  # default_await_before_unload will await for all calls to reload! to finish before calling
+  # unload!. This behavior is usually desired in web applications to avoid unloading anything
+  # while a request hasn't been finished, however it won't work fine if some requests are
+  # supposed to remain open, like websockets connections or something like that.
+
+  attr_reader :reloadable_paths, :default_onchange, :default_delay, :default_await_before_unload
 
   def_delegators :instance, :activate, :reload!, :reloadable_paths, :reloadable_paths=,
     :unload!, :force_next_reload, :sync_require!, :async_require!
@@ -35,14 +40,17 @@ class AutoReloader
 
   ActivatedMoreThanOnce = Class.new RuntimeError
   def activate(reloadable_paths: [], onchange: true, delay: nil, watch_paths: nil,
-              watch_latency: 1, sync_require: false)
+               watch_latency: 1, sync_require: false, await_before_unload: true)
     @activate_lock.synchronize do
       raise ActivatedMoreThanOnce, 'Can only activate Autoreloader once' if @reloadable_paths
       @default_delay = delay
       @default_onchange = onchange
+      @default_await_before_unload = await_before_unload
       @watch_latency = watch_latency
       sync_require! if sync_require
       @reload_lock = Mutex.new
+      @zero_requests_condition = ConditionVariable.new
+      @requests_count = 0
       @top_level_consts_stack = []
       @unload_constants = Set.new
       @unload_files = Set.new
@@ -118,16 +126,30 @@ class AutoReloader
   end
 
   InvalidUsage = Class.new RuntimeError
-  def reload!(delay: default_delay, onchange: default_onchange, watch_paths: @watch_paths)
+  def reload!(delay: default_delay, onchange: default_onchange, watch_paths: @watch_paths,
+              await_before_unload: default_await_before_unload)
     if onchange && !block_given?
       raise InvalidUsage, 'A block must be provided to reload! when onchange is true (the default)'
     end
 
-    unload! unless reload_ignored = ignore_reload?(delay, onchange, watch_paths)
+    unless reload_ignored = ignore_reload?(delay, onchange, watch_paths)
+      @reload_lock.synchronize do
+        @zero_requests_condition.wait(@reload_lock) unless @requests_count == 0
+      end if await_before_unload && block_given?
+      unload!
+    end
 
     result = nil
     if block_given?
-      result = yield
+      @reload_lock.synchronize{ @requests_count += 1 }
+      begin
+        result = yield
+      ensure
+        @reload_lock.synchronize{
+          @requests_count -= 1
+          @zero_requests_condition.signal if @requests_count == 0
+        }
+      end
       find_mtime
     end
     @last_reloaded = clock_time if delay

data/lib/auto_reloader/version.rb

@@ -1,3 +1,3 @@
 class AutoReloader
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: auto_reloader
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Rodrigo Rosenfeld Rosas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-09 00:00:00.000000000 Z
+date: 2017-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -105,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A transparent code reloader.