axlsx_styler 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 57172ec25d3c09d1fc97016dfa3c2e4671fcf0fa
-  data.tar.gz: 06bcc42c0cac9e19f91e72d4e439feedd71a9ed9
+SHA256:
+  metadata.gz: 7afaf1eeca35216610277bc48f73ddbff03344a91a3909d80b7ba43b48c7fe5d
+  data.tar.gz: 5cdb2b7dd5bd2a85929271852cdcdc7af2743a7acb6c26bddc0ac2bccab067f4
 SHA512:
-  metadata.gz: cd15fa7bf1787b17c3f3d1e3fd70b9652ebedc7d347fb7026e05d451ff777bb3e64b1fd2818c726c467746f243c11e2d31f3484c7a73f81987547af2becfc468
-  data.tar.gz: 717fe82874512efb01d0d9832e01706ad63203b6705d1170bd4f4b9e7b75a9bbf4e6acf9bb77df9204bbe771d6395a1c3745aecc7e799f88ca5f49ffada97e0d
+  metadata.gz: 6a4e8bd27a92224b7fbe74e5f0cafd11756c8b841029b6485837728cdcb79a1f1dd5dc3f55d669e8ae9d4ea55fc82f5cf75a40742f583e7ca76823c10b5abde7
+  data.tar.gz: 8a9df17a77ae556b9bc799f4c9834d0a436bb54667bece8a799caaf6c13cb66b5c7e69fe0430e3c4a6913ad395e53d2e033f6d4d89ce5c810afe0fbe90220806

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+- **1.0.0 - January 5, 2020**
+  - Switch to the `caxlsx` gem (Community Axlsx) from the legacy unmaintained `axlsx` gem. Axlsx has had a long history of being poorly maintained so this community gem improves the situation.
+  - Require Ruby 2.3+
+  - Improve Package and Styles monkey patches using `prepend`
+  - Removed unnecessary module `AxlsxStyler::Axlsx`
+  - Major test suite improvements
+  - Add Rails dummy app to test suite and test with `axlsx_rails`
+- **0.2.0**
+  - Add support for `axlsx` v3 (at this time for v3.0.0.pre).
+  - Update test suite to run against both v2 and v3 of `axlsx`
+- **0.1.7**
+  - 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 customizable.
+- **0.1.2**
+  - Allow applying multiple style hashes.

data/README.md

