rubyXL 1.2.10 → 3.4.33

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14119a8af99822bbe1fd209a060d5374e92fe921750766cc83fa2cebdf586963
+  data.tar.gz: a3870a59650bd9b32c82bd6ad950aa720cb9f50370b96956eecb522d1c8e8fce
+SHA512:
+  metadata.gz: 27f8bf50de4801721703c78a73b156626998d37a7fa1ce76a05e2848d9bf233a29ed91044567b2b02a8cd29487872f2a5ed2eeeb65c45ae6b3fed8b4bfccea25
+  data.tar.gz: 7ba264f255d544ba9efb9bb5aaa272a2ba84442930bf41eb72c6a63571b0ed21a69255975c843b796725ce17ca29c81950b1784a0c027a54dc35e4801ea0870e

data/.circleci/config.yml

@@ -0,0 +1,60 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: cimg/ruby:3.1.4
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            gem install bundler
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec.xml \
+              --format progress \
+              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.codeclimate.yml

@@ -0,0 +1,3 @@
+exclude_patterns:
+- "rdoc/*"
+- "spec/*"

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,16 +1,20 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+source 'http://rubygems.org'
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.6.0"
-  gem "rcov", ">= 0"
-  gem "nokogiri", ">= 1.4.4"
-  gem "rubyzip", ">= 0.9.4"
-  gem "rspec", ">= 1.3.4"
+# Dependencies required to run this gem.
+gem 'nokogiri', '>= 1.10.8'
+gem 'rubyzip', '>= 1.3.0' , :require => 'zip'
+
+# Development dependencies.
+group :development, :test do
+  gem 'bundler'
+  gem 'rake'
+  gem 'juwelier'
+  gem 'rspec'
+  gem 'simplecov'
+
+#  gem 'stackprof'
+  gem 'ruby-prof'
+  gem 'rspec_junit_formatter'
+
+  gem 'rubocop'
 end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Vivek Bhagwat
+Copyright (c) 2011 Vivek Bhagwat, 2013-2020 Wesha
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,181 +1,252 @@
 = 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
