bosdk 1.0.3-universal-java-1.6 → 1.1.0-universal-java-1.6

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/README.rdoc

@@ -51,8 +51,17 @@ Disconnects @boe from the cms.
  query(stmt)
 Runs the provided query on @boe and returns the resulting InfoObject array.
 
- open(docid)
-Opens the specified InfoObject using a ReportEngine and returns the doc handle.
+ open_webi(docid)
+Opens the specified InfoObject using a ReportEngine and returns a handle to the
+WebiInstance. It also creates the following instance variables: @doc, @objs and
+@vars. @doc is a handle to the WebiInstance, @objs is an alias for @doc.objects
+and @vars is an alias for @doc.variables.
+
+ objects
+Shortcut to @objs which is an alias for @doc.objects
+
+ variables
+Shortcut to @vars which is an alias for @doc.variables
 
 == Resources
 

data/Rakefile

@@ -1,26 +1,53 @@
+require 'rubygems'
+require 'rake'
 require 'rake/clean'
 
-CLEAN.include %w( doc )
-CLOBBER.include %w( *.gem )
+CLOBBER.include 'pkg'
 
-desc 'generate documentation'
-task :rdoc do
-  sh 'hanna README.rdoc MIT-LICENSE lib -U'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "bosdk"
+    gem.summary = "JRuby Business Object Java SDK wrapper"
+    gem.description = "A JRuby wrapper for the Business Objects Java SDK"
+    gem.email = "semmons99@gmail.com"
+    gem.homepage = "http://semmons99.github.com/bosdk"
+    gem.authors = ["Shane Emmons"]
+    gem.platform = Gem::Platform::CURRENT
+    gem.requirements = "An environment variable 'BOE_JAVA_LIB' pointing to the Business Objects Java SDK directory"
+    gem.add_development_dependency "rspec", ">= 1.3.0"
+    gem.add_development_dependency "hanna", ">= 0.1.12"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with gem install jeweler"
 end
 
-desc 'build gem'
-task :gem do
-  sh 'gem build bosdk.gemspec'
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
 end
 
-desc 'upload gem'
-task :upload => :gem do
-  Dir.glob('bosdk*.gem') do |gem|
-    sh "gem push #{gem}"
-  end
+desc "Run specs with '--format specdoc'"
+Spec::Rake::SpecTask.new(:specdoc) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts << '--format specdoc'
 end
 
-desc 'run unit tests'
-task :test do
-  ruby '-S spec -f s -c spec/*_spec.rb'
+task :spec => :check_dependencies
+
+task :default => :spec
+
+task :test => :spec
+
+require 'hanna/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bosdk #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/bin/boirb

@@ -46,7 +46,18 @@ def query(stmt)
 end
 
 def open_webi(docid)
-  @boe.open_webi(docid) if connected?
+  @doc = @boe.open_webi(docid) if connected?
+  @objs = @doc.objects
+  @vars = @doc.variables
+  @doc
+end
+
+def objects
+  @objs
+end
+
+def variables
+  @vars
 end
 
 IRB.start_session(Kernel.binding)

data/bosdk.gemspec

