textify 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Joseph Weissman
+
+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

@@ -0,0 +1,33 @@
+= Textify
+
+Some basic, non-curses-based functions to aid user 
+interaction in text-only ruby scripts. Included are 
+functions for
+
+  * Justifying strings
+  * List selection, confirmation, data entry
+  * Displaying arrays and hashes as tables
+  
+== Usage
+  require "textify"
+  class MyClass
+    textify
+    def foo
+      [[1,2,3],[4,5,6],[7,8,9]].table({:headings => %w[ one two three ]})
+    end
+  end
+
+  o = MyClass.new
+  o.foo 
+  
+  
+  The snippet above outputs:
+  
+  
+  ****************************************
+  *     one    *     two    *    three   *
+  ****************************************
+  *      1     *      2     *      3     *
+  *      4     *      5     *      6     *
+  *      7     *      8     *      9     *
+  ****************************************

data/README.rdoc

@@ -0,0 +1,33 @@
+= Textify
+
+Some basic, non-curses-based functions to aid user 
+interaction in text-only ruby scripts. Included are 
+functions for
+
+  * Justifying strings
+  * List selection, confirmation, data entry
+  * Displaying arrays and hashes as tables
+  
+== Usage
+  require "textify"
+  class MyClass
+    textify
+    def foo
+      [[1,2,3],[4,5,6],[7,8,9]].table({:headings => %w[ one two three ]})
+    end
+  end
+
+  o = MyClass.new
+  o.foo 
+  
+  
+  The snippet above outputs:
+  
+  
+  ****************************************
+  *     one    *     two    *    three   *
+  ****************************************
+  *      1     *      2     *      3     *
+  *      4     *      5     *      6     *
+  *      7     *      8     *      9     *
+  ****************************************

data/lib/sample.rb

@@ -0,0 +1,21 @@
+require "textify"
+class MyClass
+   textify
+   def foo
+     # @val = ask "Enter a value: "
+     [[1,2,3],[4,5,6],[7,8,9]].table({:headings => %w[ one two three ]})
+   end
+end
+
+o = MyClass.new
+o.foo 
+
+=begin
+****************************************
+*     one    *     two    *    three   *
+****************************************
+*      1     *      2     *      3     *
+*      4     *      5     *      6     *
+*      7     *      8     *      9     *
+****************************************
+=end

data/lib/textify.rb

