mutter 0.3.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+.document

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 cloudhead
+
+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.md

@@ -0,0 +1,98 @@
+mutter
+======
+
+    $ my words come out, 
+        in color and
+            style
+
+> mutter takes the concepts of **separation of style & content** to the command-line!
+
+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
+    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
+
+styles
+------
+mutter supports these styles:
+
+    :bold, :underline, :inverse, :blink
+
+and these colors:
+
+    :red, :green, :blue, :yellow, :cyan, :purple, :white, :black
+
+customization
+-------------
+
+    styles = {
+      :warning => {                     # an alias you can use anywhere in mutter
+        :match => ['*!', '!*'],         # will match *!mutter!*
+        :style => ['yellow', 'bold']    # these styles will be applied to the match
+      },
+      :error => {
+        :match => '!!',                 # will match !!mutter!!
+        :style => ['red', 'underline']
+      }
+    }
+    
+    mut = Mutter.new(styles)
+    mut.say     "warning, the dogs have escaped!", :warning  # These two are
+    mut.warning "warning, the dogs have escaped!"            # equivalent
+    mut.say     "gosh, we have an !!error!!"
+
+### YAML
+    
+The previous example could have (and should really have) been written in a separate .yml file, like so:
+    
+    warning:
+      match: 
+        - '*!'
+        - '!*
+      style:
+        - yellow
+        - bold
+
+    error:
+      match: '!!'
+      style:
+        - red
+        - underline
+
+and then loaded like this:
+
+    Mutter.new("styles.yml")
+    
+### quick styles
+
+    mut = Mutter.new :yellow => '~'
+    mut.say "~[black on yellow!]~"
+    
+### add/remove styles from an instance
+
+    mut = Mutter.new(:blink)
+    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

@@ -0,0 +1,100 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mutter"
+    gem.summary = %Q{the tiny CLI library}
+    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
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+# rubyforge
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+        options << '--line-numbers' << '--inline-source'
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/the-perfect-gem/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+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|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--color', '--format=specdoc']
+end
+
+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

data/VERSION

@@ -0,0 +1 @@
+0.3.2

data/lib/ext.rb

@@ -0,0 +1,36 @@
+require 'mutter'
+
+class String
+  def examine depth = 0
+    inspect
+  end
+end
+
+class Array
+  def examine depth = 0
+  end
+end
+
+class Hash
+  def examine depth = 0
+  end
+end
+
+class Symbol
+  def examine depth = 0
+    Mutter.stylize inspect, :purple
+  end
+end
+
+class Numeric
+  def examine depth = 0
+    Mutter.stylize inspect, :cyan
+  end
+end
+
+class Object
+  def tap
+    yield self
+    self
+  end
+end

data/lib/mutter/indenter.rb

@@ -0,0 +1,11 @@
+module Mutter
+  class Indenter
+    def initialize tab = 2
+      @tab = tab
+    end
+
+    def [] n, obj = nil
+      ' ' * (n * @tab)
+    end
+  end
+end

data/lib/mutter/mutterer.rb

