stepheneb-jnlp 0.0.3 → 0.0.5

data/History.txt

@@ -1,3 +1,15 @@
+== 0.0.4 2009-03-30
+
+* added MavenJnlp class for encapsulating jnlp resources served
+by a MavenJnlp Java Web Start server.
+
+* specified a dependency on hpricot v 0.6.164, so far v0.7
+doesn't support JRUby
+
+== 0.0.3 2009-02
+
+* extended OTrunk capability and integration with JRuby
+
 == 0.0.1 2008-04-14
 
 * 1 major enhancement:

data/Manifest.txt

@@ -9,6 +9,7 @@ lib/jnlp.rb
 lib/jnlp/version.rb
 lib/jnlp/jnlp.rb
 lib/jnlp/otrunk.rb
+lib/jnlp/maven_jnlp.rb
 log/debug.log
 script/console
 script/destroy

data/README.txt

@@ -1,48 +1,43 @@
-= jnlp
+== jnlp
 
-* FIX (url)
+A gem for encapsulating the content and resources referenced by Java Web Start jnlps
 
-== DESCRIPTION:
+Complete rdoc available here: http://rubywebstart.rubyforge.org/jnlp/Jnlp/Jnlp.html
 
-FIX (describe your package)
+For more information about the structure of Java Web Start see:
 
-== FEATURES/PROBLEMS:
+http://java.sun.com/javase/6/docs/technotes/guides/javaws/developersguide/contents.html
 
-* FIX (list of features or problems)
+To create a new Jnlp call Jnlp#new with a string that contains either a local path or a url.
 
-== SYNOPSIS:
+Examples:
 
-  FIX (code sample of usage)
+Creating a new Jnlp object from a local Java Web Start jnlp file. 
 
-== REQUIREMENTS:
+j = Jnlp::Jnlp.new("authoring.jnlp")
 
-* FIX (list of requirements)
+Creating a new Jnlp object from a Java Web Start jnlp referenced with a url. 
 
-== INSTALL:
+j = Jnlp::Jnlp.new("jnlp.concord.org/dev/org/concord/maven-jnlp/otrunk-sensor/otrunk-sensor.jnlp")
 
-* FIX (sudo gem install, anything else)
+Once the Jnlp object is created you can call Jnlp#cache_resources to create a local cache of all the jar and nativelib resources. 
 
-== LICENSE:
+The structure of the cache directory and the naming using for the jar and nativelib files is the same as that used by the Java Web Start Download Servlet, see:
 
-(The MIT License)
+http://java.sun.com/javase/6/docs/technotes/guides/javaws/developersguide/downloadservletguide.html
 
-Copyright (c) 2008 FIX
+== Building the gem
 
