table_setting 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63c40c25789795050dc7263feef891495355d4fa
+  data.tar.gz: c65c25bba4e6335aa6706387764a153553462472
+SHA512:
+  metadata.gz: 5d5bc712d9a5e61aa1a6dcd3a4cba1255c89a12b46c604cadc0dd31f85e3813a402d9e25005a989a4450667e07ddfeac86ed24812d2e02a4147f9f919e59f168
+  data.tar.gz: adc6634d47602631a50b561c4d0358fe58520e3b22bfdc388bcaf62e985483b2f0bf50bff9d81622fdcee60af834b527eebe64d5e66c211070c3d2cbf1b10fff

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    table_setting (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  rake
+  table_setting!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Todd Gehman
+
+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,51 @@
+# TableSetting
+
+I couldn't find a gem that would allow an HTML preview of a styled Excel spreadsheet before exporting, so I had to roll my own.  Styles can be applied to individual cells, entire rows, or (once the table is built) even columns. To save some bandwidth, styles are applied using automatically-defined classes which are then applied to the corresponding cells.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'table_setting'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install table_setting
+
+## Usage
+
+The following simple example creates a table which has a header featuring large white text on a dark brown background.  The bottom right cell is individually set to bold text and the bottom row spans all columns.  Exporting with to_html or to_xls achieve roughly the same formatting.
+
+    sheet = TableSetting::Sheet.new
+    header = sheet.new_row(background: '#3A2212', color: '#ffffff', bold: true, size: '18px')
+    header.add_cells(["First Name", "Last Name"])
+
+    sheet.new_row.add_cells(["Fred", "Flintstone"])
+    row = sheet.new_row
+    row.new_cell("Wilma")
+    row.new_cell("Flintstone", bold: true)
+    
+    footer = sheet.new_row
+    footer.new_cell("That is all the people to list.", span: 'all')
+    
+Then export:
+
+    sheet.to_html
+    sheet.to_xls
+    sheet.to_csv
+    
+Or maybe you want to turn the whole second column red:
+
+    sheet.style_column(2, background: '#ff6666')
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/table_setting/cell.rb

@@ -0,0 +1,131 @@
+class TableSetting::Cell
+  attr_reader :row, :contents, :span, :style, :left_index
+    
+  def initialize(row, contents, options = {})
+    @row = row
+    @row.cells.push(self)
+
+    @contents = contents
+    @span     = options[:span] || 1
+
+    @style = TableSetting::Style.new(self, options)
+
+    @left_index = column_index
+  end
+
+  def set_style(options)
+    style.update(options)
+  end
+  
+
+  def sheet
+    row.sheet
+  end
+
+  def bold?
+    @bold || row.bold
+  end
+
+  def background
+    @background || row.background
+  end
+
+  def color
+    @color || row.color
+  end
+
+  def size
+    @size || row.size
+  end
+
+  def in_column?(number)
+    left_index == (number - 1)
+  end
+
+  def preceding_cells
+    list = []
+    my_index = row.cells.index(self)
+    row.cells.each do |cell|
+      if row.cells.index(cell) < my_index
+        list << cell
+      else
+        break
+      end
+    end
+    list
+  end
+
+  def to_html
+    <<-HTML
+      <td #{html_classes} #{span_attribute}>#{contents.blank? ? '&nbsp;' : contents}</td>
+    HTML
+  end
+
+  def style_name
+    style.name
+  end
+
+  def style_css
+    style.to_css
+  end
+
+  def style_xls
+    style.to_xls_xml
+  end
+
+  def to_xls
+    colspan = 1
+    if span == 'all'
+      colspan = sheet.num_columns
+    elsif span
+      colspan = span
+    end
+
+    if colspan > 1
+      column_attribute = %Q{ss:MergeAcross="#{colspan - 1}"}
+    end
+
+    %Q{<Cell #{column_attribute} ss:StyleID="#{style.name}"><Data ss:Type="String">#{contents}</Data></Cell>\n}
+  end
+
+  # def left_index
+  #   preceeding_cells.map{|c| c.span}.sum
+  # end
+
+  private
+
+    def html_classes
+      list = []
+      if bold?
+        list << 'bold'
+      end
+      list.push(style.name)
+      unless list.empty?
+        return %Q{class="#{list.join(' ')}"}
+      end
+      ''
+    end
+
+    def span_attribute
+      span = 0
+      if @span == 'all'
+        span = sheet.num_columns
+      elsif @span
+        span = @span
+      end
+      if span > 0
+        return %Q{colspan="#{span}"}
+      end
+      ''
+    end
+
+    def column_index
+      lefties = preceding_cells
+      if lefties.empty?
+        return 0
+      end
+      lefties.map{|c| c.span}.sum
+    end
+
+
+end

data/lib/table_setting/column.rb

@@ -0,0 +1,14 @@
+class TableSetting::Column
+  def initialize(title, method, options = {})
+    @title  = title
+    @method = method
+  end
+
+  def title
+    @title
+  end
+
+  def method
+    @method
+  end
+end

data/lib/table_setting/row.rb

@@ -0,0 +1,74 @@
+class TableSetting::Row
+  attr_reader :sheet, :bold, :background, :color, :size
+  attr_accessor :cells
+  def initialize(sheet, options = {})
+    @sheet = sheet
+    @cells = []
+    @sheet.rows.push(self)
+    @bold       = options[:bold]       || nil
+    @background = options[:background] || nil
+    @color      = options[:color]      || nil
+    @size       = options[:size]       || nil
+  end
+
+  def num_columns
+    total_width = 0
+    cells.each do |cell|
+      width = 1
+      if cell.span and 
+        cell.span != 'all' and 
+        cell.span > 1
+        width = cell.span
+      end
+      total_width += width
+    end
+    total_width
+  end
+
+  def bold?
+    bold
+  end
+
+  def new_cell(contents, options = {})
+    TableSetting::Cell.new(self, contents, options)
+  end
+
+  def add_cells(list)
+    list.map{|contents| self.new_cell(contents)}
+  end
+  
+  def to_a
+    cells.map(&:contents)
+  end
+
+  def to_html
+    <<-HTML
+      <tr>
+        #{cells.map(&:to_html).join("\n")}
+      </tr>
+    HTML
+  end
+
+  def filled?
+    cells.each do |cell|
+      return true if cell.span == 'all'
+    end
+    false
+  end
+
+  def fill
+    if num_columns < sheet.num_columns and
+      !filled?
+      filler_columns = sheet.num_columns - num_columns
+      filler_cell = self.new_cell('', span: filler_columns).to_html
+    end
+  end
+
+  def to_xls
+    <<-XML
+      <Row>
+        #{cells.map(&:to_xls).join}
+      </Row>
+    XML
+  end
+end

data/lib/table_setting/sheet.rb

@@ -0,0 +1,102 @@
+class TableSetting::Sheet
+  attr_reader :stack
+  attr_accessor :name, :rows
+
+  @@counter = 0
+
+  def initialize(parent_stack = TableSetting::Stack.new, options = {})
+    @stack = parent_stack
+    @stack.sheets.push(self)
+    @rows = []
+
+    @@counter += 1
+    @name = options[:name] || "Sheet#{@@counter}"
+  end
+
+  def cells
+    list = []
+    rows.each do |row|
+      list.concat(row.cells)
+    end
+    list
+  end
+
+  def num_columns
+    max = 0
+    rows.each do |row|
+      if row.num_columns > max
+        max = row.num_columns
+      end
+    end
+    max
+  end
+
+  def style_column(number, options)
+    rows.each do |row|
+      row.fill
+      row.cells.select{|c| c.in_column?(number)}.map{|c| c.set_style(options)}
+    end
+  end
+
+  def spacer
+    self.new_row.new_cell('', span: 'all')
+  end
+
+  def new_row(options = {})
+    TableSetting::Row.new(self, options)
+  end
+  
+  def to_csv
+    csv_string = CSV.generate do |csv|
+      rows.each do |row|
+        csv << row.to_a
+      end
+    end
+    csv_string
+  end
+
+  def to_html
+    <<-HTML
+      <style type="text/css">
+        #{css_styles}
+      </style>
+      <table class="grid-sheet">
+        #{rows.map(&:to_html).join("\n")}
+      </table>
+    HTML
+  end
+
+  def css_styles
+    signatures = {}
+    cells.each do |cell|
+      next if signatures[cell.style_name]
+      signatures[cell.style_name] = cell.style_css
+    end
+    # .grid-sheet td {background-color: #fff;}
+    # .grid-sheet tr:nth-child(odd) td {background-color: #eee;}
+    # .grid-sheet .bold {font-weight: bold;}
+    css = <<-CSS
+      .grid-sheet {background-color: #ddd; border-collapse: separate; border-spacing: 1px;}
+      .grid-sheet td {background-color: #fff;}
+    CSS
+    signatures.each do |signature_class, signature_css|
+      next if signature_css.empty?
+      css += "\n.grid-sheet td.#{signature_class} {#{signature_css}}"
+    end
+    css
+  end
+
+  def to_xls(stack_context = false)
+    if stack_context
+      <<-XML
+        <Worksheet ss:Name="#{self.name}">
+          <Table>
+            #{rows.map(&:to_xls).join}
+          </Table>
+        </Worksheet>
+      XML
+    else
+      stack.to_xls
+    end
+  end
+end

data/lib/table_setting/stack.rb

@@ -0,0 +1,56 @@
+class TableSetting::Stack
+  attr_accessor :sheets
+
+  def initialize
+    @sheets = []
+  end
+
+  def cells
+    list = []
+    sheets.each do |sheet|
+      list += sheet.cells
+    end
+    list
+  end
+
+
+  def new_sheet(options = {})
+    TableSetting::Sheet.new(self, options)
+  end
+
+  def to_xls
+    xml = <<-XML
+      <?xml version="1.0"?>
+      <Workbook xmlns="urn:schemas-microsoft-com:office:spreadsheet"
+        xmlns:o="urn:schemas-microsoft-com:office:office"
+        xmlns:x="urn:schemas-microsoft-com:office:excel"
+        xmlns:ss="urn:schemas-microsoft-com:office:spreadsheet"
+        xmlns:html="http://www.w3.org/TR/REC-html40">
+        <Styles>
+        #{xls_styles}
+        </Styles>
+        #{sheets.map{|s| s.to_xls(true)}.join}
+      </Workbook>
+    XML
+    xml.strip!
+  end
+
+
+  def xls_styles
+    signatures = {}
+    cells.each do |cell|
+      next if signatures[cell.style_name]
+      signatures[cell.style_name] = cell.style_xls
+    end
+
+    xml = ''
+    signatures.each do |signature_class, signature_xls_style|
+      xml += <<-XML
+        <Style ss:ID="#{signature_class}">
+          #{signature_xls_style}
+        </Style>
+      XML
+    end
+    xml
+  end
+end

data/lib/table_setting/style.rb

@@ -0,0 +1,72 @@
+class TableSetting::Style
+  attr_reader :bold, :size, :background, :color
+  def initialize(cell, options = {})
+    @bold =       options[:bold]       || cell.row.bold?
+    @size =       options[:size]       || cell.row.size
+    @background = options[:background] || cell.row.background
+    @color =      options[:color]      || cell.row.color
+  end
+
+  def update(options)
+    @bold       = options[:bold]       if options[:bold]
+    @background = options[:background] if options[:background]
+    @color      = options[:color]      if options[:color]
+    @size       = options[:size]       if options[:size]
+  end
+
+  def name
+    settings = {
+      bold:       bold?,
+      background: background,
+      size:       size,
+      color:      color
+    }
+    "style-#{Digest::MD5.hexdigest(settings.to_s)[0..7]}"
+  end
+
+  def bold?
+    bold
+  end
+
+  def to_css
+    signature = ''
+    if bold?
+      signature += "font-weight: bold;"
+    end
+    if size
+      signature += "font-size: #{size};"
+    end
+    if background
+      signature += "background-color: #{background};"
+    end
+    if color
+      signature += "color: #{color};"
+    end
+    signature
+  end
+
+  def to_xls_xml
+    signature = ''
+    font_specs = {}
+    if bold?
+      font_specs["ss:Bold"] = 1
+    end
+    if size
+    end
+    if background
+      signature += %Q{<Interior ss:Color="#{background}" ss:Pattern="Solid"/>}
+    end
+    if color
+      font_specs["ss:Color"] = color
+    end
+    unless font_specs.empty?
+      spec_string = ''
+      font_specs.each do |key, value|
+        spec_string += %Q{#{key}="#{value}" }
+      end
+      signature += "<ss:Font #{spec_string} />"
+    end
+
+    signature
+  end
+end

data/lib/table_setting/version.rb

@@ -0,0 +1,3 @@
+module TableSetting
+  VERSION = "0.2.0"
+end

data/lib/table_setting.rb

@@ -0,0 +1,12 @@
+require "table_setting/version"
+
+require 'table_setting/cell'
+require 'table_setting/column'
+require 'table_setting/row'
+require 'table_setting/sheet'
+require 'table_setting/stack'
+require 'table_setting/style'
+
+module TableSetting
+
+end

data/table_setting.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'table_setting/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "table_setting"
+  spec.version       = TableSetting::VERSION
+  spec.authors       = ["Todd Gehman"]
+  spec.email         = ["toddgehman@gmail.com"]
+  spec.description   = %q{Ruby gem to create a data table that can be easily presented as HTML or Excel with the same human-friendly display styles applied to both. Unstyled formats like CSV are supported as well.}
+  spec.summary       = %q{Data table exports with shared custom style settings.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: table_setting
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Todd Gehman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby gem to create a data table that can be easily presented as HTML
+  or Excel with the same human-friendly display styles applied to both. Unstyled formats
+  like CSV are supported as well.
+email:
+- toddgehman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/table_setting.rb
+- lib/table_setting/cell.rb
+- lib/table_setting/column.rb
+- lib/table_setting/row.rb
+- lib/table_setting/sheet.rb
+- lib/table_setting/stack.rb
+- lib/table_setting/style.rb
+- lib/table_setting/version.rb
+- table_setting.gemspec
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Data table exports with shared custom style settings.
+test_files: []