trinidad_daemon_extension 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+0.1.0 (2010-04-17)
+ 
+  * First release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David Calavera
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,42 @@
+Trinidad Daemon Extension
+=======
+
+# DESCRIPTION
+
+Extension to run Trinidad server as a daemon.
+
+[WARNING] This extension only works with Trinidad 0.8.3 or above.
+
+# INSTALLATION
+
+jruby -S gem install trinidad_daemon_extension
+
+# USAGE
+
+This extension can be enabled from the Trinidad's configuration file or from the command line.
+It uses a temporal directory to write the pid file but its route can be overrided.
+
+  * To enable it from the configuration file you have to add a section "extensions" to the root of the file and the section "daemon" to this one. The pid file can be specified there:
+
+    --
+      extensions:
+        daemon:
+          pid_file: ./trinidad.pid # this is optional by default the extension writes the pid file into a temporal directory.
+
+  * To enable it from the command line you have to load the extension first and the add one of these options:
+
+     -d, --daemonize [PID_FILE]
+
+     for instance: 
+
+     $ jruby -S trinidad --load daemon --daemonize ./trinidad.pid
+
+# TODO
+
+  * enable logging. Right now the Tomcat's log is not written anywhere.
+
+You can find further information on how to write your onw extension in the wiki: http://wiki.github.com/calavera/trinidad/extensions
+
+# Copyright
+
+Copyright (c) 2010 David Calavera. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,150 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :spec
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_opts = ['--options', 'spec/spec.opts']
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+task :build => ['ant:build', 'gemspec'] do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg|src)/ }.
+    reject { |file| file =~ /tomcat-core.jar/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  files << "\n    trinidad-libs/trinidad-daemon-extension.jar"
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/lib/trinidad_daemon_extension.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+gem 'trinidad_jars'
+require 'trinidad/extensions'
+require 'trinidad/jars'
+
+require File.expand_path('../../trinidad-libs/akuma', __FILE__)
+require File.expand_path('../../trinidad-libs/trinidad-daemon-extension', __FILE__)
+
+module Trinidad
+  module Extensions
+    module Daemon
+      VERSION = '0.1.0'
+    end
+
+    class DaemonServerExtension < ServerExtension
+      def configure(tomcat)
+        org.jruby.trinidad.TrinidadDaemon.new(tomcat, @options[:pid_file])
+      end
+
+      def override_tomcat?; true; end
+    end
+
+    class DaemonOptionsExtension < OptionsExtension
+      def configure(parser, default_options)
+        parser.on('-d', '--daemonize [PID_FILE]', 'run Trinidad as a daemon, pid_file by default is ENV[$TMPDIR]/trinidad.pid') do |pid|
+          extensions = default_options[:extensions] || {}
+          extensions[:daemon] = {:pid_file => pid}
+          default_options[:extensions] = extensions
+        end
+      end
+    end
+  end
+end

data/rakelib/build.rake

@@ -0,0 +1,38 @@
+require 'ant'
+require 'fileutils'
+include FileUtils
+
+TARGET_DIR = 'target'
+LIBS_DIR = 'trinidad-libs'
+JAR_NAME = 'trinidad-daemon-extension.jar'
+
+namespace :ant do
+  desc 'Clean the java target directory'
+  task :clean do
+    rm_f TARGET_DIR
+    rm_f "#{LIBS_DIR}/#{JAR_NAME}"
+  end
+
+  desc 'Compile the java classes'
+  task :compile => :clean do
+    opts = {
+      :fork => 'true',
+      :failonerror => 'true',
+      :srcdir => 'src/main',
+      :destdir => TARGET_DIR,
+      :classpath => Dir.glob('trinidad-libs/*.jar').join(':')
+    }
+
+    mkdir_p TARGET_DIR
+    ant.javac(opts)
+  end
+
+  desc 'Create the jar file'
+  task :build => :compile do
+    opts = {
+      :destfile => "#{LIBS_DIR}/#{JAR_NAME}",
+      :basedir => TARGET_DIR
+    }
+    ant.jar(opts)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'java'
+require 'trinidad_daemon_extension'
+require 'mocha'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

data/spec/trinidad_daemon_extension_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'optparse'
+
+describe Trinidad::Extensions::DaemonServerExtension do
+  subject { Trinidad::Extensions::DaemonServerExtension.new({}) }
+
+  before(:each) do
+    @tomcat = Trinidad::Tomcat::Tomcat.new
+  end
+
+  it "bypass the control to the daemon" do
+    daemon = subject.configure(@tomcat)
+    daemon.should_not be_nil
+    daemon.should be_instance_of(org.jruby.trinidad.TrinidadDaemon)
+  end
+
+  it "uses a temporal directory to write the pid file by default" do
+    daemon = subject.configure(@tomcat)
+    daemon.pid_file.should =~ /trinidad.pid$/
+  end
+
+  it "can use a given pid file" do
+    extension = Trinidad::Extensions::DaemonServerExtension.new(:pid_file => 'trinidad_pid.txt')
+    daemon = extension.configure(@tomcat)
+    daemon.pid_file.should =~ /trinidad_pid.txt$/
+  end
+
+  it "allows to specify a command line option to run the daemon" do
+    extension = Trinidad::Extensions::DaemonOptionsExtension.new
+    parser = OptionParser.new
+    options = {}
+    
+    extension.configure(parser, options)
+    parser.parse! '-d /tmp/trinidad.pid'.split
+
+    options[:extensions].keys.should include(:daemon)
+    options[:extensions][:daemon].should include(:pid_file)
+    options[:extensions][:daemon][:pid_file].should == '/tmp/trinidad.pid'
+  end
+end

data/trinidad_daemon_extension.gemspec

@@ -0,0 +1,73 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'trinidad_daemon_extension'
+  s.version           = '0.1.0'
+  s.date              = '2010-04-17'
+  s.rubyforge_project = 'trinidad_daemon_extension'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Trinidad daemon extension"
+  s.description = "Trinidad extension to run the Apache Tomcat server as a daemon"
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["David Calavera"]
+  s.email    = 'calavera@apache.org'
+  s.homepage = 'http://github.com/trinidad/trinidad_daemon_extension'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README LICENSE]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  s.add_dependency('trinidad_jars', [">= 0.1.1"])
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('mocha')
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    History.txt
+    LICENSE
+    README
+    Rakefile
+    lib/trinidad_daemon_extension.rb
+    rakelib/build.rake
+    spec/spec.opts
+    spec/spec_helper.rb
+    spec/trinidad_daemon_extension_spec.rb
+    trinidad-libs/akuma.jar
+    trinidad_daemon_extension.gemspec
+    trinidad-libs/trinidad-daemon-extension.jar
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^spec\/.*_spec\.rb/ }
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: trinidad_daemon_extension
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Calavera
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-17 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: trinidad_jars
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Trinidad extension to run the Apache Tomcat server as a daemon
+email: calavera@apache.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- History.txt
+- LICENSE
+- README
+- Rakefile
+- lib/trinidad_daemon_extension.rb
+- rakelib/build.rake
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/trinidad_daemon_extension_spec.rb
+- trinidad-libs/akuma.jar
+- trinidad_daemon_extension.gemspec
+- trinidad-libs/trinidad-daemon-extension.jar
+has_rdoc: true
+homepage: http://github.com/trinidad/trinidad_daemon_extension
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: trinidad_daemon_extension
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 2
+summary: Trinidad daemon extension
+test_files: 
+- spec/trinidad_daemon_extension_spec.rb