jenkins-plugin-runtime 0.1.18 → 0.1.20

data/lib/jenkins/plugin/proxy.rb

@@ -10,11 +10,12 @@ module Jenkins
     #
     # This module provides common functionality for all proxies.
     module Proxy
-      def self.included(mod)
-        super
-        mod.extend(Marshal)
-        mod.send(:include, Unmarshal)
-        mod.send(:include, Customs)
+      extend Plugin::Behavior
+
+      implemented do |cls|
+        cls.class_eval do
+          include Java.org.kohsuke.stapler.StaplerProxy
+        end
       end
 
       # Every Proxy object has a reference to the plugin to which it belongs, as well as the
@@ -30,11 +31,21 @@ module Jenkins
       end
 
       # tell Stapler to go look for views from the wrapped object
-      include Java.org.kohsuke.stapler.StaplerProxy
       def getTarget
         @object
       end
 
+      # Used to specify which Ruby class this will act as a proxy
+      module ProxyFor
+        # register this class as a proxy for `internal_class`. Jenkins
+        # will auto-create instances of this class when passing to
+        # ruby and vice-versa
+        def proxy_for(internal_class)
+          fail "not a ruby class" unless internal_class.is_a? Class
+          Jenkins::Plugin::Proxies.register internal_class, self
+        end
+      end
+
       # Make sure that proxy classes do not try to persist the plugin parameter.
       # when serializing this proxy to XStream. It will be reconstructed with
       # [Unmarshal#read_completed]
@@ -78,6 +89,16 @@ module Jenkins
           @plugin.export(object)
         end
       end
+
+      module ClassMethods
+        include Marshal
+        include ProxyFor
+      end
+
+      module InstanceMethods
+        include Unmarshal
+        include Customs
+      end
     end
   end
 end

data/lib/jenkins/plugin/runtime.rb

@@ -1,9 +1,12 @@
 require 'jenkins/plugin'
+require 'jenkins/plugin/behavior'
+require 'jenkins/plugin/wrapper'
 require 'jenkins/plugin/specification'
 require 'jenkins/plugin/runtime/version'
 require 'jenkins/plugin/proxy'
 require 'jenkins/plugin/proxies/describable'
 require 'jenkins/plugin/proxies'
+require 'jenkins/cli/command'
 require 'jenkins/model'
 require 'jenkins/model/action'
 require 'jenkins/model/root_action'

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

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

data/lib/jenkins/plugin/wrapper.rb

@@ -0,0 +1,29 @@
+class Jenkins::Plugin
+  # Proxies provide a lens through which the Java world sees a Ruby
+  # object. On the other hand, Wrappers are a lens through which
+  # the Ruby world sees a Java object.
+  module Wrapper
+    extend Behavior
+
+    # The native [java.lang.Object] which this object wraps
+    attr_reader :native
+
+    def initialize(*args)
+      @native, = *args
+    end
+
+    module ClassMethods
+
+      # Declare a wrapper class to wrap a certain type of
+      # java class. The plugin runtime will maintain this
+      # mapping so that whenever it sees an object coming
+      # in from Java, it knows the appropriate wrapper
+      # class to choose.
+      #
+      # @param [java.lang.Class] the java class equivalent
+      def wrapper_for(java_class)
+        Jenkins::Plugin::Proxies.register self, java_class
+      end
+    end
+  end
+end

data/spec/jenkins/cli/command_proxy_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Jenkins::CLI::CommandProxy do
+  it 'works and is testable *cough* @kohsuke *cough*'
+end

data/spec/jenkins/cli/command_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Jenkins::CLI::Command do
+  it 'works and is testable *cough* @kohsuke *cough*'
+end

data/spec/jenkins/launcher_spec.rb

@@ -10,10 +10,6 @@ describe Jenkins::Launcher do
     @launcher = Jenkins::Launcher.new(@native)
   end
 
-  it "can be instantiated" do
-    Jenkins::Launcher.new
-  end
-
   describe "execute" do
     it "passes a simple command to a native launcher" do
       @starter.should_receive(:envs).with({})

data/spec/jenkins/model/action_spec.rb

@@ -35,7 +35,8 @@ describe Jenkins::Model::Action do
   private
 
   def new_action(&body)
-    action = Class.new(Jenkins::Model::Action)
+    action = Class.new
+    action.send(:include, Jenkins::Model::Action)
     action.class_eval(&body) if block_given?
     return action
   end

data/spec/jenkins/model/build_spec.rb

@@ -5,8 +5,8 @@ describe Jenkins::Model::Build do
   include SpecHelper
 
   before :each do
-    @native = mockito(Java.hudson.model.AbstractBuild)
-    @native.buildEnvironments = java.util.ArrayList.new
+    @native = mock(Java.hudson.model.AbstractBuild)
+    @native.stub(:buildEnvironments).and_return(java.util.ArrayList.new)
     @build = Jenkins::Model::Build.new(@native)
   end
 
@@ -50,7 +50,6 @@ describe Jenkins::Model::Build 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()
       @vars = @native.getEnvironment(nil)
     end
 

data/spec/jenkins/model/describable_spec.rb

@@ -4,14 +4,14 @@ describe Jenkins::Model::Describable do
 
   before do
     @plugin = mock(Jenkins::Plugin)
-    Jenkins::Plugin.stub(:instance).and_return(@plugin)
+    Jenkins.stub(:plugin).and_return(@plugin)
   end
 
   describe "when mixed into a class" do
     before do
       @class = Class.new
-      @class.send(:include, Jenkins::Model::Describable)
       @plugin.stub(:register_describable)
+      @class.send(:include, Jenkins::Model::Describable)
     end
 
 
@@ -30,11 +30,17 @@ describe Jenkins::Model::Describable do
     describe "a subclass of that class" do
       before do
         @class.describe_as java.lang.Object
+        def @class.to_s; "SuperClass" end
         @subclass = Class.new(@class)
+        def @subclass.to_s; "SubClass" end
       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, nil)
+      it "is registered as an extension" do
+        @plugin.should have_received(:register_describable).with(@subclass)
+      end
+
+      it "has the same java type as its superclass" do
+        @subclass.describe_as_type.should eql java.lang.Object.java_class
       end
 
       describe ". a sub-subclass" do
@@ -43,20 +49,29 @@ 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, nil)
+          @plugin.should have_received(:register_describable).with(@subsubclass)
+        end
+        
+        it 'inherits its describe_as_type' do
+          @subsubclass.describe_as_type.should eql java.lang.Object.java_class
         end
       end
     end
 
     describe "with a custom descriptor type" do
-      it "registers that custom descriptor" do
+      before 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 "registers that custom descriptor" do
+        @plugin.should have_received(:register_describable).with(@subclass)
       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
+      it "inherits the descriptor type" do
+        @subclass.descriptor_is.should eql java.lang.String.java_class
+      end
     end
   end
 end

data/spec/jenkins/model_spec.rb

@@ -61,34 +61,6 @@ describe Jenkins::Model do
     child.should be_transient(:bar)
   end
 
-  describe "tracking descendants" do
-    before do
-      Model.clear
-    end
-
-    it "captures including classes" do
-      cls = Class.new
-      cls.send(:include, Model)
-      Model.should be_descendant cls
-    end
-
-    it "captures classes that extend including classes" do
-      cls = Class.new
-      cls.send(:include, Model)
-      Model.should be_descendant(Class.new(cls))
-    end
-
-    it "captures classes that include including modules" do
-      m1 = Module.new
-      m1.send(:include, Model)
-      m2 = Module.new
-      m2.send(:include, m1)
-      cls = Class.new
-      cls.send(:include, m2)
-      Model.should be_descendant(Class.new(cls))
-    end
-  end
-
   private
 
   def new_model(&block)

data/spec/jenkins/plugin/behavior_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+require 'jenkins/plugin/behavior'
+
+describe Jenkins::Plugin::Behavior do
+  before do
+    module OhBehave
+      extend Jenkins::Plugin::Behavior
+      @implementations = []
+      def self.implementations
+        @implementations
+      end
+      implemented do |impl|
+        @implementations << impl
+      end
+      module Foo
+        def foo; 'foo' end
+      end
+      module Bar
+        def bar; 'bar' end
+      end
+      module Baz
+        def baz; 'baz' end
+      end
+      module Qux
+        def qux; 'qux' end
+      end
+      module InstanceMethods
+        include Foo
+        include Bar
+      end
+      module ClassMethods
+        include Baz
+        include Qux
+      end
+    end
+  end
+  describe "when a behavior is included into a class" do
+    before do
+      @class = Class.new
+      def @class.to_s; 'Behaving' end
+      @class.send(:include, OhBehave)
+    end
+
+    its "methods in ClassMethods are available to the implementing class" do
+      @class.baz.should eql 'baz'
+      @class.qux.should eql 'qux'
+    end
+
+    its "methods in the InstanceMethods module are available to instances" do
+      @class.new.tap do |i|
+        i.foo.should eql 'foo'
+        i.bar.should eql 'bar'
+      end
+    end
+
+    its "implementation block is invoked" do
+      OhBehave.implementations.should be_member @class
+    end
+
+    describe "and then that class is subclassed" do
+      before do
+        @subclass = Class.new(@class)
+        def @subclass.to_s; 'BehavingSubclass' end
+      end
+
+      its "methods in ClassMethods are available to the subclass" do
+        @subclass.baz.should eql 'baz'
+        @subclass.qux.should eql 'qux'
+      end
+
+      its 'methods in InstanceMethods are available to subclass instances' do
+        @subclass.new.foo.should eql 'foo'
+        @subclass.new.bar.should eql 'bar'
+      end
+
+      its 'implementation block is invoked with the subclass' do
+        OhBehave.implementations.should be_member @subclass
+      end
+
+      describe ". If it is subclassed yet again" do
+        before do
+          @subsubclass = Class.new(@subclass)
+          def @subsubclass.to_s; "BehavingSubSubClass" end
+        end
+        its 'implementatin block is invoked with the sub-sub-class' do
+          OhBehave.implementations.should be_member @subsubclass
+        end
+      end
+    end
+  end
+  describe 'when a behavior is included into another module' do
+    before do
+      @module = Module.new
+      @module.send(:include, OhBehave)
+      @class = Class.new(Object)
+      @class.send(:include, @module)
+    end
+    it 'reaches classes the module includes' do
+      @class.baz.should eql 'baz'
+      @class.new.foo.should eql 'foo'
+    end
+    its 'implementation callback is invoked for classes including that module' do
+      OhBehave.implementations.should be_member @class
+    end
+    its 'implementation callback is NOT invoked for any intervening modules' do
+      OhBehave.implementations.should_not be_member @module
+    end
+  end
+end

data/spec/jenkins/plugin/proxy_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'rspec-spies'
 
 describe "a class with #{Jenkins::Plugin::Proxy} mixed in" do
 
@@ -40,4 +41,17 @@ describe "a class with #{Jenkins::Plugin::Proxy} mixed in" do
     end
   end
 
+  describe "specifiying which ruby class it proxies" do
+    before do
+      @proxies = Jenkins::Plugin::Proxies
+      @proxies.stub(:register)
+      @class.class_eval do
+        proxy_for String
+      end
+    end
+
+    it 'registers it with the global proxy registry' do
+      @proxies.should have_received(:register).with(String, @class)
+    end
+  end
 end

data/spec/jenkins/plugin_spec.rb

@@ -3,6 +3,26 @@ require 'tmpdir'
 
 describe Jenkins::Plugin do
 
+  describe Jenkins::Plugin::Lifecycle do
+    before do |variable|
+      @plugin = Jenkins::Plugin.new mock(:name => 'org.jenkinsci.ruby.RubyPlugin')
+      @plugin.on.start do |plugin|
+        @start = plugin
+      end
+      @plugin.on.stop do |plugin|
+        @stop = plugin
+      end
+      @plugin.start
+      @plugin.stop
+    end
+    it "gets a callback on start" do
+      @start.should be @plugin
+    end
+    it "gets a callback on stop" do
+      @stop.should be @plugin
+    end
+  end
+
   describe "when plugin loads models" do
     include SpecHelper
 

data/spec/spec_helper.rb

@@ -1,6 +1,12 @@
 require 'java'
 require 'tmpdir'
 
+module Jenkins
+  def self.rspec_ewwww_gross_hack?
+    true
+  end
+end
+
 require 'jenkins/war'
 for path in Dir[File.join(ENV['HOME'], '.jenkins', 'wars', Jenkins::War::VERSION, "**/*.jar")]
   $CLASSPATH << path
@@ -10,7 +16,11 @@ $:.unshift Pathname(__FILE__).dirname.join('../lib')
 
 require 'jenkins/plugin/runtime'
 require 'jenkins/plugin/proxies/proxy_helper'
-require File.expand_path '../mockito-all-1.8.5.jar', __FILE__
+
+def puts(msg = nil)
+  require 'erb'
+  super ERB::Util.h(msg) + "<br/>"
+end
 
 module SpecHelper
   # Java does not support opening directory as a File: File.open(".")
@@ -43,8 +53,4 @@ module SpecHelper
       f << content
     end
   end
-
-  def mockito(cls)
-    Java.org.mockito.Mockito.mock(cls.java_class)
-  end
 end