geek_painter 0.1.1 → 0.2.0

data/README.rdoc

@@ -1,6 +1,6 @@
 == Geek Painter
 
-A very simple DSL to generate a colored shell prompt to use in *nix OS
+A very simple DSL to generate colored strings to use in *nix-like OS's terminals
 
 == Installation
 	
@@ -8,28 +8,90 @@ A very simple DSL to generate a colored shell prompt to use in *nix OS
 	
 == Usage
 	
-	#put the following lines in a file (ie. geek_painter_client.rb or whatever you want)
-	painting = GeekPainter.paint do
-	  trace "[".in    :brown
-	  trace "\\u".in  :red
-	  trace ":".in    :yellow
-	  trace "\\h".in  :red
-	  trace "] ".in   :magenta
-	  trace "\\w ".in :default
-	  trace "\$(__git_ps1)".in :yellow
-	  trace " $ ".reset
+=== Generate a valid string to be used as a prompt string (PS1)
+	
+Check this link to see the available variables: http://www.ibm.com/developerworks/linux/library/l-tip-prompt/
+
+Put the following lines in a file (ie. ~/.my_scripts/my_prompt.rb or whatever you want)
+	
+	master_piece = GeekPainter.paint do
+	  label "[".in(:brown).on :blue
+	  label "\\u".in  :red
+	  label ":".in    :yellow
+	  label "\\h".in  :red
+	  label "] ".in(:magenta).on :red
+	  label "\\W ".in :default
+	  label "\$(__git_ps1)".in :yellow <= This might not work if you don't have git installed
 	end
 	
-	#it shows the actual string ready to be copied and pasted in ~/.bashrc or ~/.bash_profile files like this => PS1='the_string'
-	# just do: $ruby geek_painter_client.rb
-	painting.print_raw
+	puts master_piece.prompt
+		
+Now open your ~/.bash_profile, ~/.bashrc or ~/.profile and put this on it
+
+	PS1=`ruby ~/.my_scripts/my_prompt.rb`
+
+Open a console and you'll see your new shiny and colorful prompt.
+
+If you just want to copy and paste the string run the same script like this in a Ruby terminal (irb):
+
+	 puts master_pieces.raw_prompt
+
+Copy the resulting string and paste it in your PS1.
+
+=== Generate a valid string to be used as colored text in the terminal
+
+	my_text = GeekPainter.paint do
+		label "Hello, ".in(:red).on(:blue)
+		label "World.".in(:yellow).on(:cyan)
+	end
 	
-	#the GeekPainter#show method is meant to be used when geek painter is used like this:
-	#
-	#  in ~/.bashrc
-	#	    PS1='$(ruby geek_painter_client.rb)'
-	painting.show
+	puts my_text.raw_text
 
