buildr-bnd 0.0.1 → 0.0.2

data/README.rdoc

@@ -53,6 +53,33 @@ The extension sets the following bnd parameters;
 * -classpath is set to the compile target directory and any compile time
   dependencies.
 
+== Parameters
+
+=== classpath_element
+
+The user can also specify additional elements that are added to the classpath
+using the 'classpath_element' method. If the parameter to this 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|
+      # This dependency will be added to classpath
+      bnd.classpath_element 'someOtherExistingFile.zip'
+      # All of these dependencies will be invoked and added to classpath 
+      bnd.classpath_element artifact('com.sun.messaging.mq:imq:jar:4.4')
+      bnd.classpath_element project('bar') # Adds all the packages
+      bnd.classpath_element 'org.apache.ant:ant:jar:1.8.0'
+      bnd.classpath_element file('myLocalFile.jar')
+      ...
+    end
+
+    project 'bar' do
+      ...
+    end
+  end
+
 == Examples
 
 === Using bnd to wrap an existing jar
@@ -69,10 +96,10 @@ example wraps the OpenMQ JMS provider as an OSGi bundle.
   define 'com.sun.messaging.mq.imq' do
     project.version = '4.4'
     project.group = 'iris'
-    compile.with 'com.sun.messaging.mq:imq:jar:4.4'
     package(:bundle).tap do |bnd|
       bnd['Import-Package'] = "*;resolution:=optional"
       bnd['Export-Package'] = "com.sun.messaging.*;version=#{version}"
+      bnd.classpath_element 'com.sun.messaging.mq:imq:jar:4.4'
     end
   end
 
@@ -127,27 +154,6 @@ parameter withy a local value.
     end
   end
 
-== Future Work
-
-=== Dependencies
-
-Currently you need to declare all dependencies required by bnd as a compile dependency via
-"compile.with X" even if they are not compile time dependencies but are just included in the
-bundle otherwise these resources may not be uptodate when the bnd tool is invoked. An option
-for improving this situation is something like the following code;
-
-  # Will invoke dependencies before packaging
-  define 'foo' do
-    bnd.dependency artifact('com.sun.messaging.mq:imq:jar:4.4')
-    bnd.dependency project('bar')
-    ...
-    package :bundle
-
-    project 'bar' do
-      ...
-    end
-  end
-
 == Credit
 
 The plugin was heavily inspired by the bnd tasks originally authored by Rhett Sutphin. It began

data/lib/buildr_bnd.rb

@@ -22,7 +22,7 @@ module Buildr
     end
 
     class BundleTask < Rake::FileTask
-      attr_accessor :project
+      attr_reader :project
 
       def [](key)
         @params[key]
@@ -32,9 +32,17 @@ module Buildr
         @params[key] = value
       end
 
+      def classpath_element(dependencies)
+        artifacts = self.class.to_artifacts([dependencies])
+        self.prerequisites << artifacts
+        artifacts.each do |dependency|
+          @classpath << dependency.to_s
+        end
+      end
+
       def to_params
         params = project.manifest.merge(@params).reject { |k, v| v.nil? }
-        params["-classpath"] ||= ([project.compile.target] + project.compile.dependencies).collect(&:to_s).join(", ")
+        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
@@ -45,8 +53,37 @@ module Buildr
         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
+        end
+      end
+
       def initialize(*args) #:nodoc:
         super
         @params = {}

data/spec/buildr/bnd/bundle_package_spec.rb

@@ -1,5 +1,19 @@
 require File.expand_path('../../../spec_helper', __FILE__)
 
+def open_zip_file(file = 'target/foo-2.1.3.jar')
+  jar_filename = @foo._(file)
+  File.should be_exist(jar_filename)
+  Zip::ZipFile.open(jar_filename) do |zip|
+    yield zip
+  end
+end
+
+def open_main_manifest_section(file = 'target/foo-2.1.3.jar')
+  jar_filename = @foo._(file)
+  File.should be_exist(jar_filename)
+  yield Buildr::Packaging::Java::Manifest.from_zip(jar_filename).main
+end
+
 describe "package :bundle" do
   describe "with a valid bundle" do
     before do
@@ -89,20 +103,6 @@ SRC
         attribs['Magic-Food'].should eql('Cheese')
       end
     end
-
-    def open_zip_file(file = 'target/foo-2.1.3.jar')
-      jar_filename = @foo._(file)
-      File.should be_exist(jar_filename)
-      Zip::ZipFile.open(jar_filename) do |zip|
-        yield zip
-      end
-    end
-
-    def open_main_manifest_section(file = 'target/foo-2.1.3.jar')
-      jar_filename = @foo._(file)
-      File.should be_exist(jar_filename)
-      yield Buildr::Packaging::Java::Manifest.from_zip(jar_filename).main
-    end
   end
 
   describe "with an invalid bundle" do
@@ -119,9 +119,59 @@ SRC
       lambda { task('package').invoke }.should raise_error
     end
 
-    it "raise notp produce an invalid jar file" do
+    it "raise not produce an invalid jar file" do
       lambda { task('package').invoke }.should raise_error
       File.should_not be_exist(@foo._("target/foo-2.1.3.jar"))
     end
   end
+
+  describe "using classpath_element to specify dependency" do
+    before do
+      @foo = define "foo" do
+        project.version = "2.1.3"
+        project.group = "mygroup"
+        package(:bundle).tap do |bnd|
+          bnd['Export-Package'] = 'org.apache.tools.zip.*'
+          Buildr::Ant.dependencies.each do |d|
+            bnd.classpath_element d
+          end
+        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
+        project.version = "2.1.3"
+        project.group = "mygroup"
+        compile.with Buildr::Ant.dependencies
+        package(:bundle).tap do |bnd|
+          bnd['Export-Package'] = 'org.apache.tools.zip.*'
+        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
 end

data/spec/buildr/bnd/to_artifacts_spec.rb

@@ -0,0 +1,52 @@
+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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
     - 0
     - 0
-    - 1
-  version: 0.0.1
+    - 2
+  version: 0.0.2
 platform: ruby
 authors: 
   - Peter Donald
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-17 00:00:00 +10:00
+date: 2010-04-18 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -37,6 +37,7 @@ files:
   - 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
@@ -48,7 +49,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
   - --title
-  - buildr-bnd 0.0.1
+  - buildr-bnd 0.0.2
   - --main
   - README.rdoc
 require_paths: