axlsx_styler 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a78ec129205b19cc466a29461787fcdd8e4d6113
-  data.tar.gz: 0c04a30a6c48799392eb765e7fbd67c6236ef294
+  metadata.gz: cd31d073d9ff50b0f751553c2623c372ec9a4d1d
+  data.tar.gz: d8c93fe14f0215c0aa0619ebfcb37cc6479f9781
 SHA512:
-  metadata.gz: c280bc771e8bda4131834f6a68502e5ade34ed808b61a996327806927d1467485fd226cebbba347940e97754f894053d15d02cd11b11e0292028197ebe868fdb
-  data.tar.gz: 6aca119eb6c65299047e927836c972dcc5252f02bed720bc4a9d7fc6da0bce77e78a560ad74d6efe617076db2881d0627a1217ccd51462e4d9288dc95144f09f
+  metadata.gz: e99d3aae264ab742166af6b76fb34d9d2b19d61e2a57cf56d9d35d3102f7a45365da068cc18f16f945082907ec73beece46e9a79808acfb3b290498b07b6efde
+  data.tar.gz: 392fcc8712ce0fc970894f19671324ff327bc8a712a2753be62230ff80f08df12e6501073c7f0521c57b596b144e06b7cfff45ea6e1737f35a99de20c24d84ff

data/README.md