@@ -1,31 +1,72 @@
-Gem::Specification.new do |s|
-  s.name = "bosdk"
-  s.version = "1.0.3"
-  
-  s.author = "Shane Emmons"
-  s.description = "A JRuby wrapper for the Business Objects Java SDK"
-  s.email = "semmons99@gmail.com"
-  s.files = [
-    "README.rdoc", "MIT-LICENSE", "bosdk.gemspec", "Rakefile",
-    "bin/boirb",
-    "lib/bosdk.rb",
-    "lib/bosdk/enterprise_session.rb",
-    "lib/bosdk/info_object.rb",
-    "lib/bosdk/webi_report_engine.rb",
-    "spec/enterprise_session_spec.rb",
-    "spec/info_object_spec.rb",
-    "spec/webi_report_engine_spec.rb",
-  ]
-  s.bindir = "bin"
-  s.executables = ["boirb"]
-  s.default_executable = "boirb"
-
-  s.homepage = "http://semmons99.github.com/bosdk"
-  s.summary = "JRuby Business Object Java SDK wrapper"
-  s.platform = Gem::Platform::CURRENT
-  s.requirements = "An environment variable 'BOE_JAVA_LIB' pointing to the Business Objects Java SDK directory"
-  s.has_rdoc = true
-  s.extra_rdoc_files = ["README.rdoc", "MIT-LICENSE"]
-  s.add_development_dependency("rspec", ">= 1.3.0")
-  s.add_development_dependency("hanna", ">= 0.1.12")
-end
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bosdk}
+  s.version = "1.1.0"
+  s.platform = %q{universal-java-1.6}
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Shane Emmons"]
+  s.date = %q{2010-02-09}
+  s.default_executable = %q{boirb}
+  s.description = %q{A JRuby wrapper for the Business Objects Java SDK}
+  s.email = %q{semmons99@gmail.com}
+  s.executables = ["boirb"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/boirb",
+     "bosdk.gemspec",
+     "lib/bosdk.rb",
+     "lib/bosdk/enterprise_session.rb",
+     "lib/bosdk/info_object.rb",
+     "lib/bosdk/webi_instance.rb",
+     "lib/bosdk/webi_report_engine.rb",
+     "spec/bosdk_spec.rb",
+     "spec/enterprise_session_spec.rb",
+     "spec/info_object_spec.rb",
+     "spec/webi_instance_spec.rb",
+     "spec/webi_report_engine_spec.rb"
+  ]
+  s.homepage = %q{http://semmons99.github.com/bosdk}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.requirements = ["An environment variable 'BOE_JAVA_LIB' pointing to the Business Objects Java SDK directory"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{JRuby Business Object Java SDK wrapper}
+  s.test_files = [
+    "spec/bosdk_spec.rb",
+     "spec/enterprise_session_spec.rb",
+     "spec/info_object_spec.rb",
+     "spec/webi_instance_spec.rb",
+     "spec/webi_report_engine_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_development_dependency(%q<hanna>, [">= 0.1.12"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<hanna>, [">= 0.1.12"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<hanna>, [">= 0.1.12"])
+  end
+end
+

data/lib/bosdk.rb

@@ -29,6 +29,7 @@ include_class "com.businessobjects.rebean.wi.ReportEngines"
 require 'bosdk/enterprise_session'
 require 'bosdk/info_object'
 require 'bosdk/webi_report_engine'
+require 'bosdk/webi_instance'
 
 module BOSDK
   # A closure over EnterpriseSession

data/lib/bosdk/enterprise_session.rb

@@ -1,6 +1,3 @@
-require 'bosdk/info_object'
-require 'bosdk/webi_report_engine'
-
 module BOSDK
   # Creates a wrapper around the Business Objects Java SDK.
   class EnterpriseSession
@@ -51,7 +48,7 @@ module BOSDK
     # Open a Webi document from the provided docid
     def open_webi(docid)
       @webi_report_engine ||= WebiReportEngine.new(@session, @locale)
-      @webi_report_engine.open(docid)
+      WebiInstance.new(@webi_report_engine.open(docid))
     end
   end
 end

data/lib/bosdk/info_object.rb

@@ -10,9 +10,14 @@ module BOSDK
       @obj = obj
     end
 
+    # Returns the Business Objects ID (alias for #getID).
+    def docid
+      getID
+    end
+
     # Returns true/false if #obj is a root node.
     def is_root?
-      parent_id.nil? or parent_id == 0 or parent_id == getID
+      parent_id.nil? or parent_id == 0 or parent_id == docid
     end
 
     # Returns the parent of #obj as an InfoObject

data/lib/bosdk/webi_instance.rb

@@ -0,0 +1,46 @@
+module BOSDK
+  # Creates a wrapper around a DocumentInstance
+  class WebiInstance
+    # The underlying DocumentInstance
+    attr_reader :instance
+
+    # Create a new WebiInstance from the provided DocumentInstance
+    def initialize(instance)
+      @instance = instance
+    end
+
+    # Returns an array of hashes representing report objects.
+    def objects
+      return @objects unless @objects.nil?
+      objs = []
+      dict = @instance.getDictionary
+      (0 ... dict.getChildCount).each do |i|
+        obj = dict.getChildAt(i)
+        objs << {
+          :name => obj.getName,
+          :qual => obj.getQualification.toString.downcase.to_sym,
+          :type => obj.getType.toString.downcase.to_sym,
+          :object => obj,
+        }
+      end
+      @objects = objs
+    end
+
+    # Returns an array of hashes representing report variables.
+    def variables
+      return @variables unless @variables.nil?
+      vars = []
+      dict = @instance.getDictionary
+      dict.getVariables.each do |var|
+        vars << {
+          :name => var.getName,
+          :qual => var.getQualification.toString.downcase.to_sym,
+          :type => var.getType.toString.downcase.to_sym,
+          :formula => var.getFormula.getValue,
+          :variable => var,
+        }
+      end
+      @variables = vars
+    end
+  end
+end

data/spec/bosdk_spec.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'bosdk'
+
+module BOSDK
+  describe BOSDK do
+    describe "#connect" do
+      before(:each) do
+        @es = mock("EnterpriseSession").as_null_object
+        class EnterpriseSession; end
+        EnterpriseSession.should_receive(:new).once.with('cms', 'Administrator', '', {:locale => "en_US"}).and_return(@es)
+        @es.should_receive(:disconnect).once.with.and_return
+      end
+
+      specify "wraps EnterpriseSession#new in a closure" do
+        BOSDK.connect('cms', 'Administrator', '', :locale => "en_US") do |session|
+          session.should == @es
+        end
+      end
+    end
+  end
+end

data/spec/enterprise_session_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
 require 'bosdk/enterprise_session'
 
@@ -18,111 +17,154 @@ module BOSDK
       @es = EnterpriseSession.new('cms', 'Administrator', '')
     end
 
-    specify "#new should accept an optional locale setting" do
-      EnterpriseSession.new('cms', 'Administrator', '', :locale => 'en_CA')
+    describe "#new" do
+      it "should accept an optional locale setting" do
+        EnterpriseSession.new('cms', 'Administrator', '', :locale => 'en_CA')
+      end
     end
 
-    specify "#connected? returns 'true' when connected to a CMS" do
-      @es.connected?.should be_true
-    end
+    describe "#connected?" do
+      before(:each) do
+        @session.should_receive(:logoff).at_most(1).with.and_return
+      end
 
-    specify "#connected? returns 'false' when not connected to a CMS" do
-      @session.should_receive(:logoff).once.with.and_return
+      it "returns 'true' when connected to a CMS" do
+        @es.connected?.should be_true
+      end
 
-      @es.disconnect
-      @es.connected?.should be_false
+      it "returns 'false' when not connected to a CMS" do
+        @es.disconnect
+        @es.connected?.should be_false
+      end
     end
 
-    specify "#disconnect should disconnect from the CMS" do
-      @session.should_receive(:logoff).once.with.and_return
-
-      @es.disconnect
-      @es.connected?.should be_false
-    end
+    describe "#disconnect" do
+      before(:each) do
+        @session.should_receive(:logoff).once.with.and_return
+      end
 
-    specify "#disconnect shouldn't raise an error when not connected" do
-      @session.should_receive(:logoff).once.with.and_return
+      it "should disconnect from the CMS" do
+        @es.disconnect
+        @es.connected?.should be_false
+      end
 
-      lambda{2.times{ @es.disconnect }}.should_not raise_exception
+      it "shouldn't raise an error when not connected" do
+        lambda{2.times{ @es.disconnect }}.should_not raise_exception
+      end
     end
 
-    specify "#path_to_sql should convert a path query to an sql query" do
-      path_query = 'path://SystemObjects/Users/Administrator@SI_ID'
-      stmt = "SELECT SI_ID FROM CI_SYSTEMOBJECTS WHERE SI_KIND='User' AND SI_NAME='Administrator'"
-      
-      @stateless_page_info = mock("IStatelessPageInfo").as_null_object
-
-      class PagingQueryOptions; end
-      PagingQueryOptions.should_receive(:new).once.with
-      @infostore.should_receive(:getStatelessPageInfo).once.with(path_query, nil).and_return(@stateless_page_info)
-      @stateless_page_info.should_receive(:getPageSQL).once.with.and_return(stmt)
-
-      @es.path_to_sql(path_query).should == stmt
+    describe "#path_to_sql" do
+      before(:each) do
+        @path_query = 'path://SystemObjects/Users/Administrator@SI_ID'
+        @stmt = "SELECT SI_ID FROM CI_SYSTEMOBJECTS WHERE SI_KIND='User' AND SI_NAME='Administrator'"
+        
+        @stateless_page_info = mock("IStatelessPageInfo").as_null_object
+
+        class PagingQueryOptions; end
+        PagingQueryOptions.should_receive(:new).once.with
+        @infostore.should_receive(:getStatelessPageInfo).once.with(@path_query, nil).and_return(@stateless_page_info)
+        @stateless_page_info.should_receive(:getPageSQL).once.with.and_return(@stmt)
+      end
+
+      it "should convert a path query to an sql query" do
+        @es.path_to_sql(@path_query).should == @stmt
+      end
     end
 
-    specify "#query should send the statement to the underlying InfoStore" do
-      stmt = 'SELECT * FROM CI_INFOOBJECTS'
-      @infostore.should_receive(:query).once.with(stmt).and_return([])
-
-      @es.query(stmt)
+    describe "#query" do
+      context "when :type => sql" do
+        before(:each) do
+          @stmt = 'SELECT * FROM CI_INFOOBJECTS'
+          @infostore.should_receive(:query).once.with(@stmt).and_return([])
+        end
+
+        it "should send the statement to the underlying InfoStore" do
+          @es.query(@stmt)
+        end
+      end
+
+      context "when :type => path://" do
+        before(:each) do
+          @path_query = 'path://SystemObjects/Users/Administrator@SI_ID'
+          @stmt = "SELECT * FROM CI_SYSTEMOBJECTS WHERE SI_KIND='User' AND SI_NAME='Administator'"
+
+          @es.should_receive(:path_to_sql).once.with(@path_query).and_return(@stmt)
+          @infostore.should_receive(:query).once.with(@stmt).and_return([])
+        end
+
+        it "should convert a path:// query to sql before execution" do
+          @es.query(@path_query)
+        end
+      end
+
+      context "when :type => query://" do
+        before(:each) do
+          @path_query = 'query://{SELECT * FROM CI_INFOOBJECTS}'
+          @stmt = 'SELECT * FROM CI_INFOOBJECTS'
+
+          @es.should_receive(:path_to_sql).once.with(@path_query).and_return(@stmt)
+          @infostore.should_receive(:query).once.with(@stmt).and_return([])
+        end
+
+        it "should convert a query:// query to sql before execution" do
+          @es.query(@path_query)
+        end
+      end
+
+      context "when :type => cuid://" do
+        before(:each) do
+          @path_query = 'cuid://ABC'
+          @stmt = "SELECT * FROM CI_INFOOBJECTS WHERE SI_CUID='ABC'"
+
+          @es.should_receive(:path_to_sql).once.with(@path_query).and_return(@stmt)
+          @infostore.should_receive(:query).once.with(@stmt).and_return([])
+        end
+
+        it "should convert a cuid:// query to sql before execution" do
+          @es.query(@path_query)
+        end
+      end
     end
 
-    specify "#query should convert a path:// query to sql before execution" do
-      path_query = 'path://SystemObjects/Users/Administrator@SI_ID'
-      stmt = "SELECT * FROM CI_SYSTEMOBJECTS WHERE SI_KIND='User' AND SI_NAME='Administator'"
-
-      @es.should_receive(:path_to_sql).once.with(path_query).and_return(stmt)
-      @infostore.should_receive(:query).once.with(stmt).and_return([])
-
-      @es.query(path_query)
-    end
-
-    specify "#query should convert a query:// query to sql before execution" do
-      path_query = 'query://{SELECT * FROM CI_INFOOBJECTS}'
-      stmt = 'SELECT * FROM CI_INFOOBJECTS'
-
-      @es.should_receive(:path_to_sql).once.with(path_query).and_return(stmt)
-      @infostore.should_receive(:query).once.with(stmt).and_return([])
-
-      @es.query(path_query)
-    end
-
-    specify "#query should convert a cuid:// query to sql before execution" do
-      path_query = 'cuid://ABC'
-      stmt = "SELECT * FROM CI_INFOOBJECTS WHERE SI_CUID='ABC'"
-
-      @es.should_receive(:path_to_sql).once.with(path_query).and_return(stmt)
-      @infostore.should_receive(:query).once.with(stmt).and_return([])
-
-      @es.query(path_query)
-    end
-
-    specify "#open_webi should create a WebiReportEngine and call #open" do
-      @webi_report_engine = mock("WebiReportEngine").as_null_object
-      class WebiReportEngine; end
-      WebiReportEngine.should_receive(:new).once.with(@session, 'en_US').and_return(@webi_report_engine)
-      @webi_report_engine.should_receive(:open).once.with("1234")
-
-      @es.open_webi("1234")
-    end
-
-    specify "#open_webi should only create a WebiReportEngine once" do
-      @webi_report_engine = mock("WebiReportEngine").as_null_object
-      class WebiReportEngine; end
-      WebiReportEngine.should_receive(:new).once.with(@session, 'en_US').and_return(@webi_report_engine)
-      @webi_report_engine.should_receive(:open).twice.with("1234")
-
-      2.times{@es.open_webi("1234")}
-    end
-
-    specify "#open_webi should pass any specified locale" do
-      @webi_report_engine = mock("WebiReportEngine").as_null_object
-      class WebiReportEngine; end
-      WebiReportEngine.should_receive(:new).once.with(@session, 'en_CA').and_return(@webi_report_engine)
-      @webi_report_engine.should_receive(:open).once.with("1234")
-
-      es = EnterpriseSession.new('cms', 'Administrator', '', :locale => 'en_CA')
-      es.open_webi("1234")
+    describe "#open_webi" do
+      before(:each) do
+        @webi_report_engine = mock("WebiReportEngine").as_null_object
+        @document_instance = mock("DocumentInstance").as_null_object
+        @webi_instance = mock("WebiInstance").as_null_object
+        class WebiReportEngine; end
+        class WebiInstance; end
+        WebiInstance.should_receive(:new).at_least(1).with(@document_instance).and_return(@webi_instance)
+        @webi_report_engine.should_receive(:open).at_least(1).with("1234").and_return(@document_instance)
+      end
+
+      context "when :locale => en_US" do
+        before(:each) do
+          WebiReportEngine.should_receive(:new).once.with(@session, 'en_US').and_return(@webi_report_engine)
+        end
+
+        it "should create a WebiReportEngine and call #open" do
+          @es.open_webi("1234")
+        end
+
+        it "should only create a WebiReportEngine once" do
+          2.times{@es.open_webi("1234")}
+        end
+
+        it "should create a WebiInstance and return it" do
+          @es.open_webi("1234").should == @webi_instance
+        end
+      end
+
+      context "when :locale => en_CA" do
+        before(:each) do
+          WebiReportEngine.should_receive(:new).once.with(@session, 'en_CA').and_return(@webi_report_engine)
+        end
+
+        it "should pass any specified locale" do
+          es = EnterpriseSession.new('cms', 'Administrator', '', :locale => 'en_CA')
+          es.open_webi("1234")
+        end
+      end
     end
   end
 end

data/spec/info_object_spec.rb

@@ -1,111 +1,149 @@
-# 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
+    
+    describe "#docid" do
+      before(:each) do
+        @infoobject.should_receive(:getID).once.with.and_return(1)
+      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)
+      it "should call #getID and return the result" do
+        @obj.docid.should == 1
+      end
 
-      @obj.is_root?.should be_false
+      it "should only call #getID once" do
+        2.times{@obj.docid.should == 1}
+      end
     end
 
-    specify "#parent should return nil if #is_root? == true" do
-      @infoobject.should_receive(:parent_id).once.with.and_return(nil)
+    describe "#is_root?" do
+      context "when #parent_id == nil" do
+        before(:each) do
+          @infoobject.should_receive(:parent_id).once.with.and_return(nil)
+        end
 
-      @obj.parent.should be_nil
-    end
+        it "should return true" do
+          @obj.is_root?.should be_true
+        end
+      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)
+      context "when #parent_id == 0" do
+        before(:each) do
+          @infoobject.should_receive(:parent_id).once.with.and_return(0)
+        end
 
