init 1.0.0

data/History.txt

@@ -0,0 +1,5 @@
+=== 1.0.0 / 2009-03-25
+
+* 1 major enhancement
+
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+README.rdoc
+COPYING.txt
+Rakefile
+lib/init.rb
+lib/init/init.rb
+examples/murmur.rb
+spec/init_spec.rb
+spec/bin/mock_daemon.rb
+spec/bin/simple_init.rb

data/README.rdoc

@@ -0,0 +1,164 @@
+= Init
+
+* Project: https://rubyforge.org/projects/aef/
+* RDoc: http://aef.rubyforge.org/init/
+* Github: http://github.com/aef/init/
+
+== DESCRIPTION:
+
+Clean and simple *nix init scripts with Ruby
+
+== FEATURES/PROBLEMS:
+
+* Tested and fully working on:
+  * Ubuntu Linux 8.10 i386_64 (Ruby 1.8.7 and 1.9.1p0)
+  * Debian GNU/Linux 4.0 i386 (Ruby 1.8.6)
+
+== SYNOPSIS:
+
+Simply subclass Init and define at least a start and a stop method. At the end,
+call the parse method on that class.
+
+  class DemoSubclass < Aef::Init
+    def start
+      system('echo start')
+    end
+
+    def stop
+      system('echo stop')
+    end
+  end
+  
+  DemoSubclass.parse
+
+To be able to call the commands from ruby you should wrap the parse method call
+in a block that only calls it if the script is executed on the commandline.
+
+  if __FILE__ == $PROGRAM_NAME
+    DemoSubclass.parse
+  end
+
+There is no need to implement the command restart in most cases, as there is one
+defined by default, which simply calls the commands stop and start in a row.
+A delay can between the two commands can be defined:
+
+  class DemoSubclass < Aef::Init
+    ...
+    stop_start_delay 3
+    ...
+  end
+
+If no command is specified on the commandline, restart is called by default.
+This default can be changed:
+
+  class DemoSubclass < Aef::Init
+    ...
+    default_command :start
+    ...
+  end
+
+If you want to share commands between init scripts, you can also simple put a
+class between Init and the final implementation:
+
+  class CommonCommands > Aef::Init
+    def common
+      system('echo common')
+    end
+  end
+
+  class DemoSubclass > CommonCommands
+    ...
+  end
+
+See examples/murmur.rb and spec/bin/simple_ini.rb for working example classes.
+
+== REQUIREMENTS:
+
+* rubygems
+
+=== Additional for automated testing
+* hoe
+* rspec
+* sys-uname
+
+== INSTALL:
+
+=== Normal
+
+  gem install init
+
+=== High security (recommended)
+
+There is a high security installation option available through rubygems. It is
+highly recommended over the normal installation, although it may be a bit less
+comfortable. To use the installation method, you will need my public key, which
+I use for cryptographic signatures on all my gems. You can find the public key
+and more detailed verification information in the aef-certificates section of my
+rubyforge project[https://rubyforge.org/frs/?group_id=7890&release_id=31749]
+
+Add the key to your rubygems' trusted certificates by the following command:
+
+  gem cert --add aef.pem
+
+Now you can install the gem while automatically verifying it's signature by the
+following command:
+
+  gem install init --ignore-dependencies -P HighSecurity
+
+Please notice that you will need other keys for dependent libraries, so you may
+have to install dependencies manually.
+
+=== Automated testing
+
+You can test this package through rspec on your system. First find the path
+where the gem was installed to:
+
+  gem which init
+
+Go into the root directory of the installed gem and run the following command
+to start the test runner:
+
+  rake spec
+
+On Windows systems you have to run the following instead:
+
+  spec spec/**/*_spec.rb
+
+If something goes wrong you should be noticed through failing examples.
+
+== DEVELOPMENT:
+
+This software is developed in the source code management system git hosted
+at github.com. You can download the most recent sourcecode through the following
+command:
+
+  git clone git://github.com/aef/init.git
+
+Help on making this software better is always very appreciated. If you want your
+changes to be included in the official release, please send me a patch through
+the project's tracker[https://rubyforge.org/tracker/?group_id=7890] at
+rubyforge.org. You can generate a patch-file by the following command:
+
+  git diff > patch.diff
+
+Please make sure to write tests for your changes and notice that I can't promise
+to include your changes before reviewing them.
+
+== LICENSE:
+
+Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+
+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/>.

data/Rakefile

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/init.rb'
+
+Hoe.new('init', Aef::Init::VERSION) do |p|
+  p.rubyforge_name = 'aef'
+  p.developer('Alexander E. Fischer', 'aef@raxys.net')
+  p.extra_dev_deps = %w{rspec facets}
+  p.url = 'https://rubyforge.org/projects/aef/'
+  p.readme_file = 'README.rdoc'
+  p.extra_rdoc_files = %w{README.rdoc}
+  p.spec_extras = {
+    :rdoc_options => ['--main', 'README.rdoc', '--inline-source', '--line-numbers', '--title', 'Init']
+  }
+end
+
+# vim: syntax=Ruby

data/examples/murmur.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# 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 'init'
+
+# An example init script for the voice chat application Murmur
+class Murmur < Aef::Init
+  PATH = '/opt/murmur'
+  DAEMON = File.join(PATH, 'murmur.x86')
+  PIDFILE = '/var/run/murmur/murmur.pid'
+  USER = 'mumble'
+
+  # Defines the seconds to wait between stop and start in the predefined restart
+  # command
+  stop_start_delay 1
+
+  # If not set this defaults to :restart
+  default_command :start
+
+  # An implementation of the start method for the mumble daemon
+  def start
+    system("start-stop-daemon --start --chdir #{PATH} --chuid #{USER} --exec #{DAEMON}")
+  end
+
+  # An implementation of the stop method for the mumble daemon
+  def stop
+    system("start-stop-daemon --stop --pidfile #{PIDFILE}")
+  end
+end
+
+# The parser is only executed if the script is executed as a program, never
+# when the script is required in a ruby program
+if __FILE__ == $PROGRAM_NAME
+  Murmur.parse
+end

data/lib/init.rb

@@ -0,0 +1,30 @@
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# 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/>.
+
+# 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:
+#
+#  include Aef
+module Aef
+  
+end
+
+libdir = File.dirname(__FILE__)
+require File.join(libdir, 'init/init')

data/lib/init/init.rb

@@ -0,0 +1,85 @@
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# 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 'rubygems'
+
+# Clean and simple *nix init scripts with Ruby
+class Aef::Init
+  VERSION = '1.0.0'
+
+  # Call this to begin commandline parsing
+  #
+  # If an invalid command is specified on the commandline, a usage example is
+  # displayed. If no command is specified, the default command is started
+  def self.parse
+    command = ARGV.shift || :default
+
+    valid_commands = []
+
+    self.ancestors.each do |klass|
+      valid_commands += klass.public_instance_methods(false)
+      break if klass == Aef::Init
+    end
+
+    valid_commands.uniq!
+
+    @@default_command ||= 'restart'
+    @@stop_start_delay ||= 0
+
+    # This is neccessary because since ruby 1.9, the instance_methods method
+    # returns an array of symbols instead of an array of strings which it did
+    # in 1.8
+    command = command.to_sym if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('1.9')
+
+    if command == :default
+      new.send(@@default_command)
+    elsif valid_commands.include?(command)
+      new.send(command)
+    else
+      puts "Usage: #$PROGRAM_NAME {#{valid_commands.sort.join('|')}}"; exit false
+    end
+  end
+
+  # Set a delay in seconds between the call of the stop and the start method in
+  # the predefined restart method
+  def self.stop_start_delay(seconds)
+    @@stop_start_delay = seconds
+  end
+
+  # Set a default command to be called if no command is specified on the
+  # commandline.
+  def self.default_command(command)
+    @@default_command = command
+  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 @@stop_start_delay
+    start
+  end
+end

data/spec/bin/mock_daemon.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# 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/>.
+
+# This is a simple mock daemon which will write all commandline arguments it
+# recevies to a file specified as first commandline option
+
+if ARGV.empty?
+  puts "Usage: #$PROGRAM_NAME output_file [arguments]"
+else
+  puts arguments = ARGV.join(' ')
+  puts output_file = ARGV.first
+
+  File.open(output_file, 'a') do |f|
+    f.puts(arguments)
+  end
+end

data/spec/bin/simple_init.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# 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 'lib/init'
+
+# A library in between the base and the final class
+class MiddleInit < Aef::Init
+  RUBY_PATH = 'ruby'
+  MOCK_EXECUTABLE = "#{RUBY_PATH} spec/bin/mock_daemon.rb"
+
+  def middle
+    tempfile = ARGV.first
+    system("#{MOCK_EXECUTABLE} #{tempfile} --middle -e --abc")
+  end
+
+  protected
+
+  def middle_protected
+    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
+  end
+end
+
+# The final implementation
+class SimpleInit < MiddleInit
+  RUBY_PATH = 'ruby'
+  MOCK_EXECUTABLE = "#{RUBY_PATH} spec/bin/mock_daemon.rb"
+
+  # Defines the seconds to wait between stop and start in the predefined restart
+  # command
+  stop_start_delay 1.5
+
+  # If not set this defaults to :restart
+  default_command :stop
+
+  # An implementation of the start method for the mumble daemon
+  def start
+    tempfile = ARGV.first
+    system("#{MOCK_EXECUTABLE} #{tempfile} --start --example -y")
+  end
+
+  # An implementation of the stop method for the mumble daemon
+  def stop
+    tempfile = ARGV.first
+    system("#{MOCK_EXECUTABLE} #{tempfile} --stop --example -y")
+  end
+
+  protected
+
+  def end_protected
+    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
+  end
+end
+
+# The parser is only executed if the script is executed as a program, never
+# when the script is required in a ruby program
+if __FILE__ == $PROGRAM_NAME
+  SimpleInit.parse
+end