jenkins-plugin-runtime 0.1.17 → 0.1.18

data/lib/jenkins/filepath.rb

@@ -128,6 +128,10 @@ module Jenkins
     # TODO: createTempDir
     # TODO: createTempFile
 
+    def create_launcher(listener)
+      Launcher.new(@native.createLauncher(listener.native))
+    end
+
   private
 
     def create_filepath(path)

data/lib/jenkins/model/build.rb

@@ -21,7 +21,7 @@ module Jenkins
       #
       # build.env['GEM_HOME'] = '/path/to/my/gem/home'
       #
-      # Note that this is not an exhaustive list of all environement variables,
+      # Note that this is not an exhaustive list of all environment variables,
       # only those which have been explicitly set by code inside this Ruby
       # plugin.
       #

data/lib/jenkins/model/describable.rb

@@ -19,6 +19,7 @@ module Jenkins
     #     class Builder
     #       include Jenkins::Model::Describable
     #       describe_as Java.hudson.tasks.Builder
+    #       descriptor_is Jenkins::Tasks::BuildStepDescriptor
     #     end
     #
     # behind the scenes, this creates a `Descriptor` instance registered against the java type
@@ -31,15 +32,22 @@ module Jenkins
       DescribableError = Class.new(StandardError)
 
       module DescribeAs
-        def describe_as cls
-          if defined?(cls.java_class) && cls.is_a?(Class)
-            @describe_as_type = cls.java_class
-          else
+        # Java class that represents the extension point, which gets eventually set to Descriptor.clazz
+        # :with will use this java class as the type of descriptor.
+        def describe_as cls, options = {}
+          @describe_as_type = verify_java_class(cls).java_class
+          @descriptor_is = verify_java_class(options[:with]).java_class if options[:with]
+        end
+        attr_reader :describe_as_type
+        attr_reader :descriptor_is
+
+        private
+
+        def verify_java_class cls
+          if !defined?(cls.java_class) || !cls.is_a?(Class)
             fail DescribableError, "#{cls.class.inspect} is not an instance of java.lang.Class"
           end
-        end
-        def describe_as_type
-          @describe_as_type
+          cls
         end
       end
 
@@ -49,11 +57,13 @@ module Jenkins
           super(cls)
           cls.extend Inherited
           describe_as_type = @describe_as_type
+          descriptor_is = @descriptor_is
           cls.class_eval do
             @describe_as_type = describe_as_type
+            @descriptor_is = descriptor_is
           end
           if Jenkins::Plugin.instance
-            Jenkins::Plugin.instance.register_describable(cls, describe_as_type)
+            Jenkins::Plugin.instance.register_describable(cls, describe_as_type, descriptor_is)
           end
         end
       end

data/lib/jenkins/model/descriptor.rb

@@ -3,8 +3,13 @@ require 'json'
 
 module Jenkins
   module Model
-    class Descriptor < Java.hudson.model.Descriptor
-
+    #
+    # Jenkins typically defines one Descriptor subtype per extension point, and
+    # in Ruby we want to subtype those to add Ruby-specific behaviours.
+    #
+    # This class captures commonality of such "Ruby-specific behaviours" across different Descriptors
+    # so it can be mixed into the Descriptor subtypes
+    module RubyDescriptor
       def initialize(impl, plugin, java_type)
         super(java_type)
         @impl, @plugin, @java_type = impl, plugin, java_type
@@ -22,6 +27,11 @@ module Jenkins
         @java_type
       end
 
+      # let Jenkins use our Ruby class for resource lookup and all
+      def getKlass()
+        @plugin.peer.klassFor(@impl)
+      end
+
       # we take a fully-qualified class name, like Abc::Def::GhiJkl to underscore-separated tokens, like abc/def/ghi_jkl
       # and then look for config.* (where *=.erb, .haml, ...)
       def getConfigPage
@@ -52,6 +62,7 @@ module Jenkins
       def construct(attrs)
         @impl.new(attrs)
       rescue ArgumentError
+        # TODO: this automatic rescue can mask a user-problem in the constructor
         @impl.new
       end
 
@@ -67,5 +78,8 @@ module Jenkins
       end
     end
 
+    class Descriptor < Java.hudson.model.Descriptor
+      include RubyDescriptor
+    end
   end
 end

data/lib/jenkins/plugin/proxies/action.rb

@@ -1,4 +1,5 @@
 require 'jenkins/model/action'
