axlsx_styler 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd31d073d9ff50b0f751553c2623c372ec9a4d1d
-  data.tar.gz: d8c93fe14f0215c0aa0619ebfcb37cc6479f9781
+  metadata.gz: 777a2c460b127a0ce0cb3413631b77e06e22aabe
+  data.tar.gz: 1229fcf346e19b981b244208ee0d73d561bce0d1
 SHA512:
-  metadata.gz: e99d3aae264ab742166af6b76fb34d9d2b19d61e2a57cf56d9d35d3102f7a45365da068cc18f16f945082907ec73beece46e9a79808acfb3b290498b07b6efde
-  data.tar.gz: 392fcc8712ce0fc970894f19671324ff327bc8a712a2753be62230ff80f08df12e6501073c7f0521c57b596b144e06b7cfff45ea6e1737f35a99de20c24d84ff
+  metadata.gz: f8f5b791535070ee91a18c48ba730a6a530f552c097fd2d3ca8e733be27c19be379b1148a66fd8845340b5c41458e25872a6354828de43cefe85b4854ab8abe4
+  data.tar.gz: 3313ffef3a641b259822a22071a58f9c3a5a8f10ad9300039e0895b734c1a6dfbcb39a693d70840e2c7f9c962d85cf28734019c6323958567f875cc2afd25be8

data/.gitignore

@@ -22,3 +22,4 @@ tmp
 mkmf.log
 *.xlsx
 *.xlsx#
+.DS_Store

data/README.md

@@ -86,6 +86,7 @@ Producing the same spreadsheet with vanilla `axlsx` turns out [a bit trickier](.
 
 Version | Change
 --------|-------
+0.1.6 | Allow mixing vanilla `axlsx` styles and those from `add_style` and `add_border` (see [this example](./examples/mixing_styles.rb))
 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/axlsx_styler.gemspec

@@ -27,7 +27,9 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 1.9.3'
 
   spec.add_dependency 'axlsx', '~> 2.0'
-  spec.add_dependency 'activesupport', '>= 3.1'
+  # TODO: extract active_support/core_ext/hash/deep_merge
+  # and remove the dependency
+  spec.add_dependency 'activesupport', '~> 3.1'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 0.9'

data/examples/mixing_styles.rb

@@ -0,0 +1,22 @@
+# As of v0.1.6 it is possible to add styles using vanilla axlsx approach
+# as well as using add_style and add_border. This is something users have
+# been asking for.
+#
+# The example below is superfluous and the same results are more easily achieved
+# without workbook.styles.add_style. You've been warned!
+require 'axlsx_styler'
+
+axlsx = Axlsx::Package.new
+workbook = axlsx.workbook
+red = workbook.styles.add_style fg_color: 'FF0000'
+workbook.add_worksheet do |sheet|
+  sheet.add_row
+  sheet.add_row ['', 'B2', 'C2', 'D2'], style: [nil, red, nil, nil]
+  sheet.add_row ['', 'B3', 'C3', 'D3'], style: [nil, red, nil, nil]
+  sheet.add_row ['', 'B4', 'C4', 'D4'], style: [nil, red, nil, nil]
+
+  sheet.add_style 'B2:D2', b: true
+  sheet.add_border 'B2:D4'
+end
+workbook.apply_styles
+axlsx.serialize File.expand_path('../../tmp/mixing_styles.xlsx', __FILE__)

data/lib/axlsx_styler.rb

@@ -11,7 +11,6 @@ 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)
@@ -28,4 +27,39 @@ module Axlsx
       original_to_stream.bind(self).(*args)
     end
   end