-      parent = @obj.parent
-      parent.should be_instance_of InfoObject
-      parent.obj.should == parent_obj
-    end
+        it "should return true" do
+          @obj.is_root?.should be_true
+        end
+      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)
+      context "when #parent_id == #getID" do
+        before(:each) do
+          @infoobject.should_receive(:parent_id).once.with.and_return(1)
+          @infoobject.should_receive(:getID).once.with.and_return(1)
+        end
 
-      2.times{@obj.parent}
-    end
+        it "should return true" do
+          @obj.is_root?.should be_true
+        end
+      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')
+      context "when #parent_id != nil, 0 or #getID" do
+        before(:each) do
+          @infoobject.should_receive(:parent_id).once.with.and_return(1)
+          @infoobject.should_receive(:getID).once.with.and_return(2)
+        end
 
-      @obj.path.should == '/test obj'
+        it "should return false" do
+          @obj.is_root?.should be_false
+        end
+      end
     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')
+    describe "#parent" do
+      context "when #is_root? == true" do
+        before(:each) do
+          @infoobject.should_receive(:parent_id).once.with.and_return(nil)
+        end
 
-      @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)
+        it "should return nil" do
+          @obj.parent.should be_nil
+        end
+      end
 
-      @obj.path.should == '/test parent/test obj'
+      context "when #is_root? == false" do
+        before(:each) 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)
+        end
+
+        it "should return results of #getParent" do
+          parent = @obj.parent
+          parent.should be_instance_of InfoObject
+          parent.obj.should == @parent_obj
+        end
+
+        it "should only call the underlying #getParent once" do
+          2.times{@obj.parent}
+        end
+      end
     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')
