robust_excel_ole 0.3.9 → 0.4

data/Changelog

@@ -1,6 +1,23 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.4] - 2016-03-16
+
+### Added
+- options visible, displayalerts in unobtrusively, for_reading, for_writing
+
+## [0.3.8] - 2016-02-12
+
+### Added
+ - mark down comments
+ - trace
+ - Excel, Book: respond_to?, methods, special_methods, special_methods 
+
+## [0.3.9] - 2016-03-03
+
+### Added
+- methods, respond_to?, own_methods in new module General
+- yardopts option --legacy for ruby 1.8.6. such that class Book is included in the documentation
 
 ## [0.3.8] - 2016-02-12
 

data/README.rdoc

@@ -125,7 +125,7 @@ The method +unobtrusively+ enables the user to read or modify a workbook, no mat
 
 Some options determine the Excel instance in which a closed workbook is opened. The options +:reuse (default) indicates that the closed workbook is opened in the Excel instance where the workbooks is opened, if such an Excel instance exists, otherwise that another Excel instance is reused. The option +:hidden+ provokes that the closed workbook is opened in a separate Excel instance that is not visible and has no DisplayAlerts. Any following closed workbook would be opened in this Excel instance as well when using this option. Moreover, an Excel instance can be given directly where to open the closed workbook.
 
-Further options are +:read_only+, +:readonly_excel+, and +:keep_open. The option +:readonly_excel+ chooses whether a book that is opened in read only mode. If the workbook is opened as read only, then the option +:readonly_excel+ determines whether to close the workbook and open it as writable in the Excel instance where it was open so far, or to open it as writable in another running Excel instance, if such an instance exists, or to open it in a new Excel instance.
+Further options are +:read_only+, +:readonly_excel+, and +:keep_open. The option +:readonly_excel+ chooses whether a book that is opened in read only mode. If the workbook is opened as read only, then the option +:readonly_excel+ determines whether to close the workbook and open it as writable in the Excel instance where it was open so far, or to open it as writable in another running Excel instance, if such an instance exists, or to open it in a new Excel instance. Moreover, there are the options +:visible+ and +:displayalerts+.
 
   Book.unobtrusively('workbook.xls', :reuse, :read_only => false, :keep_open => false) do |book|
     # some modification

data/README_detail.rdoc

@@ -179,8 +179,8 @@ One option chooses the Excel instance in which a closed workbook is opened. The
 
 Options are the following:
 
-:reuse (default) : open a closed workbook in the Excel instance of the workbook, if it exists, otherwise reuse another Excel
-:hidden          : open a closed workbook in one separate Excel instance that is not visible and has no displayalerts
++:reuse+:: (default) : open a closed workbook in the Excel instance of the workbook, if it exists, otherwise reuse another Excel
++:hidden+::          : open a closed workbook in one separate Excel instance that is not visible and has no displayalerts
 <excel-instance> : open a closed workbooks in the given Excel instance
                
 +:read_only+:: Open the workbook unobtrusively for reading only  (default: false)
@@ -189,6 +189,8 @@ Options are the following:
                      false (default) open it as writable in another running excel instance, if it exists, 
                                      otherwise open in a new excel instance
 +:keep_open+:: let the workbook open after unobtrusively opening (default: false)
++:visible+::   change the Excel into visible or invisible
++:displayalerts+:: change the Excel into enable or disable displayalerts
 
   Book.unobtrusively('workbook.xls') do |book|
     # some modification

data/lib/robust_excel_ole.rb

@@ -1,6 +1,5 @@
 require "win32ole"
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/general')
-require File.join(File.dirname(__FILE__), 'robust_excel_ole/utilities')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/excel')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/bookstore')
 require File.join(File.dirname(__FILE__), 'robust_excel_ole/book')

data/lib/robust_excel_ole/book.rb

@@ -2,8 +2,6 @@
 
 require 'weakref'
 
-include Utilities
-
 module RobustExcelOle
 
   class Book
@@ -12,6 +10,7 @@ module RobustExcelOle
     attr_accessor :ole_workbook
     attr_accessor :stored_filename
     attr_accessor :options
+    attr_accessor :can_be_closed
 
     alias ole_object ole_workbook
 
@@ -196,12 +195,7 @@ module RobustExcelOle
           @excel = self.class.excel_of(options[:excel])
         end
       end
-      # if :excel => :new or (:excel => :reuse but could not reuse)
-      #   keep the old values for :visible and :displayalerts, set them only if the parameters are given
-      if (not excel_options)
-        @excel.displayalerts = options[:displayalerts] unless options[:displayalerts].nil?
-        @excel.visible = options[:visible] unless options[:visible].nil?
-      end
+      apply_options(options) unless excel_options
     end
 
     def ensure_workbook(file, options)     # :nodoc: #