+
+  class Styles
+    # An index for cell styles
+    #   {
+    #     1 => < style_hash >,
+    #     2 => < style_hash >,
+    #     ...
+    #     K => < style_hash >
+    #   }
+    # where keys are Cell#raw_style and values are styles
+    # codes as per Axlsx::Style
+    attr_accessor :style_index
+
+    # Patches the original Axlsx::Styles#add_style method so that plain axlsx
+    # styles are added to the axlsx_styler style_index cache
+    original_add_style = instance_method(:add_style)
+    define_method :add_style do |style|
+      self.style_index ||= {}
+
+      raw_style = {type: :xf, name: 'Arial', sz: 11, family: 1}.merge(style)
+      if raw_style[:format_code]
+        raw_style.delete(:num_fmt)
+      end
+
+      index = style_index.key(raw_style)
+      if !index
+        index = original_add_style.bind(self).(style)
+        self.style_index[index] = raw_style
+      end
+      return index
+    end
+
+    private 
+
+  end
 end

data/lib/axlsx_styler/axlsx_cell.rb

@@ -21,12 +21,14 @@ module AxlsxStyler
         # using deep_merge from active_support:
         # 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] || 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
+
         self.raw_style = new_style
       end
 

data/lib/axlsx_styler/axlsx_workbook.rb

@@ -1,4 +1,5 @@
 require 'set'
+require 'active_support/core_ext/hash/deep_merge'
 
 module AxlsxStyler
   module Axlsx
@@ -6,21 +7,10 @@ module AxlsxStyler
       # 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
+      # Checks if styles are indexed 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 >,
-      #     2 => < style_hash >,
-      #     ...
-      #     K => < style_hash >
-      #   }
-      # where keys are Cell#raw_style and values are styles
-      # codes as per Axlsx::Style
-      attr_accessor :style_index
-
       def add_styled_cell(cell)
         self.styled_cells ||= Set.new
         self.styled_cells << cell
@@ -28,29 +18,20 @@ module AxlsxStyler
 
       def apply_styles
         return unless styled_cells
+  
         styled_cells.each do |cell|
-          set_style_index(cell)
+          if styles.style_index && styles.style_index[cell.style]
+            current_style = styles.style_index[cell.style]
+            new_style = current_style.deep_merge(cell.raw_style)
+          else
+            new_style = cell.raw_style
+          end
+
+          cell.style = styles.add_style(new_style)
         end
         self.styles_applied = true
       end
 
-      private
-
-      # Check if style code
-      def set_style_index(cell)
-        self.style_index ||= {}
-
-        index_item = style_index.select { |_, v| v == cell.raw_style }.first
-        if index_item
-          cell.style = index_item.first
-        else
-          old_style = cell.raw_style.dup
-          new_style = styles.add_style(cell.raw_style)
-          cell.style = new_style
-          # cell.raw_style.delete(:num_fmt)
-          style_index[new_style] = old_style
-        end
-      end
     end
   end
 end

data/lib/axlsx_styler/version.rb

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

data/test/cell_test.rb

@@ -9,6 +9,6 @@ class CellTest < MiniTest::Test
     cell = row.cells.first
 
     cell.add_style b: true
-    assert_equal({ b: true }, cell.raw_style)
+    assert_equal({b: true}, cell.raw_style)
   end
 end

data/test/integration_test.rb

@@ -28,7 +28,7 @@ class IntegrationTest < MiniTest::Test
       sheet.add_style 'A1:B1', b: true
     end
     serialize(filename)
-    assert_equal 1, @workbook.style_index.count
+    assert_equal 1, @workbook.styles.style_index.count
   end
 
   # New functionality as of 0.1.5 (to_stream)
@@ -40,7 +40,7 @@ class IntegrationTest < MiniTest::Test
       sheet.add_style 'A1:B1', b: true
     end
     to_stream(filename)
-    assert_equal 1, @workbook.style_index.count
+    assert_equal 1, @workbook.styles.style_index.count
   end
 
   # Backwards compatibility with pre 0.1.5 (serialize)
@@ -52,7 +52,7 @@ class IntegrationTest < MiniTest::Test
       sheet.add_style 'A1:B1', b: true
     end
     @workbook.apply_styles # important for backwards compatibility
-    assert_equal 1, @workbook.style_index.count
+    assert_equal 1, @workbook.styles.style_index.count
     serialize(filename)
   end
 
