robust_excel_ole 0.2.2.1 → 0.2.3

data/README.rdoc

@@ -128,13 +128,19 @@ Return the file name of the book with the absolute path that contains slash (/)
 
 === Access a sheet.
 
-A sheet object can be accessed with a Book#[] method.
+A sheet object can be accessed with a Book#[] method via an integer number.
 
   sheet = book[0]
 
 Access a sheet object with the sheet name.
 
-  book['Sheet1']
+  sheet = book['Sheet1']
+
+Access sheet objects using the methods Book#each.
+
+  book.each do |sheet|               
+    # do something with sheet
+  end
 
 === Access a row or a column.
 
@@ -146,11 +152,11 @@ A sheet object is enumerable. Use the methods Sheet#each_column, Sheet#each_row
   end
 
   sheet.each_row do |row|
-    # do something with row_range
+    # do something with row
   end
 
-  sheet.each_column do |column_range|
-    # do something with column_range
+  sheet.each_column do |column|
+    # do something with column
   end
 
 === Access a cell.
@@ -164,7 +170,49 @@ Read a cell from a range object.
   row_range[0]  => first cell in row_range
   column_range[1] => second cell in column_range
 
-= Examples
+Read the value of a cell.
+
+  cell = sheet[0,0]
+  cell.value  => value of the cell.
+
+Write a cell
+
+  sheet[0,0] = "new_value"
+
+
+=== Access a range of a row or column. 
+
+Access a range of a row.
+
+  sheet.row_range(0)  => first row
+  sheet.row_range(0, 0..2 )  => first three cells of the first row  
+
+Access a range of a column.
+
+  sheet.col_range(2)  => third column
+  sheet.col_range(2, 0..1)  => first two cells of the third column
+
+
+=== Add a sheet
+
+Add a new sheet.
+
+  book.add_sheet
+
+Add a new sheet with a name.
+
+  book.add_sheet(:as => 'new_sheet')
+
+Add a new sheet with a name before another sheet.
+
+  book.add_sheet(:as => 'new_sheet2', :before => another_sheet)
+
+Add a copy of a sheet with a name after another sheet.
+
+  book.add_sheet(sheet, :as => 'sheet_copy', :after => another_sheet)
+
+
+=== Examples
 
 Include robust_excel_ole.
 
@@ -176,11 +224,11 @@ Open a book.
 
   book = Book.open('simple.xls')
 
-Access a sheet.
+Access a sheet via its name.
 
-  sheet = book[0]
+  sheet = book['Sheet1']
   
-Change a cell.
+Change the first cell.
 
   sheet[0,0] = "new"
   
@@ -188,7 +236,7 @@ Save the book.
 
   book.save
 
-Save it with a different name, and overwrite if a file with this name exists.
+Save the book with a different name, and overwrite if a file with this name exists.
 
   book.save_as('different_simple.xls', :if_exists => :overwrite)
 
@@ -198,38 +246,38 @@ Close the book.
 
 === Example 2
 
-Open the book again in a new Excel application and make it visible.
+Open the book in a new Excel application and make it visible.
 
-  book1.open('simple.xls', :reuse => false, :visible => true)
+  book.open('simple.xls', :reuse => false, :visible => true)
 
-Add a sheet.
+Add a copy of the first sheet after the second sheet.
 
-  book1.add_sheet
+  book.add_sheet(book[0], :as => 'Sheet1_copy', :after => book[1])
 
-Open a new book with the same name in a new Excel. Leave the unsaved book in the old Excel.
+Open a new book with the same name in a new Excel. Leave the book that contains unsaved changes in the old Excel.
 
-  book2.open('simple.xls', :if_unsaved => :new_app)
+  new_book.open('simple.xls', :if_unsaved => :new_app)
 
-Access a sheet and Change a cell.
+Access a sheet and change a cell.
 
-  sheet = book2[0]
-  sheet[0,0] = "another"
+  sheet = new_book[0]
+  sheet[1,1] = "another"
 
-Open another book with the same name in the running Excel. Close the unsaved book. 
+Open another book with the same name in the running Excel. The book that contains unsaved changes will be closed before. 
 
-  book3.open('simple.xls', :if_unsaved => :forget)
+  third_book.open('simple.xls', :if_unsaved => :forget)
 
 Add a sheet.
 
-  book3.add_sheet
+  third_book.add_sheet
 
 Close the book without saving it.
 
-  book3.close(:if_unsaved => :forget)
+  third_book.close(:if_unsaved => :forget)
 
 Close the first book and save it before.
 
-  book1.close(:if_unsaved => :save)
+  book.close(:if_unsaved => :save)
 
 === Example 3
 
@@ -246,11 +294,11 @@ Change its cell.
   sheet = book2[0]
   sheet[0,0] = "new"
 
