shellout 0.1

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gemspec
+

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :cli => "--color" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -0,0 +1,39 @@
+Shellout
+========
+
+Usage
+-----
+
+### Shadowboxes
+
+
+    require 'shellout/shadowbox'
+    
+    Shellout::Shadowbox.new("Hello world").print
+    
+    # ┌──────────────────────────────────────────┐ 
+	# │               Hello world                │▒
+	# └──────────────────────────────────────────┘▒
+	#   ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
+
+
+### Tables
+
+    require 'shellout/table'
+    
+    Shellout::Table.new(headers: %w{Team Points},
+	                    rows: [['Man City', 22],
+	                           ['Man Utd', 20],
+	                           ['Chelsea', 19],
+	                           ['Newcastle', 16]]
+	).print
+	
+	# ┌───────────┬────────┐
+	# │   Team    │ Points │
+	# ├───────────┼────────┤
+	# │ Man City  │     22 │
+	# │ Man Utd   │     20 │
+	# │ Chelsea   │     19 │
+	# │ Newcastle │     16 │
+	# └───────────┴────────┘
+

data/Rakefile

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

data/lib/shellout.rb

@@ -0,0 +1,21 @@
+
+# Unicode box drawing characters and block elements
+#
+# http://en.wikipedia.org/wiki/Box-drawing_characters
+#
+#        0 1 2 3 4 5 6 7 8 9 A B C D E F
+# U+250x ─ ━ │ ┃ ┄ ┅ ┆ ┇ ┈ ┉ ┊ ┋ ┌ ┍ ┎ ┏
+# U+251x ┐ ┑ ┒ ┓ └ ┕ ┖ ┗ ┘ ┙ ┚ ┛ ├ ┝ ┞ ┟
+# U+252x ┠ ┡ ┢ ┣ ┤ ┥ ┦ ┧ ┨ ┩ ┪ ┫ ┬ ┭ ┮ ┯
+# U+253x ┰ ┱ ┲ ┳ ┴ ┵ ┶ ┷ ┸ ┹ ┺ ┻ ┼ ┽ ┾ ┿
+# U+254x ╀ ╁ ╂ ╃ ╄ ╅ ╆ ╇ ╈ ╉ ╊ ╋ ╌ ╍ ╎ ╏
+# U+255x ═ ║ ╒ ╓ ╔ ╕ ╖ ╗ ╘ ╙ ╚ ╛ ╜ ╝ ╞ ╟
+# U+256x ╠ ╡ ╢ ╣ ╤ ╥ ╦ ╧ ╨ ╩ ╪ ╫ ╬ ╭ ╮ ╯
+# U+257x ╰ ╱ ╲ ╳ ╴ ╵ ╶ ╷ ╸ ╹ ╺ ╻ ╼ ╽ ╾ ╿
+#
+#        0 1 2 3 4 5 6 7 8 9 A B C D E F
+# U+258x ▀ ▁ ▂ ▃ ▄ ▅ ▆ ▇ █ ▉ ▊ ▋ ▌ ▍ ▎ ▏
+# U+259x ▐ ░ ▒ ▓ ▔ ▕ ▖ ▗ ▘ ▙ ▚ ▛ ▜ ▝ ▞ ▟
+
+module Shellout
+end

data/lib/shellout/shadowbox.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module Shellout
+  class Shadowbox
+    
+    MIN_WIDTH = 40
+    
+    def initialize(title)
+      @title = title
+    end
+    
+    def print(out=$stdout)
+      length = [@title.length, MIN_WIDTH].max + 2 
+      out.print "" <<
+      '┌'  << '─' * length             <<  "┐ \n" <<
+      '│ ' << @title.center(MIN_WIDTH) << " │▒\n" <<
+      '└'  << '─' * length             <<  "┘▒\n" <<
+      '  ' << '▒' * length             <<   "▒\n"
+    end
+    
+  end
+end

