trinidad_diagnostics_extension 0.1.0

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem 'trinidad'
+gem 'jruby-lint', '>=0.3.0'
+
+group :test do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bouncy-castle-java (1.5.0146.1)
+    diff-lcs (1.1.2)
+    jruby-lint (0.3.0)
+      jruby-openssl
+      nokogiri (= 1.5.0.beta.4)
+      term-ansicolor
+    jruby-openssl (0.7.4)
+      bouncy-castle-java
+    jruby-rack (1.0.9)
+    nokogiri (1.5.0.beta.4-java)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.2)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    term-ansicolor (1.0.5)
+    trinidad (1.2.1)
+      jruby-rack (>= 1.0.9)
+      trinidad_jars (>= 1.0.1)
+    trinidad_jars (1.0.1)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  jruby-lint (>= 0.3.0)
+  rspec
+  trinidad

data/History.txt

@@ -0,0 +1,5 @@
+== 0.1.0 (2011-07-05)
+
+* Initial release
+* Create diagnostics.html
+* Allow debug mode

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 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.md

@@ -0,0 +1,33 @@
+# Trinidad diagnostics extension
+
+Trinidad diagnostics let's you know the level of compatibility between
+your application and JRuby. 
+
+It uses [JRuby lint](http://github.com/jruby/jruby-lint)
+under the hood to inspect your code before Trinidad starts up your
+application. Once your code is audited jruby-lint generates an html report
+that's located under your public directory, so you can access to it from a
+browser. I.e if the application path is `/` the report is located under
+`/diagnostics.html`.
+
+## Installation
+
+Install the gem trinidad_diagnostics_extension or add it to your Gemfile.
+
+## Configuration
+
+Add the extension to the Trinidad's configuration file:
+
+    ---
+      extensions:
+        diagnostics:
+
+Or load it from the command line:
+
+    $ trinidad --load diagnostics
+
+### Further configuration
+
+There is a debug mode that prints the results by the console log to. Add the
+option `debug: true` under the extension configuration or use the option
+`--diagnostics-debug` from the command line.

data/Rakefile

@@ -0,0 +1,131 @@
+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
+#
+#############################################################################
+
+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)
+#
+#############################################################################
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['--colour', "--format documentation"]
+end
+
+#############################################################################
+#
+# 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 --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 :install => :build do
+  sh "gem install pkg/#{name}-#{version}.gem"
+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|trinidad-libs|rakelib)/ }.
+    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_diagnostics_extension.rb

@@ -0,0 +1,63 @@
+module Trinidad
+  module Extensions
+    gem 'jruby-lint'
+    require 'jruby/lint'
+
+    class DiagnosticsWebAppExtension < WebAppExtension
+      VERSION = '0.1.0'
+
+      def configure(tomcat, app_context)
+        app_context.add_lifecycle_listener DiagnosticsListener.new(@options[:debug])
+      end
+    end
+
+    class DiagnosticsOptionsExtension < OptionsExtension
+      def configure(parser, default_options)
+        default_options[:extensions] ||= {}
+        default_options[:extensions][:diagnostics] = {}
+
+        parser.on('--dd', '--diagnostics-debug', 'Append diagnostics to the console log') do
+          default_options[:extensions][:diagnostics] ||= {}
+          default_options[:extensions][:diagnostics][:debug] = true
+        end
+      end
+    end
+
+    class DiagnosticsListener
+      require 'ostruct'
+      include Trinidad::Tomcat::LifecycleListener
+
+      def initialize(debug)
+        @debug = debug || false
+      end
+
+      def lifecycleEvent(event)
+        if event.type == Trinidad::Tomcat::Lifecycle::BEFORE_START_EVENT
+          puts '-- Trinidad diagnostics on' if @debug
+          app_context = event.lifecycle
+
+          options = lint_options(app_context)
+
+          run_diagnostics(options)
+          puts '-- Trinidad diagnostics off' if @debug
+        end
+      end
+
+      def run_diagnostics(options)
+        JRuby::Lint::Project.new(options).run
+      end
+
+      def lint_options(app_context)
+        OpenStruct.new(
+          :html => report_output(app_context),
+          :chdir => app_context.doc_base,
+          :text => @debug)
+      end
+
+      def report_output(app_context)
+        public_root = app_context.find_parameter('public.root') || 'public'
+        File.join(public_root, 'diagnostics.html')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'java'
+require 'rspec'
+require 'trinidad'
+require 'trinidad_diagnostics_extension'

