array-formatter 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74c5fcc251fdd3259eb03c4c60aab0cbd067a4a8
+  data.tar.gz: b3101c02d554d3b2971752e4154aa7ad06e1b74c
+SHA512:
+  metadata.gz: c4e0b8880b25896db9867d8a7439d83b28127fa04dd84895ab083c5cccc9223305291af7b021d78d0023a4d9868fe202a813b655c5e93d64c432267f25dc4b3f
+  data.tar.gz: 4698454dc011619bfbd8f75d6bbf1b05b3025c0fd88f5621cf830799c55479bac8e1d97d625eab1244962cc439f3dfce83637e485ea52a01b5300fa8ce33ef0b

data/.gitignore

@@ -0,0 +1,25 @@
+# Because this is a gem, ignore Gemfile.lock:
+
+Gemfile.lock
+
+# And because this is Ruby, ignore the following
+#  (source: https://github.com/github/gitignore/blob/master/Ruby.gitignore):
+
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alan K. Stebbens <aks@stebbens.org>
+
+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,50 @@
+# Array::Formatter
+
+A simple gem to reformat an array of arrays into one of several formats:
+
+- HTML table (as a string)
+- CSV string
+- table (using fixed-width ASCII text or Unicode drawing characters)
+- YAML string
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'array-formatter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install array-formatter
+
+## Usage
+
+    require 'array/formatter'
+
+    array.to_table :ascii
+    array.to_table :unicode
+    array.to_table :unicode_double
+    array.to_table :unicode_single
+    array.to_table :unicode_mixed
+
+    array.to_csv
+
+    array.to_html
+
+    array.to_yaml
+
+## Author:
+
+Alan K. Stebbens <aks@stebbens.org>
+
+## 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,12 @@
+#require 'rake'
+
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/test[-_]*.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/array-formatter.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'array/formatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "array-formatter"
+  spec.version       = Array::Formatter::VERSION
+  spec.authors       = ["Alan Stebbens"]
+  spec.email         = ["aks@stebbens.org"]
+  spec.summary       = "Format an array of arrays in one of serveral string formats"
+  spec.description   = <<-EOF
+    A simple gem to reformat an array of arrays into one of several string
+    formats: HTML table; CSV; ASCII table; YAML
+    EOF
+  spec.homepage      = "https://gitlab.com/as/array-formatter"
+  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

data/lib/array/formatter.rb

