mutter 0.3.7 → 0.4.0

data/README.md

@@ -11,7 +11,7 @@ synopsis
 --------
     
     require 'mutter'
-    
+
     mut = Mutter.new                # creates a new 'Mutterer', who talks in command-line language
     mut.say "hello _world_"         # underlines 'world'
     mut.say "hello world",   :bold  # bolds the whole string
@@ -19,6 +19,34 @@ synopsis
     mut.print "bonjour!"            # alias of `say`
     mut["_hola_"]                   # return the stylized string without printing
 
+### Tables
+    
+    # Define your table structure, arguments are optional.
+    # Strings which don't fit the column width will be truncated
+    # with '..' by default, you can change that with the :truncater
+    # option.
+    table = Mutter::Table.new(:delimiter => '|') do
+      column :width => 15, :style => :green
+      column :style => :yellow
+      column :width => 15, :align => :right
+    end
+    
+    # Add some rows
+    table << ["gaspar", "morello", 1976]
+    table << ["eddie", "vedder", 1964]
+    table << ["david", "bowie", 1947]
+    
+    # Print
+    print table.to_s
+
+If you want something barebones, you can also do
+
+    t = Mutter::Table.new
+    t.rows = (1..10).map {|n| [n, n **2, n **3] }
+    t.print
+
+And it'll make sure everything is aligned nicely
+
 styles
 ------
 mutter supports these styles:

data/VERSION

@@ -1 +1 @@
-0.3.7
+0.4.0

data/lib/mutter.rb

@@ -8,6 +8,7 @@ $:.unshift File.dirname(__FILE__) + '/mutter'
 
 require 'mutterer'
 require 'indenter'
+require 'table'
 require 'ext'
 
 module Mutter
@@ -50,6 +51,10 @@ module Mutter
     new.stylize *args
   end
   
+  def self.process *args
+    new.process *args
+  end
+  
   def self.new *args
     Mutterer.new(*args)
   end

data/lib/mutter/mutterer.rb

@@ -9,7 +9,7 @@ module Mutter
     #
     def initialize obj = {}
       self.reset
-      @defaults = load File.dirname(__FILE__) + "/styles"
+      @defaults = load 'default'
 
       case obj
         when Hash       # A style definition: expand quick-styles and merge with @styles
@@ -44,12 +44,13 @@ module Mutter
 
     def clear opt = :all
       case opt
-        when :user    then @styles = {}
-        when :default then @defaults = {}
-        when :styles  then @styles, @defaults = {}, {}
-        when :active  then @active = []
-        when :all     then @active, @styles, @defaults = [], {}, {}
-        else          raise ArgumentError, "[:user, :default, :active, :all] only"
+        when :user     then @styles = {}
+        when :styles   then @styles, @defaults = {}, {}
+        when :active   then @active = []
+        when :all      then @active, @styles, @defaults = [], {}, {}
+        when :default, 
+             :defaults then @defaults = {}
+        else           raise ArgumentError, "[:user, :default, :active, :all] only"
       end
       self
     end
@@ -60,7 +61,8 @@ module Mutter
     #   and converts the keys to symbols
     #
     def load styles
-      styles += '.yml' unless styles =~ /\.ya?ml/
+      styles += '.yml' unless styles =~ /\.ya?ml$/
+      styles = File.join(File.dirname(__FILE__), "styles", styles) unless File.exist? styles
       YAML.load_file(styles).inject({}) do |h, (key, value)|
         value = { :match => value['match'], :style => value['style'] }
         h.merge key.to_sym => value
@@ -107,6 +109,13 @@ module Mutter
       end
     end
     alias :oo watch
+    
+    #
+    # Create a table
+    #
+    def table *args, &blk
+      Table.new(*args, &blk)
+    end
 
     #
     # Add and remove styles from the active styles

data/lib/mutter/styles/html.yml

@@ -0,0 +1,29 @@
+bold:
+  match: ['<b>','</b>']
+  style:
+    - bold
+    
+underline:
+  match: ['<u>','</u>']
+  style:
+    - underline
+  
+inverse:
+  match: ['<i>','</i>']
+  style:
+    - inverse
+
+error:
+  match: ['<err>','</err>']
+  style:
+    - red
+    
+warning:
+  match: ['<warn>','</warn>']
+  style:
+    - yellow
+
+ok:
+  match: ['<ok>','</ok>']
+  style:
+    - green

data/lib/mutter/table.rb