@@ -9,7 +9,7 @@ row is created.
 a spreadsheet with data and apply styles later. Paired with
 [axlsx_rails](https://github.com/straydogstudio/axlsx_rails) this gem
 allows to build clean and maintainable Excel views in a Rails app. It can also
-be used outside of any specific ruby framework as shown in example below.
+be used outside of any specific Ruby framework as shown in example below.
 
 ## Usage
 
@@ -44,19 +44,13 @@ sheet.add_border 'B2:D5', { edges: [:bottom, :right], style: :thick, color: 'FF0
 
 Border parameters are optional. The default is to draw a thin black border on all four edges of the selected cell range.
 
-The styles are applied with a simple call:
 
-```ruby
-workbook.apply_styles
-```
+### Example
 
-Here's an example that compares styling a simple table with and without
-`axlsx_styler`. Suppose we wand to create the following spreadsheet:
+Suppose we want create the following spreadsheet:
 
 ![alt text](./spreadsheet.png "Sample Spreadsheet")
 
-### `axlsx` paired with `axlsx_styler`
-
 You can apply styles after all data is entered, similar to how you'd create
 an Excel document by hand:
 
@@ -82,92 +76,16 @@ workbook.add_worksheet do |sheet|
   sheet.add_border 'B2:D5'
   sheet.add_border 'B3:D3', [:top]
 end
-workbook.apply_styles
 axlsx.serialize 'grocery.xlsx'
 ```
 
-### `axlsx` gem without `axlsx_styler`
-
-Whith plain `axlsx` you need to know which styles you're going to use beforehand.
-The code for our example is a bit more envolved:
-
-```ruby
-require 'axlsx'
-axlsx = Axlsx::Package.new
-wb = axlsx.workbook
-border_color = '000000'
-wb.add_worksheet do |sheet|
-  # top row
-  header_hash = { b: true, bg_color: '95AFBA' }
-  top_left_corner = wb.styles.add_style header_hash.merge({
-    border: { style: :thin, color: border_color, edges: [:top, :left, :bottom] }
-  })
-  top_edge = wb.styles.add_style header_hash.merge({
-    border: { style: :thin, color: border_color, edges: [:top, :bottom] }
-  })
-  top_right_corner = wb.styles.add_style header_hash.merge({
-    border: { style: :thin, color: border_color, edges: [:top, :right, :bottom] }
-  })
-  sheet.add_row
-  sheet.add_row(["", "Product", "Category", "Price"],
-    style: [ nil, top_left_corner, top_edge, top_right_corner ]
-  )
-
-  # middle rows
-  color_hash = { bg_color: 'E2F89C' }
-  left_edge = wb.styles.add_style color_hash.merge(
-    b: true,
-    border: {
-      style: :thin, color: border_color, edges: [:left]
-    }
-  )
-  inner = wb.styles.add_style color_hash
-  right_edge = wb.styles.add_style color_hash.merge(
-    alignment: { horizontal: :left },
-    border: {
-      style: :thin, color: border_color, edges: [:right]
-    }
-  )
-  sheet.add_row(
-    ["", "Butter", "Dairy", 4.99],
-    style: [nil, left_edge, inner, right_edge]
-  )
-  sheet.add_row(
-    ["", "Bread", "Baked Goods", 3.45],
-    style: [nil, left_edge, inner, right_edge]
-  )
-
-  # last row
-  bottom_left_corner = wb.styles.add_style color_hash.merge({
-    b: true,
-    border: { style: :thin, color: border_color, edges: [:left, :bottom] }
-  })
-  bottom_edge = wb.styles.add_style color_hash.merge({
-    border: { style: :thin, color: border_color, edges: [:bottom] }
-  })
-  bottom_right_corner = wb.styles.add_style color_hash.merge({
-    alignment: { horizontal: :left },
-    border: { style: :thin, color: border_color, edges: [:right, :bottom] }
-  })
-  sheet.add_row(["", "Broccoli", "Produce", 2.99],
-    style: [nil, bottom_left_corner, bottom_edge, bottom_right_corner]
-  )
-
-  sheet.column_widths 5, 20, 20, 20
-end
-axlsx.serialize "grocery.xlsx"
-```
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'axlsx_styler'
-
-And then execute:
+Producing the same spreadsheet with vanilla `axlsx` turns out [a bit trickier](./examples/vanilla_axlsx.md).
 
-    $ bundle
 
-Or install it yourself as:
+## Change log
 
-    $ gem install axlsx_styler
+Version | Change
+--------|-------
+0.1.5 | Hide `Workbook#apply_styles` method to make it easier to use.
+0.1.3 | Make border styles customazible.
+0.1.2 | Allow applying multiple style hashes.

data/examples/vanilla_axlsx.md

@@ -0,0 +1,70 @@
+This gem is supposed to make styling spreadsheets easier.
+
+Here's how the [example from the README](../README.md) compares to that implemented with plain `axlsx`.
+
+```ruby
+require 'axlsx'
+axlsx = Axlsx::Package.new
+wb = axlsx.workbook
+border_color = '000000'
+wb.add_worksheet do |sheet|
+  # top row
+  header_hash = { b: true, bg_color: '95AFBA' }
+  top_left_corner = wb.styles.add_style header_hash.merge({
+    border: { style: :thin, color: border_color, edges: [:top, :left, :bottom] }
+  })
+  top_edge = wb.styles.add_style header_hash.merge({
+    border: { style: :thin, color: border_color, edges: [:top, :bottom] }
+  })
+  top_right_corner = wb.styles.add_style header_hash.merge({
+    border: { style: :thin, color: border_color, edges: [:top, :right, :bottom] }
+  })
+  sheet.add_row
+  sheet.add_row(["", "Product", "Category", "Price"],
+    style: [ nil, top_left_corner, top_edge, top_right_corner ]
+  )
+
+  # middle rows
+  color_hash = { bg_color: 'E2F89C' }
+  left_edge = wb.styles.add_style color_hash.merge(
+    b: true,
+    border: {
+      style: :thin, color: border_color, edges: [:left]
+    }
+  )
+  inner = wb.styles.add_style color_hash
+  right_edge = wb.styles.add_style color_hash.merge(
+    alignment: { horizontal: :left },
+    border: {
+      style: :thin, color: border_color, edges: [:right]
+    }
+  )
+  sheet.add_row(
+    ["", "Butter", "Dairy", 4.99],
+    style: [nil, left_edge, inner, right_edge]
+  )
+  sheet.add_row(
+    ["", "Bread", "Baked Goods", 3.45],
+    style: [nil, left_edge, inner, right_edge]
+  )
+
+  # last row
+  bottom_left_corner = wb.styles.add_style color_hash.merge({
+    b: true,
+    border: { style: :thin, color: border_color, edges: [:left, :bottom] }
+  })
+  bottom_edge = wb.styles.add_style color_hash.merge({
+    border: { style: :thin, color: border_color, edges: [:bottom] }
+  })
+  bottom_right_corner = wb.styles.add_style color_hash.merge({
+    alignment: { horizontal: :left },
+    border: { style: :thin, color: border_color, edges: [:right, :bottom] }
+  })
+  sheet.add_row(["", "Broccoli", "Produce", 2.99],
+    style: [nil, bottom_left_corner, bottom_edge, bottom_right_corner]
+  )
+
+  sheet.column_widths 5, 20, 20, 20
+end
+axlsx.serialize "grocery.xlsx"
+```

data/lib/axlsx_styler.rb

@@ -8,3 +8,24 @@ require 'axlsx_styler/axlsx_cell'
 Axlsx::Workbook.send :include, AxlsxStyler::Axlsx::Workbook
 Axlsx::Worksheet.send :include, AxlsxStyler::Axlsx::Worksheet
 Axlsx::Cell.send :include, AxlsxStyler::Axlsx::Cell
+
+module Axlsx
+  class Package
+
+    # Patches the original Axlsx::Package#serialize method so that styles are
+    # applied when the workbook is saved
+    original_serialize = instance_method(:serialize)
+    define_method :serialize do |*args|
+      workbook.apply_styles if !workbook.styles_applied
+      original_serialize.bind(self).(*args)
+    end
+
+    # Patches the original Axlsx::Package#to_stream method so that styles are
+    # applied when the workbook is converted to StringIO
+    original_to_stream = instance_method(:to_stream)
+    define_method :to_stream do |*args|
+      workbook.apply_styles if !workbook.styles_applied
+      original_to_stream.bind(self).(*args)
+    end
+  end
+end

data/lib/axlsx_styler/axlsx_cell.rb

@@ -22,8 +22,8 @@ module AxlsxStyler
         # with regular Hash#merge adding borders fails miserably
         new_style = raw_style.deep_merge style
         if with_border?(raw_style) && with_border?(style)
-          border_at = raw_style[:border][:edges] + style[:border][:edges]
-          new_style[:border][:edges] = border_at.uniq
+          border_at = (raw_style[:border][:edges] || all_edges) + (style[:border][:edges] || all_edges)
+          new_style[:border][:edges] = border_at.uniq.sort
         elsif with_border?(style)
           new_style[:border] = style[:border]
         end
@@ -33,6 +33,10 @@ module AxlsxStyler
       def with_border?(style)
         !style[:border].nil?
       end
+
+      def all_edges
+        [:top, :right, :bottom, :left]
+      end
     end
   end
 end

data/lib/axlsx_styler/axlsx_workbook.rb

@@ -1,9 +1,15 @@
+require 'set'
+
 module AxlsxStyler
   module Axlsx
     module Workbook
       # An array that holds all cells with styles
       attr_accessor :styled_cells
 
+      # Checks if styles are idexed to make it work for pre 0.1.5 version
+      # users that still explicitly call @workbook.apply_styles
+      attr_accessor :styles_applied
+
       # An index for cell styles
       #   {
       #     1 => < style_hash >,
@@ -25,13 +31,13 @@ module AxlsxStyler
         styled_cells.each do |cell|
           set_style_index(cell)
         end
+        self.styles_applied = true
       end
 
       private
 
       # Check if style code
       def set_style_index(cell)
-        # @TODO fix this hack
         self.style_index ||= {}
 
         index_item = style_index.select { |_, v| v == cell.raw_style }.first

data/lib/axlsx_styler/version.rb

@@ -1,3 +1,3 @@
 module AxlsxStyler
-  VERSION = '0.1.3'
+  VERSION = '0.1.5'
 end

data/test/integration_test.rb

@@ -6,14 +6,71 @@ class IntegrationTest < MiniTest::Test
     @workbook = @axlsx.workbook
   end
 
-  # Save files in case you'd like to see what the result is
-  def teardown
-    return unless @filename
-    @axlsx.serialize File.expand_path("../../tmp/#{@filename}.xlsx", __FILE__)
+  # Save to a file using Axlsx::Package#serialize
+  def serialize(filename)
+    @axlsx.serialize File.expand_path("../../tmp/#{filename}.xlsx", __FILE__)
+    assert_equal true, @workbook.styles_applied
+  end
+
+  # Save to a file by getting contents from stream
+  def to_stream(filename)
+    File.open(File.expand_path("../../tmp/#{filename}.xlsx", __FILE__), 'w') do |f|
+      f.write @axlsx.to_stream.read
+    end
+  end
+
+  # New functionality as of 0.1.5 (serialize)
+  def test_works_without_apply_styles_serialize
+    filename = 'without_apply_styles_serialize'
+    assert_equal nil, @workbook.styles_applied
+    @workbook.add_worksheet do |sheet|
+      sheet.add_row ['A1', 'B1']
+      sheet.add_style 'A1:B1', b: true
+    end
+    serialize(filename)
+    assert_equal 1, @workbook.style_index.count
+  end
+
+  # New functionality as of 0.1.5 (to_stream)
+  def test_works_without_apply_styles_to_stream
+    filename = 'without_apply_styles_to_stream'
+    assert_equal nil, @workbook.styles_applied
+    @workbook.add_worksheet do |sheet|
+      sheet.add_row ['A1', 'B1']
+      sheet.add_style 'A1:B1', b: true
+    end
+    to_stream(filename)
+    assert_equal 1, @workbook.style_index.count
+  end
+
+  # Backwards compatibility with pre 0.1.5 (serialize)
+  def test_works_with_apply_styles_serialize
+    filename = 'with_apply_styles_serialize'
+    assert_equal nil, @workbook.styles_applied
+    @workbook.add_worksheet do |sheet|
+      sheet.add_row ['A1', 'B1']
+      sheet.add_style 'A1:B1', b: true
+    end
+    @workbook.apply_styles # important for backwards compatibility
+    assert_equal 1, @workbook.style_index.count
+    serialize(filename)
+  end
+
+  # Backwards compatibility with pre 0.1.5 (to_stream)
+  def test_works_with_apply_styles_to_stream
+    filename = 'with_apply_styles_to_stream'
+    assert_equal nil, @workbook.styles_applied
+    @workbook.add_worksheet do |sheet|
+      sheet.add_row ['A1', 'B1']
+      sheet.add_style 'A1:B1', b: true
+    end
+    @workbook.apply_styles # important for backwards compatibility
+    assert_equal 1, @workbook.style_index.count
+    to_stream(filename)
   end
 
   def test_table_with_borders
-    @filename = 'borders_test'
+    filename = 'borders_test'
     @workbook.add_worksheet do |sheet|
       sheet.add_row
       sheet.add_row ['', 'Product', 'Category',  'Price']
@@ -23,7 +80,6 @@ class IntegrationTest < MiniTest::Test
       sheet.add_row ['', 'Pizza', 'Frozen Foods',  4.99]
       sheet.column_widths 5, 20, 20, 20
 
-      # using AxlsxStyler DSL
       sheet.add_style 'B2:D2', b: true
       sheet.add_style 'B2:B6', b: true
       sheet.add_style 'B2:D2', bg_color: '95AFBA'
@@ -34,13 +90,13 @@ class IntegrationTest < MiniTest::Test
       sheet.add_border 'B3:D3', edges: [:bottom], style: :medium
       sheet.add_border 'B3:D3', edges: [:bottom], style: :medium, color: '32f332'
     end
-    @workbook.apply_styles
+    serialize(filename)
     assert_equal 12, @workbook.style_index.count
     assert_equal 12 + 2, @workbook.style_index.keys.max
   end
 
   def test_duplicate_borders
-    @filename = 'duplicate_borders_test'
+    filename = 'duplicate_borders_test'
     @workbook.add_worksheet do |sheet|
       sheet.add_row
       sheet.add_row ['', 'B2', 'C2', 'D2']
@@ -50,13 +106,13 @@ class IntegrationTest < MiniTest::Test
       sheet.add_border 'B2:D4'
       sheet.add_border 'B2:D4'
     end
-    @workbook.apply_styles
+    serialize(filename)
     assert_equal 8, @workbook.style_index.count
     assert_equal 8, @workbook.styled_cells.count
   end
 
   def test_multiple_style_borders_on_same_sells
-    @filename = 'multiple_style_borders'
+    filename = 'multiple_style_borders'
     @workbook.add_worksheet do |sheet|
       sheet.add_row
       sheet.add_row ['', 'B2', 'C2', 'D2']
@@ -65,7 +121,7 @@ class IntegrationTest < MiniTest::Test
       sheet.add_border 'B2:D3', :all
       sheet.add_border 'B2:D2', edges: [:bottom], style: :thick, color: 'ff0000'
     end
-    @workbook.apply_styles
+    serialize(filename)
     assert_equal 6, @workbook.style_index.count
     assert_equal 6, @workbook.styled_cells.count
 
@@ -73,25 +129,25 @@ class IntegrationTest < MiniTest::Test
       border: {
         style: :thick,
         color: 'ff0000',
-        edges: [:top, :left, :bottom]
+        edges: [:bottom, :left, :top]
       }
     }
     assert_equal b2_cell_style, @workbook.style_index
-      .find { |_, v| v[:border][:edges] == [:top, :left, :bottom] }[1]
+      .find { |_, v| v[:border][:edges] == [:bottom, :left, :top] }[1]
 
     d3_cell_style = {
       border: {
         style: :thin,
         color: '000000',
-        edges: [:right, :bottom]
+        edges: [:bottom, :right]
       }
     }
     assert_equal d3_cell_style, @workbook.style_index
-      .find { |_, v| v[:border][:edges] == [:right, :bottom] }[1]
+      .find { |_, v| v[:border][:edges] == [:bottom, :right] }[1]
   end
 
   def test_table_with_num_fmt
-    @filename = 'num_fmt_test'
+    filename = 'num_fmt_test'
     t = Time.now
     day = 24 * 60 * 60
     @workbook.add_worksheet do |sheet|
@@ -103,14 +159,14 @@ class IntegrationTest < MiniTest::Test
       sheet.add_style 'A1:B1', b: true
       sheet.add_style 'A2:A4', format_code: 'YYYY-MM-DD hh:mm:ss'
     end
-    @workbook.apply_styles
+    serialize(filename)
     assert_equal 2, @workbook.style_index.count
     assert_equal 2 + 2, @workbook.style_index.keys.max
     assert_equal 5, @workbook.styled_cells.count
   end
 
   def test_duplicate_styles
-    @filename = 'duplicate_styles'
+    filename = 'duplicate_styles'
     @workbook.add_worksheet do |sheet|
       sheet.add_row %w(Index City)
       sheet.add_row [1, 'Ottawa']
@@ -121,13 +177,13 @@ class IntegrationTest < MiniTest::Test
       sheet.add_style 'A1:A3', b: true
       sheet.add_style 'A1:A3', b: true
     end
-    @workbook.apply_styles
+    serialize(filename)
     assert_equal 4, @workbook.styled_cells.count
     assert_equal 3, @workbook.style_index.count
   end
 
   def test_multiple_named_styles
-    @filename = 'multiple_named_styles'
+    filename = 'multiple_named_styles'
     bold_blue = { b: true, fg_color: '0000FF' }
     large = { sz: 16 }
     red = { fg_color: 'FF0000' }
@@ -139,8 +195,40 @@ class IntegrationTest < MiniTest::Test
       sheet.add_style 'A1:B1', bold_blue, large
       sheet.add_style 'A1:A3', red
     end
-    @workbook.apply_styles
+    serialize(filename)
     assert_equal 4, @workbook.styled_cells.count
     assert_equal 3, @workbook.style_index.count
   end
+
+  # Overriding borders (part 1)
+  def test_mixed_borders_1
+    @filename = 'mixed_borders_1'
+    @workbook.add_worksheet do |sheet|
+      sheet.add_row
+      sheet.add_row ['', '1', '2', '3']
+      sheet.add_row ['', '4', '5', '6']
+      sheet.add_row ['', '7', '8', '9']
+      sheet.add_style 'B2:D4', border: { style: :thin, color: '000000' }
+      sheet.add_border 'C3:D4', style: :medium
+    end
+    @workbook.apply_styles
+    assert_equal 9, @workbook.styled_cells.count
+    assert_equal 2, @workbook.style_index.count
+  end
+
+  # Overriding borders (part 2)
+  def test_mixed_borders
+    @filename = 'mixed_borders_2'
+    @workbook.add_worksheet do |sheet|
+      sheet.add_row
+      sheet.add_row ['', '1', '2', '3']
+      sheet.add_row ['', '4', '5', '6']
+      sheet.add_row ['', '7', '8', '9']
+      sheet.add_border 'B2:D4', style: :medium
+      sheet.add_style 'D2:D4', border: { style: :thin, color: '000000' }
+    end
+    @workbook.apply_styles
+    assert_equal 8, @workbook.styled_cells.count
+    assert_equal 6, @workbook.style_index.count
+  end
 end

data/test/workbook_test.rb

@@ -5,5 +5,6 @@ class WorkbookTest < MiniTest::Test
     wb.add_styled_cell 'Cell 1'
     wb.add_styled_cell 'Cell 2'
     assert_equal ['Cell 1', 'Cell 2'].to_set, wb.styled_cells
+    assert_equal nil, wb.styles_applied
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: axlsx_styler
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Anton Sakovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2016-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: axlsx
@@ -113,6 +113,7 @@ files:
 - Rakefile
 - axlsx_styler.gemspec
 - examples/colors_and_borders.rb
+- examples/vanilla_axlsx.md
 - lib/axlsx_styler.rb
 - lib/axlsx_styler/axlsx_cell.rb
 - lib/axlsx_styler/axlsx_workbook.rb