auto_reloader 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10beff4b13c065b8d6c20336b1046c0786590c70
-  data.tar.gz: eee5bfb397efaa8846dfe155d81a657b8e2f56d7
+  metadata.gz: 73f6ff42577565773f43c6d8089f35c4fdce994c
+  data.tar.gz: 65e7a40ff8248c7fddc86d895360077ce6fc16fd
 SHA512:
-  metadata.gz: 5c3e98205d8ff2c48e73fd4a6c8e6046cec6c296de3388dc8df3d17ad6f924970b380075f30f43ee2389a6f28f57de343b0d36ec1f21b6f7b6352e388d5917c3
-  data.tar.gz: 5520c5208041eaff4b9c23d33b0b290150f72cb9c2340b1f80264309d06a485ee84acd6b71469f8269e1e28cc3bd205f55fd6abed35dc4d60bc03bf018821157
+  metadata.gz: 1fd10e677eebbc4d7f08c1d284b40936912f6c71ba49bd747e778f5e25f68dd585f2f87d6592856178beea703e5b4c56f2d4684e5645cb3ef259511ea2d17c4a
+  data.tar.gz: 43323abf4020359ce4fb2f59132e7dc1abe53fb470120310d1cff8459f3d64505ce9379b44363c9b49ad7dbcaffbddaffb0a13f0a084d73e2c9346df2e828e96

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
   - 2.3.1
+  - jruby-9.1.2.0
 before_install: gem install bundler -v 1.11.2

data/README.md

@@ -59,7 +59,11 @@ Just change "Sample output" to something else and reload the page.
 
 By default reloading will only happen if one of the reloadable file was changed since it was
 required. This can be overriden by providing the `onchange: false` option to either `activate`
-or `reload!`.
+or `reload!`. When the `listen` gem is available it's used by default to detect changes in
+the `reloadable_paths` using specific OS watch mechanisms which allows AutoReloader to speed
+up `reload!` when no changes happened although it won't probably do much difference unless
+your application has tons of reloadable files loaded upon each request. If you don't want to
+use `listen` when available, set `watch_paths: false` when calling `activate`.
 
 ## Known Caveats
 

data/auto_reloader.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'listen', '~> 3.0'
 end

data/lib/auto_reloader/version.rb

@@ -1,3 +1,3 @@
 class AutoReloader
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/auto_reloader.rb

@@ -1,5 +1,6 @@
 require 'auto_reloader/version'
 require 'singleton'
+require 'forwardable'
 require 'monitor'
 require 'thread' # for Mutex
 require 'set'
@@ -7,9 +8,12 @@ require 'time' unless defined?(Process::CLOCK_MONOTONIC)
 
 class AutoReloader
   include Singleton
+  extend SingleForwardable
 
   attr_reader :reloadable_paths, :default_onchange, :default_delay
 
+  def_delegators :instance, :activate, :reload!, :reloadable_paths, :reloadable_paths=, :unload!
+
   module RequireOverride
     def require(path)
       AutoReloader.instance.require(path) { super }
@@ -21,37 +25,33 @@ class AutoReloader
     end
   end
 
-  def self.activate(*args)
-    instance.activate *args
-  end
-
   def initialize
     @activate_lock = Mutex.new
   end
 
   ActivatedMoreThanOnce = Class.new RuntimeError
-  def activate(reloadable_paths: [], onchange: true, delay: nil)
+  def activate(reloadable_paths: [], onchange: true, delay: nil, watch_paths: nil,
+              watch_latency: 1)
     @activate_lock.synchronize do
       raise ActivatedMoreThanOnce, "Can only activate Autoreloader once" if @reloadable_paths
       @default_delay = delay
       @default_onchange = onchange
-      self.reloadable_paths = reloadable_paths
-      Object.include RequireOverride
+      @watch_latency = watch_latency
       @require_lock = Monitor.new # monitor is like Mutex, but reentrant
       @reload_lock = Mutex.new
       @top_level_consts_stack = []
       @unload_constants = Set.new
       @unload_files = Set.new
       @last_reloaded = clock_time
+      try_listen unless watch_paths == false
+      self.reloadable_paths = reloadable_paths
+      Object.include RequireOverride
     end
   end
 
-  def self.reloadable_paths=(paths)
-    instance.reloadable_paths = paths
-  end
-
   def reloadable_paths=(paths)
     @reloadable_paths = paths.map{|rp| File.expand_path(rp).freeze }.freeze
+    setup_listener if @watch_paths
   end
 
   def require(path, &block)
@@ -86,14 +86,6 @@ class AutoReloader
     Object.require fullpath
   end
 
-  def self.reload!(delay: instance.default_delay, onchange: instance.default_onchange)
-    if block_given?
-      instance.reload!(delay: delay, onchange: onchange){ yield }
-    else
-      instance.reload!(delay: delay, onchange: onchange)
-    end
-  end
-
   InvalidUsage = Class.new RuntimeError
   def reload!(delay: default_delay, onchange: default_onchange)
     if onchange && !block_given?
@@ -111,10 +103,6 @@ class AutoReloader
     result
   end
 
-  def self.unload!
-    instance.unload!
-  end
-
   def unload!
     @reload_lock.synchronize do
       @unload_files.each{|f| $LOADED_FEATURES.delete f }
@@ -124,8 +112,27 @@ class AutoReloader
     end
   end
 
+  def stop_listener
+    @listener.stop if @listener
+  end
+
   private
 
+  def try_listen
+    Kernel.require 'listen'
+    @watch_paths = true
+  rescue LoadError # ignore
+    #puts 'listen is not available. Add it to Gemfile if you want to speed up change detection.'
+  end
+
+  def setup_listener
+    @listener.stop if @listener
+    @listener = Listen.to(*@reloadable_paths, latency: @watch_latency) do |m, a, r|
+      @paths_changed = true
+    end
+    @listener.start
+  end
+
   if defined?(Process::CLOCK_MONOTONIC)
     def clock_time
       Process.clock_gettime(Process::CLOCK_MONOTONIC)
@@ -145,6 +152,8 @@ class AutoReloader
   end
 
   def changed?
+    return false if @watch_paths && !@paths_changed
+    @paths_changed = false
     return true unless @last_mtime_by_path
     @reload_lock.synchronize do
       return @unload_files.any?{|f| @last_mtime_by_path[f] != safe_mtime(f) }

metadata

@@ -1,58 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: auto_reloader
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Rodrigo Rosenfeld Rosas
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
 date: 2016-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
-  name: bundler
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
 - !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-  name: rake
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-  name: rspec
+  type: :development
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description:
+description: 
 email:
 - rr.rosas@gmail.com
 executables: []
@@ -75,7 +89,7 @@ homepage: https://github.com/rosenfeld/auto_reloader
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -90,9 +104,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.4
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
 specification_version: 4
 summary: A transparent code reloader.
 test_files: []