rubyXL 3.4.14 → 3.4.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6d7d1c02347b372b277757fa2fdc86362f4084c6d2aaaa5e34cb5f43d95f105
-  data.tar.gz: cc4169e2863565f21aeb0a32e3b7f485bbc234a81c3376de91fb657fe52a1794
+  metadata.gz: 14119a8af99822bbe1fd209a060d5374e92fe921750766cc83fa2cebdf586963
+  data.tar.gz: a3870a59650bd9b32c82bd6ad950aa720cb9f50370b96956eecb522d1c8e8fce
 SHA512:
-  metadata.gz: a782eb58f6a39b6a72de09a0cf14e65832efd968953083d051fd3b555a9f848b46af80806af586f28d4429825a12e53c9569a3ec3d0e55a48c8dbc031c21595a
-  data.tar.gz: 8bf1ac6bcbe54d4f56c8378684cb4934beefe7c4ef2f703a84f22206d8b192629398b02ce996efe8c815c3fcc33e9cbe5b1aef56c749b2b151d25e20710c4bba
+  metadata.gz: 27f8bf50de4801721703c78a73b156626998d37a7fa1ce76a05e2848d9bf233a29ed91044567b2b02a8cd29487872f2a5ed2eeeb65c45ae6b3fed8b4bfccea25
+  data.tar.gz: 7ba264f255d544ba9efb9bb5aaa272a2ba84442930bf41eb72c6a63571b0ed21a69255975c843b796725ce17ca29c81950b1784a0c027a54dc35e4801ea0870e

data/.circleci/config.yml

@@ -7,7 +7,7 @@ jobs:
   build:
     docker:
       # specify the version you desire here
-      - image: circleci/ruby:2.4.1-node-browsers
+      - image: cimg/ruby:3.1.4
 
       # Specify service dependencies here if necessary
       # CircleCI maintains a library of pre-built images
@@ -29,6 +29,7 @@ jobs:
       - run:
           name: install dependencies
           command: |
+            gem install bundler
             bundle install --jobs=4 --retry=3 --path vendor/bundle
 
       - save_cache:

data/.rubocop.yml

@@ -0,0 +1,124 @@
+#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
+
+# "Excessive" parentheses are your friend. You will understand it in time, Luke.
+Style/TernaryParentheses:
+  Enabled: false
+
+# Implicity is evil. Unwilingness to type a couple extra characters is laziness.
+Style/RedundantConstantBase:
+  Enabled: false
+
+# I don't see a good reason in this. Unless you are paid per line.
+Style/CommentedKeyword:
+  Enabled: false
+
+# Yes, some things are "redundant" but they are there exactly to drive home some point...
+Style/RedundantSelf:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Layout/FirstArrayElementIndentation:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LeadingCommentSpace:
+  Enabled: false
+
+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

@@ -1,18 +1,20 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 # Dependencies required to run this gem.
-gem "nokogiri", ">= 1.10.8"
-gem "rubyzip", ">= 1.3.0" , :require => 'zip'
+gem 'nokogiri', '>= 1.10.8'
+gem 'rubyzip', '>= 1.3.0' , :require => 'zip'
 
 # Development dependencies.
 group :development, :test do
-  gem "bundler"
-  gem "rake"
-  gem "jeweler"
-  gem "rspec"
-  gem "simplecov"
+  gem 'bundler'
+  gem 'rake'
+  gem 'juwelier'
+  gem 'rspec'
+  gem 'simplecov'
 
 #  gem 'stackprof'
   gem 'ruby-prof'
   gem 'rspec_junit_formatter'
+
+  gem 'rubocop'
 end

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
@@ -55,6 +55,14 @@ Please note that row is a _sparse_ array of cells. Your code *must* expect that
   worksheet.sheet_data[0][0] # Returns cell A1 in the worksheet
   worksheet[0][0]            # Returns cell A1 in the worksheet
 
+  cell = worksheet[0][0]
+  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
@@ -134,26 +142,25 @@ Please note: these methods are being phased out in favor of the OOXML object mod
 
 ==== Changing Alignment
 ===== Horizontal
-center, distributed, justify, left, right
+  # Possible alignments: center, distributed, justify, left, right
   worksheet.sheet_data[0][0].change_horizontal_alignment('center') # Sets A1 to be centered
   worksheet.change_row_horizontal_alignment(0, 'justify')          # Sets first row to be justified
   worksheet.change_column_horizontal_alignment(0, 'right')         # Sets first column to be right-aligned
 
 ===== Vertical
-bottom, center, distributed, top
+  # Possible alignments: bottom, center, distributed, top
   worksheet.sheet_data[0][0].change_vertical_alignment('bottom')  # Sets A1 to be bottom aligned
   worksheet.change_row_vertical_alignment(0, 'distributed')       # Sets first row to be distributed vertically
   worksheet.change_column_vertical_alignment(0, 'top')            # Sets first column to be top aligned
   
 ===== Rotation
