rubyXL 3.4.24 → 3.4.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d174a06e6a9c7cb4c88d59e54381b4f2a110b9781bf7adab38f787cb99cbd2e8
-  data.tar.gz: d0114d7bc184ffc82bc3143ae2f8b843fd1c980299fa302e78211b588b1e23f6
+  metadata.gz: b11583265e2c20fd90e4edea3102a50467957be9c7934dc80bd1d33b029e030c
+  data.tar.gz: 390623df463b75a35b0fa626052cb6e330779763b653eecc95169ddf97c8b6c7
 SHA512:
-  metadata.gz: 7e9dd0dceb2fcd27376ff8c97440f98d7e7bc6d37d68dd514ff4d3c629d2ef18acc7c9c585afe840657a0805c867e4884ab3510ab0d0f08bf489df56bf68ea50
-  data.tar.gz: '096d1ef36c7025887d9b07cf511cc45b39a0965b3fe2831627899ee25b1cb22e28f49f770c2b4dea64f3ad01006ce88e9ee0ff2ba391d66140989a1211b98421'
+  metadata.gz: b0c34a5bed00017b79286ac01c03d8318fe847bd01e19d7456f625e567cf76a763fb02039f7a5215193e57dcefe6b107de5bfbbf75e29c0915447bb650896d38
+  data.tar.gz: 994c6df51513c61da7781d9a35fe68ba7ae274437cda4ce6d195a5f8e447f33f34d9fe9599c7688067c5d9fa94cfbb55879005519fcc9bf2ddc13c23b8b7c09c

data/.rubocop.yml

@@ -0,0 +1,96 @@
+#inherit_from: .rubocop_todo.yml
+
+#require:
+#  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - test/**/*
+    - tmp/*
+    - vendor/**/*
+    - Gemfile
+    - rubyXL.gemspec
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false
+
+Style/MultilineIfThen:
+  Enabled: false
+
+Style/ParenthesesAroundCondition:
+  Enabled: false
+
+Style/MultilineWhenThen:
+  Enabled: false
+
+Style/RedundantPercentQ:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/ExponentialNotation:
+  Enabled: false
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  EnforcedStyle: space 
+  Enabled: false
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/ClassAndModuleCamelCase:
+  Enabled: false
+
+Naming/ConstantName:
+  Enabled: false
+
+
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table 
+
+Layout/SpaceInsidePercentLiteralDelimiters:
+  Enabled: false
+
+
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# v3.4.25 (May 19, 2022)
+
+* Improve code style and consistently (@weshatheleopard)
+* Update `Gemfile.lock`, dependency versions used when developing the gem (@weshatheleopard)
+
+# v3.4.24 (May 16, 2022)
+
+* Add `Cell#add_hyperlink` for adding a hyperlink to a cell (@weshatheleopard)
+* Add `Reference#valid?` for checking if a cell reference is valid (@weshatheleopard)
+* Add `Worksheet#cell_at` for finding a cell by its Excel-style reference (@weshatheleopard)
+* Prevent creation of sheets with reserved names (specifically, `History`) (@weshatheleopard)
+* Update `Gemfile.lock`, dependency versions used when developing the gem (@weshatheleopard)

data/Gemfile

@@ -15,4 +15,6 @@ group :development, :test do
 #  gem 'stackprof'
   gem 'ruby-prof'
   gem 'rspec_junit_formatter'
+
+  gem 'rubocop'
 end

data/Gemfile.lock

@@ -1,14 +1,16 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    base64 (0.2.0)
     builder (3.2.4)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.5.0)
+    diff-lcs (1.5.1)
     docile (1.4.0)
-    faraday (1.10.0)
+    faraday (1.10.3)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -24,14 +26,15 @@ GEM
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.3)
-      multipart-post (>= 1.2, < 3)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
     faraday-retry (1.0.3)
-    git (1.11.0)
+    git (1.19.1)
+      addressable (~> 2.8)
       rchardet (~> 1.8)
     github_api (0.19.0)
       addressable (~> 2.4)
