creek 1.1.2 → 2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    M2M3NGQxMDJmMTc3NDk5MDUzMjFiNTU4NWI1ODZmMjBiNThkYzgyYg==
-  data.tar.gz: !binary |-
-    NWE3YmRhNGI5NTkwMDgzNDFiMDJkMmYzYzI1NjNiYjY2MDE0NmQ0Yw==
+SHA1:
+  metadata.gz: 6b7d68233b036517f99988f30405a4508c3b4892
+  data.tar.gz: a34206d988e501a0324598bcb2de856957de1ec5
 SHA512:
-  metadata.gz: !binary |-
-    ZjdmNjdmOTM1Zjc1OGIyNjI1YWZiNjlmNmJhZDliZDViMDJjODE5NDEzNzJi
-    NjI5MTkxMTYyNTRhMDhkODkxOGExY2E1MTVlMmZkODEwMTM4M2NlYjgyODI2
-    MDcxMjFmMzNmZDA2ZWU3MWM3OWJmNWRhMzAyYzgxM2E0NzdkODk=
-  data.tar.gz: !binary |-
-    ZmYxNDFiYzU0MDM1Y2FlMjgxZmI4OGI2OTRiYTQzMTI2OGRhMGYxNjlhNTU0
-    MzFjNTY5MjA5M2ZjY2MyODA3MDljYzYwZTNhNmZjZTAzMGQ4ZDFmMTNjNzU1
-    MTU5Y2I1M2Q3ZGU3YWE1Y2VjZDVhMDY3NTVlYzc1NmEyNmZlODU=
+  metadata.gz: 3b75245668526340173ae7be11e0f5f81a92c5f0da6383e2961fd877fef49a7ec8809e7e97202b11cc978db8e2260fc8c3f43c7ad41da285e3d922dc705e4f79
+  data.tar.gz: 639e94e90af3d78d1af3ef6a07e08f79c79f21accf9d1f197976022112ee03c9d12284f0a78d674a946f33bf2d2091ed6c614a4d2c49c53329faed9ba5a4b514

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 TODO: Write your name
+Copyright (c) 2017 Ramtin Vaziri
 
 MIT License
 

data/README.md

