mutter 0.4.0 → 0.5.0

data/README.md

@@ -7,9 +7,14 @@ mutter
 
 > mutter takes the concepts of **separation of style & content** to the command-line!
 
+setup
+-----
+
+    $ sudo gem install mutter -s http://gemcutter.org
+
 synopsis
 --------
-    
+
     require 'mutter'
 
     mut = Mutter.new                # creates a new 'Mutterer', who talks in command-line language
@@ -17,26 +22,26 @@ synopsis
     mut.say "hello world",   :bold  # bolds the whole string
     mut.say "hello [world]", :cyan  # inverts 'world', and colors the string cyan
     mut.print "bonjour!"            # alias of `say`
-    mut["_hola_"]                   # return the stylized string without printing
+    mut["_hola_"]                   # return the stylized string without printing, alias of #process
 
 ### 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
+
+Define your table structure, arguments are optional.
+
+    table = Mutter::Table.new(:delimiter => '|') do    # Strings which don't fit the column width will be truncated
+      column :width => 15, :style => :green            # with '..' by default, you can change that with the :truncater
+      column :style => :yellow                         # option.
       column :width => 15, :align => :right
     end
-    
-    # Add some rows
+
+Add some rows
+
     table << ["gaspar", "morello", 1976]
     table << ["eddie", "vedder", 1964]
     table << ["david", "bowie", 1947]
     
-    # Print
+Print.
+
     print table.to_s
 
 If you want something barebones, you can also do
@@ -109,18 +114,8 @@ and then loaded like this:
     mut >> :blink               # remove :blink
     mut << :bold << :underline  # add :bold and :underline
     mut.say "hello mutter."     # bold and underlined
-
-installation
-------------
-
-    $ sudo gem install cloudhead-mutter
     
 That's it!
 ----------
 
 _have fun_
-
-Footnote
---------
-
-This code is _highly experimental_, don't try this at home!

data/Rakefile

@@ -6,56 +6,18 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "mutter"
     gem.summary = %Q{the tiny CLI library}
-    gem.description = %Q{the tiny CLI library}
+    gem.description = %Q{the tiny command-line interface library with lots of style}
     gem.email = "self@cloudhead.net"
     gem.homepage = "http://github.com/cloudhead/mutter"
     gem.rubyforge_project = 'mutter'
     gem.authors = ["cloudhead"]
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
+  Jeweler::GemcutterTasks.new
   Jeweler::RubyforgeTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
-  end
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "mutter #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
 require 'spec/rake/spectask'
 
 Spec::Rake::SpecTask.new("spec") do |t|
@@ -67,9 +29,4 @@ task :test do
   Rake::Task['spec'].invoke
 end
 
-Spec::Rake::SpecTask.new("rcov_spec") do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb']
-  t.spec_opts = ['--color']
-  t.rcov = true
-  t.rcov_opts = ['--exclude', '^spec,/gems/']
-end
+task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/lib/ext.rb

@@ -1,4 +1,3 @@
-require 'mutter'
 
 class String
   def examine depth = 0
@@ -33,4 +32,4 @@ class Object
     yield self
     self
   end
-end
+end

data/lib/mutter.rb

@@ -58,4 +58,17 @@ module Mutter
   def self.new *args
     Mutterer.new(*args)
   end
+  
+  #
+  # Utility function, to make a block interruptible
+  #
+  def watch
+    begin
+      yield
+    rescue Interrupt
+      puts
+      exit 0
+    end
+  end
+  alias :oo watch
 end

data/lib/mutter/mutterer.rb

@@ -1,6 +1,7 @@
 module Mutter
   class Mutterer
-    @stream = STDOUT
+    @stream = STDOUT  # output stream
+    @color = false    # force color
 
     # Initialize the styles, and load the defaults from +styles.yml+
     #
@@ -37,7 +38,7 @@ module Mutter
         end if style.is_a? Symbol
       end
     end
-    
+
     def styles
       @defaults.merge @styles
     end
