buildr-bnd 0.0.4 → 0.0.5

data/CHANGELOG

@@ -1,3 +1,10 @@
+0.0.5 (September 8, 2010)
+* Added: The bnd parameter "Include-Resource" defaults to project.resources.target if it exists.
+* Added: The bnd.classpath setting was added.
+* Changed: The extension no longer defaults the bnd parameters "Import-Package" and "Export-Package" to *
+* Changed: Stop using absolute paths in requires.
+* Changed: Renamed main.rb to core.rb.
+
 0.0.4 (July 5, 2010)
 * Changed: Separated code into separate files, moved project extension code into a separate module and moved
   the code into a hierarchy matching the module hierarchy.

data/README.rdoc

@@ -48,15 +48,15 @@ repositories.remote << Buildr::Bnd.remote_repository
 
 The extension sets the following bnd parameters;
 
-* Bundle-Version defaults to the project version.
-* Bundle-SymbolicName defaults to the concaternation of the project group
+* <tt>"Bundle-Version"</tt> defaults to the project version.
+* <tt>"Bundle-SymbolicName"</tt> defaults to the concatenation of the project group
   and project id, replacing ':' characters with '.'.
-* Bundle-Name defaults to the project description if present else the project
+* <tt>"Bundle-Name"</tt> defaults to the project description if present else the project
   name
-* Bundle-Description defaults to the project description.
-* Import-Package and Export-Package default to *
-* -classpath is set to the compile target directory and any compile time
+* <tt>"Bundle-Description"</tt> defaults to the project description.
+* <tt>"-classpath"</tt> is set to the compile target directory and any compile time
   dependencies.
+* <tt>"Include-Resource"</tt> defaults to the dir project.resources.target if it exists.
 
 == Parameters
 
@@ -85,8 +85,48 @@ bnd.
     end
   end
 
+=== classpath
+
+The user can specify the complete classpath using the 'classpath' method. The classpath
+should be an array of elements. If the element is a task, artifact, artifact namespace etc.
+then it will be resolved prior to invoking bnd. 
+
+  define 'foo' do
+    ...
+    package(:bundle).tap do |bnd|
+      bnd.classpath [ project.compile.target,
+                      'someOtherExistingFile.zip',
+                      artifact('com.sun.messaging.mq:imq:jar:4.4'),
+                      project('bar'),
+                      'org.apache.ant:ant:jar:1.8.0',
+                      file('myLocalFile.jar') ]
+      ...
+    end
+
+    project 'bar' do
+      ...
+    end
+  end
+
+
 == Examples
 
+=== Including non-class resources in a bundle
+
+Bnd can be used to include non-class resources in a bundle. The following
+example includes all resources in 'src/etc' into the bundle.
+
+  require 'buildr_bnd'
+
+  desc 'Including resources example'
+  define 'myproject' do
+    ...
+    package(:bundle).tap do |bnd|
+      bnd['Include-Resource'] = project._('src/etc') + '/'
+      ...
+    end
+  end
+
 === Using bnd to wrap an existing jar
 
 Bnd can be used to wrap an existing jar as an OSGi bundle. The following
@@ -143,12 +183,16 @@ parameter withy a local value.
     ...
     define 'fe' do
       ...
-      package :bundle
+      package(:bundle).tap do |bnd|
+        ...
+      end
     end
 
     define 'fi' do
       ...
-      package :bundle
+      package(:bundle).tap do |bnd|
+        ...
+      end
     end
 
     define 'fo' do
@@ -159,6 +203,27 @@ parameter withy a local value.
     end
   end
 
+== Future Work
+
+The following is a list of feature requests for future versions of the extension. Feel free to
+jump in and supply a patch if you have gone ahead and implemented the feature.
+
+=== Support Embed-Dependency equivalent
+
+The maven-bundle-plugin supports Embed-Dependency which can include a jar inside the bundle,
+add manifest directives to include it in the export calculations. One "Embed-Dependency"
+directive may turn into something like
+
+  -classpath=com.ibm.mq.jar
+  Include-Resource=com.ibm.mq.jar
+  Bundle-Classpath=.,com.ibm.mq.jar
+  Private-Package=!*
+  -exportcontents: com.ibm.mq.*
+
+For further discussion on this see;
+* http://www.mail-archive.com/users@felix.apache.org/msg06625.html
+* http://www.mail-archive.com/users@felix.apache.org/msg06626.html
+
 == Credit
 
 The plugin was heavily inspired by the bnd tasks originally authored by Rhett Sutphin. It began