@@ -0,0 +1,117 @@
+# Creek - Stream parser for large Excel (xlsx and xlsm) files.
+
+Creek is a Ruby gem that provides a fast, simple and efficient method of parsing large Excel (xlsx and xlsm) files.
+
+
+## Installation
+
+Creek can be used from the command line or as part of a Ruby web framework. To install the gem using terminal, run the following command:
+
+```
+gem install creek
+```
+
+To use it in Rails, add this line to your Gemfile:
+
+```ruby
+gem 'creek'
+```
+
+## Basic Usage
+Creek can simply parse an Excel file by looping through the rows enumerator:
+
+```ruby
+require 'creek'
+creek = Creek::Book.new 'specs/fixtures/sample.xlsx'
+sheet= creek.sheets[0]
+
+sheet.rows.each do |row|
+  puts row # => {"A1"=>"Content 1", "B1"=>nil, C1"=>nil, "D1"=>"Content 3"}
+end
+
+sheet.rows_with_meta_data.each do |row|
+  puts row # => {"collapsed"=>"false", "customFormat"=>"false", "customHeight"=>"true", "hidden"=>"false", "ht"=>"12.1", "outlineLevel"=>"0", "r"=>"1", "cells"=>{"A1"=>"Content 1", "B1"=>nil, C1"=>nil, "D1"=>"Content 3"}}
+end
+
+sheet.state   # => 'visible'
+sheet.name    # => 'Sheet1'
+sheet.rid     # => 'rId2'
+```
+
+## Filename considerations
+By default, Creek will ensure that the file extension is either *.xlsx or *.xlsm, but this check can be circumvented as needed:
+
+```ruby
+path = 'sample-as-zip.zip'
+Creek::Book.new path, :check_file_extension => false
+```
+
+By default, the Rails [file_field_tag](http://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-file_field_tag) uploads to a temporary location and stores the original filename with the StringIO object. (See [this section](http://guides.rubyonrails.org/form_helpers.html#uploading-files) of the Rails Guides for more information.)
+
+Creek can parse this directly without the need for file upload gems such as Carrierwave or Paperclip by passing the original filename as an option:
+
+```ruby
+# Import endpoint in Rails controller
+def import
+  file = params[:file]
+  Creek::Book.new file.path, check_file_extension: false
+end
+```
+
+## Parsing images
+Creek does not parse images by default. If you want to parse the images,
+use `with_images` method before iterating over rows to preload images information. If you don't call this method, Creek will not return images anywhere.
+
+Cells with images will be an array of Pathname objects.
+If an image is spread across multiple cells, same Pathname object will be returned for each cell.
+
+```ruby
+sheet.with_images.rows.each do |row|
+  puts row # => {"A1"=>[#<Pathname:/var/folders/ck/l64nmm3d4k75pvxr03ndk1tm0000gn/T/creek__drawing20161101-53599-274q0vimage1.jpeg>], "B2"=>"Fluffy"}
+end
+```
+
+Images for a specific cell can be obtained with images_at method:
+
+```ruby
+puts sheet.images_at('A1') # => [#<Pathname:/var/folders/ck/l64nmm3d4k75pvxr03ndk1tm0000gn/T/creek__drawing20161101-53599-274q0vimage1.jpeg>]
+
+# no images in a cell
+puts sheet.images_at('C1') # => nil
+```
+
+Creek will most likely return nil for a cell with images if there is no other text cell in that row - you can use *images_at* method for retrieving images in that cell.
+
+## Remote files
+
+```ruby
+remote_url = 'http://dev-builds.libreoffice.org/tmp/test.xlsx'
+Creek::Book.new remote_url, remote: true
+```
+
+## Contributing
+
+Contributions are welcomed. You can fork a repository, add your code changes to the forked branch, ensure all existing unit tests pass, create new unit tests which cover your new changes and finally create a pull request.
+
+After forking and then cloning the repository locally, install the Bundler and then use it
+to install the development gem dependencies:
+
+```
+gem install bundler
+bundle install
+```
+
+Once this is complete, you should be able to run the test suite:
+
+```
+rake
+```
+
+## Bug Reporting
+
+Please use the [Issues](https://github.com/pythonicrubyist/creek/issues) page to report bugs or suggest new enhancements.
+
+
+## License
+
+Creek has been published under [MIT License](https://github.com/pythonicrubyist/creek/blob/master/LICENSE.txt)

data/creek.gemspec

@@ -18,13 +18,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 1.9.2'
+  spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency 'rspec', '~> 2.13.0'
+  spec.add_development_dependency 'rspec', '~> 3.6.0'
   spec.add_development_dependency 'pry'
 
-  spec.add_dependency 'nokogiri', '~> 1.6.0'
+  spec.add_dependency 'nokogiri', '~> 1.7.0'
   spec.add_dependency 'rubyzip', '>= 1.0.0'
+  spec.add_dependency 'httparty', '~> 0.15.5'
 end

data/lib/creek.rb

@@ -1,9 +1,11 @@
-require "creek/version"
+require 'creek/version'
 require 'creek/book'
 require 'creek/styles/constants'
 require 'creek/styles/style_types'
 require 'creek/styles/converter'
+require 'creek/utils'
 require 'creek/styles'
+require 'creek/drawing'
 require 'creek/sheet'
 require 'creek/shared_strings'
 

data/lib/creek/book.rb

@@ -1,6 +1,7 @@
 require 'zip/filesystem'
 require 'nokogiri'
 require 'date'
+require 'httparty'
 
 module Creek
 
@@ -19,16 +20,32 @@ module Creek
         extension = File.extname(options[:original_filename] || path).downcase
         raise 'Not a valid file format.' unless (['.xlsx', '.xlsm'].include? extension)
       end
-      @files = Zip::File.open path
+      if options[:remote]
+        zipfile = Tempfile.new("file")
+        zipfile.binmode
+        zipfile.write(HTTParty.get(path).body)
+        zipfile.close
+        path = zipfile.path
+      end
+      @files = Zip::File.open(path)
       @shared_strings = SharedStrings.new(self)
     end
 
     def sheets
       doc = @files.file.open "xl/workbook.xml"
       xml = Nokogiri::XML::Document.parse doc
+      namespaces = xml.namespaces
+
+      cssPrefix = ''
+      namespaces.each do |namespace|
+        if namespace[1] == 'http://schemas.openxmlformats.org/spreadsheetml/2006/main' && namespace[0] != 'xmlns' then
+          cssPrefix = namespace[0].split(':')[1]+'|'
+        end
+      end
+
       rels_doc = @files.file.open "xl/_rels/workbook.xml.rels"
       rels = Nokogiri::XML::Document.parse(rels_doc).css("Relationship")
-      @sheets = xml.css('sheet').map do |sheet|
+      @sheets = xml.css(cssPrefix+'sheet').map do |sheet|
         sheetfile = rels.find { |el| sheet.attr("r:id") == el.attr("Id") }.attr("Target")
         Sheet.new(self, sheet.attr("name"), sheet.attr("sheetid"),  sheet.attr("state"), sheet.attr("visible"), sheet.attr("r:id"), sheetfile)
       end

data/lib/creek/drawing.rb

@@ -0,0 +1,109 @@
+require 'pathname'
+
+module Creek
+  class Creek::Drawing
+    include Creek::Utils
+
+    COLUMNS = ('A'..'AZ').to_a
+
+    def initialize(book, drawing_filepath)
+      @book = book
+      @drawing_filepath = drawing_filepath
+      @drawings = []
+      @drawings_rels = []
+      @images_pathnames = Hash.new { |hash, key| hash[key] = [] }
+
+      if file_exist?(@drawing_filepath)
+        load_drawings_and_rels
+        load_images_pathnames_by_cells if has_images?
+      end
+    end
+
+    ##
+    # Returns false if there are no images in the drawing file or the drawing file does not exist, true otherwise.
+    def has_images?
+      @has_images ||= !@drawings.empty?
+    end
+
+    ##
+    # Extracts images from excel to tmpdir for a cell, if the images are not already extracted (multiple calls or same image file in multiple cells).
+    # Returns array of images as Pathname objects or nil.
+    def images_at(cell_name)
+      coordinate = calc_coordinate(cell_name)
+      pathnames_at_coordinate = @images_pathnames[coordinate]
+      return if pathnames_at_coordinate.empty?
+
+      pathnames_at_coordinate.map do |image_pathname|
+        if image_pathname.exist?
+          image_pathname
+        else
+          excel_image_path = "xl/media#{image_pathname.to_path.split(tmpdir).last}"
+          IO.copy_stream(@book.files.file.open(excel_image_path), image_pathname.to_path)
+          image_pathname
+         end
+      end
+    end
+
+    private
+
+    ##
+    # Transforms cell name to [row, col], e.g. A1 => [0, 0], B3 => [1, 2]
+    # Rows and cols start with 0.
+    def calc_coordinate(cell_name)
+      col = COLUMNS.index(cell_name.slice /[A-Z]+/)
+      row = (cell_name.slice /\d+/).to_i - 1 # rows in drawings start with 0
+      [row, col]
+    end
+
+    ##
+    # Creates/loads temporary directory for extracting images from excel
+    def tmpdir
+      @tmpdir ||= ::Dir.mktmpdir('creek__drawing')
+    end
+
+    ##
+    # Parses drawing and drawing's relationships xmls.
+    # Drawing xml contains relationships ID's and coordinates (row, col).
+    # Drawing relationships xml contains images' locations.
+    def load_drawings_and_rels
+      @drawings = parse_xml(@drawing_filepath).css('xdr|twoCellAnchor')
+      drawing_rels_filepath = expand_to_rels_path(@drawing_filepath)
+      @drawings_rels = parse_xml(drawing_rels_filepath).css('Relationships')
+    end
+
+    ##
+    # Iterates through the drawings and saves images' paths as Pathname objects to a hash with [row, col] keys.
+    # As multiple images can be located in a single cell, hash values are array of Pathname objects.
+    # One image can be spread across multiple cells (defined with from-row/to-row/from-col/to-col attributes) - same Pathname object is associated to each row-col combination for the range.
+    def load_images_pathnames_by_cells
+      image_selector = 'xdr:pic/xdr:blipFill/a:blip'.freeze
+      row_from_selector = 'xdr:from/xdr:row'.freeze
+      row_to_selector = 'xdr:to/xdr:row'.freeze
+      col_from_selector = 'xdr:from/xdr:col'.freeze
+      col_to_selector = 'xdr:to/xdr:col'.freeze
+
+      @drawings.xpath('//xdr:twoCellAnchor').each do |drawing|
+        embed = drawing.xpath(image_selector).first.attributes['embed']
+        next if embed.nil?
+
+        rid = embed.value
+        path = Pathname.new("#{tmpdir}/#{extract_drawing_path(rid).slice(/[^\/]*$/)}")
+
+        row_from = drawing.xpath(row_from_selector).text.to_i
+        col_from = drawing.xpath(col_from_selector).text.to_i
+        row_to = drawing.xpath(row_to_selector).text.to_i
+        col_to = drawing.xpath(col_to_selector).text.to_i
+
+        (col_from..col_to).each do |col|
+          (row_from..row_to).each do |row|
+            @images_pathnames[[row, col]].push(path)
+          end
+        end
+      end
+    end
+
+    def extract_drawing_path(rid)
+      @drawings_rels.css("Relationship[@Id=#{rid}]").first.attributes['Target'].value
+    end
+  end
+end

data/lib/creek/sheet.rb

@@ -3,6 +3,7 @@ require 'nokogiri'
 
 module Creek
   class Creek::Sheet
+    include Creek::Utils
 
     attr_reader :book,
                 :name,
@@ -21,6 +22,28 @@ module Creek
       @rid = rid
       @state = state
       @sheetfile = sheetfile
+      @images_present = false
+    end
+
+    ##
+    # Preloads images info (coordinates and paths) from related drawing.xml and drawing rels.
+    # Must be called before #rows method if you want to have images included.
+    # Returns self so you can chain the calls (sheet.with_images.rows).
+    def with_images
+      @drawingfile = extract_drawing_filepath
+      if @drawingfile
+        @drawing = Creek::Drawing.new(@book, @drawingfile.sub('..', 'xl'))
+        @images_present = @drawing.has_images?
+      end
+      self
+    end
+
+    ##
+    # Extracts images for a cell to a temporary folder.
+    # Returns array of Pathnames for the cell.
+    # Returns nil if images asre not found for the cell or images were not preloaded with #with_images.
+    def images_at(cell)
+      @drawing.images_at(cell) if @images_present
     end
 
     ##
@@ -43,7 +66,7 @@ module Creek
     # Returns a hash per row that includes the cell ids and values.
     # Empty cells will be also included in the hash with a nil value.
     def rows_generator include_meta_data=false
-      path = "xl/#{@sheetfile}"
+      path = if @sheetfile.start_with? "/xl/" or @sheetfile.start_with? "xl/" then @sheetfile else "xl/#{@sheetfile}" end
       if @book.files.file.exist?(path)
         # SAX parsing, Each element in the stream comes through as two events:
         # one to open the element and one to close it.
@@ -62,6 +85,14 @@ module Creek
                 y << (include_meta_data ? row : cells) if node.self_closing?
               elsif (node.name.eql? 'row') and (node.node_type.eql? closer)
                 processed_cells = fill_in_empty_cells(cells, row['r'], cell)
+
+                if @images_present
+                  processed_cells.each do |cell_name, cell_value|
+                    next unless cell_value.nil?
+                    processed_cells[cell_name] = images_at(cell_name)
+                  end
+                end
+
                 row['cells'] = processed_cells
                 y << (include_meta_data ? row : processed_cells)
               elsif (node.name.eql? 'c') and (node.node_type.eql? opener)
@@ -72,6 +103,10 @@ module Creek
                 unless cell.nil?
                   cells[cell] = convert(node.inner_xml, cell_type, cell_style_idx)
                 end
+              elsif (node.name.eql? 't') and (node.node_type.eql? opener)
+                unless cell.nil?
+                  cells[cell] = convert(node.inner_xml, cell_type, cell_style_idx)
+                end
               end
             end
           end
@@ -108,5 +143,22 @@ module Creek
 
       new_cells
     end
+
+    ##
+    # Find drawing filepath for the current sheet.
+    # Sheet xml contains drawing relationship ID.
+    # Sheet relationships xml contains drawing file's location.
+    def extract_drawing_filepath
+      # Read drawing relationship ID from the sheet.
+      sheet_filepath = "xl/#{@sheetfile}"
+      drawing = parse_xml(sheet_filepath).css('drawing').first
+      return if drawing.nil?
+
+      drawing_rid = drawing.attributes['id'].value
+
+      # Read sheet rels to find drawing file's location.
+      sheet_rels_filepath = expand_to_rels_path(sheet_filepath)
+      parse_xml(sheet_rels_filepath).css("Relationship[@Id='#{drawing_rid}']").first.attributes['Target'].value
+    end
   end
-end
+end

data/lib/creek/styles/converter.rb

@@ -58,10 +58,8 @@ module Creek
           value
         when :fixnum
           value.to_i
-        when :float
+        when :float, :percentage
           value.to_f
-        when :percentage
-          value.to_f / 100
         when :date, :time, :date_time
           convert_date(value, options)
         when :bignum

data/lib/creek/utils.rb

@@ -0,0 +1,16 @@
+module Creek
+  module Utils
+    def expand_to_rels_path(filepath)
+      filepath.sub(/(\/[^\/]+$)/, '/_rels\1.rels')
+    end
+
+    def file_exist?(path)
+      @book.files.file.exist?(path)
+    end
+
+    def parse_xml(xml_path)
+      doc = @book.files.file.open(xml_path)
+      Nokogiri::XML::Document.parse(doc)
+    end
+  end
+end

data/lib/creek/version.rb

@@ -1,3 +1,3 @@
 module Creek
-  VERSION = "1.1.2"
+  VERSION = "2.0"
 end

data/spec/drawing_spec.rb

@@ -0,0 +1,52 @@
+require './spec/spec_helper'
+
+describe 'drawing' do
+  let(:book) { Creek::Book.new('spec/fixtures/sample-with-images.xlsx') }
+  let(:book_no_images) { Creek::Book.new('spec/fixtures/sample.xlsx') }
+  let(:drawingfile) { 'xl/drawings/drawing1.xml' }
+  let(:drawing) { Creek::Drawing.new(book, drawingfile) }
+  let(:drawing_without_images) { Creek::Drawing.new(book_no_images, drawingfile) }
+
+  describe '#has_images?' do
+    it 'has' do
+      expect(drawing.has_images?).to eq(true)
+    end
+
+    it 'does not have' do
+      expect(drawing_without_images.has_images?).to eq(false)
+    end
+  end
+
+  describe '#images_at' do
+    it 'returns images pathnames at cell' do
+      image = drawing.images_at('A2')[0]
+      expect(image.class).to eq(Pathname)
+      expect(image.exist?).to eq(true)
+      expect(image.to_path).to match(/.+creek__drawing.+\.jpeg$/)
+    end
+
+    context 'when no images in cell' do
+      it 'returns nil' do
+        images = drawing.images_at('B2')
+        expect(images).to eq(nil)
+      end
+    end
+
+    context 'when more images in one cell' do
+      it 'returns all images at cell' do
+        images = drawing.images_at('A10')
+        expect(images.size).to eq(2)
+        expect(images.all?(&:exist?)).to eq(true)
+      end
+    end
+
+    context 'when same image across multiple cells' do
+      it 'returns same image for each cell' do
+        image1 = drawing.images_at('A4')[0]
+        image2 = drawing.images_at('A5')[0]
+        expect(image1.class).to eq(Pathname)
+        expect(image1).to eq(image2)
+      end
+    end
+  end
+end

data/spec/shared_string_spec.rb

@@ -7,12 +7,12 @@ describe 'shared strings' do
     doc = Nokogiri::XML(shared_strings_xml_file)
     dictionary = Creek::SharedStrings.parse_shared_string_from_document(doc)
 
-    dictionary.keys.size.should == 5
-    dictionary[0].should == 'Cell A1'
-    dictionary[1].should == 'Cell B1'
-    dictionary[2].should == 'My Cell'
-    dictionary[3].should == 'Cell A2'
-    dictionary[4].should == 'Cell B2'
+    expect(dictionary.keys.size).to eq(5)
+    expect(dictionary[0]).to eq('Cell A1')
+    expect(dictionary[1]).to eq('Cell B1')
+    expect(dictionary[2]).to eq('My Cell')
+    expect(dictionary[3]).to eq('Cell A2')
+    expect(dictionary[4]).to eq('Cell B2')
   end
 
 end

data/spec/sheet_spec.rb

@@ -0,0 +1,85 @@
+require './spec/spec_helper'
+
+describe 'sheet' do
+  let(:book_with_images) { Creek::Book.new('spec/fixtures/sample-with-images.xlsx') }
+  let(:book_no_images) { Creek::Book.new('spec/fixtures/sample.xlsx') }
+  let(:sheetfile) { 'worksheets/sheet1.xml' }
+  let(:sheet_with_images) { Creek::Sheet.new(book_with_images, 'Sheet 1', 1, '', '', '1', sheetfile) }
+  let(:sheet_no_images) { Creek::Sheet.new(book_no_images, 'Sheet 1', 1, '', '', '1', sheetfile) }
+
+  def load_cell(rows, cell_name)
+    cell = rows.find { |row| !row[cell_name].nil? }
+    cell[cell_name] if cell
+  end
+
+  describe '#rows' do
+    context 'with excel with images' do
+      context 'with images preloading' do
+        let(:rows) { sheet_with_images.with_images.rows.map { |r| r } }
+
+        it 'parses single image in a cell' do
+          expect(load_cell(rows, 'A2').size).to eq(1)
+        end
+
+        it 'returns nil for cells without images' do
+          expect(load_cell(rows, 'A3')).to eq(nil)
+          expect(load_cell(rows, 'A7')).to eq(nil)
+          expect(load_cell(rows, 'A9')).to eq(nil)
+        end
+
+        it 'returns nil for merged cell within empty row' do
+          expect(load_cell(rows, 'A5')).to eq(nil)
+        end
+
+        it 'returns nil for image in a cell with empty row' do
+          expect(load_cell(rows, 'A8')).to eq(nil)
+        end
+
+        it 'returns images for merged cells' do
+          expect(load_cell(rows, 'A4').size).to eq(1)
+          expect(load_cell(rows, 'A6').size).to eq(1)
+        end
+
+        it 'returns multiple images' do
+          expect(load_cell(rows, 'A10').size).to eq(2)
+        end
+      end
+
+      it 'ignores images' do
+        rows = sheet_with_images.rows.map { |r| r }
+        expect(load_cell(rows, 'A2')).to eq(nil)
+        expect(load_cell(rows, 'A3')).to eq(nil)
+        expect(load_cell(rows, 'A4')).to eq(nil)
+      end
+    end
+
+    context 'with excel without images' do
+      it 'does not break on with_images' do
+        rows = sheet_no_images.with_images.rows.map { |r| r }
+        expect(load_cell(rows, 'A10')).to eq(0.15)
+      end
+    end
+  end
+
+  describe '#images_at' do
+    it 'returns images for merged cell' do
+      image = sheet_with_images.with_images.images_at('A5')[0]
+      expect(image.class).to eq(Pathname)
+    end
+
+    it 'returns images for empty row' do
+      image = sheet_with_images.with_images.images_at('A8')[0]
+      expect(image.class).to eq(Pathname)
+    end
+
+    it 'returns nil for empty cell' do
+      image = sheet_with_images.with_images.images_at('B3')
+      expect(image).to eq(nil)
+    end
+
+    it 'returns nil for empty cell without preloading images' do
+      image = sheet_with_images.images_at('B3')
+      expect(image).to eq(nil)
+    end
+  end
+end

data/spec/styles/converter_spec.rb

@@ -9,7 +9,7 @@ describe Creek::Styles::Converter do
 
     describe :date_time do
       it "works" do
-        convert('41275', 'n', :date_time).should == Date.new(2013,01,01)
+        expect(convert('41275', 'n', :date_time)).to eq(Date.new(2013,01,01))
       end
     end
   end

data/spec/styles/style_types_spec.rb

@@ -7,9 +7,9 @@ describe Creek::Styles::StyleTypes do
       xml_file = File.open('spec/fixtures/styles/first.xml')
       doc      = Nokogiri::XML(xml_file)
       res      = Creek::Styles::StyleTypes.new(doc).call
-      res.size.should == 8
-      res[3].should == :date_time
-      res.should == [:unsupported, :unsupported, :unsupported, :date_time, :unsupported, :unsupported, :unsupported, :unsupported]
+      expect(res.size).to eq(8)
+      expect(res[3]).to eq(:date_time)
+      expect(res).to eq([:unsupported, :unsupported, :unsupported, :date_time, :unsupported, :unsupported, :unsupported, :unsupported])
     end
   end
 end

data/spec/test_spec.rb

@@ -2,25 +2,38 @@ require './spec/spec_helper'
 
 describe 'Creek trying to parsing an invalid file.' do
   it 'Fail to open a legacy xls file.' do
-    lambda { Creek::Book.new 'spec/fixtures/invalid.xls' }.should raise_error 'Not a valid file format.'
+    expect { Creek::Book.new 'spec/fixtures/invalid.xls' }
+      .to raise_error 'Not a valid file format.'
   end
 
   it 'Ignore file extensions on request.' do
     path = 'spec/fixtures/sample-as-zip.zip'
-    lambda { Creek::Book.new path, :check_file_extension => false }.should_not raise_error
+    expect { Creek::Book.new path, check_file_extension: false }
+      .not_to raise_error
   end
 
   it 'Check file extension when requested.' do
-    open_book = lambda { Creek::Book.new 'spec/fixtures/invalid.xls', :check_file_extension => true }
-    open_book.should raise_error 'Not a valid file format.'
+    expect { Creek::Book.new 'spec/fixtures/invalid.xls', check_file_extension: true }
+      .to raise_error 'Not a valid file format.'
+  end
+
+  it 'Fail to open remote file' do
+    expect { Creek::Book.new 'http://dev-builds.libreoffice.org/tmp/test.xlsx' }
+      .to raise_error(Zip::Error, /not found/)
+  end
+
+  it 'Opens remote file with remote flag' do
+    expect { Creek::Book.new 'http://dev-builds.libreoffice.org/tmp/test.xlsx', remote: true }
+      .not_to raise_error
   end
 
   it 'Check file extension of original_filename if passed.' do
     path = 'spec/fixtures/temp_string_io_file_path_with_no_extension'
-    lambda { Creek::Book.new path, :original_filename => 'invalid.xls' }.should raise_error 'Not a valid file format.'
-    lambda { Creek::Book.new path, :original_filename => 'valid.xlsx' }.should_not raise_error
+    expect { Creek::Book.new path, :original_filename => 'invalid.xls' }
+      .to raise_error 'Not a valid file format.'
+    expect { Creek::Book.new path, :original_filename => 'valid.xlsx' }
+      .not_to raise_error
   end
-
 end
 
 describe 'Creek parsing a sample XLSX file' do
@@ -32,7 +45,8 @@ describe 'Creek parsing a sample XLSX file' do
                     {'A4'=>'Content 7', 'B4'=>'Content 8', 'C4'=>'Content 9', 'D4'=>'Content 10', 'E4'=>'Content 11', 'F4'=>'Content 12'},
                     {'A5'=>nil, 'B5'=>nil, 'C5'=>nil, 'D5'=>nil, 'E5'=>nil, 'F5'=>nil, 'G5'=>nil, 'H5'=>nil, 'I5'=>nil, 'J5'=>nil, 'K5'=>nil, 'L5'=>nil, 'M5'=>nil, 'N5'=>nil, 'O5'=>nil, 'P5'=>nil, 'Q5'=>nil, 'R5'=>nil, 'S5'=>nil, 'T5'=>nil, 'U5'=>nil, 'V5'=>nil, 'W5'=>nil, 'X5'=>nil, 'Y5'=>nil, 'Z5'=>'Z Content', 'AA5'=>nil, 'AB5'=>nil, 'AC5'=>nil, 'AD5'=>nil, 'AE5'=>nil, 'AF5'=>nil, 'AG5'=>nil, 'AH5'=>nil, 'AI5'=>nil, 'AJ5'=>nil, 'AK5'=>nil, 'AL5'=>nil, 'AM5'=>nil, 'AN5'=>nil, 'AO5'=>nil, 'AP5'=>nil, 'AQ5'=>nil, 'AR5'=>nil, 'AS5'=>nil, 'AT5'=>nil, 'AU5'=>nil, 'AV5'=>nil, 'AW5'=>nil, 'AX5'=>nil, 'AY5'=>nil, 'AZ5'=>'Content 13'},
                     {'A6'=>'1', 'B6'=>'2', 'C6'=>'3'}, {'A7'=>'Content 15', 'B7'=>'Content 16', 'C7'=>'Content 18', 'D7'=>'Content 19'},
-                    {'A8'=>nil, 'B8'=>'Content 20', 'C8'=>nil, 'D8'=>nil, 'E8'=>nil, 'F8'=>'Content 21'}]
+                    {'A8'=>nil, 'B8'=>'Content 20', 'C8'=>nil, 'D8'=>nil, 'E8'=>nil, 'F8'=>'Content 21'},
+                    {'A10' => 0.15, 'B10' => 0.15}]
   end
 
   after(:all) do
@@ -40,15 +54,15 @@ describe 'Creek parsing a sample XLSX file' do
   end
 
   it 'open an XLSX file successfully.' do
-    @creek.should_not be_nil
+    expect(@creek).not_to be_nil
   end
 
   it 'find sheets successfully.' do
-    @creek.sheets.count.should == 1
+    expect(@creek.sheets.count).to eq(1)
     sheet = @creek.sheets.first
-    sheet.state.should eql nil
-    sheet.name.should eql 'Sheet1'
-    sheet.rid.should eql 'rId1'
+    expect(sheet.state).to eql nil
+    expect(sheet.name).to eql 'Sheet1'
+    expect(sheet.rid).to eql 'rId1'
   end
 
   it 'Parse rows with empty cells successfully.' do
@@ -59,15 +73,16 @@ describe 'Creek parsing a sample XLSX file' do
       row_count += 1
     end
 
-    rows[0].should == @expected_rows[0]
-    rows[1].should == @expected_rows[1]
-    rows[2].should == @expected_rows[2]
-    rows[3].should == @expected_rows[3]
-    rows[4].should == @expected_rows[4]
-    rows[5].should == @expected_rows[5]
-    rows[6].should == @expected_rows[6]
-    rows[7].should == @expected_rows[7]
-    row_count.should == 8
+    expect(rows[0]).to eq(@expected_rows[0])
+    expect(rows[1]).to eq(@expected_rows[1])
+    expect(rows[2]).to eq(@expected_rows[2])
+    expect(rows[3]).to eq(@expected_rows[3])
+    expect(rows[4]).to eq(@expected_rows[4])
+    expect(rows[5]).to eq(@expected_rows[5])
+    expect(rows[6]).to eq(@expected_rows[6])
+    expect(rows[7]).to eq(@expected_rows[7])
+    expect(rows[8]).to eq(@expected_rows[8])
+    expect(row_count).to eq(9)
   end
 
   it 'Parse rows with empty cells and meta data successfully.' do
@@ -77,6 +92,6 @@ describe 'Creek parsing a sample XLSX file' do
       rows << row
       row_count += 1
     end
-    rows.map{|r| r['cells']}.should == @expected_rows
+    expect(rows.map{|r| r['cells']}).to eq(@expected_rows)
   end
 end

metadata

@@ -1,99 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: creek
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: '2.0'
 platform: ruby
 authors:
 - pythonicrubyist
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-21 00:00:00.000000000 Z
+date: 2017-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.5
 description: A Ruby gem that streams and parses large Excel(xlsx and xlsm) files fast
   and efficiently.
 email:
@@ -102,29 +116,34 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - creek.gemspec
 - lib/creek.rb
 - lib/creek/book.rb
+- lib/creek/drawing.rb
 - lib/creek/shared_strings.rb
 - lib/creek/sheet.rb
 - lib/creek/styles.rb
 - lib/creek/styles/constants.rb
 - lib/creek/styles/converter.rb
 - lib/creek/styles/style_types.rb
+- lib/creek/utils.rb
 - lib/creek/version.rb
+- spec/drawing_spec.rb
 - spec/fixtures/invalid.xls
 - spec/fixtures/sample-as-zip.zip
+- spec/fixtures/sample-with-images.xlsx
 - spec/fixtures/sample.xlsx
 - spec/fixtures/sheets/sheet1.xml
 - spec/fixtures/sst.xml
 - spec/fixtures/styles/first.xml
 - spec/fixtures/temp_string_io_file_path_with_no_extension
 - spec/shared_string_spec.rb
+- spec/sheet_spec.rb
 - spec/spec_helper.rb
 - spec/styles/converter_spec.rb
 - spec/styles/style_types_spec.rb
@@ -139,29 +158,32 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for parsing large Excel(xlsx and xlsm) files.
 test_files:
+- spec/drawing_spec.rb
 - spec/fixtures/invalid.xls
 - spec/fixtures/sample-as-zip.zip
+- spec/fixtures/sample-with-images.xlsx
 - spec/fixtures/sample.xlsx
 - spec/fixtures/sheets/sheet1.xml
 - spec/fixtures/sst.xml
 - spec/fixtures/styles/first.xml
 - spec/fixtures/temp_string_io_file_path_with_no_extension
 - spec/shared_string_spec.rb
+- spec/sheet_spec.rb
 - spec/spec_helper.rb
 - spec/styles/converter_spec.rb
 - spec/styles/style_types_spec.rb

data/README.rdoc

@@ -1,76 +0,0 @@
-= Creek -- Stream parser for large Excel(xlsx and xlsm) files.
-
-Creek is a Ruby gem that provide a fast, simple and efficient method of parsing large Excel(xlsx and xlsm) files.
-
-
-== Installation
-
-Creek can be used from the command line or as part of a Ruby web framework. To install the gem using terminal, run the following command:
-
-    gem install creek
-
-To use it in Rails, add this line to your Gemfile:
-
-    gem "creek"
-
-
-== Basic Usage
-Creek can simply parse an Excel file by looping through the rows enumerator:
-
-    require 'creek'
-    creek = Creek::Book.new "specs/fixtures/sample.xlsx"
-    sheet= creek.sheets[0]
-
-    sheet.rows.each do |row|
-      puts row # => {"A1"=>"Content 1", "B1"=>nil, C1"=>nil, "D1"=>"Content 3"}
-    end
-
-
-    sheet.rows_with_meta_data.each do |row|
-      puts row # => {"collapsed"=>"false", "customFormat"=>"false", "customHeight"=>"true", "hidden"=>"false", "ht"=>"12.1", "outlineLevel"=>"0", "r"=>"1", "cells"=>{"A1"=>"Content 1", "B1"=>nil, C1"=>nil, "D1"=>"Content 3"}}
-    end
-
-
-    sheet.state   # => 'visible'
-    sheet.name    # => 'Sheet1'
-    sheet.rid     # => 'rId2'
-
-== Filename considerations
-By default, Creek will ensure that the file extension is either *.xlsx or *.xlsm, but this check can be circumvented as needed:
-
-    path = 'sample-as-zip.zip'
-    Creek::Book.new path, :check_file_extension => false
-
-By default, the Rails {file_field_tag}[http://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-file_field_tag] uploads to a temporary location and stores the original filename with the StringIO object. (See {this section}[http://guides.rubyonrails.org/form_helpers.html#uploading-files] of the Rails Guides for more information.)
-
-Creek can parse this directly without the need for file upload gems such as Carrierwave or Paperclip by passing the original filename as an option:
-
-    # Import endpoint in Rails controller
-    def import
-      file = params[:file]
-      Creek::Book.new file.path, check_file_extension: false
-    end
-
-== Contributing
-
-Contributions are welcomed. You can fork a repository, add your code changes to the forked branch, ensure all existing unit tests pass, create new unit tests cover your new changes and finally create a pull request.
-
-After forking and then cloning the repository locally, install Bundler and then use it
-to install the development gem dependecies:
-
-    gem install bundler
-    bundle install
-
-Once this is complete, you should be able to run the test suite:
-
-    rake
-
-
-== Bug Reporting
-
-Please use the {Issues}[https://github.com/pythonicrubyist/creek/issues] page to report bugs or suggest new enhancements.
-
-
-== License
-
-Creek has been published under {MIT License}[https://github.com/pythonicrubyist/creek/blob/master/LICENSE.txt]