+  # Possible values:
+  # * 0-90 - degrees counterclockwise, around the bottom LEFT corner of the cell;
+  # * 91-179 - degrees clockwise, around the bottom RIGHT corner of the cell;
+  # * 180-254 - degrees clockwise, around the bottom LEFT corner of the cell, text becomes progressively invisible
+  # * 255 - text is in normal rotation but displayed vertically (one letter under another), line feed starts new line to the right of the previous.
   worksheet.sheet_data[0][0].change_text_rotation(90)  # Sets A1 to be rotated by 90 degrees
 
-Values:
-* 0-90 - degrees counterclockwise, around the bottom LEFT corner of the cell;
-* 91-179 - degrees clockwise, around the bottom RIGHT corner of the cell;
-* 180-254 - degrees clockwise, around the bottom LEFT corner of the cell, text becomes progressively invisible
-* 255 - text is in normal rotation but displayed vertically (one letter under another), line feed starts new line to the right of the previous.
-
 ==== Changing Row Height
   worksheet.change_row_height(0, 30)  # Sets first row height to 30
 
@@ -161,7 +168,9 @@ Values:
   worksheet.change_column_width(0, 30)  # Sets first column width to 30
 
 ==== Merging Cells
-  worksheet.merge_cells(0, 0, 1, 1)  # Merges A1:B2
+  worksheet.merge_cells(0, 1, 2, 3)  # Merges B1:D3
+  worksheet.merge_cells('A2:C4')     # Merges A2:C4
+  worksheet.merge_cells(row_from: 0, row_to: 1, col_from 2:, col_to: 3) # Merges C1:D2
 
 ==== Insert Row
 This method will insert a row at specified index, pushing all rows below it down. It also copies styles from row above.
@@ -207,8 +216,14 @@ WARNING: Use of this method WILL break formulas referencing cells which have bee
   cell = worksheet[0][0]
   cell.set_number_format '0.0000%'    # For formats, see https://support.office.com/en-us/article/5026bbd6-04bc-48cd-bf33-80f18b4eae68
   cell.change_text_wrap(true)         # Makes the text in the cell to wrap.
+  cell.change_shrink_to_fit(true)     # Makes the text in the cell to shrink to fit.
   cell.change_text_indent(1)          # Indents the text in the cell by 1 level
 
+==== Add hyperlink to a Cell
+  cell.add_hyperlink('http://example.com')
+  cell.add_hyperlink('http://example.com', 'Some tooltip text')
+
+
 == I/O
 
 By default, the gem operates with files on the local filesystem:
@@ -229,6 +244,10 @@ It can also operate on +StringIO+ objects, thus eliminating the need to save the
 
   RubyXL.class_variable_set(:@@suppress_warnings, true)
 
+== Data validation (colloquially referred to as "dropdown list")
+
+  worksheet.add_validation_list("A1", [ "value1", "value2" ])
+
 == For more information
 Take a look at the files in spec/lib/ for rspecs on most methods
 
@@ -244,5 +263,5 @@ Take a look at the files in spec/lib/ for rspecs on most methods
 
 == Copyright
 
-Copyright (c) 2011 Vivek Bhagwat, 2013-2020 Wesha.
+Copyright (c) 2011 Vivek Bhagwat, 2013-2022 Wesha.
 See LICENSE.txt for further details.

data/Rakefile

@@ -1,29 +1,28 @@
-# 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
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  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.email = "bhagwat.vivek@gmail.com"
-  gem.authors = ["Vivek Bhagwat", 'Wesha']
+  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.email = 'bhagwat.vivek@gmail.com'
+  gem.authors = ['Vivek Bhagwat', 'Wesha']
 #  gem.required_ruby_version = '>2.1'
   # dependencies defined in Gemfile
 end
-Jeweler::RubygemsDotOrgTasks.new 
+Juwelier::RubygemsDotOrgTasks.new
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -39,7 +38,7 @@ task :default => :rspec
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "rubyXL #{version}"
@@ -47,42 +46,42 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-desc "Dump profiling data with stackprof"
+desc 'Dump profiling data with stackprof'
 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!