@@ -40,7 +43,8 @@ GEM
       hashie (~> 3.5, >= 3.5.2)
       oauth2 (~> 1.0)
     hashie (3.6.0)
-    highline (2.0.3)
+    highline (2.1.0)
+    json (2.7.1)
     juwelier (2.4.9)
       builder
       bundler
@@ -53,58 +57,82 @@ GEM
       rake
       rdoc
       semver2
-    jwt (2.3.0)
+    jwt (2.8.1)
+      base64
     kamelcase (0.0.2)
       semver2 (~> 3)
-    mini_portile2 (2.8.0)
+    language_server-protocol (3.17.0.3)
+    mini_portile2 (2.8.5)
     multi_json (1.15.0)
     multi_xml (0.6.0)
-    multipart-post (2.1.1)
-    nokogiri (1.13.4)
-      mini_portile2 (~> 2.8.0)
+    multipart-post (2.4.0)
+    nokogiri (1.15.6)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    oauth2 (1.4.9)
+    oauth2 (1.4.11)
       faraday (>= 0.17.3, < 3.0)
       jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    psych (4.0.3)
+      rack (>= 1.2, < 4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.2)
       stringio
-    public_suffix (4.0.7)
-    racc (1.6.0)
-    rack (2.2.3)
-    rake (13.0.6)
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rack (3.0.10)
+    rainbow (3.1.1)
+    rake (13.1.0)
     rchardet (1.8.0)
