init 1.2.1 → 2.0.0

data/examples/murmur.rb

@@ -1,21 +1,22 @@
 #!/usr/bin/env ruby
-#
-# Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2010
-#
-# This file is part of Init.
-#
-# Init is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Init.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
 
 require 'aef/init'
 

data/init.gemspec

@@ -0,0 +1,55 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Init.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require File.expand_path('../lib/aef/init/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'init'
+  s.version     = Aef::Init::VERSION.dup
+  s.authors     = ['Alexander E. Fischer']
+  s.email       = ['aef@raxys.net']
+  s.homepage    = 'http://github.com/aef/init'
+  s.license     = 'ISC'
+  s.summary     = 'Clean and simple *nix init scripts with Ruby'
+  s.description = <<-DESCRIPTION
+Init is a lightweight framework for writing readable, reusable *nix init
+scripts in Ruby.
+  DESCRIPTION
+
+  s.rubyforge_project = nil
+  s.has_rdoc          = 'yard'
+  s.extra_rdoc_files  = ['HISTORY.md', 'LICENSE.md']
+
+  s.files         = `git ls-files`.lines.map(&:chomp)
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.lines.map(&:chomp)
+  s.executables   = `git ls-files -- bin/*`.lines.map{|f| File.basename(f.chomp) }
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.add_development_dependency('bundler', '~> 1.0.22')
+  s.add_development_dependency('rake', '~> 0.9.2')
+  s.add_development_dependency('rspec', '~> 2.8.0')
+  s.add_development_dependency('simplecov', '~> 0.6.1')
+  s.add_development_dependency('pry', '~> 0.9.8')
+  s.add_development_dependency('yard', '~> 0.7.5')
+
+  s.cert_chain = "#{ENV['GEM_CERT_CHAIN']}".split(':')
+  s.signing_key = ENV['GEM_SIGNING_KEY']
+end

data/lib/aef/init.rb

@@ -1,29 +1,133 @@
-# Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2010
-#
-# This file is part of Init.
-#
-# Init is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Init.
 
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require 'set'
 require 'pathname'
+require 'aef/init/version'
 
-# Namespace for projects of Alexander E. Fischer <aef@raxys.net>
-#
+# Namespace for projects of Alexander E. Fischer <aef@raxys.net>.
+# 
 # If you want to be able to simply type Example instead of Aef::Example to
 # address classes in this namespace simply write the following before using the
-# classes:
+# classes.
 #
-#  include Aef
+# @example Including the namespace
+#   include Aef
+# @author Alexander E. Fischer
 module Aef
-  autoload :Init, 'aef/init/init'
+
+  # Clean and simple *nix init scripts with Ruby
+  class Init
+
+    class << self
+
+      # The default command to be called if no command is specified on the
+      # commandline.
+      #
+      # @note This used to be implicitly set to "restart" but in practice
+      #   caused far too much unwanted service restarts, so it is now not
+      #   enabled by default.
+      #
+      # @return [Symbol] a command's name
+      attr_writer :default_command
+
+      # The default command to be called if no command is specified on the
+      # commandline.
+      #
+      # @note This used to be implicitly set to "restart" but in practice
+      #   caused far too much unwanted service restarts, so it is now not
+      #   enabled by default.
+      def default_command(command = false)
+        if command.equal?(false)
+          @default_command
+        else
+          @default_command = command.to_sym
+        end
+      end
+
+      # The delay in seconds between the call of the stop and the start method
+      # in the predefined restart method.
+      #
+      # @return [Float] time in seconds
+      attr_writer :stop_start_delay
+
+      # The delay in seconds between the call of the stop and the start method
+      # in the predefined restart method.
+      #
+      # @param [Numeric, false] time in seconds, if false is given, the value
+      #   will be returned and not modified.
+      # @return [Float] time in seconds
+      def stop_start_delay(seconds = false)
+        if seconds.equal?(false)
+          @stop_start_delay ||= 0.0
+        else
+          @stop_start_delay = seconds.to_f
+        end
+      end
+
+      # Call this to begin commandline parse.
+      #
+      # If an invalid command is specified on the commandline, a usage example
+      # is displayed. If no command is specified, the default command is
+      # started, if one is set.
+      def parse
+        command = ARGV.shift || :default
+    
+        valid_commands = []
+    
+        ancestors.each do |klass|
+          valid_commands += klass.public_instance_methods(false)
+          break if klass == Aef::Init
+        end
+
+        valid_commands = valid_commands.sort.map(&:to_sym).uniq!
+    
+        command = command.to_sym
+    
+        if command == :default && default_command
+          new.send(default_command)
+        elsif valid_commands.include?(command)
+          new.send(command)
+        else
+          puts "Usage: #$PROGRAM_NAME {#{valid_commands.join('|')}}"; exit false
+        end
+      end
+
+    end
+
+    # The start method needs to be implemented in a subclass
+    def start
+      warn 'start method needs to be implemented'
+      exit false
+    end
+  
+    # The stop method needs to be implemented in a subclass
+    def stop
+      warn 'stop method needs to be implemented'
+      exit false
+    end
+  
+    # By default restart simply calls stop and then start
+    def restart
+      stop
+      sleep self.class.stop_start_delay
+      start
+    end
+  end
 end

data/lib/aef/init/version.rb

@@ -0,0 +1,30 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Init.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+module Aef
+  class Init
+
+    # The currently loaded library version
+    #
+    # Using Semantic Versioning (2.0.0-rc.1) rules
+    # @see http://semver.org/
+    VERSION = '2.0.0'.freeze
+
+  end
+end

data/lib/init.rb

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Init.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+# Helper file to allow loading by gem name.
+
+require 'aef/init'

data/spec/bin/mock_daemon.rb

@@ -1,24 +1,22 @@
 #!/usr/bin/env ruby
-#
-# Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2010
-#
-# This file is part of Init.
-#
-# Init is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
 
-# This is a simple mock daemon which will write all commandline arguments it
-# recevies to a file specified as first commandline option
+This file is part of Init.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
 
 if ARGV.empty?
   puts "Usage: #$PROGRAM_NAME output_file [arguments]"

data/spec/bin/simple_init.rb

@@ -1,21 +1,22 @@
 #!/usr/bin/env ruby
-#
-# Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2010
-#
-# This file is part of Init.
-#
-# Init is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Init.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
 
 require 'rbconfig'
 
@@ -34,13 +35,15 @@ class MiddleInit < Aef::Init
   protected
 
   def middle_protected
-    warn 'This should not be executable as a command'; exit false
+    warn 'This should not be executable as a command'
+    exit false
   end
 
   private
 
   def middle_private
-    warn 'This should not be executable as a command'; exit false
+    warn 'This should not be executable as a command'
+    exit false
   end
 end
 
@@ -68,13 +71,15 @@ class SimpleInit < MiddleInit
   protected
 
   def end_protected
-    warn 'This should not be executable as a command'; exit false
+    warn 'This should not be executable as a command'
+    exit false
   end
 
   private
 
   def end_private
-    warn 'This should not be executable as a command'; exit false
+    warn 'This should not be executable as a command'
+    exit false
   end
 end
 

data/spec/init_spec.rb

@@ -1,23 +1,23 @@
-# Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2010
-#
-# This file is part of Init.
-#
-# Init is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-require './spec/spec_helper'
-
-require 'facets/timer'
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+This file is part of Init.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+=end
+
+require 'spec_helper'
 
 describe Aef::Init do
   before(:each) do
@@ -73,13 +73,12 @@ describe Aef::Init do
   it "should wait 3 seconds between stop and start through the restart command" do
     restart_output = @temp_dir + 'restart_output'
 
-    timer = Timer.new
-    timer.start
+    start_time = Time.now
 
     `#{executable} restart #{restart_output}`.should be_true
 
-    timer.stop
-    (timer.total_time.should > 1.5).should be_true
+    stop_time = Time.now
+    (stop_time - start_time).should > 1.5
   end
 
   it "should display a usage example if a wrong command is specified" do