@@ -305,6 +299,7 @@ module RobustExcelOle
           workbooks.Add if @excel.Version == "12.0" && count == 0
           workbooks.Open(filename,{ 'ReadOnly' => options[:read_only] })
           workbooks.Item(1).Close if @excel.Version == "12.0" && count == 0
+          @can_be_closed = false
         rescue WIN32OLERuntimeError => msg
           trace "WIN32OLERuntimeError: #{msg.message}" 
           if msg.message =~ /800A03EC/
@@ -395,6 +390,8 @@ module RobustExcelOle
     # @option opts [Boolean] :read_only whether the file is opened for read-only
     # @option opts [Boolean] :readonly_excel behaviour when workbook is opened read-only and shall be modified
     # @option opts [Boolean] :keep_open whether the workbook shall be kept open after unobtrusively opening
+    # @option opts [Boolean] :displayalerts  true, or false (default)
+    # @option opts [Boolean] :visible        true, or false (default) 
     #  options: 
     #   :if_closed :   if the workbook is closed, then open it in
     #                    :reuse  -> the Excel instance of the workbook, if it exists, 
@@ -406,7 +403,8 @@ module RobustExcelOle
     #                    true:  closes it and open it as writable in the Excel instance where it was open so far
     #                    false (default)   opens it as writable in another running excel instance, if it exists,
     #                                      otherwise open in a new Excel instance.
-    #  :keep_open: lets the workbook open after unobtrusively opening (default: false)
+    # :displayalerts enables DisplayAlerts in Excel  
+    # :visible       makes visible in Excel 
     # @return [Book] a workbook
     def self.unobtrusively(file, if_closed = nil, opts = { }, &block) 
       if if_closed.is_a? Hash
@@ -417,7 +415,7 @@ module RobustExcelOle
       options = {
         :read_only => false,
         :readonly_excel => false,
-        :keep_open => false,
+        :keep_open => false
       }.merge(opts)
       book = bookstore.fetch(file, :prefer_writable => (not options[:read_only]))
       was_not_alive_or_nil = book.nil? || (not book.alive?)
@@ -450,6 +448,8 @@ module RobustExcelOle
                                          open(file, :force_excel => :new, :read_only => options[:read_only])
             end
           end
+        book.excel.displayalerts = options[:displayalerts] unless options[:displayalerts].nil?
+        book.excel.visible = options[:visible] unless options[:visible].nil?
         yield book
       ensure
         book.save if (was_not_alive_or_nil || was_saved || ((not options[:read_only]) && (not was_writable))) && (not options[:read_only]) && book && (not book.saved)
@@ -457,6 +457,7 @@ module RobustExcelOle
         if (not was_not_alive_or_nil) && (not options[:read_only]) && (not was_writable) && options[:readonly_excel]
           open(file, :force_excel => book.excel, :if_obstructed => :new_excel, :read_only => true)
         end
+        @can_be_closed = true if options[:keep_open] && book
         book.close if (was_not_alive_or_nil && (not now_alive) && (not options[:keep_open]) && book)
       end
     end
@@ -807,8 +808,9 @@ module RobustExcelOle
     def self.excel_class    # :nodoc: #
       @excel_class ||= begin
         module_name = self.parent_name
-        "#{module_name}::Excel".constantsize
+        "#{module_name}::Excel".constantize
       rescue NameError => e
+        #trace "excel_class: NameError: #{e}"
         Excel
       end
     end

data/lib/robust_excel_ole/bookstore.rb

@@ -1,8 +1,6 @@
 
 # -*- coding: utf-8 -*-
 
-include Utilities
-
 module RobustExcelOle
 
   class Bookstore

data/lib/robust_excel_ole/excel.rb

@@ -2,8 +2,6 @@
 
 require 'timeout'
 
-include Utilities
-
 module RobustExcelOle    
 
   class Excel

data/lib/robust_excel_ole/general.rb

@@ -1,3 +1,9 @@
+LOG_TO_STDOUT = true      unless Object.const_defined?(:LOG_TO_STDOUT)
+REO_LOG_DIR   = ""        unless Object.const_defined?(:REO_LOG_DIR)
+REO_LOG_FILE  = "reo.log" unless Object.const_defined?(:REO_LOG_FILE)
+  
+File.delete REO_LOG_FILE rescue nil
+
 include Enumerable
 
 module General
@@ -76,7 +82,25 @@ module General
     path
   end
 
