esumitra-test_off 0.2

data/features/step_definitions/word_app_steps.rb

@@ -0,0 +1,121 @@
+require File.dirname(__FILE__) + '/../../lib/msword.rb'
+
+include MSWordUtils
+
+#-----------------------------------------
+# Scenario: Instantiate a word application
+#-----------------------------------------
+Given /^I have Word installed$/ do
+  @wdApp = Word.new
+end
+
+When /^I ask for the word version$/ do
+  @version = @wdApp.Version
+end
+
+Then /^I should get back the word version$/ do
+  @version.should_not == nil
+  @wdApp.Quit(0)
+end
+#-----------------------------------------
+# Scenario: Get correct template count for word application
+#-----------------------------------------
+Given /^a new Word object$/ do
+  @wdApp = Word.new
+end
+
+When /^I ask for a multiple level member$/ do
+  @tCount = @wdApp.Templates.Count
+end
+
+Then /^I should get back the correct member value$/ do
+  @tCount.should == 2
+  @wdApp.Quit(0)
+end
+#-----------------------------------------
+# Scenario: Call method with arguments
+#-----------------------------------------
+When /^I call a method with an argument$/ do
+  @points = @wdApp.CentimetersToPoints(1)
+end
+
+Then /^I should get the correct method value$/ do
+  @points.should be_close(28.34646,0.0001)
+  @wdApp.Quit(0)
+end
+#-----------------------------------------
+# Scenario: Call static method with a code block
+#-----------------------------------------
+Given /^nothing$/ do
+end
+
+When /^I call the Word.open method with a block$/ do
+  @version = Word.open{|app| app.Version}
+end
+
+Then /^I should get the correct result from the block$/ do
+  @version.should eql("11.0")
+end
+#-----------------------------------------
+# Scenario: Call a function with no arguments in a doc
+#-----------------------------------------
+When /^I pass a block to execute macro (.+) in document at (.+)$/ do |macro_name, filename|
+  @result = Word.open{ |app| 
+    filepath = File.expand_path(File.dirname(__FILE__) + '/' + filename)
+    macroDoc = app.Documents.Open(filepath)
+    rs = app.Run(macro_name)
+    macroDoc.Close(0)
+    rs
+  }
+end
+
+Then /^I should get the no arg return value (.+)$/ do |value|
+  @result.to_s.should eql(value)
+end
+#-----------------------------------------
+# Scenario: Call a function with multiple arguments in a doc
+#-----------------------------------------
+When /^I pass a block to execute macro (.+) with arguments (.+) and (.+) in document at (.+)$/ do |macro_name, arg1,arg2, filename|
+  @result = Word.open{ |app|
+    filepath = File.expand_path(File.dirname(__FILE__) + '/' + filename)
+    macroDoc = app.Documents.Open(filepath)
+    rs = app.Run(macro_name,arg1,arg2)
+    macroDoc.Close(0)
+    rs
+  }
+end
+
+Then /^I should get the multiple args return value (.+)$/ do |value|
+  @result.should eql(value)
+end
+#-----------------------------------------
+# Scenario: Open an existing document
+#-----------------------------------------
+Given /^I open an existing document at (.+)$/ do |filename|
+  @doc = Document.new(filename)
+end
+
+When /^I read the document text$/ do
+  @text = @doc.Range.Text
+end
+
+Then /^I should be able to write the text$/ do
+  !@text.nil?
+  @doc.close
+end
+#-----------------------------------------
+# Scenario: Execute a simple macro in a document
+#-----------------------------------------
+Given /^I open a document with a simple macro at (.+)$/ do |filename|
+  @doc = Document.new(filename)
+end
+
+When /^I call the simple macro named (.+)$/ do |macro_name|
+  puts "#{@doc.Name}!#{macro_name}"
+  @fResp = @doc.Application.Run("#{@doc.Name}!#{macro_name}")
+end
+
+Then /^the simple macro should return truet$/ do
+  @doc.close
+  @fResp
+end

data/features/step_definitions/word_doc_steps.rb

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + '/../../lib/msword.rb'
+
+include MSWordUtils
+
+NormalDocPath = File.expand_path(File.dirname(__FILE__) + "/../data/DocWithoutMacros.doc")
+MacroDocPath= File.expand_path(File.dirname(__FILE__) + "/../data/DocWithMacros.doc")
+NewDocPath=File.expand_path(File.dirname(__FILE__) + "/../data")
+
+Given /^an existing word document$/ do
+  File.exists?(NormalDocPath).should be_true 
+end
+
+When /^I open the existing document$/ do
+  @doc = Document.new(NormalDocPath)
+end
+
+Then /^I should get the text successfully$/ do
+  @doc.Range.Text.size.should_not equal(0)
+  @doc.close
+end
+
+Given /^a random document name$/ do
+  @new_file_path = "#{NewDocPath}/#{Time.now.to_i}.doc"
+end
+
+When /^I create a new document$/ do
+  @doc = Document.new
+end
+
+Then /^I should be able to save the new document correctly$/ do
+  @doc.SaveAs(@new_file_path)
+  @doc.close
+  File.exists?(@new_file_path).should be_true
+  File.delete(@new_file_path)
+end
+
+When /^I pass a code block to get the paragraph count$/ do
+  Document.open(NormalDocPath) { |doc|
+    @pars = doc.Paragraphs.Count
+  }
+end
+
+Then /^I should get the paragraph count correctly$/ do
+  @pars.should_not equal(0)
+end
+
+Given /^an existing document with macros$/ do
+  @doc = Document.new(MacroDocPath)
+end
+
+When /^I try to execute a simple macro$/ do
+  @macro_result = @doc.macro_SimpleMacroNoParams
+end
+
+Then /^I should get the correct result from the simple macro$/ do
+  @macro_result.should be_true
+  @doc.close
+end
+
+When /^I try to execute a document macro with arguments$/ do
+  @macro_result = @doc.macro_SimpleMacroMultipleParams("string1","string2")
+end
+
+Then /^I should get the correct result from the document macro with arguments$/ do
+  @macro_result.should == "string1+string2"
+  @doc.close
+end