@@ -1,35 +1,34 @@
-[![Gem Version](https://badge.fury.io/rb/axlsx_styler.svg)](https://rubygems.org/gems/axlsx_styler)
-[![Build Status](https://travis-ci.org/sakovias/axlsx_styler.svg?branch=master)](https://travis-ci.org/sakovias/axlsx_styler)
-
 # axlsx_styler
 
-[axlsx](https://github.com/randym/axlsx) gem is an excellent tool to
-build Excel spreadsheets. The sheets are
-created row-by-row and styles are immediately added to each cell when a
-row is created.
+<a href="https://badge.fury.io/rb/axlsx_styler" target="_blank"><img height="21" style='border:0px;height:21px;' border='0' src="https://badge.fury.io/rb/axlsx_styler.svg" alt="Gem Version"></a>
+<a href='https://travis-ci.org/axlsx-styler-gem/axlsx_styler' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://api.travis-ci.org/axlsx-styler-gem/axlsx_styler.svg?branch=master' border='0' alt='Build Status' /></a>
+<a href='https://rubygems.org/gems/axlsx_styler' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://ruby-gem-downloads-badge.herokuapp.com/axlsx_styler?label=rubygems&type=total&total_label=downloads&color=brightgreen' border='0' alt='RubyGems Downloads' /></a>
+
+`axlsx_styler` is a gem that allows you to build clean and maintainable styles for your `axlsx` spreadsheets. Build your spreadsheeet with data and then apply styles later.
+
+While [`axlsx`](https://github.com/randym/axlsx) is an excellent tool to build Excel spreadsheets in Ruby, the sheets styles are only applied immediately as the row is created. This makes it very difficult to style easily and effectively.
+
+To solve this issue, `axlsx_styler` was born to allow the separatation of styles from content within your `axlsx` code. It gives you the ability to fill out a spreadsheet with data and apply styles later. 
 
-`axlsx_styler` allows to separate styles from content: you can fill out
-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.
+Works well in any Rails app or outside of any specific Ruby framework.
 
-## Usage
+# Usage
 
-This gem provides a DSL that allows you to apply styles to ranges of cells, e.g.
+This gem provides a DSL that allows you to apply styles or borders to ranges of cells.
+
+## Styles
 
 ```ruby
 sheet.add_style 'A1:D10', b: true, sz: 14
 ```
 
-The styles can be overlayed, so that later on you can add another style
-to cells that already have styles, e.g.
+The styles can be overlayed, so that later on you can add another style to cells that already have styles.
 
 ```ruby
 sheet.add_style 'A1:D1', bg_color: 'FF0000'
 ```
 
-Applying multiple styles as a sequence of Ruby hashes is also possible:
+Applying multiple styles as a sequence of Ruby hashes is also possible.
 
 ```ruby
 bold     = { b: true }
@@ -37,25 +36,29 @@ centered = { alignment: { horizontal: :center } }
 sheet.add_style 'A2:D2', bold, centered
 ```
 
-You can also add borders to ranges of cells:
+## Borders
+
+The border style is to draw a thin black border on all four edges of the selected cell range.
 
 ```ruby
 sheet.add_border 'B2:D5'
+```
+
+You can easily customize the border styles.
+
+```ruby
 sheet.add_border 'B2:D5', [:bottom, :right]
 sheet.add_border 'B2:D5', { edges: [:bottom, :right], style: :thick, color: 'FF0000' }
 ```
 
-Border parameters are optional. The default is to draw a thin black border on all four edges of the selected cell range.
 
-
-### Example
+## Example
 
 Suppose we want create the following spreadsheet:
 
 ![alt text](./spreadsheet.png "Sample Spreadsheet")
 
-You can apply styles after all data is entered, similar to how you'd create
-an Excel document by hand:
+You can apply styles after all data is entered, similar to how you'd create an Excel document by hand.
 
 ```ruby
 require 'axlsx_styler'
@@ -82,15 +85,19 @@ end
 axlsx.serialize 'grocery.xlsx'
 ```
 
-Producing the same spreadsheet with vanilla `axlsx` turns out [a bit trickier](./examples/vanilla_axlsx.md).
+If you try creating this same spreadsheet using only `axlsx`, you will find this is much more difficult. See this [See this example](./examples/vanilla_axlsx.md)
+
+For more examples, please see the [examples folder](./examples/)
+
+# Contributing
+
+We use the `appraisal` gem for testing multiple versions of `axlsx`. Please use the following steps to test using `appraisal`.
+
+1. `bundle exec appraisal install`
+2. `bundle exec appraisal rake test`
 
+# Credits
 
-## Change log
+Created by Anton Sakovich - @sakovias
 
-Version | Change
---------|-------
-0.2.0 | Add support for `axlsx` major version `3.0.0`. Update test suite to run against v2 and v3 of `axlsx`
-0.1.7 | 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 customizable.
-0.1.2 | Allow applying multiple style hashes.
+Maintained by Weston Ganger - @westonganger - Uses `axlsx_styler` within the gem,  [`spreadsheet_architect`](https://github.com/westonganger/spreadsheet_architect)

data/Rakefile

@@ -1,7 +1,21 @@
 require "bundler/gem_tasks"
-require 'rake/testtask'
 
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.pattern = "test/*_test.rb"
+task :test do 
+  require 'rake/testtask'
+
+  Rake::TestTask.new(:test) do |t|
+    t.libs << 'lib'
+    t.libs << 'test'
+    t.pattern = 'test/**/*_test.rb'
+    t.verbose = false
+  end
+end
+
+task default: :test
+
+task :console do
+  require 'axlsx_styler'
+
+  require 'irb'
+  binding.irb
 end

data/lib/axlsx_styler.rb

@@ -1,65 +1,12 @@
 require 'axlsx'
-
 require 'axlsx_styler/version'
+
+require 'axlsx_styler/axlsx_package'
+require 'axlsx_styler/axlsx_styles'
 require 'axlsx_styler/axlsx_workbook'
 require 'axlsx_styler/axlsx_worksheet'
 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
-
-  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 
+module AxlsxStyler
 
-  end
 end

data/lib/axlsx_styler/axlsx_cell.rb

@@ -1,44 +1,44 @@
 require 'active_support/core_ext/hash/deep_merge'
 
 module AxlsxStyler
-  module Axlsx
-    module Cell
-      attr_accessor :raw_style
-
-      def add_style(style)
-        self.raw_style ||= {}
-        add_to_raw_style(style)
-        workbook.add_styled_cell self
-      end
+  module Cell
+    attr_accessor :raw_style
 
-      private
+    def add_style(style)
+      self.raw_style ||= {}
+      add_to_raw_style(style)
+      workbook.add_styled_cell self
+    end
 
-      def workbook
-        row.worksheet.workbook
-      end
+    private
 
-      def add_to_raw_style(style)
-        # using deep_merge from active_support:
-        # with regular Hash#merge adding borders fails miserably
-        new_style = raw_style.deep_merge style
+    def workbook
+      row.worksheet.workbook
+    end
 
-        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
+    def add_to_raw_style(style)
+      # using deep_merge from active_support:
+      # with regular Hash#merge adding borders fails miserably
+      new_style = raw_style.deep_merge style
 
-        self.raw_style = new_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
 
-      def with_border?(style)
-        !style[:border].nil?
-      end
+      self.raw_style = new_style
+    end
 
-      def all_edges
-        [:top, :right, :bottom, :left]
-      end
+    def with_border?(style)
+      !style[:border].nil?
+    end
+
+    def all_edges
+      [:top, :right, :bottom, :left]
     end
   end
 end
+
+Axlsx::Cell.send(:include, AxlsxStyler::Cell)

data/lib/axlsx_styler/axlsx_package.rb

@@ -0,0 +1,17 @@
+module AxlsxStyler
+  module Package
+
+    def serialize(*args)
+      workbook.apply_styles if !workbook.styles_applied
+      super
+    end
+
+    def to_stream(*args)
+      workbook.apply_styles if !workbook.styles_applied
+      super
+    end
+
+  end
+end
+
+Axlsx::Package.send(:prepend, AxlsxStyler::Package)

data/lib/axlsx_styler/axlsx_styles.rb

@@ -0,0 +1,36 @@
+module AxlsxStyler
+  module 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
+
+    # Ensure plain axlsx styles are added to the axlsx_styler style_index cache
+    def add_style(*args)
+      style = args.first
+
+      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 = super 
+        self.style_index[index] = raw_style
+      end
+      return index
+    end
+
+  end
+end
+
+Axlsx::Styles.send(:prepend, AxlsxStyler::Styles)

data/lib/axlsx_styler/axlsx_workbook.rb

@@ -2,36 +2,36 @@ require 'set'
 require 'active_support/core_ext/hash/deep_merge'
 
 module AxlsxStyler
-  module Axlsx
-    module Workbook
-      # An array that holds all cells with styles
-      attr_accessor :styled_cells
-
-      # 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
-
-      def add_styled_cell(cell)
-        self.styled_cells ||= Set.new
-        self.styled_cells << cell
-      end
+  module Workbook
+    # An array that holds all cells with styles
+    attr_accessor :styled_cells
+
+    # 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
+
+    def add_styled_cell(cell)
+      self.styled_cells ||= Set.new
+      self.styled_cells << cell
+    end
+
+    def apply_styles
+      return unless styled_cells
 
-      def apply_styles
-        return unless styled_cells
-  
-        styled_cells.each do |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)
+      styled_cells.each do |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
-        self.styles_applied = true
-      end
 
+        cell.style = styles.add_style(new_style)
+      end
+      self.styles_applied = true
     end
+
   end
 end
+
+Axlsx::Workbook.send(:include, AxlsxStyler::Workbook)

data/lib/axlsx_styler/axlsx_worksheet.rb

@@ -1,35 +1,35 @@
 require_relative './border_creator'
 
 module AxlsxStyler
-  module Axlsx
-    module Worksheet
-      # Example to add a single style:
-      #   add_style 'A1:B5', b: true, sz: 14
-      #
-      # Example to add multiple styles:
-      #   bold = { b: true }
-      #   large_text = { sz: 30 }
-      #   add_style 'B2:F8', bold, large_text
-      def add_style(cell_ref, *styles)
-        item = self[cell_ref]
-        cells = item.is_a?(Array) ? item : [item]
-        cells.each do |cell|
-          styles.each do |style|
-            cell.add_style(style)
-          end
+  module Worksheet
+    # Example to add a single style:
+    #   add_style 'A1:B5', b: true, sz: 14
+    #
+    # Example to add multiple styles:
+    #   bold = { b: true }
+    #   large_text = { sz: 30 }
+    #   add_style 'B2:F8', bold, large_text
+    def add_style(cell_ref, *styles)
+      item = self[cell_ref]
+      cells = item.is_a?(Array) ? item : [item]
+      cells.each do |cell|
+        styles.each do |style|
+          cell.add_style(style)
         end
       end
+    end
 
-      # Examples:
-      #   add_border 'B2:F8', [:left, :top], :medium, '00330f'
-      #   add_border 'B2:F8', [:left, :top], :medium
-      #   add_border 'C2:G10', [:top]
-      #   add_border 'C2:G10'
-      #   add_border 'B2:D5', { style: :thick, color: '00330f', edges: [:left, :right] }
-      def add_border(cell_ref, args = :all)
-        cells = self[cell_ref]
-        BorderCreator.new(self, cells, args).draw
-      end
+    # Examples:
+    #   add_border 'B2:F8', [:left, :top], :medium, '00330f'
+    #   add_border 'B2:F8', [:left, :top], :medium
+    #   add_border 'C2:G10', [:top]
+    #   add_border 'C2:G10'
+    #   add_border 'B2:D5', { style: :thick, color: '00330f', edges: [:left, :right] }
+    def add_border(cell_ref, args = :all)
+      cells = self[cell_ref]
+      BorderCreator.new(self, cells, args).draw
     end
   end
 end
+
+Axlsx::Worksheet.send(:include, AxlsxStyler::Worksheet)