@@ -48,7 +49,7 @@ module Mutter
         when :styles   then @styles, @defaults = {}, {}
         when :active   then @active = []
         when :all      then @active, @styles, @defaults = [], {}, {}
-        when :default, 
+        when :default,
              :defaults then @defaults = {}
         else           raise ArgumentError, "[:user, :default, :active, :all] only"
       end
@@ -69,16 +70,29 @@ module Mutter
       end
     end
 
+    def color?
+      (ENV['TERM'].include?('color') && self.class.stream.tty?) || self.class.color
+    end
+
     #
     # Output to @stream
     #
     def say msg, *styles
-      self.write((ENV['TERM'].include?('color') ? process(msg, *styles) : msg) + "\n")
-      return nil
+      self.write((color?? process(msg, *styles) : unstyle(msg)) + "\n") ; nil
     end
-    
     alias :print say
-    
+
+    #
+    # Remove all tags from string
+    #
+    def unstyle msg
+      styles.map do |_,v|
+        v[:match]
+      end.flatten.inject(msg) do |m, tag|
+        m.gsub(tag, '')
+      end
+    end
+
     #
     #  Parse the message, but also apply a style on the whole thing
     #
@@ -94,22 +108,9 @@ module Mutter
       self.class.stream.tap do |stream|
         stream.write str
         stream.flush
-      end; nil
+      end ; nil
     end
 
-    #
-    # Utility function, to make a block interruptible
-    #
-    def watch
-      begin
-        yield
-      rescue Interrupt
-        puts
-        exit 0
-      end
-    end
-    alias :oo watch
-    
     #
     # Create a table
     #
@@ -197,5 +198,13 @@ module Mutter
     def self.stream= io
       @stream = io
     end
+
+    def self.color
+      @color
+    end
+
+    def self.color= bool
+      @color = bool
+    end
   end
 end

data/mutter.gemspec

@@ -1,16 +1,16 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{mutter}
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["cloudhead"]
-  s.date = %q{2009-10-15}
-  s.description = %q{the tiny CLI library}
+  s.date = %q{2009-11-08}
+  s.description = %q{the tiny command-line interface library with lots of style}
   s.email = %q{self@cloudhead.net}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -58,3 +58,4 @@ Gem::Specification.new do |s|
   else
   end
 end
+

data/spec/mutter_spec.rb

@@ -4,11 +4,12 @@ describe Mutter do
   def out
     File.read("spec/out.txt")
   end
-  
+
   before(:each) do
     Mutter::Mutterer.stream = File.new("spec/out.txt", 'w')
+    Mutter::Mutterer.color = true
   end
-  
+
   after(:all) do
     File.delete("spec/out.txt")
   end
@@ -17,107 +18,107 @@ describe Mutter do
     Mutter.say "hello mutter!"
     out.should == "hello mutter!\n"
   end
-  
+
   it "should underline" do
     Mutter.say "_hello mutter!_"
     out.should == "\e[4mhello mutter!\e[24m\n"
   end
-  
+
   it "should bold" do
     Mutter.say "*hello mutter!*"
     out.should == "\e[1mhello mutter!\e[22m\n"
   end
-  
+
   it "should inverse" do
     Mutter.say "[hello mutter!]"
     out.should == "\e[7mhello mutter!\e[27m\n"
   end
-  
+
   it "should blink" do
     Mutter.say "hello mutter!", :blink
     out.should == "\e[5mhello mutter!\e[25m\n"
   end
-  
+
   it "should escape glyphs" do
     Mutter.say "**hello * world**"
     out.should == "\e[1mhello * world\e[22m\n"
   end
-  
+
   it "should set actives at the instance level" do
     Mutter.new([:bold, :underline]).say "hello mutter!"
     out.should == "\e[4m\e[1mhello mutter!\e[22m\e[24m\n"
   end
-  
+
   it "should set actives at the method level" do
     Mutter.say "hello mutter!", :bold, :underline
     out.should == "\e[4m\e[1mhello mutter!\e[22m\e[24m\n"
   end
