spreadbase 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45c4554bad3ea396a50ac1bad824d06fe218b17392062152ab07298e636d8be6
-  data.tar.gz: ed6a11f32c3acf8ba6d41c1b0630d36c010a707dd1039161718741acd70e830a
+  metadata.gz: 0c25a3b806d510bde0b396fc5dcb9443f2a909493a8b3bd850078a63539fc189
+  data.tar.gz: 76b76fe5242a2626c170f3b032c5ba6b26d500ec00cd72ceba813aa418c0335d
 SHA512:
-  metadata.gz: 7d60ab79f3551f59d566940435fb75c63b05fe91ece2dbdc84f9c5e60e64ebe08dffcb76159b898b9bf16b878d97a128d744d545ac13d88bc55047b1a90f3863
-  data.tar.gz: 69b4c6b2f7a7476826cd4990b8cbe3c3a455826e34ac8060acb2ef30749bc5b793d9b6a84969414a55e3dd6f7f05933d52cd3b50c6541eee43cb83f99a130bf4
+  metadata.gz: 37098ecaa48b14abb507edab85965d9383a1caf292e279eb970cf000c9edc3b68f30b6d4f1c75378b3497a48b00de9999bff60da2c45873db3ce0e20339c4c90
+  data.tar.gz: e9829cad4842d6219199a0ee2f0f3798997bc37f67fb4021c0d415e2f0e89579dd7ab81f6459fa690a096818c889c483ce8a4f250e93e78bb9f1d37ca23517b8

data/.github/workflows/ci.yml

@@ -1,6 +1,9 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches: [ master ]
+  pull_request:
 
 jobs:
   rspec:
@@ -8,11 +11,12 @@ jobs:
 
     strategy:
       matrix:
-        ruby: ['3.0', '2.7', '2.6', '2.5', '2.4']
+        ruby: [head, '3.3', '3.2', '3.1', '3.0']
+      fail-fast: false
 
     steps:
       - name: Checkout spreadbase repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1

data/Gemfile

@@ -1,7 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-if Gem.ruby_version >= Gem::Version.new('3.0.0')
-  gem 'rexml'
-end

data/lib/spreadbase/codecs/open_document_12.rb

@@ -33,8 +33,8 @@ module SpreadBase # :nodoc:
       #
       # _returns_ the archive as binary string.
       #
-      def encode_to_archive(el_document, options={})
-        document_buffer = encode_to_content_xml(el_document, options)
+      def encode_to_archive(el_document, **options)
+        document_buffer = encode_to_content_xml(el_document, **options)
         zip_buffer      = ''
 
         Zip::File.open_buffer(zip_buffer) do | zip_file |
@@ -58,11 +58,10 @@ module SpreadBase # :nodoc:
       #
       # _returns_ the SpreadBase::Document instance.
       #
-      def decode_archive(zip_buffer, options={})
-        io = StringIO.new(zip_buffer)
-        content_xml_data = Zip::File.new(io, false, true).read('content.xml')
+      def decode_archive(zip_buffer, **options)
+        content_xml_data = read_content_xml(zip_buffer)
 
-        decode_content_xml(content_xml_data, options)
+        decode_content_xml(content_xml_data, **options)
       end
 
       # Utility method; encodes the Document to the content.xml format.
@@ -79,7 +78,7 @@ module SpreadBase # :nodoc:
       #--
       # "utility" is a fancy name for testing/utils helper.
       #
-      def encode_to_content_xml(el_document, options={})
+      def encode_to_content_xml(el_document, **options)
         prettify = options[:prettify]
 
         document_xml_root = encode_to_document_node(el_document)
@@ -98,14 +97,30 @@ module SpreadBase # :nodoc:
       #--
       # "utility" is a fancy name for testing/utils helper.
       #
-      def decode_content_xml(content_xml_data, options={})
+      def decode_content_xml(content_xml_data, **options)
         root_node = REXML::Document.new(content_xml_data)
 
-        decode_document_node(root_node, options)
+        decode_document_node(root_node, **options)
       end
 
       private
 
+      def read_content_xml(zip_buffer)
+        io = StringIO.new(zip_buffer)
+
+        zip_file = if using_rubyzip_3?
+          Zip::File.new(io, buffer: true)
+        else
+          Zip::File.new(io, false, true)
+        end
+
+        zip_file.read('content.xml')
+      end
+
+      def using_rubyzip_3?
+        Gem.loaded_specs['rubyzip'].version >= Gem::Version.new('3.0.0')
+      end
+
       def pretty_xml(document)
         buffer = ""
 

