axlsx_styler 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2536d38bb1cb2ea59a3c8c3b4271056e6ed61e4f
-  data.tar.gz: 49dd2f0a2069ccc497167b2ceef045420236c2c2
+  metadata.gz: 741a7a700d2d37228f6002dcc7776f00d3c975ec
+  data.tar.gz: 049469dbe509df37e8c21c3702248ab5eabb467e
 SHA512:
-  metadata.gz: 9f1ae20c49e60b41217a3c43e398685fa7de9d66b401e309fe5f69a6c938fd2c93df70028ae73949b3a685ea03ce46c80662c84387a227cebc2bf8df4c6f92a0
-  data.tar.gz: 9f8ce7362c84f93d1c9c747d73cfbe9d5067b2934c39c58d7003bc3fbd3219e21f9ed2e05a0c50cc32fe1f8fcbcf78d0ca750feb972a4322c2591d75b7e43cb2
+  metadata.gz: e80a33c66d5f932b502b5ba69fb5a03ed764295a5798a98279acb9c001f66e53cd4b821568fe4dab69c442a3ae6986cad845a6b04841bd2844204da260403677
+  data.tar.gz: 4096057d99938214307c0b2a7f217b3a632cd84011dfec1065bdc62a3380568445116b4eebe2e5fcbeba15403e9cd2f95282d633f01f752235df9bdcfbd7b75e

data/.gitignore

@@ -21,3 +21,4 @@ tmp
 *.a
 mkmf.log
 *.xlsx
+*.xlsx#

data/README.md

@@ -1,6 +1,151 @@
 # AxlsxStyler
 
-TODO: Write a gem description
+[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. This gem allows to follow an alternative route: fill out
+a spreadsheet with data and apply styles later. Styles can be added
+to individual cells as well as to ranges of cells. As a bonus, this gem
+also simplifies drawing borders around groups of cells.
+
+## Usage
+
+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
+```
+
+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'
+```
+
+You can also add borders to ranges of cells:
+
+```ruby
+sheet["B2:D5"].add_border
+sheet["B2:B5"].add_border [:right]
+```
+
+When you are done with styling you just need to run
+
+```ruby
+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:
+
+![alt text](./spreadsheet.png "Sample Spreadsheet")
+
+### With `AxlsxStyler`
+
+Just follow the step outlined above:
+
+```ruby
+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.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]
+end
+
+workbook.apply_styles
+
+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.
+
+```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
 
@@ -15,15 +160,3 @@ And then execute:
 Or install it yourself as:
 
     $ gem install axlsx_styler
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/axlsx_styler/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request

data/examples/colors_and_borders.rb

@@ -9,13 +9,18 @@ workbook.add_worksheet do |sheet|
   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
 
-  sheet["B2:D2"].add_style(b: true)
-  sheet["B2:D5"].add_style(bg_color: "E2D3EB")
+  # 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["B3:D3"].add_border [:top]
 end
 
 workbook.apply_styles
 
-axlsx.serialize "grocery.xlsx"
+axlsx.serialize "../grocery.xlsx"

data/lib/axlsx_styler.rb

@@ -4,6 +4,6 @@ require 'axlsx_styler/version'
 require 'axlsx_styler/array'
 require 'axlsx_styler/axlsx_extensions'
 
-Array.include AxlsxStyler::Array
-Axlsx::Workbook.include AxlsxStyler::Axlsx::Workbook
-Axlsx::Cell.include AxlsxStyler::Axlsx::Cell
+Array.send :include, AxlsxStyler::Array
+Axlsx::Workbook.send :include, AxlsxStyler::Axlsx::Workbook
+Axlsx::Cell.send :include, AxlsxStyler::Axlsx::Cell

data/lib/axlsx_styler/version.rb

@@ -1,3 +1,3 @@
 module AxlsxStyler
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: axlsx_styler
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Anton Sakovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-16 00:00:00.000000000 Z
+date: 2015-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: axlsx
@@ -99,11 +99,11 @@ files:
 - Rakefile
 - axlsx_styler.gemspec
 - examples/colors_and_borders.rb
-- examples/grocery.xlsx
 - lib/axlsx_styler.rb
 - lib/axlsx_styler/array.rb
 - lib/axlsx_styler/axlsx_extensions.rb
 - lib/axlsx_styler/version.rb
+- spreadsheet.png
 - test/array_test.rb
 - test/cell_test.rb
 - test/test_helper.rb