osgi 0.0.1

data/LICENSE

@@ -0,0 +1,176 @@
+                              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/NOTICE

@@ -0,0 +1,6 @@
+COPYRIGHT NOTICES
+-----------------
+Copyright 2009 Intalio
+
+This product includes software developed by Intalio
+http://www.intalio.com

data/README.rdoc

@@ -0,0 +1,50 @@
+= Buildr4osgi
+
+A plugin for adding OSGi support to Buildr.
+
+See the official Buildr site: http://buildr.apache.org
+
+You just had this OSGi bundle started, and everything runs in your development environment.
+You hit one of those issues:
+* You can't run a reproducible build.
+* Bundles are hard to package.
+* And it looks like you are going to have to find a way to resolve all your plugin dependencies (none of them are in a Maven repository!)
+
+Enter OSGi!
+
+Your bundle uses one of the mechanisms defined by OSGi to define dependencies:
+* Require-Bundle: you require some bundles, optionally with a version range or a version.
+* Import-Package: you import a package exported by other bundles.
+* Fragment-Host: your bundle has fragments, they will be added to the bundle classpath on activation.
+
+Each of those instructions have their own use. There's just no way you are going to resolve all your dependencies manually though.
+
+== Install Buildr4osgi
+
+* See the github instructions on how to setup to install their gems: http://gems.github.com
+* For the impatient:
+  * gem sources -a http://gems.github.com
+  * sudo gem install intalio-buildr4osgi
+
+== Documentation
+
+See http://oss.intalio.com/buildr4osgi
+
+http://intalio.github.com/buildr4osgi is the cutting edge documentation if you work against the trunk.
+
+== License
+
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with this
+work for additional information regarding copyright ownership.  The ASF
+licenses this file to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+License for the specific language governing permissions and limitations under
+the License.

data/Rakefile

@@ -0,0 +1,45 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+
+# We need JAVA_HOME for most things (setup, spec, etc).
+unless ENV['JAVA_HOME']
+  if RUBY_PLATFORM[/java/]
+    ENV['JAVA_HOME'] = java.lang.System.getProperty('java.home')
+  elsif RUBY_PLATFORM[/darwin/]
+    ENV['JAVA_HOME'] = '/System/Library/Frameworks/JavaVM.framework/Home'
+  else
+    fail "Please set JAVA_HOME first (set JAVA_HOME=... or env JAVA_HOME=... rake ...)"
+  end
+end
+
+
+# Load the Gem specification for the current platform (Ruby or JRuby).
+def spec(platform = RUBY_PLATFORM[/java/] || 'ruby')
+  @specs ||= ['ruby', 'java', 'x86-mswin32'].inject({}) { |hash, spec_platform|
+    $platform = spec_platform
+    hash.update(spec_platform=>Gem::Specification.load('buildr4osgi.gemspec'))
+  }
+  @specs[platform]
+end
+
+# Tell us if we need sudo for various commands.
+def sudo_needed?
+  Config::CONFIG['host_os'] !~ /windows|cygwin|bccwin|cygwin|djgpp|mingw|mswin|wince/i && !ENV['GEM_HOME']
+end
+
+
+desc 'Clean up all temporary directories used for running tests, creating documentation, packaging, etc.'
+task :clobber

data/lib/osgi.rb

@@ -0,0 +1,24 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require 'osgi/bundle'
+require 'osgi/bundle_package'
+require 'osgi/container'
+require 'osgi/execution_environment'
+require 'osgi/registry'
+require 'osgi/resolving_strategies'
+require 'osgi/version'
+
+module OSGi ; extend self ; end

data/lib/osgi/bundle.rb

