jnlp 0.0.5.4 → 0.6.1

data/History.txt

@@ -1,3 +1,25 @@
+== 0.6.1 2010-05-17
+
+Clear up new version numbering.
+
+== 0.6.0 2010-05-17
+
+Added ability to limit the number of families parsed when creating a Jnlp::MavenJnlp.
+
+Added ability to limit the number of versions parsed when creating a Jnlp::MavenJnlpFamily.
+
+Updates to the README
+
+== 0.0.5.5 2010-04-19
+
+Removed use of the development dependency on hoe. Much simpler to 
+just check-in and manage the gemspec file itself.
+See: http://yehudakatz.com/2010/04/02/using-gemspecs-as-intended/
+
+Updates to the README
+
+new specs for new behaviors
+
 == 0.0.5.4 2010-02-11
 
 addition optional parameter: arch for Jnlp::Jnlp instance methods:

data/README.rdoc

@@ -0,0 +1,134 @@
+= Jnlp:Jnlp
+
+A gem for encapsulating the content and resources referenced by Java Web Start jnlps
+and interacting with jnlp repositories managed by the maven-jnlp Eclipse plugin.
+
+Complete rdoc available here: Jnlp::Jnlp
+
+For more information about the structure of Java Web Start see Sun's documentation[http://java.sun.com/javase/6/docs/technotes/guides/javaws/developersguide/contents.html]
+
+To create a new Jnlp::Jnlp call Jnlp::Jnlp#new with a string that contains either a local path or a url.
+
+== Examples:
+
+=== Creating a new Jnlp::Jnlp object from a local Java Web Start jnlp file. 
+
+  j = Jnlp::Jnlp.new("authoring.jnlp")
+
+=== Creating a new Jnlp::Jnlp object from a Java Web Start jnlp referenced with a url. 
+
+  j = Jnlp::Jnlp.new("jnlp.concord.org/dev/org/concord/maven-jnlp/otrunk-sensor/otrunk-sensor.jnlp")
+
+Once the Jnlp::Jnlp object is created you can call Jnlp::Jnlp#cache_resources to create a local cache of all the jar and nativelib resources. 
+
+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 Sun's servelet guide[http://java.sun.com/javase/6/docs/technotes/guides/javaws/developersguide/downloadservletguide.html].
+
+== Creating MavenJnlp objects that represent the resources deployed by a maven jnlp servlet.
+
+=== Creating a MavenJnlp object that represents the all the resources deployed by a maven jnlp servlet.
+
+  require 'jnlp'
+  mj = Jnlp::MavenJnlp.new('http://jnlp.concord.org', '/dev/org/concord/maven-jnlp/')
+
+This takes about 90s on a 3Mbps connection processing Concord's
+Maven Jnlp Web Start server.
+
+You can now do this:
+
+  mj.maven_jnlp_families.length                        # => 26
+  mj.maven_jnlp_families[0].name                       # => "all-otrunk-snapshot"
+  mj.maven_jnlp_families[0].versions.length            # => 1568
+  mj.maven_jnlp_families[0].versions.first.version     # => "0.1.0-20070420.131610"
+  mj.maven_jnlp_families[0].snapshot_version           # => "0.1.0-20090327.222627"
+
+  mj.maven_jnlp_families[0].versions.last.url
+
+  # => "/dev/org/concord/maven-jnlp/all-otrunk-snapshot/all-otrunk-snapshot-0.1.0-20090327.222627.jnlp"
+ 
+  mj.maven_jnlp_families[0].snapshot.url
+
+  # => "/dev/org/concord/maven-jnlp/all-otrunk-snapshot/all-otrunk-snapshot-0.1.0-20090327.222627.jnlp"
+
+  mj.maven_jnlp_families[0].versions.first.url
+
+  # => "/dev/org/concord/maven-jnlp/all-otrunk-snapshot/all-otrunk-snapshot-0.1.0-20070420.131610.jnlp"
+
+=== Creating MavenJnlp objects that represent some all the resources deployed by a maven jnlp servlet.
+
+You can pass in an options hash to limit the number of maven jnlp families parsed:
+
+Example: passing in an optional array of maven jnlp families
+This will get all versions of each family.
+
+  mj = Jnlp::MavenJnlp.new('http://jnlp.concord.org', '/dev/org/concord/maven-jnlp/', 
+       { :families => ['all-otrunk-snapshot', 'gui-testing'] })
+
+  mj.maven_jnlp_families.length
+  => 2
+
+Example: passing in an optional hash of maven jnlp families
+This will get all versions of each family.
+
+  mj = Jnlp::MavenJnlp.new('http://jnlp.concord.org', '/dev/org/concord/maven-jnlp/', 
+       { :families => { 'all-otrunk-snapshot' => nil, 'gui-testing' => nil } })
+
+  mj.maven_jnlp_families.length
+  => 2
+
+Example: passing in an optional hash of maven jnlp families and specifying
+the versions of the jnlp urls to get for one family.
+
+  mj = Jnlp::MavenJnlp.new('http://jnlp.concord.org', '/dev/org/concord/maven-jnlp/',
+       { :families => { 
+         'all-otrunk-snapshot' => { :versions => ['0.1.0-20100513.161426', '0.1.0-20100513.154925'] },
+         'gui-testing' => nil }
+       })
+  mjfs = mj.maven_jnlp_families
+  [mjfs.length, mjfs[0].versions.length, mjfs[1].versions.length]
+  => [2, 2, 50]
+
+== Building the gem
+
+=== 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
+
+=== Runtime dependencies
+
+  hpricot '= 0.6.164'
+
+=== Development dependencies
+
+  rspec -v'>= 1.3.0'
+  ci_reporter -v'>= 1.6.0'
+
+=== rake tasks
+
+  $ rake -T
+  rake spec         # run spec tests (the default task)
+  rake package      # generate the gem package: jnlp-0.0.5.4.gem
+  rake release      # push the packaged gem: jnlp-0.0.5.4.gem to rubygems.org
+  rake hudson:spec  # run the spec tests and generate JUnit XML reports (for integrating with a Hudson CIS server)
+  rake rdoc         # generate the rdoc documentation in doc/
+  
+=== Running the tests
+
+JRuby:
+
+  jruby -S rake spec
+
+MRI:
+
+  rake spec
+
+Generating JUnit XML for integrating with the Hudson CIS server:
+
+  rake hudson:spec
+
+=== TODO
+
+Add tests for the MavenJnlp features.
+
+=== Packaging and installing