data/features/word_app.feature

@@ -0,0 +1,34 @@
+@word
+Feature: Word Application Feature
+  Provide easy interface to the
+  "Word.Application" COM object
+
+  Scenario: Instantiate a word application
+    Given I have Word installed
+    When I ask for the word version 
+    Then I should get back the word version
+
+  Scenario: Call application multiple level member method without arguments
+    Given a new Word object
+    When I ask for a multiple level member
+    Then I should get back the correct member value
+  
+  Scenario: Call application method with arguments
+    Given a new Word object
+    When I call a method with an argument
+    Then I should get the correct method value
+    
+  Scenario: Call application static method with a code block
+    Given nothing
+    When I call the Word.open method with a block
+    Then I should get the correct result from the block
+
+  Scenario: Use application to call function with no arguments
+    Given nothing
+    When I pass a block to execute macro Module1.SimpleMacroNoParams in document at ../data/DocWithMacros.doc
+    Then I should get the no arg return value true
+
+  Scenario: Use application to call a function with multiple arguments
+    Given nothing
+    When I pass a block to execute macro Module1.SimpleMacroMultipleParams with arguments string1 and string2 in document at ../data/DocWithMacros.doc
+    Then I should get the multiple args return value string1+string2

data/features/word_doc.feature

@@ -0,0 +1,30 @@
+@document
+Feature:
+  Provide easy interface to the
+  "Word.Document" COM object
+  
+  Scenario: Open existing document
+    Given an existing word document
+    When I open the existing document
+    Then I should get the text successfully
+    
+  Scenario: Create new document
+    Given a random document name
+    When I create a new document
+    Then I should be able to save the new document correctly
+    
+  Scenario: Open existing document and execute code block
+    Given nothing
+    When I pass a code block to get the paragraph count
+    Then I should get the paragraph count correctly
+  
+  Scenario: Open existing document and run macro
+    Given an existing document with macros
+    When I try to execute a simple macro
+    Then I should get the correct result from the simple macro
+
+  Scenario: Open existing document and run a macro with arguments
+    Given an existing document with macros
+    When I try to execute a document macro with arguments
+    Then I should get the correct result from the document macro with arguments
+  

data/lib/msword.rb

@@ -0,0 +1,79 @@
+# word utilities
+
+require 'win32ole'
+require 'Win32API'
+
+module MSWordUtils
+  class WdSaveOptions
+    WdDoNotSaveChanges = 0
+    WdSaveChanges = -1
+  end
+
+  # Document 
+  # create a new document, if path specified, opens the document at the path
+  # if no path specified, creates a new document
+  # options :read_only => ReadOnly, :visible => Visible  
+  class Document
+    def initialize(path = nil,opts = {})      
+      @app = WIN32OLE.new('Word.Application')
+      read_opt = opts[:read_only]?true:false
+      if path.nil?        
+        @doc = @app.Documents.Add   
+      else
+        @doc = @app.Documents.Open(path,true,read_opt)
+      end
+    end
+    
+    def close(saveDoc = false)
+      saveOpt = (saveDoc)?(WdSaveOptions::WdSaveChanges):(WdSaveOptions::WdDoNotSaveChanges)
+      @doc.Close(saveOpt)
+      @app.Quit(WdSaveOptions::WdDoNotSaveChanges)
+    end
+
+    def method_missing(msg,*args)
+      if ((msg.id2name=~/^macro_/) == 0)
+        macro_name = $'
+        @app.Run(macro_name,*args)
+      else
+        @doc.send(msg,*args)
+      end
+    end
+    
+    def self.open(path,read_only=true)
+      app = WIN32OLE.new('Word.Application')
+      doc = app.Documents.Open(path,true,read_only)
+      begin
+        yield(doc) if block_given?
+      rescue => e
+        puts e.message
+      ensure
+        save_flag=(read_only)?(WdSaveOptions::WdDoNotSaveChanges):(WdSaveOptions::WdSaveChanges)
+        doc.Close(save_flag)
+        app.Quit(WdSaveOptions::WdDoNotSaveChanges)
+      end      
+    end
+    
+  end
+  
+  # Application
+  class Word
+    def initialize
+      @app = WIN32OLE.new('Word.Application')
+    end
+    
+    def method_missing(msg,*args)
+      @app.send(msg,*args)
+    end
+
+    def self.open()
+      app = WIN32OLE.new('Word.Application')
+      begin
+        yield(app) if block_given?
+      rescue => e
+        puts e.message
+      ensure
+        app.Quit(WdSaveOptions::WdDoNotSaveChanges)
+      end
+    end
+  end
+end

