spreadsheet_architect 4.2.0 → 5.0.0

data/test/unit/{utils_test.rb → spreadsheet_architect/utils_test.rb}

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class UtilsTest < ActiveSupport::TestCase
+class SpreadsheetArchitectUtilsTest < ActiveSupport::TestCase
   klass = SpreadsheetArchitect::Utils
 
   def setup
@@ -40,7 +40,7 @@ class UtilsTest < ActiveSupport::TestCase
 
     ### using Data option
     output = klass.get_cell_data(@options.merge(headers: true), SpreadsheetArchitect)
-    assert_equal [[]], output[:headers]
+    assert_equal false, output[:headers]
 
     output = klass.get_cell_data(@options.merge(headers: false), SpreadsheetArchitect)
     assert_equal false, output[:headers]
@@ -88,7 +88,7 @@ class UtilsTest < ActiveSupport::TestCase
     assert_not_empty klass.get_options(@options, Post)
 
     ### without :headers removes :header_style
-    assert_equal klass.get_options({header_style: false, headers: false}, SpreadsheetArchitect)[:header_style], nil
+    assert_nil klass.get_options({header_style: false, headers: false}, SpreadsheetArchitect)[:header_style]
 
     ### sets :sheet_name if needed 
     assert_equal klass.get_options({sheet_name: false}, SpreadsheetArchitect)[:sheet_name], 'Sheet1'
@@ -96,40 +96,17 @@ class UtilsTest < ActiveSupport::TestCase
     ### sets :sheet_name if needed, using pluralized only when using Rails
     assert_equal klass.get_options({sheet_name: false}, Post)[:sheet_name], 'Posts'
 
+    ### sets :escape_formulas if not given
+    assert_equal klass.get_options({}, SpreadsheetArchitect)[:escape_formulas], true
+
+    assert_equal klass.get_options({}, SpreadsheetArchitect)[:use_zero_based_row_index], false
+
     ### removes default styles
-    assert_equal klass.get_options({skip_defaults: true}, SpreadsheetArchitect), {skip_defaults: true, sheet_name: "Sheet1"}
-    assert_equal klass.get_options({skip_defaults: true}, Post), {skip_defaults: true, sheet_name: "Posts"}
+    assert_equal klass.get_options({skip_defaults: true}, SpreadsheetArchitect), {skip_defaults: true, sheet_name: "Sheet1", escape_formulas: true, use_zero_based_row_index: false}
+    assert_equal klass.get_options({skip_defaults: true}, Post), {skip_defaults: true, sheet_name: "Posts", escape_formulas: true, use_zero_based_row_index: false}
 
-    assert_not_equal klass.get_options({skip_defaults: false}, SpreadsheetArchitect), {skip_defaults: true, sheet_name: "Sheet1"}
-    assert_not_equal klass.get_options({skip_defaults: false}, Post), {skip_defaults: true, sheet_name: "Posts"}
-  end
-  
-  test "convert_styles_to_ods" do
-    ods_styles = klass.convert_styles_to_ods({
-      background_color: '333333', 
-      color: '000000', 
-      align: true, 
-      bold: true, 
-      font_size: 14, 
-      italic: true, 
-      underline: true, 
-      test: true
-    })
-
-    assert_equal(ods_styles, {
-      'cell' => {
-        'background-color' => '#333333'
-      }, 
-      'text' => {
-        'color' => '#000000', 
-        'align' => true, 
-        'font-weight' => 'bold', 
-        'font-size' => 14, 
-        'font-style' => 'italic', 
-        'text-underline-type' => 'single', 
-        'text-underline-style' => 'solid'
-      }
-    })
+    assert_not_equal klass.get_options({skip_defaults: false}, SpreadsheetArchitect), {skip_defaults: true, sheet_name: "Sheet1", escape_formulas: true, use_zero_based_row_index: false}
+    assert_not_equal klass.get_options({skip_defaults: false}, Post), {skip_defaults: true, sheet_name: "Posts", escape_formulas: true, use_zero_based_row_index: false}
   end
 
   test "is_ar_model" do

data/test/unit/xlsx/freeze_test.rb

