wirb 0.3.2 → 0.4.0

data/CHANGELOG.rdoc

@@ -1,3 +1,11 @@
+== 0.4.0
+* Add support for loading color schemas from yaml files
+* Add ability to hook in a custom colorizer
+  * Support for Paint, HighLine (1.6.3), old Wirb color names (Wirb0) and even older Wirble color names
+  * Wirb0(-like) colors are still default, but will be dropped (as default) in 1.0
+  * Provides hybrid connectors to Paint and HighLine that also enable Wirb colors (Wirb0_Paint, Wirb0_HighLine)
+* Only display error on failed tokenizations if $VERBOSE is not false
+
 == 0.3.2
 * Improve :<=> parsing :D
 * Support gem requirements (:gem_requirement_condition, :gem_requirement_version) and gem dependencies

data/README.rdoc

@@ -1,7 +1,7 @@
 == Wavy Interactive Ruby
-*Wirb* colorizes your inspected Ruby objects. It is based on Wirble[http://pablotron.org/software/wirble/], but only provides and improves result highlighting.
+*Wirb* colorizes your inspected Ruby objects. It is based on Wirble[http://pablotron.org/software/wirble/], but only provides and improves result highlighting. It also provides a colorization engine abstraction layer and offers flexible schemas using yaml. Wirb is part of the {irbtools suite}[https://github.com/janlelis/irbtools].
 
-http://travis-ci.org/janlelis/wirb.png
+{Travis}[http://travis-ci.org/janlelis/wirb]: http://travis-ci.org/janlelis/wirb.png
 
 == Install
 Install the gem with:
@@ -23,15 +23,28 @@ Add to your <tt>~/.irbrc</tt>
 * Can be used without irb
 * Limited stdlib/gem objects support (e.g. Set, Gem::Requirement)
 * Supports 1.8, 1.9, jruby, rbx, head
+* Usable with any supported terminal colors engine
+* Color schemas in yaml files
 
-== Customize
-The color schema can be changed with:
+== Colors
+To only tweak some colors, take a look at the <tt>Wirb.schema</tt> hash. To use a custom schema, inspect the yaml files in the <tt>data/wirb/</tt> directory. You can create your own schema and load it using <tt>Wirb.load_schema(path_to_yaml_file)</tt>. Alternatively, you can use one of the bundled ones by passing a symbol instead of a path.
 
-  Wirb.schema = { :comma => :purple, ... }
+=== Colorizer
+Wirb supports multiple colorization engines. Available engines can be found in <tt>lib/wirb/colorizer/*</tt>. Some of them require external gems as dependencies (e.g. HighLine). The current default engine is <em>Wirb0</em> (the one of previous Wirb versions, inherited from the original Wirble). It will be dropped as default engine in 1.0 (later this year), because it uses wrong color names. It will be replaced by Paint[https://github.com/janlelis/paint] or a simple colorizer engine with proper color names. You can change the colorizer using:
 
-Wirb color schemas are (almost) compatible with those from the original Wirble, but there are lots of extensions. Take a look at wirb/schema.rb or <tt>Wirb.schema</tt> for a list of available token descriptions. See wirb/colors.rb or <tt>Wirb::COLORS</tt> for the available colors.
+  Wirb.load_colorizer :Paint # or :HighLine or whatever
 
-Color schemas wanted! You've got a good looking alternative color schema? Please post it on the wiki[https://github.com/janlelis/wirb/wiki/schemas], it may be bundled with a next version ;)
+Be careful, though! You also need to select a color schema that supports your colorizer (Schemas define supported colorizers using the <tt>:colorizer</tt> key). Load a schema with:
+
+  Wirb.load_schema! :classic_paint # make sure your colorizer is paint
+
+You can automatically use the first colorizer of the schema by using the non-exclamation mark version:
+
+  Wirb.load_schema :classic_paint # will fail if paint is not installed
+
+Color schemas wanted! You've got a good looking alternative color schema? Please fork and add it to <tt>data/wirb/*</tt> :)
+
+Colorizers wanted! Your favorite terminal colors gem is not supported yet? Please fork and add it to <tt>lib/wirb/colorizer/*</tt> :D
 
 == wp
 You can colorize any object with <tt>wp</tt> (wavy_print):
@@ -43,11 +56,20 @@ You can colorize any object with <tt>wp</tt> (wavy_print):
 * Configure views for specific objects: hirb[https://github.com/cldwalker/hirb]
 * Wirb is part of: irbtools[https://github.com/janlelis/irbtools]
 * ripl is an irb alternative, syntax highlighting plugin (uses wirb by default): ripl-color_result[https://github.com/janlelis/ripl-color_result]
+* Advanced terminal color gems: Paint[https://github.com/janlelis/paint], HighLine[https://github.com/JEG2/highline]
+
+== Todo
+* Tests for schema stuff
+* More colorizers and themes
+* More support for stdlib (most important: Complex)
 
 == Credits
-Copyright (c) 2011 Jan Lelis <http://rbjl.net>, see COPYING for details.
+* Copyright (c) 2011 Jan Lelis <http://rbjl.net>, see COPYING for details.
+
+Contributions[https://github.com/janlelis/wirb/contributors] by and thanks to:
+* {Richard LeBer}[https://github.com/rleber]
 
-Contains code from (and thanks to)
+Influenced by code from and thanks to:
 * Copyright (C) 2006-2009 Paul Duncan <pabs@pablotron.org>
 
 J-_-L

data/data/wirb/classic_paint.yml

@@ -0,0 +1,137 @@
+colorizer:
+- Paint
+- Wirb0_Paint
+
+# container
+open_hash:
+- :green
+- :bright
+close_hash:
+- :green
+- :bright
+open_array:
+- :green
+- :bright
+close_array:
+- nil
+- :green
+- :bright
+open_set:
+- :green
+close_set:
+- :green
+
+# delimiter
+comma:  :green
+refers: :green
+
+# class
+class:
+- :green
+- :bright
+class_separator:
+- :green
+object_class:
+- :green
+- :bright
+
+# object
+open_object:
+- :green
+object_description_prefix:
+- :green
+object_description:
+- :yellow
+object_address_prefix:
+- :yellow
+- :underline
+object_address:
+- :yellow
+- :underline
+object_line_prefix:
+- :yellow
+- :underline
+object_line:
+- :yellow
+- :underline
+object_line_number:
+- :brown
+- :underline
+object_variable_prefix:
+- :purple
+- :bright
+object_variable:
+- :purple
+- :bright
+close_object:
+- :green
+
+# symbol
+symbol_prefix:
+- :yellow
+- :bright
+symbol:
+- :yellow
+- :bright
+open_symbol_string:
+- :yellow
+symbol_string:
+- :yellow
+- :bright
+close_symbol_string:
+- :yellow
+
+# string
+open_string:
+- :white
+string:
+- :black
+- :bright
+close_string:
+- :white
+
+# regexp
+open_regexp:
+- :blue
+- :bright
+regexp:
+- :white
+close_regexp:
+- :blue
+- :bright
+regexp_flags:
+- :red
+- :bright
+
+# number
+number:
+- :cyan
+range:
+- :red
+open_rational:
+- :cyan
+- :bright
+rational_separator:
+- :cyan
+- :bright
+close_rational:
+- :cyan
+- :bright
+
+# misc
+#default:
+#keyword:
+time:
+- :purple
+nil:
+- :red
+- :bright
+false:
+- :red
+true:
+- :green
+gem_requirement_condition:
+- :cyan
+gem_requirement_version:
+- :cyan
+- :bright

data/data/wirb/classic_wirb0.yml

@@ -0,0 +1,69 @@
+colorizer:
+- Wirb0
+- Wirb0_Paint
+- Wirb0_HighLine
+
+# container
+open_hash:   light_green
+close_hash:  light_green
+open_array:  light_green
+close_array: light_green
+open_set:    green
+close_set:   green
+
+# delimiter
+comma:  green
+refers: green
+
+# class
+class:           light_green
+class_separator: green
+object_class:    light_green
+
+# object
+open_object:               green
+object_description_prefix: green
+object_description:        brown
+object_address_prefix:     brown_underline
+object_address:            brown_underline
+object_line_prefix:        brown_underline
+object_line:               brown_underline
+object_line_number:        brown_underline
+object_variable_prefix:    light_purple
+object_variable:           light_purple
+close_object:              green
+
+# symbol
+symbol_prefix:       yellow
+symbol:              yellow
+open_symbol_string:  brown
+symbol_string:       yellow
+close_symbol_string: brown
+
+# string
+open_string:  light_gray
+string:       dark_gray
+close_string: light_gray
+
+# regexp
+open_regexp:  light_blue
+regexp:       dark_gray
+close_regexp: light_blue
+regexp_flags: light_red
+
+# number
+number: cyan
+range:  red
+open_rational:      light_cyan
+rational_separator: light_cyan
+close_rational:     light_cyan
+
+# misc
+#default:
+#keyword:
+time:    purple
+nil:     light_red
+false:   red
+true:    green
+gem_requirement_condition: cyan
+gem_requirement_version:   light_cyan

data/lib/wirb.rb

@@ -1,28 +1,97 @@
-require File.expand_path( File.dirname(__FILE__) + '/wirb/version' )
-require File.expand_path( File.dirname(__FILE__) + '/wirb/colors' )
-require File.expand_path( File.dirname(__FILE__) + '/wirb/schema' )
-require File.expand_path( File.dirname(__FILE__) + '/wirb/tokenizer' )
+require File.dirname(__FILE__) + '/wirb/version'
+require File.dirname(__FILE__) + '/wirb/colorizer'
+require File.dirname(__FILE__) + '/wirb/tokenizer'
+require 'yaml'
 
 class << Wirb
-  attr_accessor :schema
+  def running?() @running end
 
   @running = false
-  def running?() @running end
 
-  # Return the escape code for a given color
-  def get_color(key)
-    if key.is_a? String
-      color = key
-    elsif Wirb::COLORS.key?(key)
-      color = Wirb::COLORS[key]
+  # Start colorizing results, will hook into irb if IRB is defined
+  def start
+    require File.dirname(__FILE__) + '/wirb/irb' if defined?(IRB) && !IRB::Irb.instance_methods.include?(:prompt_non_fancy)
+    @running = true
+  rescue LoadError
+    warn "Couldn't activate Wirb"
+  end
+  alias activate start
+  alias enable   start
+
+  # Stop colorizing
+  def stop
+    @running = false
+  end
+  alias deactivate stop
+  alias disable    stop
+
+  # extend getter & setter for colorizer & schema
+  def colorizer
+    @colorizer ||= Wirb::Colorizer::Wirb0
+  end
+
+  def colorizer=(col)
+    @colorizer = col
+  end
+
+  # Convenience method, permits simplified syntax like:
+  #   Wirb.load_colorizer :HighLine
+  def load_colorizer(colorizer_name)
+    # @colorizer = Wirb::Colorizer.const_get(colorizer_name, false)
+    @colorizer = eval "Wirb::Colorizer::#{colorizer_name}"
+    compatibile_colorizer?(@colorizer)
+    @colorizer
+  end
+
+  def schema
+    @schema || load_schema
+  end
+
+  def schema=(val)
+    @schema = val
+  end
+
+  # Loads a color schema from a yaml file
+  #   If first argument is a String: path to yaml file
+  #   If first argument is a Symbol: bundled schema
+  def load_schema!(yaml_path = :classic_wirb0)
+    if yaml_path.is_a? Symbol # bundled themes
+      schema_name = yaml_path.to_s
+      schema_yaml = YAML.load_file(File.join( Gem.datadir('wirb'), schema_name + '.yml' ))
+    else
+      schema_name = File.basename(yaml_path).gsub(/\.yml$/, '')
+      schema_yaml = YAML.load_file(yaml_path)
+    end
+
+    if schema_yaml.is_a?(Hash)
+      @schema = Hash[ schema_yaml.map{ |k,v|
+        [k.to_s.to_sym, Array( v )]
+      } ]
+      @schema[:name] = schema_name.to_sym
+      @schema[:colorizer].map!(&:to_sym)
+    else
+      raise LoadError, "Could not load the Wirb schema at: #{yaml_path}"
     end
 
-    color ? "\033[#{ color }m" : ''
+    @schema
   end
 
+  # Loads a color schema from a yaml file and sets colorizer to first suggested one in schema
+  def load_schema(yaml_path = :classic_wirb0)
+    load_schema! yaml_path
+    load_colorizer schema[:colorizer].first
+    @schema
+  end
+
+  # Return the escape code for a given color
+  def get_color(*keys)
+    colorizer.color(*keys)
+  end
+  alias color get_color
+  
   # Colorize a string
-  def colorize_string(string, color)
-    get_color(color) + string.to_s + get_color(:nothing)
+  def colorize_string(string, *colors)
+    colorizer.run(string, *colors)
   end
 
   # Colorize a result string
@@ -31,7 +100,7 @@ class << Wirb
       check = ''
       colorful = tokenize(string).map do |kind, token|
         check << token
-        colorize_string token, custom_schema[kind]
+        colorize_string token, *Array( custom_schema[kind] )
       end.join
 
       # always display the correct inspect string!
@@ -40,23 +109,27 @@ class << Wirb
       string
     end
   end
+  alias colorize_code colorize_result
+  alias colorize_ruby colorize_result
 
-  # Colorize results
-  #  Will hook into irb if IRB is defined
-  def start
-    require File.dirname(__FILE__) + '/wirb/irb' if defined?(IRB)
-    @running = true
-  rescue LoadError
-    warn "Couldn't activate Wirb"
-  end
-  alias activate start
-  alias enable start
+  private
 
-  def stop # don't colorize, anymore
-    @running = false
+  def compatibile_colorizer?(col)
+    short_col = col.to_s.sub(/^.*::(.*?)$/, '\1').to_sym
+    if !col
+      warn "No colorizer selected!"
+      false
+    elsif !Array( @schema[:colorizer] ).include?(short_col)
+      warn "Your current color schema does not support this colorizer:\n" +
+           "  #{ short_col }\n" + 
+           "The following colorizeres are supported with this schema (use Wirb.load_colorizer :Name):\n  " + 
+           Array( @schema[:colorizer] ).join("\n  ")
+      false
+    else
+      true
+    end
   end
-  alias deactivate stop
-  alias disable stop
+
 end
 
 # J-_-L