+require 'jenkins/plugin/proxies/describable'
 
 module Jenkins
   class Plugin
@@ -7,6 +8,7 @@ module Jenkins
         include Java.hudson.model.Action
         include Java.jenkins.ruby.Get
         include Jenkins::Plugin::Proxy
+        include Jenkins::Plugin::Proxies::Describable
 
         def getIconFileName
           @object.icon
@@ -15,14 +17,6 @@ module Jenkins
         def getUrlName
           @object.url_path
         end
-
-        def getDescriptor
-          @plugin.descriptors[@object.class]
-        end
-
-        def get(name)
-          @object.respond_to?(name) ? @object.send(name) : nil
-        end
       end
 
       register Jenkins::Model::Action, Action

data/lib/jenkins/plugin/proxies/build_wrapper.rb

@@ -11,6 +11,7 @@ module Jenkins
       # Ruby API Jenkins::Tasks::BuildWrapper
 
       class BuildWrapper < Java.hudson.tasks.BuildWrapper
+        include Jenkins::Plugin::Proxies::Describable
         include Java.jenkins.ruby.Get
         include Jenkins::Plugin::Proxy
 
@@ -20,15 +21,6 @@ module Jenkins
         rescue Jenkins::Model::Build::Halt
           nil
         end
-
-        def getDescriptor
-          @plugin.descriptors[@object.class]
-        end
-
-        def get(name)
-          @object.respond_to?(name) ? @object.send(name) : nil
-        end
-
       end
 
 

data/lib/jenkins/plugin/proxies/builder.rb

@@ -5,18 +5,10 @@ module Jenkins
   class Plugin
     class Proxies
       class Builder < Java.hudson.tasks.Builder
+        include Jenkins::Plugin::Proxies::Describable
         include Java.jenkins.ruby.Get
         include Jenkins::Plugin::Proxy
-
         include BuildStep
-
-        def getDescriptor
-          @plugin.descriptors[@object.class]
-        end
-
-        def get(name)
-          @object.respond_to?(name) ? @object.send(name) : nil
-        end
       end
 
       register Jenkins::Tasks::Builder, Builder

data/lib/jenkins/plugin/proxies/describable.rb

@@ -0,0 +1,17 @@
+module Jenkins
+  class Plugin
+    class Proxies
+      # mix-in on top of the subtypes of the Describable Java class
+      # to add standard behaviour as a proxy to Ruby object
+      module Describable
+        def getDescriptor
+          @plugin.descriptors[@object.class]
+        end
+
+        def get(name)
+          @object.respond_to?(name) ? @object.send(name) : nil
+        end
+      end
+    end
+  end
+end

data/lib/jenkins/plugin/proxies/publisher.rb

@@ -5,18 +5,10 @@ module Jenkins
   class Plugin
     class Proxies
       class Publisher < Java.hudson.tasks.Publisher
+        include Jenkins::Plugin::Proxies::Describable
         include Java.jenkins.ruby.Get
         include Jenkins::Plugin::Proxy
-
         include BuildStep
-
-        def getDescriptor
-          @plugin.descriptors[@object.class]
-        end
-
-        def get(name)
-          @object.respond_to?(name) ? @object.send(name) : nil
-        end
       end
 
       register Jenkins::Tasks::Publisher, Publisher

data/lib/jenkins/plugin/proxies/root_action.rb

@@ -7,6 +7,7 @@ module Jenkins
         include Java.hudson.model.RootAction
         include Java.jenkins.ruby.Get
         include Jenkins::Plugin::Proxy
+        include Jenkins::Plugin::Proxies::Describable
 
         def getDisplayName
           @object.display_name
@@ -19,14 +20,6 @@ module Jenkins
         def getUrlName
           @object.url_path
         end
-
-        def getDescriptor
-          @plugin.descriptors[@object.class]
-        end
-
-        def get(name)
-          @object.respond_to?(name) ? @object.send(name) : nil
-        end
       end
 
       register Jenkins::Model::RootAction, RootAction

data/lib/jenkins/plugin/proxies.rb

@@ -69,6 +69,8 @@ module Jenkins
       # Reflect a native Ruby object into its External Java form.
       #
       # Try to find a suitable form for this object and if one is found then decorate it.
+      # If the object already is a java.lang.Object, then just let it pass through.
+      #
       # @param [Object] object the ruby object that is being exported to Java
       # @return [java.lang.Object] the Java wrapper that provides an interface to `object`
       # @throw [ExportError] if no suitable Java representation can be found
