tablizer 1.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Nicolas Oga
+
+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,47 @@
+Tablizer
+========
+
+# DESCRIPTION
+
+Tablizer is a gem that provides you a tool for quickly rendering tables, and has ANSI support for printing color strings into your console.
+
+This should do the trick:
+
+``` ruby
+table = [
+	['animal',				'familia',		'cantidad de patas',	'pelaje'				],
+	['ornitorrinco',		'mamiferos',	'4',					'mediano y marron'		, "caca"],
+	['pato',				'aves',		 	'2',					'plumas blancas'		],
+	['gato',				'mamiferos',	'4',	 				'gris y corto'			],
+	['marmota',				'mamiferos',	'4',					'color natural y corto'	]
+]
+
+mytable = Table.new(table, header: true, align: 'right')
+puts mytable
+
+=>	+------------+---------+-----------------+---------------------+----+
+	|   Animal   | Familia |Cantidad de patas|       Pelaje        |    |
+	+------------+---------+-----------------+---------------------+----+
+	|ornitorrinco|mamiferos|                4|     mediano y marron|caca|
+	|        pato|     aves|                2|       plumas blancas|    |
+	|        gato|mamiferos|                4|         gris y corto|    |
+	|     marmota|mamiferos|                4|color natural y corto|    |
+	+------------+---------+-----------------+---------------------+----+
+```
+
+The table object has the [] and []= methods, that lets you access it's data and manipulate it.
+
+``` ruby
+mytable[0,3]	# => 'gato'
+mytable[0,6]	# => nil
+mytable[3,2] = 'trololo'
+
+=> 	+------------+---------+-----------------+---------------------+----+
+	|   Animal   | Familia |Cantidad de patas|       Pelaje        |    |
+	+------------+---------+-----------------+---------------------+----+
+	|ornitorrinco|mamiferos|                4|     mediano y marron|caca|
+	|        pato|     aves|                2|              trololo|    |
+	|        gato|mamiferos|                4|         gris y corto|    |
+	|     marmota|mamiferos|                4|color natural y corto|    |
+	+------------+---------+-----------------+---------------------+----+
+```

data/Rakefile

@@ -0,0 +1,150 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/lib/tablizer.rb

@@ -0,0 +1,5 @@
+module Tablizer
+  VERSION = '1.0.2'
+end
+
+require_relative 'tablizer/table'

data/lib/tablizer/ansi_string.rb

