auto_reloader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba4a09d3953bfde28a2af58974520277a6586f66
+  data.tar.gz: fbf78f768bb8ea66ec1ca341f74ecae6fe0c207c
+SHA512:
+  metadata.gz: c307052c4138e40de2855ace66cb2c5369771ce2aadaa8366cb4bf146dde3e8fc59733fd37a79b2a72f47a0692485d68d62681816e46245f992fd41c7a3694d6
+  data.tar.gz: 40fd961e6b85db733047235bef5099fe5d9a2e18492845495c94e98307d000c9047ed564532b552b617db7b55bb2698f6d31d6d91c03a3a94d3036f212cfa562

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--order default

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in auto_reloader.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rodrigo Rosenfeld Rosas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,129 @@
+# AutoReloader
+
+AutoReloader is a lightweight code reloader intended to be used specially in development mode of server applications.
+
+It will override `require` and `require_relative` when activated.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'auto_reloader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install auto_reloader
+
+## Usage
+
+AutoReloader will try to add auto-reloading code support transparently by unloading all files
+belonging to the list of reloadable paths and the constants defined by them. This is not always
+possible to handle transparently, so please read the Known Caveats to properly understand what
+you should do to avoid them.
+
+Here's how it would be used in a Rack application.
+
+app.rb:
+
+```ruby
+App = ->{['200', {'Content-Type' => 'text/plain'}, ['Sample output']]}
+```
+
+config.ru:
+
+```ruby
+if ENV['RACK_ENV'] != 'development'
+  require_relative 'app'
+  run App
+else
+  require 'auto_reloader'
+  # won't reload before 1s elapsed since last reload by default. It can be overridden
+  # in the reload! call below
+  AutoReloader.activate reloadable_paths: [__dir__], delay: 1
+  run ->(env) {
+    AutoReloader.reload! do
+      require_relative 'app'
+      App.call env
+    end
+  }
+end
+```
+
+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!`.
+
+## Known Caveats
+
+In order to work transparently AutoReloader will override `require` and `require_relative` when
+activated and track changes to the top-level constants after each require. Top-level constants
+defined by reloadable files are removed upon `reload!` or `unload!`. So, if your application
+does something crazy like this:
+
+json-extension.rb:
+
+```ruby
+class JSON
+  class MyExtension
+  # crazy stuff: don't do that
+  end
+end
+```
+
+If you require 'json-extension' before requiring 'json', supposing it's reloadable, `unload!`
+and `reload!` would remove the JSON constant because AutoReloader will think it was defined
+by 'json-extension'. If you require 'json' before this file, then JSON won't be removed but
+neither will JSON::MyExtension.
+
+As a general rule, any reloadable file should not change the behavior of code in non
+reloadable files.
+
+## Implementation description
+
+AutoReloader doesn't try to reload only the changed files. If any of the reloadable files change
+then all reloadable files are unloaded and the constants they defined are removed. Reloadable
+files are those living in one of the `reloadable_paths` entries. The more paths it has to search
+the bigger will be the overhead to `require` and `require_relative`.
+
+Currently this implementation does not use an evented watcher to detect changes to files but
+it may be considered in future versions. Currently it traverses each loaded reloadable file and
+check whether it was changed.
+
+## AutoReloadable does not support automatic autoload
+
+AutoReloadable does not provide automatic autoload features like ActiveSupport::Dependencies
+by design and won't support it ever, although such feature could be implemented as an extension
+or as a separate gem. Personally I don't find it a good practice and I think all dependencies
+should be declared explicitly by all files depending on them even if it's not necessary because
+it was already required by another file.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec`
+to run the tests. You can also run `bin/console` for an interactive prompt that will allow
+you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a
+new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and tags, and push the `.gem`
+file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome
+[on GitHub](https://github.com/rosenfeld/auto_reloader).
+
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/auto_reloader.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'auto_reloader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'auto_reloader'
+  spec.version       = AutoReloader::VERSION
+  spec.authors       = ['Rodrigo Rosenfeld Rosas']
+  spec.email         = ['rr.rosas@gmail.com']
+
+  spec.summary       = %q{A transparent code reloader.}
+  spec.homepage      = 'https://github.com/rosenfeld/auto_reloader'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "auto_reloader"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/auto_reloader.rb

@@ -0,0 +1,161 @@
+require 'auto_reloader/version'
+require 'singleton'
+require 'monitor'
+require 'thread' # for Mutex
+require 'set'
+require 'time' unless defined?(Process::CLOCK_MONOTONIC)
+
+class AutoReloader
+  include Singleton
+
+  attr_reader :reloadable_paths
+
+  module RequireOverride
+    def require(path)
+      AutoReloader.instance.require(path) { super }
+    end
+
+    def require_relative(path)
+      fullpath = File.join File.dirname(caller.first), path
+      AutoReloader.instance.require_relative path, fullpath
+    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)
+    @activate_lock.synchronize do
+      raise ActivatedMoreThanOnce, "Can only activate Autoreloader once" if @reloadable_paths
+      @delay = delay
+      @onchange = onchange
+      self.reloadable_paths = reloadable_paths
+      Object.include RequireOverride
+      @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
+    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
+  end
+
+  def require(path, &block)
+    was_required = false
+    @require_lock.synchronize do
+      @top_level_consts_stack << Set.new
+      old_consts = Object.constants
+      prev_consts = new_top_level_constants = nil
+      begin
+        was_required = yield
+      ensure
+        prev_consts = @top_level_consts_stack.pop
+        if was_required
+          new_top_level_constants = Object.constants - old_consts - prev_consts.to_a
+          @top_level_consts_stack.each{|c| c.merge new_top_level_constants }
+        end
+      end
+      return false unless was_required # was required already, do nothing
+      full_loaded_path = $LOADED_FEATURES.last
+      reloadable = reloadable?(full_loaded_path, path)
+      if reloadable
+        @reload_lock.synchronize do
+          @unload_constants.merge new_top_level_constants
+          @unload_files << full_loaded_path
+        end
+      end
+    end
+    was_required
+  end
+
+  def require_relative(path, fullpath)
+    Object.require fullpath
+  end
+
+  def self.reload!(*args)
+    if block_given?
+      instance.reload!(*args){ yield }
+    else
+      instance.reload!(*args)
+    end
+  end
+
+  InvalidUsage = Class.new RuntimeError
+  def reload!(delay: @default_delay, onchange: @default_onchange)
+    if onchange && !block_given?
+      raise InvalidUsage, 'A block must be provided to reload! when onchange is true (the default)'
+    end
+
+    unload! unless ignore_reload?(delay, onchange)
+
+    result = nil
+    if block_given?
+      result = yield
+      find_mtime
+    end
+    @last_reloaded = clock_time if delay
+    result
+  end
+
+  def self.unload!
+    instance.unload!
+  end
+
+  def unload!
+    @reload_lock.synchronize do
+      @unload_files.each{|f| $LOADED_FEATURES.delete f }
+      @unload_constants.each{|c| Object.send :remove_const, c }
+      @unload_files = Set.new
+      @unload_constants = Set.new
+    end
+  end
+
+  private
+
+  if defined?(Process::CLOCK_MONOTONIC)
+    def clock_time
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+  else
+    def clock_time
+      Time.now.to_f
+    end
+  end
+
+  def reloadable?(fullpath, path)
+    @reloadable_paths.any?{|rp| fullpath.start_with? rp}
+  end
+
+  def ignore_reload?(delay, onchange)
+    (delay && (clock_time - @last_reloaded < delay)) || (onchange && !changed?)
+  end
+
+  def changed?
+    return true unless @last_mtime_by_path
+    @reload_lock.synchronize do
+      return @unload_files.any?{|f| @last_mtime_by_path[f] != File.mtime(f) }
+    end
+  end
+
+  def find_mtime
+    @reload_lock.synchronize do
+      @last_mtime_by_path = {}
+      @unload_files.each{|f| @last_mtime_by_path[f] = File.mtime f }
+    end
+    @last_mtime_by_path
+  end
+end

data/lib/auto_reloader/version.rb

@@ -0,0 +1,3 @@
+class AutoReloader
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: auto_reloader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodrigo Rosenfeld Rosas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-16 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'
+  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'
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- rr.rosas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- auto_reloader.gemspec
+- bin/console
+- bin/setup
+- lib/auto_reloader.rb
+- lib/auto_reloader/version.rb
+homepage: https://github.com/rosenfeld/auto_reloader
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A transparent code reloader.
+test_files: []