+In this case "raw_text" will return the following string: 
+	
+	\e[1;31;44mHello, \e[1;33;46mWorld.\e[0m
+
+Copy it and...
+	
+	$ printf "\e[1;31;44mHello, \e[1;33;46mWorld.\e[0m"
+	
+To print the colored text in the Interactive Ruby console (IRb) do the following
+
+	puts my_text.text # it will print the colored text itself not the escaped string
+		
+== Available colors
+
+=== Foreground (These colors can be used as a parameter in the "in" method)
+
+	:black
+	:dark_gray
+	:light_gray
+	:light_red
+	:red
+	:light_green
+	:green
+	:yellow
+	:brown
+	:light_blue
+	:blue
+	:light_magenta
+	:magenta
+	:light_cyan
+	:cyan
+	:white
+	:default
+    
+=== Background (These colors can be used as a parameter in the "on" method)
+
+	:black
+	:red
+	:green
+	:brown
+	:blue
+	:magenta
+	:cyan
+	:white
+	:default
 
 == Note on Patches/Pull Requests
  
@@ -41,6 +103,10 @@ A very simple DSL to generate a colored shell prompt to use in *nix OS
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
+== TODO
+
+	* generate string to be used like this => echo -e "the_string", right now the generated string shows extra characters if used this way.
+	
 == Copyright
 
 Copyright (c) 2010 Rafael Magaña. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/geek_painter.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{geek_painter}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rafael Magana"]
-  s.date = %q{2010-04-03}
+  s.date = %q{2010-07-22}
   s.description = %q{A very simple DSL to generate a colored shell prompt string to use in *nix OS terminals. it might be used to generate a valid string to be used as a prompt or to generated strings that represent colored text on a terminal.}
   s.email = %q{raf.magana@gmail.com}
   s.extra_rdoc_files = [
@@ -27,16 +27,15 @@ Gem::Specification.new do |s|
      "geek_painter_client.rb",
      "lib/geek_painter.rb",
      "lib/geek_painter/canvas.rb",
+     "lib/geek_painter/core-ext.rb",
      "lib/geek_painter/escaping_tools.rb",
-     "lib/geek_painter/palette.rb",
-     "lib/geek_painter/string.rb",
      "test/helper.rb",
      "test/test_geek_painter.rb"
   ]
   s.homepage = %q{http://github.com/rafmagana/geek_painter}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A very simple DSL to generate a colored shell prompt string to use in *nix OS terminals}
   s.test_files = [
     "test/helper.rb",
@@ -47,7 +46,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
     else
       s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])

data/geek_painter_client.rb

@@ -1,19 +1,15 @@
 require "rubygems"
 require "geek_painter"
 
+
 painting = GeekPainter.paint do
-  trace "[".in    :brown
-  trace "\\u".in  :red
-  trace ":".in    :yellow
-  trace "\\h".in  :red
-  trace "] ".in   :magenta
-  trace "\\w ".in :default
-  trace "\$(__git_ps1)".in :yellow
-  trace " $ ".in :default
+  label "[".in    :brown
+  label "\\u".in  :red
+  label ":".in    :yellow
+  label "\\h".in  :red
+  label "] ".in   :magenta
+  label "\\w ".in :default
+  label "\$(__git_ps1)".in :blue
 end
 
-painting.print_raw
-# >> 
-# >> \[\033[0;33m\][\[\033[0;31m\]\u\[\033[1;33m\]:\[\033[0;31m\]\h\[\033[0;35m\]] \[\033[0m\]\w \[\033[1;33m\]$(__git_ps1)\[\033[0m\] $ \[\033[0m\]
-# >> 
-# >> copy the string above and put it in your ~/.bashrc or ~/.bash_profile like this => PS1='the_string'
+puts painting.prompt

data/lib/geek_painter.rb

@@ -1,12 +1,10 @@
 require 'geek_painter/escaping_tools'
-require 'geek_painter/string'
-require 'geek_painter/palette'
 require 'geek_painter/canvas'
 
 module GeekPainter
   def self.paint(&block)
-    @canvas = Canvas.new
-    @canvas.instance_eval(&block)
-    @canvas
+    canvas = Canvas.new
+    canvas.instance_eval(&block)
+    canvas
   end
 end

data/lib/geek_painter/canvas.rb

@@ -1,43 +1,68 @@
+require 'geek_painter/core-ext'
+
 module GeekPainter  
   #
-  # The main DSL, every single call to the "trace" method pushes the parameters to an array
+  # The main DSL, every single call to the "label" method pushes the parameters to an array
   # and "raw" method then joins the array to generate the actual string to be used in PS1 or wherever.
   #
   # ie. canvas = Canvas.new
-  #     canvas.trace "\\[\\033[33m\\]user:" => yellow text
-  #     canvas.trace "\\[\\033[34m\\]host" => blue text
+  #     canvas.label "\\[\\033[33m\\]user:" => yellow text
+  #     canvas.label "\\[\\033[34m\\]host" => blue text
   #     canvas.show => \\[\\033[33m\\]user:\\[\\033[34m\\]host => user:host
     
   class Canvas
     include EscapingTools
-  
+    
+    attr_reader :labels
+    
     def initialize
-      @traces = []
+      @labels = []
+    end
+
+    def label(string_color_pair)
+      @labels << string_color_pair
+    end
+    #for backwards compatibility with <= 0.1.1
+    alias :trace :label
+        
+    def prompt
+      render :for_prompt
+    end
+    
+    def text
+      render :for_text
     end
 
-    def trace(string)
-      add_trace(string)
-    end
-  
-    def raw
-      @traces << escape_char("0")
-      @traces.join("")
-    end
-  
-    def print_raw
-      puts ""
-      puts raw
-      puts ""
-      puts "copy the string above and put it in your ~/.bashrc or ~/.bash_profile like this => PS1='the_string'"
-    end
-  
-    def show
-      puts raw
-    end
-  
-    protected
-    def add_trace(trace)
-      @traces << trace
-    end  
+    def for_prompt
+      prompt.to_raw
+    end
+    
+    def for_text
+      text.to_raw
+    end
+     
+    def reset_color
+      @labels << ["", :default]
+    end
+    
+    private
+    def render(format=:for_text)
+      colored_labels = []
+      reset_color unless @labels.last[1] == :default if @labels.last
+      @labels.each do |t|
+        unless t[2]
+          background_color = :default
+        else
+          background_color = t[2]
+        end
+        
+        if t.is_a? Array
+          colored_labels << escape(t[0].to_s, t[1].to_fg_code, background_color.to_bg_code, format)
+        else
+          colored_labels << t
+        end
+      end
+      colored_labels.join ""     
+    end
   end
 end

data/lib/geek_painter/core-ext.rb

@@ -0,0 +1,72 @@
+module GeekPainter
+  #
+  # Extends String to help the DSL to be more readable
+  # adds an "in" method to specify the color of the text
+  # ie. "my_text".in :red
+  #
+  module RubyCoreExtensions
+
+    module String
+      def in(color_name)
+        [self, color_name]
+      end
+      
+      def to_raw
+        self.gsub("\e", "\\e")
+      end
+    end
+
+    module Symbol
+      def to_fg_code
+        case self
+        when :black         then '0;30'
+        when :dark_gray     then '1;30'
+        when :light_gray    then '1;37'
+        when :light_red     then '0;31'
+        when :red           then '1;31'
+        when :light_green   then '0;32'
+        when :green         then '1;32'
+        when :yellow        then '1;33'
+        when :brown         then '0;33'
+        when :light_blue    then '0;34'
+        when :blue          then '1;34'
+        when :light_magenta then '0;35'
+        when :magenta       then '1;35'
+        when :light_cyan    then '0;36'
+        when :cyan          then '1;36'
+        when :white         then '1;37'
+        when :default       then '0'
+        else '0'
+        end
+      end
+      
+      def to_bg_code
+        case self
+        when :black         then '40'
+        when :red           then '41'
+        when :green         then '42'
+        when :brown         then '43'
+        when :blue          then '44'
+        when :magenta       then '45'
+        when :cyan          then '46'
+        when :white          then '47'
+        when :default       then '0'
+        else '0'
+        end
+        
+      end
+    end
+  end
+end
+
+String.class_eval do
+  include GeekPainter::RubyCoreExtensions::String
+end
+
+Symbol.class_eval do
+  include GeekPainter::RubyCoreExtensions::Symbol
+end
+
+Array.class_eval do
+  alias :on <<
+end

data/lib/geek_painter/escaping_tools.rb

@@ -1,15 +1,43 @@
 module GeekPainter
+
+  #TODO: Refactor!!!!!
   module EscapingTools
-    def open_esc_char
-      "\\[\\033["
+    
+    def open_escape
+      '\['
     end
-  
-    def close_esc_char
-      "m\\]"    
+    
+    #con dos funciona para prompt, pero no para text
+    #con una funciona para text, pero no para prompt
+    def start_color
+      "\033["
     end
-  
-    def escape_char(char)
-      open_esc_char + char + close_esc_char
+    
+    def end_color
+      'm'
     end
+    
+    def end_escape
+      '\]'
+    end
+    
+    def escape(string, foreground_color_code, background_color_code, format)
+      color_delimiter = ";"
+      escaped_string = ''
+      
+      if background_color_code == '0'
+        color_delimiter = ""
+        background_color_code = ""
+      end
+      
+      if format == :for_prompt
+        escaped_string = open_escape + start_color + foreground_color_code + color_delimiter + background_color_code + end_color + end_escape + string
+      elsif format == :for_text
+        escaped_string = start_color + foreground_color_code + color_delimiter + background_color_code + end_color + string
+      end
+      
+      escaped_string
+    end
+
   end
 end

data/test/test_geek_painter.rb

@@ -1,7 +1,10 @@
 require 'helper'
 
 class TestGeekPainter < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+
+  context "Raf" do
+    should "write tests for his geek_painter gem" do
+      flunk "\n\n\nComing soon! ^_^\n\n\n"
+    end
   end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: geek_painter
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Rafael Magana
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-03 00:00:00 -06:00
+date: 2010-07-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -49,9 +52,8 @@ files:
 - geek_painter_client.rb
 - lib/geek_painter.rb
 - lib/geek_painter/canvas.rb
+- lib/geek_painter/core-ext.rb
 - lib/geek_painter/escaping_tools.rb
-- lib/geek_painter/palette.rb
-- lib/geek_painter/string.rb
 - test/helper.rb
 - test/test_geek_painter.rb
 has_rdoc: true
@@ -64,23 +66,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A very simple DSL to generate a colored shell prompt string to use in *nix OS terminals

data/lib/geek_painter/palette.rb

@@ -1,34 +0,0 @@
-module GeekPainter
-  #
-  # The palette of colors
-  #
-  class Palette
-    extend EscapingTools
-    def self.grab_escaped(color_name)
-      case color_name
-      when :black         then escape "0;30"
-      when :dark_gray     then escape "1;30"
-      when :light_gray    then escape "1;37"
-      when :red           then escape "0;31"
-      when :light_red     then escape "1;31"
-      when :green         then escape "0;32"
-      when :light_green   then escape "1;32"
-      when :yellow        then escape "1;33"
-      when :brown         then escape "0;33"
-      when :blue          then escape "0;34"
-      when :light_blue    then escape "1;34"
-      when :magenta       then escape "0;35"
-      when :light_magenta then escape "1;35"
-      when :cyan          then escape "0;36"
-      when :light_cyan    then escape "1;36;5"
-      when :white         then escape "1;37"
-      when :default       then escape "0"
-      end
-    end
-
-    private
-    def self.escape(color_code)
-      self.escape_char(color_code.to_s)
-    end  
-  end
-end

data/lib/geek_painter/string.rb

@@ -1,22 +0,0 @@
-#
-# Extend String to help the DSL to be more readable
-# adds a "in" method to specify the color of the text
-# ie. "my_text".in :red
-#
-module GeekPainter
-  module RubyCoreExtensions
-    module String
-      def in(color_name)
-        Palette.grab_escaped(color_name) + self.to_s
-      end
-
-      def reset
-        self + escape_char("0")
-      end
-    end
-  end
-end
-
-String.class_eval do
-  include GeekPainter::RubyCoreExtensions::String
-end