data/lib/spreadbase/codecs/open_document_12_modules/decoding.rb

@@ -17,7 +17,7 @@ module SpreadBase # :nodoc:
 
         # Returns a Document instance.
         #
-        def decode_document_node(root_node, options={})
+        def decode_document_node(root_node, **options)
           document = Document.new
 
           style_nodes = root_node.elements.to_a('//office:document-content/office:automatic-styles/style:style')
@@ -25,7 +25,7 @@ module SpreadBase # :nodoc:
 
           document.column_width_styles = decode_column_width_styles(style_nodes)
 
-          document.tables = table_nodes.map { | node | decode_table_node(node, options) }
+          document.tables = table_nodes.map { | node | decode_table_node(node, **options) }
 
           document
         end
@@ -50,7 +50,7 @@ module SpreadBase # :nodoc:
           end
         end
 
-        def decode_table_node(table_node, options)
+        def decode_table_node(table_node, **options)
           table = Table.new(table_node.attributes['table:name'])
 
           column_nodes = table_node.elements.to_a('table:table-column')
@@ -59,7 +59,7 @@ module SpreadBase # :nodoc:
           # A single column/row can represent multiple columns (table:number-(columns|rows)-repeated)
           #
           table.column_width_styles = column_nodes.inject([]) { | current_styles, node | current_styles + decode_column_width_style(node) }
-          table.data                = decode_row_nodes(row_nodes, options)
+          table.data                = decode_row_nodes(row_nodes, **options)
 
           table
         end
@@ -73,21 +73,21 @@ module SpreadBase # :nodoc:
           make_array_from_repetitions(style_name, repetitions)
         end
 
-        def decode_row_nodes(row_nodes, options)
+        def decode_row_nodes(row_nodes, **options)
           rows = []
           row_nodes.inject(0) do |size, node|
-            row, repetitions = decode_row_node(node, options)
+            row, repetitions = decode_row_node(node, **options)
             row.empty? || append_row(rows, size, row, repetitions)
             size + repetitions
           end
           rows
         end
 
-        def decode_row_node(row_node, options)
+        def decode_row_node(row_node, **options)
           repetitions = (row_node.attributes['table:number-rows-repeated'] || '1').to_i
           cell_nodes  = row_node.elements.to_a('table:table-cell')
 
-          [decode_cell_nodes(cell_nodes, options), repetitions]
+          [decode_cell_nodes(cell_nodes, **options), repetitions]
         end
 
         def append_row(rows, size, row, repetitions)
@@ -95,19 +95,19 @@ module SpreadBase # :nodoc:
           rows.concat(make_array_from_repetitions(row, repetitions))
         end
 
-        def decode_cell_nodes(cell_nodes, options)
+        def decode_cell_nodes(cell_nodes, **options)
           cells = []
           cell_nodes.inject(0) do |size, node|
-            cell, repetitions = decode_cell_node(node, options)
+            cell, repetitions = decode_cell_node(node, **options)
             cell.nil? || append_cell(cells, size, cell, repetitions)
             size + repetitions
           end
           cells
         end
 
-        def decode_cell_node(cell_node, options)
+        def decode_cell_node(cell_node, **options)
           [
-            decode_cell_value(cell_node, options),
+            decode_cell_value(cell_node, **options),
             (cell_node.attributes['table:number-columns-repeated'] || '1').to_i
           ]
         end
@@ -117,7 +117,7 @@ module SpreadBase # :nodoc:
           cells.concat(make_array_from_repetitions(cell, repetitions))
         end
 
-        def decode_cell_value(cell_node, options)
+        def decode_cell_value(cell_node, **options)
           floats_as_bigdecimal = options[:floats_as_bigdecimal]
 
           value_type = cell_node.attributes['office:value-type']

data/lib/spreadbase/document.rb

@@ -24,13 +24,13 @@ module SpreadBase # :nodoc:
     #
     # +floats_as_bigdecimal+::        (false) decode floats as BigDecimal instead of Float
     #
-    def initialize(document_path=nil, options={})
+    def initialize(document_path=nil, **options)
       @document_path = document_path
       @options       = options.clone
 
       if @document_path && File.exist?(document_path)
         document_archive = IO.read(document_path)