@@ -0,0 +1,247 @@
+# array-formatter.rb
+#
+# Author: Alan K. Stebbens <aks@stebbens.org>
+#
+# ARRAY.to_html  -- format an array of arrays into an HTML table string
+# ARRAY.to_csv   -- format an array of arrays into a CSV string
+# ARRAY.to_table -- format an array of arrays into an ASCII table string
+#
+
+class Array
+
+  # string = ARRAY.to_html indent=0
+  #
+  # Return an HTML representation of an array of arrays as an
+  # HTML table.  If indent given, indent the <table> by that
+  # many spaces.
+
+  def to_html indent=0
+    require 'cgi'
+    s = self.wrap_map_html_data("table", indent + 0) do |row,   rx|
+         row.wrap_map_html_data("tr",    indent + 1) do |field, fx|
+           tag = rx == 0 ? 'th' : 'td'
+           (' ' *                       (indent + 2)) +   # indention
+           "<#{tag}>"                                 +   # open tag
+           (field && CGI.escapeHTML(field) || '')     +   # cell text
+           "</#{tag}>\n"                                  # close tag
+         end
+    end
+    s
+  end
+
+  # string = ARRAY.wrap_map_html_data TAG, INDENT {|DATA, INDEX| block}
+  #
+  # Return a string HTML representation of an array of data, starting with
+  # <TAG> and ending with </TAG>, and invoking the block on each array item,
+  # passing the DATA item with its INDEX.
+
+  def wrap_map_html_data tag, indent=0
+    s = ''
+    prefix = ' ' * indent
+    s << prefix + "<#{tag}>\n"
+    self.each_with_index {|data, x| s << ((yield data, x) || '') }
+    s << prefix + "</#{tag}>\n"
+    s
+  end
+
+  # string = ARRAY.to_csv
+  #
+  # Convert an array of arrays to CSV representation Basically, each
+  # top-level array row becomes a line of CSV data The 2nd level
+  # arrays become individual rows of data, separated by commas.  Each
+  # 2nd level array item gets quoted if it contains any punctuation
+  # characters.
+
+  def to_csv
+    self.map {|row| row.map {|f| f =~ /[[:punct:]]/ ?  '"' + f.gsub(/"/, '""') + '"' : f }.join(",")}.join("\n")
+  end
+
+  # string = ARRAY.to_table type
+  #
+  # Convert an array of arrays to ASCII table representation
+  #
+  # to create a box, we need to describe the parts of it:
+  # (be sure to used fixed-width font)
+  #
+  #  +-------+-------+  <== top border
+  #  | cell1 | cell2 |  <== data row
+  #  +-------+-------+  <== inner border
+  #  | r2c1  | r2c2  |  <== data row
+  #  +-------+-------+  <== bottom border
+  #  ^       ^       ^
+  #  |       |       +--<== right
+  #  |       +----------<== middle
+  #  +------------------<== left
+  #
+  # Given these, there are 15 specific characters for line drawing:
+  #
+  #      Location          Symbol          Location          Symbol
+  #   ================     ======       ================     ======
+  #     top-left-border     tlb           left-inner-border   lib
+  #     top-border           tb                inner-border    ib
+  #     top-inner-border    tib         middle-inner-border   mib
+  #     top-right-border    trb          right-inner-border   rib
+  #
+  #     left-data-border    ldb          bottom-left-border   blb
+  #    inner-data-border    idb          bottom-border         bb
+  #    right-data-border    rdb          bottom-inner-border  bib
+  #                                      bottom-right-border  brb
+  #
+  # In the specs below, the characters are given in the same order as above.
+  # The characters are index by the given symbols.
+
+  class TableChars < Hash
+
+    @@table_chars = {}
+    @@table_char_names = %w( tlb tb tib trb ldb idb rdb lib ib mib rib blb bb bib brb ).map{|n|n.intern}
+
+    def initialize name, fmt_chars, start=nil, stop=nil
+      @chars = self
+      @@table_chars[name] = @chars
+      if fmt_chars.class == Symbol
+        @@table_chars[name] = @chars = @@table_chars[fmt_chars].dup
+      elsif fmt_chars.class == Array
+        chars = fmt_chars.dup
+        @@table_char_names.each{|n| @chars[n] = chars.shift || raise(ArgumentError, "Missing characters from table drawing charset!")}
+      end
+      @start = start
+      @stop = stop
+      @chars
+    end
+
+    @@table_char_names.each do |name|
+      define_method(name) { @chars[name] }
+    end
+
+    # TableChars.get NAME
+    #
+    # Return the TableChars object for NAME, or nil
+
+    def self.get name
+      @chars = @@table_chars[name]
+    end
+
+    attr_reader :start, :stop
+
+    def wrap text
+      (@start || '') + text + (@stop || '')
+    end
+
+  end
+
+  # :ascii -- an ASCII table
+
+  TableChars.new :ascii, %w( + - + +   | | |  + - + +   + - + +  )
+
+  # :unicode_single - a table with thick outer border, and thin inner lines.
+  TableChars.new :unicode_single, [ "\u250F", "\u2501", "\u252F", "\u2513",     # tlb,  tb, tib, trb
+                                    "\u2503", "\u2502", "\u2503",               # ldb, idb, rdb
+                                    "\u2520", "\u2500", "\u253C", "\u2528",     # lib,  ib, mib, rib
+                                    "\u2517", "\u2501", "\u2537", "\u251B" ]    # blb,  bb, bib, brb
+
+  # :unicode_bold - a table with thick borders everywhere
+  TableChars.new :unicode_bold,   [ "\u250F", "\u2501", "\u2533", "\u2513",     # tlb,  tb, tib, trb
+                                    "\u2503", "\u2503", "\u2503",               # ldb, idb, rdb
+                                    "\u2523", "\u2501", "\u254B", "\u252B",     # lib,  ib, mib, rib
+                                    "\u2517", "\u2501", "\u253B", "\u251B" ]    # blb,  bb, bib, brb
+
+  # :unicode_double - a table with double lines everywhere
+  TableChars.new :unicode_double, [ "\u2554", "\u2550", "\u2566", "\u2557",     # tlb,  tb, tib, trb
+                                    "\u2551", "\u2551", "\u2551",		# ldb, idb, rdb
+                                    "\u2560", "\u2550", "\u256C", "\u2563",     # lib,  ib, mib, rib
+                                    "\u255A", "\u2550", "\u2569", "\u255D" ]    # blb,  bb, bib, brb  			
+
+  # :unicode_mixed - a table with double outer lines, and single inner lines
+  TableChars.new :unicode_mixed,  [ "\u2554", "\u2550", "\u2564", "\u2557",     # tlb,  tb, tib, trb
+                                    "\u2551", "\u2502", "\u2551",		# ldb, idb, rdb
+                                    "\u2557", "\u2550", "\u253C", "\u2562",     # lib,  ib, mib, rib
+                                    "\u255A", "\u2550", "\u2567", "\u255D" ]    # blb,  bb, bib, brb 
+
+  TableChars.new :dos_single,	  [ "\xDA", "\xC4", "\xC2", "\xBF",	        # tlb,  tb, tib, trb
+                                    "\xB3", "\xB3", "\xB3",		        # ldb, idb, rdb
+                                    "\xC3", "\xC4", "\xC5", "\xB4",	        # lib,  ib, mib, rib
+                                    "\xC0", "\xC4", "\xC1", "\xD9" ]	        # blb,  bb, bib, brb
+
+  TableChars.new :dos_double, 	  [ "\xC9", "\xCD", "\xCB", "\xBB",	        # tlb,  tb, tib, trb
+                                    "\xBA", "\xBA", "\xBA",		        # ldb, idb, rdb
+                                    "\xCC", "\xCD", "\xCE", "\xB9",	        # lib,  ib, mib, rib
+                                    "\xC8", "\xCD", "\xCA", "\xBC" ]	        # blb,  bb, bib, brb
+
+  TableChars.new :vt100,	  [ "\x6C", "\x71", "\x77", "\x6B",	        # tlb,  tb, tib, trb
+                                    "\x78", "\x78", "\x78",		        # ldb, idb, rdb,
+                                    "\x74", "\x71", "\x6E", "\x75",	        # lib,  ib, mib, rib 
+                                    "\xCD", "\x71", "\x76", "\x6A" ],           # blb,  bb, bib, brb
+                                  "\e(0", "\e(B"
+
+  TableChars.new :unicode, :unicode_single
+  TableChars.new :dos,     :dos_single
+
+
+  def to_table name=:ascii
+    @chars = TableChars.get name
+
+    # compute the maximum widths and the alignment of each column
+    @widths = []
+    @align = []
+    self.each_with_index do |row,rx| 
+      row.each_with_index do |col,cx|
+        @widths[cx] ||= 0
+        l = col.to_s.length 
+        @widths[cx] = l if l > @widths[cx]
+        if rx == 0
+          type = nil
+        else
+          type = case (col || '')
+                 when /^\$?\s*\d[,\d]*\.\d*$/  then :rjust   # real number and/or currency
+                 when /^\$?\s*\d[,\d]*$/       then :rjust   # integer
+                 when /^$/, /^\s*-\s*$/, nil   then nil       # empty values have no alignment
+                 else :ljust
+                 end
+        end
+        @align[cx] ||= (col ? type : nil)
+        @align[cx] = :ljust if type && @align[cx] != type && rx > 0
+      end
+    end
+
+    # now format each row
+    s = ''
+    self.each_with_index do |row, rx|
+      s << table_line(rx == 0 ? :top : :middle)
+      s << table_data(row)
+    end
+    s << table_line(:bottom)
+    s
+  end
+
+  ## 
+  # table_line position
+  #
+  # generate a table line for position (:top, :middle, :bottom)
+  # 
+  def table_line position
+    c = @chars
+    left, line, mid, right = case position
+                             when :top     then [c[:tlb], c[:tb], c[:tib], c[:trb]]
+                             when :middle  then [c[:lib], c[:ib], c[:mib], c[:rib]]
+                             when :bottom  then [c[:blb], c[:bb], c[:bib], c[:brb]]
+                             end
+    s = @chars.wrap(left + @widths.map{|w| line * (w + 2)}.join(mid) + right) + "\n"
+    s
+  end
+
+  ##
+  # table_data data
+  #
+  # generate a data row as part of a table
+
+  def table_data data
+    left, middle, right = [@chars[:ldb], @chars[:idb], @chars[:rdb]]
+    a = []
+    data.each_with_index do |item, x|
+      a << (' ' + item.to_s.send(@align[x] || :ljust, @widths[x]) + ' ')
+    end
+    s = @chars.wrap(left) + a.join(@chars.wrap(middle)) + @chars.wrap(right) + "\n"
+    s
+  end
+
+end

data/lib/array/formatter/version.rb

@@ -0,0 +1,3 @@
+class Array::Formatter
+  VERSION = "1.0.1"
+end

data/test/test-array-formatter.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift '.', './test', './lib'
+
+require 'array/formatter'
+require 'test-helper'
+
+class Test_Array_Formatter < MiniTest::Unit::TestCase
+
+  @@a = [ %w( Company  Name  Address  Phone  Email ),
+          [ 'New Company', 'First Last', 'Somewhere, US', '123-45-6789', 'user@sample.com' ],
+          [ 'Old Company', 'First2 Last2', 'Somewhere else, US', '987-65-4321', 'user2@sample.com' ],
+          [ 'No Company',  'First3 Last3', 'Elsewhere ZZ', '763-34-1234', 'user3@sample.com' ]
+        ]
+
+  @@a2 = [ %w( Region    State      Sales   ),
+           %w( Northwest WA       $2,100,500 ),
+           %w( Northwest OR         $900,800 ),
+           %w( Northeast NY       $8,120,000 ),
+           %w( Northeast MN         $489,500 ),
+           %w( Southeast GA       $2,111,200 ),
+           %w( Southeast FL       $9,388,000 ),
+           %w( Southwest AZ       $7,377,000 ) ]
+        
+
+  def test_to_table_default
+    s = @@a.to_table
+    puts s
+  end
+
+  def test_to_table_unicode
+    s = @@a.to_table(:unicode)
+    puts s
+  end
+
+  def test_to_table_alignments
+    s = @@a2.to_table
+    puts s
+    puts ''
+    s = @@a2.to_table(:unicode)
+    puts s
+  end
+
+end

data/test/test-helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'array/formatter'

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: array-formatter
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Alan Stebbens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-17 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: |2
+      A simple gem to reformat an array of arrays into one of several string
+      formats: HTML table; CSV; ASCII table; YAML
+email:
+- aks@stebbens.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- array-formatter.gemspec
+- lib/array/formatter.rb
+- lib/array/formatter/version.rb
+- test/test-array-formatter.rb
+- test/test-helper.rb
+homepage: https://gitlab.com/as/array-formatter
+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.7
+signing_key: 
+specification_version: 4
+summary: Format an array of arrays in one of serveral string formats
+test_files:
+- test/test-array-formatter.rb
+- test/test-helper.rb