@@ -0,0 +1,78 @@
+module Mutter
+  class Table
+    attr_accessor :rows, :columns
+    
+    DefaultTable = {
+      :delimiter => " ",
+      :truncater => ".."
+    }
+    DefaultColumn = {
+      :align  => :left,
+      :style  => []
+    }
+    
+    def initialize options = {}, &blk
+      @columns, @rows = [], []
+      @options = DefaultTable.merge options
+      instance_eval(&blk) if block_given?
+    end
+    
+    def column options = {}
+      @columns << DefaultColumn.merge(options)
+    end
+    
+    def << row
+      if row.size > @columns.size
+        raise ArgumentError, 
+          "row size is #{row.size} but I only have #{@columns.size} columns"
+      else
+        @rows << row
+      end
+    end
+    
+    def render
+      # Create missing columns as needed
+      (@rows.map {|r| r.size }.max - @columns.size).times do
+        self.column
+      end
+      
+      # Compute max column width
+      @columns.each_with_index do |col, i|        
+        col[:_width] = @rows.map do |r|
+          r[i].to_s.length
+        end.max if @rows[i]
+      end
+      
+      # print table
+      @rows.map do |row|
+        @columns.zip(row).map do |col, cell|
+          process(cell.to_s || "", 
+                  col[:width] || col[:_width],
+                  col[:align],
+                  col[:style])
+        end.join @options[:delimiter]
+      end
+    end
+    alias :to_a render
+    
+    def to_s
+      render.join("\n")
+    end
+    
+    def print
+      puts render
+    end
+    
+    def process str, length = nil, align = :left, style = []
+      length ||= str.length
+      
+      if str.length > length
+        str[0...(length - @options[:truncater].length)] + @options[:truncater]
+      else
+        s = [Mutter.process(str, style), ' ' * (length - str.length)]
+        s.reverse! if align == :right
+        s.join
+      end
+    end
+  end
+end

data/mutter.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mutter}
-  s.version = "0.3.7"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["cloudhead"]
-  s.date = %q{2009-10-07}
+  s.date = %q{2009-10-15}
   s.description = %q{the tiny CLI library}
   s.email = %q{self@cloudhead.net}
   s.extra_rdoc_files = [
@@ -27,11 +27,14 @@ Gem::Specification.new do |s|
      "lib/mutter.rb",
      "lib/mutter/indenter.rb",
      "lib/mutter/mutterer.rb",
-     "lib/mutter/styles.yml",
+     "lib/mutter/styles/default.yml",
+     "lib/mutter/styles/html.yml",
+     "lib/mutter/table.rb",
      "mutter.gemspec",
      "spec/mutter_spec.rb",
      "spec/spec_helper.rb",
-     "spec/style.yml"
+     "spec/style.yml",
+     "spec/table_spec.rb"
   ]
   s.homepage = %q{http://github.com/cloudhead/mutter}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -41,7 +44,8 @@ Gem::Specification.new do |s|
   s.summary = %q{the tiny CLI library}
   s.test_files = [
     "spec/mutter_spec.rb",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "spec/table_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/table_spec.rb

@@ -0,0 +1,21 @@
+require 'spec/spec_helper'
+
+describe Mutter::Table do
+  it "should render tables defined with a block" do
+    table = Mutter::Table.new(:delimiter => '|') do
+      column :width => 8
+      column :align => :right
+      column
+    end
+    
+    table << ["hello", "moto", "malacif"]
+    table << ["misha", "fafa", "fio"]
+    table << ["lombardic", "fister", "falalala"]
+        
+    table.to_a.should == [
+      "hello   |  moto|malacif ",
+      "misha   |  fafa|fio     ",
+      "lombar..|fister|falalala"
+    ]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mutter
 version: !ruby/object:Gem::Version 
-  version: 0.3.7
+  version: 0.4.0
 platform: ruby
 authors: 
 - cloudhead
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-07 00:00:00 -04:00
+date: 2009-10-15 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -33,11 +33,14 @@ files:
 - lib/mutter.rb
 - lib/mutter/indenter.rb
 - lib/mutter/mutterer.rb
-- lib/mutter/styles.yml
+- lib/mutter/styles/default.yml
+- lib/mutter/styles/html.yml
+- lib/mutter/table.rb
 - mutter.gemspec
 - spec/mutter_spec.rb
 - spec/spec_helper.rb
 - spec/style.yml
+- spec/table_spec.rb
 has_rdoc: true
 homepage: http://github.com/cloudhead/mutter
 licenses: []
@@ -69,3 +72,4 @@ summary: the tiny CLI library
 test_files: 
 - spec/mutter_spec.rb
 - spec/spec_helper.rb
+- spec/table_spec.rb