data/lib/buildr/bnd/bundle_task.rb

@@ -2,6 +2,7 @@ module Buildr
   module Bnd
     class BundleTask < Rake::FileTask
       attr_reader :project
+      attr_accessor :classpath
 
       def [](key)
         @params[key]
@@ -12,57 +13,46 @@ module Buildr
       end
 
       def classpath_element(dependencies)
-        artifacts = self.class.to_artifacts([dependencies])
+        artifacts = Buildr.artifacts([dependencies])
         self.prerequisites << artifacts
         artifacts.each do |dependency|
-          @classpath << dependency.to_s
+          self.classpath << dependency.to_s
         end
       end
 
       def to_params
-        params = project.manifest.merge(@params).reject { |k, v| v.nil? }
-        params["-classpath"] ||= @classpath.collect(&:to_s).join(", ")
-        params['Bundle-SymbolicName'] ||= [project.group, project.name.gsub(':', '.')].join('.')
-        params['Bundle-Name'] ||= project.comment || project.name
-        params['Bundle-Description'] ||= project.comment
-        params['Bundle-Version'] ||= project.version
-        params['Import-Package'] ||= '*'
-        params['Export-Package'] ||= '*'
-
+        params = self.project.manifest.merge(@params).reject { |k, v| v.nil? }
+        params["-classpath"] ||= self.classpath.collect(&:to_s).join(", ")
+        params['Bundle-SymbolicName'] ||= [self.project.group, self.project.name.gsub(':', '.')].join('.')
+        params['Bundle-Name'] ||= self.project.comment || self.project.name
+        params['Bundle-Description'] ||= self.project.comment
+        params['Bundle-Version'] ||= self.project.version
+        if params["Include-Resource"].nil? && !project.resources.target.nil?
+          params["Include-Resource"] = "#{project.resources.target}/"
+        end
+        
         params
       end
 
       def project=(project)
         @project = project
-        @classpath = [project.compile.target] + project.compile.dependencies
       end
 
-      protected
-
-      # Convert objects to artifacts, where applicable
-      def self.to_artifacts(files)
-        files.flatten.inject([]) do |set, file|
-          case file
-            when ArtifactNamespace
-              set |= file.artifacts
-            when Symbol, Hash
-              set |= [Buildr.artifact(file)]
-            when /([^:]+:){2,4}/ # A spec as opposed to a file name.
-              set |= [Buildr.artifact(file)]
-            when Project
-              set |= Buildr.artifacts(file.packages)
-            when Rake::Task
-              set |= [file]
-            when Struct
-              set |= Buildr.artifacts(file.values)
-            else
-              # non-artifacts passed as-is; in particular, String paths are
-              # unmodified since Rake FileTasks don't use absolute paths
-              set |= [file]
-          end
+      def classpath=(classpath)
+        @classpath = []
+        Buildr.artifacts([classpath.flatten.compact]).each do |dependency|
+          self.prerequisites << dependency
+          @classpath << dependency.to_s
         end
+        @classpath
+      end
+
+      def classpath
+        @classpath ||= ([project.compile.target] + project.compile.dependencies).flatten.compact
       end
 
+      protected
+
       def initialize(*args) #:nodoc:
         super
         @params = {}

data/lib/buildr/bnd/version.rb

@@ -3,7 +3,7 @@ module Buildr
     class Version
       MAJOR = "0"
       MINOR = "0"
-      MICRO = "4"
+      MICRO = "5"
 
       STRING = "#{MAJOR}.#{MINOR}.#{MICRO}" 
     end

data/lib/buildr_bnd.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/buildr/bnd/version')
-require File.expand_path(File.dirname(__FILE__) + '/buildr/bnd/main')
-require File.expand_path(File.dirname(__FILE__) + '/buildr/bnd/bundle_task')
-require File.expand_path(File.dirname(__FILE__) + '/buildr/bnd/project_extension')
+require 'buildr/bnd/version'
+require 'buildr/bnd/core'
+require 'buildr/bnd/bundle_task'
+require 'buildr/bnd/project_extension'