@@ -0,0 +1,179 @@
+module Mutter
+  class Mutterer
+    attr_accessor :styles
+
+    @stream = STDOUT
+
+    # Initialize the styles, and load the defaults from +styles.yml+
+    #
+    # @active: currently active styles, which apply to the whole string
+    # @styles: contains all the user + default styles
+    #
+    def initialize obj = {}
+      @active, @styles = [], {}
+      load File.dirname(__FILE__) + "/styles"
+
+      case obj
+        when Hash       # A style definition: expand quick-styles and merge with @styles
+          obj = obj.inject({}) do |h, (k, v)|
+            h.merge k =>
+              (v.is_a?(Hash) ? v : { :match => v, :style => [k].flatten })
+          end
+          @styles.merge! obj
+        when Array      # An array of styles to be activated
+          @active = obj
+        when Symbol     # A single style to be activated
+          self.<< obj
+        when String     # The path of a yaml style-sheet
+          load obj
+        else raise ArgumentError
+      end
+
+      #
+      # Create an instance method for each style
+      #
+      @styles.keys.each do |style|
+        (class << self; self end).class_eval do
+          define_method style do |msg|
+            say msg, style
+          end
+        end if style.is_a? Symbol
+      end
+    end
+
+    #
+    # Loads styles from a YAML style-sheet,
+    #   and converts the keys to symbols
+    #
+    def load styles
+      styles += '.yml' unless styles =~ /\.ya?ml/
+      @defaults = YAML.load_file(styles).inject({}) do |h, (key, value)|
+        value = { :match => value['match'], :style => value['style'] }
+        h.merge key.to_sym => value
+      end
+      @styles.merge! @defaults
+    end
+
+    #
+    # Output to @stream
+    #
+    def say msg, *styles
+      self.write (ENV['TERM'].include?('color') ? process(msg, *styles) : msg) + "\n"
+      return nil
+    end
+    
+    alias :print say
+    
+    #
+    #  Parse the message, but also apply a style on the whole thing
+    #
+    def process msg, *styles
+      stylize(parse(msg), @active + styles).gsub(/\e(\d+)\e/, "\e[\\1m")
+    end
+    alias :[] process
+
+    #
+    # Write to the out stream, and flush it
+    #
+    def write str
+      self.class.stream.tap do |stream|
+        stream.write str
+        stream.flush
+      end; nil
+    end
+
+    #
+    # Utility function, to make a block interruptible
+    #
+    def watch
+      begin
+        yield
+      rescue Interrupt
+        puts
+        exit 0
+      end
+    end
+    alias :oo watch
+
+    #
+    # Add and remove styles from the active styles
+    #
+    def << style
+      @active << style
+    end
+
+    def >> style
+      @active.delete style
+    end
+
+    def + style
+      dup.tap {|m| m << style }
+    end
+
+    def - style
+      dup.tap {|m| m >> style }
+    end
+
+    #
+    # Parse a string to ANSI codes
+    #
+    #   if the glyph is a pair, we match [0] as the start
+    #   and [1] as the end marker.
+    #   the matches are sent to +stylize+
+    #
+    def parse string
+      @styles.inject(string) do |str, (name, options)|
+        glyph, styles = options[:match], options[:style]
+        if glyph.is_a? Array
+          str.gsub(/#{Regexp.escape(glyph.first)}(.+?)
+                    #{Regexp.escape(glyph.last)}/x) { stylize $1, styles }
+        else
+          str.gsub(/(#{Regexp.escape(glyph)}+)(.+?)\1/) { stylize $2, styles }
+        end
+      end
+    end
+
+    #
+    # Apply styles to a string
+    #
+    #   if the style is a default ANSI style, we add the start
+    #   and end sequence to the string.
+    #
+    #   if the style is a custom style, we recurse, sending
+    #   the list of ANSI styles contained in the custom style.
+    #
+    #   TODO: use ';' delimited codes instead of multiple \e sequences
+    #
+    def stylize string, styles = []
+      [styles].flatten.inject(string) do |str, style|
+        style = style.to_sym
+        if ANSI[:transforms].include? style
+          esc str, *ANSI[:transforms][style]
+        elsif ANSI[:colors].include? style
+          esc str, ANSI[:colors][style], ANSI[:colors][:reset]
+        else
+          stylize(str, @styles[style][:style])
+        end
+      end
+    end
+
+    #
+    # Escape a string, for later replacement
+    #
+    def esc str, open, close
+      "\e#{open}\e" + str + "\e#{close}\e"
+    end
+
+    #
+    # Output stream (defaults to STDOUT)
+    #   mostly for test purposes
+    #
+    def self.stream
+      @stream
+    end
+
+    def self.stream= io
+      @stream = io
+    end
+  end
+end

data/lib/mutter/styles.yml

@@ -0,0 +1,14 @@
+bold:
+  match: '*'
+  style:
+    - bold
+
+underline:
+  match: '_'
+  style:
+    - underline
+
+inverse:
+  match: ['[', ']']
+  style:
+    - inverse

data/lib/mutter.rb

@@ -0,0 +1,57 @@
+#
+# Mutter — the tiny command-line interface library with lots of style~
+#
+
+require 'yaml' 
+
+$:.unshift File.dirname(__FILE__) + '/mutter'
+
+require 'mutterer'
+require 'indenter'
+require 'io'
+require 'ext'
+
+module Mutter
+  #
+  # ANSI color & transform codes
+  #
+  #   If the value's an array, 
+  #   [0] is the start code
+  #   and [1] is the end code.
+  #
+  #   Colors all have the same
+  #   reset code (39).
+  #
+  ANSI = {
+    :reset => 0,
+    :transforms => {
+      :bold      => [1, 22],
+      :underline => [4, 24],
+      :blink     => [5, 25],
+      :inverse   => [7, 27]
+    },
+    :colors => {
+      :black  => 30, :red    => 31,
+      :green  => 32, :yellow => 33,
+      :blue   => 34, :purple => 35,
+      :cyan   => 36, :white  => 37,
+      :reset  => 39
+    }
+  }
+  
+  def self.indenter tab
+    Indenter.new tab
+  end
+  
+  def self.say *args
+    new.say *args
+  end
+  
+  def self.stylize *args
+    new.stylize *args
+  end
+  
+  def self.new *args
+    Mutterer.new(*args)
+  end
+end

data/mutter.gemspec

@@ -0,0 +1,52 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mutter}
+  s.version = "0.3.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["cloudhead"]
+  s.date = %q{2009-09-02}
+  s.email = %q{self@cloudhead.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/ext.rb",
+     "lib/mutter.rb",
+     "lib/mutter/indenter.rb",
+     "lib/mutter/mutterer.rb",
+     "lib/mutter/styles.yml",
+     "mutter.gemspec",
+     "spec/mutter_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/style.yml"
+  ]
+  s.homepage = %q{http://github.com/cloudhead/mutter}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{mutter}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{the tiny CLI library}
+  s.test_files = [
+    "spec/mutter_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/mutter_spec.rb

@@ -0,0 +1,129 @@
+require 'spec/spec_helper'
+
+describe Mutter do
+  def out
+    File.read("spec/out.txt")
+  end
+  
+  before(:each) do
+    Mutter::Mutterer.stream = File.new("spec/out.txt", 'w')
+  end
+  
+  after(:all) do
+    File.delete("spec/out.txt")
+  end
+
+  it "should output strings" 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 defaults 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 defaults 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 defaults 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 => '!!', 
+          :style => ['bold', 'red']
+        }
+      }
+      Mutter.new(style).say "alert!", :alert
+      out.should == "\e[31m\e[1malert!\e[22m\e[39m\n"
+    end
+  
+    it "should work with shorthand custom styles" do
+      Mutter.new({:bold => '~'}).say "~hello mutter!~"
+      out.should == "\e[1mhello mutter!\e[22m\n"
+    end
+  
+    it "should color" do
+      Mutter.new({:cyan => ['<', '>']}).say "<hello mutter!>"
+      out.should == "\e[36mhello mutter!\e[39m\n"
+    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 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
+    
+    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 add and remove active styles" do
+      mut = Mutter.new
+      mut << :bold << :underline << :inverse
+      mut >> :inverse
+      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
+      (mut - :bold).say "hello mutter!"
+      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

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'spec'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+
+require 'mutter'
+
+

data/spec/style.yml

@@ -0,0 +1,14 @@
+important:
+  match:
+    - '{'
+    - '}'
+  style:
+    - bold
+    - underline
+    - yellow
+
+warning:
+  match: '@'
+  style:
+    - red
+    

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: mutter
+version: !ruby/object:Gem::Version 
+  version: 0.3.2
+platform: ruby
+authors: 
+- cloudhead
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-02 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: self@cloudhead.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/ext.rb
+- lib/mutter.rb
+- lib/mutter/indenter.rb
+- lib/mutter/mutterer.rb
+- lib/mutter/styles.yml
+- mutter.gemspec
+- spec/mutter_spec.rb
+- spec/spec_helper.rb
+- spec/style.yml
+has_rdoc: true
+homepage: http://github.com/cloudhead/mutter
+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: mutter
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: the tiny CLI library
+test_files: 
+- spec/mutter_spec.rb
+- spec/spec_helper.rb