yummi 0.2.1 → 0.2.2

data/examples/{table_cash_flow.rb → cash_flow_table.rb}

@@ -75,13 +75,16 @@ opt.on '--color TYPE', 'Specify the color type (zebra,full,none)' do |type|
 end
 opt.on '--layout LAYOUT', 'Defines the table layout (horizontal or vertical)' do |layout|
   case layout
-    when 'horizonta'
+    when 'horizontal'
       @table.layout = :horizontal
     when 'vertical'
       @table.layout = :vertical
     else
   end
 end
+opt.on '--box', 'Prints the table inside a box' do
+  @box = Yummi::TextBox::new
+end
 opt.on '--help', 'Prints this message' do
   puts opt
   exit 0
@@ -89,4 +92,9 @@ end
 
 opt.parse ARGV
 
-@table.print
+if @box
+  @box << @table
+  @box.print
+else
+  @table.print
+end

data/examples/license_box.rb

@@ -0,0 +1,57 @@
+#                         The MIT License
+#
+# Copyright (c) 2012 Marcelo Guimarães <ataxexe@gmail.com>
+#
+# 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.
+
+require 'optparse'
+require_relative '../lib/yummi'
+
+@box = Yummi::TextBox.new
+
+@box.width = 70
+@box.default_align = :justify
+@box.default_separator[:color] = :brown
+
+opt = OptionParser::new
+
+opt.on '--align ALIGN', 'Sets the default alignment to use' do |align|
+  @box.default_align = align.to_sym
+end
+opt.on '--width WIDTH', Integer, 'Sets the text box width' do |width|
+  @box.width = width
+end
+opt.on '--help', 'Prints this message' do
+  puts opt
+  exit 0
+end
+
+opt.parse! ARGV
+
+@box.add 'The MIT License', :color => :yellow, :align => :center
+@box.line_break
+@box.add 'Copyright (c) 2012 Marcelo Guimaraes <ataxexe@gmail.com>', :color => :green, :align => :center
+@box.separator
+@box.add '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:'
+@box.line_break
+@box.add 'The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.'
+@box.separator :width => @box.width / 3, :align => :center
+@box.add '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.',
+         :color => :red
+@box.print

data/examples/monitor_table.rb

@@ -74,6 +74,9 @@ opt.on '--layout LAYOUT', 'Defines the table layout (horizontal or vertical)' do
     else
   end
 end
+opt.on '--box', 'Prints the table inside a box' do
+  @box = Yummi::TextBox::new
+end
 opt.on '--help', 'Prints this message' do
   puts opt
   exit 0
@@ -93,4 +96,9 @@ opt.parse ARGV
   ['Server 6', 1_000_000, 5_000, 200, 180],
 ]
 
-@table.print
+if @box
+  @box << @table
+  @box.print
+else
+  @table.print
+end

data/lib/yummi.rb

@@ -178,6 +178,7 @@ module Yummi
 
     # Aligns the text to the center
     def self.center text, width
+      return text if text.size >= width
       size = width - text.size
       left_size = size / 2
       right_size = size - left_size
@@ -187,8 +188,9 @@ module Yummi
     # Aligns the text to both sides
     def self.justify text, width
       extra_spaces = width - text.size
-      return text if extra_spaces < 0
+      return text unless extra_spaces > 0
       words = text.split ' '
+      return text if words.size == 1
       return text if extra_spaces / (words.size - 1) > 2
       until extra_spaces == 0
         words.each_index do |i|

data/lib/yummi/text_box.rb

@@ -28,18 +28,20 @@ module Yummi
     attr_accessor :color
     # The box content
     attr_accessor :content
-    # The box maximum width
-    attr_accessor :max_width
+    # The box width (leave it null to manually manage the width)
+    attr_accessor :width
     # The default alignment to use
     attr_accessor :default_align
+    # The default separator parameters to use. Use the :pattern: key to set the pattern
+    # and the keys supported in #self#separator
+    attr_accessor :default_separator
 
-    def initialize params = {}
-      params = {
-        :color => :white,
-        :content => ''
-      }.merge! params
-      @color = params[:color]
+    def initialize
+      @color = :white
       @content = []
+      @default_separator = {
+        :pattern => '-'
+      }
     end
 
     #
@@ -53,10 +55,12 @@ module Yummi
     #   A hash of parameters. Currently supported are:
     #     color: the text color (see #Yummi#COLORS)
     #     width: the text maximum width. Set this to break the lines automatically.
+    #            If the #width is set, this will override the box width for this lines.
+    #     align: the text alignment (see #Yummi#Aligner)
     #
     def add text, params = {}
       params = {
-        :width => @max_width,
+        :width => @width,
         :align => @default_align
       }.merge! params
       if params[:width]
@@ -65,7 +69,7 @@ module Yummi
         buff = ''
         words.each do |word|
           # go to next line if the current word blows up the width limit
-          if buff.size + word.size >= width
+          if buff.size + word.size >= width and not buff.empty?
             _add_ buff, params
             buff = ''
           end
@@ -82,16 +86,47 @@ module Yummi
       end
     end
 
-    alias_method :<<, :add
+    # Adds the given object as it
+    def << object
+      text = object.to_s
+      text.each_line do |line|
+        add line
+      end
+    end
+
+    #
+    # Adds a line separator.
+    #
+    # === Args
+    #
+    # +pattern+::
+    #   The pattern to build the line
+    # +params+::
+    #   A hash of parameters. Currently supported are:
+    #     color: the separator color (see #Yummi#COLORS)
+    #     width: the separator width (#self#width will be used if unset)
+    #     align: the separator alignment (see #Yummi#Aligner)
+    #
+    def separator pattern = @default_separator[:pattern], params = {}
+      unless pattern.is_a? String
+        params = pattern
+        pattern = @default_separator[:pattern]
+      end
+      params = @default_separator.merge params
+      width = (params[:width] or @width)
+      if @width and width < @width
+        params[:width] = @width
+      end
+      line = pattern * width
+      add line[0...width], params
+    end
 
     # Adds a line break to the text.
     def line_break
       @content << $/
     end
 
-    #
     # Prints the #to_s into the given object.
-    #
     def print to = $stdout
       to.print to_s
     end

data/lib/yummi/version.rb

@@ -21,5 +21,5 @@
 # THE SOFTWARE.
 
 module Yummi
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yummi
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-14 00:00:00.000000000Z
+date: 2012-05-16 00:00:00.000000000Z
 dependencies: []
 description: A tool to colorize your console application.
 email:
@@ -24,11 +24,11 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- examples/box_license.rb
+- examples/cash_flow_table.rb
+- examples/license_box.rb
 - examples/list_files.rb
 - examples/logger.rb
 - examples/monitor_table.rb
-- examples/table_cash_flow.rb
 - lib/yummi.rb
 - lib/yummi/logger.rb
 - lib/yummi/no_colors.rb

data/examples/box_license.rb

@@ -1,40 +0,0 @@
-#                         The MIT License
-#
-# Copyright (c) 2012 Marcelo Guimarães <ataxexe@gmail.com>
-#
-# 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.
-
-require_relative '../lib/yummi'
-
-box = Yummi::TextBox.new
-
-box.max_width = 70
-box.default_align = :justify
-
-box.add 'The MIT License', :color => :yellow, :align => :center
-box.line_break
-box.add 'Copyright (c) 2012 Marcelo Guimaraes <ataxexe@gmail.com>', :color => :green, :align => :center
-box.line_break
-box.add '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:'
-box.line_break
-box.add 'The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.'
-box.line_break
-box.add '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.',
-         :color => :red
-box.print