diff options
| author | Geremia Taglialatela <[email protected]> | 2023-06-05 17:14:59 +0200 |
|---|---|---|
| committer | Geremia Taglialatela <[email protected]> | 2023-06-05 17:27:41 +0200 |
| commit | b0fb7d1f19afbc933b3aa445f5d95d4b6bef9f6b (patch) | |
| tree | a50309ea3b0db8a2de8d3f6985ba29de3b826f5a | |
| parent | 0cc60e3eb08e11542612871e2e15350ed07fff06 (diff) | |
| download | caxlsx-b0fb7d1f19afbc933b3aa445f5d95d4b6bef9f6b.tar.gz caxlsx-b0fb7d1f19afbc933b3aa445f5d95d4b6bef9f6b.zip | |
Prefer `Kernel#format` to `String#%`
This commit fixes cases that cannot be detected by RuboCop
Ref: https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style/FormatString
| -rw-r--r-- | lib/axlsx/drawing/chart.rb | 2 | ||||
| -rw-r--r-- | lib/axlsx/drawing/drawing.rb | 4 | ||||
| -rw-r--r-- | lib/axlsx/drawing/vml_drawing.rb | 2 | ||||
| -rw-r--r-- | lib/axlsx/stylesheet/styles.rb | 4 | ||||
| -rw-r--r-- | lib/axlsx/util/validators.rb | 4 | ||||
| -rw-r--r-- | lib/axlsx/workbook/workbook.rb | 4 | ||||
| -rw-r--r-- | lib/axlsx/workbook/worksheet/comments.rb | 2 | ||||
| -rw-r--r-- | lib/axlsx/workbook/worksheet/pivot_table.rb | 4 | ||||
| -rw-r--r-- | lib/axlsx/workbook/worksheet/pivot_table_cache_definition.rb | 2 | ||||
| -rw-r--r-- | lib/axlsx/workbook/worksheet/table.rb | 2 | ||||
| -rw-r--r-- | lib/axlsx/workbook/worksheet/worksheet.rb | 12 | ||||
| -rw-r--r-- | test/content_type/tc_content_type.rb | 22 | ||||
| -rw-r--r-- | test/workbook/worksheet/tc_comments.rb | 2 |
13 files changed, 33 insertions, 33 deletions
diff --git a/lib/axlsx/drawing/chart.rb b/lib/axlsx/drawing/chart.rb index 6b3acab1..63a12641 100644 --- a/lib/axlsx/drawing/chart.rb +++ b/lib/axlsx/drawing/chart.rb @@ -124,7 +124,7 @@ module Axlsx # The part name for this chart # @return [String] def pn - CHART_PN % (index + 1) + format(CHART_PN, index + 1) end # The title object for the chart. diff --git a/lib/axlsx/drawing/drawing.rb b/lib/axlsx/drawing/drawing.rb index 8ae4ed0c..c927a6c9 100644 --- a/lib/axlsx/drawing/drawing.rb +++ b/lib/axlsx/drawing/drawing.rb @@ -128,14 +128,14 @@ module Axlsx # The part name for this drawing # @return [String] def pn - DRAWING_PN % (index + 1) + format(DRAWING_PN, index + 1) end # The relational part name for this drawing # #NOTE This should be rewritten to return an Axlsx::Relationship object. # @return [String] def rels_pn - DRAWING_RELS_PN % (index + 1) + format(DRAWING_RELS_PN, index + 1) end # A list of objects this drawing holds. diff --git a/lib/axlsx/drawing/vml_drawing.rb b/lib/axlsx/drawing/vml_drawing.rb index 15698486..9132b00c 100644 --- a/lib/axlsx/drawing/vml_drawing.rb +++ b/lib/axlsx/drawing/vml_drawing.rb @@ -14,7 +14,7 @@ module Axlsx # The part name for this vml drawing # @return [String] def pn - VML_DRAWING_PN % (@comments.worksheet.index + 1) + format(VML_DRAWING_PN, @comments.worksheet.index + 1) end # serialize the vml_drawing to xml. diff --git a/lib/axlsx/stylesheet/styles.rb b/lib/axlsx/stylesheet/styles.rb index 6356d9e6..bdda36c7 100644 --- a/lib/axlsx/stylesheet/styles.rb +++ b/lib/axlsx/stylesheet/styles.rb @@ -370,7 +370,7 @@ module Axlsx if options[:border].is_a?(Integer) if options[:border] >= borders.size - raise ArgumentError, (ERR_INVALID_BORDER_ID % options[:border]) + raise ArgumentError, format(ERR_INVALID_BORDER_ID, options[:border]) end if options[:type] == :dxf @@ -382,7 +382,7 @@ module Axlsx validate_border_hash = ->(val) { unless val.key?(:style) && val.key?(:color) - raise ArgumentError, (ERR_INVALID_BORDER_OPTIONS % options[:border]) + raise ArgumentError, format(ERR_INVALID_BORDER_OPTIONS, options[:border]) end } diff --git a/lib/axlsx/util/validators.rb b/lib/axlsx/util/validators.rb index 1357f4f3..8533145d 100644 --- a/lib/axlsx/util/validators.rb +++ b/lib/axlsx/util/validators.rb @@ -71,7 +71,7 @@ module Axlsx # @para, [Any] v the value to validate # @raise [ArgumentError] raised if the value cannot be converted to an integer def self.validate_integerish(v) - raise ArgumentError, (ERR_INTEGERISH % v.inspect) unless v.respond_to?(:to_i) && v.to_i.is_a?(Integer) + raise ArgumentError, format(ERR_INTEGERISH, v.inspect) unless v.respond_to?(:to_i) && v.to_i.is_a?(Integer) end # Requires that the value is between -54000000 and 54000000 @@ -79,7 +79,7 @@ module Axlsx # @raise [ArgumentError] raised if the value cannot be converted to an integer between the allowed angle values for chart label rotation. # @return [Boolean] true if the data is valid def self.validate_angle(v) - raise ArgumentError, (ERR_ANGLE % v.inspect) unless v.to_i >= -5400000 && v.to_i <= 5400000 + raise ArgumentError, format(ERR_ANGLE, v.inspect) unless v.to_i >= -5400000 && v.to_i <= 5400000 end # Validates an unsigned intger diff --git a/lib/axlsx/workbook/workbook.rb b/lib/axlsx/workbook/workbook.rb index 271d4300..0f4db9ce 100644 --- a/lib/axlsx/workbook/workbook.rb +++ b/lib/axlsx/workbook/workbook.rb @@ -354,10 +354,10 @@ module Axlsx def relationships r = Relationships.new @worksheets.each do |sheet| - r << Relationship.new(sheet, WORKSHEET_R, WORKSHEET_PN % (r.size + 1)) + r << Relationship.new(sheet, WORKSHEET_R, format(WORKSHEET_PN, r.size + 1)) end pivot_tables.each_with_index do |pivot_table, index| - r << Relationship.new(pivot_table.cache_definition, PIVOT_TABLE_CACHE_DEFINITION_R, PIVOT_TABLE_CACHE_DEFINITION_PN % (index + 1)) + r << Relationship.new(pivot_table.cache_definition, PIVOT_TABLE_CACHE_DEFINITION_R, format(PIVOT_TABLE_CACHE_DEFINITION_PN, index + 1)) end r << Relationship.new(self, STYLES_R, STYLES_PN) if use_shared_strings diff --git a/lib/axlsx/workbook/worksheet/comments.rb b/lib/axlsx/workbook/worksheet/comments.rb index b27a1940..abf24763 100644 --- a/lib/axlsx/workbook/worksheet/comments.rb +++ b/lib/axlsx/workbook/worksheet/comments.rb @@ -20,7 +20,7 @@ module Axlsx # The part name for this object # @return [String] def pn - COMMENT_PN % (index + 1) + format(COMMENT_PN, index + 1) end # Creates a new Comments object diff --git a/lib/axlsx/workbook/worksheet/pivot_table.rb b/lib/axlsx/workbook/worksheet/pivot_table.rb index 00ffe92d..f7607f57 100644 --- a/lib/axlsx/workbook/worksheet/pivot_table.rb +++ b/lib/axlsx/workbook/worksheet/pivot_table.rb @@ -159,13 +159,13 @@ module Axlsx # The part name for this table # @return [String] def pn - PIVOT_TABLE_PN % (index + 1) + format(PIVOT_TABLE_PN, index + 1) end # The relationship part name of this pivot table # @return [String] def rels_pn - PIVOT_TABLE_RELS_PN % (index + 1) + format(PIVOT_TABLE_RELS_PN, index + 1) end # The cache_definition for this pivot table diff --git a/lib/axlsx/workbook/worksheet/pivot_table_cache_definition.rb b/lib/axlsx/workbook/worksheet/pivot_table_cache_definition.rb index 5bb946a0..3a6053e9 100644 --- a/lib/axlsx/workbook/worksheet/pivot_table_cache_definition.rb +++ b/lib/axlsx/workbook/worksheet/pivot_table_cache_definition.rb @@ -26,7 +26,7 @@ module Axlsx # The part name for this table # @return [String] def pn - PIVOT_TABLE_CACHE_DEFINITION_PN % (index + 1) + format(PIVOT_TABLE_CACHE_DEFINITION_PN, index + 1) end # The identifier for this cache diff --git a/lib/axlsx/workbook/worksheet/table.rb b/lib/axlsx/workbook/worksheet/table.rb index 4221925d..2bfb64eb 100644 --- a/lib/axlsx/workbook/worksheet/table.rb +++ b/lib/axlsx/workbook/worksheet/table.rb @@ -44,7 +44,7 @@ module Axlsx # The part name for this table # @return [String] def pn - TABLE_PN % (index + 1) + format(TABLE_PN, index + 1) end # The relationship id for this table. diff --git a/lib/axlsx/workbook/worksheet/worksheet.rb b/lib/axlsx/workbook/worksheet/worksheet.rb index d4840050..e3e409af 100644 --- a/lib/axlsx/workbook/worksheet/worksheet.rb +++ b/lib/axlsx/workbook/worksheet/worksheet.rb @@ -345,13 +345,13 @@ module Axlsx # The part name of this worksheet # @return [String] def pn - WORKSHEET_PN % (index + 1) + format(WORKSHEET_PN, index + 1) end # The relationship part name of this worksheet # @return [String] def rels_pn - WORKSHEET_RELS_PN % (index + 1) + format(WORKSHEET_RELS_PN, index + 1) end # The relationship id of this worksheet. @@ -673,7 +673,7 @@ module Axlsx parts.first else if parts.size > 2 - raise ArgumentError, (ERR_CELL_REFERENCE_INVALID % cell_def) + raise ArgumentError, format(ERR_CELL_REFERENCE_INVALID, cell_def) elsif parts.first.nil? raise ArgumentError, format(ERR_CELL_REFERENCE_MISSING_CELL, cell_def.split(":").first, cell_def) elsif parts.last.nil? @@ -756,12 +756,12 @@ module Axlsx raise ArgumentError, ERR_SHEET_NAME_EMPTY if name.empty? character_length = name.encode("utf-16")[1..-1].encode("utf-16").bytesize / 2 - raise ArgumentError, (ERR_SHEET_NAME_TOO_LONG % name) if character_length > WORKSHEET_MAX_NAME_LENGTH - raise ArgumentError, (ERR_SHEET_NAME_CHARACTER_FORBIDDEN % name) if WORKSHEET_NAME_FORBIDDEN_CHARS.any? { |char| name.include? char } + raise ArgumentError, format(ERR_SHEET_NAME_TOO_LONG, name) if character_length > WORKSHEET_MAX_NAME_LENGTH + raise ArgumentError, format(ERR_SHEET_NAME_CHARACTER_FORBIDDEN, name) if WORKSHEET_NAME_FORBIDDEN_CHARS.any? { |char| name.include? char } name = Axlsx::coder.encode(name) sheet_names = @workbook.worksheets.reject { |s| s == self }.map(&:name) - raise ArgumentError, (ERR_DUPLICATE_SHEET_NAME % name) if sheet_names.include?(name) + raise ArgumentError, format(ERR_DUPLICATE_SHEET_NAME, name) if sheet_names.include?(name) end def serializable_parts diff --git a/test/content_type/tc_content_type.rb b/test/content_type/tc_content_type.rb index a3c6603f..2108c1fe 100644 --- a/test/content_type/tc_content_type.rb +++ b/test/content_type/tc_content_type.rb @@ -21,30 +21,30 @@ class TestContentType < Test::Unit::TestCase # default assert_equal(2, @doc.xpath("//xmlns:Default").size, "There should be 2 default types") - node = @doc.xpath(d_path % Axlsx::XML_CT).first + node = @doc.xpath(format(d_path, Axlsx::XML_CT)).first assert_equal(node["Extension"], Axlsx::XML_EX.to_s, "xml content type invalid") - node = @doc.xpath(d_path % Axlsx::RELS_CT).first + node = @doc.xpath(format(d_path, Axlsx::RELS_CT)).first assert_equal(node["Extension"], Axlsx::RELS_EX.to_s, "relationships content type invalid") # overrride assert_equal(4, @doc.xpath("//xmlns:Override").size, "There should be 4 Override types") - node = @doc.xpath(o_path % Axlsx::APP_CT).first + node = @doc.xpath(format(o_path, Axlsx::APP_CT)).first assert_equal(node["PartName"], "/#{Axlsx::APP_PN}", "App part name invalid") - node = @doc.xpath(o_path % Axlsx::CORE_CT).first + node = @doc.xpath(format(o_path, Axlsx::CORE_CT)).first assert_equal(node["PartName"], "/#{Axlsx::CORE_PN}", "Core part name invalid") - node = @doc.xpath(o_path % Axlsx::STYLES_CT).first + node = @doc.xpath(format(o_path, Axlsx::STYLES_CT)).first assert_equal(node["PartName"], "/xl/#{Axlsx::STYLES_PN}", "Styles part name invalid") - node = @doc.xpath(o_path % Axlsx::WORKBOOK_CT).first + node = @doc.xpath(format(o_path, Axlsx::WORKBOOK_CT)).first assert_equal(node["PartName"], "/#{Axlsx::WORKBOOK_PN}", "Workbook part invalid") end @@ -56,13 +56,13 @@ class TestContentType < Test::Unit::TestCase doc = Nokogiri::XML(@package.send(:content_types).to_xml_string) assert_equal(5, doc.xpath("//xmlns:Override").size, "adding a worksheet should add another type") - assert_equal(doc.xpath(o_path % Axlsx::WORKSHEET_CT).last["PartName"], "/xl/#{ws.pn}", "Worksheet part invalid") + assert_equal(doc.xpath(format(o_path, Axlsx::WORKSHEET_CT)).last["PartName"], "/xl/#{ws.pn}", "Worksheet part invalid") ws = @package.workbook.add_worksheet doc = Nokogiri::XML(@package.send(:content_types).to_xml_string) assert_equal(6, doc.xpath("//xmlns:Override").size, "adding workship should add another type") - assert_equal(doc.xpath(o_path % Axlsx::WORKSHEET_CT).last["PartName"], "/xl/#{ws.pn}", "Worksheet part invalid") + assert_equal(doc.xpath(format(o_path, Axlsx::WORKSHEET_CT)).last["PartName"], "/xl/#{ws.pn}", "Worksheet part invalid") end def test_drawings_and_charts_need_content_types @@ -73,13 +73,13 @@ class TestContentType < Test::Unit::TestCase doc = Nokogiri::XML(@package.send(:content_types).to_xml_string) assert_equal(7, doc.xpath("//xmlns:Override").size, "expected 7 types got #{doc.css('Types Override').size}") - assert_equal(doc.xpath(o_path % Axlsx::DRAWING_CT).first["PartName"], "/xl/#{ws.drawing.pn}", "Drawing part name invlid") - assert_equal(doc.xpath(o_path % Axlsx::CHART_CT).last["PartName"], "/xl/#{c.pn}", "Chart part name invlid") + assert_equal(doc.xpath(format(o_path, Axlsx::DRAWING_CT)).first["PartName"], "/xl/#{ws.drawing.pn}", "Drawing part name invlid") + assert_equal(doc.xpath(format(o_path, Axlsx::CHART_CT)).last["PartName"], "/xl/#{c.pn}", "Chart part name invlid") c = ws.add_chart Axlsx::Pie3DChart doc = Nokogiri::XML(@package.send(:content_types).to_xml_string) assert_equal(8, doc.xpath("//xmlns:Override").size, "expected 7 types got #{doc.css('Types Override').size}") - assert_equal(doc.xpath(o_path % Axlsx::CHART_CT).last["PartName"], "/xl/#{c.pn}", "Chart part name invlid") + assert_equal(doc.xpath(format(o_path, Axlsx::CHART_CT)).last["PartName"], "/xl/#{c.pn}", "Chart part name invlid") end end diff --git a/test/workbook/worksheet/tc_comments.rb b/test/workbook/worksheet/tc_comments.rb index d9be807e..b3de3acd 100644 --- a/test/workbook/worksheet/tc_comments.rb +++ b/test/workbook/worksheet/tc_comments.rb @@ -37,7 +37,7 @@ class TestComments < Test::Unit::TestCase end def test_pn - assert_equal(@ws.comments.pn, Axlsx::COMMENT_PN % (@ws.index + 1).to_s) + assert_equal(@ws.comments.pn, format(Axlsx::COMMENT_PN, @ws.index + 1)) end def test_index |
