yummi 0.1.0 → 0.2.0

data/examples/box_license.rb

@@ -0,0 +1,40 @@
+#                         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

data/examples/list_files.rb

@@ -32,14 +32,14 @@ opt = OptionParser::new
 @table.header = ['Name', 'Size']
 @table.aliases << :directory
 # sets the title
-@table.title = 'Files in home folder'
+@table.title = 'File List'
 # formats size for easily reading
 @table.format :size, :using => Yummi::Formatter.unit(:byte)
 
 opt.on '--color TYPE', 'Specify the color type (zebra,file,none)' do |type|
   case type
     when 'zebra'
-      @table.row_colorizer Yummi::IndexedDataColorizer.zebra :intense_gray, :intense_white
+      @table.row_colorizer Yummi::Colorizer.stripe :intense_gray, :intense_white
     when 'file'
       @table.row_colorizer do |i, data|
         data[:directory] ? :intense_gray : :intense_white

data/examples/monitor_table.rb

@@ -51,7 +51,7 @@ thread_colorizer.use(:intense_cyan) { |value| value >= 0.9 }
 opt.on '--color TYPE', 'Specify the color type (zebra,row,cell,none)' do |type|
   case type
     when 'zebra'
-      @table.row_colorizer Yummi::Colorizer.by_index.zebra :brown, :purple
+      @table.row_colorizer Yummi::Colorizer.stripe :brown, :purple
     when 'row'
       @table.row_colorizer memory_colorizer
       @table.row_colorizer thread_colorizer
@@ -65,14 +65,13 @@ opt.on '--color TYPE', 'Specify the color type (zebra,row,cell,none)' do |type|
     else
   end
 end
-opt.on '--layout LAYOUT', 'Specify the layout (horizontal or vertical)' do |layout|
+opt.on '--layout LAYOUT', 'Defines the table layout (horizontal or vertical)' do |layout|
   case layout
-    when 'horizontal'
+    when 'horizonta'
       @table.layout = :horizontal
     when 'vertical'
       @table.layout = :vertical
     else
-      abort "Not recognized layout: #{layout}"
   end
 end
 opt.on '--help', 'Prints this message' do

data/examples/table_cash_flow.rb

@@ -47,7 +47,7 @@ opt = OptionParser::new
 opt.on '--color TYPE', 'Specify the color type (zebra,full,none)' do |type|
   case type
     when 'zebra'
-      @table.row_colorizer Yummi::Colorizer.by_index.zebra :brown, :purple
+      @table.row_colorizer Yummi::Colorizer.stripe :brown, :purple
     when 'full'
       # colorize all values from the Description column to purple
       @table.colorize :description, :with => :purple
@@ -73,6 +73,15 @@ opt.on '--color TYPE', 'Specify the color type (zebra,full,none)' do |type|
     else
   end
 end
+opt.on '--layout LAYOUT', 'Defines the table layout (horizontal or vertical)' do |layout|
+  case layout
+    when 'horizonta'
+      @table.layout = :horizontal
+    when 'vertical'
+      @table.layout = :vertical
+    else
+  end
+end
 opt.on '--help', 'Prints this message' do
   puts opt
   exit 0

data/lib/yummi.rb

@@ -22,6 +22,7 @@
 
 require_relative "yummi/version"
 require_relative "yummi/table"
+require_relative "yummi/text_box"
 require_relative "yummi/logger"
 
 module Yummi