data/spec/buildr/bnd/bundle_package_spec.rb

@@ -20,6 +20,9 @@ describe "package :bundle" do
       write "src/main/java/com/biz/Foo.java", <<SRC
 package com.biz;
 public class Foo {}
+SRC
+      write "src/main/resources/IRIS-INF/iris.config", <<SRC
+some=setting
 SRC
       write "bar/src/main/java/com/biz/bar/Bar.java", <<SRC
 package com.biz.bar;
@@ -30,12 +33,15 @@ SRC
         project.group = "mygroup"
         manifest["Magic-Food"] = "Chocolate"
         manifest["Magic-Drink"] = "Wine"
-        package :bundle
+        package(:bundle).tap do |bnd|
+          bnd["Export-Package"] = "com.*"
+        end
 
         define "bar" do
           project.version = "2.2"
           package(:bundle).tap do |bnd|
             bnd["Magic-Food"] = "Cheese"
+            bnd["Export-Package"] = "com.*"
           end
         end
       end
@@ -56,6 +62,12 @@ SRC
       end
     end
 
+    it "produces a .jar containing resoruces from resource directory root project" do
+      open_zip_file do |zip|
+        zip.file.exist?('IRIS-INF/iris.config').should be_true
+      end
+    end
+
     it "produces a .jar containing expected manifest entries derived from project.bnd for root project" do
       open_main_manifest_section do |attribs|
         attribs['Bundle-Name'].should eql('foo')
@@ -111,7 +123,9 @@ SRC
       @foo = define "foo" do
         project.version = "2.1.3"
         project.group = "mygroup"
-        package :bundle
+        package(:bundle).tap do |bnd|
+          bnd["Export-Package"] = "*"
+        end
       end
     end
 
@@ -151,6 +165,38 @@ SRC
     end
   end
 
+  describe "using classpath to specify dependencies" do
+    before do
+      write "src/main/java/com/biz/Foo.java", <<SRC
+package com.biz;
+public class Foo {}
+SRC
+      write "bar/src/main/java/com/biz/bar/Bar.java", <<SRC
+package com.biz.bar;
+public class Bar {}
+SRC
+      @foo = define "foo" do
+        project.version = "2.1.3"
+        project.group = "mygroup"
+        package(:bundle).tap do |bnd|
+          bnd['Export-Package'] = 'org.apache.tools.zip.*'
+          bnd.classpath = bnd.classpath + Buildr::Ant.dependencies
+        end
+      end
+    end
+
+    it "should not raise an error during packaging" do
+      lambda { task('package').invoke }.should_not raise_error
+    end
+
+    it "should generate package with files exported from dependency" do
+      task('package').invoke
+      open_main_manifest_section do |attribs|
+        attribs['Export-Package'].should eql('org.apache.tools.zip')
+      end
+    end
+  end
+
   describe "using compile dependencies to specify dependency" do
     before do
       @foo = define "foo" do

data/spec/buildr/bnd/defaults_spec.rb

@@ -3,10 +3,20 @@ require File.expand_path('../../../spec_helper', __FILE__)
 describe "project.bnd defaults" do
 
   before do
+    write "src/main/java/com/biz/Foo.java", <<SRC
+package com.biz;
+public class Foo {}
+SRC
+    write "bar/src/main/java/com/biz/bar/Bar.java", <<SRC
+package com.biz.bar;
+public class Bar {}
+SRC
+
     @foo = define "foo" do
       project.version = "2.1.3"
       project.group = "mygroup"
       package :bundle
+      compile.with Buildr::Ant.dependencies
       desc "My Bar Project"
       define "bar" do
         package :bundle
@@ -20,19 +30,33 @@ describe "project.bnd defaults" do
     @bar.packages[0].to_params['Bundle-Version'].should eql('2.1.3')
   end
 