@@ -65,7 +65,7 @@ class IntegrationTest < MiniTest::Test
       sheet.add_style 'A1:B1', b: true
     end
     @workbook.apply_styles # important for backwards compatibility
-    assert_equal 1, @workbook.style_index.count
+    assert_equal 1, @workbook.styles.style_index.count
     to_stream(filename)
   end
 
@@ -91,8 +91,8 @@ class IntegrationTest < MiniTest::Test
       sheet.add_border 'B3:D3', edges: [:bottom], style: :medium, color: '32f332'
     end
     serialize(filename)
-    assert_equal 12, @workbook.style_index.count
-    assert_equal 12 + 2, @workbook.style_index.keys.max
+    assert_equal 12, @workbook.styles.style_index.count
+    assert_equal 12 + 2, @workbook.styles.style_index.keys.max
   end
 
   def test_duplicate_borders
@@ -107,11 +107,11 @@ class IntegrationTest < MiniTest::Test
       sheet.add_border 'B2:D4'
     end
     serialize(filename)
-    assert_equal 8, @workbook.style_index.count
+    assert_equal 8, @workbook.styles.style_index.count
     assert_equal 8, @workbook.styled_cells.count
   end
 
-  def test_multiple_style_borders_on_same_sells
+  def test_multiple_style_borders_on_same_cells
     filename = 'multiple_style_borders'
     @workbook.add_worksheet do |sheet|
       sheet.add_row
@@ -122,7 +122,7 @@ class IntegrationTest < MiniTest::Test
       sheet.add_border 'B2:D2', edges: [:bottom], style: :thick, color: 'ff0000'
     end
     serialize(filename)
-    assert_equal 6, @workbook.style_index.count
+    assert_equal 6, @workbook.styles.style_index.count
     assert_equal 6, @workbook.styled_cells.count
 
     b2_cell_style = {
@@ -130,20 +130,26 @@ class IntegrationTest < MiniTest::Test
         style: :thick,
         color: 'ff0000',
         edges: [:bottom, :left, :top]
-      }
+      },
+      type: :xf,
+      name: 'Arial',
+      sz: 11,
+      family: 1
     }
-    assert_equal b2_cell_style, @workbook.style_index
-      .find { |_, v| v[:border][:edges] == [:bottom, :left, :top] }[1]
+    assert_equal b2_cell_style, @workbook.styles.style_index.values.find{|x| x == b2_cell_style}
 
     d3_cell_style = {
       border: {
         style: :thin,
         color: '000000',
         edges: [:bottom, :right]
-      }
+      },
+      type: :xf,
+      name: 'Arial',
+      sz: 11,
+      family: 1
     }
-    assert_equal d3_cell_style, @workbook.style_index
-      .find { |_, v| v[:border][:edges] == [:bottom, :right] }[1]
+    assert_equal d3_cell_style, @workbook.styles.style_index.values.find{|x| x == d3_cell_style}
   end
 
   def test_table_with_num_fmt
@@ -160,8 +166,8 @@ class IntegrationTest < MiniTest::Test
       sheet.add_style 'A2:A4', format_code: 'YYYY-MM-DD hh:mm:ss'
     end
     serialize(filename)
-    assert_equal 2, @workbook.style_index.count
-    assert_equal 2 + 2, @workbook.style_index.keys.max
+    assert_equal 2, @workbook.styles.style_index.count
+    assert_equal 2 + 2, @workbook.styles.style_index.keys.max
     assert_equal 5, @workbook.styled_cells.count
   end
 
@@ -179,7 +185,7 @@ class IntegrationTest < MiniTest::Test
     end
     serialize(filename)
     assert_equal 4, @workbook.styled_cells.count
-    assert_equal 3, @workbook.style_index.count
+    assert_equal 3, @workbook.styles.style_index.count
   end
 
   def test_multiple_named_styles
