buildr4osgi 0.9.0 → 0.9.2

data/lib/buildr4osgi/osgi/packaging.rb

@@ -25,7 +25,74 @@ module OSGi
   module BundlePackaging
     
   end
+  
+  #monkey patch the Unzip task to support unzipping tgz
+  #TODO: find out how to apply the patterns (include/exclude) and move this to buildr eventually
+  class Buildr::Unzip
+    def extract
+      # If no paths specified, then no include/exclude patterns
+      # specified. Nothing will happen unless we include all files.
+      if @paths.empty?
+        @paths[nil] = FromPath.new(self, nil)
+      end
+
+      # Otherwise, empty unzip creates target as a file when touching.
+      mkpath target.to_s
+      zip_file_path = zip_file.to_s
+      if zip_file_path.match /\.[t?]gz$/ or zip_file_path.match /\.tar\.gz$/
+        #un-tar.gz
+        @paths.each do |path, patterns|
+          patterns.include = ['*'] if patterns.include.nil?
+          patterns.exclude = [] if patterns.exclude.nil?
+        end
+        Zlib::GzipReader.open(zip_file_path) { |tar|
+          Archive::Tar::Minitar::Input.open(tar) do |inp|
+          inp.each do |entry|
+            if included?(entry.full_name)
+              trace "Extracting #{entry.full_name}"
+              inp.extract_entry(target.to_s, entry)
+            end
+          end
+        end
+        }
+      else
+        Zip::ZipFile.open(zip_file.to_s) do |zip|
+          entries = zip.collect
+          @paths.each do |path, patterns|
+            patterns.map(entries).each do |dest, entry|
+              next if entry.directory?
+              dest = File.expand_path(dest, target.to_s)
+              trace "Extracting #{dest}"
+              mkpath File.dirname(dest) rescue nil
+              entry.restore_permissions = true
+              entry.extract(dest) { true }
+            end
+          end
+        end
+      end
+      # Let other tasks know we updated the target directory.
+      touch target.to_s
+    end
     
+    #reads the includes/excludes and apply them to the entry_name
+    def included?(entry_name)
+      @paths.each do |path, patterns|
+        return true if path.nil?
+        if entry_name =~ /^#{path}/
+          short = entry_name.sub(path, '')
+          if patterns.include.any? { |pattern| File.fnmatch(pattern, entry_name) } &&
+            !patterns.exclude.any? { |pattern| File.fnmatch(pattern, entry_name) }
+           # trace "tar_entry.full_name " + entry_name + " is included"
+            return true
+          end
+        end
+      end
+     # trace "tar_entry.full_name " + entry_name + " is excluded"
+      return false
+    end
+    
+  end
+
   
   #
   # The task to package a project
@@ -61,7 +128,7 @@ module OSGi
     def is_packaging_osgi_bundle()
       packages.each {|package| return true if package.is_a?(::OSGi::BundlePackaging)}
       return false
-    end
+    end    
     
     def package_as_bundle(file_name)
       task = BundleTask.define_task(file_name).tap do |plugin|
@@ -78,6 +145,12 @@ module OSGi
         p_r.exclude("bin").exclude("bin/**")
         p_r.exclude("target/**").exclude("target")
         
+        
+        properties = ResourcesTask.define_task
+        properties.send :associate_with, project, :main
+        properties.from(File.join(project.base_dir, project.layout[:source, :main, :java])).
+          exclude("**/.*").exclude("**/*.java") if File.exists? File.join(project.base_dir, project.layout[:source, :main, :java])
+        
         manifest_location = File.join(project.base_dir, "META-INF", "MANIFEST.MF")
         manifest = project.manifest
         if File.exists?(manifest_location)
@@ -85,19 +158,18 @@ module OSGi
           manifest = project.manifest.merge(read_m)
         end
         manifest["Bundle-Version"] = project.version # the version of the bundle packaged is ALWAYS the version of the project.