data/Rakefile

@@ -1,19 +1,106 @@
 require 'rubygems'
-require 'hoe'
 
-require './lib/jnlp.rb'
+JRUBY = defined? RUBY_ENGINE && RUBY_ENGINE == 'jruby'
 
-Hoe.spec 'jnlp' do |spec|
-  spec.rubyforge_name = 'rubywebstart' # if different than lowercase project name
-  spec.author = 'Stephen Bannasch'
-  spec.email = 'stephen.bannasch@gmail.com'
-  spec.url = 'http://rubywebstart.rubyforge.org/jnlp/rdoc/'
-  spec.summary = "Ruby tools for working with Java Web Start JNLPs."
-  spec.description = "For manipulation of Java Web Start Jnlps and the resources they reference."
-  spec.extra_deps << ['hpricot','=0.6.164']
+def gem_install_command_strings(missing_gems)
+  command = JRUBY ? "  jruby -S gem install " : "  sudo gem install "
+  command + missing_gems.collect {|g| "#{g[0]} -v '#{g[1]}'"}.join(' ') + "\n"
 end
 
+@development_gems = [['hpricot', '= 0.6.164'], ['rspec', '>= 1.3.0'], ['ci_reporter', '>= 1.6.0']]
+@missing_gems = []
+@development_gems.each do |gem_name_and_version|
+  begin
+    gem gem_name_and_version[0], gem_name_and_version[1]
+  rescue Gem::LoadError
+    @missing_gems << gem_name_and_version
+  end
+end
+
+unless @missing_gems.empty?
+  message = <<-HEREDOC
+
+The following gem(s) need to be installed to run, test and package the jnlp gem.
+
+  #{gem_install_command_strings(@missing_gems.reverse)}
+
+  HEREDOC
+  raise message
+end
+
+require 'spec/rake/spectask'
+
+require File.join(File.expand_path(File.dirname(__FILE__)), 'lib', 'jnlp.rb')
+
 task :default => :spec
