autorespawn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea386cb98108e534b9f65033e7f664ec13321893
+  data.tar.gz: 7a8e260d15d67f91563da5505f6c42878548301e
+SHA512:
+  metadata.gz: 56804a4ae5f3410c656a0e95d35c1504a215c2bdee3769f65b51496df699c4c4238c1c2dba2490a5c5bca524f7b4ed752f4a32b14f70758c2184bf37f18bb7d2
+  data.tar.gz: 7d2735d95211f6e70b4ad28ca5204e292bd2775dfdebdff8961332d6b5b84c4d37680d63af48a657fb617f11bb206d967201a70b287888b5182b6ce7946fcba1

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'flexmock', github: 'doudou/flexmock', branch: 'master'
+# Specify your gem's dependencies in autorespawn.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sylvain Joyeux
+
+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,59 @@
+# Autorespawn
+
+Autorespawn is an implementation of the popular autoreload scheme, which reloads
+Ruby program files when they change, but instead execs/spawns the underlying
+program again. This avoids common issues related to the load mechanism.
+
+## Usage
+
+Require all the files you need autorespawn to watch and then do
+
+~~~
+Autorespawn.autorespawn do
+   # Add the program's functionality here
+end
+~~~
+
+If you touch ARGV and $0, you will want to pass the program and arguments
+explicitely
+
+~~~
+Autorespawn.autorespawn 'program', 'argument0', 'argument1' do
+end
+~~~
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'autorespawn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install autorespawn
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.
+
+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 at https://github.com/doudou/autorespawn.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/autorespawn.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'autorespawn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "autorespawn"
+  spec.version       = Autorespawn::VERSION
+  spec.authors       = ["Sylvain Joyeux"]
+  spec.email         = ["sylvain.joyeux@m4x.org"]
+
+  spec.summary       = "functionality to respawn a Ruby program when its source changes"
+  spec.description   =<<-EOD
+This gem implements the functionality to take a signature of the current Ruby
+program (i.e. the current process) and respawn it whenever the source code or
+libraries change
+EOD
+  spec.homepage      = "https://github.com/doudou/autorespawn"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", ">= 5.0", "~> 5.0"
+  spec.add_development_dependency "fakefs", ">= 0.6", "~> 0.6.0"
+  spec.add_development_dependency 'flexmock', ">= 2.0", '~> 2.0'
+end

data/lib/autorespawn/exceptions.rb

@@ -0,0 +1,14 @@
+module Autorespawn
+    # Exception raised when a path cannot be resolved to a file on disk
+    class FileNotFound < RuntimeError
+        # @return [Pathname] the path to resolve
+        attr_reader :path
+        # @return [Array<Pathname>] the search path that was provided to resolve
+        #   {#path}. It is always empty if {#path} is absolute
+        attr_reader :search_path
+
+        def initialize(path, search_path)
+            @path, @search_path = path, search_path
+        end
+    end
+end

data/lib/autorespawn/program_id.rb

@@ -0,0 +1,165 @@
+require 'autorespawn/program_id'
+require 'pathname'
+require 'digest/sha1'
+
+module Autorespawn
+    # Management of the ID of a complete Ruby program
+    #
+    # It basically stores information about all the files that form this
+    # program.
+    class ProgramID
+        FileInfo = Struct.new :require_path, :path, :mtime, :size, :id
+
+        # Information about the files that form this program
+        #
+        # @return [Hash<Pathname,FileInfo>]
+        attr_reader :files
+
+        def initialize
+            @files = Hash.new
+        end
+
+        # Compute ID information abou thte current Ruby process
+        def self.for_self
+            id = ProgramID.new
+            id.register_loaded_features
+            id
+        end
+
+        # Registers the file information for all loaded features
+        # 
+        # @return [void]
+        def register_loaded_features
+            search_path = ruby_load_path
+            $LOADED_FEATURES.each do |file|
+                # enumerator.so is listed in $LOADED_FEATURES but is not present
+                # on disk ... no idea
+                begin
+                    begin
+                        register_file(Pathname.new(file))
+                    rescue FileNotFound => e
+                        STDERR.puts "WARN: could not find #{e.path} in ruby search path, ignored"
+                    end
+                end
+            end
+        end
+
+        # Registers file information for one file
+        #
+        # @param [Pathname] file the path to the file
+        # @return [FileInfo] the file's information
+        def register_file(file, search_path = ruby_load_path)
+            info = file_info(file, search_path)
+            files[info.path] = info
+            @id = nil
+            info
+        end
+
+        # Returns a string that can ID this program
+        def id
+            return @id if @id
+
+            complete_id = files.keys.sort.map do |p|
+                files[p].id
+            end.join("")
+            @id = Digest::SHA1.hexdigest(complete_id)
+        end
+
+        # Whether the state on disk is different than the state stored in self
+        def changed?
+            files.each_value do |info|
+                return true if !info.path.exist?
+                stat = info.path.stat
+                if stat.mtime != info.mtime || stat.size != info.size
+                    new_id = compute_file_id(info.path)
+                    return new_id != info.id
+                end
+            end
+            false
+        end
+
+        # @api private
+        #
+        # Given a path that may be relative, computes the full path to the
+        # corresponding file
+        #
+        # @param [Pathname] path the file path
+        # @param [Array<Pathname>] search_path the search path to use to resolve
+        #   relative paths
+        # @return [void]
+        # @raise FileNotFound when a relative path cannot be resolved into a
+        #   global one
+        def resolve_file_path(path, search_path = Array.new)
+            if !path.absolute?
+                search_path.each do |search_p|
+                    full = search_p + path
+                    if full.exist?
+                        return full
+                    end
+                end
+                raise FileNotFound.new(path, search_path), "cannot find #{path} in #{search_path.join(", ")}"
+            elsif !path.exist?
+                raise FileNotFound.new(path, []), "#{path} does not exist"
+            else
+                return path
+            end
+        end
+
+        # The ruby load path
+        #
+        # @param [Array<Pathname>]
+        def ruby_load_path
+            $LOAD_PATH.map { |p| Pathname.new(p) }
+        end
+
+        # Resolve file information about a single file
+        #
+        # @param [Pathname] path the path to the file
+        # @param [Array<Pathname>] search_path the search path to use to resolve
+        #    'path' if it is relative
+        # @return [FileInfo]
+        def file_info(path, search_path = ruby_load_path)
+            resolved = resolve_file_path(path, search_path)
+            stat = resolved.stat
+            id   = compute_file_id(resolved)
+            return FileInfo.new(path, resolved, stat.mtime, stat.size, id)
+        end
+
+        # @api private
+        #
+        # Compute the content ID of a text (code) file
+        def compute_text_file_id(file)
+            sanitized = file.readlines.map do |line|
+                # Remove unnecessary spaces
+                line = line.strip
+                line = line.gsub(/\s\s+/, ' ')
+                if !line.empty?
+                    line
+                end
+            end.compact
+            Digest::SHA1.hexdigest(sanitized.join("\n"))
+        end
+
+        # @api private
+        #
+        # Compute the content ID of a binary file
+        def compute_binary_file_id(file)
+            Digest::SHA1.hexdigest(file.read(enc: 'BINARY'))
+        end
+    
+        # Compute a SHA1 that is representative of the file's contents
+        #
+        # It does some whitespace cleanup, but is not meant to be super-robust
+        # to changes that are irrelevant to the end program
+        #
+        # @param [Pathname] file the path to the file
+        # @return [String] an ID string
+        def compute_file_id(file)
+            if file.extname == ".rb"
+                compute_text_file_id(file)
+            else
+                compute_binary_file_id(file)
+            end
+        end
+    end
+end