data/spec/trinidad_diagnostics_extension_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe 'Trinidad::Extensions::DiagnosticsWebAppExtension' do
+  it "add the diagnostics listener to the application context" do
+    context = Trinidad::Tomcat::StandardContext.new
+    extension = Trinidad::Extensions::DiagnosticsWebAppExtension.new {}
+    extension.configure(nil, context)
+
+    context.find_lifecycle_listeners.should have(1).listener
+  end
+end
+
+describe 'Trinidad::Extensions::DiagnosticsListener' do
+  subject { Trinidad::Extensions::DiagnosticsListener }
+  let(:context) { Trinidad::Tomcat::StandardContext.new }
+
+  it 'keeps the report file under the public root' do
+    listener = subject.new(false)
+    context.add_parameter('public.root', 'foo')
+
+    file_path = listener.report_output(context)
+    file_path.should == 'foo/diagnostics.html'
+  end
+
+  it "uses `public' as default path to keep the report" do
+    listener = subject.new(false)
+
+    file_path = listener.report_output(context)
+    file_path.should == 'public/diagnostics.html'
+  end
+
+  it "uses the context doc base as root directory to inspect" do
+    listener = subject.new(false)
+    context.doc_base = Dir.pwd
+
+    options = listener.lint_options(context)
+    options.chdir.should == Dir.pwd
+  end
+
+  it "appends a text reporter when the debug option is enabled" do
+    listener = subject.new(true)
+
+    options = listener.lint_options(context)
+    options.text.should == true
+  end
+
+  it "uses the report output as html report file path" do
+    listener = subject.new(true)
+
+    options = listener.lint_options(context)
+    options.html.should == listener.report_output(context)
+  end
+
+  it "runs the diagnostics before the application starts" do
+    listener = subject.new(false)
+    event = mock
+    event.should_receive(:type).and_return Trinidad::Tomcat::Lifecycle::BEFORE_START_EVENT
+    event.should_receive(:lifecycle).and_return context
+    listener.should_receive(:run_diagnostics)
+
+    listener.lifecycleEvent event
+  end
+
+  it "does not run the diagnostics on any other event" do
+    listener = subject.new(false)
+    event = mock
+    event.should_receive(:type).and_return Trinidad::Tomcat::Lifecycle::AFTER_START_EVENT
+    event.should_not_receive(:lifecycle)
+    listener.should_not_receive(:run_diagnostics)
+
+    listener.lifecycleEvent event
+  end
+end

data/trinidad_diagnostics_extension.gemspec

@@ -0,0 +1,71 @@
+## 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_diagnostics_extension'
+  s.version           = '0.1.0'
+  s.date              = '2011-07-05'
+  s.rubyforge_project = 'trinidad_diagnostics_extension'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "JRuby diagnostics for Trinidad"
+  s.description = "Plugin that uses JRuby-lint to run diagnostics for the application before Trinidad starts it up"
+
+  ## 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_diagnostics_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.md 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')
+  s.add_dependency('jruby-lint', '>=0.3.0')
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  s.add_development_dependency('rspec')
+
+  ## 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[
+    Gemfile
+    Gemfile.lock
+    History.txt
+    LICENSE
+    README.md
+    Rakefile
+    lib/trinidad_diagnostics_extension.rb
+    spec/spec_helper.rb
+    spec/trinidad_diagnostics_extension_spec.rb
+    trinidad_diagnostics_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,98 @@
+--- !ruby/object:Gem::Specification 
+name: trinidad_diagnostics_extension
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+  - David Calavera
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-05 00:00:00 +02:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: trinidad
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: jruby-lint
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 0.3.0
+    type: :runtime
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id003
+description: Plugin that uses JRuby-lint to run diagnostics for the application before Trinidad starts it up
+email: calavera@apache.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+  - README.md
+  - LICENSE
+files: 
+  - Gemfile
+  - Gemfile.lock
+  - History.txt
+  - LICENSE
+  - README.md
+  - Rakefile
+  - lib/trinidad_diagnostics_extension.rb
+  - spec/spec_helper.rb
+  - spec/trinidad_diagnostics_extension_spec.rb
+  - trinidad_diagnostics_extension.gemspec
+has_rdoc: true
+homepage: http://github.com/calavera/trinidad_diagnostics_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 
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+requirements: []
+
+rubyforge_project: trinidad_diagnostics_extension
+rubygems_version: 1.5.1
+signing_key: 
+specification_version: 2
+summary: JRuby diagnostics for Trinidad
+test_files: 
+  - spec/trinidad_diagnostics_extension_spec.rb