@@ -29,8 +30,6 @@ module Yummi
   module Color
     # Colors from default linux terminal scheme
     COLORS = {
-      :nothing => '0;0',
-
       :black => '0;30',
       :red => '0;31',
       :green => '0;32',
@@ -97,16 +96,22 @@ module Yummi
     # Escape the given text with the given color code
     def self.escape key
       return key unless key
-      color = COLORS[key]
+      color = (COLORS[key] or key)
       color ||= parse(key)
       "\033[#{color}m"
     end
 
     # Colorize the given text with the given color
     def self.colorize string, color
-      col, nocol = [color, :nothing].map { |key| Color.escape(key) }
-      col ? "#{col}#{string}#{nocol}" : string
+      color, end_color = [color, '0;0'].map { |key| Color.escape(key) }
+      color ? "#{color}#{string}#{end_color}" : string
+    end
+
+    # Extracts the text from a colorized string
+    def self.raw string
+      string.gsub(/\033\[\d;\d{2}m/, '').gsub(/\033\[0;0m/, '')
     end
+
   end
 
   # see #Color#colorize
@@ -145,6 +150,22 @@ module Yummi
   # A module to align texts based on a reference width
   module Aligner
 
+    #
+    # Aligns the text
+    #
+    # === Args
+    #
+    # +to+::
+    #   Defines the type of the alignment (must be a method defined in this module)
+    # +text+::
+    #   The text to align
+    # +width+::
+    #   The width of alignment, this will define how much the text will be moved.
+    #
+    def self.align to, text, width
+      send to, text, width
+    end
+
     # Aligns the text to the right
     def self.right text, width
       text.rjust(width)
@@ -155,6 +176,31 @@ module Yummi
       text.ljust(width)
     end
 
+    # Aligns the text to the center
+    def self.center text, width
+      size = width - text.size
+      left_size = size / 2
+      right_size = size - left_size
+      (' ' * left_size) << text << (' ' * right_size)
+    end
+
+    # Aligns the text to both sides
+    def self.justify text, width
+      extra_spaces = width - text.size
+      return text if extra_spaces == 0
+      words = text.split ' '
+      return text if extra_spaces / (words.size - 1) > 2
+      until extra_spaces == 0
+        words.each_index do |i|
+          break if i - 1 == words.size # do not add spaces in the last word
+          words[i] << ' '
+          extra_spaces -= 1
+          break if extra_spaces == 0
+        end
+      end
+      words.join ' '
+    end
+
   end
 
   # A module with useful colorizers
@@ -177,9 +223,25 @@ module Yummi
       EvalColorizer::new &block
     end
 
-    # Returns the #IndexedDataColorizer module
-    def self.by_index
-      IndexedDataColorizer
+    # Returns a new instance of #StripeColorizer
+    def self.stripe *colors
+      StripeColorizer::new *colors
+    end
+
+    # A colorizer that cycles through colors to create a striped effect
+    class StripeColorizer
+
+      # Creates a new colorizer using the given colors
+      def initialize *colors
+        @colors = colors
+        @count = -1
+      end
+
+      def call *args
+        @count += 1
+        @colors[@count % @colors.size]
+      end
+
     end
 
     #
@@ -256,31 +318,6 @@ module Yummi
 
     end
 
-    # A module with colorizers that uses indexes
-    module IndexedDataColorizer
-
-      # Returns a colorizer that uses the given color in odd indexes
-      def self.odd color
-        lambda do |index, data|
-          color if index.odd?
-        end
-      end
-
-      # Returns a colorizer that uses the given color in even indexes
-      def self.even color
-        lambda do |index, data|
-          color if index.even?
-        end
-      end
-
-      # Returns a colorizer that uses the first color for odd indexes and the second for
-      # even indexes.
-      def self.zebra first_color, second_color
-        Yummi::Colorizer.join odd(first_color), even(second_color)
-      end
-
-    end
-
   end
 
   # A module with useful formatters

data/lib/yummi/table.rb

@@ -266,9 +266,9 @@ module Yummi
         row.each_index do |j|
           column = row[j]
           width = max_width data, j
-          align = (@align[j] or @default_align)
+          alignment = (@align[j] or @default_align)
           color = color_map[i][j]
-          value = Aligner.send align, column.to_s, width
+          value = Aligner.align alignment, column.to_s, width
           value = Color.colorize value, color unless @no_colors
           string << value
           string << (' ' * @colspan)

data/lib/yummi/text_box.rb

@@ -0,0 +1,132 @@
+#                         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.
+
+module Yummi
+
+  # A box to decorate texts
+  class TextBox
+    # The border color
+    attr_accessor :color
+    # The box content
+    attr_accessor :content
+    # The box maximum width
+    attr_accessor :max_width
+    # The default alignment to use
+    attr_accessor :default_align
+
+    def initialize params = {}
+      params = {
+        :color => :white,
+        :content => ''
+      }.merge! params
+      @color = params[:color]
+      @content = params[:content].to_s
+    end
+
+    #
+    # Adds a line text to this box
+    #
+    # === Args
+    #
+    # +line_text+::
+    #   The text to add.
+    # +params+::
+    #   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.
+    #
+    def add text, params = {}
+      params = {
+        :width => @max_width + 1,
+        :align => @default_align
+      }.merge! params
+      if params[:width]
+        width = params[:width]
+        words = text.gsub($/, ' ').split(' ')
+        buff = ''
+        words.each do |word|
+          if buff.size + word.size > width
+            _add_ buff, params
+            buff = ''
+          end
+          buff << ' ' unless buff.empty?
+          buff << word
+        end
+        unless buff.empty?
+          _add_ buff, params
+        end
+      else
+        text.each_line do |line|
+          _add_ line, params
+        end
+      end
+    end
+
+    alias_method :<<, :add
+
+    # 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
+
+    def to_s
+      width = 0
+      sizes = []
+      content.each_line do |line|
+        size = (Yummi::Color::raw line.chomp).size
+        sizes << size
+        width = [width, size].max
+      end
+      border = Yummi.colorize('+' + ('-' * width) + '+', color) + $/
+      pipe = Yummi.colorize '|', color
+      buff = ''
+      buff << border
+      i = 0
+      content.each_line do |line|
+        diff = width - sizes[i]
+        buff << pipe << line.chomp << (' ' * diff) << pipe << $/
+        i += 1
+      end
+      buff << border
+      buff
+    end
+
+    private
+
+    def _add_ text, params
+      if params[:align] and params[:width]
+        text = Yummi::Aligner.align params[:align], text, params[:width]
+      end
+      @content << Yummi.colorize(text, params[:color])
+      line_break
+    end
+
+  end
+
+end

data/lib/yummi/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yummi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-30 00:00:00.000000000Z
+date: 2012-05-14 00:00:00.000000000Z
 dependencies: []
 description: A tool to colorize your console application.
 email:
@@ -24,6 +24,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/box_license.rb
 - examples/list_files.rb
 - examples/logger.rb
 - examples/monitor_table.rb
@@ -32,6 +33,7 @@ files:
 - lib/yummi/logger.rb
 - lib/yummi/no_colors.rb
 - lib/yummi/table.rb
+- lib/yummi/text_box.rb
 - lib/yummi/version.rb
 - yummi.gemspec
 homepage: https://github.com/ataxexe/yummi