+reading files produced by MS Excel, making minor modifications to them and saving
+them to be opened again, while preserving as much of the structure as possible.
+
+Please note that proprietary binary +xls+ format is *not* supported by this gem. If you need to parse those files, try {spreadsheet}[https://github.com/zdavatz/spreadsheet] gem.
 
 == To Install:
   gem install rubyXL
 
 == To Use:
-  require 'rubyXL' #assuming rubygems is already required
+  require 'rubyXL' # Assuming rubygems is already required
+
+=== Convenience methods
+
+Starting with version 3.4.0, the main data structure has been separated from the convenience methods that provide access to individual features of the +xlsx+ format, in order to decrease the memory footprint. If you intend to use these features, you will need to additionally include the respective files:
+  require 'rubyXL/convenience_methods/cell'
+  require 'rubyXL/convenience_methods/color'
+  require 'rubyXL/convenience_methods/font'
+  require 'rubyXL/convenience_methods/workbook'
+  require 'rubyXL/convenience_methods/worksheet'
+
+If you do not care about your RAM usage, just include them all at once by adding the following line to your code so it can continue operating just as before:
+  require 'rubyXL/convenience_methods'
 
 === Parsing an existing workbook
   workbook = RubyXL::Parser.parse("path/to/Excel/file.xlsx")
 
-
 === Creating a new Workbook
   workbook = RubyXL::Workbook.new
 
 === Accessing
 
 ==== Accessing a Worksheet
-  workbook.worksheets[0] #returns first worksheet
-  workbook[0] #returns first worksheet
-
-==== Accessing Only the Values
-  workbook.worksheets[0].extract_data #produces a 2d array which consists only of the values (instead of the Cell objects which include other variables)
+  workbook.worksheets[0] # Returns first worksheet
+  workbook[0]            # Returns first worksheet
+  workbook['Sheet1']     # Finds and returns worksheet titled "Sheet1". Note that sheet names in Excel are limited to 31 character.
 
 ==== Accessing a Row (Array of Cells)
-  workbook[0].sheet_data[0] #returns first row in first worksheet
-  workbook[0][0] #returns first row in first worksheet
-
-==== Accessing a Cell
-  workbook[0].sheet_data[0][0] #returns A1 in first worksheet
-  workbook[0][0][0] #returns A1 in first worksheet
-
-==== Accessing Cell properties
-  workbook[0][0][0].is_struckthrough() #returns if A1 is struckthrough, other boolean properties have same syntax
-  workbook[0][0][0].font_name #returns font name for A1
-  workbook[0][0][0].font_size #returns font size for A1
-  workbook[0][0][0].font_color #returns font color for A1
-  workbook[0][0][0].fill_color #returns fill color for A1
-  workbook[0][0][0].horizontal_alignment #returns horizontal alignment for A1 (or nil if it does not exist)
-  workbook[0][0][0].vertical_alignment #returns vertical alignment for A1 (or nil if it does not exist)
-  workbook[0][0][0].border_top #returns type of border on top of A1 (nil if none exists), other directions have same syntax
-
-==== Accessing row properties
-  workbook[0].get_row_fill(0) #returns fill color for first row
-  workbook[0].get_row_font_name(0) #returns font name for first row
-  workbook[0].get_row_font_size(0) #returns font size for first row
-  workbook[0].get_row_font_color(0) #returns font color for first row
-  workbook[0].is_row_underlined(0) #returns if first row is italicized, other boolean properties have same syntax
-  workbook[0].get_row_height(0) #returns height of first row
-  workbook[0].get_row_horizontal_alignment(0) #returns horizontal alignment of first row (nil if none exists)
-  workbook[0].get_row_vertical_alignment(0) #returns vertical alignment of first row (nil if none exists)
-  workbook[0].get_row_border_right(0) #returns weight of right border of first row (nil if none exists), other directions have the same syntax
+Please note that worksheet is a _sparse_ array of rows. Your code *must* expect that any row it plucks from the array may be <tt>nil</tt>.
+
+  worksheet = workbook[0]
+  worksheet.sheet_data[0] # Returns first row of the worksheet
+  worksheet[0]            # Returns first row of the worksheet
+
+==== Accessing a Cell object
+Please note that row is a _sparse_ array of cells. Your code *must* expect that any cell it plucks from the array may be <tt>nil</tt>.
+
+  worksheet = workbook[0]
+  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
+  cell.font_name
+  cell.font_size
+  cell.font_color
+  cell.fill_color
+  cell.horizontal_alignment
+  cell.vertical_alignment
+  cell.get_border(:top)
+  cell.get_border_color(:top)
+  cell.text_rotation
+
+==== Wrappers for accessing Row properties 
+Please note: these methods are being phased out in favor of the OOXML object model.
+  worksheet = workbook[0]
+  worksheet.get_row_fill(0)
+  worksheet.get_row_font_name(0)
+  worksheet.get_row_font_size(0)
+  worksheet.get_row_font_color(0)
+  worksheet.is_row_underlined(0)
+  worksheet.get_row_height(0)
+  worksheet.get_row_alignment(0, true)
+  worksheet.get_row_alignment(0, false)
+  worksheet.get_row_border(0, :right)
+  worksheet.get_row_border_color(0, :right)
 
 ==== Accessing column properties
-  workbook[0].get_column_fill(0) #returns fill color for first column
-  workbook[0].get_column_font_name(0) #returns font name for first column
-  workbook[0].get_column_font_size(0) #returns font size for first column
-  workbook[0].get_column_font_color(0) #returns font color for first column
-  workbook[0].is_column_underlined(0) #returns if first column is italicized, other boolean properties have same syntax
-  workbook[0].get_column_height(0) #returns height of first column
-  workbook[0].get_column_horizontal_alignment(0) #returns horizontal alignment of first column (nil if none exists)
-  workbook[0].get_column_vertical_alignment(0) #returns vertical alignment of first column (nil if none exists)
-  workbook[0].get_column_border_right(0) #returns weight of right border of first column (nil if none exists), other directions have the same syntax
-
-==== Table identification
-  workbook[0].get_table(["NAME", "AGE", "HEIGHT"]) #returns hash of a table in the first worksheet, with the specified strings as headers, accessible by row and column
-  #it returns the following structure
-  {
-   :Name=>["John", "Jane", "Joe"], 
-   :Height=>[70, 65, 68], 
-   :Age=>[30, 25, 35]
-   :table=>[
-    {:Name=>"John", :Height=>70, :Age=>30},
-    {:Name=>"Jane", :Height=>65, :Age=>25}, 
-    {:Name=>"Joe", :Height=>68, :Age=>35}
-   ]
-  }
+Please note: these methods are being phased out in favor of the OOXML object model.
+  worksheet = workbook[0]
+  worksheet.get_column_fill(0)
+  worksheet.get_column_font_name(0)
+  worksheet.get_column_font_size(0)
+  worksheet.get_column_font_color(0)
+  worksheet.is_column_underlined(0)
+  worksheet.get_column_width(0)
+  worksheet.get_column_alignment(0, :horizontal)
+  worksheet.get_column_alignment(0, :vertical)
+  worksheet.get_column_border(0, :right)
+  worksheet.get_column_border_color(0, :right)
 
 === Modifying
 
 ==== Adding Worksheets
-  workbook.worksheets << Worksheet.new('Sheet2')
+  worksheet = workbook.add_worksheet('Sheet2')
+
+==== Renaming Worksheets
+  worksheet.sheet_name = 'Cool New Name' # Note that sheet name is limited to 31 characters by Excel.
 
 ==== Adding Cells
-  workbook.worksheets[0].add_cell(0,0,'A1') #sets A1 to string "A1"
-  workbook.worksheets[0].add_cell(0,1,'','A1') #sets B1 to value of A1
+  worksheet.add_cell(0, 0, 'A1')      # Sets cell A1 to string "A1"
+  worksheet.add_cell(0, 1, '', 'A1')  # Sets formula in the cell B1 to '=A1'
  
-  workbook.worksheets[0].add_cell_obj(Cell.new(1,0,'blah')) #sets A2 to 'blah'
-
 ==== Changing Cells
-  workbook.worksheets[0][0][0].change_contents("", workbook.worksheets[0][0][0].formula) #sets A1 to empty string, preserves formula
+  worksheet[0][0].change_contents("", worksheet[0][0].formula) # Sets value of cell A1 to empty string, preserves formula
 
 ==== Changing Fonts
-  workbook.worksheets[0].sheet_data[0][0].change_font_bold(true) #sets A1 to bold
-  workbook.worksheets[0].change_row_font_italics(0,true) #makes first row italicized
-  workbook.worksheets[0].change_column_font_name(0,'Courier') #makes first column have font Courier
+  worksheet.sheet_data[0][0].change_font_bold(true) # Makes A1 bold
+  worksheet.change_row_italics(0,true)              # Makes first row italicized
+  worksheet.change_column_font_name(0, 'Courier')   # Makes first column have font Courier
 
 ==== Changing Fills	
-  workbook.worksheets[0].sheet_data[0][0].change_fill('0ba53d') #sets A1 to have fill #0ba53d
-  workbook.worksheets[0].change_row_fill(0, '0ba53d') #sets first row to have fill #0ba53d
-  workbook.worksheets[0].change_column_fill(0, '0ba53d') #sets first column to have fill #0ba53d
+  worksheet.sheet_data[0][0].change_fill('0ba53d')  # Sets A1 to have fill #0ba53d
+  worksheet.change_row_fill(0, '0ba53d')            # Sets first row to have fill #0ba53d
+  worksheet.change_column_fill(0, '0ba53d')         # Sets first column to have fill #0ba53d
 
 ==== Changing Borders
   # Possible weights: hairline, thin, medium, thick
   # Possible "directions": top, bottom, left, right, diagonal
-  workbook.worksheets[0].sheet_data[0][0].change_border_top('thin') #sets A1 to have a top, thin border
-  workbook.worksheets[0].change_row_border_left(0, 'hairline') #sets first row to have a left, hairline border
-  workbook.worksheets[0].change_column_border_diagonal(0, 'medium') #sets first column to have diagonal, medium border
+  worksheet.sheet_data[0][0].change_border(:top, 'thin')  # Sets A1 to have a top, thin border
+  worksheet.change_row_border(0, :left, 'hairline')       # Sets first row to have a left, hairline border
+  worksheet.change_column_border(0, :diagonal, 'medium')  # Sets first column to have diagonal, medium border
+
+  # Set the border style first so there's something to color.
+  worksheet.change_row_border_color(0, :top, '0ba53d')    # Sets first row to have a green top border
+  worksheet.change_column_border_color(0, :top, '0ba53d') # Sets first column to have a green top border
 
 ==== Changing Alignment
 ===== Horizontal
-center, distributed, justify, left, right
-  workbook.worksheets[0].sheet_data[0][0].change_horizontal_alignment('center') #sets A1 to be centered
-  workbook.worksheets[0].change_row_horizontal_alignment(0,'justify') #sets first row to be justified
-  workbook.worksheets[0].change_column_horizontal_alignment(0,'right'), #sets first column to be right-aligned
+  # 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
-  workbook.worksheets[0].sheet_data[0][0].change_vertical_alignment('bottom') #sets A1 to be bottom aligned
-  workbook.worksheets[0].change_row_vertical_alignment(0,'distributed') #sets first row to be distributed vertically
-  workbook.worksheets[0].change_column_vertical_alignment(0,'top') #sets first column to be top aligned
+  # 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
 
 ==== Changing Row Height
-  workbook.worksheets[0].change_row_height(0,30) #sets first row to be of height 30
+  worksheet.change_row_height(0, 30)  # Sets first row height to 30
 
 ==== Changing Column Width
-  workbook.worksheets[0].change_column_width(0,30) #sets first column to be of width 30
+  worksheet.change_column_width(0, 30)  # Sets first column width to 30
 
 ==== Merging Cells
-  workbook.worksheets[0].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.
 
 WARNING: Use of this method WILL break formulas referencing cells which have been moved, as the formulas do not adapt to the shifted rows
-  workbook.worksheets[0].insert_row(1)
+  worksheet.insert_row(1)
 
 ==== Insert Column
 This method will insert a column at specified index, pushing all columns to the right of it one to the right. It also copies styles from column to the left
 
 WARNING: Use of this method WILL break formulas referencing cells which have been moved, as the formulas do not adapt to the shifted columns
-  workbook.worksheets[0].insert_column(1)
+  worksheet.insert_column(1)
 
 ==== Delete Row
 This method will delete a row at specified index, pushing all rows below it up.
 
 WARNING: Use of this method WILL break formulas referencing cells which have been moved, as the formulas do not adapt to the shifted rows
-  workbook.worksheets[0].delete_row(1)
+  worksheet.delete_row(1)
 
 ==== Delete Column
 This method will delete a column at specified index, pushing all columns to the right of it left.
 
 WARNING: Use of this method WILL break formulas referencing cells which have been moved, as the formulas do not adapt to the shifted columns
- workbook.worksheets[0].delete_column(1)
+  worksheet.delete_column(1)
 
 ==== Insert Cell
 This method will insert a cell at specified position. It takes a :right or :down option, to shift cells either left or down upon inserting (nil means replacing the cell)
 
 WARNING: Use of this method WILL break formulas referencing cells which have been moved, as the formulas do not adapt to the shifted cells
-  workbook.worksheets[0].insert_cell(0,0,"blah",formula=nil,:right) #inserts cell at A1, shifts cells in first row right
-  workbook.worksheets[0].insert_cell(0,0,"blah",formula=nil,:down) #inserts cell at A1, shifts cells in first column down
-  workbook.worksheets[0].insert_cell(0,0,"blah") #inserts cell at A1, shifts nothing
+  worksheet.insert_cell(0, 0, "blah", formula = nil, :right)  # Inserts cell at A1, shifts cells in first row right
+  worksheet.insert_cell(0, 0, "blah", formula = nil, :down)   # Inserts cell at A1, shifts cells in first column down
+  worksheet.insert_cell(0, 0, "blah")                         # Inserts cell at A1, shifts nothing
 
 ==== Delete Cell
 This method will delete a cell at specified position. It takes a :left or :up option, to shift cells either up or left upon deletion (nil means simply deleting the cell contents)
 
 WARNING: Use of this method WILL break formulas referencing cells which have been moved, as the formulas do not adapt to the shifted cells
-  workbook.worksheets[0].delete_cell(0,0,:left) #deletes A1, shifts contents of first row left
-  workbook.worksheets[0].delete_cell(0,0,:up) #deletes A1, shifts contents of first column up
-  workbook.worksheets[0].delete_cell(0,0) #deletes A1, does not shift cells
+  worksheet.delete_cell(0, 0, :left)  # Deletes A1, shifts contents of first row left
+  worksheet.delete_cell(0, 0, :up)    # Deletes A1, shifts contents of first column up
+  worksheet.delete_cell(0, 0)         # Deletes A1, does not shift cells
+
+==== Modifying Cell Format
+  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
 
-=== Writing
+==== 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:
+
+  workbook = RubyXL::Parser.parse("path/to/Excel/file.xlsx")
   workbook.write("path/to/desired/Excel/file.xlsx")
 
+It can also operate on +StringIO+ objects, thus eliminating the need to save the +xlsx+ file to disk. This capability comes in handy for web servers.
+
+  workbook = RubyXL::Parser.parse_buffer(buffer)
+  workbook.stream
 
-=== Miscellaneous
-  Cell.convert_to_cell(0,0) == 'A1' #converts row and column index to Excel-style index
-  Parser.convert_to_index('A1') == [0,0] #converts Excel-style index to row and column index
+== Miscellaneous
+  RubyXL::Reference.ind2ref(0,0) == 'A1'    # Converts row and column index to Excel-style cell reference
+  RubyXL::Reference.ref2ind('A1') == [0, 0] # Converts Excel-style cell reference to row and column index
+
+=== Suppress warnings about malformed input files
+
+  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
@@ -192,6 +263,5 @@ Take a look at the files in spec/lib/ for rspecs on most methods
 
 == Copyright
 
-Copyright (c) 2011 Vivek Bhagwat. See LICENSE.txt for
-further details.
-
+Copyright (c) 2011 Vivek Bhagwat, 2013-2022 Wesha.
+See LICENSE.txt for further details.