-  
+
   it "should set actives at both levels" do
     Mutter.new(:bold).say "hello mutter!", :underline, :yellow
     out.should == "\e[33m\e[4m\e[1mhello mutter!\e[22m\e[24m\e[39m\n"
   end
-  
+
   describe "with custom styles" do
     it "should work with custom styles" do
       style = {
         :alert => {
-          :match => '!!', 
+          :match => '!!',
           :style => ['bold', 'red']
         }
       }
       Mutter.new(style).say "alert!", :alert
       out.should == "\e[31m\e[1malert!\e[22m\e[39m\n"
     end
-    
+
     describe "in shorthand form" do
       it "should work with simple shorthand styles" do
         Mutter.new({:bold => '~'}).say "~hello mutter!~"
         out.should == "\e[1mhello mutter!\e[22m\n"
       end
-  
+
       it "should work with complex shorthand styles" do
         Mutter.new({:cyan => ['<', '>']}).say "<hello mutter!>"
         out.should == "\e[36mhello mutter!\e[39m\n"
       end
-    
+
       it "should work with multiple shorthand styles" do
         Mutter.new({[:cyan, :underline] => '~'}).say "~hello mutter!~"
         out.should == "\e[4m\e[36mhello mutter!\e[39m\e[24m\n"
       end
     end
-    
+
     it "should mix styles" do
       Mutter.new({:cyan => '~'}).say "_*hello* ~world~_"
       out.should == "\e[4m\e[1mhello\e[22m \e[36mworld\e[39m\e[24m\n"
     end
-  
+
     it "should color backgrounds" do
       Mutter.new({:cyan => '~'}).say "~[hello mutter!]~"
       out.should == "\e[36m\e[7mhello mutter!\e[27m\e[39m\n"
     end
-    
+
     it "should load styles from a yaml" do
       Mutter.new("spec/style").say "{important message!}"
       out.should == "\e[33m\e[4m\e[1mimportant message!\e[22m\e[24m\e[39m\n"
     end
-    
+
     it "should be able to call styles as methods" do
       Mutter.new("spec/style").important "important message!"
       out.should == "\e[33m\e[4m\e[1mimportant message!\e[22m\e[24m\e[39m\n"
     end
-    
+
     it "should clear all styles" do
       Mutter.new.clear(:all).say "[hello] *world*"
       out.should == "[hello] *world*\n"
     end
-    
+
     it "should clear active styles" do
       mut = Mutter.new(:bold)
       mut.clear(:active).say "hello"
       out.should == "hello\n"
     end
-    
+
     it "should add and remove active styles" do
       mut = Mutter.new
       mut << :bold << :underline << :inverse
@@ -125,7 +126,7 @@ describe Mutter do
       mut.say "hello mutter!"
       out.should == "\e[4m\e[1mhello mutter!\e[22m\e[24m\n"
     end
-    
+
     it "should return instances of itself, +- active styles" do
       mut = Mutter.new
       mut << :bold << :underline
@@ -133,10 +134,22 @@ describe Mutter do
       out.should == "\e[4mhello mutter!\e[24m\n"
     end
   end
-  
+
   it "should parse a complex string" do
     m = Mutter.new({:cyan => ['<','>']})
     m.say "hello *mutter*, would you _<please be quiet>_ for this <[test]>?"
     out.should == "hello \e[1mmutter\e[22m, would you \e[4m\e[36mplease be quiet\e[39m\e[24m for this \e[36m\e[7mtest\e[27m\e[39m?\n"
   end
-end
+
+  describe "when color isn't supported" do
+    before(:each) do
+      Mutter::Mutterer.color = false
+    end
+
+    it "should remove style tags" do
+      m = Mutter.new
+      m.say "hello *mutter*, how are _you_?"
+      out.should == "hello mutter, how are you?\n"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mutter
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - cloudhead
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-15 00:00:00 -04:00
+date: 2009-11-08 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: the tiny CLI library
+description: the tiny command-line interface library with lots of style
 email: self@cloudhead.net
 executables: []