data/lib/shellout/table.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+module Shellout
+  class Table
+
+    def initialize(table={})
+      @data = []
+      @data << table[:headers] if table.has_key? :headers
+      @data += table[:rows]    if table.has_key? :rows
+      @data << table[:footers] if table.has_key? :footers
+      
+      @has_headers = table.has_key? :headers
+      @has_footers = table.has_key? :footers
+    end
+
+    def print(out=$stdout)
+      return if @data.empty?
+      
+      separators = widths.map {|w| '─'*(w+2)}
+      format = build_format
+      
+      out.print '┌' << separators.join('┬') << "┐\n"
+      @data.each_with_index do |r, i|
+        if @has_headers and i == 0
+          out.print '│ ' << center(r).join(' │ ') << " │\n"
+          out.print '├' << separators.join('┼') << "┤\n"
+        elsif @has_footers and i == @data.size-1
+          out.print '├' << separators.join('┼') << "┤\n"
+          out.printf(format, *r)          
+        else
+          out.printf(format, *r)          
+        end
+      end
+      out.print '└' << separators.join('┴') << "┘\n"
+    end
+    
+    private
+
+    def center(row)
+      row.zip(widths).map {|s,l| s.center(l)}      
+    end
+    
+    def widths
+      @widths ||= @data.transpose.map {|c| c.map(&:to_s).map(&:size).max }
+    end
+    
+    def build_format
+      data = @data.clone
+      data.shift if @has_headers
+      
+      numeric_columns = data.transpose.map do |col|
+        col.reduce(true) do |is_numeric, c|
+          is_numeric &&= c.is_a?(Numeric) || c.match(/\d+[:.,]?\d*$/)
+        end
+      end
+      
+      format = widths.reduce('│') do |f, l|
+        justify = numeric_columns.shift ? '' : '-'
+        f + " %#{justify}#{l}s │"
+      end + "\n"
+    end
+  end
+end

data/shellout.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name        = "shellout"
+  s.version     = "0.1"
+  s.authors     = ["Kjell-Magne Øierud"]
+  s.email       = ["kjellm@acm.org"]
+  s.homepage    = "https://github.com/kjellm/shellout"
+  s.summary     = %q{Tools for writing terminal interfaces}
+  s.description = %q{Contains classes for printing tables and boxes}
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-rspec"
+
+  if RUBY_PLATFORM.downcase.include?("darwin")
+    s.add_development_dependency 'rb-fsevent'
+    s.add_development_dependency 'growl_notify'
+  end
+end

data/spec/shellout/shadowbox_spec.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'stringio'
+require 'shellout/shadowbox'
+
+describe Shellout::Shadowbox do
+
+  before(:each) do
+    @out = StringIO.new
+  end
+  
+  describe 'when title is empty' do
+    it 'should print an empty box' do
+      @box = Shellout::Shadowbox.new('')
+      x = <<EOB
+┌──────────────────────────────────────────┐ 
+│                                          │▒
+└──────────────────────────────────────────┘▒
+  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
+EOB
+      @box.print(@out)
+      @out.string.should == x
+    end
+  end
+  
+  describe 'when a short title is given' do
+    it 'should print a padded box with centered title' do
+      @box = Shellout::Shadowbox.new('short')
+      x = <<EOB
+┌──────────────────────────────────────────┐ 
+│                  short                   │▒
+└──────────────────────────────────────────┘▒
+  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
+EOB
+      @box.print(@out)
+      @out.string.should == x
+    end
+  end
+  
+  describe 'when a long title is given' do
+    it 'should print a box that is big enough' do
+      @box = Shellout::Shadowbox.new('a very extremely humongously large meaningless title')
+      x = <<EOB
+┌──────────────────────────────────────────────────────┐ 
+│ a very extremely humongously large meaningless title │▒
+└──────────────────────────────────────────────────────┘▒
+  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
+EOB
+      @box.print(@out)
+      @out.string.should == x
+    end
+  end
+end

