senotrusov-ruby-process-controller 1.0.1

data/LICENSE

@@ -0,0 +1,205 @@
+
+   Copyright 2006-2009 Stanislav Senotrusov <senotrusov@gmail.com>
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README

@@ -0,0 +1 @@
+

data/lib/ruby-process-controller.rb

@@ -0,0 +1,22 @@
+
+#  Copyright 2006-2009 Stanislav Senotrusov <senotrusov@gmail.com>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+require 'etc'
+require 'ruby-toolkit'
+require 'ruby-threading-toolkit'
+
+require 'ruby-process-controller/argv_parser.rb'
+require 'ruby-process-controller/process_controller.rb'
+require 'ruby-process-controller/test_daemon.rb'

data/lib/ruby-process-controller/argv_parser.rb

@@ -0,0 +1,486 @@
+
+#  Copyright 2006-2008 Stanislav Senotrusov <senotrusov@gmail.com>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+# TODO: separator between options
+
+class ArgvParser
+
+  class UnnamedOption
+    def initialize option_name, value_is_optional, value_may_be_array, comment, conditions, block
+      @option_name = option_name
+      @value_is_optional = value_is_optional
+      @value_may_be_array = value_may_be_array
+      @comment = comment
+      @conditions = conditions
+      @block = block
+    end
+    
+    attr_accessor :option_name, :value_is_optional, :value_may_be_array, :comment, :conditions, :block
+    attr_accessor :short_option_name, :option_is_boolean, :value_name
+    
+    def display
+      "#{"[" if value_is_optional}#{option_name}#{"]" if value_is_optional}#{"..." if value_may_be_array}"
+    end
+
+    def columnized_display
+      [display, comment]
+    end
+  end
+  
+  
+  class Option < UnnamedOption
+    def initialize short_option_name, option_name, option_is_boolean, value_is_optional, value_may_be_array, value_name, comment, conditions, block
+      super option_name, value_is_optional, value_may_be_array, comment, conditions, block
+      
+      @short_option_name = short_option_name
+      @option_is_boolean = option_is_boolean
+      @value_name = value_name
+    end
+    
+    def display_names
+      [display_short_name, display_name].compact * "/"
+    end
+    
+    def display_name
+      "--#{"[no-]" if option_is_boolean}#{option_name}" if option_name
+    end
+    
+    def display_short_name
+      "-#{short_option_name}" if short_option_name
+    end
+    
+    def display_value
+      "#{"[" if value_is_optional}#{value_name}#{"]" if value_is_optional}#{"..." if value_may_be_array}"
+    end
+    
+    def columnized_display
+      [display_short_name, display_name, display_value, comment]
+    end
+  end
+  
+
+  class IteratableArray < Array
+    def initialize *args, &block
+      @position = 0
+      super(*args, &block)
+    end
+    
+    attr_accessor :position
+
+    def each_with_iterator
+      while @position < length
+        result = yield(current)
+
+        if result.kind_of?(Array)
+          if result.first == :and_crop
+            slice!(@position, result.last)
+          elsif result.first == :after_slice_until!
+            
+          else
+            step
+          end
+        else
+          step
+        end
+      end
+    end
+    
+    def slice_until!
+      slice_from = @position
+      step
+      
+      while @position < length
+        break if yield(current)
+        step
+      end
+      
+      result = slice!(slice_from, @position - slice_from)
+      
+      @position = slice_from
+      
+      return result
+    end
+    
+    def current
+      self[@position]
+    end
+
+    def look_ahead(offset = 1)
+      self[@position + offset]
+    end
+    
+    def remains
+      slice(@position..-1)
+    end
+    
+    def step
+      @position += 1
+    end
+    
+    def end?
+      @position >= length
+    end
+  end
+  
+
+  def initialize argv
+    # TODO ! Normalisation of "=" and ",". Remove "=", join comma separated arrays to arrays.
+
+    @argv = IteratableArray.new(argv)
+    @values = {}
+
+    @header = []
+    @footer = []
+    
+    @errors = []
+    
+    @heading_opts  = IteratableArray.new
+    @tailing_opts  = IteratableArray.new
+    @floating_opts = IteratableArray.new
+    
+    @opts = {}
+    @opts_list = []
+
+    @tailing_start_position = 0
+    
+    yield(self) if block_given?
+  end
+
+  def [] option
+    if @values.has_key?(option)
+      @values[option]
+      
+    elsif @values.has_key?(key = option.to_s)
+      @values[key]
+      
+    elsif @values.has_key?(key = option.to_s.gsub(/_/, '-'))
+      @values[key]
+
+    elsif @values.has_key?(key = option.to_s.gsub(/_/, '-').upcase)
+      @values[key]
+    
+    else
+      nil
+    end
+  end
+  
+  def []= option, value
+    @values[option] = value
+  end
+
+  def to_hash
+    @values
+  end
+
+  def merge hash
+    to_hash.merge hash
+  end
+  
+  def inspect
+    @values.inspect
+  end
+  
+  attr_reader :header, :footer, :errors
+  
+  def errors?
+    !@errors.empty?
+  end
+  
+  def complete?
+    (errors? || 
+     !@argv.empty? ||
+      unnamed_opts_incomplete?(@heading_opts) ||
+      unnamed_opts_incomplete?(@tailing_opts) ||
+      unnamed_opts_incomplete?(@floating_opts)) ? false : true
+  end
+  
+  private
+  
+  def unnamed_opts_incomplete? collection
+    !collection.remains.select{|item| !item.value_is_optional && !@values[item.option_name]}.empty?
+  end
+  
+  def display_incomplete_required_unnamed_opts collection
+    collection.remains.select{|item| !item.value_is_optional}.collect{|item|item.display}
+  end
+  
+  public
+  
+  def show_options_and_errors_on_incomplete
+    unless complete?
+      show_options_and_errors
+      true
+    else
+      false
+    end
+  end
+
+  def show_options_and_errors
+    show_options
+    show_errors
+  end
+  
+  def show_errors_and_options
+    show_errors
+    show_options
+  end
+  
+  def show_errors output = STDERR
+    
+    # TODO: Check MacOS compatibility
+    
+    if ENV["LANG"].include?("UTF-8")
+      header_line = "⬇⬇⬇ "
+      footer_line = "⬆⬆⬆ "
+    else
+      header_line = "vvv "
+      footer_line = "^^^ "
+    end
+    
+    output << (header_line * 20 + "\n\n")
+    output << (@errors * "\n" +  "\n") unless @errors.empty?
+    output << ("Can't parse options: " + @argv * " " +  "\n") unless @argv.empty?
+    output << ("Incomplete heading options: " + display_incomplete_required_unnamed_opts(@heading_opts) * " " + "\n") if unnamed_opts_incomplete?(@heading_opts)
+    output << ("Incomplete tailing options: " + display_incomplete_required_unnamed_opts(@tailing_opts) * " " + "\n") if unnamed_opts_incomplete?(@tailing_opts)
+    output << ("Incomplete floating options: " + display_incomplete_required_unnamed_opts(@floating_opts) * " " + "\n") if unnamed_opts_incomplete?(@floating_opts)
+    output << ("\n" + (footer_line * 20) + "\n\n")
+    
+    output.flush if output.respond_to?(:flush)
+  end
+  
+  def show_options output = STDOUT
+    output << (@header * "\n" + "\n\n") unless @header.empty?
+    
+    overview = @heading_opts.collect{|option| option.display}
+    overview += [("[Options]..." unless @opts_list.empty?)]
+      
+    unless @floating_opts.empty?
+      overview += @floating_opts.collect{|option| option.display}
+      overview += [("[Options]..." unless @opts_list.empty?)]
+    end
+    
+    overview += @tailing_opts.collect{|option| option.display}
+
+    output << "Usage:\n  " + ("#{$0} " + (overview * " ") + "\n\n")
+    
+    options = @opts_list.collect {|option| option.columnized_display }
+    unnamed_opts = (@heading_opts + @tailing_opts + @floating_opts).collect{|option| option.columnized_display}
+
+    first_column = options.collect{|option| "#{option[0]},".length}.max
+    second_column = (unnamed_opts.collect{|option| "#{option[0]}".length} + options.collect{|option| option[1] ? "#{option[1]} #{option[2]}".length : ("#{option[2]}".length - 1)}).max
+
+    lines = unnamed_opts.collect do |option|
+      sprintf("  %#{first_column}s %#{0 - second_column}s %s", nil, option[0], option[1])
+    end
+    
+    lines.push ""
+    lines.push "Options:"
+
+    lines += options.collect do |option|
+      if option[1]
+        sprintf("  %#{first_column}s %#{0 - second_column}s %s", ("#{option[0]}," if option[0]), "#{option[1]} #{option[2]}", option[3])
+      else
+        sprintf("  %#{first_column - 1}s %#{-1-second_column}s %s", option[0], option[2], option[3])
+      end
+    end
+
+    output << (lines * "\n" + "\n\n")
+    
+    output << (@footer * "\n" + "\n\n")
+    
+    output.flush if output.respond_to?(:flush)
+  end
+
+  private
+
+  VALUE_NAME = /[\w\d\-\/\\\:]+/
+  
+  def parse_option(option, comment, conditions, &block)
+    unless (matchdata = option.match(/^\s*(-([\w\d\?]+)\s*((\[?)(#{VALUE_NAME})(\]?)(\.{0,3}))?\s*(,*)\s*)?(--(\[no-\])?([\w\d\-\?]+)\s*((\[?)(#{VALUE_NAME})(\]?)(\.{0,3}))?\s*(,*)\s*)?$/))
+      raise "Can not recognize option declaration '#{option}'" 
+    end
+
+    return Option.new(
+      matchdata[2],  #  short_option_name
+      matchdata[11], #  option_name
+      matchdata[10] == "[no-]" || (!matchdata[14] && !matchdata[5]) ? true : false, #  option_is_boolean
+      matchdata[13] == "["   || matchdata[4] == "["   ? true : false, #  value_is_optional
+      matchdata[16] == "..." || matchdata[7] == "..." ? true : false, #  value_may_be_array
+      matchdata[14] || matchdata[5], #  value_name
+      comment,
+      conditions,
+      block
+    )
+  end
+  
+  def parse_unnamed_option(option, comment, conditions, &block)
+    unless (matchdata = option.match(/^\s*(\[?)(#{VALUE_NAME})(\]?)(\.{0,3}?)\s*$/))
+      raise "Can not recognize option declaration '#{option}'" 
+    end
+    
+    return UnnamedOption.new(
+      matchdata[2], #  option_name
+      matchdata[1] == "[" ? true : false,   #  value_is_optional
+      matchdata[4] == "..." ? true : false, #  value_may_be_array
+      comment,
+      conditions,
+      block
+    )
+  end
+  
+  def push_unnamed_option(collection, option)
+    raise("There are no text left for #{option.option_name} after a greedy array '#{collection.last.option_name}'") if collection.last && collection.last.value_may_be_array
+    raise("Strictly required text #{option.option_name} can't be after a optional text '#{collection.last.option_name}'") if !option.value_is_optional && collection.last && collection.last.value_is_optional
+    
+    collection.push option    
+  end
+  
+  public
+
+  # "--option-foo [VALUE]"
+  # "--option [VALUE]..." (zero or more comma separated values)
+  # "--option VALUE"
+  # "--option VALUE..." (one or more comma separated values)
+  # "--option"
+  # "--[no-]option"
+  # 
+  # "-ooo [VALUE]"
+  # "-o [VALUE]..." (zero or more comma separated values)
+  # "-o VALUE"
+  # "-o VALUE..." (one or more comma separated values)
+  # "-o"
+  # 
+  # "-o, --option [VALUE]"
+  # "-o, --option [VALUE]..." (zero or more comma separated values)
+  # "-o, --option VALUE"
+  # "-o, --option VALUE..." (one or more comma separated values)
+  # "-o, --option"
+  # "-o, --[no-]option"
+  def option(option, comment = nil, conditions = nil, &block)
+    option = parse_option(option, comment, conditions, &block)
+    
+    @opts_list.push option
+    @opts[option.short_option_name] = option if option.short_option_name
+    @opts[option.option_name] = option if option.option_name
+  end
+  
+  # "[VALUE]"
+  # "VALUE"
+  # "[VALUE]..." (zero or more space separated values)
+  # "VALUE..."  (one or more space separated values)
+  def heading_option(option, comment = nil, conditions = nil, &block)
+    push_unnamed_option(@heading_opts, parse_unnamed_option(option, comment, conditions, &block))
+  end
+  
+  # "[VALUE]"
+  # "VALUE"
+  # "[VALUE]..." (zero or more space separated values)
+  # "VALUE..."  (one or more space separated values)
+  def tailing_option(option, comment = nil, conditions = nil, &block)
+    push_unnamed_option(@tailing_opts, parse_unnamed_option(option, comment, conditions, &block))
+  end
+  
+  # "[VALUE]"
+  # "VALUE"
+  # "[VALUE]..." (zero or more space separated values)
+  # "VALUE..."  (one or more space separated values)
+  def floating_option(option, comment = nil, conditions = nil, &block)
+    push_unnamed_option(@floating_opts, parse_unnamed_option(option, comment, conditions, &block))
+  end
+  
+
+  private
+  
+  def check_and_assign_value option, value
+    value = value.split(",") if option.value_may_be_array
+    
+    if option.option_is_boolean
+      option.block.call if value && option.block
+    else
+      begin
+        value = option.block.call(value) if option.block
+      rescue ArgumentError => exception
+        @errors << "#{option.display_names}: #{exception.message}"
+        
+      rescue Exception => exception
+        @errors << "#{option.display_names}: #{exception.inspect_with_backtrace}"
+        
+        raise exception unless exception.kind_of?(StandardError) || exception.kind_of?(ScriptError)
+      end
+    end
+    
+    # TODO: conditions
+    
+    @values[option.option_name || option.short_option_name] = value
+  end
+  
+  def parse_unnamed_opts collection
+    @argv.each_with_iterator do |item|
+      break if collection.end? || item =~ /^-/
+      
+      if collection.current.value_may_be_array
+        check_and_assign_value(collection.current, @argv.slice_until!{|item| item =~ /^-/})
+        collection.step
+        break
+      else
+        check_and_assign_value(collection.current, item)
+        collection.step
+        next :and_crop, 1
+      end
+    end
+  end
+  
+  public
+  
+  # TODO: "tar -czf file.tgz dir", "tar czf file.tgz dir"
+
+  def parse!
+    @argv.position = 0
+    
+    parse_unnamed_opts @heading_opts
+    
+    @argv.each_with_iterator do |item|
+      next unless (matchdata = item.match(/^--?(no-)?([\w\d\-\?]+)$/))
+      next unless (option = @opts[matchdata[2]])
+      
+      @tailing_start_position = @argv.position
+      
+      if option.option_is_boolean
+        check_and_assign_value(option, (matchdata[1].nil? ? true : false))
+        next :and_crop, 1
+        
+      elsif @argv.look_ahead =~ /^-/ || !@argv.look_ahead
+        if option.value_is_optional
+          check_and_assign_value(option, true)
+        else
+          errors << "#{option.display_names} must have a value"
+        end
+        next :and_crop, 1
+      else
+        check_and_assign_value(option, @argv.look_ahead)
+        next :and_crop, 2
+      end
+    end
+    
+    unless @argv.detect{|item| item =~ /^-/}
+      @argv.position = @tailing_start_position
+      parse_unnamed_opts @tailing_opts
+      
+      @argv.position = 0
+      parse_unnamed_opts @floating_opts
+    end
+  end
+end

data/lib/ruby-process-controller/process_controller.rb

@@ -0,0 +1,484 @@
+
+#  Copyright 2006-2009 Stanislav Senotrusov <senotrusov@gmail.com>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+
+
+  # CALL SEQUENCE AND CONCURRENCY
+  # -----------------------------
+  #  
+  # initialize
+  # start
+  # join
+  # stop
+  # before_exit
+  # 
+  # initialize выполняется в main без каких-либо тредов
+  # start, stop, before_exit выполняются строго по порядку, неконкурентно
+  # join вызывается после start, при этом stop может быть как позже, так и раньше join
+  
+  # EXCEPTION HANDLING
+  # ------------------
+  #
+  # on exception from initialize - пишется в лог и на экран, процесс завершится
+  # on exception from start - стартуется termination watchdog (15 секунд по умолчанию), вызывается join и stop в непредсказуемом порядке, после join - before_exit
+  # on exception from stop - процесс аварийно останавливается, before_exit не выполняется
+  # on exception from join - пишется в лог, переходит к before_exit
+  # on exception from before_exit - пишется в лог, процесс завершается
+  
+  # SIGNAL HANDLING AND BEHAVIOR WITH UNIMPLEMENTED METHODS
+  # -------------------------------------------------------
+  #
+  # join, stop and before exit MAY BE implemented or not. 
+  #
+  # В момент выполнения initialize, сигналы ещё не перехватываются и ruby вызывает SignalException в произвольном месте initialize.
+  # Если сигнал на остановку приходит после initialize, но до start, то start-join-stop-before_exit не выполняются вовсе.
+  #
+  # If join() and stop() IS implemented, join() will be after start() and stop() will be called in a separate thread ONLY ONCE AFTER FIRST SIGNAL
+  #
+  # If stop() is not implemented, SignalException raised (by ruby) for main thread running start() ON EACH received INT, TERM, ABRT or HUP 
+  #
+  # If join() is not implemented, stop will be called in main thread, как бы его приостанавливая ON EACH received INT, TERM, ABRT or HUP
+  #   Note, in that case, when stop() call is still working and the next signal is arrived, first stop() processing stops and seconds starts.
+  #
+  # Если определён только join, но не stop, то join вызывается после завершения start.
+
+
+class ProcessController
+  COMMANDS = %w(start stop run)
+  
+  FAILURE_EXIT_CODES = {
+    :process_controller_init => 1,
+    :termination_watchdog => 2,
+    :stop_thread => 3,
+    :dispatch_termination_signal => 4,
+    :stop_has_no_effect => 5
+  }
+  
+  DEFAULT_NAME = "daemon"
+  LOGGER_CLASS = defined?(ActiveSupport::BufferedLogger) && ActiveSupport::BufferedLogger || 
+                 defined?(Merb::Logger) && Merb::Logger || 
+                 defined?(Logger) && Logger 
+                 
+  DEFAULT_PID_DIR = "tmp/pids"
+  DEFAULT_LOG_DIR = "log"
+  
+  DEFAULT_TERM_TIMEOUT = 15
+  MINIMUM_TERM_TIMEOUT = 1
+
+  attr_reader :logger, :env, :name, :argv
+  
+  
+  # ARGV OPTIONS
+  # TODO: extract class
+  
+  def initialize_argv_options(argv)
+    @argv ||= ArgvParser.new(ARGV)
+    define_argv_options
+    @argv.parse!
+    apply_argv_options
+  end
+    
+  def define_argv_options
+    @argv.heading_option "[COMMAND]", "ProcessController command (#{COMMANDS * "/"})"
+
+    @argv.option "-e, --environment NAME", "Run in environment (development/production/testing)"
+    @argv.option "-n, --name NAME", "Daemon's name"
+
+    @argv.option "--user USER", "Run as user"
+    @argv.option "--group GROUP", "Run as group"
+    @argv.option "--working-dir DIRECTORY", "Working directory, defaults to ."
+
+    @argv.option "--pid-dir DIRECTORY", "PID directory, relative to working-dir, defaults to '#{DEFAULT_PID_DIR}', fallbacks to '.', may be absolute path"
+    @argv.option "--pid-file FILE", "PID file, defaults to [name].pid, may be absolute path"
+
+    @argv.option "--log-level LEVEL", "Log level (#{LOGGER_CLASS::Severity.constants * "/"})"
+    @argv.option "--log-dir DIRECTORY", "Log directory, relative to working-dir, default to '#{DEFAULT_LOG_DIR}', fallbacks to '.', may be absolute path"
+    @argv.option "--log-file FILE", "Logfile, default to [name].log, may be absolute path"
+
+    @argv.option "--term-timeout SECONDS", "Termination timeout, default to 30 seconds"
+    @argv.option "-h, --help", "Show this help message"
+  end
+  
+  def apply_argv_options
+    @user = @argv["user"]
+    @group = @argv["group"]
+    
+    @working_dir = @argv["working-dir"]
+    
+    @command = @argv["COMMAND"] || "run"
+    
+    @env = @argv["environment"] || (@command == "start" ? "production" : "development")
+    
+    @name = @argv["name"] || DEFAULT_NAME
+
+    @pid_dir = @argv['pid-dir'] || DEFAULT_PID_DIR
+    @pid_dir = '.' unless File.directory? @pid_dir
+
+    @pid_file = if @argv['pid-file']
+        (@argv['pid-file'] =~ /^\//) ? @argv['pid-file'] : "#{@pid_dir}/#{@argv['pid-file']}"
+      else
+         "#{@pid_dir}/#{@name}.pid"
+      end
+
+    @log_level = LOGGER_CLASS::Severity.const_get((@argv["log-level"] || (@env == "production" ? "warn" : "debug")).upcase.to_sym)
+    
+    @log_dir = @argv["log-dir"] || DEFAULT_LOG_DIR
+    @log_dir = '.' unless File.directory?(@log_dir)
+    
+    @log_file = if (@command == "run" || @command == "stop")
+        STDOUT
+      elsif @argv["log-file"]
+        (@argv["log-file"] =~ /^\//) ? @argv["log-file"] : "#{@log_dir}/#{@argv["log-file"]}"
+      else
+        "#{@log_dir}/#{@name}.log"
+      end
+
+    @term_timeout = (@argv['term-timeout'] || DEFAULT_TERM_TIMEOUT).to_i
+    @term_timeout = MINIMUM_TERM_TIMEOUT if @term_timeout < MINIMUM_TERM_TIMEOUT
+  end
+
+  
+  # INITIALIZE
+
+  def initialize(argv = nil)
+    initialize_argv_options(argv)
+    
+    change_process_privileges
+
+    Dir.chdir(@working_dir) if @working_dir
+    
+    if @command != "stop"
+      @logger = LOGGER_CLASS.new(@log_file, @log_level)
+      @logger.auto_flushing = true
+      
+      @stop_mutex = Mutex.new
+      @stop_was_called = false
+      
+      @stop_thread_mutex = Mutex.new
+      @stop_thread_was_runned = false
+      
+      @daemon_mutex = Mutex.new
+      @must_terminate = false
+      @daemon_started_to_some_extent = false
+      @detached = false
+      
+      if (running_pid = getpid)
+        if is_running? running_pid
+          raise "#{@name}: already running with pid #{running_pid}"
+        else
+          log(:warn, "#{self.class}#initialize @name:`#{@name}' -- Found pidfile:`#{@pid_file}' with pid:`#{running_pid}' and is not running, it may be result of an unclean shutdown.")
+        end
+      end
+
+      @logger.info "#{self.class}#initialize @name:`#{@name}' -- Creating process..."
+      
+      @daemon = yield(self)
+      
+      @logger.info "#{self.class}#initialize @name:`#{@name}' -- Process initialized."
+    end
+    
+    if @argv["help"]
+      @argv.show_options
+      
+    elsif @argv.complete?
+      __send__("execute_#{@command}")
+      
+    else
+      @argv.show_errors(@logger) if @logger
+      @argv.show_options_and_errors
+    end
+    
+    @logger.flush if @logger && @logger.respond_to?(:flush)
+    
+  rescue Exception => exception
+    begin
+      log(:fatal, "#{self.class}#initialize @name:`#{@name}' -- #{exception.inspect_with_backtrace}") if @log_file != STDOUT
+      
+      unless @detached
+        @argv.errors << exception.inspect_with_backtrace
+        @argv.show_errors
+      end
+    rescue Exception => another_exception
+      STDERR.puts "\n#{exception.inspect_with_backtrace}"
+      STDERR.puts "\nWhile handling previous exception another error was occured:\n#{another_exception.inspect_with_backtrace}"
+    ensure
+      Process.exit!(FAILURE_EXIT_CODES[:process_controller_init])
+    end
+  end
+  
+  def stop
+    @stop_mutex.synchronize do
+      unless @stop_was_called
+        @stop_was_called = true
+        dispatch_termination_signal
+      end
+    end
+  end
+
+  private
+  
+
+  # START/RUN/STOP COMMANDS
+  
+  def execute_start
+    detach
+    execute_run
+  end
+  
+  def execute_run
+    @logger.info "#{self.class}#execute_run @name:`#{@name}' -- Starting..."
+    
+    create_pid  
+    
+    @termination_watchdog = termination_watchdog
+    @stop_thread = stop_thread if @daemon.respond_to?(:stop) && @daemon.respond_to?(:join)
+
+    trap_signals if @daemon.respond_to?(:stop)
+    
+    daemon_start_sequence
+
+  ensure
+    untrap_signals
+    delete_pid
+    @logger.info "#{self.class}#execute_run @name:`#{@name}' -- Stopped"
+  end
+  
+  def daemon_start_sequence
+    start_daemon    
+    join_daemon
+
+  ensure
+    before_exit_daemon_handler
+  end
+  
+  
+  def start_daemon
+    @daemon_mutex.synchronize do
+      return if @must_terminate
+
+      @daemon_started_to_some_extent = true
+
+      @daemon.start
+    end
+  rescue Exception => exception
+    log(:fatal, "#{self.class}#start_daemon @name:`#{@name}' -- #{exception.inspect_with_backtrace}")
+    stop_daemon
+  end
+  
+  
+  def join_daemon
+    @daemon.join if @daemon.respond_to?(:join) && @daemon_started_to_some_extent
+  rescue Exception => exception
+    log(:fatal, "#{self.class}#join_daemon @name:`#{@name}' -- #{exception.inspect_with_backtrace}")
+  end
+  
+  
+  def before_exit_daemon_handler
+    @daemon_mutex.synchronize do
+      @daemon.before_exit if @daemon.respond_to?(:before_exit) && @daemon_started_to_some_extent
+    end
+  rescue Exception => exception
+    log(:fatal, "#{self.class}#before_exit_daemon_handler @name:`#{@name}' -- #{exception.inspect_with_backtrace}")
+  end
+  
+  
+  def execute_stop
+    if (running_pid = getpid)
+      if is_running? running_pid
+        Process.kill("TERM", running_pid)
+        
+        start_waiting = Time.now
+        user_is_given_to_know_whats_happening = false
+        
+        while is_running? running_pid 
+          sleep 0.1
+          now = Time.now
+          
+          if !user_is_given_to_know_whats_happening && (now - start_waiting > @term_timeout * 0.2)
+            STDOUT.puts "#{self.class}#execute_stop @name:`#{@name}' -- Waiting for @term_timeout:`#{@term_timeout}' seconds..."
+            user_is_given_to_know_whats_happening = true
+            start_waiting = Time.now
+            
+          elsif now - start_waiting > @term_timeout
+            STDOUT.puts "#{self.class}#execute_stop @name:`#{@name}' -- ERROR. Process DOES NOT stopped in @term_timeout:`#{@term_timeout}' seconds"
+            Process.exit!(FAILURE_EXIT_CODES[:stop_has_no_effect])
+            
+          end
+        end          
+        STDOUT.puts "#{self.class}#execute_stop @name:`#{@name}' -- Stopped"
+      else
+        raise "@name:`#{@name}' -- Process with pid:`#{running_pid}' is not running."
+      end
+    else
+      raise "@name:`#{@name}' -- Pidfile:`#{@pid_file}' not found"
+    end
+  end
+  
+
+  # PROCESS PRIVILEGES AND TERMINAL DETACH
+  
+  # TODO: REVIEW THIS
+  
+  def change_process_privileges
+    uid = @user && Etc.getpwnam(@user).uid || Process.euid
+    gid = @group && Etc.getgrnam(@group).gid || Process.egid
+    
+    # http://www.ruby-forum.com/topic/110492
+    Process.initgroups(@user, gid) if @user
+    
+    Process::GID.change_privilege(uid)
+    Process::UID.change_privilege(gid)
+  end
+
+  # based on Reimer Behrends notes http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/87467
+  def detach
+    Process.exit!(0) if fork        # Parent exits, child continues.
+    Process.setsid                  # Become session leader.
+    Process.exit!(0) if fork        # Zap session leader. See http://www.erlenstar.demon.co.uk/unix/faq_2.html#SEC16
+    
+    File.umask 022                  # Ensure sensible umask. Adjust as needed.
+    
+    STDIN.reopen "/dev/null" # Free file descriptors and
+
+
+#    STDOUT.reopen(@log_file.gsub(/\.(log)$/, '.output'), "a") # point them somewhere sensible.
+#    STDERR.reopen STDOUT                                      # STDOUT/ERR should better go to a logfile.
+
+    STDOUT.reopen(@logger.instance_variable_get("@log")) # point them somewhere sensible.
+    STDERR.reopen STDOUT                                      # STDOUT/ERR should better go to a logfile.
+    
+    @detached = true
+  end
+  
+  
+  # SIGNAL HANDLING
+  
+  
+  # This "Thread.stop" complexity is needed, кажется, for some cases, where ruby can not spawn new threads.
+  # И я совершенно забыл, при каких обстоятельствах я наблюдал такую картину.
+  # Кажется это какие-то случаи c IO для сокетов. Надо поглядеть в коде rubymq
+  # Ещё иногда удобно нажимать ctrl+c два раза и не ждать нормального завершения
+  
+  def termination_watchdog
+    Thread.new_with_exception_handling(lambda { |exception| Process.exit!(FAILURE_EXIT_CODES[:termination_watchdog]) unless exception.kind_of?(ThreadTerminatedError) }, @logger, :fatal, "#{self.class}#termination_watchdog") do
+      Thread.stop
+      Thread.main.join_and_terminate(@term_timeout)
+    end
+  end
+  
+  def stop_thread
+    Thread.new_with_exception_handling(lambda { Process.exit!(FAILURE_EXIT_CODES[:stop_thread]) }, @logger, :fatal, "#{self.class}#stop_thread") do
+      Thread.stop
+      @logger.debug("#{self.class}#stop_thread @name:`#{@name}' -- Stopping...")
+      @daemon_mutex.synchronize do
+        @must_terminate = true
+        @daemon.stop if @daemon_started_to_some_extent
+      end
+    end
+  end
+
+  def dispatch_termination_signal
+    stop_daemon
+  rescue Exception => exception
+    begin
+      log(:fatal, "#{self.class}#dispatch_termination_signal @name:`#{@name}' -- Error while stopping: #{exception.inspect_with_backtrace}")
+    ensure
+      Process.exit!(FAILURE_EXIT_CODES[:dispatch_termination_signal])
+    end
+  end
+  
+  def stop_daemon
+    log(:info, "\n#{self.class}#stop_daemon @name:`#{@name}' -- Stopping...")
+
+    if @termination_watchdog
+      begin
+        @termination_watchdog.run 
+      rescue ThreadError
+      end
+    end
+
+    if @stop_thread
+      begin
+        @stop_thread_mutex.synchronize do
+          unless @stop_thread_was_runned
+            @stop_thread_was_runned = true
+            @stop_thread.run
+          end
+        end
+      rescue ThreadError
+      end
+    else
+      @daemon.stop
+    end
+  end
+  
+  
+  # SIGNAL TRAPPING
+  
+  def trap_signals
+    Signal.trap('INT')  {dispatch_termination_signal} # Ctrl+C
+    Signal.trap('TERM') {dispatch_termination_signal} # kill
+    Signal.trap('ABRT') {dispatch_termination_signal} # Ctrl-\
+    Signal.trap('HUP')  {dispatch_termination_signal} # terminal line hand-up
+  end
+  
+  def untrap_signals
+    Signal.trap 'INT',  'DEFAULT'
+    Signal.trap 'TERM', 'DEFAULT'
+    Signal.trap 'ABRT', 'DEFAULT'
+    Signal.trap 'HUP',  'DEFAULT'
+  end
+
+
+  # PID FILE
+
+  def create_pid
+    File.write @pid_file, Process.pid
+  end
+
+  def delete_pid
+    File.delete @pid_file
+  end
+  
+  def getpid
+    if File.exists?(@pid_file)
+      File.read(@pid_file).to_i
+    else
+      false
+    end
+  end
+  
+
+  # DETECTION OF ALREADY RUNNING DAEMON
+
+  def is_running? pid
+    begin        
+      Process.getpgid(pid) && true
+    rescue Errno::ESRCH
+      false
+    end
+  end
+  
+
+  # LOGGING
+
+  def log severity, message
+    if defined?(@logger)
+      @logger.__send__(severity, message)
+      @logger.flush if @logger.respond_to?(:flush)
+    end
+  end
+end
+

data/lib/ruby-process-controller/test_daemon.rb

@@ -0,0 +1,38 @@
+
+#  Copyright 2006-2009 Stanislav Senotrusov <senotrusov@gmail.com>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+class ProcessController::TestDaemon
+  SLEEP_FOR = 100
+  
+  def define_options(options)
+    options.header << "Test Daemon"
+    options.option "--foo FOO", "Foo option"
+  end
+
+  def apply_options(options)
+    puts options.inspect
+  end
+
+  def start
+    puts "#{self.class.inspect} STARTED"
+    puts "#{self.class.inspect} SLEEPING FOR #{SLEEP_FOR} seconds..."
+    sleep SLEEP_FOR
+  end
+  
+  def stop
+    puts "#{self.class.inspect} STOP method"
+  end
+end
+

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: senotrusov-ruby-process-controller
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- Stanislav Senotrusov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-23 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: senotrusov-ruby-toolkit
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: senotrusov-ruby-threading-toolkit
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: senotrusov@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- README
+- LICENSE
+- lib/ruby-process-controller.rb
+- lib/ruby-process-controller
+- lib/ruby-process-controller/argv_parser.rb
+- lib/ruby-process-controller/test_daemon.rb
+- lib/ruby-process-controller/process_controller.rb
+has_rdoc: false
+homepage: http://github.com/senotrusov
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Staging for console ruby apps - ARGV parser, logger, pids, 2nd instance run prevention, privileges, signals, graceful shutdown for multithreaded app
+test_files: []
+