buildr-ipojo 0.0.1

data/CHANGELOG

@@ -0,0 +1,2 @@
+0.0.1 (Pending)
+* Initial Release

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.rdoc

@@ -0,0 +1,51 @@
+= iPojo support for buildr
+
+iPojo is an OSGi component model (http://felix.apache.org/site/apache-felix-ipojo.html).
+This extension processes OSGi bundles using iPojo's pojoizer to generate the required
+metadata for the iPojo component model.
+
+The extension will process all packages of type :jar and generate the required metadata
+from annotations and an ipojo metadata file if present. The default location of the
+metadata file is "src/main/config/ipojo.xml" but this can be changed by assigning the
+"ipojo.metadata_filename" setting.
+
+A typical project that uses the extension with the default metadata file location.
+
+  define 'myProject' do
+    ...
+    project.ipojoize!
+    package :jar
+    ...
+  end
+
+An example of a project that specifies the metadata file location.
+
+  define 'myProject' do
+    ...
+    # Note: no longer require project.pojoize!
+    project.ipojo.metadata_filename = _("src/ipojo.xml")
+    package :jar
+    ...
+  end
+
+== Installation
+
+The extension is packaged as a gem named "buildr-ipojo", consult the ruby gems installation
+steps but typically it is either
+
+  sudo gem install buildr-ipojo
+
+for MRI ruby or
+
+  jgem install buildr-ipojo
+
+for jruby.
+
+The user then needs to add the following require into the build file:
+
+  require 'buildr_ipojo'
+
+If the local maven repository does not contain the required ipojo jars they can be downloaded
+but you will need to register the remote repository by adding the following to the build file:
+
+repositories.remote << Buildr::Ipojo.remote_repository

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require File.expand_path("lib/buildr/ipojo/version", File.dirname(__FILE__))
+
+gem_spec = Gem::Specification.load(File.expand_path('buildr-ipojo.gemspec', File.dirname(__FILE__)))
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+task :package => [:spec]
+
+desc "Generate RDoc documentation in rdoc/"
+Rake::RDocTask.new :rdoc do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = gem_spec.name
+  rdoc.options = gem_spec.rdoc_options.clone
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include gem_spec.extra_rdoc_files
+end
+
+Rake::GemPackageTask.new(gem_spec).define
+
+namespace :deploy do
+  task :tag do
+    system("git tag -a #{Buildr::Ipojo::Version::STRING} -m 'Released #{Buildr::Ipojo::Version::STRING}'")
+    puts "Tagged locally.  `git push --tags` if you're sure."
+  end
+end

data/buildr-ipojo.gemspec

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/lib/buildr/ipojo/version')
+
+Gem::Specification.new do |spec|
+  spec.name           = 'buildr-ipojo'
+  spec.version        = Buildr::Ipojo::Version::STRING
+  spec.authors        = ['Peter Donald']
+  spec.email          = ["peter@realityforge.org"]
+  spec.homepage       = "http://github.com/realityforge/buildr-ipojo"
+  spec.summary        = "Buildr tasks to process OSGi bundles using IPojo"
+  spec.description    = <<-TEXT
+This is a buildr extension that processes OSGi bundles using the
+iPojo "pojoization" tool that generates appropriate metadata from
+annotations and a config file.
+  TEXT
+
+  spec.files          = Dir['{lib,spec}/**/*', '*.gemspec'] +
+                        ['LICENSE', 'README.rdoc', 'CHANGELOG', 'Rakefile']
+  spec.require_paths  = ['lib']
+
+  spec.has_rdoc         = true
+  spec.extra_rdoc_files = 'README.rdoc', 'LICENSE', 'CHANGELOG'
+  spec.rdoc_options     = '--title', "#{spec.name} #{spec.version}", '--main', 'README.rdoc'
+
+  spec.post_install_message = "Thanks for installing the iPojo extension for Buildr"
+end

data/lib/buildr/ipojo/config.rb

@@ -0,0 +1,20 @@
+module Buildr
+  module Ipojo
+    class Config
+      attr_writer :metadata_filename
+
+      attr_reader :project
+
+      def initialize(project)
+        @project= project
+      end
+
+      def metadata_filename
+        return @metadata_filename unless @metadata_filename.nil?
+        filename = project._(:src, :main, :config, "ipojo.xml")
+        File.exist?(filename) ? filename : nil
+      end
+
+    end
+  end
+end

data/lib/buildr/ipojo/core.rb

@@ -0,0 +1,48 @@
+module Buildr
+  module Ipojo
+    class << self
+
+      def ipojo_version
+        @ipojo_version ||= '1.6.2'
+      end
+
+      def ipojo_version=(ipojo_version)
+        @ipojo_version = ipojo_version
+      end
+
+      def annotation_artifact
+        "org.apache.felix:org.apache.felix.ipojo.annotations:jar:#{self.ipojo_version}"
+      end
+
+      # The specs for requirements
+      def requires
+        [
+          self.annotation_artifact,
+          "org.apache.felix:org.apache.felix.ipojo.metadata:jar:1.4.0",
+          "org.apache.felix:org.apache.felix.ipojo.manipulator:jar:#{self.ipojo_version}",
+          'asm:asm-all:jar:3.0'
+        ]
+      end
+
+      # Repositories containing the requirements
+      def remote_repository
+        'https://repository.apache.org/content/repositories/releases'
+      end
+
+      def pojoize(project, input_filename, output_filename, metadata_filename)
+        trace("Enhancing #{input_filename} with ipojo metadata")
+        cp = Buildr.artifacts(self.requires).each(&:invoke).map(&:to_s)
+        cp += [File.expand_path(File.dirname(__FILE__) + '/ipojo_cli.jar')]
+        args =
+          [
+            input_filename,
+            output_filename,
+            metadata_filename,
+            Buildr.application.options.trace ? "true" : "false",
+            {:classpath => cp}
+          ]
+        Java::Commands.java 'buildr.ipojo.cli.Main', *(args)
+      end
+    end
+  end
+end

data/lib/buildr/ipojo/project_extension.rb

@@ -0,0 +1,53 @@
+module Buildr
+  module Ipojo
+    module ProjectExtension
+      include Extension
+
+      def ipojo?
+        !@ipojo.nil?
+      end
+
+      def ipojo
+        @ipojo ||= Buildr::Ipojo::Config.new(self)
+      end
+
+      def ipojoize!
+        self.ipojo
+      end
+
+      after_define do |project|
+        if project.ipojo?
+          project.packages.each do |pkg|
+            if pkg.respond_to?(:to_hash) && pkg.to_hash[:type] == :jar
+              pkg.enhance do
+                pkg.enhance do
+                  begin
+                    tmp_filename = pkg.to_s + ".out"
+                    metadata_filename = project.ipojo.metadata_filename
+                    if metadata_filename.nil?
+                      metadata_filename = project._(:target, :generated, :config, "ipojo.xml")
+                      mkdir_p File.dirname(metadata_filename)
+                      File.open(metadata_filename, "w") do |f|
+                        f << "<ipojo></ipojo>"
+                      end
+                    end
+                    info("Processing #{File.basename(pkg.to_s)} through iPojo pre-processor")
+                    Buildr::Ipojo.pojoize(project, pkg.to_s, tmp_filename, metadata_filename)
+                    FileUtils.mv tmp_filename, pkg.to_s
+                  rescue => e
+                    FileUtils.rm_rf pkg.to_s
+                    raise e
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+class Buildr::Project
+  include Buildr::Ipojo::ProjectExtension
+end

data/lib/buildr/ipojo/version.rb

@@ -0,0 +1,11 @@
+module Buildr
+  module Ipojo
+    class Version
+      MAJOR = "0"
+      MINOR = "0"
+      MICRO = "1"
+
+      STRING = "#{MAJOR}.#{MINOR}.#{MICRO}"
+    end
+  end
+end

data/lib/buildr_ipojo.rb

@@ -0,0 +1,5 @@
+require 'buildr'
+require 'buildr/ipojo/version'
+require 'buildr/ipojo/config'
+require 'buildr/ipojo/core'
+require 'buildr/ipojo/project_extension'

data/spec/buildr/ipojo/ipojo_spec.rb

@@ -0,0 +1,104 @@
+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
+
+def init_project(project)
+  project.version = "2.1.3"
+  project.group = "mygroup"
+  compile.with Buildr::Ipojo.annotation_artifact
+end
+
+describe "ipojo" do
+  before do
+    write "src/main/java/com/biz/Foo.java", <<SRC
+package com.biz;
+@org.apache.felix.ipojo.annotations.Component
+public class Foo {}
+SRC
+  end
+
+  describe "with no metadata file and pojoized!" do
+    before do
+      @foo = define "foo" do
+        init_project(project)
+        project.ipojoize!
+        package :jar
+      end
+      task('package').invoke
+    end
+
+    it "produces a .jar in the correct location" do
+      File.should be_exist(@foo._("target/foo-2.1.3.jar"))
+    end
+
+    it "produces a .jar containing expected manifest ipojo entries" do
+      open_main_manifest_section do |attribs|
+        attribs['iPOJO-Components'].should match(/\$name="com\.biz\.Foo"/)
+        attribs['iPOJO-Components'].should_not match(/instance \{ \$component="com\.biz\.Foo" \}/)
+      end
+    end
+  end
+
+  describe "with default metadata file and pojoized!" do
+    before do
+    write "src/main/config/ipojo.xml", <<SRC
+<ipojo><instance component="com.biz.Foo"/></ipojo>
+SRC
+      @foo = define "foo" do
+        init_project(project)
+        project.ipojoize!
+        package :jar
+      end
+      task('package').invoke
+    end
+
+    it "produces a .jar in the correct location" do
+      File.should be_exist(@foo._("target/foo-2.1.3.jar"))
+    end
+
+    it "produces a .jar containing expected manifest ipojo entries" do
+      open_main_manifest_section do |attribs|
+        attribs['iPOJO-Components'].should match(/\$name="com\.biz\.Foo"/)
+        attribs['iPOJO-Components'].should match(/instance \{ \$component="com\.biz\.Foo" \}/)
+      end
+    end
+  end
+
+  describe "with non-default metadata file and pojoized!" do
+    before do
+    write "src/main/config/non-default-ipojo.xml", <<SRC
+<ipojo><instance component="com.biz.Foo"/></ipojo>
+SRC
+      @foo = define "foo" do
+        init_project(project)
+        project.ipojoize!
+        project.ipojo.metadata_filename = project._("src/main/config/non-default-ipojo.xml")
+        package :jar
+      end
+      task('package').invoke
+    end
+
+    it "produces a .jar in the correct location" do
+      File.should be_exist(@foo._("target/foo-2.1.3.jar"))
+    end
+
+    it "produces a .jar containing expected manifest ipojo entries" do
+      open_main_manifest_section do |attribs|
+        attribs['iPOJO-Components'].should match(/\$name="com\.biz\.Foo"/)
+        attribs['iPOJO-Components'].should match(/instance \{ \$component="com\.biz\.Foo" \}/)
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'spec'
+
+DEFAULT_BUILDR_DIR=File.expand_path(File.dirname(__FILE__) + '/../../buildr')
+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'} $BUILDR_DIR (#{BUILDR_DIR})"
+end
+
+# hook into buildr's spec_helpers load process
+module SandboxHook
+  def SandboxHook.included(spec_helpers)
+    $LOAD_PATH.unshift(File.dirname(__FILE__))
+    $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+    require 'buildr_ipojo'
+  end
+end
+
+require "#{BUILDR_DIR}/spec/spec_helpers.rb"
+
+# Download deps into real local dir
+Buildr::repositories.remote << Buildr::Ipojo.remote_repository
+Buildr::Ipojo.requires.each { |spec| artifact(spec).invoke }

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: buildr-ipojo
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+    - 0
+    - 0
+    - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+  - Peter Donald
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-22 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: |
+  This is a buildr extension that processes OSGi bundles using the
+  iPojo "pojoization" tool that generates appropriate metadata from
+  annotations and a config file.
+
+email: 
+  - peter@realityforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+  - README.rdoc
+  - LICENSE
+  - CHANGELOG
+files: 
+  - lib/buildr_ipojo.rb
+  - lib/buildr/ipojo/version.rb
+  - lib/buildr/ipojo/config.rb
+  - lib/buildr/ipojo/project_extension.rb
+  - lib/buildr/ipojo/ipojo_cli.jar
+  - lib/buildr/ipojo/core.rb
+  - spec/spec_helper.rb
+  - spec/spec.opts
+  - spec/buildr/ipojo/ipojo_spec.rb
+  - buildr-ipojo.gemspec
+  - LICENSE
+  - README.rdoc
+  - CHANGELOG
+  - Rakefile
+has_rdoc: true
+homepage: http://github.com/realityforge/buildr-ipojo
+licenses: []
+
+post_install_message: Thanks for installing the iPojo extension for Buildr
+rdoc_options: 
+  - --title
+  - buildr-ipojo 0.0.1
+  - --main
+  - README.rdoc
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Buildr tasks to process OSGi bundles using IPojo
+test_files: []
+