+  it "defaults -classpath to compile path and dependencies" do
+    @foo.packages[0].to_params['-classpath'].should include(@foo.compile.target.to_s)
+    @foo.packages[0].to_params['-classpath'].should include(Buildr.artifacts(Buildr::Ant.dependencies[0]).to_s)
+    @bar.packages[0].to_params['-classpath'].should include(@bar.compile.target.to_s)
+  end
+
+  it "classpath method returns compile path and dependencies" do
+    @foo.packages[0].classpath.should include(@foo.compile.target)
+    Buildr::Ant.dependencies.each do |dependency|
+      @foo.packages[0].classpath.to_s.should include(Buildr.artifacts(dependency).to_s)
+    end
+    @bar.packages[0].classpath.should include(@bar.compile.target)
+  end
+
   it "defaults Bundle-SymbolicName to combination of group and name" do
     @foo.packages[0].to_params['Bundle-SymbolicName'].should eql('mygroup.foo')
     @bar.packages[0].to_params['Bundle-SymbolicName'].should eql('mygroup.foo.bar')
   end
 
-  it "defaults Export-Package to *" do
-    @foo.packages[0].to_params['Export-Package'].should eql('*')
-    @bar.packages[0].to_params['Export-Package'].should eql('*')
+  it "defaults Export-Package to nil" do
+    @foo.packages[0].to_params['Export-Package'].should be_nil
+    @bar.packages[0].to_params['Export-Package'].should be_nil
   end
 
-  it "defaults Import-Package to *" do
-    @foo.packages[0].to_params['Import-Package'].should eql('*')
-    @bar.packages[0].to_params['Import-Package'].should eql('*')
+  it "defaults Import-Package to nil" do
+    @foo.packages[0].to_params['Import-Package'].should be_nil
+    @bar.packages[0].to_params['Import-Package'].should be_nil
   end
 
   it "defaults Bundle-Name to project.name if comment not present" do

data/spec/spec_helper.rb

@@ -1,60 +1,32 @@
 require 'spec'
 
 DEFAULT_BUILDR_DIR=File.expand_path(File.dirname(__FILE__) + '/../../buildr')
-BUILDR_DIR=ENV['BUILDR_DIR'] || DEFAULT_BUILDR_DIR
+BUILDR_DIR =
+  begin
+    if ENV['BUILDR_DIR']
+      ENV['BUILDR_DIR']
+    elsif File.exist?(File.expand_path('../buildr_dir', __FILE__))
+      File.read(File.expand_path('../buildr_dir', __FILE__)).strip
+    else
+      DEFAULT_BUILDR_DIR
+    end
+  end
 
 unless File.exist?("#{BUILDR_DIR}/buildr.gemspec")
-  raise "Unable to find buildr.gemspec in #{BUILDR_DIR == DEFAULT_BUILDR_DIR ? 'guessed' : 'specified'} $BUILD_DIR (#{BUILDR_DIR})"
+  raise "Unable to find buildr.gemspec in #{BUILDR_DIR == DEFAULT_BUILDR_DIR ? 'guessed' : 'specified'} $BUILDR_DIR (#{BUILDR_DIR})"
 end
 
-require 'rubygems'
-
-# For testing we use the gem requirements specified on the buildr.gemspec
-Gem::Specification.load(File.expand_path("#{BUILDR_DIR}/buildr.gemspec", File.dirname(__FILE__))).
-    dependencies.each { |dep| gem dep.name, dep.requirement.to_s }
-
 # hook into buildr's spec_helpers load process
-unless defined?(SpecHelpers)
-  module SandboxHook
-    def SandboxHook.included(spec_helpers)
-      $LOAD_PATH.unshift(File.dirname(__FILE__))
-      $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-      require 'buildr_bnd'
-    end
+module SandboxHook
+  def SandboxHook.included(spec_helpers)
+    $LOAD_PATH.unshift(File.dirname(__FILE__))
+    $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+    require 'buildr_bnd'
   end
+end
 
