autoreload 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d195b06220f6ebf62098971a806660fedf14608
+  data.tar.gz: 23585273514dc91e35cd8755f6e0ce65bdb5bbdd
+SHA512:
+  metadata.gz: 4e9f3c074a1f8d160d05a24e497bd015432ba1ae9d85c8c02d04c1f5c6ebbcd4fa906f96e2dc07c79e11b4707863432d54b845f7c029bdaed02d9069932c84bc
+  data.tar.gz: 4b49181378e9e939019d6295cfd20696c78609dc953911b1e6fadc35aaff8de4eb33552fae7b081b947d5f23bf9447cec24bebdf1329f4d329d1885f049af23d

data/.index

@@ -0,0 +1,53 @@
+---
+revision: 2013
+type: ruby
+sources:
+- Indexfile
+- Gemfile
+authors:
+- name: Thomas Sawyer
+  email: transfire@gmail.com
+- name: Kouichirou Eto
+organizations: []
+requirements:
+- groups:
+  - development
+  version: '>= 0'
+  name: rake
+- groups:
+  - test
+  version: '>= 0'
+  name: minitest
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/autoreload
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/autoreload
+  label: Source Code
+- type: gems
+  uri: http://rubygems.org/gems/autoreload
+repositories: []
+categories: []
+copyrights:
+- holder: Thomas Sawyer
+  year: '2010'
+  license: BSD-2-Clause
+- holder: Kouichiro Eto
+  year: '2003'
+  license: RUBY
+customs: []
+paths:
+  lib:
+  - lib
+version: 1.1.0
+name: autoreload
+title: AutoReload
+summary: Automatically reload library files
+description: Autoreload automatically reloads library files when they have been updated.
+  It is especially useful when testing stateless services such as web applications.
+created: '2007-07-01'
+webcvs: https://github.com/rubyworks/autoreload/tree/master
+date: '2014-11-08'

data/.yardopts

@@ -1,5 +1,9 @@
+--title AutoReload
+--readme README.rdoc
+--plugin tomdoc
 --private
 --protected
 lib/
 -
 [A-Z]*.*
+

data/{HISTORY.rdoc → HISTORY.md}

@@ -1,6 +1,17 @@
-= RELEASE HISTORY
+# RELEASE HISTORY
 
-== 1.0.0 (2011-07-15)
+## 1.1.0
+
+This release is simply a maintenance release to bring the build
+configuration up to date.
+
+Changes:
+
+* Modernize build configuration.
+* Use interpolation on error message.
+
+
+## 1.0.0 (2011-07-16)
 
 This release overhauls the API. The #autoreload method now
 takes a block. All libraries required within this block
@@ -27,13 +38,13 @@ Changes:
 * Fix require of require issue.
 
 
-== 0.3.1 (2011-05-15)
+## 0.3.1 (2011-05-15)
 
 This release simply fixes licensing issues. Autoreload is licensed
 under the GPL v3.
 
 
-== 0.3.0 (2010-10-14)
+## 0.3.0 (2010-10-14)
 
 Changes:
 
@@ -41,21 +52,21 @@ Changes:
 * Switch testing framework to RSpec2.
 
 
-== 0.2.0 (2010-05-10)
+## 0.2.0 (2010-05-10)
 
 Changes:
 
 * Completely reworked API.
 
 
-== 0.1.0 (2010-05-01)
+## 0.1.0 (2010-05-01)
 
 Changes:
 
 * Same as original, but now a RubyWorks project.
 
 
-== 0.0.1 (2007-07-01)
+## 0.0.1 (2007-07-01)
 
 Changes:
 

data/LICENSE.md

