rspreadsheet 0.3 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7c4756f4b74164e9aeafb35af79f923aff8a5fa
-  data.tar.gz: 04814801b5e23bd0d4077ffbe39a65fbc7401d67
+  metadata.gz: 88cd9c36fae6899582d7fed02831bb3b07d0e1a2
+  data.tar.gz: 3c1101531b2fb416d20968aea2d927f303be9269
 SHA512:
-  metadata.gz: e9e8fd002a0fdd21bd453b62088df71ece09d107eb6b6b8217f6805e989e0c18d63d376d8e7c338b2b8c292f7d46deec8dab8b161372a59978b10b33990de417
-  data.tar.gz: 59db224cb0928ee5494f79583e6f340ecba729670688e39f0a64216647947a274022e73740f801bbe0e639984d7806d610484742805f469a2c8df0d033dfebaa
+  metadata.gz: e90c357bf816cdfc28c6e35abab33558b20c20467a45ed187e9a2d2edda9db186052d66d37a988001feaa645b0010857d3cf5c9fea067b162553b044a867b1d1
+  data.tar.gz: ac8a7b2def1b7ace32c901e4ef0f71a1059f13b2076ea6e7fb81736b2610892095048fd514a2a70b51e9e784271de9c028b2d55d6e622405e9e1aee71c86b892

data/DEVEL_BLOG.md

@@ -75,8 +75,9 @@ RSpreadsheet.generate('pricelist.ods') do
 ## Release notes
 
   2017-01