-        manifest["Bundle-SymbolicName"] ||= project.id # if it was resetted to nil, we force the id to be added back.
-        
+        manifest["Bundle-SymbolicName"] ||= project.name.split(":").last # if it was resetted to nil, we force the id to be added back.
         plugin.with :manifest=> manifest, :meta_inf=>meta_inf
-        plugin.with [compile.target, resources.target, p_r.target].compact
+        plugin.with [compile.target, resources.target, p_r.target, properties.target].compact
       end
     end
     
     def package_as_bundle_spec(spec) #:nodoc:
-      spec.merge(:type=>:jar)
+      spec.merge(:type=>:jar, :id => name.split(":").last)
     end
     
     before_define do |project|
-      project.manifest["Bundle-SymbolicName"] = project.id
+      project.manifest["Bundle-SymbolicName"] = project.name.split(":").last
       project.manifest["Bundle-Name"] = project.comment || project.name
       project.manifest["Bundle-Version"] = project.version
     end

data/lib/buildr4osgi/osgi/packaging_sources.rb

@@ -0,0 +1,86 @@
+# 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
+  
+    # generate an Eclipse-SourceBundle manifest from the manifest of a runtime plugin
+    # Assumes that there are no jars inside the runtime plugin.
+    def self.create_source_bundle_manifest(pluginManifest)
+      #remove the properties after the sym-name such as ';singleton=true'
+      bundleSymName = pluginManifest["Bundle-SymbolicName"].split(';').first
+      bundleVersion = pluginManifest["Bundle-Version"]
+      sourcesManifest = ::Buildr::Packaging::Java::Manifest.new(nil)
+      sourcesManifest.main["Bundle-ManifestVersion"] = "2"
+      sourcesManifest.main["Eclipse-SourceBundle"] = "#{bundleSymName};version=\"#{bundleVersion}\";roots:=\".\""
+      sourcesManifest.main["Bundle-SymbolicName"] = bundleSymName + ".sources"
+      sourcesManifest.main["Bundle-Name"] += " sources" if sourcesManifest.main["Bundle-Name"] 
+      sourcesManifest.main["Bundle-Version"] = bundleVersion
+      sourcesManifest.main["Bundle-Vendor"] = pluginManifest["Bundle-Vendor"] unless pluginManifest["Bundle-Vendor"].nil?
+      #TODO: ability to define a different license for the sources.
+      sourcesManifest.main["Bundle-License"] = pluginManifest["Bundle-License"] unless pluginManifest["Bundle-License"].nil?
+      return sourcesManifest
+    end
+
+  
+  #:nodoc:
+  # This module is used to identify the packaging task
+  # that represent a bundle packaging.
+  #
+  module PackagingAsSourcesExtension #:nodoc:
+    include Extension
+
+    # Change the zip classifier for the sources produced by
+    # a jar classifier unless we are packaking a feature right now.
+    def package_as_sources_spec_source_extension(spec) #:nodoc:
+      spec = package_as_sources_spec_before_source_extension(spec)
+      if is_packaging_osgi_bundle
+        spec.merge!(:type=>:jar, :id => name.split(":").last)
+      end 
+      spec
+    end
+
+    # if the current packaging is a plugin or a bundle
+    # then call package_as_eclipse_source_feature
+    # if the current packaging is a feature
+    # then call package_as_eclipse_source_bundle
+    def package_as_osgi_pde_sources(file_name)
+      return package_as_eclipse_source_bundle(file_name) if project.send :is_packaging_osgi_bundle
+      package_as_sources_old(file_name)
+    end
+
+
+    # package as an OSGi bundle that contains the sources
+    # of the bundle. Specialized for eclipse-PDE version 3.4.0 and more recent
+    # http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclipse.pde.doc.user/tasks/pde_individual_source.htm
+    # file_name
+    def package_as_eclipse_source_bundle(file_name)
+      pluginManifest = package(:plugin).manifest
+      sourcesManifest = ::OSGi::create_source_bundle_manifest(pluginManifest)
+      package_as_sources_old(file_name).with :manifest => sourcesManifest
+    end    
+  end
+end
+
+module Buildr #:nodoc:
+  class Project #:nodoc:
+    include OSGi::PackagingAsSourcesExtension
+    
+    protected 
+    alias :package_as_sources_spec_before_source_extension :package_as_sources_spec 
+    alias :package_as_sources_spec :package_as_sources_spec_source_extension
+    alias :package_as_sources_old :package_as_sources
+    alias :package_as_sources :package_as_osgi_pde_sources
+  end
+end