-  module_function :absolute_path, :canonize, :normalize, :rot
+  def trace(text)
+    if LOG_TO_STDOUT 
+      puts text
+    else
+      if REO_LOG_DIR.empty?
+        homes = ["HOME", "HOMEPATH"]
+        home = homes.find {|h| ENV[h] != nil}
+        reo_log_dir = ENV[home]
+      else
+        reo_log_dir = REO_LOG_DIR
+      end
+      File.open(reo_log_dir + "/" + REO_LOG_FILE,"a") do | file |
+        file.puts text
+      end
+    end
+  end
+
+
+  module_function :absolute_path, :canonize, :normalize, :rot, :trace
 
   class VBAMethodMissingError < RuntimeError  # :nodoc: #
   end
@@ -172,8 +196,6 @@ class Module   # :nodoc: #
   end
 end
 
-REO = General
-
 module MethodHelpers
 
   def respond_to?(meth_name, include_private = false)  # :nodoc: #    
@@ -186,3 +208,5 @@ module MethodHelpers
   end
 
 end
+
+REO = General

data/lib/robust_excel_ole/sheet.rb

@@ -1,7 +1,5 @@
 # -*- coding: utf-8 -*-
 
-include Utilities
-
 module RobustExcelOle
 
   class Sheet

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "0.3.9"
+  VERSION = "0.4"
 end

data/spec/book_specs/book_unobtr_spec.rb

@@ -124,6 +124,25 @@ describe Book do
         }.to raise_error(ExcelError, "receiver instance is neither an Excel nor a Book")
       end
 
+      it "should be visible and displayalerts" do
+        Book.unobtrusively(@simple_file, :visible => true, :displayalerts => true) do |book|
+          book.should be_a Book
+          book.should be_alive
+          book.excel.visible.should be_true
+          book.excel.displayalerts.should be_true
+        end
+      end
+
+      it "should be visible" do
+        excel = Excel.new(:reuse => false, :displayalerts => true)
+        Book.unobtrusively(@simple_file, :visible => true) do |book|
+          book.should be_a Book
+          book.should be_alive
+          book.excel.visible.should be_true
+          book.excel.displayalerts.should be_true
+        end
+      end
+
     end
 
     context "with an open book" do
@@ -273,6 +292,19 @@ describe Book do
         sheet[1,1].value.should_not == old_cell_value
       end
 
+      it "should set can_be_closed" do
+        Excel.close_all
+        Book.unobtrusively(@simple_file, :keep_open => true) do |book|
+          book.should be_a Book
+          book.should be_alive
+          book.can_be_closed.should be_false
+          @book2 = book
+        end
+        @book2.should be_alive
+        book = Book.open(@simple_file)
+        book.can_be_closed.should be_true
+      end
+
       # book shall be reanimated even with :hidden
       it "should use the excel of the book and keep open the book" do
         excel = Excel.new(:reuse => false)

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: robust_excel_ole
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 3
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 9
-  version: 0.3.9
+  - 4
+  version: "0.4"
 platform: ruby
 authors: 
 - traths
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2016-03-02 00:00:00 +01:00
+date: 2016-03-16 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -89,7 +88,6 @@ files:
 - lib/robust_excel_ole/robustexcelole.sublime-project
 - lib/robust_excel_ole/robustexcelole.sublime-workspace
 - lib/robust_excel_ole/sheet.rb
-- lib/robust_excel_ole/utilities.rb
 - lib/robust_excel_ole/version.rb
 - lib/spec_helper.rb
 - reo.bat

data/lib/robust_excel_ole/utilities.rb

@@ -1,28 +0,0 @@
-LOG_TO_STDOUT = true      unless Object.const_defined?(:LOG_TO_STDOUT)
-REO_LOG_DIR   = ""        unless Object.const_defined?(:REO_LOG_DIR)
-REO_LOG_FILE  = "reo.log" unless Object.const_defined?(:REO_LOG_FILE)
-  
-File.delete REO_LOG_FILE rescue nil
-
-module Utilities  # :nodoc: #
-
-  def trace(text)
-    if LOG_TO_STDOUT 
-      puts text
-    else
-      if REO_LOG_DIR.empty?
-        homes = ["HOME", "HOMEPATH"]
-        home = homes.find {|h| ENV[h] != nil}
-        reo_log_dir = ENV[home]
-      else
-        reo_log_dir = REO_LOG_DIR
-      end
-      File.open(reo_log_dir + "/" + REO_LOG_FILE,"a") do | file |
-        file.puts text
-      end
-    end
-  end
-
-  module_function :trace
-
-end