@@ -0,0 +1,79 @@
+require "test_helper"
+
+class XlsxFreezeTest < ActiveSupport::TestCase
+
+  def setup
+    @options = {
+      headers: [
+        ['Latest Posts'],
+        ['Title','Category','Author','Posted on','Posted At','Earnings']
+      ],
+      data: 50.times.map{|i| [i, "foobar-#{i}", 5.4*i, true, Date.today, Time.now]},
+    }
+  end
+
+  def teardown
+  end
+
+  test "basic" do
+    opts = @options.merge({
+      freeze: {rows: 1, columns: 1},
+    })
+
+    # Using Array Data
+    file_data = SpreadsheetArchitect.to_xlsx(opts)
+
+    save_file("xlsx/freeze_basic.xlsx", file_data)
+  end
+
+  test "using_ranges" do
+    opts = @options.merge({
+      freeze: {rows: (2..4), columns: (2..4)},
+    })
+
+    # Using Array Data
+    file_data = SpreadsheetArchitect.to_xlsx(opts)
+
+    save_file("xlsx/freeze_using_ranges.xlsx", file_data)
+  end
+
+  test "using_legacy_arguments" do
+    opts = @options.merge({
+      freeze: {rows: :all, columns: 2},
+    })
+
+    # Using Array Data
+    file_data = SpreadsheetArchitect.to_xlsx(opts)
+
+    save_file("xlsx/freeze_using_legacy_arguments.xlsx", file_data)
+  end
+
+  test "freeze_type" do
+    opts = @options.merge({
+      freeze: {row: (@options[:data].size-2), column: 16, type: "split_panes"},
+    })
+
+    # Using Array Data
+    file_data = SpreadsheetArchitect.to_xlsx(opts)
+
+    save_file("xlsx/freeze_type.xlsx", file_data)
+  end
+
+  test "panes_all_axlsx_options" do
+    opts = @options.merge({
+      freeze: {
+        row: (@options[:data].size-2),
+        column: 16, 
+        state: "split", 
+        #active_pane: "top_right", 
+        #top_left_cell: "A2",
+      },
+    })
+
+    # Using Array Data
+    file_data = SpreadsheetArchitect.to_xlsx(opts)
+
+    save_file("xlsx/freeze_panes_all_axlsx_options.xlsx", file_data)
+  end
+
+end

data/test/unit/xlsx/general_test.rb