-Open a book with the same name in a different path. Save and close the unsaved book before.
+Open a book with the same name in a different path. The old book that was modified will be saved and closed before.
 
   book3 = Book.open('simple.xls', :if_obstructed => :save)
 
-Open a book with the same name in a different path. The other book is closed, since it is saved. 
+Open a book with the same name in a different path. The other book will be closed, because it does not contain unsaved changes.
 
   book4 = Book.open('more/simple.xls', :if_obstructed => :close_if_unsaved)
 

data/examples/edit_sheets/example_access_sheets_and_cells.rb

@@ -0,0 +1,53 @@
+# example_access_sheets_and_cells.rb: 
+# access sheets, print cells, rows, and columns of a sheet
+
+require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
+require File.join(File.dirname(__FILE__), '../../spec/helpers/create_temporary_dir')
+require "fileutils"
+
+include RobustExcelOle
+
+Excel.close_all
+begin
+  dir = create_tmpdir
+  simple_file = dir + 'simple.xls'
+  simple_save_file = dir + 'simple_save.xls'
+  File.delete simple_save_file rescue nil
+  book = Book.open(simple_file)      # open a book
+  sheet = book[0]                    # access a sheet via integer 
+  cell = sheet[0,0]                  # access the first cell
+  puts "1st cell: #{cell.value}"     # put the value of the first cell
+  sheet[0,0] = "complex"             # write a value into a cell
+  puts "new cell: #{sheet[0,0].value}"
+  puts "all cells:"
+  sheet.each do |cell|               # access all cells
+    puts "#{cell.value}"             #   for each row: for every column: put the value of the cells
+  end
+  
+  sheet_enum = proc do |enum_method|     # put each cell, each row or each column 
+    i = 0
+    sheet.send(enum_method) do |item|
+      i = i + 1
+      item_name = 
+        case enum_method
+        when :each        : "cell"
+        when :each_row    : "row"
+        when :each_column : "column"
+        end 
+      puts "#{item_name} #{i}: #{item.value}" # put values of the item of the sheet
+    end
+  end
+
+  sheet_enum[:each]        # put cells
+  sheet_enum[:each_row]    # put rows
+  sheet_enum[:each_column] # put columns
+
+  book.save                # save the book
+  book.close               # close the book
+  
+ensure
+  Excel.close_all
+  rm_tmp(dir)
+end
+
+  

data/examples/edit_sheets/example_adding_sheets.rb

@@ -0,0 +1,63 @@
+# example_adding_sheets.rb: 
+# adding new and copied at various positions with various sheet names
+
+require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
+require File.join(File.dirname(__FILE__), '../../spec/helpers/create_temporary_dir')
+require "fileutils"
+
+include RobustExcelOle
+
+Excel.close_all
+begin
+  dir = create_tmpdir
+  simple_file = dir + 'simple.xls'
+  simple_save_file = dir + 'simple_save.xls'
+  File.delete simple_save_file rescue nil
+  @book = Book.open(simple_file)      # open a book
+
+  def show_sheets 
+    @book.each do |sheet|               # access each sheet
+      puts "sheet name: #{sheet.name}" #  put the sheet name
+    end
+  end
+
+  puts "sheets of the book:"
+  show_sheets
+
+  puts "adding a new sheet"
+  @book.add_sheet
+  show_sheets
+
+  puts "adding a new sheet with the name 'sheet_name'"
+  @book.add_sheet(:as => 'sheet_name')
+  show_sheets
+
+  puts "adding a copy of the 2nd sheet"
+  sheet = @book[1]
+  @book.add_sheet sheet
+  show_sheets
+
+  puts "adding a copy of the 2nd sheet and name it 'second_sheet_copy'"
+  @book.add_sheet(sheet, :as => 'second_sheet_copy')
+  show_sheets
+
+  puts "adding a new sheet after the 2nd sheet"
+  @book.add_sheet(:after => sheet)
+  show_sheets
+
+  puts "adding a copy of the 2nd sheet after the 2nd sheet"
+  @book.add_sheet(sheet, :after => sheet)
+  show_sheets
+
+  puts "adding a copy of the 4th sheet before the 7th sheet and name it 'sheet_copy'"
+  @book.add_sheet(@book[3], :as => 'sheet_copy', :after => @book[6])
+  show_sheets
+
+  @book.close(:if_unsaved => :forget)   # close the book without saving it
+  
+ensure
+  Excel.close_all
+  rm_tmp(dir)
+end
+
+  

data/examples/edit_sheets/example_ranges.rb