+    describe "#path" do
+      context "when #is_root? == true" do
+        before(:each) do
+          @infoobject.should_receive(:parent_id).once.with.and_return(nil)
+          @infoobject.should_receive(:title).once.with.and_return('test obj')
+        end
 
-      @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)
+        it "should return /#title" do
+          @obj.path.should == '/test obj'
+        end
+      end
 
-      2.times{@obj.path}
+      context "when #is_root? == false" do
+        before(:each) 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)
+        end
+
+        it "should return #parent_title/../#title" do
+          @obj.path.should == '/test parent/test obj'
+        end
+
+        it "should only call the underlying #title, #parent#path, etc. once" do
+          2.times{@obj.path}
+        end
+      end
     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)
+    describe "#<=>" do
+      it "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
-
-      sorted_objs = objs.sort
-      sorted_objs.should == objs.reverse
     end
   end
 end

data/spec/webi_instance_spec.rb

@@ -0,0 +1,112 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'bosdk/webi_instance'
+
+module BOSDK
+  describe WebiInstance do
+    before(:each) do
+      @document_instance = mock("DocumentInstance").as_null_object
+
+      @webi = WebiInstance.new(@document_instance)
+    end
+
+    describe "#new" do
+      it "should store the passed DocumentInstance in @doc_instance" do
+        @webi.instance.should == @document_instance
+      end
+    end
+
+    describe "#objects" do
+      before(:each) do
+        @report_dictionary = mock("ReportDictionary").as_null_object
+        @report_expression_1 = mock("ReportExpression").as_null_object
+        @report_expression_2 = mock("ReportExpression").as_null_object
+        @object_qualification_1 = mock("ObjectQualification").as_null_object
+        @object_qualification_2 = mock("ObjectQualification").as_null_object
+        @object_type_1 = mock("ObjectType").as_null_object
+        @object_type_2 = mock("ObjectType").as_null_object
+
+        @document_instance.should_receive(:getDictionary).once.with.and_return(@report_dictionary)
+
+        @report_dictionary.should_receive(:getChildCount).once.with.and_return(2)
+        @report_dictionary.should_receive(:getChildAt).once.with(0).and_return(@report_expression_1)
+        @report_dictionary.should_receive(:getChildAt).once.with(1).and_return(@report_expression_2)
+
+        @report_expression_1.should_receive(:getName).once.with.and_return("Object1")
+        @report_expression_1.should_receive(:getQualification).once.with.and_return(@object_qualification_1)
+        @report_expression_1.should_receive(:getType).once.with.and_return(@object_type_1)
+
+        @report_expression_2.should_receive(:getName).once.with.and_return("Object2")
+        @report_expression_2.should_receive(:getQualification).once.with.and_return(@object_qualification_2)
+        @report_expression_2.should_receive(:getType).once.with.and_return(@object_type_2)
+
+        @object_qualification_1.should_receive(:toString).once.with.and_return("DIMENSION")
+        @object_qualification_2.should_receive(:toString).once.with.and_return("MEASURE")
+
+        @object_type_1.should_receive(:toString).once.with.and_return("TEXT")
+        @object_type_2.should_receive(:toString).once.with.and_return("NUMERIC")
+
+        @objects = [
+          {:name => 'Object1', :qual => :dimension, :type => :text, :object => @report_expression_1},
+          {:name => 'Object2', :qual => :measure, :type => :numeric, :object => @report_expression_2},
+        ]
+      end
+
+      it "should return an array of report objects" do
+        @webi.objects.should == @objects
+      end
+
+      it "should cache results" do
+        2.times{@webi.objects}
+      end
+    end
+
+    describe "#variables" do
+      before(:each) do
+        @report_dictionary = mock("ReportDictionary").as_null_object
+        @variable_expression_1 = mock("VariableExpression").as_null_object
+        @variable_expression_2 = mock("VariableExpression").as_null_object
+        @object_qualification_1 = mock("ObjectQualification").as_null_object
+        @object_qualification_2 = mock("ObjectQualification").as_null_object
+        @object_type_1 = mock("ObjectType").as_null_object
+        @object_type_2 = mock("ObjectType").as_null_object
+        @formula_expression_1 = mock("FormulaExpression").as_null_object
+        @formula_expression_2 = mock("FormulaExpression").as_null_object
+
+        @document_instance.should_receive(:getDictionary).once.with.and_return(@report_dictionary)
+        @report_dictionary.should_receive(:getVariables).once.with.and_return([@variable_expression_1, @variable_expression_2])
+
+        @variable_expression_1.should_receive(:getName).once.with.and_return("Variable1")
+        @variable_expression_1.should_receive(:getQualification).once.with.and_return(@object_qualification_1)
+        @variable_expression_1.should_receive(:getType).once.with.and_return(@object_type_1)
+        @variable_expression_1.should_receive(:getFormula).once.with.and_return(@formula_expression_1)
+
+        @variable_expression_2.should_receive(:getName).once.with.and_return("Variable2")
+        @variable_expression_2.should_receive(:getQualification).once.with.and_return(@object_qualification_2)
+        @variable_expression_2.should_receive(:getType).once.with.and_return(@object_type_2)
+        @variable_expression_2.should_receive(:getFormula).once.with.and_return(@formula_expression_2)
+
+        @object_qualification_1.should_receive(:toString).once.with.and_return("DIMENSION")
+        @object_qualification_2.should_receive(:toString).once.with.and_return("MEASURE")
+
+        @object_type_1.should_receive(:toString).once.with.and_return("TEXT")
+        @object_type_2.should_receive(:toString).once.with.and_return("NUMERIC")
+
+        @formula_expression_1.should_receive(:getValue).once.with.and_return('If([Object1]="Object1";"Yes";"False")')
+        @formula_expression_2.should_receive(:getValue).once.with.and_return('Sum([Object2])')
+
+        @variables = [
+          {:name => 'Variable1', :qual => :dimension, :type => :text, :formula => 'If([Object1]="Object1";"Yes";"False")', :variable => @variable_expression_1},
+          {:name => 'Variable2', :qual => :measure, :type => :numeric, :formula => 'Sum([Object2])', :variable => @variable_expression_2},
+        ]
+      end
+
+      it "should return an array of variables" do
+        @webi.variables.should == @variables
+      end
+
+      it "should cache results" do
+        2.times{@webi.variables}
+      end
+    end
+  end
+end