@@ -0,0 +1,199 @@
+require 'test_helper'
+
+class XlsxGeneralTest < ActiveSupport::TestCase
+
+  describe "header" do
+    test "header: false" do
+      spreadsheet = SpreadsheetArchitect.to_xlsx(headers: false, data: [[1]])
+      
+      save_file("xlsx/headers_false_test.xlsx", spreadsheet)
+    end
+  end
+
+  test "use_zero_based_row_index" do
+    spreadsheet = SpreadsheetArchitect.to_xlsx(
+      use_zero_based_row_index: true,
+      headers: [1, 2, 3],
+      data: [
+        [4,5,6],
+        [7,8,9],
+        [10,11,12],
+      ],
+      range_styles: [
+        {range: {rows: 0, columns: 0}, styles: {bold: true}},
+        {range: {rows: (2..3), columns: 0}, styles: {italic: true}},
+      ],
+      merges: [
+        {range: {rows: 0, columns: 1..2}},
+        {range: {rows: (2..3), columns: 2}},
+      ],
+      borders: [
+        {range: {rows: 0, columns: :all}},
+        {range: {rows: 3, columns: 0}},
+      ],
+    )
+
+    save_file("xlsx/use_zero_based_row_index_test.xlsx", spreadsheet)
+  end
+
+  test "multisheet" do
+    test_data = [[1,2,3], [4,5,6], [7,8,9]]
+
+    package = Post.to_axlsx_package
+    package = CustomPost.to_axlsx_package({sheet_name: 'Latest Projects'}, package)
+    package = SpreadsheetArchitect.to_axlsx_package({data: test_data, sheet_name: 'Another Sheet'}, package)
+
+    save_file("xlsx/multi_sheet.xlsx", package)
+  end
+
+  test "kitchen sink" do
+    options = {
+      headers: [
+        ['Latest Posts'],
+        ['Title','Category','Author','Posted on','Posted At','Earnings']
+      ],
+      data: 50.times.map{|i| [i, "foobar-#{i}", 5.4*i, true, Date.today, Time.now]},
+      header_style: {background_color: "000000", color: "FFFFFF", align: :center, font_size: 12, bold: true},
+      row_style: {background_color: nil, color: "000000", align: :left, font_size: 12},
+      sheet_name: 'Kitchen Sink',
+      freeze_headers: true,
+
+      column_styles: [
+        {columns: 0, styles: {bold: true}},
+        {columns: (1..3), styles: {color: "444444"}},
+        {columns: [4], include_header: false, styles: {italic: true}}
+      ],
+
+      range_styles: [
+        {range: "B2:C4", styles: {background_color: "CCCCCC"}},
+        {range: {rows: 1, columns: :all}, styles: {bold: true}},
+        {range: {rows: (20..25), columns: (1..4)}, styles: {italic: true}},
+        {range: {rows: :all, columns: (3..4)}, styles: {color: "999999"}}
+      ],
+
+      conditional_row_styles: [
+        {
+          if: Proc.new{|row_data, row_index|
+            row_index == 0 || row_data[0].to_i == 2
+          }, 
+          styles: {font_size: 18}
+        },
+        {
+          unless: Proc.new{|row_data, row_index|
+            row_index <= 10 || row_data[0].to_i == 15
+          }, 
+          styles: {align: :right}
+        },
+      ],
+
+      borders: [
+        {range: "B2:C4"},
+        {range: "D6:D7", border_styles: {style: :dashDot, color: "333333"}},
+        {range: {rows: (2..11), columns: :all}, border_styles: {edges: [:top,:bottom]}},
+        {range: {rows: 3, columns: 4}, border_styles: {edges: [:top,:bottom]}}
+      ],
+
+      merges: [
+        {range: "A1:C1"},
+        {range: {rows: 2, columns: :all}},
+        {range: {rows: (3..4), columns: (0..3)}}
+      ],
+
+      column_types: [
+        :integer,
+        :string,
+        :float,
+        :boolean,
+        :date,
+        :time,
+        nil,
+      ],
+    }
+
+    # Using Array Data
+    file_data = SpreadsheetArchitect.to_xlsx(options)
+
+    save_file("xlsx/kitchen_sink.xlsx", file_data)
+  end
+
+  describe "column_types" do
+    test "validates provided types" do
+      assert_raise SpreadsheetArchitect::Exceptions::ArgumentError do
+        SpreadsheetArchitect.to_axlsx_package(
+          data: [], 
+          column_types: [""]
+        )
+      end
+
+      SpreadsheetArchitect.to_axlsx_package(
+        data: [], 
+        column_types: [:string, :integer, :float, :date, :time, :boolean, :hyperlink, nil, ->(x){ :foo }]
+      )
+    end
+
+    test "works with Proc types" do
+      url = "https://github.com/westonganger/spreadsheet_architect"
+
+      data = [
+        [1, 2],
+        [1, url],
+      ]
+
+      p = SpreadsheetArchitect.to_axlsx_package(
+        data: data, 
+        column_types: [
+          :string, 
+          ->(x){ x.to_s.start_with?("http") ? :hyperlink : :string }
+        ]
+      )
+
+      doc = parse_axlsx_package(p)
+
+      hyperlinks = doc.css("hyperlinks hyperlink")
+
+      assert_equal 1, hyperlinks.size
+
+      ref = "B2"
+      assert_equal ref, hyperlinks[0].attr("ref")
+      cell = doc.at("c[r='#{ref}']")
+      assert_equal url, cell.text
+      assert_equal "inlineStr", cell.attr("t")
+
+      save_file("xlsx/hyperlinks.xlsx", p)
+    end
+
+    describe "hyperlinks" do
+      test "shows the text and have the correct attributes" do
+        url = "https://github.com/westonganger/spreadsheet_architect"
+
+        data = [
+          [1,2,3],
+          [1, url, "https://github.com/caxlsx/caxlsx"],
+        ]
+
+        p = SpreadsheetArchitect.to_axlsx_package(data: data, column_types: [:string, :hyperlink, :string])
+
+        doc = parse_axlsx_package(p)
+
+        hyperlinks = doc.css("hyperlinks hyperlink")
+
+        assert_equal 2, hyperlinks.size
+
+        ref = "B1"
+        assert_equal ref, hyperlinks[0].attr("ref")
+        cell = doc.at("c[r='#{ref}']")
+        assert_equal "2", cell.text
+        assert_equal "inlineStr", cell.attr("t")
+
+        ref = "B2"
+        assert_equal ref, hyperlinks[1].attr("ref")
+        cell = doc.at("c[r='#{ref}']")
+        assert_equal url, cell.text
+        assert_equal "inlineStr", cell.attr("t")
+
+        save_file("xlsx/hyperlinks.xlsx", p)
+      end
+    end
+  end
+
+end