-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:
+=== First patch Hoe
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+Hoe versions 1.11.0 and 1.11.1 do not work with JRuby.
+
+To build the gem you will need to apply this patch to Hoe:
+0001-install_gem-nows-works-with-jruby-also.patch[http://gist.github.com/raw/87670/7bd12ecff3e27dd0a1a1d750b61d4efece372374/0001-install_gem-nows-works-with-jruby-also.patch]
+
+=== The source code
+
+The source code for the jnlp gem is on github[http://github.com/stepheneb/jnlp/tree/master].
+
+  git clone git://github.com/stepheneb/jnlp.git
 
-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/Rakefile

@@ -1,4 +1,19 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
-
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+require 'rubygems'
+require 'hoe'
+
+require './lib/jnlp.rb'
+
+Hoe.new('jnlp', Jnlp::VERSION) do |p|
+  p.rubyforge_name = 'rubywebstart' # if different than lowercase project name
+  p.author = 'Stephen Bannasch'
+  p.email = 'stephen.bannasch@gmail.com'
+  p.url = 'http://rubywebstart.rubyforge.org/jnlp/rdoc/'
+  p.summary = "Ruby tools for working with Java Web Start JNLPs."
+  p.description = "For manipulation of Java Web Start Jnlps and the resources they reference."
+  p.extra_deps << ['hpricot','=0.6.164']
+end
+
+task :default => :spec
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end

data/config/hoe.rb

@@ -4,7 +4,7 @@ AUTHOR = 'Stephen Bannasch'  # can also be an array of Authors
 EMAIL = "stephen.bannasch@gmail.com"
 DESCRIPTION = "For manipulation of Java Web Start Jnlps and the resources they reference."
 GEM_NAME = 'jnlp' # what ppl will type to install your gem
-RUBYFORGE_PROJECT = 'jnlp' # The unix name for your project
+RUBYFORGE_PROJECT = 'rubywebstart' # The unix name for your project
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
 
@@ -53,8 +53,8 @@ $hoe = Hoe.new(GEM_NAME, VERS) do |p|
   p.description = DESCRIPTION
   p.summary = DESCRIPTION
   p.url = HOMEPATH
+  p.remote_rdoc_dir = 'jnlp' # Release to root
   p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
-  p.test_globs = ["test/**/test_*.rb"]
   p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
   
   # == Optional

data/lib/jnlp/jnlp.rb

@@ -2,7 +2,7 @@
 # :title: Jnlp::Jnlp RDoc
 #
 # to regenerate and display this rdoc: 
-#   rdoc -U -SN jnlp.rb otrunk.rb ; open doc/index.html
+#   rdoc -U -SN jnlp.rb otrunk.rb maven_jnlp.rb; open doc/index.html
 #
 require 'rubygems'
 require 'open-uri'
@@ -13,9 +13,9 @@ require 'date'
 
 if RUBY_PLATFORM =~ /java/
   include Java
-  import java.util.jar.JarInputStream unless defined? JarInputStream
-  import java.io.FileInputStream unless defined? FileInputStream
-  import java.net.URL unless defined? URL
+  java_import java.util.jar.JarInputStream unless defined? JarInputStream
+  java_import java.io.FileInputStream unless defined? FileInputStream
+  java_import java.net.URL unless defined? URL
 end
 
 unless Net::HTTP::Get.new('/')['User-Agent'] # unless a 'User-Agent' is already defined add one
@@ -189,6 +189,13 @@ module Jnlp #:nodoc:
     #
     #   "net/sf/sail/webstart-proxy/jetty-proxy/jetty-proxy.jar"
     #
+    attr_reader :main
+    #
+    # Contains a boolean that repesents whether the main_class for this
+    # jnlp is contained within this jar.
+    # This attribute is optional in a jnlp and if present should 
+    # only be present and set to true on one jar resource in a jnlp.
+    #
     attr_reader :href
     #
     # Contains the url reference to the resource
@@ -213,6 +220,14 @@ module Jnlp #:nodoc:
     #
     #   "httpclient__V0.1.0-20071212.220020-17.jar"
     #
+    attr_reader :suffix
+    #
+    # Contains the suffix of the resource
+    #
+    # Example:
+    #
+    #   "__V0.1.0.jar"
+    #
     attr_reader :filename
     #
     # Contains the filename of the gzipped pack200 version of the resource
@@ -221,6 +236,14 @@ module Jnlp #:nodoc:
     #
     #   "httpclient__V0.1.0-20071212.220020-17.jar.pack.gz"
     #
+    attr_reader :filename_pack
+    #
+    # Contains the filename of the pack200 version of the resource
+    #
+    # Example:
+    #
+    #   "httpclient__V0.1.0-20071212.220020-17.jar.pack"
+    #
     attr_reader :filename_pack_gz
     #
     # Contains the size of the resource
@@ -332,6 +355,7 @@ module Jnlp #:nodoc:
     def initialize(res, codebase, os)
       @resource = res
       @kind = res.name
+      @main = res['main'] && res['main'] == 'true'
       @href = res['href']
       @href_path = File.dirname(@href)
       if @href_path == '.'
@@ -471,7 +495,7 @@ module Jnlp #:nodoc:
   #
   # == Jnlp
   #
-  # A library for encapslating the content and resources referenced by Java Web Start jnlps
+  # A gem for encapsulating the content and resources referenced by Java Web Start jnlps
   #
   # For more information about the structure of Java Web Start see: 
   # * http://java.sun.com/javase/6/docs/technotes/guides/javaws/developersguide/contents.html
@@ -562,37 +586,8 @@ module Jnlp #:nodoc:
   #
   # Note:
   #
-  # The current Hpricot v6.0 Gem does not work with JRuby 1.1 release candidates
-  #
-  # You can get a version that does work here:
-  #
-  #    http://www.telscenter.org/confluence/download/attachments/20236/hpricot-0.6.159-java.gem
-  # 
-  # After you download it -- install it like this:
-  #
-  #   jruby -S gem install pkg/hpricot-0.6.159-jruby.gem
-  # 
-  # FYI: If you need to build it yourself (Nick Sieger's patch still applies 
-  # cleanly to the current trunk revision: 161 of Hpricot):
-  # 
-  #   svn co  https://code.whytheluckystiff.net/svn/hpricot/trunk hpricot
-  #   cd hpricot
-  #   curl http://caldersphere.net/hpricot-0.6.157-jruby-trunk.patch > hpricot-0.6.157-jruby-trunk.patch
-  #   patch -p0 -i hpricot-0.6.157-jruby-trunk.patch
-  #   jruby -S rake package_jruby
-  #
-  # You'll find the gem here:
-  #
-  #   pkg/hpricot-0.6.159-jruby.gem
-  #
-  # If you want to run the tests (there is only one failing test in JRuby Hpricot,  C Hpricot has two different failures):
-  # 
-  #   jruby -S rake hpricot_java
-  #   jruby -S rake test
-  # 
-  # I reported all this on why's tracker for hpricot:
-  # 
-  #   https://code.whytheluckystiff.net/hpricot/ticket/131#comment:1
+  # The jnlp gem has a dependency on hpricot version 0.6.164.
+  # The most recent version of hpricot, version 0.7.0 does not yet work with JRuby.
   # 
   class Jnlp
     #
@@ -846,6 +841,7 @@ module Jnlp #:nodoc:
         @title = (info/"title").inner_html
         @vendor = (info/"vendor").inner_html
         @homepage = (info/"homepage").empty? ? '' : (info/"homepage").attr('href')
+        @description = (info/"description").empty? ? '' : (info/"description").inner_html
         icon = (info/"icon")
         @icon = Icon.new(icon) unless icon.empty?
         @offline_allowed = (info/"offline-allowed") ? true : false
@@ -956,6 +952,9 @@ module Jnlp #:nodoc:
       cp_jars = @jars.collect {|j| j.local_path}
       cp_nativelibs = @nativelibs.collect {|n| n.local_path}
       resources = cp_jars + cp_nativelibs
+      #
+      # FIXME: this should probably be more discriminatory 
+      #
       if options[:remove_jruby]
         resources = resources.reject {|r| r =~ /\/jruby\//}
       end
@@ -1037,6 +1036,9 @@ module Jnlp #:nodoc:
     #
     # This will add all the jars for this jnlp to the effective
     # classpath for this Java process.
+    # 
+    # *If* you are already running in JRuby *AND* the jnlp references a 
+    # JRuby resource the JRuby resource will not be required.
     #
     def require_resources
       if RUBY_PLATFORM =~ /java/

data/lib/jnlp/otrunk.rb

@@ -11,12 +11,12 @@ require 'net/http'
 require 'date'
 
 if RUBY_PLATFORM =~ /java/
-  import java.util.jar.JarInputStream unless defined? JarInputStream
-  import java.io.FileInputStream unless defined? FileInputStream
-  import java.net.URL unless defined? URL
-  import java.util.Collection unless defined? Collection
-  import java.util.List unless defined? List
-  import java.util.ArrayList unless defined? ArrayList
+  java_import java.util.jar.JarInputStream unless defined? JarInputStream
+  java_import java.io.FileInputStream unless defined? FileInputStream
+  java_import java.net.URL unless defined? URL
+  java_import java.util.Collection unless defined? Collection
+  java_import java.util.List unless defined? List
+  java_import java.util.ArrayList unless defined? ArrayList
   #
   # Used to refer to Java classes in the java.io package.
   # Some of the class names in the java.io package have the
@@ -87,9 +87,9 @@ module Jnlp #:nodoc:
   #
   require "#{File.expand_path(File.dirname(__FILE__))}/jnlp.rb"
   #
-  # Jnlp::Otrunk is a subclass of Jnlp::Jnlp that adds SAIL
-  # SAIL-Otrunk specific methods for execution.of the jnlp
-  # locally without using Java Web Start.
+  # Jnlp::Otrunk is a subclass of Jnlp::Jnlp that adds SAIL-Otrunk[https://confluence.concord.org/display/CSP/OTrunk]
+  # specific methods for execution.of the jnlp locally without 
+  # using Java Web Start.
   #
   # It assumes a default main-class of:
   #

data/lib/jnlp/version.rb

@@ -1,9 +1,30 @@
 module Jnlp #:nodoc:
-  module VERSION #:nodoc:
-    MAJOR = 0
-    MINOR = 0
-    TINY  = 2
-
-    STRING = [MAJOR, MINOR, TINY].join('.')
-  end
+  VERSION = '0.0.5'
+  #
+  # Let's see if this patch:
+  #
+  #   http://rubyforge.org/tracker/index.php?func=detail&aid=24392&group_id=126&atid=577
+  #
+  # makes it into RubyGems -- it has been applied.
+  # Will probably be part of 1.3.2.
+  #
+  # then I can start using this form again:
+  #
+  # module VERSION
+  #   MAJOR = 0
+  #   MINOR = 0
+  #   TINY  = 4
+  # 
+  #   STRING = [MAJOR, MINOR, TINY].join('.')
+  #   
+  #   class << self
+  #     def to_s
+  #       STRING
+  #     end
+  #     
+  #     def ==(arg)
+  #       STRING == arg
+  #     end
+  #   end
+  # end
 end

data/lib/jnlp.rb

@@ -1,8 +1,13 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
+require 'rubygems'
+
+gem 'hpricot', '=0.6.164'
+
 module Jnlp
   require 'jnlp/jnlp.rb'
   require 'jnlp/otrunk.rb'
+  require 'jnlp/maven_jnlp.rb'
   require 'jnlp/version.rb'
 end

data/website/index.html

@@ -1,11 +1,63 @@
-<html>
-	<head>
-		<meta http-equiv="Content-type" content="text/html; charset=utf-8">
-		<title>jnlp</title>
-		
-	</head>
-	<body id="body">
-		<p>This page has not yet been created for RubyGem <code>jnlp</code></p>
-		<p>To the developer: To generate it, update website/index.txt and run the rake task <code>website</code> to generate this <code>index.html</code> file.</p>
-	</body>
-</html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      jnlp
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>jnlp</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/jnlp"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/jnlp" class="numbers">0.0.3</a>
+    </div>
+    <h1>&amp;#x2192; &#8216;jnlp&#8217;</h1>
+<h2>What</h2>
+<h2>Installing</h2>
+<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">jnlp</span></pre></p>
+<h2>The basics</h2>
+<h2>Demonstration of usage</h2>
+<h2>Forum</h2>
+<p><a href="http://groups.google.com/group/jnlp">http://groups.google.com/group/jnlp</a></p>
+<p><span class="caps">TODO</span> &#8211; create Google Group &#8211; jnlp</p>
+<h2>How to submit patches</h2>
+<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+<p>The trunk repository is <code>svn://rubyforge.org/var/svn/jnlp/trunk</code> for anonymous access.</p>
+<h2>License</h2>
+<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+<h2>Contact</h2>
+<p>Comments are welcome. Send an email to <a href="mailto:FIXME"><span class="caps">FIXME</span> full name</a> email via the <a href="http://groups.google.com/group/jnlp">forum</a></p>
+    <p class="coda">
+      <a href="FIXME email">FIXME full name</a>, 12th May 2008<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: stepheneb-jnlp
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors: 
 - Stephen Bannasch