-    rdoc (6.4.0)
+    rdoc (6.6.3.1)
       psych (>= 4.0.0)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rspec_junit_formatter (0.5.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    ruby-prof (1.4.3)
+    rubocop (1.62.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    ruby-prof (1.6.3)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     rubyzip (2.3.2)
     semver2 (3.4.2)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    stringio (3.0.1)
+    stringio (3.1.0)
     thread_safe (0.3.6)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby
@@ -116,9 +144,10 @@ DEPENDENCIES
   rake
   rspec
   rspec_junit_formatter
+  rubocop
   ruby-prof
   rubyzip (>= 1.3.0)
   simplecov
 
 BUNDLED WITH
-   2.3.5
+   2.4.21

data/README.rdoc

@@ -1,7 +1,7 @@
 = rubyXL
-{<img src="https://badge.fury.io/rb/rubyXL.svg" alt="Gem Version" />}[http://badge.fury.io/rb/rubyXL]
-{<img src="https://codeclimate.com/github/weshatheleopard/rubyXL.png" alt="Code Climate" />}[https://codeclimate.com/github/weshatheleopard/rubyXL]
-{<img src="https://circleci.com/gh/weshatheleopard/rubyXL.svg?style=svg" alt="CircleCI" />}[https://circleci.com/gh/weshatheleopard/rubyXL]
+{rdoc-image:https://badge.fury.io/rb/rubyXL.svg}[http://badge.fury.io/rb/rubyXL]
+{rdoc-image:https://codeclimate.com/github/weshatheleopard/rubyXL.png}[https://codeclimate.com/github/weshatheleopard/rubyXL]
+{rdoc-image:https://circleci.com/gh/weshatheleopard/rubyXL.svg?style=svg}[https://circleci.com/gh/weshatheleopard/rubyXL]
 
 This gem supports operating on +xlsx+ files (Open XML format). While it is capable
 of properly parsing the entire OOXML structure, its current main emphasis is on
@@ -59,6 +59,10 @@ Please note that row is a _sparse_ array of cells. Your code *must* expect that
   cell.value                 # Returns a properly converted value in the cell (if the file claims that the cell
                              # is holding a number, returns a respective Integer or Float, and so on).
 
+Or, if you prefer Excel-style references (single-cell only!)
+
+  cell = worksheet.cell_at('B11')
+
 ==== Wrappers for accessing Cell properties
   cell = workbook[0][0][0]
   cell.is_struckthrough  # Returns +true+ if the cell is struckthrough, other boolean properties have same syntax

data/Rakefile

@@ -1,13 +1,11 @@
-# encoding: utf-8
-
 require 'rubygems'
 
 require 'bundler'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts 'Run `bundle install` to install missing gems'
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 
@@ -17,8 +15,8 @@ Juwelier::Tasks.new do |gem|
   gem.name = 'rubyXL'
   gem.homepage = 'http://github.com/gilt/rubyXL'
   gem.license = 'MIT'
-  gem.summary = %Q{rubyXL is a gem which allows the parsing, creation, and manipulation of Microsoft Excel (.xlsx/.xlsm) Documents}
-  gem.description = %Q{rubyXL is a gem which allows the parsing, creation, and manipulation of Microsoft Excel (.xlsx/.xlsm) Documents}
+  gem.summary = %q{rubyXL is a gem which allows the parsing, creation, and manipulation of Microsoft Excel (.xlsx/.xlsm) Documents}
+  gem.description = %q{rubyXL is a gem which allows the parsing, creation, and manipulation of Microsoft Excel (.xlsx/.xlsm) Documents}
   gem.email = 'bhagwat.vivek@gmail.com'
   gem.authors = ['Vivek Bhagwat', 'Wesha']
 #  gem.required_ruby_version = '>2.1'
@@ -53,7 +51,7 @@ task :stackprof do
   require 'benchmark'
   require 'stackprof'
 
-  $:.unshift File.dirname(__FILE__) + '/lib'  # Make Ruby aware of load path
+  $LOAD_PATH.unshift File.dirname(__FILE__) + '/lib'  # Make Ruby aware of load path
   require './lib/rubyXL'
 
   spreadsheets = Dir.glob(File.join('test', 'input', '*.xls?')).sort!
@@ -80,7 +78,7 @@ task :rubyprof do
   require 'benchmark'
   require 'ruby-prof'
 
-  $:.unshift File.dirname(__FILE__) + '/lib'  # Make Ruby aware of load path
+  $LOAD_PATH.unshift File.dirname(__FILE__) + '/lib'  # Make Ruby aware of load path
   require './lib/rubyXL'
 
   spreadsheets = Dir.glob(File.join('test', 'input', '*.xls?')).sort!

data/VERSION

@@ -1 +1 @@
-3.4.24
+3.4.26

data/lib/rubyXL/cell.rb

@@ -6,7 +6,7 @@ module RubyXL
 
     private
 
-    def validate_workbook()
+    def validate_workbook
       unless workbook.nil? || workbook.worksheets.nil?
         workbook.worksheets.each { |sheet|
           unless sheet.nil? || sheet.sheet_data.nil? || sheet.sheet_data[row].nil?
@@ -19,7 +19,7 @@ module RubyXL
       raise "This cell #{self} is not in workbook #{workbook}"
     end
 
-    def validate_worksheet()
+    def validate_worksheet
       return if @worksheet && @worksheet[row] && @worksheet[row][column].equal?(self)
       raise "Cell #{self} is not in worksheet #{worksheet}"
     end

data/lib/rubyXL/convenience_methods/cell.rb

@@ -79,61 +79,61 @@ module RubyXL
       self.style_index = workbook.modify_border_color(self.style_index, direction, color)
     end
 
-    def is_italicized()
+    def is_italicized
       validate_worksheet
       get_cell_font.is_italic
     end
 
-    def is_bolded()
+    def is_bolded
       validate_worksheet
       get_cell_font.is_bold
     end
 
-    def is_underlined()
+    def is_underlined
       validate_worksheet
       get_cell_font.is_underlined
     end
 
-    def is_struckthrough()
+    def is_struckthrough
       validate_worksheet
       get_cell_font.is_strikethrough
     end
 
-    def font_name()
+    def font_name
       validate_worksheet
       get_cell_font.get_name
     end
 
-    def font_size()
+    def font_size
       validate_worksheet
       get_cell_font.get_size
     end
 
-    def font_color()
+    def font_color
       validate_worksheet
       get_cell_font.get_rgb_color || '000000'
     end
 
-    def fill_color()
+    def fill_color
       validate_worksheet
       return workbook.get_fill_color(get_cell_xf)
     end
 
-    def horizontal_alignment()
+    def horizontal_alignment
       validate_worksheet
       xf_obj = get_cell_xf
       return nil if xf_obj.alignment.nil?
       xf_obj.alignment.horizontal
     end
 
-    def vertical_alignment()
+    def vertical_alignment
       validate_worksheet
       xf_obj = get_cell_xf
       return nil if xf_obj.alignment.nil?
       xf_obj.alignment.vertical
     end
 
-    def text_wrap()
+    def text_wrap
       validate_worksheet
       xf_obj = get_cell_xf
       return nil if xf_obj.alignment.nil?
@@ -147,7 +147,7 @@ module RubyXL
       xf_obj.alignment.text_rotation
     end
 
-    def text_indent()
+    def text_indent
       validate_worksheet
       xf_obj = get_cell_xf
       return nil if xf_obj.alignment.nil?
@@ -266,12 +266,10 @@ module RubyXL
       worksheet.hyperlinks << hyperlink
     end
 
-=begin
-    def add_shared_string(str)
-      self.datatype = RubyXL::DataType::SHARED_STRING
-      self.raw_value = @workbook.shared_strings_container.add(str)
-    end
-=end
+#     def add_shared_string(str)
+#       self.datatype = RubyXL::DataType::SHARED_STRING
+#       self.raw_value = @workbook.shared_strings_container.add(str)
+#     end
   end
 
   RubyXL::Cell.send(:include, RubyXL::CellConvenienceMethods) # ruby 2.1 compat

data/lib/rubyXL/convenience_methods/worksheet.rb

@@ -701,7 +701,7 @@ module RubyXL
       # "Any double quote characters in the value should be escaped with another double quote.
       # If the value does not contain a comma, newline or double quote, then the String value should be returned unchanged.
       # If the value contains a comma, newline or double quote, then the String value should be returned enclosed in double quotes."
-      expr = '"' + list_arr.collect{|str| str.gsub('"', '""')}.join(',') + '"'
+      expr = '"' + list_arr.collect{ |str| str.gsub('"', '""') }.join(',') + '"'
       self.data_validations ||= RubyXL::DataValidations.new
       self.data_validations <<
         RubyXL::DataValidation.new({:sqref    => RubyXL::Reference.new(ref),

data/lib/rubyXL/objects/chartsheet.rb

@@ -62,8 +62,7 @@ module RubyXL
     include RubyXL::RelationshipSupport
     define_relationship(RubyXL::DrawingFile)
 
-    attr_accessor :state, :rels
-    attr_accessor :workbook, :sheet_name, :sheet_id
+    attr_accessor :state, :rels, :workbook, :sheet_name, :sheet_id
 
     define_child_node(RubyXL::ChartsheetProperties)
     define_child_node(RubyXL::ChartsheetViews)

data/lib/rubyXL/objects/external_links.rb

@@ -55,11 +55,19 @@ module RubyXL
     define_element_name 'sheetDataSet'
   end
 
+  # https://learn.microsoft.com/en-us/openspecs/office_standards/ms-xlsx/452524b4-b22f-45a9-aac1-81fdd1f1db6c
+  class AlternateUrls < OOXMLObject
+    define_attribute(:absoluteUrl, :string, :required => false)
+    define_attribute(:relativeUrl, :string, :required => false)
+    define_element_name 'xxl21:alternateUrls'
+  end
+
   # http://www.datypic.com/sc/ooxml/e-ssml_externalBook-1.html
   class ExternalBook < OOXMLObject
     define_child_node(RubyXL::SheetNames)
     define_child_node(RubyXL::DefinedNamesExt)
     define_child_node(RubyXL::SheetDataSet)
+    define_child_node(RubyXL::AlternateUrls)
     define_relationship(:required => true)
     define_element_name 'externalBook'
   end

data/lib/rubyXL/objects/reference.rb

@@ -8,6 +8,7 @@ module RubyXL
     # RubyXL::Reference.new(row, col)
     # RubyXL::Reference.new(row_from, row_to, col_from, col_to)
     # RubyXL::Reference.new(reference_string)
+    # RubyXL::Reference.new(row_from:, row_to:, col_from:, col_to:)
     def initialize(*params)
       row_from = row_to = col_from = col_to = nil
 
@@ -15,10 +16,16 @@ module RubyXL
       when 4 then row_from, row_to, col_from, col_to = params
       when 2 then row_from, col_from = params
       when 1 then
-        raise ArgumentError.new("invalid value for #{self.class}: #{params[0].inspect}") unless params[0].is_a?(String)
-        from, to = params[0].split(':')
-        row_from, col_from = self.class.ref2ind(from)
-        row_to, col_to = self.class.ref2ind(to) unless to.nil?
+        case params.first
+        when Hash then
+          row_from, row_to, col_from, col_to = params.first.fetch_values(:row_from, :row_to, :col_from, :col_to)
+        when String then
+          from, to = params[0].split(':')
+          row_from, col_from = self.class.ref2ind(from)
+          row_to, col_to = self.class.ref2ind(to) unless to.nil?
+        else
+          raise ArgumentError.new("invalid value for #{self.class}: #{params[0].inspect}") unless params[0].is_a?(String)
+        end
       end
 
       @row_range = Range.new(row_from || 0, row_to || row_from || ROW_MAX)

data/lib/rubyXL/objects/storage.rb

@@ -169,6 +169,11 @@ module RubyXL
     REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/sheetMetadata'.freeze
   end
 
+  class PersonMetadata < GenericStorageObject
+    CONTENT_TYPE = 'application/vnd.ms-excel.person+xml'.freeze
+    REL_TYPE     = 'http://schemas.microsoft.com/office/2017/10/relationships/person'.freeze
+  end
+
   class ActiveX < GenericStorageObject
     REL_TYPE     = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/control'.freeze
 

data/lib/rubyXL/objects/workbook.rb

@@ -334,6 +334,7 @@ module RubyXL
     define_relationship(RubyXL::CustomXMLFile)
     define_relationship(RubyXL::MacrosFile, :macros)
     define_relationship(RubyXL::SlicerCacheFile)
+    define_relationship(RubyXL::PersonMetadata)
 
     define_child_node(RubyXL::FileVersion)
     define_child_node(RubyXL::FileSharing)
@@ -363,8 +364,7 @@ module RubyXL
                    'http://schemas.openxmlformats.org/markup-compatibility/2006'         => 'mc',
                    'http://schemas.microsoft.com/office/spreadsheetml/2010/11/main'      => 'x15')
 
-    attr_accessor :worksheets
-    attr_accessor :is_template
+    attr_accessor :worksheets, :is_template
 
     def before_write_xml
       max_sheet_id = worksheets.collect(&:sheet_id).compact.max || 0
@@ -422,8 +422,8 @@ module RubyXL
 
     def date_to_num(date)
       case date
-      when Date, DateTime then (date.ajd - base_date().ajd).to_f
-      when Time then ((date.to_r - base_date().to_time.to_r) / 86400).to_f
+      when Date, DateTime then (date.ajd - base_date.ajd).to_f
+      when Time then ((date.to_r - base_date.to_time.to_r) / 86400).to_f
       end
     end
 

data/lib/rubyXL/worksheet.rb

@@ -72,7 +72,7 @@ module RubyXL
     private
 
     # validates Workbook, ensures that this worksheet is in @workbook
-    def validate_workbook()
+    def validate_workbook
       unless @workbook.nil? || @workbook.worksheets.nil?
         return if @workbook.worksheets.any? { |sheet| sheet.equal?(self) }
       end