init 1.2.1 → 2.0.0

data/.gitignore

@@ -0,0 +1,12 @@
+# Project metadata
+nbproject
+.idea
+
+Gemfile.lock
+
+doc
+coverage
+pkg
+.yardoc
+.rbx
+*.rbc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-18mode
+  - jruby-19mode

data/.yardopts

@@ -0,0 +1,5 @@
+--protected
+--no-private
+-
+HISTORY.md
+LICENSE.md

data/Gemfile

@@ -0,0 +1,23 @@
+# 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
+
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in weekling.gemspec
+gemspec

data/{History.txt → HISTORY.md}

@@ -1,4 +1,19 @@
-=== 1.2.1 / 2010-12-02
+2.0.0 / 2012-03-13
+==================
+
+* 2 major improvement
+
+  * Changed to ISC based license
+  * A default command is no longer set implicitly
+
+* 3 minor enhancements
+
+  * Using singleton class instance variables instead of class variables
+  * Slightly restructured project
+  * Documentation converted to YARD syntax
+
+1.2.1 / 2010-12-02
+==================
 
 * 1 minor enchancement
 
@@ -8,7 +23,8 @@
 
   * Removed machine local paths from gemspec file
 
-=== 1.2.0 / 2010-12-02
+1.2.0 / 2010-12-02
+==================
 
 * 3 minor enhancements
 
@@ -20,7 +36,8 @@
 
   * Fixed some typos in documentation
 
-=== 1.1.0 / 2010-10-04
+1.1.0 / 2010-10-04
+==================
 
 * 3 minor enhancements
 
@@ -32,7 +49,8 @@
 
   * Files are now correctly namespaced
 
-=== 1.0.0 / 2009-03-25
+1.0.0 / 2009-03-25
+==================
 
 * 1 major enhancement
 

data/LICENSE.md

@@ -0,0 +1,15 @@
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
+
+Init is licensed under the following ISC-style license:
+
+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.

data/README.md