data/lib/autorespawn/version.rb

@@ -0,0 +1,3 @@
+module Autorespawn
+  VERSION = "0.1.0"
+end

data/lib/autorespawn/watch.rb

@@ -0,0 +1,85 @@
+module Autorespawn
+    # Functionality to watch a program for change
+    class Watch
+        # Create a pipe and dump the program ID state of the current program
+        # there
+        def self.dump_self_id
+            r, w = IO.pipe
+            Marshal.dump(ProgramID.for_self, w)
+            w.flush
+            return r, w
+        end
+
+        # Automatically autoreload this program when one of the source file
+        # changes
+        #
+        # Call this method from the entry point of your program, giving it the
+        # actual program functionality as a block. The method will exec and
+        # spawn subprocesses at will, when needed, and call the block in these
+        # subprocesses as required.
+        #
+        # At the point of call, all of the program's dependencies must be
+        # already required, as it is on this basis that the auto-reloading will
+        # be done
+        #
+        # This method does NOT return
+        #
+        # @param [Array<String>] command the command to be executed. It is
+        #   passed as-is to Kernel.spawn and Kernel.exec
+        # @param options keyword options to pass to Kernel.spawn and Kernel.exec
+        def self.autoreload(*command, **options)
+            if !block_given?
+                raise ArgumentError, "you must provide the actions to perform on reload as a block"
+            end
+
+            # Check if we're being called by an autoreload call already
+            if ENV['autorespawn_AUTORELOAD']
+                program_id = Marshal.load(STDIN)
+                if !program_id.changed?
+                    # We can do what is required of us and wait for changes
+                    yield
+                    new(program_id).wait
+                end
+
+                r, w = dump_self_id
+                exec(Hash['autorespawn_AUTORELOAD' => '1'], *command,
+                     in: r, **options)
+            else
+                begin
+                    r, w = dump_self_id
+                    pid = spawn(Hash['autorespawn_AUTORELOAD' => '1'], *command,
+                                in: r, pgroup: true, **options)
+                    w.close
+                    r.close
+                    _, status = Process.waitpid2(pid)
+                    exit status.exitcode
+                ensure
+                    if pid
+                        Process.kill 'TERM', pid
+                    end
+                    if !$!
+                        exit 0
+                    end
+                end
+            end
+        end
+
+        # @return [ProgramID] the reference state
+        attr_reader :current_state
+
+        def initialize(current_state)
+            @current_state = current_state
+        end
+
+        # Wait for changes
+        def wait
+            loop do
+                if current_state.changed?
+                    return
+                end
+                sleep 1
+            end
+        end
+    end
+end
+

data/lib/autorespawn.rb

@@ -0,0 +1,8 @@
+require "autorespawn/version"
+require "autorespawn/exceptions"
+require "autorespawn/program_id"
+require "autorespawn/watch"
+
+module Autorespawn
+    # Your code goes here...
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: autorespawn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sylvain Joyeux
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: flexmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |
+  This gem implements the functionality to take a signature of the current Ruby
+  program (i.e. the current process) and respawn it whenever the source code or
+  libraries change
+email:
+- sylvain.joyeux@m4x.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- autorespawn.gemspec
+- lib/autorespawn.rb
+- lib/autorespawn/exceptions.rb
+- lib/autorespawn/program_id.rb
+- lib/autorespawn/version.rb
+- lib/autorespawn/watch.rb
+homepage: https://github.com/doudou/autorespawn
+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.2.3
+signing_key: 
+specification_version: 4
+summary: functionality to respawn a Ruby program when its source changes
+test_files: []