@@ -197,12 +203,12 @@ class IntegrationTest < MiniTest::Test
     end
     serialize(filename)
     assert_equal 4, @workbook.styled_cells.count
-    assert_equal 3, @workbook.style_index.count
+    assert_equal 3, @workbook.styles.style_index.count
   end
 
   # Overriding borders (part 1)
   def test_mixed_borders_1
-    @filename = 'mixed_borders_1'
+    filename = 'mixed_borders_1'
     @workbook.add_worksheet do |sheet|
       sheet.add_row
       sheet.add_row ['', '1', '2', '3']
@@ -213,12 +219,13 @@ class IntegrationTest < MiniTest::Test
     end
     @workbook.apply_styles
     assert_equal 9, @workbook.styled_cells.count
-    assert_equal 2, @workbook.style_index.count
+    assert_equal 2, @workbook.styles.style_index.count
+    serialize(filename)
   end
 
   # Overriding borders (part 2)
   def test_mixed_borders
-    @filename = 'mixed_borders_2'
+    filename = 'mixed_borders_2'
     @workbook.add_worksheet do |sheet|
       sheet.add_row
       sheet.add_row ['', '1', '2', '3']
@@ -229,6 +236,53 @@ class IntegrationTest < MiniTest::Test
     end
     @workbook.apply_styles
     assert_equal 8, @workbook.styled_cells.count
-    assert_equal 6, @workbook.style_index.count
+    assert_equal 6, @workbook.styles.style_index.count
+    serialize(filename)
+  end
+
+  def test_merge_styles_1
+    filename = 'merge_styles_1'
+    bold = @workbook.styles.add_style b: true
+
+    @workbook.add_worksheet do |sheet|
+      sheet.add_row
+      sheet.add_row ['', '1', '2', '3'], style: [nil, bold]
+      sheet.add_row ['', '4', '5', '6'], style: bold
+      sheet.add_row ['', '7', '8', '9']
+      sheet.add_style 'B2:D4', b: true
+      sheet.add_border 'B2:D4', { style: :thin, color: '000000' }
+    end
+    @workbook.apply_styles
+    assert_equal 9, @workbook.styles.style_index.count
+    serialize(filename)
+  end
+
+  def test_merge_styles_2
+    filename = 'merge_styles_2'
+    bold = @workbook.styles.add_style b: true
+
+    @workbook.add_worksheet do |sheet|
+      sheet.add_row ['A1', 'B1'], style: [nil, bold]
+      sheet.add_row ['A2', 'B2'], style: bold
+      sheet.add_row ['A3', 'B3']
+      sheet.add_style 'A1:A2', i: true
+    end
+    @workbook.apply_styles
+    assert_equal 3, @workbook.styles.style_index.count
+    serialize(filename)
+  end
+  
+  def test_merge_styles_3
+    filename = 'merge_styles_3'
+    bold = @workbook.styles.add_style b: true
+
+    @workbook.add_worksheet do |sheet|
+      sheet.add_row ['A1', 'B1'], style: [nil, bold]
+      sheet.add_row ['A2', 'B2']
+      sheet.add_style 'B1:B2', bg_color: 'FF0000'
+    end
+    @workbook.apply_styles
+    assert_equal 3, @workbook.styles.style_index.count
+    serialize(filename)
   end
 end

data/test/test_helper.rb

@@ -2,3 +2,5 @@ require 'axlsx_styler'
 require 'minitest/autorun'
 require 'minitest/pride'
 require 'awesome_print'
+
+mkdir_p(File.expand_path("../../tmp", __FILE__))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: axlsx_styler
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Anton Sakovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-06 00:00:00.000000000 Z
+date: 2016-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: axlsx
@@ -28,14 +28,14 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
@@ -113,6 +113,7 @@ files:
 - Rakefile
 - axlsx_styler.gemspec
 - examples/colors_and_borders.rb
+- examples/mixing_styles.rb
 - examples/vanilla_axlsx.md
 - lib/axlsx_styler.rb
 - lib/axlsx_styler/axlsx_cell.rb