@@ -78,6 +80,9 @@ module Jenkins
         end
 
         cls = object.class
+        if cls.respond_to? :java_class
+          return object
+        end
         while cls do
           if external_class = @@intcls2extcls[cls]
             external = external_class.new(@plugin, object)
@@ -149,7 +154,7 @@ module Jenkins
       # that links can be built automatically.
       #
       # @param [Class] internal_class the Ruby class
-      # @param [java.lang.Class] external_class the Java class on the othe side of this link.
+      # @param [java.lang.Class] external_class the Java class on the other side of this link.
       def self.register(internal_class, external_class)
         @@intcls2extcls[internal_class] = external_class
         @@extcls2intcls[external_class] = internal_class

data/lib/jenkins/plugin/proxy.rb

@@ -22,8 +22,9 @@ module Jenkins
       #
       # @param [Jenkins::Plugin] plugin the plugin from whence this proxy object came
       # @param [Object] object the implementation to which this proxy will delegate.
-      def initialize(plugin, object)
-        super() if defined? super
+      # @param super_args               pass through arguments to the super type
+      def initialize(plugin, object, *super_args)
+        super(*super_args) if defined? super
         @plugin, @object = plugin, object
         @pluginid = @plugin.name
       end

data/lib/jenkins/plugin/runtime/version.rb

@@ -1,7 +1,7 @@
 module Jenkins
   class Plugin
     module Runtime
-      VERSION = "0.1.17"
+      VERSION = "0.1.18"
     end
   end
 end

data/lib/jenkins/plugin/runtime.rb

@@ -2,6 +2,7 @@ require 'jenkins/plugin'
 require 'jenkins/plugin/specification'
 require 'jenkins/plugin/runtime/version'
 require 'jenkins/plugin/proxy'
+require 'jenkins/plugin/proxies/describable'
 require 'jenkins/plugin/proxies'
 require 'jenkins/model'
 require 'jenkins/model/action'

data/lib/jenkins/plugin.rb

@@ -99,11 +99,14 @@ module Jenkins
     # process, and should not need to be invoked by plugin code.
     #
     # @param [Class] ruby_class the class implementing the extension point
-    # @param [java.lang.Class] java_class that Jenkins will see this extention point as
-    def register_describable(ruby_class, java_class)
-      descriptor = Jenkins::Model::Descriptor.new(ruby_class, self, java_class)
+    # @param [java.lang.Class] describable_class that Jenkins will see this extention point as
+    # @param [Class] descriptor_class that we use to instantiate Descriptor.
+    #                          nil to use the plain-vanilla Descriptor class for those extension points that don't define its own Descriptor type
+    def register_describable(ruby_class, describable_class, descriptor_class = nil)
+      descriptor_class ||= Jenkins::Model::Descriptor
+      descriptor = descriptor_class.new(ruby_class, self, describable_class)
       @descriptors[ruby_class] = descriptor
-      @peer.addExtension(descriptor)
+      register_extension(descriptor)
     end
 
     # unique identifier for this plugin in the Jenkins server
@@ -189,4 +192,13 @@ module Jenkins
       end
     end
   end
+
+  # Make the singleton instance available from the top-level
+  # namespace
+  #
+  #     Jenkins.plugin
+  # @see [Jenkins::Plugin.instance]
+  def self.plugin
+    self::Plugin.instance
+  end
 end

data/lib/jenkins/rack.rb

@@ -8,7 +8,7 @@ module Jenkins
     include Java.jenkins.ruby.DoDynamic
 
     def doDynamic(request, response)
-      $RUBYPLUGIN.rack(Rack::Handler::Servlet.new(self))
+      Plugin.instance.peer.rack(Rack::Handler::Servlet.new(self))
     end
   end
 end

data/spec/jenkins/model/build_spec.rb

@@ -47,6 +47,7 @@ describe Jenkins::Model::Build do
 
   describe "environment variables" do
     before do
+      pending "we need to get some full stack testing for this to fully work"
       @build.env['FOO'] = 'bar'
       @build.env[:bar] = :baz
       Java.org.mockito.Mockito.when(@native.getEvironment(nil)).thenCallRealMethod()

data/spec/jenkins/model/describable_spec.rb

