eye-patch 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c944d91e42e1d00b32dc0fe2bdd9d326d97a4a39
-  data.tar.gz: 5987d11eab09075aec1b7369dcf7b1fcbbf92dca
+  metadata.gz: b7477e243372a1ca33023899cd22d2f6451d7643
+  data.tar.gz: b5df3de37f9f04d334bb40148d77ddd304cea1c9
 SHA512:
-  metadata.gz: b2735759864af0e4b8ba6df917d5fa95ed477f6e7b0bb54ea533c3c86dbf9a36718dd5b2df019d95e4e1a6afed98285f547966f7968f6b7fb8b5c98a9e335953
-  data.tar.gz: ad085aa238b0223b8626308f61dccbb29f3782bf6aa0af13d042503e1ca71b3992c4bc89c95665236078e6889e0bc14de79ef6fb23e7a39c099e8ff48c1fd688
+  metadata.gz: 1eec5cf18ca009aa4044e3cd1ecc63334ad022dd8b1fb5ba4bdd50521ac230faa5c8f0a68a57236ee4e0eeb946a8e4d4c2da03971a68b378825c8db5171aa3b0
+  data.tar.gz: 86ea56d72bdfcbb587240bdfa8c91b6613efc479eeafd3b9ab8f8ed2c031c0b13a8011d3a335334d2a99fa21a5ff3a8232fd8bea99c7ee0e15aceb8f7d6743c0

data/README.md

@@ -102,6 +102,56 @@ The above configuration will spin up a number of processes equal to `count`, res
 
 This approach pairs well with the `daemonize: true` option, as `eye` will have control over the creation and management of the enumerated PID files.
 
+### Monkey-Patching
+
+`Eye::Patch` can't cover all possible use cases, so instead, it supplies a few hooks to allow you to inject your own behavior into `eye` during initial load.
+
+#### Defining a Setup File
+
+For the application specified in your configuration file, you can specify a `setup_file` directive, which will tell `Eye::Patch` to load the specified file (relative to the working directory for the application) immediately after parsing your configuration.
+
+This can be used to inject any desired behavior or hooks into `eye`. For example:
+
+`working-dir/config/eye.rb`:
+
+    #!/usr/bin/env/ruby
+
+    Eye::Control.settings[:my_key] = "SOME_KEY"
+
+    Eye::Controller.class_eval do
+      def before_spawn
+        reader, writer = ::IO.pipe.map(&:binmode)
+        reader.close_on_exec = false
+        writer.close_on_exec = true
+
+        ENV["MY_FD"] = reader.to_i.to_s
+
+        writer << Eye::Control.settings[:my_key]
+        writer.flush
+        writer.close
+      end
+    end
+
+`working-dir/config/eye.yml`:
+
+    ...
+    application:
+      working_dir: working-dir
+      setup_file: config/eye.rb
+    ...
+
+#### Using a `before_spawn` Hook
+
+If you need to invoke some code before spawning a process (for example, if you want to make a file descriptor available to your new child process), you can accomplish this by patching `Eye::Controller` with a `#before_spawn` method in your setup file. This method will be invoked prior to `Eye::System` calling `Process.spawn`.
+
+See above for more instructions on how to define this hook during setup.
+
+#### Working with File Descriptors
+
+Note that if you _do_ need to persist file descriptors for a daemonized process, you'll want to set the `preserve_fds: true` option for that particular process in your configuration file. `Process.spawn`'s default behavior closes all non-standard file descriptors; this option will ensure that they remain open.
+
+Note also that since Ruby 2.0, file descriptors are closed when a process is invoked through `bundle exec`. From versions 1.5 and above, you can pass the `--keep-file-descriptors` flag to `bundle exec` to prevent this behavior.
+
 ### Running Locally
 
 You can test your configurations locally by running the `eye-patch` binary like so:

data/lib/eye/patch.rb

@@ -23,16 +23,10 @@ module Eye::Patch
     config.validate!
 
     config.applications.values.each do |application|
-      if application[:setup_file]
-        @setup_file = File.join(application[:working_dir], application[:setup_file])
-        break
-      end
+      next unless application[:setup_file]
+      require File.join(application[:working_dir], application[:setup_file])
     end
 
     config
   end
-
-  def self.setup_file
-    @setup_file
-  end
 end

data/lib/eye/patch/overrides.rb

@@ -25,20 +25,22 @@ Eye::System.class_eval do
     private
 
     def spawn_options(config = {})
-      o = {pgroup: true, chdir: config[:working_dir] || '/'}
-      o.update(out: [config[:stdout], 'a']) if config[:stdout]
-      o.update(err: [config[:stderr], 'a']) if config[:stderr]
-      o.update(in: config[:stdin]) if config[:stdin]
-      o.update(close_others: !config[:preserve_fds])
+      options = {
+        pgroup: true,
+        chdir: config[:working_dir] || '/',
+        close_others: !config[:preserve_fds] }
+
+      options[:out]   = [config[:stdout], 'a'] if config[:stdout]
+      options[:err]   = [config[:stderr], 'a'] if config[:stderr]
+      options[:in]    = config[:stdin] if config[:stdin]
+      options[:umask] = config[:umask] if config[:umask]
 
       if Eye::Local.root?
-        o.update(uid: Etc.getpwnam(config[:uid]).uid) if config[:uid]
-        o.update(gid: Etc.getpwnam(config[:gid]).gid) if config[:gid]
+        options[:uid] = Etc.getpwnam(config[:uid]).uid if config[:uid]
+        options[:gid] = Etc.getpwnam(config[:gid]).gid if config[:gid]
       end
 
-      o.update(umask: config[:umask]) if config[:umask]
-
-      o
+      options
     end
   end
 end
@@ -46,6 +48,7 @@ end
 Eye::Controller.class_eval do
 
   def invoke_spawn_callback
+    debug "Attempting before_spawn hook"
     if respond_to?(:before_spawn)
       debug "Invoking before_spawn hook"
       before_spawn
@@ -55,14 +58,7 @@ Eye::Controller.class_eval do
   private
 
   def parse_config(filename)
-    config = Eye::Patch.parse(filename)
-
-    if Eye::Patch.setup_file
-      info "Loading setup from: #{Eye::Patch.setup_file}"
-      require Eye::Patch.setup_file
-    end
-
-    config
+    Eye::Patch.parse(filename)
   end
 end
 

data/lib/eye/patch/version.rb

@@ -1,5 +1,5 @@
 module Eye
   module Patch
-    VERSION = "0.0.9"
+    VERSION = "0.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eye-patch
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Horner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-14 00:00:00.000000000 Z
+date: 2014-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eye