+
+desc 'run spec tests (the default task)'
 Spec::Rake::SpecTask.new do |t|
   t.spec_files = FileList["spec/**/*_spec.rb"]
 end
+
+desc "generate the gem package: jnlp-#{Jnlp::VERSION}.gem"
+task :package do
+  system "gem build jnlp.gemspec"
+end
+
+desc "push the packaged gem: jnlp-#{Jnlp::VERSION}.gem to rubygems.org"
+task :release => :package do
+  system "gem push jnlp-#{Jnlp::VERSION}.gem"
+end
+
+namespace :hudson do
+  desc "run the spec tests and generate JUnit XML reports (for integrating with a Hudson CIS server)"
+  task :spec => ["hudson:setup:rspec", 'rake:spec']
+
+  namespace :setup do
+    task :pre_ci do
+      ENV["CI_REPORTS"] = 'spec/reports/'
+      gem 'ci_reporter'
+      require 'ci/reporter/rake/rspec'
+    end
+    task :rspec => [:pre_ci, "ci:setup:rspec"]
+  end
+end
+
+# Documentation tasks
+#
+# You can generate the doc by hand as follows:
+#
+#   rdoc -U --main=README.rdoc --title='Jnlp::Jnlp' README.rdoc History.txt License.txt lib
+#
+#   yardoc -o ydoc - README.rdoc History.txt License.txt
+
+begin
+  # try using the rdoc gem if it is installed
+  require 'rdoc/task'
+  RDoc::Task.new do |rdoc|
+    rdoc.rdoc_dir = 'doc'
+    rdoc.template = "darkfish"
+    rdoc.main = "README.rdoc"
+    rdoc.title = 'Jnlp::Jnlp'
+    rdoc.rdoc_files.include("README.rdoc", 'History.txt', 'License.txt', "lib/**/*.rb")
+    rdoc.options += ['-f', 'darkfish']
+  end
+rescue LoadError
+  # else use Rake's rdoc task (but this won't use the darkfish template)
+  require 'rake/rdoctask'
+  Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = 'doc'
+    rdoc.main = "README.rdoc"
+    rdoc.title = 'Jnlp::Jnlp'
+    rdoc.rdoc_files.include("README.rdoc", 'History.txt', 'License.txt', "lib/**/*.rb")
+  end
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |ydoc|
+    ydoc.files   = ["README.rdoc", 'History.txt', 'License.txt', "lib/**/*.rb"]
+    ydoc.options = ['-o', 'ydoc', '--main', 'README.rdoc']
+  end
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc: sudo gem install yard"
+  end
+end

data/jnlp.gemspec

@@ -0,0 +1,27 @@
+GEM_ROOT = File.expand_path(File.dirname(__FILE__))
+$:.unshift File.join(GEM_ROOT, 'lib')
+require 'jnlp'
+
+Gem::Specification.new do |s|
+  s.name = 'jnlp'
+  s.version = Jnlp::VERSION
+  s.authors = ["Stephen Bannasch"]
+  s.email = 'stephen.bannasch@gmail.com'
+  s.homepage = 'http://rubywebstart.rubyforge.org/jnlp/rdoc'
+  s.summary = %q{Ruby tools for working with Java Web Start JNLPs.}
+  s.description = %q{For manipulation of Java Web Start Jnlps and the resources they reference.}
+  s.date = '2010-02-11'
+  s.rubyforge_project = 'rubywebstart'
+
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.extra_rdoc_files = %w{ History.txt License.txt README.rdoc}
+  
+  s.required_rubygems_version = ">= 1.3.2"
+  s.require_path = 'lib'
+
+  s.files =  Dir.glob("{lib,spec}/**/*.{rb}") + %w{ History.txt License.txt README.rdoc Rakefile jnlp.gemspec }
+
+  s.add_runtime_dependency('hpricot', "= 0.6.164")  
+  s.add_development_dependency("rspec", '>= 1.3.0')
+  s.add_development_dependency("ci_reporter", '>= 1.6.0')
+end

data/lib/jnlp/jnlp.rb

@@ -1,9 +1,3 @@
-# :main: Jnlp::Jnlp
-# :title: Jnlp::Jnlp RDoc
-#
-# to regenerate and display this rdoc: 
-#   rdoc -U -SN jnlp.rb otrunk.rb maven_jnlp.rb; open doc/index.html
-#
 require 'rubygems'
 require 'open-uri'
 require 'hpricot'