data/lib/buildr4osgi/osgi/project_extension.rb

@@ -76,35 +76,18 @@ module OSGi
         project.projects.each do |subp|
           collect(subp)
           _projects[subp.name] = projects.collect {|p| p.name}.uniq.sort
-          _dependencies[subp.name] = bundles.sort 
+          _dependencies[subp.name] = bundles.collect {|b| b.to_s }.uniq.sort 
         end
         
         collect(project)
-        _dependencies[project.name] = bundles.sort
+        _dependencies[project.name] = bundles.collect {|b| b.to_s }.uniq.sort 
         _projects[project.name] = projects.collect {|p| p.name}.uniq.sort
         
-        def find_root(project)
-          project.parent.nil? ? project : project.parent
-        end
-        
-        base_dir = find_root(project).base_dir
-        written_dependencies = YAML.load(File.read(File.join(base_dir, "dependencies.yml"))) if File.exists? File.join(base_dir, "dependencies.yml")
-        written_dependencies ||= {}
-        written_dependencies.extend SortedHash
-        
-       
-        _projects.keys.each {|p|
-          written_dependencies[p] ||= {}
-          written_dependencies[p].extend SortedHash
-          written_dependencies[p]["dependencies"] ||= []
-          written_dependencies[p]["projects"] ||= []
-          written_dependencies[p]["dependencies"] |= _dependencies[p]
-          written_dependencies[p]["projects"] |= _projects[p]
-          written_dependencies[p]["dependencies"].sort!
-          written_dependencies[p]["projects"].sort!
+        dependencies = ::OSGi::Dependencies.new(project)
+        dependencies.write(_projects.keys) {|hash, p|
+          hash[p]["dependencies"] |= _dependencies[p]
+          hash[p]["projects"] |= _projects[p]
         }
-        
-        Buildr::write File.join(base_dir, "dependencies.yml"), written_dependencies.to_yaml
       end
     end
   end
@@ -213,47 +196,9 @@ module OSGi
     # This method is used recursively, so beware of cyclic dependencies.
     #
     def dependencies(&block)
-      
-      deps = Dependencies.new
-      deps.read(project)
-      return deps.projects + deps.dependencies
-    end
-
-    class OSGi #:nodoc:
-
-      attr_reader :options, :registry
-
-      def initialize(project)
-        if (project.parent)
-          @options = project.parent.osgi.options.dup
-          @registry = project.parent.osgi.registry.dup
-        end
-        @options ||= Options.new
-        @registry ||= ::OSGi::Registry.new
-      end
-
-      # The options for the osgi.options method
-      #   package_resolving_strategy:
-      #     The package resolving strategy, it should be a symbol representing a module function in the OSGi::PackageResolvingStrategies module.
-      #   bundle_resolving_strategy:
-      #     The bundle resolving strategy, it should be a symbol representing a module function in the OSGi::BundleResolvingStrategies module.
-      class Options
-        attr_accessor :package_resolving_strategy, :bundle_resolving_strategy
-
-        def initialize
-          @package_resolving_strategy = :all
-          @bundle_resolving_strategy = :latest
-        end
-
-      end
-    end
-    
-    # Makes a osgi instance available to the project.
-    # The osgi object may be used to access OSGi containers
-    # or set options, currently the resolving strategies.
-    def osgi
-      @osgi ||= OSGi.new(self)
-      @osgi
+      deps = ::OSGi::Dependencies.new(project)
+      deps.read
+      deps.dependencies + deps.projects
     end
     
     # returns an array of the dependencies of the plugin, read from the manifest.
@@ -264,57 +209,6 @@ module OSGi
     
   end
   
-  private
-  
-  #
-  # A class to read dependencies.yml, and get a flat array of projects and dependencies for a project.
-  class Dependencies
-    
-    attr_accessor :dependencies, :projects
-    
-    def read(project)
-      def find_root(project)
-        project.parent.nil? ? project : project.parent
-      end
-      
-      base_dir = find_root(project).base_dir
-      @dependencies = []
-      @projects = []
-      @deps_yml = {}
-      return unless File.exists? File.join(base_dir, "dependencies.yml")
-      @deps_yml =YAML.load(File.read(File.join(base_dir, "dependencies.yml")))
-      return if @deps_yml[project.name].nil? || @deps_yml[project.name]["dependencies"].nil?
-      _read(project.name, false)
-      @dependencies = @dependencies.flatten.compact.uniq
-      return @dependencies, @projects
-    end
-    
-    private
-    
-    def _read(project, add_project = true)
-      @dependencies |= @deps_yml[project]["dependencies"]
-      projects << Buildr::project(project) if add_project
-      @deps_yml[project]["projects"].each {|p| _read(p) unless projects.include?(p)}
-    end
-  end
-  
-  # Copy/pasted from here: http://snippets.dzone.com/posts/show/5811
-  # no author information though.
-  module SortedHash
-    
-    # Replacing the to_yaml function so it'll serialize hashes sorted (by their keys)
-    #
-    # Original function is in /usr/lib/ruby/1.8/yaml/rubytypes.rb
-    def to_yaml( opts = {} )
-      YAML::quick_emit( object_id, opts ) do |out|
-        out.map( taguri, to_yaml_style ) do |map|
-          sort.each do |k, v|   # <-- here's my addition (the 'sort')
-            map.add( k, v )
-          end
-        end
-      end
-    end
-  end
 end
 
 module Buildr #:nodoc:

data/lib/buildr4osgi/osgi/registry.rb

@@ -15,6 +15,28 @@
 
 module OSGi
   
+  OSGI_GROUP_ID = "osgi"
+  
+  class GroupMatcher
+    include Singleton
+    attr_accessor :group_matchers
+    
+    def initialize
+      @group_matchers = []
+      # Default rule for Eclipse artifacts.
+      @group_matchers << Proc.new {|n| "org.eclipse" if n.match(/org\.eclipse\..*/) }
+    end
+    
+    def group(bundle)
+      return group(bundle.id) if bundle.is_a?(Bundle)
+      group_matchers.reverse.each do |group|
+        result = group.call(bundle)
+        return result unless result.nil?
+      end
+      OSGI_GROUP_ID
+      
+    end
+  end
   #
   # A class to hold the registered containers. It is possible to add containers until resolved_containers is called,
   # after which it is not possible to modify the registry anymore.
@@ -53,9 +75,57 @@ module OSGi
     # Containers are resolved only once.
     #
     def resolved_containers
-      @resolved_containers ||= containers.collect { |container| OSGi::Container.new(container) }
+      @resolved_containers ||= containers.collect { |container| Container.new(container) }
       @resolved_containers
     end 
   end
 
+  class OSGi #:nodoc:
+
+    attr_reader :options, :registry
+
+    def initialize(project)
+      if (project.parent)
+        @options = project.parent.osgi.options.dup
+        @registry = project.parent.osgi.registry.dup
+      end
+      @options ||= Options.new
+      @registry ||= ::OSGi::Registry.new
+    end
+
+    # The options for the osgi.options method
+    #   package_resolving_strategy:
+    #     The package resolving strategy, it should be a symbol representing a module function in the OSGi::PackageResolvingStrategies module.
+    #   bundle_resolving_strategy:
+    #     The bundle resolving strategy, it should be a symbol representing a module function in the OSGi::BundleResolvingStrategies module.
+    #   group_matchers:
+    #     A set of Proc objects to match a bundle to a groupId for maven.
+    #     The array is examined with the latest added Procs first.
+    #     The first proc to return a non-nil answer is used, otherwise the OGSGI_GROUP_ID constant is used.
+    class Options
+      attr_accessor :package_resolving_strategy, :bundle_resolving_strategy
+
+      def initialize
+        @package_resolving_strategy = :all
+        @bundle_resolving_strategy = :latest
+      end
+
+    end
+  end
+  
+  module OSGiOptions
+    include Extension
+    
+    # Makes a osgi instance available to the project.
+    # The osgi object may be used to access OSGi containers
+    # or set options, currently the resolving strategies.
+    def osgi
+      @osgi ||= OSGi.new(self)
+      @osgi
+    end
+  end
+end
+
+class Buildr::Project
+  include OSGi::OSGiOptions
 end

data/lib/buildr4osgi/osgi/resolving_strategies.rb

@@ -28,7 +28,7 @@ module OSGi #:nodoc:
     #
     def prompt(package, bundles)
       bundle = nil
-      while (!bundle)
+      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")
@@ -38,6 +38,7 @@ module OSGi #:nodoc:
           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
@@ -83,7 +84,7 @@ module OSGi #:nodoc:
     # 
     def prompt(bundles)
       bundle = nil
-      while (!bundle)
+      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 = gets.chomp
@@ -91,6 +92,7 @@ module OSGi #:nodoc:
           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

data/lib/buildr4osgi/osgi.rb

@@ -15,10 +15,12 @@
 
 require 'buildr4osgi/osgi/version'
 require 'buildr4osgi/osgi/packaging'
+require 'buildr4osgi/osgi/packaging_sources'
 require 'buildr4osgi/osgi/bundle'
 require 'buildr4osgi/osgi/bundle_package'
 require 'buildr4osgi/osgi/container'
 require 'buildr4osgi/osgi/registry'
 require 'buildr4osgi/osgi/resolving_strategies'
+require 'buildr4osgi/osgi/dependencies'
 require 'buildr4osgi/osgi/project_extension'
 require 'buildr4osgi/osgi/library_extension'

data/lib/buildr4osgi.rb

@@ -13,7 +13,6 @@
 # License for the specific language governing permissions and limitations under
 # the License.
 
-require 'buildr4osgi/nature'
 require 'buildr4osgi/osgi'
 require 'buildr4osgi/eclipse'
 require 'buildr4osgi/compile'

data/rakelib/release.rake

@@ -45,6 +45,9 @@ task :release do
 
   # Upload binary and source packages to RubyForge.
   lambda do
+    sh 'rubyforge', 'login'
+    # update rubyforge projects, processors, etc. in local config
+    sh 'rubyforge', 'config'
     files = FileList["_release/#{spec.version}/dist/*.{gem,tgz,zip}"]
     puts "Uploading #{spec.version} to RubyForge ... "
     rubyforge = RubyForge.new.configure

data/rakelib/rspec.rake

@@ -19,10 +19,10 @@ begin
   directory '_reports'
 
   desc "Run all specs"
-  Spec::Rake::SpecTask.new :spec=>'_reports' do |task|
+  Spec::Rake::SpecTask.new :spec=>['_reports', :compile] do |task|
     task.spec_files = FileList['spec/**/*_spec.rb']
     task.spec_files.exclude('spec/groovy/*') if RUBY_PLATFORM[/java/]
-    task.spec_opts = %w{--format specdoc --format failing_examples:failed --format html:_reports/specs.html --loadby mtime --backtrace}    
+    task.spec_opts = %w{--format specdoc --format failing_examples:failed --format html:_reports/specs.html --backtrace}    
     task.spec_opts << '--colour' if $stdout.isatty
   end
   file('_reports/specs.html') { task(:spec).invoke }
@@ -35,7 +35,7 @@ begin
   end
 
   desc 'Run RSpec and generate Spec and coverage reports (slow)'
-  Spec::Rake::SpecTask.new :coverage=>'_reports' do |task|
+  Spec::Rake::SpecTask.new :coverage=>['_reports', :compile] do |task|
     task.spec_files = FileList['spec/**/*_spec.rb']
     task.spec_opts = %W{--format progress --format failing_examples:failed --format html:_reports/specs.html --backtrace}    
     task.spec_opts << '--colour' if $stdout.isatty

data/rakelib/stage.rake

@@ -62,6 +62,13 @@ task :prepare do |task, args|
     puts "[X] We have JRuby, Scala and Groovy"
   end.call
 
+  # Need Prince to generate PDF
+  lambda do
+    puts "Checking that we have prince available ... "
+    sh 'prince --version'
+    puts "[X] We have prince available"
+  end.call
+
   # Need RubyForge to upload new release files.
   lambda do
     puts "[!] Make sure you have admin privileges to make a release on RubyForge"

data/spec/compile/compiler_spec.rb

@@ -13,18 +13,50 @@
 # License for the specific language governing permissions and limitations under
 # the License.
 
-=begin
+
 require File.join(File.dirname(__FILE__), '../spec_helpers')
 
 describe Buildr4OSGi::CompilerSupport::OSGiC do
-  it "should compile a Java project just in the same way javac does" do
-    
+  describe "should compile a Java project just in the same way javac does" do  
+    javac_spec = File.read(File.join(File.dirname(__FILE__), "..", "..", "buildr", "spec", "java", "compiler_spec.rb"))
+    javac_spec = javac_spec.match(Regexp.escape("require File.join(File.dirname(__FILE__), '../spec_helpers')\n")).post_match
+    javac_spec.gsub!("javac", "osgic")
+    javac_spec.gsub!("nowarn", "warn:none")
+    eval(javac_spec)
+  end
+  
+  # Redirect the java error ouput, yielding so you can do something while it is
+  # and returning the content of the error buffer.
+  #
+  def redirect_java_err
+    byteArray = Rjb::import('java.io.ByteArrayOutputStream')
+    printStream = Rjb::import('java.io.PrintStream')
+    err = byteArray.new()
+    Rjb::import('java.lang.System').err = printStream.new(err)
+    yield
+    err.toString
+  end
+  
+  it "should not issue warnings for type casting when warnings are set to warn:none" do
+    write "src/main/java/Main.java", "import java.util.List; public class Main {public List get() {return null;}}"
+    foo = define("foo") {
+      compile.options.source = "1.5"
+      compile.options.target = "1.5"
+    }
+    redirect_java_err { foo.compile.invoke }.should_not match(/WARNING/)
   end
   
-  javac_spec = File.read(File.join(File.dirname(__FILE__), "..", "..", "buildr", "spec", "java", "compiler_spec.rb"))
-  javac_spec = javac_spec.match(Regexp.escape("require File.join(File.dirname(__FILE__), '../spec_helpers')\n")).post_match
-  javac_spec.gsub!("javac", "osgic")
-  #eval(javac_spec)
+  it "should not issue warnings for type casting when warnings are set to warn:none" do
+    write "src/main/java/Main.java", "import java.util.List; public class Main {public List get() {return null;}}"
+    foo = define("foo") {
+      compile.options.source = "1.5"
+      compile.options.target = "1.5"
+      compile.options.warnings = true
+    }
+    redirect_java_err { foo.compile.invoke }.should match(/WARNING/)
+  end
+  
+  
 end
 
-=end
+