@@ -0,0 +1,38 @@
+# example_ranges.rb: 
+# access row and column ranges of a sheet. 
+
+require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
+require File.join(File.dirname(__FILE__), '../../spec/helpers/create_temporary_dir')
+require "fileutils"
+
+include RobustExcelOle
+
+Excel.close_all
+begin
+  dir = create_tmpdir
+  simple_file = dir + 'simple.xls'
+  simple_save_file = dir + 'simple_save.xls'
+  File.delete simple_save_file rescue nil
+  book = Book.open(simple_file)      # open a book
+  sheet = book['Sheet1']             # access a sheet via the name
+  row_r = sheet.row_range(0)         # access the whole range of the first row
+  col_r = sheet.col_range(0, 0..1)   # access the first two cells of the range of the first column
+  cell = col_r[0]                    # access the first cell of these cells 
+  puts "row range of 1st row: #{row_r.values}"                     # puts the values of the first row
+  puts "1st and 2nd cell of the 1st column : #{col_r.values}"      # and the first two cells of the first column
+  puts "1st cell of these cells of the 1st columns: #{cell.value}" # and the first cell of the row range of the 1st row 
+  
+  i = 0
+  row_r.values.each do |value|          # access the values of the first row 
+    i = i + 1
+    puts "cell #{i} of the range of the 1st row: #{value}"
+  end
+ 
+  book.close
+  
+ensure
+  Excel.close_all
+  rm_tmp(dir)
+end
+
+  

data/lib/robust_excel_ole/version.rb

@@ -1,3 +1,3 @@
 module RobustExcelOle
-  VERSION = "0.2.2.1"
+  VERSION = "0.2.3"
 end

data/spec/sheet_spec.rb

@@ -24,15 +24,20 @@ describe RobustExcelOle::Sheet do
   describe ".initialize" do
     context "when open sheet protected(with password is 'protect')" do
       before do
+        @key_sender = IO.popen  'ruby "' + File.join(File.dirname(__FILE__), '/helpers/key_sender.rb') + '" "Microsoft Office Excel" '  , "w"
+        @key_sender.puts "{p}{r}{o}{t}{e}{c}{t}{enter}"
         @book_protect = RobustExcelOle::Book.open(@dir + '/protected_sheet.xls', :visible => true, :read_only => true)
         @protected_sheet = @book_protect['protect']
       end
 
       after do
         @book_protect.close
+        @key_sender.close
       end
 
-      it { @protected_sheet.ProtectContents.should be_true }
+      it "should be a protected sheet" do
+        @protected_sheet.ProtectContents.should be_true
+      end
 
       it "protected sheet can't be write" do
         expect { @protected_sheet[0,0] = 'write' }.to raise_error

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: robust_excel_ole
 version: !ruby/object:Gem::Version 
-  hash: 85
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 2
-  - 2
-  - 1
-  version: 0.2.2.1
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - traths
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-10-21 00:00:00 +02:00
+date: 2014-10-22 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -132,7 +131,9 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
-- examples/edit_sheets/example_print_cells.rb
+- examples/edit_sheets/example_access_sheets_and_cells.rb
+- examples/edit_sheets/example_adding_sheets.rb
+- examples/edit_sheets/example_ranges.rb
 - examples/open_save_close/example_control_to_excel.rb
 - examples/open_save_close/example_if_obstructed_closeifsaved.rb
 - examples/open_save_close/example_if_obstructed_forget.rb

data/examples/edit_sheets/example_print_cells.rb

@@ -1,43 +0,0 @@
-# example 1: open a book, print the cells, rows, and columns of a sheet
-
-require File.join(File.dirname(__FILE__), '../../lib/robust_excel_ole')
-require File.join(File.dirname(__FILE__), '../../spec/helpers/create_temporary_dir')
-require "fileutils"
-
-include RobustExcelOle
-
-Excel.close_all
-begin
-  dir = create_tmpdir
-  simple_file = dir + 'simple.xls'
-  simple_save_file = dir + 'simple_save.xls'
-  File.delete simple_save_file rescue nil
-  book = Book.open(simple_file)
-  sheet = book[0]
-  cell = sheet[0,0]
-
-  sheet_enum = proc do |enum_method|
-    i = 0
-    sheet.send(enum_method) do |cell|
-      i = i + 1
-      puts "sheet.#{enum_method} #{i}: #{cell.value}"
-    end
-  end
-
-  sheet_enum[:each]
-  sheet_enum[:each_row]
-  sheet_enum[:each_column]
-
-  col_r = sheet.col_range(0,1..2).values
-  row_r = sheet.row_range(0,1..2).values
-  puts "row range of 1st row, 1..2: #{row_r}"
-  puts "column range of 1st column, 1..2: #{col_r}"
-  sheet[0,0] = "complex"
-  book.save
-  book.close
-ensure
-  Excel.close_all
-  rm_tmp(dir)
-end
-
-