data/lib/jnlp/maven_jnlp.rb

@@ -1,9 +1,3 @@
-# :main: Jnlp::Jnlp
-# :title: Jnlp::Jnlp RDoc
-#
-# to regenerate and display this rdoc: 
-#   rdoc -U -SN jnlp.rb otrunk.rb ; open doc/index.html 
-#
 require 'open-uri'
 require 'hpricot'
 
@@ -16,6 +10,17 @@ module Jnlp #:nodoc:
   #
   # Encapsulates a versioned jnlp in a Maven Jnlp Web Start server.
   #
+  #   Jnlp::VersionedJnlpUrl.new(family_name, path, base_url)
+  #
+  # Example:
+  #
+  #   require 'jnlp'
+  #   vju = Jnlp::VersionedJnlpUrl("concord", "/dev/org/concord/maven-jnlp/", "http://jnlp.concord.org")
+  #
+  # Example:
+  #
+  #   vju = Jnlp::VersionedJnlpUrl("concord", "/dev/org/concord/maven-jnlp/", "http://jnlp.concord.org")
+  #
   class VersionedJnlpUrl
     #
     # Contains the the full path to the jnlp
@@ -52,6 +57,25 @@ module Jnlp #:nodoc:
   #
   # Encapsulates a single MavenJnlp Family of versioned jnlps.
   #
+  #   Jnlp::MavenJnlpFamily.new(base_url, family_path)
+  #
+  # Example:
+  #
+  #   require 'jnlp'
+  #   mjf = Jnlp::MavenJnlpFamily.new('http://jnlp.concord.org', '/dev/org/concord/maven-jnlp/all-otrunk-snapshot')
+  #
+  #   mjf = Jnlp::MavenJnlpFamily.new('http://jnlp.concord.org', '/dev/org/concord/maven-jnlp/all-otrunk-snapshot', 
+  #     { :versions => ['0.1.0-20100513.161426', '0.1.0-20100513.154925'] })
+  # You can pass in an options hash to limit the number of versioned jnlps parsed:
+  #
+  # Example
+  #
+  #   mjf = Jnlp::MavenJnlpFamily.new('http://jnlp.concord.org', '/dev/org/concord/maven-jnlp/all-otrunk-snapshot', 
+  #        { :versions => ['0.1.0-20100513.161426', '0.1.0-20100513.154925'] })
+  #
+  #   mjf.versions.length
+  #   => 2
+  #
   class MavenJnlpFamily
     #
     # Contains the base_url for this MavenJnlp server
@@ -103,7 +127,7 @@ module Jnlp #:nodoc:
     #
     # Contains the VersionedJnlpUrl referencing the latest 
     # versioned jnlp. This jnlp is identical to the snapshot 
-    # jnlp at the of processing. 
+    # jnlp at the time of instantiation. 
     #
     attr_reader :snapshot
     #
@@ -111,7 +135,8 @@ module Jnlp #:nodoc:
     #
     #    base_url, family_path
     #
-    def initialize(base_url, family_path)
+    
+    def initialize(base_url, family_path, options={})
       @base_url = base_url
       @path = family_path
       @url = @base_url + @path
@@ -121,16 +146,23 @@ module Jnlp #:nodoc:
       anchor_tags = doc.search("//a")
       snapshot_version_path = anchor_tags.find {|a| a['href'][/CURRENT_VERSION\.txt$/] }['href']
       @snapshot_version = open(base_url + snapshot_version_path).read
-
       jnlp_paths = anchor_tags.find_all { |a| a['href'][/jnlp$/] }.collect { |a| a['href'] }
       jnlp_paths.each do |jnlp_path|