@@ -0,0 +1,201 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+module OSGi #:nodoc:
+
+  # A bundle is an OSGi artifact represented by a jar file or a folder.
+  # It contains a manifest file with specific OSGi headers.
+  #
+  class Bundle
+
+    #Keys used in the MANIFEST.MF file
+    B_NAME = "Bundle-SymbolicName"
+    B_REQUIRE = "Require-Bundle"
+    B_IMPORT_PKG = "Import-Package"
+    B_EXPORT_PKG = "Export-Package"
+    B_FRAGMENT_HOST = "Fragment-Host"
+    B_VERSION = "Bundle-Version"
+    B_DEP_VERSION = "bundle-version"
+    B_RESOLUTION = "resolution"
+    B_LAZY_START = "Bundle-ActivationPolicy"
+    B_OLD_LAZY_START = "Eclipse-LazyStart"
+    
+    # Creates itself by loading from the manifest file passed to it as a hash
+    # Finds the name and version, and populates a list of dependencies.
+    def self.fromManifest(manifest, jarFile) 
+      if manifest.first[B_NAME].nil?
+        warn "Could not find the name of the bundle represented by #{jarFile}"
+        return nil
+      end
+      
+      #see http://aspsp.blogspot.com/2008/01/wheressystembundlejarfilecont.html for the system.bundle trick.
+      #key.strip: sometimes there is a space between the comma and the name of the bundle.
+      #Add the required bundles:
+      bundles = []
+      manifest.first[B_REQUIRE].each_pair {|key, value| bundles << Bundle.new(key.strip, value[B_DEP_VERSION], {:optional => value[B_RESOLUTION] == "optional"}) unless "system.bundle" == key} unless manifest.first[B_REQUIRE].nil?
+      exports = []
+      manifest.first[B_EXPORT_PKG].each_pair {|key, value| exports << BundlePackage.new(key.strip, value["version"])} unless manifest.first[B_EXPORT_PKG].nil?
+      
+      #Parse the version
+      version = manifest.first[B_VERSION].nil? ? nil : manifest.first[B_VERSION].keys.first
+      
+      #Read the imports
+      imports = []
+      manifest.first[B_IMPORT_PKG].each_pair {|key, value| imports << BundlePackage.new(key.strip, value["version"], :is_export => false, :optional => value[B_RESOLUTION] == "optional")} unless manifest.first[B_IMPORT_PKG].nil?
+      
+      #Read the imported packages
+      
+      bundle = Bundle.new(manifest.first[B_NAME].keys.first, version, {:file => jarFile, :bundles => bundles, :imports => imports, :exported_packages => exports})
+      if !manifest.first[B_LAZY_START].nil? 
+        # We look for the value of BundleActivationPolicy: lazy or nothing usually. 
+        # lazy may be spelled Lazy too apparently, so we downcase the string in case.
+        bundle.lazy_start = "lazy" == manifest.first[B_LAZY_START].keys.first.strip.downcase
+      else
+        bundle.lazy_start = "true" == manifest.first[B_OLD_LAZY_START].keys.first.strip unless manifest.first[B_OLD_LAZY_START].nil?
+      end
+      if (bundle.lazy_start)
+        bundle.start_level = 4
+      else
+        bundle.start_level = 1
+      end
+      
+      bundle.fragment = Bundle.new(manifest.first[B_FRAGMENT_HOST].keys.first.strip, 
+        manifest.first[B_FRAGMENT_HOST].values.first[B_DEP_VERSION]) unless (manifest.first[B_FRAGMENT_HOST].nil?)
+      return bundle
+    end
+
+    
+
+    # Attributes of a bundle, derived from its manifest
+    # The name is always the symbolic name
+    # The version is either the exact version of the bundle or the range in which the bundle would be accepted.
+    # The file is the location of the bundle on the disk
+    # The optional tag is present on bundles resolved as dependencies, marked as optional.
+    # The start level is deduced from the bundles.info file. Default is 1.
+    # The lazy start is found in the bundles.info file
+    # group is the artifact group used for Maven. By default it is set to OSGI_GROUP_ID.
+    # fragment is a Bundle object that represents the fragment host of this bundle (which means this bundle is a fragment if this field is not null).
+    # exported_packages is an array of strings representing the packages exported by the bundle.
+    # imports is an array of BundlePackage objects representing the packages imported by the bundle.
+    attr_accessor :name, :version, :bundles, :file, :optional, :start_level, :lazy_start, :group, :fragment, :exported_packages, :imports
+
+    alias :id :name
+
+    def initialize(name, version, args = {:file => nil, :bundles=>[], :imports => [], :optional => false}) #:nodoc:
+      @name = name
+      @version = VersionRange.parse(version) || (version.nil? ? nil : Version.new(version))
+      @bundles = args[:bundles] || []
+      @imports = args[:imports] || []
+      @exported_packages = args[:exported_packages] || []
+      @file = args[:file]
+      @optional = args[:optional]
+      @start_level = 4
+      @type = "jar" #it's always a jar, even if it is a directory: we will jar it for Maven.
+      @group = GroupMatcher.instance.group(name)
+    end
+
+    
+    #
+    # Resolves the matching artifacts.
+    #
+    def resolve_matching_artifacts
+      
+      return OSGi.registry.resolved_containers.collect {|i| 
+        i.find(:name => name, :version => version)
+      }.flatten.compact.collect{|b| b.dup }
+    end
+
+    # Returns true if the bundle is an OSGi fragment.
+    #
+    def fragment?
+      !fragment.nil?
+    end
+
+    def to_s #:nodoc:
+       "#{name}:#{id}"
+    end
+
+    def to_yaml(opts = {}) #:nodoc:
+      to_s.to_yaml(opts)
+    end
+
+    def <=>(other) #:nodoc:
+      if other.is_a?(Bundle)
+       return to_s <=> other.to_s
+      else
+        return to_s <=> other
+      end
+    end
+
+    # Resolve a bundle from itself, by finding the appropriate bundle in the OSGi containers.
+    # Returns self or the project it represents if a project is found to be self.
+    #
+    def resolve(bundles = resolve_matching_artifacts)
+      bundle = case bundles.size
+      when 0 then nil
+      when 1 then bundles.first
+      else
+        BundleResolvingStrategies.send(OSGi.options.bundle_resolving_strategy, bundles)
+      end
+      if bundle.nil?
+        warn "Could not resolve bundle for #{self.to_s}" 
+        return nil
+      end
+      
+      osgi = self.dup
+      osgi.name = bundle.name
+      osgi.version = bundle.version
+      osgi.bundles = bundle.bundles
+      osgi.file = bundle.file
+      osgi.optional = bundle.optional
+      osgi.start_level = bundle.start_level
+      osgi.group = bundle.group
+
+      osgi
+    end
+
+    # Finds the fragments associated with this bundle.
+    #
+    def fragments
+      OSGi.registry.resolved_containers.collect {|i| 
+        i.find_fragments(:host => name).select{|f|
+          if f.fragment.version.is_a? VersionRange
+            f.fragment.version.in_range(version)
+          elsif f.fragment.version.nil?
+            true
+          else
+            f.fragment.version == version 
+          end
+          }
+        }.flatten.compact.collect{|b| b.dup }
+      end
+      
+    # Compares with another bundle and returns true if the name and version match.  
+    def ==(other) #:nodoc:
+      return false unless other.is_a?(Bundle)
+      name == other.name && version == other.version    
+    end
+    
+    alias :eql? ==
+    
+    # Important for maps.
+    # We absolutely want to avoid having to resolve several times the same bundle
+    #
+    def hash
+      return to_s.hash
+    end
+
+  end
+end