data/spec/shellout/table_spec.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+
+require 'stringio'
+require 'shellout/table'
+
+describe Shellout::Table do
+
+  before(:each) do
+    @out = StringIO.new
+  end
+  
+  describe 'when no parameters' do
+    it 'should not print anything' do
+      Shellout::Table.new.print(@out)
+      @out.string.should == ''
+    end
+  end
+
+  describe 'table with only a single data row' do
+    it 'should print a single row table' do
+      Shellout::Table.new(rows: [%w{a b c}]).print(@out)
+      @out.string.should == <<'EOT'
+┌───┬───┬───┐
+│ a │ b │ c │
+└───┴───┴───┘
+EOT
+    end
+  end
+  
+  describe 'when only given headers' do 
+    it 'should print headers and one empty row' do
+      Shellout::Table.new(headers: %w{a b c}).print(@out)
+      @out.string.should == <<'EOT'
+┌───┬───┬───┐
+│ a │ b │ c │
+├───┼───┼───┤
+└───┴───┴───┘
+EOT
+    end
+  end
+
+  describe 'when all parameters are defined' do 
+    it 'should print a nice table' do
+      Shellout::Table.new(headers: %w{a b c}, rows: [%w{d e f}, %w{g h i}], footers: %w{j k l}).print(@out)
+      @out.string.should == <<'EOT'
+┌───┬───┬───┐
+│ a │ b │ c │
+├───┼───┼───┤
+│ d │ e │ f │
+│ g │ h │ i │
+├───┼───┼───┤
+│ j │ k │ l │
+└───┴───┴───┘
+EOT
+    end
+  end
+  
+  it 'should center headers' do
+    Shellout::Table.new(headers: %w{a b c}, rows: [%w{123 456 789}]).print(@out)
+    @out.string.each_line.to_a[1].should == "│  a  │  b  │  c  │\n"
+  end
+  
+  it 'should_right_justify_numbers' do
+    Shellout::Table.new(headers: %w{aaaa bb ccc}, rows: [%w{123 4 56}]).print(@out)
+    @out.string.should == <<'EOT'
+┌──────┬────┬─────┐
+│ aaaa │ bb │ ccc │
+├──────┼────┼─────┤
+│  123 │  4 │  56 │
+└──────┴────┴─────┘
+EOT
+  end
+  
+  it 'should handle an example with some "real" data' do
+    Shellout::Table.new(
+      headers: %w{project code hours price},
+      rows:    [%w{nice_project_1 a 7:30 100.00}, %w{nice_project_2 b 7:30 87.50}],
+      footers: %w{Sum - 15:00 187.50},
+    ).print(@out)
+    @out.string.should == <<'EOT'
+┌────────────────┬──────┬───────┬────────┐
+│    project     │ code │ hours │ price  │
+├────────────────┼──────┼───────┼────────┤
+│ nice_project_1 │ a    │  7:30 │ 100.00 │
+│ nice_project_2 │ b    │  7:30 │  87.50 │
+├────────────────┼──────┼───────┼────────┤
+│ Sum            │ -    │ 15:00 │ 187.50 │
+└────────────────┴──────┴───────┴────────┘
+EOT
+  end
+end    

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: shellout
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Kjell-Magne Øierud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70243003183560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70243003183560
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70243003182740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70243003182740
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70243003181780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70243003181780
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &70243003180360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70243003180360
+- !ruby/object:Gem::Dependency
+  name: growl_notify
+  requirement: &70243003179120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70243003179120
+description: Contains classes for printing tables and boxes
+email:
+- kjellm@acm.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/shellout.rb
+- lib/shellout/shadowbox.rb
+- lib/shellout/table.rb
+- shellout.gemspec
+- spec/shellout/shadowbox_spec.rb
+- spec/shellout/table_spec.rb
+homepage: https://github.com/kjellm/shellout
+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: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Tools for writing terminal interfaces
+test_files:
+- spec/shellout/shadowbox_spec.rb
+- spec/shellout/table_spec.rb