cloudhead-mutter 0.1.2 → 0.2.0

data/README.md

@@ -6,8 +6,7 @@ mutter
             style
 
 > mutter is the tiny CLI library, with a focus on style.
-
-use it in your apps to have _gorgeous_ command-line output!
+> use it in your apps to have _gorgeous_ command-line output!
 
 usage (command-line output)
 ---------------------------
@@ -19,6 +18,7 @@ usage (command-line output)
     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"]                     # yet another way to print
 
 styles
 ------
@@ -45,8 +45,9 @@ customization
     }
     
     mut = Mutter.new(styles)
-    mut.say "warning, warning!", :warning
-    mut.say "gosh, we have an !!error!!"
+    mut.say     "warning, warning!", :warning
+    mut.warning "warning, warning!"
+    mut.say     "gosh, we have an !!error!!"
     
 ### quick styles
 
@@ -70,3 +71,8 @@ That's it!
 ----------
 
 _have fun_
+
+Footnote
+--------
+
+This code is _highly experimental_, don't try this at home!

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

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,157 @@
+module Mutter
+  class Mutterer
+    @stream = STDOUT
+
+    # Initialize the styles, and load the defaults from +defaults.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 the command-line
+    #   we parse the string, but also apply a style on the whole string,
+    #
+    def say obj, *styles
+      stylize(parse(obj), @active + styles).tap do |out|
+        self.write out.gsub(/\e(\d+)\e/, "\e[\\1m") + "\n"
+      end
+    end
+
+    alias :print say
+    alias :[]    say
+
+    #
+    # Write to the out stream, and flush it
+    #
+    def write str
+      self.class.stream.tap do |stream|
+        stream.write str
+        stream.flush
+      end
+    end
+
+    #
+    # Utility function, to make a block interruptible
+    #
+    def watch
+      begin
+        yield
+      rescue Interrupt
+        puts
+        exit 0
+      end
+    end
+    alias :oo watch
+
+    #
+    # Add a style to the active styles
+    #
+    def << style
+      @active << 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.
+    #
+    def stylize string, styles = []
+      [styles].flatten.inject(string) do |str, style|
+        style = style.to_sym
+        if ANSI.include? style
+          open, close = ANSI[style]
+          "#{esc(open)}#{str}#{esc(close || 0)}"
+        else
+          stylize(str, @styles[style][:style])
+        end
+      end
+    end
+
+    #
+    # Escape a string, for later replacement
+    #
+    def esc style
+      "\e#{style}\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.rb

@@ -1,6 +1,26 @@
-require 'yaml'
+#
+# Mutter — the tiny command-line interface library with lots of style~
+#
+
+require 'yaml' 
+
+$:.unshift File.dirname(__FILE__) + '/mutter'
+
+require 'mutterer'
+require 'indenter'
+require 'ext'
 
 module Mutter
+  #
+  # ANSI color & style codes
+  #
+  #   if the value's an array, it 
+  #   represents [0] is the start code
+  #   and [1] is the end code.
+  #
+  #   if the value is an int, it represents
+  #   the start code, and the end code will be 0
+  #
   ANSI = {
     :bold      => [1, 22],
     :underline => [4, 24],
@@ -12,100 +32,18 @@ module Mutter
     :cyan   => 36, :white  => 37
   }
   
-  class Mutterer
-    @stream = STDOUT
-    
-    def initialize obj = {}
-      @active, @styles = [], {}
-      load File.dirname(__FILE__) + "/defaults"
-      
-      case obj
-        when Hash
-          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
-          @active = obj
-        when Symbol
-          self.<< obj
-        when String
-          load obj
-        else raise ArgumentError
-      end
-    end
-    
-    def load styles
-      styles += '.yml' unless styles =~ /\.ya?ml/
-      styles = 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! styles
-    end
-    
-    def say str, *styles
-      out = stylize(parse(str), @active + styles)
-      self.class.stream.write out.gsub(/\e(\d+)\e/, "\e[\\1m") + "\n"
-      self.class.stream.flush
-    end
-    alias :print say
-    
-    def watch
-      begin
-        yield
-      rescue Interrupt
-        puts
-        exit 0
-      end
-    end
-    
-    def << style
-      @active << style
-    end
-    
-    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
-    
-    def stylize string, styles = []
-      [styles].flatten.inject(string) do |str, style|
-        style = style.to_sym
-        if ANSI.include? style
-          open, close = ANSI[style]
-          "#{esc(open)}#{str}#{esc(close || 0)}"
-        else
-          stylize(str, @styles[style][:style])
-        end
-      end
-    end
-    
-    def esc style
-      "\e#{style}\e"
-    end
-    
-    def self.stream
-      @stream
-    end
-
-    def self.stream= io
-      @stream = io
-    end
+  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

data/mutter.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mutter}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["cloudhead"]
-  s.date = %q{2009-07-30}
+  s.date = %q{2009-07-31}
   s.email = %q{self@cloudhead.net}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -19,8 +19,11 @@ Gem::Specification.new do |s|
      "README.md",
      "Rakefile",
      "VERSION",
-     "lib/defaults.yml",
+     "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",

data/spec/mutter_spec.rb

@@ -94,6 +94,11 @@ describe Mutter do
       Mutter.new("spec/style").say "{important message!}"
       out.should == "\e[33m\e[4m\e[1mimportant message!\e[22m\e[24m\e[0m\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[0m\n"
+    end
   end
   
   it "should parse a complex string" do

data/spec/style.yml

@@ -5,4 +5,10 @@ important:
   style:
     - bold
     - underline
-    - yellow
+    - yellow
+
+warning:
+  match: '@'
+  style:
+    - red
+    

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cloudhead-mutter
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - cloudhead
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-30 00:00:00 -07:00
+date: 2009-07-31 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -29,8 +29,11 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- lib/defaults.yml
+- 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