@@ -0,0 +1,40 @@
+module Tablizer
+
+  # Some extensions to String to deal with ANSI colors.
+  module StringANSI
+
+    COLORS = {
+      :black   => 30,
+      :red     => 31,
+      :green   => 32,
+      :brown   => 33,
+      :blue    => 34,
+      :magenta => 35,
+      :cyan    => 36,
+      :gray    => 37
+    }
+
+    def color(color)
+      code = "\033[#{COLORS[color]}m"
+      end_code = "\033[0m"
+      return "#{code}#{self}#{end_code}"
+    end
+
+    def ansi_length
+      gsub(/\033\[\d+m/, "").length
+    end
+
+    def ansi_rjust(len, char = " ")
+      rjust(len + length - ansi_length, char)
+    end
+
+    def ansi_ljust(len, char = " ")
+      ljust(len + length - ansi_length, char)
+    end
+
+    def ansi_center(len, char = " ")
+      center(len + length - ansi_length, char)
+    end
+  end
+
+end

data/lib/tablizer/conditional.rb

@@ -0,0 +1,12 @@
+module Tablizer
+
+  module ExistChecker
+    def exists?
+      return false if self.nil?
+      return false if self.is_a?(String) and self.length == 0
+      return false if self.is_a?(Numeric) and self == 0
+      true
+    end
+  end
+
+end

data/lib/tablizer/table.rb

@@ -0,0 +1,137 @@
+require_relative 'ansi_string'
+require_relative 'conditional'
+
+class String
+  include Tablizer::StringANSI
+end
+
+module Tablizer
+  class Table
+    include Enumerable
+
+    attr_accessor :options, :content
+
+    DEFAULTS = {
+      align: 'ansi_ljust',
+      header: false,
+      footer: false
+    }
+
+    def initialize(content = [], params = {})
+      @options = DEFAULTS.merge(params)
+
+      raise "Cannot set rows and columns at the same time." if @options.has_key?(:cols) && @options.has_key?(:rows)
+
+      set_content content
+    end
+
+    def set_content(content)
+      @content = content.dup
+    end
+
+    # The []= method let's you access the Table object data as if it was a 2 dimension Array.
+    # You can call []= in the form 'obj[col,row] = value', or, in mathematical terms, 'obj[x,y] = value'
+    def []=(col, row, value)
+      @content[row] ||= []
+      @content[row][col] = value
+    end
+
+    def [](col, row)
+      @content[row][col].to_s
+    end
+
+    def empty?
+      each { |elem| return false if elem =~ /\S/ }
+      true
+    end
+
+    def each(&block)
+      block_given? ? enumerator.each(&block) : enumerator
+    end
+
+    def enumerator
+      Enumerator.new do |yielder|
+        number_of_columns, number_of_rows = columns, rows
+        (0...number_of_rows).each do |row_index|
+          (0...number_of_columns).each do |column_index|
+            yielder.yield self[column_index, row_index]
+          end
+        end
+      end
+    end
+
+    def <=>(other)
+      size <=> other
+    end
+
+    def size
+      rows * columns
+    end
+
+    def to_s
+      tablize
+    end
+
+    def to_s_with_margins
+      ("\n" * 4) << to_s << ("\n" * 4)
+    end
+
+    def columns
+      @content.collect { |a| a.length }.max || 0
+    end
+
+    def rows
+      @content.length
+    end
+
+  private
+
+    def tablize
+      return "" if empty?
+
+      alignment = @options[:align]
+
+      number_of_columns, number_of_rows = columns, rows
+
+      # Getting maximun lengths for each column
+      length = (0...number_of_columns).map do |column_index|
+        (0...rows).map do |row_index|
+          self[column_index, row_index].ansi_length
+        end.max
+      end
+
+      # Generating the table itself
+      table = border(length)
+
+      (0...number_of_rows).each do |row_index|
+        table << '|'
+
+        if @options[:footer] && row_index == number_of_rows - 1 then table << border(length) end
+
+        if @options[:header] && row_index == 0 then
+          (0...number_of_columns).each do |column_index|
+            val = self[column_index, row_index]
+            table <<  val.capitalize.center(length[column_index]) << '|'
+          end
+
+          table << "\n" + border(length)
+        else
+          (0...number_of_columns).each do |column_index|
+            val = self[column_index, row_index] || EMPTY
+            table <<  val.send(alignment, length[column_index]) << '|'
+          end
+          table << "\n"
+        end
+      end
+
+      table << border(length)
+    end
+
+    def border(length)
+      border = '+'
+      length.each { |length| border << ('-' * length) << '+' }
+      border << "\n"
+    end
+  end
+
+end

data/tablizer.gemspec

@@ -0,0 +1,44 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'tablizer'
+  s.version           = '1.0.2'
+  s.date              = '2012-01-22'
+  s.rubyforge_project = 'tablizer'
+
+  s.summary     = "Table object generator for ruby."
+  s.description = "Table object generator for ruby."
+
+  s.authors  = ["Nicolas Oga"]
+  s.email    = '2112.oga@gmail.com'
+  s.homepage = 'http://nicooga.github.com/Tablizer'
+
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  # = MANIFEST =
+  s.files = %w[
+    LICENSE
+    README.md
+    Rakefile
+    lib/tablizer.rb
+    lib/tablizer/ansi_string.rb
+    lib/tablizer/conditional.rb
+    lib/tablizer/table.rb
+    tablizer.gemspec
+    test/test_tablizer.rb
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/test/test_tablizer.rb

@@ -0,0 +1,107 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'tablizer/table'
+
+class TestTablizer < MiniTest::Unit::TestCase
+  def data
+    [
+      ['animal'       , 'familia'   , 'cantidad de patas' , 'pelaje'               ],
+      ['ornitorrinco' , 'mamiferos' , '4'                 , 'mediano y marron'     , "caca"] ,
+      ['pato'         , 'aves'      , '2'                 , 'plumas blancas'       ],
+      ['gato'         , 'mamiferos' , '4'                 , 'gris y corto'         ],
+      ['marmota'      , 'mamiferos' , '4'                 , 'color natural y corto']
+    ]
+  end
+
+  def setup
+    @table = Tablizer::Table.new
+  end
+
+  def test_has_zero_columns_with_no_data
+    assert_equal @table.columns, 0
+  end
+
+  def test_outputs_an_empty_string_if_no_data
+    assert_equal @table.to_s, ""
+  end
+
+  def test_knows_its_size
+    @table.set_content(data)
+    assert_equal @table.size, 25
+  end
+
+  def test_each_works
+    @table.set_content([
+      ["1","2"],
+      ["3","4","5"],
+      ["6"]
+    ])
+    assert_equal @table.each.to_a, ["1", "2", "", "3", "4", "5", "6", "", ""]
+  end
+
+  def test_it_works
+    @table.set_content(data)
+    @table.options[:header] = false
+
+    output = (<<-OUTPUT).gsub(/^\s+/, "")
+      +------------+---------+-----------------+---------------------+----+
+      |animal      |familia  |cantidad de patas|pelaje               |    |
+      |ornitorrinco|mamiferos|4                |mediano y marron     |caca|
+      |pato        |aves     |2                |plumas blancas       |    |
+      |gato        |mamiferos|4                |gris y corto         |    |
+      |marmota     |mamiferos|4                |color natural y corto|    |
+      +------------+---------+-----------------+---------------------+----+
+    OUTPUT
+
+    assert_equal @table.to_s, output
+  end
+
+  def test_it_can_set_a_single_element
+    @table.set_content(data)
+    @table.options[:header] = true
+    @table.options[:align] = 'ansi_rjust'
+
+    @table[3,2] = 'trololo'
+
+    output = (<<-OUTPUT).gsub(/^\s+/, "")
+      +------------+---------+-----------------+---------------------+----+
+      |   Animal   | Familia |Cantidad de patas|       Pelaje        |    |
+      +------------+---------+-----------------+---------------------+----+
+      |ornitorrinco|mamiferos|                4|     mediano y marron|caca|
+      |        pato|     aves|                2|              trololo|    |
+      |        gato|mamiferos|                4|         gris y corto|    |
+      |     marmota|mamiferos|                4|color natural y corto|    |
+      +------------+---------+-----------------+---------------------+----+
+    OUTPUT
+
+    assert_equal @table.to_s, output
+  end
+
+  # def test_works_with_ansi_strings
+  #   @table.set_content(data)
+  #   @table.options[:header] = false
+
+  #   @table[0, 0] = @table[0, 1].color(:red)
+  #   @table[1, 1] = @table[1, 1].color(:green)
+  #   @table[2, 2] = @table[2, 2].color(:blue)
+
+  #   puts @table.to_s_with_margins
+  # end
+
+  def test_can_be_filled_gradually
+    @table[0, 0] = "hola"
+    @table[1, 1] = "manola"
+    @table[2, 2] = "que tul"
+
+    output = (<<-OUTPUT).gsub(/^\s+/, "")
+      +----+------+-------+
+      |hola|      |       |
+      |    |manola|       |
+      |    |      |que tul|
+      +----+------+-------+
+    OUTPUT
+
+    assert_equal @table.to_s, output
+  end
+
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: tablizer
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Nicolas Oga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-22 00:00:00.000000000 Z
+dependencies: []
+description: Table object generator for ruby.
+email: 2112.oga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/tablizer.rb
+- lib/tablizer/ansi_string.rb
+- lib/tablizer/conditional.rb
+- lib/tablizer/table.rb
+- tablizer.gemspec
+- test/test_tablizer.rb
+homepage: http://nicooga.github.com/Tablizer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: tablizer
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 2
+summary: Table object generator for ruby.
+test_files:
+- test/test_tablizer.rb