data/spec/webi_report_engine_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
 require 'bosdk/webi_report_engine'
 
@@ -13,21 +12,28 @@ module BOSDK
       module ReportEngines; module ReportEngineType; module WI_REPORT_ENGINE; end; end; end
       @report_engines.should_receive(:getService).at_least(1).with(ReportEngines::ReportEngineType::WI_REPORT_ENGINE).and_return(@webi_report_engine)
       @webi_report_engine.should_receive(:setLocale).at_least(1).with("en_US")
-      #@enterprise_session.should_receive(:setAttribute).at_least(1).with("widReportEngine", @webi_report_engine)
 
       @wre = WebiReportEngine.new(@enterprise_session)
     end
 
-    specify "#new should allow you to set the locale" do
-      @webi_report_engine.should_receive(:setLocale).once.with("en_CA")
+    describe "#new" do
+      before(:each) do
+        @webi_report_engine.should_receive(:setLocale).once.with("en_CA")
+      end
 
-      WebiReportEngine.new(@enterprise_session, "en_CA")
+      it "should allow you to set the locale" do
+        WebiReportEngine.new(@enterprise_session, "en_CA")
+      end
     end
 
-    specify "#open should call the underlying #openDocument with the supplied docid" do
-      @webi_report_engine.should_receive(:openDocument).once.with("1234")
+    describe "#open" do
+      before(:each) do
+        @webi_report_engine.should_receive(:openDocument).once.with("1234")
+      end
 