data/test/rspec/document_spec.rb

@@ -0,0 +1,52 @@
+# rspec tests for document class
+# run with 'spec -c -f specdoc document_spec.rb' for BDD process
+# run with 'rake rspec_tests' to run as standard process'
+
+require File.dirname(__FILE__) + '/../../lib/msword.rb'
+
+include MSWordUtils
+
+describe Document do
+  NewDocPath=File.expand_path(File.dirname(__FILE__) + "/../../features/data")
+  NormalDocPath = NewDocPath + '/DocWithoutMacros.doc'
+  MacroDocPath = NewDocPath + '/DocWithMacros.doc'
+  
+  it "should open an existing document" do
+    doc = Document.new(NormalDocPath)
+    doc.Range.Text.size.should_not equal(0)
+    doc.close
+  end
+
+  it "should open a new document" do
+    new_file_path = "#{NewDocPath}/#{Time.now.to_i}.doc"
+    doc = Document.new
+    doc.SaveAs(new_file_path)
+    doc.close
+    File.exists?(new_file_path).should be_true
+    File.delete(new_file_path)  
+  end
+
+  it "should open an existing document with a code block" do
+    result = Document.open(NormalDocPath) {|doc|
+      doc.Paragraphs.Count
+    }
+    result.should_not equal(0)
+  end
+  
+  it "should run a macro with no arguments in an existing document" do
+    doc = Document.new(MacroDocPath)
+    result = doc.macro_SimpleMacroNoParams
+    result.should be_true
+    doc.close
+  end
+  
+  it "should run a macro with multiple arguments in an existing document" do
+    arg1='string1'
+    arg2='string2'
+    doc = Document.new(MacroDocPath)
+    result = doc.macro_SimpleMacroMultipleParams(arg1,arg2)
+    result.should == "#{arg1}+#{arg2}"
+    doc.close
+  end
+
+end

data/test/rspec/word_spec.rb

@@ -0,0 +1,59 @@
+# rspec tests for word class
+require File.dirname(__FILE__) + '/../../lib/msword.rb'
+
+include MSWordUtils
+
+describe Word do
+  DocWithMacro = File.expand_path(File.dirname(__FILE__) + "/../../features/data/DocWithMacros.doc")
+  Macro1 = "Module1.SimpleMacroNoParams"
+  Macro2 = "Module1.SimpleMacroMultipleParams"
+  
+  it "should instantiate as an object" do
+    word = Word.new
+    version = word.Version
+    version.should == ("11.0" || "12.0")
+    word.Quit(0)
+  end
+  
+  it "should return a correct multiple level member value" do
+    word = Word.new
+    templates = word.Templates.Count
+    word.Quit(0)
+    templates.should > 0
+  end
+  
+  it "should return the correct value for a method with an argument" do
+    word = Word.new
+    points = word.CentimetersToPoints(1)
+    word.Quit(0)
+    points.should be_close(28.34646,0.0001)
+  end
+  
+  it "should return the correct value for code block" do
+    version = Word.open{|app| app.Version}
+    version.should == ("11.0" || "12.0")
+  end
+  
+  it "should return the correct value for a macro function with no arguments" do
+    result = Word.open{|app| 
+      macroDoc = app.Documents.Open(DocWithMacro)
+      r = app.Run(Macro1)
+      macroDoc.Close(0)
+      r
+    }
+    result.should be_true
+  end
+
+  it "should return the correct value for a macro function with multiple arguments" do
+    arg1 = 'string1'
+    arg2 = 'string2'
+    result = Word.open{|app| 
+      macroDoc = app.Documents.Open(DocWithMacro)
+      r = app.Run(Macro2,arg1,arg2)
+      macroDoc.Close(0)
+      r
+    }
+    result.should == "#{arg1}+#{arg2}"
+  end
+
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: esumitra-test_off
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Edward Sumitra
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A library for Behavior Driven Development of VBA code
+email: ed_sumitra@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/msword.rb
+- features/word_app.feature
+- features/word_doc.feature
+- features/data/DocWithMacros.doc
+- features/data/DocWithoutMacros.doc
+- features/step_definitions/word_app_steps.rb
+- features/step_definitions/word_doc_steps.rb
+- test/rspec/document_spec.rb
+- test/rspec/word_spec.rb
+has_rdoc: false
+homepage: http://github.com/esumitra/test_off
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- MS Office, rspec and cucumber to run tests
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A library for Behavior Driven Development of VBA code
+test_files: []
+