+  spreadsheets = Dir.glob(File.join('test', 'input', '*.xls?')).sort!
 
   spreadsheets.each { |input|
     puts "<<<--- Profiling parsing of #{input}..."
     doc = nil
-    StackProf.run(:mode => :cpu, :interval => 100, 
-                  :out  => "tmp/stackprof-cpu-parse-#{File.basename(input)}.dump") { 
+    StackProf.run(:mode => :cpu, :interval => 100,
+                  :out  => "tmp/stackprof-cpu-parse-#{File.basename(input)}.dump") {
       doc = RubyXL::Parser.parse(input)
     }
 
-    output = File.join("test", "output", File.basename(input))
-    puts  "--->>> Profiling writing of #{output}..."
-    StackProf.run(:mode => :cpu, :interval => 100, 
+    output = File.join('test', 'output', File.basename(input))
+    puts "--->>> Profiling writing of #{output}..."
+    StackProf.run(:mode => :cpu, :interval => 100,
                   :out  => "tmp/stackprof-cpu-write-#{File.basename(input)}.dump") {
       doc.write(output)
     }
   }
 end
 
-desc "Dump profiling data with ruby-prof"
+desc 'Dump profiling data with ruby-prof'
 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!
+  spreadsheets = Dir.glob(File.join('test', 'input', '*.xls?')).sort!
 
   spreadsheets.each { |input|
     puts "<<<--- Profiling parsing of #{input}..."
@@ -93,8 +92,8 @@ task :rubyprof do
     printer = RubyProf::CallStackPrinter.new(result)
     File.open("tmp/ruby-prof-parse-#{File.basename(input)}.html", 'w') { |f| printer.print(f, {}) }
 
-    output = File.join("test", "output", File.basename(input))
-    puts  "--->>> Profiling writing of #{output}..."
+    output = File.join('test', 'output', File.basename(input))
+    puts "--->>> Profiling writing of #{output}..."
     result = RubyProf.profile {
       doc.write(output)
     }

data/VERSION

@@ -1 +1 @@
-3.4.14
+3.4.33

data/lib/rubyXL/cell.rb

@@ -1,5 +1,4 @@
 module RubyXL
-
   module LegacyCell
     def workbook
       @worksheet.workbook
@@ -7,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?
@@ -20,10 +19,9 @@ 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
-
   end
 end

data/lib/rubyXL/convenience_methods/cell.rb

@@ -1,6 +1,5 @@
 module RubyXL
   module CellConvenienceMethods
-
     def change_contents(data, formula_expression = nil)
       validate_worksheet
 
@@ -9,12 +8,12 @@ module RubyXL
         self.formula = RubyXL::Formula.new(:expression => formula_expression)
       else
         self.datatype = case data
-                        when Date, Numeric then nil
+                        when Date, Time, Numeric then nil
                         else RubyXL::DataType::RAW_STRING
                         end
       end
 
-      data = workbook.date_to_num(data) if data.is_a?(Date)
+      data = workbook.date_to_num(data) if data.is_a?(Date) || data.is_a?(Time)
 
       self.raw_value = data
     end
@@ -54,6 +53,11 @@ module RubyXL
       self.style_index = workbook.modify_alignment(self.style_index) { |a| a.wrap_text = wrap }
     end
 
+    def change_shrink_to_fit(shrink_to_fit = false)
+      validate_worksheet
+      self.style_index = workbook.modify_alignment(self.style_index) { |a| a.shrink_to_fit = shrink_to_fit }
+    end
+
     def change_text_rotation(rot)
       validate_worksheet
       self.style_index = workbook.modify_alignment(self.style_index) { |a| a.text_rotation = rot }
@@ -75,75 +79,75 @@ 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)
+      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?
       xf_obj.alignment.wrap_text
     end
-    
+
     def text_rotation
       validate_worksheet
       xf_obj = get_cell_xf
       return nil if xf_obj.alignment.nil?
-      xf_obj.alignment.text_rotation    
+      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?
@@ -249,23 +253,23 @@ module RubyXL
       end
     end
 
-=begin
-    def add_hyperlink(l)
-      worksheet.hyperlinks ||= RubyXL::Hyperlinks.new
-      worksheet.hyperlinks << RubyXL::Hyperlink.new(:ref => self.r, :location => l)
-#    define_attribute(:'r:id',   :string)
-#    define_attribute(:location, :string)
-#    define_attribute(:tooltip,  :string)
-#    define_attribute(:display,  :string)
-
-    end
+    def add_hyperlink(url, tooltip = nil)
+      worksheet.relationship_container ||= RubyXL::OOXMLRelationshipsFile.new
+      relationships = worksheet.relationship_container.relationships
+      r_id = "rId#{relationships.size + 1}"
+      relationships << RubyXL::Relationship.new(:id => r_id, :target => url, :target_mode => 'External',
+                                                :type => RubyXL::HyperlinkRelFile::REL_TYPE)
 
-    def add_shared_string(str)
-      self.datatype = RubyXL::DataType::SHARED_STRING
-      self.raw_value = @workbook.shared_strings_container.add(str)
+      hyperlink = RubyXL::Hyperlink.new(:ref => self.r, :r_id => r_id)
+      hyperlink.tooltip = tooltip if tooltip
+      worksheet.hyperlinks ||= RubyXL::Hyperlinks.new
+      worksheet.hyperlinks << hyperlink
     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