-      @wre.open("1234")
+      it  "should call the underlying #openDocument with the supplied docid" do
+        @wre.open("1234")
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bosdk
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
+  version: 1.1.0
 platform: universal-java-1.6
 authors: 
   - Shane Emmons
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-03 00:00:00 -05:00
+date: 2010-02-09 00:00:00 -05:00
 default_executable: boirb
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -39,28 +39,34 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
+  - LICENSE
   - README.rdoc
-  - MIT-LICENSE
 files: 
+  - .document
+  - .gitignore
+  - LICENSE
   - README.rdoc
-  - MIT-LICENSE
-  - bosdk.gemspec
   - Rakefile
+  - VERSION
   - bin/boirb
+  - bosdk.gemspec
   - lib/bosdk.rb
   - lib/bosdk/enterprise_session.rb
   - lib/bosdk/info_object.rb
+  - lib/bosdk/webi_instance.rb
   - lib/bosdk/webi_report_engine.rb
+  - spec/bosdk_spec.rb
   - spec/enterprise_session_spec.rb
   - spec/info_object_spec.rb
+  - spec/webi_instance_spec.rb
   - spec/webi_report_engine_spec.rb
 has_rdoc: true
 homepage: http://semmons99.github.com/bosdk
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+  - --charset=UTF-8
 require_paths: 
   - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -82,5 +88,9 @@ rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: JRuby Business Object Java SDK wrapper
-test_files: []
-
+test_files: 
+  - spec/bosdk_spec.rb
+  - spec/enterprise_session_spec.rb
+  - spec/info_object_spec.rb
+  - spec/webi_instance_spec.rb
+  - spec/webi_report_engine_spec.rb