@@ -34,7 +34,7 @@ describe Jenkins::Model::Describable do
       end
 
       it "is registered as an extension of the java type" do
-        @plugin.should have_received(:register_describable).with(@subclass, java.lang.Object.java_class)
+        @plugin.should have_received(:register_describable).with(@subclass, java.lang.Object.java_class, nil)
       end
 
       describe ". a sub-subclass" do
@@ -43,9 +43,20 @@ describe Jenkins::Model::Describable do
         end
 
         it "is also registered as an extension of the original java type" do
-          @plugin.should have_received(:register_describable).with(@subsubclass, java.lang.Object.java_class)
+          @plugin.should have_received(:register_describable).with(@subsubclass, java.lang.Object.java_class, nil)
         end
       end
     end
+
+    describe "with a custom descriptor type" do
+      it "registers that custom descriptor" do
+        @class.describe_as java.lang.Object, :with => java.lang.String
+        @subclass = Class.new(@class)
+        @plugin.should have_received(:register_describable).with(@subclass, java.lang.Object.java_class, java.lang.String.java_class)
+      end
+      it "must be a real java class" do
+        lambda {@class.describe_as java.lang.Object, :with => Object}.should raise_error(Jenkins::Model::Describable::DescribableError)
+      end
+    end
   end
 end

data/spec/jenkins/plugin/proxies_spec.rb

@@ -149,6 +149,20 @@ describe Jenkins::Plugin::Proxies do
     end
   end
 
+  describe "exporting an alreay external java object" do
+    before do
+      @java_object = java.lang.Object.new
+      @export = @proxies.export(@java_object)
+    end
+
+    it "just passes the java object through" do
+      @export.should be @java_object
+    end
+    it "is idempotent" do
+      @proxies.export(@export).should be @export
+    end
+  end
+
   private
 
   def proxy_class

data/spec/jenkins/plugin_spec.rb

@@ -2,9 +2,6 @@ require 'spec_helper'
 require 'tmpdir'
 
 describe Jenkins::Plugin do
-  it "is unbelievable that I don't have a spec for this class" do
-    Jenkins::Plugin.instance_method(:initialize).should_not be_nil
-  end
 
   describe "when plugin loads models" do
     include SpecHelper

metadata

@@ -2,7 +2,7 @@
 name: jenkins-plugin-runtime
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.17
+  version: 0.1.18
 platform: ruby
 authors: 
   - Charles Lowell
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-27 00:00:00 Z
+date: 2012-01-10 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: json
@@ -97,6 +97,7 @@ files:
   - lib/jenkins/plugin/proxies/build_step.rb
   - lib/jenkins/plugin/proxies/build_wrapper.rb
   - lib/jenkins/plugin/proxies/builder.rb
+  - lib/jenkins/plugin/proxies/describable.rb
   - lib/jenkins/plugin/proxies/publisher.rb
   - lib/jenkins/plugin/proxies/root_action.rb
   - lib/jenkins/plugin/proxy.rb
@@ -159,5 +160,25 @@ rubygems_version: 1.8.9
 signing_key: 
 specification_version: 3
 summary: Runtime support libraries for Jenkins Ruby plugins
-test_files: []
-
+test_files: 
+  - spec/jenkins/filepath_spec.rb
+  - spec/jenkins/launcher_spec.rb
+  - spec/jenkins/model/action_spec.rb
+  - spec/jenkins/model/build_spec.rb
+  - spec/jenkins/model/describable_spec.rb
+  - spec/jenkins/model/listener_spec.rb
+  - spec/jenkins/model_spec.rb
+  - spec/jenkins/plugin/example.pluginspec
+  - spec/jenkins/plugin/proxies/build_wrapper_spec.rb
+  - spec/jenkins/plugin/proxies/builder_spec.rb
+  - spec/jenkins/plugin/proxies/proxy_helper.rb
+  - spec/jenkins/plugin/proxies/publisher_spec.rb
+  - spec/jenkins/plugin/proxies/root_action_spec.rb
+  - spec/jenkins/plugin/proxies_spec.rb
+  - spec/jenkins/plugin/proxy_spec.rb
+  - spec/jenkins/plugin/specification_spec.rb
+  - spec/jenkins/plugin_spec.rb
+  - spec/jenkins/tasks/build_wrapper_spec.rb
+  - spec/jenkins/tasks/builder_spec.rb
+  - spec/mockito-all-1.8.5.jar
+  - spec/spec_helper.rb