-  * basic image handling implemented (issue [#24](https://github.com/gorn/rspreadsheet/issues/24))
-  * bug corrected: inserted row was not empty, but rather copy of the row below.
+  - file can be saced to any IO now, making it suitable for creating files on fly.
+  - basic image handling implemented (issue [#24](https://github.com/gorn/rspreadsheet/issues/24))
+  - bug corrected: inserted row was not empty, but rather copy of the row below.
     
 ## Developing this gem
 

data/GUIDE.md

@@ -1,7 +1,7 @@
 ## Guide to basic functionality
 ### Opening the file
 
-You can open ODS file like this
+You can open ODS file (OpenDocument Spreadsheet) like this
 ````ruby
 @workbook = Rspreadsheet.open('./test.ods')
 ````
@@ -33,6 +33,14 @@ You can mix these two at will, for example like this
 i = @sheet.images.first
 i.move_to('100mm','99.98mm')
 
+### Saving 
+The file needs to be saved after doing changes. 
+````ruby
+@workbook.save
+@workbook.save('new_filename.ods')   # changes filename and saves
+@workbook.save(any_io_object)        # file can be saved to any IO like object as well
+````
+
 ## Examples
 
   * [basic functionality](https://gist.github.com/gorn/42e33d086d9b4fda10ec) 

data/README.md

@@ -2,7 +2,7 @@
 
 # rspreadsheet
  
-Manipulating spreadsheets with Ruby. Read, **modify**, write or create new OpenDocument Spreadsheet files from ruby code. 
+Manipulating spreadsheets with Ruby. Read, **modify**, write or create new OpenDocument Spreadsheet files from ruby code.
 
 The gem allows you to acces your file and modify any cell of it, **without** touching the rest of the file, which makes it compatible with all advanced features of ODS files (both existing and future ones). You do not have to worry if it supports feature XY, if it does not, it won't touch it. This itself makes it distinct from most of [similar gems](#why-another-opendocument-spreadsheet-gem). Alhought this gem is still in beta stage I use in everyday and it works fine.
 

data/lib/rspreadsheet/version.rb

@@ -1,3 +1,3 @@
 module Rspreadsheet
-  VERSION = "0.3"
+  VERSION = "0.4.1"
 end

data/lib/rspreadsheet/workbook.rb

@@ -54,7 +54,7 @@ class Workbook
   def initialize(afilename=nil)
     @worksheets=[]
     @filename = afilename
-    @content_xml = Zip::File.open(@filename || TEMPLATE_FILE) do |zip|
+    @content_xml = Zip::File.open(@filename || TEMPLATE_FILE_NAME) do |zip|
       LibXML::XML::Document.io zip.get_input_stream(CONTENT_FILE_NAME)
     end
     @xmlnode = @content_xml.find_first('//office:spreadsheet')
@@ -63,87 +63,128 @@ class Workbook
     end
   end
   
-  # @param [String] Optional new filename
-  # Saves the worksheet. Optionally you can provide new filename.
-
-  def save(new_filename_or_io_object=nil)
-    @par = new_filename_or_io_object
-    if @filename.nil? and @par.nil? then raise 'New file should be named on first save.' end
-    
-    if @par.kind_of? StringIO
-      @par.write(@content_xml.to_s(indent: false))
-    elsif @par.nil? or @par.kind_of? String
-     
-      if @par.kind_of? String   # the filename has changed 
-        # first copy the original file to new location (or template if it is a new file)
-        FileUtils.cp(@filename || File.dirname(__FILE__)+'/empty_file_template.ods', @par)
-        @filename = @par
-      end
-      
 
-      Zip::File.open(@filename) do |zip|
-        # open manifest
-        @manifest_xml = LibXML::XML::Document.io zip.get_input_stream('META-INF/manifest.xml')
-
-        # save all pictures - iterate through sheets and pictures and check if they are saved and if not, save them
-        @worksheets.each do |sheet|
-          sheet.images.each do |image|
-            # check if it is saved
-            @ifname = image.internal_filename
-            if @ifname.nil? or zip.find_entry(@ifname).nil?   
-              # if it does not have name -> make up unused name 
-              if @ifname.nil?
-                @ifname = image.internal_filename = Rspreadsheet::Tools.get_unused_filename(zip,'Pictures/',File.extname(image.original_filename))
-              end
-              raise 'Could not set up internal_filename correctly.' if @ifname.nil?
-              
-              # save it to zip file
-              zip.add(@ifname, image.original_filename)
-              
-              # make sure it is in manifest
-              if @manifest_xml.find("//manifest:file-entry[@manifest:full-path='#{@ifname}']").empty?
-                node = Tools.prepare_ns_node('manifest','file-entry')
-                Tools.set_ns_attribute(node,'manifest','full-path',@ifname)
-                Tools.set_ns_attribute(node,'manifest','media-type',image.mime)
-                @manifest_xml.find_first("//manifest:manifest") << node
-              end  
-            end
+  # @param [String] Optional new filename
+  # Saves the worksheet. Optionally you can provide new filename or IO stream to which the file should be saved.
+  def save(io=nil)
+    case
+      when @filename.nil? && io.nil?
+        raise 'New file should be named on first save.'
+      when @filename.nil? && (io.kind_of?(String) || io.kind_of?(File) || io.kind_of?(IO) || io.kind_of?(StringIO))
+        Zip::File.open(TEMPLATE_FILE_NAME) do |empty_template_zip|                       # open empty_template file
+          write_zip_to(io) do |output_zip|                                               # open output stream of file
+            copy_internally_without_content_and_manifest(empty_template_zip,output_zip)  # copy empty_template internals
+            update_manifest_and_content_xml(empty_template_zip,output_zip)               # update xmls + pictures
           end
         end
-
-        zip.get_output_stream('content.xml') do |f|
-          f.write @content_xml.to_s(:indent => false)
+      when @filename.kind_of?(String) && io.nil?
+        write_zip_to(@filename) do |input_and_output_zip|                            # open old file
+          update_manifest_and_content_xml(input_and_output_zip,input_and_output_zip) # input and output are identical
         end
         
-        zip.get_output_stream('META-INF/manifest.xml') do |f|
-          f.write @manifest_xml.to_s
+      when @filename.kind_of?(String) && (io.kind_of?(String) || io.kind_of?(File))
+        io = io.path if io.kind_of?(File)                                            # convert file to its filename
+        FileUtils.cp(@filename , io)                                                 # copy file externally
+        @filename = io                                                               # remember new name
+        save_to_io(nil)                                                              # continue modyfying file on spot
+        
+      when @filename.kind_of?(String) && (io.kind_of?(IO) || io.kind_of?(StringIO))
+        Zip::File.open(@filename) do | old_zip |                                    # open old file
+          write_zip_to(io) do |output_zip_stream|                                   # open output stream
+            copy_internally_without_content_and_manifest(old_zip,output_zip_stream) # copy the old internals
+            update_manifest_and_content_xml(old_zip,output_zip_stream)              # update xmls + pictures
+          end
         end
-      end
+        # rewind result
+        io.rewind
+      else
     end
   end
+  alias :to_io :save
+  alias :save_to_io  :save
+  
+  private 
+
+  def update_manifest_and_content_xml(input_zip,output_zip)
+    update_manifest_xml(input_zip,output_zip)
+    update_content_xml(output_zip)
+  end
   
-  # Saves the worksheet to IO stream.
-  def save_to_io(io = ::StringIO.new)
-    ::Zip::OutputStream.write_buffer(io) do |output|
-      ::Zip::File.open(TEMPLATE_FILE) do |input|
-        input.
-          select { |entry| entry.file? }.
-          select { |entry| entry.name != CONTENT_FILE_NAME }.
-          each do |entry|
-            output.put_next_entry(entry.name)
-            output.write(entry.get_input_stream.read)
+  
+  def update_content_xml(zip)
+    save_entry_to_zip(zip,CONTENT_FILE_NAME,@content_xml.to_s(indent: false))
+  end
+    
+  def update_manifest_xml(input_zip,output_zip)
+    # read manifest
+    @manifest_xml = LibXML::XML::Document.io input_zip.get_input_stream(MANIFEST_FILE_NAME)
+
+    # save all pictures - iterate through sheets and pictures and check if they are saved and if not, save them
+    @worksheets.each do |sheet|
+      sheet.images.each do |image|
+        # check if it is saved
+        @ifname = image.internal_filename
+        if @ifname.nil? or input_zip.find_entry(@ifname).nil?   
+          # if it does not have name -> make up unused name 
+          if @ifname.nil?
+            @ifname = image.internal_filename = Rspreadsheet::Tools.get_unused_filename(input_zip,'Pictures/',File.extname(image.original_filename))
           end
+          raise 'Could not set up internal_filename correctly.' if @ifname.nil?
+          raise 'This should not happen' if image.original_filename.nil?
+          
+          # save it to zip file
+          save_entry_to_zip(output_zip, @ifname, File.open(image.original_filename,'r').read)
+          
+          # make sure it is in manifest
+          if @manifest_xml.find("//manifest:file-entry[@manifest:full-path='#{@ifname}']").empty?
+            node = Tools.prepare_ns_node('manifest','file-entry')
+            Tools.set_ns_attribute(node,'manifest','full-path',@ifname)
+            Tools.set_ns_attribute(node,'manifest','media-type',image.mime)
+            @manifest_xml.find_first("//manifest:manifest") << node
+          end  
+        end
       end
+    end
 
-      output.put_next_entry(CONTENT_FILE_NAME)
-      output.write(@content_xml.to_s(indent: false))
+    # write manifest
+    save_entry_to_zip(output_zip, MANIFEST_FILE_NAME, @manifest_xml.to_s)
+  end
+  
+  def copy_internally_without_content_and_manifest(input_zip,output_zip)
+    input_zip.each do |entry|
+      next unless entry.file? 
+      next if entry.name == CONTENT_FILE_NAME || entry.name == MANIFEST_FILE_NAME
+      save_entry_to_zip(output_zip, entry.name, entry.get_input_stream.read)
+    end
+  end
+  
+  def save_entry_to_zip(zip,internal_filename,contents)
+    if zip.kind_of? Zip::File
+#       raise [internal_filename,contents].inspect  unless File.exists?(internal_filename)
+      zip.get_output_stream(internal_filename) do  |f| 
+        f.write contents
+      end
+    else
+      zip.put_next_entry(internal_filename)
+      zip.write(contents)
+    end
+  end
+  
+  def write_zip_to(io,&block)
+    if io.kind_of? File or io.kind_of? String
+      Zip::File.open(io, 'br+') do |zip|
+        yield zip
+      end
+    elsif io.kind_of? StringIO # or io.kind_of? IO
+      Zip::OutputStream.write_buffer(io) do |zip|
+        yield zip
+      end
     end
   end
-  alias :to_io :save_to_io 
   
-  private 
   CONTENT_FILE_NAME = 'content.xml'
-  TEMPLATE_FILE = (File.dirname(__FILE__)+'/empty_file_template.ods').freeze
+  MANIFEST_FILE_NAME = 'META-INF/manifest.xml'
+  TEMPLATE_FILE_NAME = (File.dirname(__FILE__)+'/empty_file_template.ods').freeze
   def register_worksheet(worksheet)
     index = worksheets_count+1
     @worksheets[index-1]=worksheet

data/rspreadsheet.gemspec

@@ -30,19 +30,17 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'andand', '~>1.3'
 
   # development dependencies
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler", '~> 1.5'
   spec.add_development_dependency "rake", '~>0.9'
   # testig - see http://bit.ly/1n5yM51
-  spec.add_development_dependency "rspec", '~>2'       # testing
-  spec.add_development_dependency 'pry-nav', '~>0'     # enables pry 'next', 'step' commands
+  spec.add_development_dependency "rspec", '~>2.0'       # running tests
+  spec.add_development_dependency 'pry-nav', '~>0.0'     # enables pry 'next', 'step' commands
+  spec.add_development_dependency "coveralls", '~>0.7' # inspecting coverage of tests
 
   # optional and testing
-  spec.add_development_dependency "coveralls", '~>0.7'
-
-  if RUBY_VERSION.split('.')[0] !=  "1"
-    # ruby_dep starts to require ruby 2.2.5 which raises errors with ruby 1.9.3
-#     spec.add_development_dependency "guard", '~>2.13'
-#     spec.add_development_dependency "guard-rspec", '~>4.6'
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.2.5')
+    spec.add_development_dependency "guard", '~>2.13'
+    spec.add_development_dependency "guard-rspec", '~>4.6'
   end
   
 #   spec.add_development_dependency 'equivalent-xml'     # implementing xml diff

data/spec/image_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
  
 describe Rspreadsheet::Image do
   before do
-    @testfile_filename = './spec/testfile2-images.ods'
-    @tmp_testfile_filename = '/tmp/testfile2.ods'
+    @testfile_filename = $test_filename_images
+    @tmp_testfile_filename = '/tmp/testfile2-image.ods'
     File.delete(@tmp_testfile_filename) if File.exists?(@tmp_testfile_filename) # delete temp file
 
     @testimage_filename  = './spec/test-image-blue.png'
@@ -12,6 +12,9 @@ describe Rspreadsheet::Image do
     @sheet  = @workbook.worksheets(1)
     @sheet2 = @workbook.worksheets(2)
   end
+  after do
+    File.delete(@tmp_testfile_filename) if File.exists?(@tmp_testfile_filename) # delete temp file
+  end
   it 'is accesible when included in spreadsheet', :xpending do
     @sheet.images_count.should == 1
     @image = @sheet.images(1)

data/spec/io_spec.rb

@@ -3,48 +3,74 @@ using ClassExtensions if RUBY_VERSION > '2.1'
 
 describe Rspreadsheet do
   before do
-    @tmp_filename = '/tmp/testfile.ods'        
+    @tmp_filename = '/tmp/testfile.ods'
     File.delete(@tmp_filename) if File.exists?(@tmp_filename)  # delete temp file
   end
   
   
-  it 'can open spreadsheet and save it to file, resulting file has same content as original' do
+  it 'when saved to file is identical' do
     spreadsheet = Rspreadsheet.new($test_filename)                 # open a file
     spreadsheet.save(@tmp_filename)                                # and save spreadsheet as temp file
     
     # now compare content saved file to original
-    contents_of_files_are_identical?($test_filename,@tmp_filename).should == true
+    contents_of_files_should_be_identical($test_filename,@tmp_filename).should == true
   end
   
-  it 'can open spreadsheet and store it to IO object', :pending => 'Under development' do
+  it 'when saved to file via save_to_io is identical' do
+    @tmp_filename = '/tmp/testfile4.ods'
     spreadsheet = Rspreadsheet.new($test_filename)                 # open a file
+    File.open(@tmp_filename, 'w+') do |file|
+       spreadsheet.save_to_io(file)                                   # and save spreadsheet as temp file
+    end
+    
+    # now compare content saved file to original
+    contents_of_files_should_be_identical($test_filename,@tmp_filename)
+  end
+  
+  it 'can be saved to IO object' do
+    @tmp_filename = '/tmp/testfile5.ods'
+    spreadsheet = Rspreadsheet.new($test_filename_images)                 # open a file
     
     stringio = StringIO.new
     spreadsheet.save_to_io(stringio)
-    stringio.size.should > 300000
+#     stringio.size.should > 300000
     
     # save it to temp file
     File.open(@tmp_filename, "w") do |f|
       f.write stringio.read                                  
     end
      
-    contents_of_files_are_identical?($test_filename,@tmp_filename).should == true
+    contents_of_files_should_be_identical($test_filename_images,@tmp_filename)
   end
+  
+
+end
+
+def xml_from_entry(zip,entryname)
+  LibXML::XML::Document.io(zip.get_input_stream(entryname))
 end
 
-def contents_of_files_are_identical?(filename1,filename2)
-  @content_xml1 = Zip::File.open(filename1) do |zip|
-    LibXML::XML::Document.io zip.get_input_stream('content.xml')
+def contents_of_files_should_be_identical(filename1,filename2)
+  Zip::File.open(filename1) do |zip|
+    @content1_xml = xml_from_entry(zip,'content.xml')
+    @manifest1_xml = xml_from_entry(zip,'META-INF/manifest.xml')
+    @images1_count = zip.glob('Pictures/**').count
   end
-  @content_xml2 = Zip::File.open(filename2) do |zip|
-    LibXML::XML::Document.io zip.get_input_stream('content.xml')
+  
+  Zip::File.open(filename2) do |zip|
+    @content2_xml = xml_from_entry(zip,'content.xml')
+    @manifest2_xml = xml_from_entry(zip,'META-INF/manifest.xml')
+    @images2_count = zip.glob('Pictures/**').count
   end
-  return contents_are_identical?(@content_xml1,@content_xml2)
+  
+  @images1_count.should == @images2_count
+  xmls_should_be_identical(@content1_xml,@content2_xml) 
+  xmls_should_be_identical(@manifest1_xml,@manifest2_xml)
 end
 
-def contents_are_identical?(content_xml1,content_xml2)
-  content_xml2.root.first_diff(content_xml1.root).should be_nil
-  content_xml1.root.first_diff(content_xml2.root).should be_nil
+def xmls_should_be_identical(xml1,xml2) 
+  xml2.root.first_diff(xml1.root).should be_nil
+  xml1.root.first_diff(xml2.root).should be_nil
   
-  return (content_xml1.root == content_xml2.root)
+  xml1.root.should == xml2.root
 end

data/spec/spec_helper.rb

@@ -14,6 +14,7 @@ Coveralls.wear!
 
 # some variables used everywhere
 $test_filename = './spec/testfile1.ods'
+$test_filename_images = './spec/testfile2-images.ods'
 
 # require my gem
 require 'rspreadsheet'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspreadsheet
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: 0.4.1
 platform: ruby
 authors:
 - Jakub A.Těšínský
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-18 00:00:00.000000000 Z
+date: 2017-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement