axlsx_styler 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83dfa2cca4c51645feaa8b0dbf6693af425e42d9
-  data.tar.gz: 770fb362a94bc3ce157dbd4df1d61ff657910882
+  metadata.gz: c39cb63343b8e6febf1d49849f79bedec5a7411f
+  data.tar.gz: 25548e35f4641c7ac07dba8c006d90e530ae0eb9
 SHA512:
-  metadata.gz: feba1d502575df2c5742ec0f3aeaf99c12cd9e571e5aab9fb3b58d917ffeea0c866c01b9edfb381b1b3f3b0b41b143fb6d024536c6791348b49d58d747a94ddd
-  data.tar.gz: 11fbe7c050e4091a084062567478ed84c58cee2a1f6e4a3f055002ad0e8974cdcbc2763b323ad81e1c34442b80c7b290cdbacaef9a42814c19f155ec251437bf
+  metadata.gz: 32d496b6251695a0fe9e05ce72fa5a930039f5df6bcb307bf9d0116c87e06f82b73195e6a631dd7cbe89e6cf1230e2aa3a125470d833704872b80f323d4d4ce4
+  data.tar.gz: 37898e7b43cbaab2fccaf06c2586c2205b7382bff89144eebfc0599837a3f4cb55251b1968e3532472b127877837de48a7444545765766433527beb72ab1b965

data/README.md

@@ -14,21 +14,21 @@ This gem extend `Array` class in a way that allows you to apply
 styles to ranges of cells, e.g.
 
 ```ruby
-sheet["A1:D10"].add_style b: true
+sheet.add_style 'A1:D10', b: true
 ```
 
 The styles can be overlayed, so that later on you can add another style
 to cells that already have styles, e.g.
 
 ```ruby
-sheet["A1:D1"].add_style bg_color: 'FF0000'
+sheet.add_style 'A1:D1', bg_color: 'FF0000'
 ```
 
 You can also add borders to ranges of cells:
 
 ```ruby
-sheet["B2:D5"].add_border
-sheet["B2:B5"].add_border [:right]
+sheet.add_border 'B2:D5'
+sheet.add_border 'B2:D5', [:right]
 ```
 
 When you are done with styling you just need to run
@@ -38,7 +38,7 @@ workbook.apply_styles
 ```
 
 Here's an example that compares styling a simple table with and without
-AxlsxStyler. Suppose make our spreadsheet to look as follows:
+AxlsxStyler. Suppose we wand to create the following spreadsheet:
 
 ![alt text](./spreadsheet.png "Sample Spreadsheet")
 
@@ -51,34 +51,31 @@ require 'axlsx_styler'
 
 axlsx = Axlsx::Package.new
 workbook = axlsx.workbook
-
 workbook.add_worksheet do |sheet|
   sheet.add_row
-  sheet.add_row ["", "Product", "Category", "Price"]
-  sheet.add_row ["", "Butter", "Dairy", 4.99]
-  sheet.add_row ["", "Bread", "Baked Goods", 3.45]
-  sheet.add_row ["", "Broccoli", "Produce", 2.99]
+  sheet.add_row ['', 'Product', 'Category',  'Price']
+  sheet.add_row ['', 'Butter', 'Dairy',      4.99]
+  sheet.add_row ['', 'Bread', 'Baked Goods', 3.45]
+  sheet.add_row ['', 'Broccoli', 'Produce',  2.99]
   sheet.column_widths 5, 20, 20, 20
 
   # using AxlsxStyler DSL
-  sheet["B2:D2"].add_style b: true
-  sheet["B2:B5"].add_style b: true
-  sheet["B2:D2"].add_style bg_color: "95AFBA"
-  sheet["B3:D5"].add_style bg_color: "E2F89C"
-  sheet["D3:D5"].add_style alignment: { horizontal: :left }
-  sheet["B2:D5"].add_border
-  sheet["B3:D3"].add_border [:top]
+  sheet.add_style 'B2:D2', b: true
+  sheet.add_style 'B2:B5', b: true
+  sheet.add_style 'B2:D2', bg_color: '95AFBA'
+  sheet.add_style 'B3:D5', bg_color: 'E2F89C'
+  sheet.add_style 'D3:D5', alignment: { horizontal: :left }
+  sheet.add_border 'B2:D5'
+  sheet.add_border 'B3:D3', [:top]
 end
-
 workbook.apply_styles
-
-axlsx.serialize "grocery.xlsx"
+axlsx.serialize 'grocery.xlsx'
 ```
 
 ### With plain `Axlsx` gem
 
 This example can be DRYied up, but it gives you a rough idea of what you
-need to go through.
+need to go through. You need to compile all the styles before you apply them.
 
 ```ruby
 require 'axlsx'

data/examples/colors_and_borders.rb

@@ -2,7 +2,6 @@ require 'axlsx_styler'
 
 axlsx = Axlsx::Package.new
 workbook = axlsx.workbook
-
 workbook.add_worksheet do |sheet|
   sheet.add_row
   sheet.add_row ['', 'Product', 'Category',  'Price']
@@ -12,15 +11,13 @@ workbook.add_worksheet do |sheet|
   sheet.column_widths 5, 20, 20, 20
 
   # using AxlsxStyler DSL
-  sheet['B2:D2'].add_style b: true
-  sheet['B2:B5'].add_style b: true
-  sheet['B2:D2'].add_style bg_color: '95AFBA'
-  sheet['B3:D5'].add_style bg_color: 'E2F89C'
-  sheet['D3:D5'].add_style alignment: { horizontal: :left }
-  sheet['B2:D5'].add_border
-  sheet['B3:D3'].add_border [:top]
+  sheet.add_style 'B2:D2', b: true
+  sheet.add_style 'B2:B5', b: true
+  sheet.add_style 'B2:D2', bg_color: '95AFBA'
+  sheet.add_style 'B3:D5', bg_color: 'E2F89C'
+  sheet.add_style 'D3:D5', alignment: { horizontal: :left }
+  sheet.add_border 'B2:D5'
+  sheet.add_border 'B3:D3', [:top]
 end
-
 workbook.apply_styles
-
 axlsx.serialize File.expand_path('../../tmp/grocery.xlsx', __FILE__)

data/lib/axlsx_styler.rb

@@ -1,10 +1,10 @@
 require 'axlsx'
 
 require 'axlsx_styler/version'
-require 'axlsx_styler/array'
 require 'axlsx_styler/axlsx_workbook'
+require 'axlsx_styler/axlsx_worksheet'
 require 'axlsx_styler/axlsx_cell'
 
-Array.send :include, AxlsxStyler::Array
 Axlsx::Workbook.send :include, AxlsxStyler::Axlsx::Workbook
+Axlsx::Worksheet.send :include, AxlsxStyler::Axlsx::Worksheet
 Axlsx::Cell.send :include, AxlsxStyler::Axlsx::Cell

data/lib/axlsx_styler/axlsx_worksheet.rb

@@ -0,0 +1,25 @@
+require_relative './border_creator'
+
+module AxlsxStyler
+  module Axlsx
+    module Worksheet
+      # Example:
+      #   add_style 'A1:B5', b: true, sz: 14
+      def add_style(cell_ref, style)
+        item = self[cell_ref]
+        cells = item.is_a?(Array) ? item : [item]
+        cells.each { |cell| cell.add_style(style) }
+      end
+
+      # Examples:
+      #   add_border 'B2:F8', [:left, :top]
+      #   add_border 'C2:G10', [:top]
+      #   add_border 'C2:G10'
+      # @TODO: allow to pass in custom border style
+      def add_border(cell_ref, edges = :all)
+        cells = self[cell_ref]
+        BorderCreator.new(self, cells, edges).draw
+      end
+    end
+  end
+end

data/lib/axlsx_styler/border_creator.rb

@@ -0,0 +1,70 @@
+class BorderCreator
+  attr_reader :worksheet, :cells, :edges
+
+  def initialize(worksheet, cells, edges)
+    @worksheet = worksheet
+    @cells     = cells
+    @edges     = edges
+  end
+
+  def draw
+    selected_edges(edges).each { |edge| add_border(edge) }
+  end
+
+  private
+
+  def selected_edges(edges)
+    all_edges = [:top, :right, :bottom, :left]
+    if edges == :all
+      all_edges
+    elsif edges.is_a?(Array) && edges - all_edges == []
+      edges.uniq
+    else
+      []
+    end
+  end
+
+  def add_border(position)
+    style = {
+      border: {
+        style: :thin, color: '000000', edges: [position.to_sym]
+      }
+    }
+    worksheet.add_style border_cells[position.to_sym], style
+    # add_style border_cells(cell_ref)[position.to_sym], style
+  end
+
+  def border_cells
+    # example range "B2:D5"
+    {
+      top:     "#{first_cell}:#{last_col}#{first_row}", # "B2:D2"
+      right:   "#{last_col}#{first_row}:#{last_cell}",  # "D2:D5"
+      bottom:  "#{first_col}#{last_row}:#{last_cell}",  # "B5:D5"
+      left:    "#{first_cell}:#{first_col}#{last_row}"  # "B2:B5"
+    }
+  end
+
+  def first_cell
+    @first_cell ||= cells.first.r
+  end
+
+  def last_cell
+    @last_cell ||= cells.last.r
+  end
+
+  def first_row
+    @first_row ||= first_cell.scan(/\d+/).first
+  end
+
+  def first_col
+    @first_col ||= first_cell.scan(/\D+/).first
+  end
+
+  def last_row
+    @last_row ||= last_cell.scan(/\d+/).first
+  end
+
+  def last_col
+    @last_col ||= last_cell.scan(/\D+/).first
+  end
+end

data/lib/axlsx_styler/version.rb

@@ -1,3 +1,3 @@
 module AxlsxStyler
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end

data/test/integration_test.rb

@@ -1,7 +1,6 @@
 require 'test_helper'
 
 class IntegrationTest < MiniTest::Test
-  # taken from /examples
   def test_table_with_borders
     axlsx = Axlsx::Package.new
     workbook = axlsx.workbook
@@ -15,13 +14,13 @@ class IntegrationTest < MiniTest::Test
       sheet.column_widths 5, 20, 20, 20
 
       # using AxlsxStyler DSL
-      sheet['B2:D2'].add_style b: true
-      sheet['B2:B6'].add_style b: true
-      sheet['B2:D2'].add_style bg_color: '95AFBA'
-      sheet['B3:D6'].add_style bg_color: 'E2F89C'
-      sheet['D3:D6'].add_style alignment: { horizontal: :left }
-      sheet['B2:D6'].add_border
-      sheet['B3:D3'].add_border [:top]
+      sheet.add_style 'B2:D2', b: true
+      sheet.add_style 'B2:B6', b: true
+      sheet.add_style 'B2:D2', bg_color: '95AFBA'
+      sheet.add_style 'B3:D6', bg_color: 'E2F89C'
+      sheet.add_style 'D3:D6', alignment: { horizontal: :left }
+      sheet.add_border 'B2:D6'
+      sheet.add_border 'B3:D3', [:top]
     end
     workbook.apply_styles
     axlsx.serialize File.expand_path(
@@ -39,15 +38,17 @@ class IntegrationTest < MiniTest::Test
     day = 24 * 60 * 60
     workbook.add_worksheet do |sheet|
       sheet.add_row %w(Date Count Percent)
-      sheet.add_row [t - 2 * day, 2, 2.to_f / 11]
-      sheet.add_row [t - 1 * day, 3, 3.to_f / 11]
-      sheet.add_row [t,           6, 6.to_f / 11]
+      sheet.add_row [t - 2 * day, 2, 2.to_f.round(2) / 11]
+      sheet.add_row [t - 1 * day, 3, 3.to_f.round(2) / 11]
+      sheet.add_row [t,           6, 6.to_f.round(2) / 11]
 
-      sheet['A1:B1'].add_style b: true
-      sheet['A2:A4'].add_style format_code: 'YYYY-MM-DD hh:mm:ss'
+      sheet.add_style 'A1:B1', b: true
+      sheet.add_style 'A2:A4', format_code: 'YYYY-MM-DD hh:mm:ss'
     end
     workbook.apply_styles
     assert_equal 2, workbook.style_index.count
+    assert_equal 2 + 2, workbook.style_index.keys.max
+    assert_equal 5, workbook.styled_cells.count
     axlsx.serialize File.expand_path(
       '../../tmp/num_fmt_test.xlsx',
       __FILE__
@@ -62,10 +63,10 @@ class IntegrationTest < MiniTest::Test
       sheet.add_row [1, 'Ottawa']
       sheet.add_row [2, 'Boston']
 
-      sheet['A1:B1'].add_border [:bottom]
-      sheet['A1:B1'].add_border [:bottom]
-      sheet['A1:A3'].add_style b: true
-      sheet['A1:A3'].add_style b: true
+      sheet.add_border 'A1:B1', [:bottom]
+      sheet.add_border 'A1:B1', [:bottom]
+      sheet.add_style 'A1:A3', b: true
+      sheet.add_style 'A1:A3', b: true
     end
     workbook.apply_styles
     assert_equal 4, workbook.styled_cells.count

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: axlsx_styler
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Anton Sakovich
@@ -114,12 +114,12 @@ files:
 - axlsx_styler.gemspec
 - examples/colors_and_borders.rb
 - lib/axlsx_styler.rb
-- lib/axlsx_styler/array.rb
 - lib/axlsx_styler/axlsx_cell.rb
 - lib/axlsx_styler/axlsx_workbook.rb
+- lib/axlsx_styler/axlsx_worksheet.rb
+- lib/axlsx_styler/border_creator.rb
 - lib/axlsx_styler/version.rb
 - spreadsheet.png
-- test/array_test.rb
 - test/cell_test.rb
 - test/integration_test.rb
 - test/test_helper.rb
@@ -149,7 +149,6 @@ signing_key:
 specification_version: 4
 summary: This gem allows to separate data from styles when using Axlsx gem.
 test_files:
-- test/array_test.rb
 - test/cell_test.rb
 - test/integration_test.rb
 - test/test_helper.rb

data/lib/axlsx_styler/array.rb

@@ -1,77 +0,0 @@
-module AxlsxStyler
-  # @TODO
-  # Move the functionality from Array to Worksheet. New DSL
-  #   sheet.add_style 'A1:B5', b: true
-  # instead of
-  #   sheet['A1:B5'].add_style, b: true
-  module Array
-    def add_style(style)
-      validate_cells
-      each do |cell|
-        cell.add_style(style)
-      end
-    end
-
-    # - edges is either :all or an an array with elements
-    #   in [:top, :bottom, :bottom, :left]
-    # - couldn't do variable border thickness around the same cell;
-    #   hardcode style to :thin for now
-    def add_border(edges = :all)
-      validate_cells
-      selected_edges(edges).each { |edge| add_border_at(edge) }
-    end
-
-    private
-
-    def selected_edges(edges)
-      all_edges = [:top, :right, :bottom, :left]
-      if edges == :all
-        all_edges
-      elsif edges.is_a?(Array) && edges - all_edges == []
-        edges.uniq
-      else
-        []
-      end
-    end
-
-    def validate_cells
-      valid = map{ |e| e.is_a? Axlsx::Cell }.uniq == [ true ]
-      raise "Not a range of cells" unless valid
-    end
-
-    def border_cells
-      @border_cells ||= get_border_cells
-    end
-
-    def get_border_cells
-      first = self.first.r
-      last  = self.last.r
-
-      first_row = first.scan(/\d+/).first
-      last_row  = last.scan(/\d+/).first
-      first_col = first.scan(/\D+/).first
-      last_col  = last.scan(/\D+/).first
-
-      # example range "B2:D5"
-      {
-        top:     "#{first}:#{last_col}#{first_row}", # "B2:D2"
-        right:   "#{last_col}#{first_row}:#{last}",  # "D2:D5"
-        bottom:  "#{first_col}#{last_row}:#{last}",  # "B5:D5"
-        left:    "#{first}:#{first_col}#{last_row}"  # "B2:B5"
-      }
-    end
-
-    def worksheet
-      @worksheet ||= self.first.row.worksheet
-    end
-
-    def add_border_at(position)
-      style = {
-        border: {
-          style: :thin, color: "000000", edges: [position.to_sym]
-        }
-      }
-      worksheet[border_cells[position.to_sym]].add_style(style)
-    end
-  end
-end

data/test/array_test.rb

@@ -1,8 +0,0 @@
-require 'test_helper'
-
-class ArrayTest < MiniTest::Test
-  def test_presesence_of_add_style
-    array = Array.new
-    assert array.respond_to?(:add_style)
-  end
-end