osgi 0.0.1

data/lib/osgi/resolving_strategies.rb

@@ -0,0 +1,107 @@
+# 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:
+  
+  # Functions declared on this module are used to select bundles exporting a particular package.
+  # Functions must have the signature (package, bundles)
+  #   where 
+  #     package: the name of the package
+  #     bundles: an array of bundles
+  #
+  module PackageResolvingStrategies
+  
+    # Default module function that prompts the user to select the bundle(s)
+    # he'd like to select as dependencies.
+    #
+    def prompt(package, bundles)
+      bundle = nil
+      while (bundle.nil?)
+        puts "This package #{package} is exported by all the bundles present.\n" +
+              "Choose a bundle amongst those presented or press A to select them all:\n" + bundles.sort! {|a, b| a.version <=> b.version }.
+        collect {|b| "\t#{bundles.index(b) +1}. #{b.name} #{b.version}"}.join("\n")
+        number = $stdin.gets.chomp
+        begin
+          return bundles if (number == 'A')
+          number = number.to_i
+          number -= 1
+          bundle = bundles[number] if number >= 0 # no negative indexing here.
+          puts "Invalid index" if number < 0
+        rescue Exception => e
+          puts "Invalid index"
+          #do nothing
+        end
+      end
+      [bundle]
+    end
+    
+    # Default module function that selects all the matching bundles to the dependencies.
+    # This is the default function.
+    #
+    def all(package, bundles)
+      warn "*** SPLIT PACKAGE: #{package} is exported by <#{bundles.join(", ")}>"
+      return bundles
+    end  
+    
+    module_function :prompt, :all
+  end
+  
+  # Functions declared on this module are used to select bundles amongst a list of them, 
+  # when requiring bundles through the Require-Bundle header.
+  # Functions must have the signature (bundles)
+  #   where 
+  #     bundles: an array of bundles
+  #
+  module BundleResolvingStrategies
+    #
+    # Default strategy:
+    # the bundle with the highest version number is returned.
+    #
+    def latest(bundles)
+      bundles.sort {|a, b| a.version <=> b.version}.last
+    end
+
+    #
+    # The bundle with the lowest version number is returned.
+    #
+    def oldest(bundles)
+      bundles.sort {|a, b| a.version <=> b.version}.first
+    end
+
+    # Default module function that prompts the user to select the bundle
+    # he'd like to select as dependencies.
+    # 
+    def prompt(bundles)
+      bundle = nil
+      while (bundle.nil?)
+        puts "Choose a bundle amongst those presented:\n" + bundles.sort! {|a, b| a.version <=> b.version }.
+        collect {|b| "\t#{bundles.index(b) +1}. #{b.name} #{b.version}"}.join("\n")
+        number = $stdin.gets.chomp
+        begin
+          number = number.to_i
+          number -= 1
+          bundle = bundles[number] if number >= 0 # no negative indexing here.
+          puts "Invalid index" if number < 0
+        rescue Exception => e
+          puts "Invalid index"
+          #do nothing
+        end
+      end
+      bundle
+    end
+
+    module_function :latest, :oldest, :prompt
+  end
+end

data/lib/osgi/version.rb