-        decoded_document = Codecs::OpenDocument12.new.decode_archive(document_archive, options)
+        decoded_document = Codecs::OpenDocument12.new.decode_archive(document_archive, **options)
 
         @column_width_styles = decoded_document.column_width_styles
         @tables              = decoded_document.tables
@@ -48,13 +48,13 @@ module SpreadBase # :nodoc:
     #
     # +prettify+::                   Prettifies the content.xml file before saving.
     #
-    def save(options={})
-      options = @options.merge(options)
+    def save(**options)
+      options = @options.merge(**options)
 
       raise "At least one table must be present" if @tables.empty?
       raise "Document path not specified"        if @document_path.nil?
 
-      document_archive = Codecs::OpenDocument12.new.encode_to_archive(self, options)
+      document_archive = Codecs::OpenDocument12.new.encode_to_archive(self, **options)
 
       File.open(@document_path, 'wb') { | file | file << document_archive }
     end
@@ -63,13 +63,13 @@ module SpreadBase # :nodoc:
     #
     # +with_headers+::        Print the tables with headers.
     #
-    def to_s(options={})
+    def to_s(**options)
       options.merge!(row_prefix: '  ')
 
       tables.inject('') do | output, table |
         output << "#{ table.name }:" << "\n" << "\n"
 
-        output << table.to_s(options) << "\n"
+        output << table.to_s(**options) << "\n"
       end
     end
 

data/lib/spreadbase/helpers/helpers.rb

@@ -34,7 +34,7 @@ module SpreadBase # :nodoc:
     # +row_prefix+::            Prefix this string to each row.
     # +with_header+::           First row will be separated from the remaining ones.
     #
-    def pretty_print_rows(rows, options={})
+    def pretty_print_rows(rows, **options)
       row_prefix   = options[:row_prefix] || ''
       with_headers = options[:with_headers]
 

data/lib/spreadbase/table.rb

@@ -35,8 +35,8 @@ module SpreadBase # :nodoc:
       @data = the_data.map { | the_row | array_to_cells(the_row) }
     end
 
-    def data(options={})
-      @data.map { | the_row | the_row.map { | cell | cell_to_value(cell, options) } }
+    def data(**options)
+      @data.map { | the_row | the_row.map { | cell | cell_to_value(cell, **options) } }
     end
 
     # Access a cell value.
@@ -48,8 +48,8 @@ module SpreadBase # :nodoc:
     #
     # _returns_ the value, which is automatically converted to the Ruby data type.
     #
-    def [](column_identifier, row_index, options={})
-      the_row = row(row_index, options)
+    def [](column_identifier, row_index, **options)
+      the_row = row(row_index, **options)
 
       column_index = decode_column_identifier(column_identifier)
 
@@ -83,13 +83,13 @@ module SpreadBase # :nodoc:
     #
     # +row_index+::                  int or range (0-based). see notes about the rows indexing.
     #
-    def row(row_index, options={})
+    def row(row_index, **options)
       check_row_index(row_index)
 
       if row_index.is_a?(Range)
-        @data[row_index].map { | row | cells_to_array(row, options) }
+        @data[row_index].map { | row | cells_to_array(row, **options) }
       else
-        cells_to_array(@data[row_index], options)
+        cells_to_array(@data[row_index], **options)
       end
     end
 
@@ -149,7 +149,7 @@ module SpreadBase # :nodoc:
     #                                for multiple access, use a range either of int or excel-format identifiers - pay attention, because ( 'A'..'c' ) is not semantically correct.
     #                                interestingly, ruby letter ranges convention is the same as the excel columns one.
     #
-    def column(column_identifier, options={})
+    def column(column_identifier, **options)
       if column_identifier.is_a?(Range)
         min_index = decode_column_identifier(column_identifier.min)
         max_index = decode_column_identifier(column_identifier.max)
@@ -158,7 +158,7 @@ module SpreadBase # :nodoc:
           @data.map do | the_row |
             cell = the_row[column_index]
 
-            cell_to_value(cell, options)
+            cell_to_value(cell, **options)
           end
         end
       else
@@ -167,7 +167,7 @@ module SpreadBase # :nodoc:
         @data.map do | the_row |
           cell = the_row[column_index]
 
-          cell_to_value(cell, options)
+          cell_to_value(cell, **options)
         end
       end
     end
@@ -248,8 +248,8 @@ module SpreadBase # :nodoc:
 
     # _returns_ a matrix representation of the tables, with the values being separated by commas.
     #
-    def to_s(options={})
-      pretty_print_rows(data, options)
+    def to_s(**options)
+      pretty_print_rows(data, **options)
     end
 
     private
