tabulate 0.1.0 → 0.1.1

data/.bnsignore

@@ -0,0 +1,18 @@
+# The list of files that should be ignored by Mr Bones.
+# Lines that start with '#' are comments.
+#
+# A .gitignore file can be used instead by setting it as the ignore
+# file in your Rakefile:
+#
+#   Bones {
+#     ignore_file  '.gitignore'
+#   }
+#
+# For a project with a C extension, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~
+announcement.txt
+coverage
+doc
+pkg

data/History.txt

@@ -1,4 +1,6 @@
-== 1.0.0 / 2011-04-24
+== 0.1.1 / 2011-04-24
+* rdoc added
+== 0.1.0 / 2011-04-24
 
 * 1 major enhancement
   * Birthday!

data/lib/tabulate.rb

@@ -1,7 +1,21 @@
 #!/usr/bin/env ruby
 # coding: utf-8
-# author: Roy Zuo ( roylzuo AT gmail DOT com )
+# A simple tabulate method to columnize data in console.
+#
+# author::  Roy Zuo (aka roylez)
+#
 
+# global template variable
+# * :rs: record seperator
+# * :hs: heading seperator
+# * :fs: field seperator
+# * :cross: the cross point of record seperator and field seperator
+# * :lframe: left frame
+# * :rframe: right frame
+# * :hlframe: heading left frame
+# * :hrframe: heading right frame
+# * :padding: number of padding characters for each field on each side
+#
 $template = { 
     "simple" => { 
         :rs => '', :fs => ' | ',  :cross => '+',
@@ -48,17 +62,16 @@ $template = {
     },
 }
             
-# tabulate arrays, styles can be simple/legacy
-# data may come in in a format like
-#   +labels+    table heading, an array
-#   +data+      an array of data to be tabulated, one element for one row
-#   +opts+      optional arguments, :indent => 0, :style => 'fancy'
-# 
+# tabulate arrays, it accepts the following arguments
+# * :label: table headings, an array
+# * :data: table data. Each elements stands for one *or more* rows.
+#   For example, [[1, 2] , [3, [4, 5]], [nil, 6]] will be processed as 4 lines
+#       +1      2+
+#       +3      4+
+#       +3      5+
+#       +       6+
+# * :opts: optional arguments, default to :indent => 0, :style => 'fancy'
 # return a String
-#
-#   [   [a, b, c],  [d, e, [f, g]] .... ]
-#   [ a, b, c] will be used as a single row
-#   and [d, e,[f,g]] will be used as two rows
 def tabulate(labels, data, opts = { } )
     raise 'Label and data do not have equal columns!' unless labels.size == data.transpose.size
 
@@ -129,17 +142,19 @@ end
 
 class String
     if RUBY_VERSION >= '1.9'
+        # test if string contains east Asian character (RUBY_VERSION > 1.9)
         def contains_cjk?               # Oniguruma regex !!!
             (self =~ /\p{Han}|\p{Katakana}|\p{Hiragana}\p{Hangul}/)
         end
-        def width
+    end
+    # actual string width
+    def width
+        if RUBY_VERSION >= '1.9'
             gsub(/(\e|\033|\33)\[[;0-9]*\D/,'').split(//).inject( 0 ) do |s, i|
                 s += i.contains_cjk? ? 2 : 1
                 s 
             end
-        end
-    else
-        def width
+        else
             gsub(/(\e|\033|\33)\[[;0-9]*\D/,'').size
         end
     end

data/version.txt

@@ -1 +1 @@
-0.1.0
+0.1.1

metadata

@@ -1,48 +1,37 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: tabulate
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.1.1
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Roy Zuo (aka roylez)
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-25 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-04-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bones
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &86175090 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 3
-        - 6
-        - 5
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.6.5
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *86175090
 description: Create fancy command line tables with ease.
 email: roylzuo AT gmail DOT com
-executables: 
+executables:
 - tabulate
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - History.txt
 - bin/tabulate
-files: 
+files:
+- .bnsignore
 - History.txt
 - README.md
 - Rakefile
@@ -54,37 +43,29 @@ files:
 - version.txt
 homepage: http://tabulate.rubygems.org
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.md
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: tabulate
 rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Create fancy command line tables with ease.
-test_files: 
+test_files:
 - test/test_tabulate.rb