axlsx_styler 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2536d38bb1cb2ea59a3c8c3b4271056e6ed61e4f
+  data.tar.gz: 49dd2f0a2069ccc497167b2ceef045420236c2c2
+SHA512:
+  metadata.gz: 9f1ae20c49e60b41217a3c43e398685fa7de9d66b401e309fe5f69a6c938fd2c93df70028ae73949b3a685ea03ce46c80662c84387a227cebc2bf8df4c6f92a0
+  data.tar.gz: 9f8ce7362c84f93d1c9c747d73cfbe9d5067b2934c39c58d7003bc3fbd3219e21f9ed2e05a0c50cc32fe1f8fcbcf78d0ca750feb972a4322c2591d75b7e43cb2

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.xlsx

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in axlsx_styler.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Anton Sakovich
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# AxlsxStyler
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'axlsx_styler'
+
+And then execute:
+
+    $ bundle
+
+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/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end

data/axlsx_styler.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'axlsx_styler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "axlsx_styler"
+  spec.version       = AxlsxStyler::VERSION
+  spec.authors       = ["Anton Sakovich"]
+  spec.email         = ["sakovias@gmail.com"]
+  spec.summary       = %q{This gem allows to separate data from styles when using Axlsx gem.}
+  spec.description   = %q{
+    Axlsx gem is an excellent tool to build Excel worksheets. 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.
+  }
+  spec.homepage      = "https://github.com/sakovias/axlsx_styler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "axlsx", "~> 2.0"
+  spec.add_dependency "activesupport", "~> 3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 0.9"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/examples/colors_and_borders.rb

@@ -0,0 +1,21 @@
+require_relative '../lib/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["B2:D2"].add_style(b: true)
+  sheet["B2:D5"].add_style(bg_color: "E2D3EB")
+  sheet["B2:D5"].add_border
+  sheet["B3:D3"].add_border([:top])
+end
+
+workbook.apply_styles
+
+axlsx.serialize "grocery.xlsx"

data/lib/axlsx_styler.rb

@@ -0,0 +1,9 @@
+require 'axlsx'
+
+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

data/lib/axlsx_styler/array.rb

@@ -0,0 +1,66 @@
+module AxlsxStyler
+  module Array
+    def add_style(style)
+      validate_cells
+      each do |cell|
+        cell.add_style(style)
+      end
+    end
+
+    # - edges is either :all or an an array with elements
+    #   in [:top, :bottom, :bottom, :left]
+    # - couldn't do variable border thickness around the same cell;
+    #   hardcode style to :thin for now
+    def add_border(edges = :all)
+      validate_cells
+      selected_edges(edges).each{ |edge| add_border_at(edge) }
+    end
+
+    private
+
+    def selected_edges(edges)
+      all_edges = [:top, :right, :bottom, :left]
+      if edges == :all
+        all_edges
+      elsif edges.is_a?(Array) && edges - all_edges == []
+        edges.uniq
+      else
+        []
+      end
+    end
+
+    def validate_cells
+      valid = map{ |e| e.is_a? Axlsx::Cell }.uniq == [ true ]
+      raise "Not a range of cells" unless valid
+    end
+
+    def border_cells
+      @border_cells ||= get_border_cells
+    end
+
+    def get_border_cells
+      first = self.first.r
+      last  = self.last.r
+      # example range "B2:D5"
+      {
+        top:     "#{first}:#{last[0]}#{first[1]}", # "B2:D2"
+        right:   "#{last[0]}#{first[1]}:#{last}",  # "D2:D5"
+        bottom:  "#{first[0]}#{last[1]}:#{last}",  # "B5:D5"
+        left:    "#{first}:#{first[0]}#{last[1]}"  # "B2:B5"
+      }
+    end
+
+    def worksheet
+      @worksheet ||= self.first.row.worksheet
+    end
+
+    def add_border_at(position)
+      style = {
+        border: {
+          style: :thin, color: "000000", edges: [position.to_sym]
+        }
+      }
+      worksheet[border_cells[position.to_sym]].add_style(style)
+    end
+  end
+end

data/lib/axlsx_styler/axlsx_extensions.rb

@@ -0,0 +1,52 @@
+require 'active_support/core_ext/hash/deep_merge'
+
+module AxlsxStyler
+  module Axlsx
+    module Workbook
+      attr_accessor :styled_cells
+
+      def add_styled_cell(cell)
+        self.styled_cells ||= []
+        self.styled_cells << cell
+      end
+
+      def apply_styles
+        return unless styled_cells
+        styled_cells.each do |cell|
+          cell.style = styles.add_style(cell.raw_style)
+        end
+      end
+    end
+
+    module Cell
+      attr_accessor :raw_style
+
+      def workbook
+        row.worksheet.workbook
+      end
+
+      def add_style(style)
+        self.raw_style ||= {}
+        add_to_raw_style(style)
+        workbook.add_styled_cell self
+      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
+        if with_border?(raw_style) && with_border?(style)
+          border_at = raw_style[:border][:edges] + style[:border][:edges]
+          new_style[:border][:edges] = border_at
+        elsif with_border?(style)
+          new_style[:border] = style[:border]
+        end
+        self.raw_style = new_style
+      end
+
+      def with_border?(style)
+        !style[:border].nil?
+      end
+    end
+  end
+end

data/lib/axlsx_styler/version.rb

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

data/test/array_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class ArrayTest < MiniTest::Test
+  def test_presesence_of_add_style
+    array = Array.new
+    assert array.respond_to?(:add_style)
+  end
+end

data/test/cell_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class CellTest < MiniTest::Test
+  def test_can_add_style
+    p = Axlsx::Package.new
+    wb = p.workbook
+    sheet = wb.add_worksheet
+    row = sheet.add_row ["x", "y"]
+    cell = row.cells.first
+
+    cell.add_style b: true
+    assert_equal({ b: true }, cell.raw_style)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'axlsx_styler'
+require 'minitest/autorun'
+require 'minitest/pride'

data/test/workbook_test.rb

@@ -0,0 +1,9 @@
+class WorkbookTest < MiniTest::Test
+  def test_adding_styled_cells
+    p = Axlsx::Package.new
+    wb = p.workbook
+    wb.add_styled_cell 'Cell 1'
+    wb.add_styled_cell 'Cell 2'
+    assert_equal ['Cell 1', 'Cell 2'], wb.styled_cells
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: axlsx_styler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anton Sakovich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: axlsx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  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
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: "\n    Axlsx gem is an excellent tool to build Excel worksheets. The
+  sheets are\n    created row-by-row and styles are immediately added to each cell
+  when a\n    row is created. This gem allows to follow an alternative route: fill
+  out\n    a spreadsheet with data and apply styles later. Styles can be added\n    to
+  individual cells as well as to ranges of cells. As a bonus, this gem\n    also simplifies
+  drawing borders around groups of cells.\n  "
+email:
+- sakovias@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- 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
+- test/array_test.rb
+- test/cell_test.rb
+- test/test_helper.rb
+- test/workbook_test.rb
+homepage: https://github.com/sakovias/axlsx_styler
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: This gem allows to separate data from styles when using Axlsx gem.
+test_files:
+- test/array_test.rb
+- test/cell_test.rb
+- test/test_helper.rb
+- test/workbook_test.rb