-        
+        version = jnlp_path[/#{name}\/#{name}-(.*)\.jnlp/, 1]
         # skip processing unless this jnlp has a version string
-        unless jnlp_path[/#{name}\.jnlp$/]  
-          versioned_jnlp_url = VersionedJnlpUrl.new(@name, jnlp_path, @base_url) 
-          @versions << versioned_jnlp_url
-          if versioned_jnlp_url.version == @snapshot_version
-            @snapshot = versioned_jnlp_url
+        if version
+          # only continue processing if:
+          #   no options[:version] was passed in OR
+          #   the current version matches one of the desired versions OR
+          #   one of the desired versions is 'snapshot' and this version IS the snapshot version
+          if  options[:versions] == nil || 
+              options[:versions].any? { |v| v == version } ||
+              options[:versions].any? { |v| v == 'snapshot' && version == @snapshot_version } 
+            versioned_jnlp_url = VersionedJnlpUrl.new(@name, jnlp_path, @base_url)
+            @versions << versioned_jnlp_url
+            if versioned_jnlp_url.version == @snapshot_version
+              @snapshot = versioned_jnlp_url
+            end
           end
         end
       end
@@ -179,6 +211,38 @@ module Jnlp #:nodoc:
   #
   #   # => "/dev/org/concord/maven-jnlp/all-otrunk-snapshot/all-otrunk-snapshot-0.1.0-20070420.131610.jnlp"
   #
+  # You can pass in an options hash to limit the number of maven jnlp families parsed:
+  #
+  # Example: passing in an optional array of maven jnlp families
+  # This will get all versions of each family.
+  #
+  #   mj = Jnlp::MavenJnlp.new('http://jnlp.concord.org', '/dev/org/concord/maven-jnlp/', 
+  #        { :families => ['all-otrunk-snapshot', 'gui-testing'] })
+  #
+  #   mj.maven_jnlp_families.length
+  #   => 2
+  #
+  # Example: passing in an optional hash of maven jnlp families
+  # This will get all versions of each family.
+  #
+  #   mj = Jnlp::MavenJnlp.new('http://jnlp.concord.org', '/dev/org/concord/maven-jnlp/', 
+  #        { :families => { 'all-otrunk-snapshot' => nil, 'gui-testing' => nil } })
+  #
+  #   mj.maven_jnlp_families.length
+  #   => 2
+  #
+  # Example: passing in an optional hash of maven jnlp families and specifying
+  # the versions of the jnlp urls to get for one family.
+  #
+  #   mj = Jnlp::MavenJnlp.new('http://jnlp.concord.org', '/dev/org/concord/maven-jnlp/',
+  #        { :families => { 
+  #          'all-otrunk-snapshot' => { :versions => ['0.1.0-20100513.161426', '0.1.0-20100513.154925'] },
+  #          'gui-testing' => nil }
+  #        })
+  #   mjfs = mj.maven_jnlp_families
+  #   [mjfs.length, mjfs[0].versions.length, mjfs[1].versions.length]
+  #   => [2, 2, 50]
+  #
   class MavenJnlp
     #
     # Contains the base_url for this MavenJnlp server
@@ -215,17 +279,34 @@ module Jnlp #:nodoc:
     #
     #    base_url, maven_jnlp_path
     #
-    def initialize(base_url, jnlp_families_path)
+    def initialize(base_url, jnlp_families_path, options={})
       @base_url = base_url
       @jnlp_families_path = jnlp_families_path
       @jnlp_families_url = @base_url + @jnlp_families_path
       @maven_jnlp_families = []
       doc = Hpricot(open(@jnlp_families_url))
       family_paths = doc.search("//a").find_all { |a| 
-        a['href'][/#{@jnlp_families_path}/] }.collect { |a| a['href'] }
-      family_paths.each do |family_path|
-        maven_jnlp_family = MavenJnlpFamily.new(@base_url, family_path) 
-        @maven_jnlp_families << maven_jnlp_family
+        a['href'][/#{@jnlp_families_path}/] 
+      }.collect { |a| a['href'] }
+      if options[:families]
+        case options[:families]
+        when Hash
+          options[:families].each do |family, versions|
+            family_path = family_paths.detect { |fp| family == File.basename(fp) }
+            if family_path
+              maven_jnlp_family = MavenJnlpFamily.new(@base_url, family_path, versions || {}) 
+              @maven_jnlp_families << maven_jnlp_family
+            end
+          end
+        when Array
+          family_paths = family_paths.select { |path| 
+            options[:families].any? { |family| family == File.basename(path) }
+          }
+          family_paths.each do |family_path|
+            maven_jnlp_family = MavenJnlpFamily.new(@base_url, family_path) 
+            @maven_jnlp_families << maven_jnlp_family
+          end
+        end
       end
     end