@@ -262,11 +262,11 @@ module SpreadBase # :nodoc:
       value.is_a?(Cell) ? value : Cell.new(value)
     end
 
-    def cells_to_array(cells, options={})
-      cells.map { | cell | cell_to_value(cell, options) }
+    def cells_to_array(cells, **options)
+      cells.map { | cell | cell_to_value(cell, **options) }
     end
 
-    def cell_to_value(cell, options={})
+    def cell_to_value(cell, **options)
       as_cell = options[:as_cell]
 
       if as_cell
@@ -283,7 +283,7 @@ module SpreadBase # :nodoc:
     #
     # +allow_append+::      Allow pointing to one unit above the last row.
     #
-    def check_row_index(row_index, options={})
+    def check_row_index(row_index, **options)
       allow_append = options [:allow_append]
 
       positive_limit = allow_append ? @data.size : @data.size - 1

data/lib/spreadbase/version.rb

@@ -1,3 +1,3 @@
 module SpreadBase
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

data/spec/elements/document_spec.rb

@@ -35,7 +35,7 @@ describe SpreadBase::Document do
 
     expect(File).to receive(:'exist?').with('/pizza/margerita.txt').and_return(true)
     expect(IO).to receive(:read).with('/pizza/margerita.txt').and_return('abc')
-    expect(codec).to receive(:decode_archive).with('abc', {}).and_return(@sample_document)
+    expect(codec).to receive(:decode_archive).with('abc').and_return(@sample_document)
 
     document = SpreadBase::Document.new('/pizza/margerita.txt')
 

data/spreadbase.gemspec

@@ -8,19 +8,21 @@ Gem::Specification.new do |s|
   s.name        = "spreadbase"
   s.version     = SpreadBase::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.required_ruby_version = '>= 2.4.0'
+  s.required_ruby_version = '>= 3.0.0'
   s.authors     = ["Saverio Miroddi"]
-  s.date        = '2021-03-05'
+  s.date        = '2024-01-03'
   s.email       = ["saverio.pub2@gmail.com"]
   s.homepage    = "https://github.com/saveriomiroddi/spreadbase"
   s.summary     = %q{Library for reading/writing OpenOffice Calc documents.}
   s.description = %q{Library for reading/writing OpenOffice Calc documents.}
   s.license     = "GPL-3.0"
 
-  s.add_runtime_dependency     "rubyzip", "~>2.3.0"
-  s.add_development_dependency "rspec",   "~>3.9.0"
+  s.add_runtime_dependency "rubyzip",    ">= 2.3.0"
+  s.add_runtime_dependency "bigdecimal", ">= 3.0.0"
+  s.add_runtime_dependency "rexml",      ">= 3.2.4"
 
-  s.add_development_dependency "rake",   "~>13.0"
+  s.add_development_dependency "rspec", "~> 3.12.0"
+  s.add_development_dependency "rake",  "~> 13.0"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec,temp,utils}/*`.split("\n")

data/utils/convert_sqlite_to_ods.rb

@@ -102,7 +102,7 @@ end
 # +options+:
 # +insert_headers+::          (true) insert the column names as headers
 #
-def convert_sqlite_to_ods(source_filename, options={})
+def convert_sqlite_to_ods(source_filename, **options)
   insert_headers = ! options.has_key?(:insert_headers) || options[:insert_headers]
 
   destination_filename = generate_destination_filename(source_filename)

data/utils/utils_helpers.rb

@@ -16,7 +16,7 @@ module UtilsHelpers
   #   :content        [nil]
   #   :name_prefix    [spreadbase_testing]
   #
-  def with_tempfile(options={}, &block)
+  def with_tempfile(**options, &block)
     content     = options[:content]
     name_prefix = options[:name_prefix] || 'spreadbase_testing'
 
@@ -33,7 +33,7 @@ module UtilsHelpers
 
   # Create an archive, whose entries' path is relative to the path passed.
   #
-  def relative_compress_to_zip(folder_path, options={})
+  def relative_compress_to_zip(folder_path, **options)
     absolute_path = File.expand_path(folder_path) + '/'
     zip_filename  = options[:zip_filename] || File.expand_path(folder_path) + '.zip'
 

metadata

@@ -1,43 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: spreadbase
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Saverio Miroddi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-05 00:00:00.000000000 Z
+date: 2024-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -101,14 +129,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Library for reading/writing OpenOffice Calc documents.