-  require "#{BUILDR_DIR}/spec/spec_helpers.rb"
-
-  # Download deps into real local dir
-  Buildr::repositories.remote << Buildr::Bnd.remote_repository
-  Buildr::Bnd.requires.each { |spec| artifact(spec).invoke }
-
-  # Adjust specs so that they do not attempt to constantly download helper artifacts
-  module BuildrBndSpecHelpers
-
-    HELPERS_REPOSITORY = "file://#{Buildr::repositories.local}"
-    LOCAL_TEST_REPOSITORY = File.expand_path File.join(File.dirname(__FILE__), "..", "tmp", "test_m2_repository")
-
-    class << self
-
-      def included(config)
-        config.before(:each) do
-          repositories.remote << "file://#{HELPERS_REPOSITORY}"
-        end
-        config.after(:all) do
-          FileUtils.rm_rf LOCAL_TEST_REPOSITORY
-        end
-      end
-    end
-
-    def createRepository(name)
-      repo = File.join(LOCAL_TEST_REPOSITORY, name)
-      mkpath repo
-      return repo
-    end
-  end
+require "#{BUILDR_DIR}/spec/spec_helpers.rb"
 
-  Spec::Runner.configure do |config|
-    config.include BuildrBndSpecHelpers
-  end
-end
+# Download deps into real local dir
+Buildr::repositories.remote << Buildr::Bnd.remote_repository
+Buildr::Bnd.requires.each { |spec| artifact(spec).invoke }

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
     - 0
     - 0
-    - 4
-  version: 0.0.4
+    - 5
+  version: 0.0.5
 platform: ruby
 authors: 
   - Peter Donald
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-05 00:00:00 +10:00
+date: 2010-09-08 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -34,15 +34,14 @@ extra_rdoc_files:
 files: 
   - lib/buildr_bnd.rb
   - lib/buildr/bnd/version.rb
-  - lib/buildr/bnd/main.rb
   - lib/buildr/bnd/bundle_task.rb
   - lib/buildr/bnd/project_extension.rb
+  - lib/buildr/bnd/core.rb
   - spec/spec_helper.rb
   - spec/spec.opts
   - spec/buildr/bnd/project_extension_spec.rb
   - spec/buildr/bnd/bundle_package_spec.rb
   - spec/buildr/bnd/defaults_spec.rb
-  - spec/buildr/bnd/to_artifacts_spec.rb
   - buildr-bnd.gemspec
   - LICENSE
   - README.rdoc
@@ -55,12 +54,13 @@ licenses: []
 post_install_message: 
 rdoc_options: 
   - --title
-  - buildr-bnd 0.0.4
+  - buildr-bnd 0.0.5
   - --main
   - README.rdoc
 require_paths: 
   - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -68,6 +68,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
           - 0
         version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -77,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Buildr extension for packaging OSGi bundles using bnd

data/spec/buildr/bnd/to_artifacts_spec.rb

@@ -1,52 +0,0 @@
-require File.expand_path('../../../spec_helper', __FILE__)
-
-DEPENDENCY_NAME = 'group:id:jar:1.0'
-
-describe "Buildr:Bnd:BundleTask.to_artifacts" do
-  before do
-    @artifact = artifact(DEPENDENCY_NAME) { |t| write t.to_s }
-    @foo = define "foo" do
-      project.version = "1.1"
-      compile.with DEPENDENCY_NAME
-      package :zip
-    end
-
-    @bar = define "bar" do
-      project.version = "1.1"
-      compile.with DEPENDENCY_NAME
-      package :zip
-      package :jar
-    end
-  end
-
-  it "flattens nested arrays" do
-    to_artifacts([["foo"]]).should eql(['foo']) 
-  end
-
-  it "turns projects into tasks to build projects" do
-    artifacts = to_artifacts([@foo])
-    artifacts.length.should eql(1)
-    artifacts[0].should be_a_kind_of(Rake::Task)
-    artifacts[0].to_s.should match(/foo-1\.1\.zip/)
-
-    artifacts = to_artifacts([@bar])
-    artifacts.length.should eql(2)
-    artifacts.each do |artifact|
-      artifact.should be_a_kind_of(Rake::Task)
-      artifact.to_s.should match(/bar-1\.1\.(zip|jar)/)
-    end
-  end
-
-  it "converts hashes into artifacts" do
-    artifacts = to_artifacts([{:group => 'group', :id => 'id', :version => '1.0', :type => 'jar'}])
-    artifacts.length.should eql(1)
-    artifacts[0].should be_a_kind_of(Rake::Task)
-    artifacts[0].to_s.should match(/group\/id\/1.0\/id-1\.0\.jar/)
-  end
-
-  protected
-
-  def to_artifacts(args)
-    Buildr::Bnd::BundleTask.to_artifacts(args)
-  end
-end