trinidad_lifecycle_extension 0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+== Trinidad
+
+Copyright (c) 2010 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,67 @@
+Trinidad lifecycle extension
+============================
+
+This extension allows you to add lifecycle listeners written in ruby to the
+Trinidad's server context as well as each application context that runs on top
+of Trinidad.
+
+
+[WARNING] This extension is completely experimental and has not been tested nor
+published yet.
+
+
+Configuration
+=============
+
+Add this extension into the Trinidad's configuration file and include the path
+to the directory where the listeners are. For instance:
+
+extensions:
+  lifecycle:
+    path: 'lib/lifecycle'
+
+Trinidad will try to load each class into that directory and add it to the
+approrpiated context regarding where the extension will be configured, into the
+server section or into the web_app section.
+
+
+How to write a lifecycle listener
+=================================
+
+If the listener is for the server the class must be into the module
+Trinidad::Lyfecycle::Server but if it's for the web application it must be into
+the module Trinidad::Lyfecycle::WebApp. The class must include the java class
+LifecycleListener and must contain the method `lifecycleEvent(event)`. For
+example:
+
+module Trinidad
+  module Lifecycle
+    module WebApp
+      import org.apache.catalina.LifecycleListener
+      import org.apache.catalina.Lifecycle
+
+      class WebAppListener
+        include LifecycleListener
+
+        def lifecycleEvent(event)
+          if Lifecycle::BEFORE_START_EVENT == event.type
+            # do something before start the web application context
+          end
+        end
+      end
+    end
+  end
+end
+
+As a reference, Trinidad is configured with a lifecycle listener, here is the
+code:
+
+http://github.com/calavera/trinidad/blob/master/lib/trinidad/web_app_lifecycle_listener.rb
+
+You should also be familiar with the Tomcat's life cycle:
+
+http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Lifecycle.java?view=markup
+
+== Copyright
+
+Copyright (c) 2010 David Calavera<calavera@apache.org>. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,147 @@
+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 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 --tags"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+task :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)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # 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_lifecycle_extension.rb

@@ -0,0 +1,46 @@
+require 'rubygems'
+gem 'trinidad_jars'
+require 'trinidad/extensions'
+
+module Trinidad
+  module Extensions
+    module Lifecycle
+      VERSION = '0.1.0'
+
+      def init_listeners(context, path, mod_name)
+        Dir.glob("#{path}/*.rb").each do |listener|
+          load listener
+        end
+
+        mod = constantize(mod_name)
+
+        mod.constants.each do |listener|
+          const_listener = mod.const_get(listener)
+          context.add_lifecycle_listener(const_listener.new)
+        end
+      end
+
+      def constantize(mod)
+        names = mod.split('::')
+        names.inject(Object) {|constant, obj| constant.const_get(obj) }
+      end
+    end
+
+
+    class LifecycleServerExtension < ServerExtension
+      include Lifecycle
+
+      def configure(tomcat)
+        init_listeners(tomcat.server, @options[:path], 'Trinidad::Lifecycle::Server')
+      end
+    end
+
+    class LifecycleWebAppExtension < WebAppExtension
+      include Lifecycle
+
+      def configure(tomcat, app_context)
+        init_listeners(app_context, @options[:path], 'Trinidad::Lifecycle::WebApp')
+      end
+    end
+  end
+end

data/spec/fixtures/fake_lifecycle_listener.rb

@@ -0,0 +1,24 @@
+module Trinidad
+  module Lifecycle
+    import org.apache.catalina.LifecycleListener
+    import org.apache.catalina.Lifecycle
+
+    module Server
+      class FakeServerListener
+        include LifecycleListener
+
+        def lifecycleEvent(event)
+        end
+      end
+    end
+
+    module WebApp
+      class FakeWebAppListener
+        include LifecycleListener
+
+        def lifecycleEvent(event)
+        end
+      end
+    end
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'trinidad_lifecycle_extension'
+
+require 'rubygems'
+require 'trinidad'
+require 'spec'
+
+Spec::Runner.configure do |config| 
+  config.mock_with :mocha
+end

data/spec/trinidad_lifecycle_extension_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'Trinidad lifecycle extension' do
+  before(:all) do
+    @options = { :path => File.expand_path('../fixtures', __FILE__) }
+  end
+
+  before(:each) do
+    @context = Trinidad::Tomcat::StandardContext.new
+    @tomcat = mock
+    @tomcat.stubs(:server).returns(@context)
+  end
+
+  context "when it's a server extension" do
+    subject { Trinidad::Extensions::LifecycleServerExtension.new(@options) }
+
+    it "adds the listener to the tomcat's server context" do
+      subject.configure(@tomcat)
+      @tomcat.server.findLifecycleListeners().should have(1).listener
+    end
+  end
+
+  context "when it's a webapp extension" do
+    subject { Trinidad::Extensions::LifecycleWebAppExtension.new(@options) }
+
+    it "adds the listener to the application context" do
+      app_context = Trinidad::Tomcat::StandardContext.new
+      subject.configure(@tomcat, app_context)
+      app_context.findLifecycleListeners().should have(1).listener
+    end
+  end
+end

data/trinidad_lifecycle_extension.gemspec

@@ -0,0 +1,69 @@
+## 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_lifecycle_extension'
+  s.version           = '0.1.0'
+  s.date              = '2010-09-12'
+  s.rubyforge_project = 'trinidad_lifecycle_extension'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Add lifecycle listeners to the trinidad's server or applications"
+  s.description = "Add lifecycle listeners to the trinidad's server or the applications that run on it"
+
+  ## 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/calavera/trinidad_lifecycle_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('DEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  # s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## 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[
+    LICENSE
+    README
+    Rakefile
+    lib/trinidad_lifecycle_extension.rb
+    spec/fixtures/fake_lifecycle_listener.rb
+    spec/spec.opts
+    spec/spec_helper.rb
+    spec/trinidad_lifecycle_extension_spec.rb
+    trinidad_lifecycle_extension.gemspec
+  ]
+  # = 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,76 @@
+--- !ruby/object:Gem::Specification 
+name: trinidad_lifecycle_extension
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Calavera
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-12 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Add lifecycle listeners to the trinidad's server or the applications that run on it
+email: calavera@apache.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- LICENSE
+- README
+- Rakefile
+- lib/trinidad_lifecycle_extension.rb
+- spec/fixtures/fake_lifecycle_listener.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/trinidad_lifecycle_extension_spec.rb
+- trinidad_lifecycle_extension.gemspec
+has_rdoc: true
+homepage: http://github.com/calavera/trinidad_lifecycle_extension
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: trinidad_lifecycle_extension
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 2
+summary: Add lifecycle listeners to the trinidad's server or applications
+test_files: []
+