@@ -0,0 +1,244 @@
+Init
+====
+
+[![Build Status](https://secure.travis-ci.org/aef/init.png)](
+https://secure.travis-ci.org/aef/init)
+
+* [Documentation][docs]
+* [Project][project]
+
+   [docs]:    http://rdoc.info/github/aef/init/
+   [project]: https://github.com/aef/init/
+
+Description
+-----------
+
+Init is a lightweight framework for writing readable, reusable *nix init
+scripts in Ruby.
+
+Features / Problems
+-------------------
+
+This project tries to conform to:
+
+* [Semantic Versioning (2.0.0-rc.1)][semver]
+* [Ruby Packaging Standard (0.5-draft)][rps]
+* [Ruby Style Guide][style]
+* [Gem Packaging: Best Practices][gem]
+
+   [semver]: http://semver.org/
+   [rps]:    http://chneukirchen.github.com/rps/
+   [style]:  https://github.com/bbatsov/ruby-style-guide
+   [gem]:    http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices
+
+Additional facts:
+
+* Written purely in Ruby.
+* Documented with YARD.
+* Intended to be used with Ruby 1.8.7 or higher.
+* Cryptographically signed gem and git tags.
+
+Synopsis
+--------
+
+This documentation defines the public interface of the software. Don't rely
+on elements marked as private. Those should be hidden in the documentation
+by default.
+
+### Loading
+
+In most cases you want to load the library by the following command:
+
+~~~~~ ruby
+require 'init'
+~~~~~
+
+In a bundler Gemfile you should use the following:
+
+~~~~~ ruby
+gem 'init'
+~~~~~
+
+### Library
+
+Simply subclass Aef::Init and define at least a start and a stop method. At the
+end, call the parse method on that class.
+
+~~~~~ ruby
+  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.
+
+~~~~~ ruby
+  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 between the two commands can be defined:
+
+~~~~~ ruby
+  class DemoSubclass < Aef::Init
+    ...
+    stop_start_delay 3
+    ...
+  end
+~~~~~
+
+Notice that in earlier versions the default command was preset to :restart
+which was not as useful in practice than expected. Many unwanted restarts were
+triggered because of this, so I don't recommend using this feature any more.
+
+Still, a default command can be specified which is called if no command is provided on the command-line:
+
+~~~~~ ruby
+  class DemoSubclass < Aef::Init
+    ...
+    default_command :start
+    ...
+  end
+~~~~~
+
+If you want to share commands between init scripts, you can simply insert an
+intermediate class between Init and the final implementation. This way you can
+build reusable libraries and keep your code DRY.
+
+~~~~~ ruby
+  class CommonCommands > Aef::Init
+    def common
+      system('echo common')
+    end
+  end
+
+  class DemoSubclass > CommonCommands
+    ...
+  end
+~~~~~
+
+See the examples folder and spec/bin/simple_init.rb for working example classes.
+
+Requirements
+------------
+
+* Ruby 1.8.7 or higher
+
+Installation
+------------
+
+On *nix systems you may need to prefix the command with sudo to get root
+privileges.
+
+### 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 [gem signing
+public key][gemkey], which I use for cryptographic signatures on all my gems.
+
+Add the key to your rubygems' trusted certificates by the following command:
+
+    gem cert --add aef-gem.pem
+
+Now you can install the gem while automatically verifying it's signature by the
+following command:
+
+    gem install init -P HighSecurity
+
+Please notice that you may need other keys for dependent libraries, so you may
+have to install dependencies manually.
+
+   [gemkey]: http://aef.name/crypto/aef-gem.pem
+
+### Normal
+
+    gem install init
+
+### Automated testing
+
+Go into the root directory of the installed gem and run the following command
+to fetch all development dependencies:
+
+    bundle
+
+Afterwards start the test runner:
+
+    rake spec
+
+If something goes wrong you should be noticed through failing examples.
+
+Development
+-----------
+
+### Bugs Reports and Feature Requests
+
+Please use the [issue tracker][issues] on github.com to let me know about errors
+or ideas for improvement of this software.
+
+   [issues]: https://github.com/aef/init/issues/
+
+### Source code
+
+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 https://github.com/aef/init.git
+
+The final commit before each released gem version will be marked by a tag
+named like the version with a prefixed lower-case "v", as required by Semantic
+Versioning. Every tag will be signed by my [OpenPGP public key][openpgp] which
+enables you to verify your copy of the code cryptographically.
+
+   [openpgp]: http://aef.name/crypto/aef-openpgp.asc
+
+Add the key to your GnuPG keyring by the following command:
+
+    gpg --import aef-openpgp.asc
+
+This command will tell you if your code is of integrity and authentic:
+
+    git tag -v [TAG NAME]
+
+### Contribution
+
+Help on making this software better is always very appreciated. If you want
+your changes to be included in the official release, please clone my project
+on github.com, create a named branch to commit and push your changes into and
+send me a pull request afterwards.
+
+Please make sure to write tests for your changes so that I won't break them
+when changing other things on the library. Also notice that I can't promise
+to include your changes before reviewing them.
+
+License
+-------
+
+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.

data/Rakefile

@@ -1,24 +1,48 @@
-# -*- ruby -*-
+# encoding: UTF-8
+=begin
+Copyright Alexander E. Fischer <aef@raxys.net>, 2009-2012
 
-$LOAD_PATH.unshift('lib')
+This file is part of Init.
 
-require 'hoe'
-require 'aef/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.
 
-Hoe.spec 'init' do
-  developer('Alexander E. Fischer', 'aef@raxys.net')
+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
 
-  extra_dev_deps << ['rspec', '~> 2.2.0']
-  extra_dev_deps << ['facets', '~> 2.9.0']
+require 'bundler/gem_tasks'
+require 'rake'
+require 'pathname'
+require 'yard'
+require 'rspec/core/rake_task'
 
-  self.version = Aef::Init::VERSION.dup 
-  self.rubyforge_name = 'aef'
-  self.url = 'https://rubyforge.org/projects/aef/'
-  self.readme_file = 'README.rdoc'
-  self.extra_rdoc_files = %w{README.rdoc}
-  self.spec_extras = {
-    :rdoc_options => ['--main', 'README.rdoc', '--inline-source', '--line-numbers', '--title', 'Init']
-  }
+RSpec::Core::RakeTask.new
+
+YARD::Rake::YardocTask.new('doc')
+
+desc "Removes temporary project files"
+task :clean do
+  %w{doc coverage pkg .yardoc .rbx Gemfile.lock}.map{|name| Pathname.new(name) }.each do |path|
+    path.rmtree if path.exist?
+  end
+
+  Pathname.glob('*.gem').each &:delete
+  Pathname.glob('**/*.rbc').each &:delete
+end
+
+desc "Opens an interactive console with the library loaded"
+task :console do
+  Bundler.setup
+  require 'pry'
+  require 'init'
+  Pry.start
 end
 
-# vim: syntax=Ruby
+task :default => :spec

data/examples/mongrel.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'