@@ -0,0 +1,33 @@
+Autoreload <http://rubyworks.github.com/autoreload>
+
+Copyright (c) 2010 Rubyworks.
+Copyright (c) 2003 Kouichirou Eto.
+
+All rights reserved.
+
+License (spdx) [BSD-2-Clause](http://spdx.org/licenses/bsd-2-clause)
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY Thomas Sawyer ``AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Thomas Sawyer OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those of the
+authors and should not be interpreted as representing official policies, either expressed
+or implied, of Thomas Sawyer.
+

data/README.md

@@ -0,0 +1,67 @@
+# AutoReload
+
+[Homepage](http://rubyworks.github.com/autoreload) |
+[Development](http://github.com/rubyworks/autoreload) |
+[Mailing List](http://groups.google.com/group/rubyworks-mailinglist)
+
+[![Build Status](https://secure.travis-ci.org/rubyworks/autoreload.png)](http://travis-ci.org/rubyworks/autoreload)
+
+
+## Description
+
+Autoreload automatically reloads library files after they
+have been updated. It is especially useful when testing
+stateless services such as web applications.
+
+IMPORTANT! Version 1.0+ has a new API. It also works best
+under Ruby 1.9 or above. Under Ruby 1.8 or older files are 
+reloaded regardless of whether they actually have changed
+since the last load. Whereas in Ruby 1.9+, they only reload
+if the mtime on the file is newer than the previous time.
+
+
+## Synopsis
+
+Say we have a library <tt>foo.rb</tt> in our load path:
+
+    def foo
+      1
+    end
+
+
+We can then run the following script, <tt>example.rb</tt>:
+
+    require 'autoreload'
+
+    autoreload(:interval=>2, :verbose=>true) do
+      require 'foo.rb'
+    end
+
+    loop {
+      puts foo
+      sleep 2
+    }
+
+While that's running we can change `foo.rb` and the change will
+take effect in `example.rb` within two seconds of being made.
+
+Note that autoreload only works with _required_ files. It cannot
+monitor files that are brought in with `#load`. This is because
+`$LOADED_FEATURES` is used to track which files are monitored.
+
+
+## Acknowledgements
+
+The current version of Autoreload is a derviative of Kouichirou Eto's original
+work which can still be found at http://autoreload.rubyforge.org.
+
+
+## License & Copyrights
+
+Autoreload is released as free software under the BSD-2-Clause license.
+
+* Copyright 2010 Rubyworks
+* Copyright 2003 Kouichirou Eto
+
+See LICENSE.md for details.
+

data/lib/autoreload.rb

@@ -2,6 +2,14 @@ require 'autoreload/version'
 require 'autoreload/reloader'
 
 # Reload features automatically at given intervals.
+#
+# options - The Hash options used to refine the reloader (default: {}):
+#           :interval - Seconds between updates.
+#           :verbose  - True provides reload warning.
+#           :reprime  - Include $0 in reload list.
+#
+# Returns Thread that's taking care of reload loop.
 def autoreload(options={}, &block)
   AutoReload::Reloader.start(options, &block)
 end
+

data/lib/autoreload/reloader.rb

@@ -7,26 +7,25 @@ module AutoReload
   #
   class Reloader
 
-    # Shortcut for Reloader.new(*args).start.
+    # Public: Shortcut for Reloader.new(*args).start.
     def self.start(*args, &block)
       self.new(*args, &block).start
     end
 
-    # Default interval is one second.
+    # Public: Default interval is one second.
     DEFAULT_INTERVAL = 1
 
     # New Reloader.
     #
-    # === Options
-    #
-    #   :interval - seconds between updates
-    #   :verbose  - true provides reload warning
-    #   :reprime  - include $0 in reload list
+    # options - The Hash options used to refine the reloader (default: {}):
+    #           :interval - Seconds between updates.
+    #           :verbose  - True provides reload warning.
+    #           :reprime  - Include $0 in reload list.
     #
     def initialize(options={}, &block)
-      @interval = options[:interval] || DEFAULT_INTERVAL
-      @verbose  = options[:verbose]
-      @reprime  = options[:reprime]
+      @interval = (options[:interval] || DEFAULT_INTERVAL).to_i
+      @verbose  = (options[:verbose])
+      @reprime  = (options[:reprime])
 
       @status   = {}
 
@@ -39,7 +38,7 @@ module AutoReload
       end
     end
 
-    # Start the reload thread.
+    # Public: Start the reload thread.
     def start
       update # prime the path loads
       @thread = Thread.new do
@@ -47,47 +46,51 @@ module AutoReload
           begin
             update
           rescue Exception
-            warn 'autoreload failed unexpectedly: ' + $!
+            warn "autoreload failed unexpectedly: #{$!}"
           end
           sleep @interval
         end
       end
       @thread.abort_on_exception = true
+      @thread
     end
 
-    # Kills the autoreload thread.
+    # Public: Kills the autoreload thread.
     def stop
       @thread.kill if @thread
     end
 
-    #
+    # Public: References the reload thread.
     attr :thread
 
-    # List of files provided to autoreload.
+    # Public: List of files provided to autoreload.
     attr :files
 
-    # Status hash, used to track reloads.
+    # Public: Status hash, used to track reloads.
     attr :status
 
-    # The periodic interval of reload.
+    # Public: The periodic interval of reload in seconds.
     attr :interval
 
-    # Provide warning on reload.
+    # Public: Provide warning on reload.
+    #
+    # Returns true/false if versboe mode.
     def verbose?
       @verbose || $VERBOSE
     end
 
-    # Put $0 in the reload list?
+    # Public: Put $0 in the reload list?
+    #
+    # Returns true/false whether to include $0.
     def reprime?
       @reprime
     end
 
   private
 
+    # TODO: Why include $0 in #libraries ?
+
     # The library files to autoreload.
-    #--
-    # ISSUE: Why include $0 ?
-    #--
     def libraries
       if @files.empty?
         @reprime ? [$0] + $" : $"
@@ -101,20 +104,23 @@ module AutoReload
       libraries.each{ |lib| check(lib) }
     end
 
+    # Check status and reload if out-of-date.
+    #
     # We can't check mtime under 1.8 b/c $LOADED_FEATURES does not
     # store the full path.
-    if RUBY_VERSION < '1.9'
-      def check(lib)
+    #
+    # lib - A library file.
+    #
+    # Returns Array of [file, mtime].
+    def check(lib)
+      if RUBY_VERSION < '1.9'
         warn "reload: '#{lib}'" if verbose?
         begin
           load lib
         rescue LoadError
           # file has been removed
         end
-      end
-    else
-      # Check status and reload if out-of-date.
-      def check(lib)
+      else 
         file, mtime = @status[lib]
         if file
           if FileTest.exist?(file)
@@ -134,6 +140,10 @@ module AutoReload
     end
 
     # Get library file status.
+    #
+    # file - The file path from which to get status.
+    #
+    # Returns Array of [file, mtime] or [nil, nil] if file not found.
     def get_status(file)
       if FileTest.exist?(file)
         [file, File.mtime(file).to_i]
@@ -149,4 +159,4 @@ module AutoReload
 
 end
 
-# Copyright (C) 2010 Thomas Sawyer (BSD-2-Clause)
+# Copyright (C) 2010 Rubyworks (BSD-2-Clause)

data/lib/autoreload/version.rb

@@ -1,3 +1,4 @@
 module AutoReload
-  VERSION = '1.0.0'
+  # Public: Current release version.
+  VERSION = '1.1.0'
 end

data/try/changeme.rb

@@ -1,5 +1,6 @@
-# Change this file during 'sample1.rb' is running.
+# Change this file while `tryme.rb' is running.
 
 def message
   "Change Me!"
 end
+

data/try/{start.rb → tryme.rb}

@@ -1,6 +1,4 @@
-# sample1.rb
-
-# Run this script and change 'foo.rb' while this script is running.
+puts "Edit 'changme.rb' while this script is still running."
 
 __dir__ = File.dirname(__FILE__)
 
@@ -10,7 +8,7 @@ library = './' + __dir__ + '/changeme.rb'
 
 require 'autoreload'
 
-autoreload(:interval=>1, :verbose=>true)
+autoreload(:interval=>1, :verbose=>true) do
   require library
 end
 

metadata

@@ -1,136 +1,95 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: autoreload
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.1.0
 platform: ruby
-authors: 
+authors:
 - Thomas Sawyer
 - Kouichirou Eto
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-16 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: detroit
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+date: 2014-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: Autoreload automatically reloads library files when they have been updated. It is especially useful when testing stateless services such as web applications.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Autoreload automatically reloads library files when they have been updated.
+  It is especially useful when testing stateless services such as web applications.
+email:
 - transfire@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- HISTORY.rdoc
-- README.rdoc
-- COPYING.rdoc
-files: 
-- .gitignore
-- .ruby
+extra_rdoc_files:
+- LICENSE.md
+- README.md
+- HISTORY.md
+files:
+- .index
 - .yardopts
-- Assembly
-- COPYING.rdoc
-- HISTORY.rdoc
-- MANIFEST
-- PROFILE
-- README.rdoc
-- Rakefile
-- VERSION
-- autoreload.gemspec
-- lib/autoreload.rb
 - lib/autoreload/reloader.rb
 - lib/autoreload/version.rb
-- site/assets/icon.png
-- site/assets/screen.css
-- site/index.html
-- site/index.page
-- site/template.layout
+- lib/autoreload.rb
 - spec/autoreload_spec.rb
 - spec/helper.rb
 - spec/require_spec.rb
 - try/changeme.rb
-- try/start.rb
-- work/autoreload.rb
-- work/consider/autoreload.rb
-- work/deprecated/Changes.txt
-- work/deprecated/Rakefile
-- work/deprecated/default_task.rb
-- work/deprecated/lookup.rb
-- work/deprecated/meta/authors
-- work/deprecated/meta/description
-- work/deprecated/meta/name
-- work/deprecated/meta/summary
-- work/deprecated/meta/version
-- work/deprecated/scripts/lib-txt2html.rb
-- work/deprecated/scripts/makemanifest.rb
-- work/deprecated/scripts/txt2html
-- work/deprecated/setup.rb
+- try/tryme.rb
+- LICENSE.md
+- HISTORY.md
+- README.md
 homepage: http://rubyworks.github.com/autoreload
-licenses: []
-
+licenses:
+- BSD-2-Clause
+- RUBY
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+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: 1.8.2
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Automatically reload library files
-test_files: 
-- spec/require_spec.rb
+test_files:
 - spec/autoreload_spec.rb
+- spec/helper.rb
+- spec/require_spec.rb
+has_rdoc: