bosdk 0.1.1-universal-java-1.6 → 0.1.2-universal-java-1.6

data/README.rdoc

@@ -14,20 +14,16 @@ A JRuby wrapper for the Business Objects SDK
 == Usage
 
  require 'bosdk'
- boe = BOSDK::EnterpriseSession.new('cms', 'Administrator', '')
+ include BOSDK
+ boe = EnterpriseSession.new('cms', 'Administrator', '')
 
  stmt = "SELECT TOP 10 * FROM CI_SYSTEMOBJECTS WHERE SI_KIND='User'"
  boe.query(stmt).each do |obj|
-   puts obj.title
+   puts obj.path
  end
 
  boe.disconnect
 
-== Future Enhancements
-
-In the future there may be wrappers around the more commonly used portions of
-the SDK, such as IInfoObject.
-
 == Resources
 
 - Website: http://semmons99.github.com/bosdk

data/bosdk.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "bosdk"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
   
   s.author = "Shane Emmons"
   s.description = "A JRuby wrapper for the Business Objects Java SDK"
@@ -9,7 +9,9 @@ Gem::Specification.new do |s|
     "README.rdoc", "MIT-LICENSE", "bosdk.gemspec", "Rakefile",
     "lib/bosdk.rb",
     "lib/bosdk/enterprise_session.rb",
+    "lib/bosdk/info_object.rb",
     "spec/enterprise_session_spec.rb",
+    "spec/info_object_spec.rb",
   ]
 
   s.homepage = "http://semmons99.github.com/bosdk"

data/lib/bosdk/enterprise_session.rb

@@ -1,5 +1,7 @@
+require 'bosdk/info_object'
+
 module BOSDK
-  # Creates a wrapper around the Business Objects Java SDK
+  # Creates a wrapper around the Business Objects Java SDK.
   class EnterpriseSession
     # The underlying IEnterpriseSession
     attr_reader :session
@@ -19,7 +21,7 @@ module BOSDK
       at_exit { disconnect }
     end
 
-    # Returned true/false if connected to the CMS.
+    # Returns true/false if connected to the CMS.
     def connected?
       return @connected
     end
@@ -32,9 +34,10 @@ module BOSDK
       nil
     end
 
-    # Queries the InfoStore with the provided statement.
+    # Queries the InfoStore with the provided statement, returning an Array of
+    # InfoObject(s).
     def query(stmt)
-      @infostore.query(stmt)
+      @infostore.query(stmt).map{|o| InfoObject.new(o)}
     end
   end
 end

data/lib/bosdk/info_object.rb

@@ -0,0 +1,46 @@
+module BOSDK
+  # Creates a wrapper around an IInfoObject.
+  class InfoObject
+    # The underlying IInfoObject.
+    attr_reader :obj
+
+    # Creates a new InfoObject from the provided IInfoObject.
+    #  InfoObject.new(obj)
+    def initialize(obj)
+      @obj = obj
+    end
+
+    # Returns true/false if #obj is a root node.
+    def is_root?
+      parent_id.nil? or parent_id == 0 or parent_id == getID
+    end
+
+    # Returns the parent of #obj as an InfoObject
+    def parent
+      return nil if is_root?
+      @parent ||= InfoObject.new(getParent)
+    end
+
+    # Returns the path of #obj as a String.
+    def path
+      @path ||= (is_root? ? '' : parent.path) + "/#{title}"
+    end
+
+    # Compares one InfoObject to another by #title.
+    def <=>(other_infoobject)
+      title <=> other_infoobject.title
+    end
+
+    def method_missing(method, *args)
+      eval "return @#{method.to_s}" if instance_variables.include?("@#{method.to_s}")
+      if @obj.respond_to?(method)
+        eval "return @#{method.to_s} = @obj.send(method, *args)"
+      end
+      super
+    end
+
+    def respond_to?(method)
+      @obj.respond_to?(method) || super
+    end
+  end
+end

data/lib/bosdk.rb

@@ -25,3 +25,4 @@ Dir.glob(ENV["BOE_JAVA_LIB"] + "/*.jar").each{|jar| require jar}
 include_class "com.crystaldecisions.sdk.framework.CrystalEnterprise"
 
 require 'bosdk/enterprise_session'
+require 'bosdk/info_object'

data/spec/enterprise_session_spec.rb

@@ -49,17 +49,9 @@ module BOSDK
 
     specify "#query should send the statement to the underlying InfoStore" do
       stmt = 'SELECT * FROM CI_infoobjectS'
-      @infostore.should_receive(:query).once.with(stmt)
+      @infostore.should_receive(:query).once.with(stmt).and_return([])
 
-      results = @es.query(stmt)
-    end
-
-    specify "#query should return the IInfoObjects" do
-      stmt = 'SELECT * FROM CI_INFOOBJECTS'
-      @infostore.should_receive(:query).once.with(stmt).and_return(@infoobjects)
-
-      results = @es.query(stmt)
-      results.should == @infoobjects
+      @es.query(stmt)
     end
   end
 end

data/spec/info_object_spec.rb

@@ -0,0 +1,111 @@
+# encoding: utf-8
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'bosdk/info_object'
+
+module BOSDK
+  describe InfoObject do
+    before(:each) do
+      # mocks
+      @infoobject = mock("IInfoObject").as_null_object
+
+      @obj = InfoObject.new(@infoobject)
+    end
+
+    specify "#is_root? should return true when #parent_id is nil" do
+      @infoobject.should_receive(:parent_id).once.with.and_return(nil)
+
+      @obj.is_root?.should be_true
+    end
+
+    specify "#is_root? should return true when #parent_id is '0'" do
+      @infoobject.should_receive(:parent_id).once.with.and_return(0)
+
+      @obj.is_root?.should be_true
+    end
+
+    specify "#is_root? should return true when #parent_id == #getID" do
+      @infoobject.should_receive(:parent_id).once.with.and_return(1)
+      @infoobject.should_receive(:getID).once.with.and_return(1)
+
+      @obj.is_root?.should be_true
+    end
+
+    specify "#is_root? should return false when #parent_id is not: nil, '0' or #getID" do
+      @infoobject.should_receive(:parent_id).once.with.and_return(1)
+      @infoobject.should_receive(:getID).once.with.and_return(2)
+
+      @obj.is_root?.should be_false
+    end
+
+    specify "#parent should return nil if #is_root? == true" do
+      @infoobject.should_receive(:parent_id).once.with.and_return(nil)
+
+      @obj.parent.should be_nil
+    end
+
+    specify "#parent should return results of #getParent if #is_root? == false" do
+      parent_obj = mock("IInfoObject").as_null_object
+      @infoobject.should_receive(:parent_id).once.with.and_return(1)
+      @infoobject.should_receive(:getID).once.with.and_return(2)
+      @infoobject.should_receive(:getParent).once.with.and_return(parent_obj)
+
+      parent = @obj.parent
+      parent.should be_instance_of InfoObject
+      parent.obj.should == parent_obj
+    end
+
+    specify "#parent should only call the underlying #getParent once" do
+      parent_obj = mock("IInfoObject").as_null_object
+      @infoobject.should_receive(:parent_id).once.with.and_return(1)
+      @infoobject.should_receive(:getID).once.with.and_return(2)
+      @infoobject.should_receive(:getParent).once.with.and_return(parent_obj)
+
+      2.times{@obj.parent}
+    end
+
+    specify "#path should return /#title if #is_root? == true" do
+      @infoobject.should_receive(:parent_id).once.with.and_return(nil)
+      @infoobject.should_receive(:title).once.with.and_return('test obj')
+
+      @obj.path.should == '/test obj'
+    end
+
+    specify "#path should return #parent_title/../#title if #is_root? == false" do
+      parent_obj = mock("IInfoObject").as_null_object
+      parent_obj.should_receive(:parent_id).once.with.and_return(nil)
+      parent_obj.should_receive(:title).once.with.and_return('test parent')
+
+      @infoobject.should_receive(:parent_id).once.with.and_return(1)
+      @infoobject.should_receive(:getID).once.with.and_return(2)
+      @infoobject.should_receive(:title).once.with.and_return('test obj')
+      @infoobject.should_receive(:getParent).once.with.and_return(parent_obj)
+
+      @obj.path.should == '/test parent/test obj'
+    end
+
+    specify "#path should only call the underlying #title, #parent#path, etc. once" do
+      parent_obj = mock("IInfoObject").as_null_object
+      parent_obj.should_receive(:parent_id).once.with.and_return(nil)
+      parent_obj.should_receive(:title).once.with.and_return('test parent')
+
+      @infoobject.should_receive(:parent_id).once.with.and_return(1)
+      @infoobject.should_receive(:getID).once.with.and_return(2)
+      @infoobject.should_receive(:title).once.with.and_return('test obj')
+      @infoobject.should_receive(:getParent).once.with.and_return(parent_obj)
+
+      2.times{@obj.path}
+    end
+
+    specify "#<=> should use #title" do
+      objs = []
+      ('a'..'c').to_a.reverse.each do |ltr|
+        obj = mock("IInfoObject").as_null_object
+        obj.should_receive(:title).once.with.and_return(ltr)
+        objs << InfoObject.new(obj)
+      end
+
+      sorted_objs = objs.sort
+      sorted_objs.should == objs.reverse
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bosdk
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: universal-java-1.6
 authors: 
   - Shane Emmons
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-19 00:00:00 -05:00
+date: 2010-01-21 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -28,7 +28,9 @@ files:
   - Rakefile
   - lib/bosdk.rb
   - lib/bosdk/enterprise_session.rb
+  - lib/bosdk/info_object.rb
   - spec/enterprise_session_spec.rb
+  - spec/info_object_spec.rb
 has_rdoc: true
 homepage: http://semmons99.github.com/bosdk
 licenses: []