@@ -0,0 +1,131 @@
+# 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 class to represent OSGi versions.
+  #
+  class Version
+
+    attr_accessor :major, :minor, :tiny, :qualifier
+
+    def initialize(string) #:nodoc:
+      digits = string.gsub(/\"/, '').split(".")
+      @major = digits[0]
+      @minor = digits[1]
+      @tiny = digits[2]
+      @qualifier = digits[3]
+      raise "Invalid version: " + self.to_s if @major == ""
+      raise "Invalid version: " + self.to_s if @minor == "" && (!@tiny != "" || !@qualifier != "")
+      raise "Invalid version: " + self.to_s if @tiny == "" && !@qualifier != ""
+    end
+
+
+    def to_s #:nodoc:
+      str = [major]
+      str << minor if minor
+      str << tiny if minor && tiny
+      str << qualifier if minor && tiny && qualifier
+      str.compact.join(".")
+    end
+
+    def <=>(other) #:nodoc:
+      if other.is_a? String
+        other = Version.new(other)
+      elsif other.nil?
+        return 1
+      end
+
+      [:major, :minor, :tiny, :qualifier].each do |digit|
+        return 0 if send(digit).nil? or other.send(digit).nil?
+
+        comparison = send(digit) <=> other.send(digit)
+        if comparison != 0
+          return comparison
+        end
+
+      end
+      return 0
+    end
+
+    def <(other) #:nodoc:
+      (self.<=>(other)) == -1
+    end
+
+    def >(other) #:nodoc:
+      (self.<=>(other)) == 1
+    end
+
+    def ==(other) #:nodoc:
+      (self.<=>(other)) == 0
+    end
+
+    def <=(other) #:nodoc:
+      (self.==(other)) || (self.<(other))
+    end
+
+    def >=(other) #:nodoc:
+      (self.==(other)) || (self.>(other))
+    end
+  end
+
+  class VersionRange #:nodoc:
+
+    attr_accessor :min, :max, :min_inclusive, :max_inclusive, :max_infinite
+
+    # Parses a string into a VersionRange.
+    # Returns false if the string could not be parsed.
+    #
+    def self.parse(string, max_infinite = false)
+      return string if string.is_a?(VersionRange) || string.is_a?(Version)
+      if !string.nil? && (match = string.match /\s*([\[|\(])([0-9|A-z|\.]*)\s*,\s*([0-9|A-z|\.]*)([\]|\)])/)
+        range = VersionRange.new
+        range.min = Version.new(match[2])
+        range.max = Version.new(match[3])
+        range.min_inclusive = match[1] == '['
+        range.max_inclusive = match[4] == ']'
+        range
+      elsif (!string.nil? && max_infinite  && string.match(/[0-9|\.]*/))
+        range = VersionRange.new
+        range.min = Version.new(string)
+        range.max = nil
+        range.min_inclusive = true
+        range.max_infinite = true
+        range
+      else
+        false
+      end
+    end
+
+    def to_s #:nodoc:
+      "#{ min_inclusive ? '[' : '('}#{min},#{max_infinite ? "infinite" : max}#{max_inclusive ? ']' : ')'}"
+    end
+
+    # Returns true if the version is in the range of this VersionRange object.
+    # Uses OSGi versioning rules to determine if the version is in range.
+    #
+    def in_range(version)
+      return in_range(version.min) && (version.max_infinite ? true : in_range(version.max)) if version.is_a?(VersionRange)
+        
+      result = min_inclusive ? min <= version : min < version
+      if (!max_infinite)
+        result &= max_inclusive ? max >= version : max > version
+      end
+      result
+    end
+  end
+  
+end

data/osgi.gemspec

@@ -0,0 +1,36 @@
+# 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.
+
+
+Gem::Specification.new do |spec|
+  spec.name           = 'osgi'
+  spec.version        = '0.0.1'
+  spec.author         = 'Antoine Toulme'
+  spec.email          = "antoine@lunar-ocean.com"
+  spec.homepage       = "http://github.com/atoulme/osgi"
+  spec.summary        = "An implementation of the OSGi framework in Ruby"
+  spec.description    = <<-TEXT
+The OSGi framework offers an unique way for Java bundles to communicate and depend on each other.
+This implementation of the OSGi framework is supposed to represent the framework as it should be in Ruby.
+TEXT
+  spec.files          = Dir['{doc,etc,lib,rakelib,spec}/**/*', '*.{gemspec,buildfile}'] +
+                        ['LICENSE', 'NOTICE', 'README.rdoc', 'Rakefile']
+  spec.require_paths  = ['lib']
+  spec.has_rdoc         = true
+  spec.extra_rdoc_files = 'README.rdoc', 'LICENSE', 'NOTICE'
+  spec.rdoc_options     = '--title', 'OSGi', '--main', 'README.rdoc',
+                          '--webcvs', 'http://github.com/atoulme/osgi'
+  spec.add_dependency("manifest", "= 0.0.8")
+end

data/spec/osgi/bundle_package_spec.rb

@@ -0,0 +1,44 @@
+# 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 File.join(File.dirname(__FILE__), '../spec_helpers')
+
+describe OSGi::BundlePackage do
+  
+  it 'should have a nice string representation' do
+    package = OSGi::BundlePackage.new("my.package", "1.0.0")
+    package2 = OSGi::BundlePackage.new("my.package", "[1.0.0,2.0.0]")
+    package.to_s.should == "Package my.package; version [1.0.0,infinite)"
+    package2.to_s.should == "Package my.package; version [1.0.0,2.0.0]"
+  end
+  
+  it 'should be able to know if it equals another bundle package' do
+    package = OSGi::BundlePackage.new("my.package", "1.0.0")
+    package2 = OSGi::BundlePackage.new("my.package", "1.0.0")
+    package.should == package2
+  end
+  
+  it 'should be able to know if it equals another bundle package with version range' do
+    package = OSGi::BundlePackage.new("javax.servlet", "[2.4.0,3.0.0)")
+    package2 = OSGi::BundlePackage.new("javax.servlet", "[2.4.0,3.0.0)")
+    package.should == package2
+  end
+  
+  it 'should define the same hash when bundles are equal' do
+    package = OSGi::BundlePackage.new("my.package", "1.0.0")
+    package2 = OSGi::BundlePackage.new("my.package", "1.0.0")
+    package.hash.should == package2.hash
+  end
+end

data/spec/osgi/bundle_spec.rb

@@ -0,0 +1,94 @@
+# 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 File.join(File.dirname(__FILE__), '..', 'spec_helpers')
+
+describe OSGi::Bundle do
+  before :all do
+    manifest = <<-MANIFEST
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-SymbolicName: org.eclipse.core.resources; singleton:=true
+Bundle-Version: 3.5.1.R_20090912
+Bundle-ActivationPolicy: Lazy
+MANIFEST
+    @bundle = OSGi::Bundle.fromManifest(Manifest.read(manifest), ".")
+    manifest2 = <<-MANIFEST
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-SymbolicName: org.eclipse.core.resources.x86; singleton:=true
+Bundle-Version: 3.5.1.R_20090912
+Bundle-ActivationPolicy: Lazy
+Fragment-Host: org.eclipse.core.resources
+MANIFEST
+    @fragment = OSGi::Bundle.fromManifest(Manifest.read(manifest2), ".")
+  end
+  
+  it 'should read from a manifest' do
+    @bundle.name.should eql("org.eclipse.core.resources")
+    @bundle.version.to_s.should eql("3.5.1.R_20090912")
+    @bundle.lazy_start.should be_true
+    @bundle.start_level.should eql(4)
+  end
+  
+  it 'should recognize itself as a fragment' do
+    @fragment.fragment?.should be_true
+  end
+  
+  it 'should return nil if no name is given in the manifest' do
+    manifest = <<-MANIFEST
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-Version: 3.5.1.R_20090912
+Bundle-ActivationPolicy: Lazy
+MANIFEST
+    OSGi::Bundle.fromManifest(Manifest.read(manifest), ".").should be_nil
+  end
+  
+end
+
+describe "fragments" do
+  before :all do
+    manifest = <<-MANIFEST
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-SymbolicName: org.eclipse.core.resources; singleton:=true
+Bundle-Version: 3.5.1.R_20090912
+Bundle-ActivationPolicy: Lazy
+MANIFEST
+    manifest2 = <<-MANIFEST
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-SymbolicName: org.eclipse.core.resources.x86; singleton:=true
+Bundle-Version: 3.5.1.R_20090912
+Bundle-ActivationPolicy: Lazy
+Fragment-Host: org.eclipse.core.resources
+MANIFEST
+    @eclipse_instances = [createRepository("eclipse1")]
+    write File.join(@eclipse_instances.first, "plugins", "org.eclipse.core.resources-3.5.1.R_20090512", "META-INF", "MANIFEST.MF"), manifest
+    write File.join(@eclipse_instances.first, "plugins", "org.eclipse.core.resources.x86-3.5.1.R_20090512", "META-INF", "MANIFEST.MF"), manifest2
+    @bundle = OSGi::Bundle.fromManifest(Manifest.read(manifest), ".")
+    @fragment = OSGi::Bundle.fromManifest(Manifest.read(manifest2), ".")
+  end
+    
+  
+  it "should find the bundle fragments" do
+    OSGi.registry.containers = @eclipse_instances.dup
+    
+    @bundle.fragments.should == [@fragment]
+  end
+  
+end
+

data/spec/osgi/container_spec.rb

@@ -0,0 +1,89 @@
+# 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 File.join(File.dirname(__FILE__), '../spec_helpers')
+
+describe OSGi::Container do
+
+  before :all do
+    e1= createRepository("eclipse1")
+    e2= createRepository("eclipse2")
+    @eclipse_instances = [e1, e2]
+    
+    write e1 + "/plugins/com.ibm.icu-3.9.9.R_20081204/META-INF/MANIFEST.MF", <<-MANIFEST
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-SymbolicName: com.ibm.icu; singleton:=true
+Bundle-Version: 3.9.9.R_20081204
+MANIFEST
+    write e1 + "/plugins/org.eclipse.core.resources-3.5.0.R_20090512/META-INF/MANIFEST.MF", <<-MANIFEST
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-SymbolicName: org.eclipse.core.resources; singleton:=true
+Bundle-Version: 3.5.0.R_20090512
+MANIFEST
+    write e1 + "/plugins/org.fragments-3.5.0.R_20090512/META-INF/MANIFEST.MF", <<-MANIFEST
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-SymbolicName: org.fragment; singleton:=true
+Fragment-Host: org.eclipse.core.resources
+Bundle-Version: 3.5.0.R_20090512
+MANIFEST
+    write e2 + "/plugins/org.eclipse.core.resources-3.5.1.R_20090912/META-INF/MANIFEST.MF", <<-MANIFEST
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-SymbolicName: org.eclipse.core.resources; singleton:=true
+Bundle-Version: 3.5.1.R_20090912
+MANIFEST
+    write e2 + "/plugins/org.eclipse.ui-3.4.2.R_20090226/META-INF/MANIFEST.MF", <<-MANIFEST
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-SymbolicName: org.eclipse.ui; singleton:=true
+Bundle-Version: 3.4.2.R_20090226
+MANIFEST
+  
+    write e2 + "/plugins/org.eclipse.ui-3.5.0.M_20090107/META-INF/MANIFEST.MF", <<-MANIFEST
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-SymbolicName: org.eclipse.ui; singleton:=true
+Bundle-Version: 3.5.0.M_20090107
+MANIFEST
+  end
+  
+  it 'should be able to create an OSGi container instance on a folder'  do
+    lambda {OSGi::Container.new(@eclipse_instances.first)}.should_not raise_error
+  end
+  
+  it 'should be able to list the bundles present in the container' do
+    e1 = OSGi::Container.new(@eclipse_instances.first)
+    bundles = e1.bundles.select {|bundle| bundle.name == "com.ibm.icu"}
+    bundles.size.should eql(1)
+  end
+  
+  it 'should be able to list the fragments present in the container' do
+    e1 = OSGi::Container.new(@eclipse_instances.first)
+    e1.fragments.size.should eql(1)
+  end
+  
+  it 'should find a specific bundle in the container' do
+    e2 = OSGi::Container.new(@eclipse_instances.last)
+    e2.find(:name=> "org.eclipse.ui", :version => "3.5.0.M_20090107").should_not be_empty
+  end
+  
+  it 'should find a specific fragment in the container' do
+    e1 = OSGi::Container.new(@eclipse_instances.first)
+    e1.find_fragments(:name=> "org.fragment").should_not be_empty
+  end
+end