@@ -0,0 +1,348 @@
+module Textify
+=begin
+
+= Textify
+
+Some basic, non-curses-based functions to aid user 
+interaction in text-only ruby scripts. Included are 
+functions for
+
+  * Justifying strings
+  * List selection, confirmation, data entry
+  * Displaying arrays and hashes as tables
+  
+== Usage
+  require "textify"
+  class MyClass
+    textify
+    def foo
+      [[1,2,3],[4,5,6],[7,8,9]].table({:headings => %w[ one two three ]})
+    end
+  end
+
+  o = MyClass.new
+  o.foo 
+  
+  
+  The snippet above outputs:
+  
+  
+  ****************************************
+  *     one    *     two    *    three   *
+  ****************************************
+  *      1     *      2     *      3     *
+  *      4     *      5     *      6     *
+  *      7     *      8     *      9     *
+  ****************************************
+
+=end
+  
+  DefaultScreenWidth = 40
+  
+  # minor utility fns
+  def br n=1; puts until (n-=1)<0; end
+  def cls; br 50; end
+
+
+=begin
+
+  Textual.justify (direction, text, options={})
+  
+  Justifies text within the default screen width. Accepts in the options hash:
+  
+    :width                set a new default width for this justification
+    :character            fill with another characer (default is ' ')
+  
+=end
+    
+  def justify(direction, text, options={})
+    # puts "Entering justify..."
+    width = options[:width] || DefaultScreenWidth
+    if text.length >= width    
+      # puts "Returning, text '#{text}' (#{text.size}) too big for width #{width}."
+      return text 
+    end
+    
+    orig_text = text
+    char = options[:character] || ' '
+    
+    usable_space = width-text.length
+    offset = char*usable_space
+    left_offset = char * (usable_space.to_f/2).ceil
+    right_offset = char * (usable_space - left_offset.size)
+    
+    #half_offset = offset.slice(0..(offset.size/2).floor)
+    # puts "Usable space: #{usable_space}. Left: #{left_offset.size}. Right: #{right_offset.size}."
+    
+    text = case direction #.downcase.to_sym
+      when :left then "#{text}#{offset}"
+      when :right then "#{offset}#{text}"
+      when :center then "#{left_offset}#{text}#{right_offset}"
+      else text
+    end
+    
+    # puts "- Justifying (#{direction.to_s}) to width (#{width}): '#{orig_text}' => \t'#{text}'"
+    
+    text
+  end
+  
+  
+  def test_justify
+    title "  Testing justify command  "
+    text = justify :left,   "Left Justifed"
+    puts text
+    puts justify(:right,  "Right Justifed")
+    puts justify(:center, "Center Justifed")
+    puts                  "Unjustified"
+    true
+  end
+  
+  
+  
+  
+  
+  
+  
+  def title name, options={}
+    br options[:offset] || 2
+    print "#{justify :center, name, {:character => options[:character] || '='}}"
+    br options[:offset] || 2
+  end
+  
+  def test_title
+    title " Sample Title 1 "
+    title " Sample Title 2 ", {:character => '@', :offset => 3 }
+    title " Sample Title 3 ", {:character => "&", :offset => 2 }
+    true
+  end
+  
+
+
+  def display_selection items, prompt
+    title prompt # print "\n"*3
+    items.each_with_index { |item, n| puts " [#{n+1}] #{item.gsub('_',' ').capitalize} \n" }
+    print "\n   > "
+    @input = gets.to_i;
+  end
+  
+  def select(items, prompt="  Please select one of the following options:  ", options={})
+    #title prompt # print "\n"*3
+    #items.each_with_index { |item, n| puts " [#{n+1}] #{item.gsub('_',' ').capitalize} \n" }
+    #print "\n   > "
+    #input = gets.to_i; 
+    # display_selection; 
+    @input=0; display_selection(items, prompt) until (@input >= 1 and @input <= items.size)
+      #title prompt # print "\n"*3
+      #items.each_with_index { |item, n| puts " [#{n+1}] #{item.gsub('_',' ').capitalize} \n" }
+      #print "\n   > "      
+      #input = gets.to_i
+    #end
+    
+    puts "Selected #{@input} (#{items[@input-1]}).. " #{ }"#{options[input-1]}."
+    return items[@input-1]
+  end
+  
+  def test_select
+    title " Selection Test "
+    choices = %w[ apples strawberries bananas mandarin_oranges tangerines oranges cherries watermelons raspberries ]
+    option = select choices
+    title "Thanks for choosing #{option}!"
+    true
+  end
+  
+  
+  
+  
+  def confirm(prompt = "Please confirm. ", options = {})
+    choices = options[:choices] || %w[ Yes No]
+    input = select choices, prompt
+    return true if input == choices[0]
+    return false
+  end
+  
+  def test_confirm
+    puts "Must be nice..." if confirm "Are you human?"
+    true
+  end
+  
+  
+  
+  def ask(prompt="\n   >",options={})
+    prompt = prompt.to_s + "? " if prompt.class == Symbol
+    print prompt.capitalize
+    
+    if options[:validate]
+     input = gets.chomp
+     if options[:validate].downcase == 'numeric'
+     end
+    else 
+     return gets.chomp
+    end
+  end
+  
+  def test_ask
+    title " Test Input Gathering "
+    name = ask "What's your name? "
+    puts "Thanks for answering, #{name}!"
+    age = ask "How old are you? "
+    puts "Great! It must be nice to be #{age} years old."
+    true
+  end
+  
+
+  
+  
+  
+
+  def tabulate(data, options={}); data.table options if %w[ Hash Array ].include? data.class.name; end
+  
+  def test_table
+    title "  Testing tables  "
+    
+    tabulate({:one => "1", :two => "2", :three => "3", :four => "4", :five => "512351234123"}); br 2
+    tabulate([[1,2,3,4],[4,5,6,7],[7,8,9,0]], {:headings => %w[ alpha beta gamma delta ], :width => 100} ); br 3
+    tabulate([[1,2,3,4],[4,5,6,7],[7,8,9,0]], {:headings => %w[ alpha beta gamma delta ], :width => 50} ); br 3
+    
+    true
+  end
+  
+  
+  
+  
+  def unit_test
+    
+    title "  Textual Unit Test  "
+    
+    results = {}
+    
+    %w[ title ask select confirm justify table ].each { 
+      |operation| results[operation.to_sym] = send("test_"+operation)
+    }
+=begin
+    results << {:title,   test_title}
+    results << {:ask,     test_ask}
+    results << {:select,  test_select}
+    results << {:confirm, test_confirm}
+    results << {:justify, test_justify}
+    results << {:table,   test_table}
+=end
+    title "   Internal Unit Test Results   "
+    results.each_pair {|k,v| puts "         #{k} => #{v==true ? 'pass' : 'fail'}" }
+    
+    assertions = results.size
+    passed     = results.select { |k,v| v=true }.size
+    failed     = results.select { |k,v| v=false }.size
+    
+    title " #{assertions} assertions, #{failed} failed, #{passed} passed "
+    
+    return false if failed > 0
+    true
+  end
+end
+
+def textify; include Textify; end
+
+
+#################################
+# Extensions to Hash
+########
+
+class Hash
+  textify
+  # include Textual
+  def self_analyze
+    @minimal_element, @maximal_element = nil,nil
+    @min_elem_sz, @max_elem_sz = 0, 0
+    each_pair do |k,v|
+      [k,v].each do |element|
+        if element.to_s.size > @max_elem_sz
+          @maximal_element = element; @max_elem_sz = element.to_s.size
+        elsif element.to_s.size < @min_elem_sz
+          @minimal_element = element; @min_elem_sz = element.to_s.size
+        end
+      end
+    end
+    # puts "[Hash.self_analyze] Maximal element => '#{@maximal_element}' (#{@max_elem_sz}), minimal element => '#{@minimal_element}'"
+  end
+    
+  def table options={}
+    self_analyze
+    width = options[:width] || DefaultScreenWidth
+    min_column_width = @maximal_element.to_s.size + 2
+    column_width = [min_column_width, (width-3).to_f/2].max.to_i
+    width = column_width*2 + 3
+    hb = "*"*width+"\n"
+    result = hb    
+    each_pair{|k,v| result += "*#{justify :center, k.to_s, :width => (column_width)}*#{justify :center, v, :width=>(column_width)}*\n"}
+    result += hb
+    puts result
+  end
+end
+
+
+####################
+# Extensions to Array
+#####
+
+class Array
+  # include Textual
+  textify
+  
+  def self_analyze
+    @minimal_element, @maximal_element = nil,nil
+    @min_elem_sz, @max_elem_sz = 0, 0
+    each do |row|
+      if row.is_a? Array
+         row.each do |element|
+           if element.to_s.size > @max_elem_sz
+            @maximal_element = element; @max_elem_sz = element.to_s.size
+           elsif element.to_s.size < @min_elem_sz
+            @minimal_element = element; @min_elem_sz = element.to_s.size
+           end
+         end
+      end
+    end
+    # puts "[Array.self_analyze] Maximal element => '#{@maximal_element}' (#{@max_elem_sz}), minimal element => '#{@minimal_element}'"
+  end
+  
+  def table options = {}
+    width = options[:width] || DefaultScreenWidth
+    self_analyze
+    
+    columns = self[0].size
+    
+    min_column_width = @maximal_element.to_s.size + 2
+    column_width = [min_column_width, ((width.to_i-columns).to_f/columns)].max.to_i    
+    width = (column_width*columns) + columns + 1
+    
+    hb = ("*"*(width))+"\n"      
+    result = hb
+  
+    # puts "[Array.table] Columns = #{columns}. Total width = #{width}. Column width = #{column_width}."
+
+    if options[:headings] then
+      options[:headings].each{ |th| result += "*#{justify :center, th.to_s, :width => column_width}"}
+      result += "*\n"
+      result += hb              
+    end
+    each do |row|
+      row.each do |item|
+        result += "*#{justify :center, item.to_s, :width => column_width}"
+      end
+      result += "*\n"
+    end
+    result += hb
+    
+    puts result
+  end
+end
+
+
+#### sample interface unit test ##############
+
+
+if __FILE__ == $0
+  class SampleUI; textify; def test_textify; unit_test; end; end
+  sample_user_interface = SampleUI.new
+  sample_user_interface.test_textify
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'textify'
+
+class Test::Unit::TestCase
+end

data/test/test_textify.rb

@@ -0,0 +1,13 @@
+require 'helper'
+require 'textify'
+
+class TestTextify < Test::Unit::TestCase
+  should "pass internal unit test" do
+    class SampleUI; textify; def test_textify; unit_test; end; end
+    sample_user_interface = SampleUI.new
+    passed_unit_test = sample_user_interface.test_textify
+    
+    assert passed_unit_test
+    flunk "failed internal unit test!" if not passed_unit_test
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: textify
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Joseph Weissman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-08 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: A collection of simple, non-curses-based functions to assist building user interaction into text-only ruby scripts
+email: jweissman1986@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+- README.rdoc
+files: 
+- lib/sample.rb
+- lib/textify.rb
+- LICENSE
+- README
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/jweissman1986/Textify
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: non-curses text-based library to aid user interaction
+test_files: 
+- test/helper.rb
+- test/test_textify.rb