clive 0.6.1 → 0.6.2

data/README.md

@@ -1,6 +1,7 @@
 # clive
 
-Clive is a DSL for creating a command line interface. It is for people who, like me, love [OptionParser's](http://ruby-doc.org/stdlib/libdoc/optparse/rdoc/classes/OptionParser.html) syntax and love [GLI's](http://github.com/davetron5000/gli) commands.
+Clive is a DSL for creating a command line interface. It is for people who, like me, 
+love [OptionParser's](http://ruby-doc.org/stdlib/libdoc/optparse/rdoc/classes/OptionParser.html) syntax and love [GLI's](http://github.com/davetron5000/gli) commands.
 
 ## Install
 
@@ -22,7 +23,8 @@ A simple example to start:
     c.parse(ARGV)
     p opts
 
-This creates a very simple interface which can have one switch, you can then use the long or short form to call the block.
+This creates a very simple interface which can have one switch, you can then use the 
+long or short form to call the block.
 
     my_file -v
     #=> {:verbose => true}
@@ -32,11 +34,14 @@ This creates a very simple interface which can have one switch, you can then use
 
 ### Switches
 
-As we've seen above switches are created using #switch. You can provide as little information as you want. `switch(:v) {}` creates a switch that responds only to `-v`, or `switch(:verbose) {}` creates a switch that only responds to `--verbose`.
+As we've seen above switches are created using #switch. You can provide as little 
+information as you want. `switch(:v) {}` creates a switch that responds only to 
+`-v`, or `switch(:verbose) {}` creates a switch that only responds to `--verbose`.
 
 ### Boolean
 
-Boolean switches allow you to accept arguments like `--no-verbose` and `--verbose`, and deal with both situations in the same block.
+Boolean switches allow you to accept arguments like `--no-verbose` and `--verbose`, 
+and deal with both situations in the same block.
 
     c = Clive.new do
       bool(:v, :verbose) {|i| p i}
@@ -52,7 +57,9 @@ Boolean switches allow you to accept arguments like `--no-verbose` and `--verbos
     my_file --no-verbose
     #=> false
 
-As you can see the true case can be triggered with the short or long form, the false case can be triggered by appending "no-" to the long form, and it can't be triggered with a short form.
+As you can see the true case can be triggered with the short or long form, the false 
+case can be triggered by appending "no-" to the long form, and it can't be triggered 
+with a short form.
 
 ### Flags
 
@@ -74,8 +81,11 @@ Flags are like switches but also take an argument:
     my_file -p short
     #=> "short"
 
-The argument is then passed into the block. As you can see you can use short, long, equals, or no equals to call flags. As with switches you can call `flag(:p) {|i| ...}` which responds to `-p ...`, `flag(:print) {|i| ...}` which responds to `--print ...` or `--print=...`.
-Flags can have default values, for that situation put square brackets round the argument name.
+The argument is then passed into the block. As you can see you can use short, long, 
+equals, or no equals to call flags. As with switches you can call `flag(:p) {|i| ...}` 
+which responds to `-p ...`, `flag(:print) {|i| ...}` which responds to `--print ...` 
+or `--print=...`. Flags can have default values, for that situation put square brackets 
+round the argument name.
 
     flag(:p, :print, "[ARG]", "Print ARG or "hey" by default) do |i|
       i ||= "hey"
@@ -101,12 +111,15 @@ Commands work like in git, here's an example:
     my_file add -r Clive
     #=> {:add => {:lib => "Clive"}}
 
-Commands make it easy to group flags, switches and even other commands. The block for the command is executed on finding the command, this allows you to put other code within the block specific for the command, as shown above.
+Commands make it easy to group flags, switches and even other commands. The block for 
+the command is executed on finding the command, this allows you to put other code within 
+the block specific for the command, as shown above.
 
 
 ### Arguments
 
-Anything that isn't a command, switch or flag is taken as an argument. These are returned by #parse as an array. 
+Anything that isn't a command, switch or flag is taken as an argument. These are returned 
+by #parse as an array. 
     
     opts = {}
     c = Clive.new do
@@ -123,7 +136,8 @@ Anything that isn't a command, switch or flag is taken as an argument. These are
 
 ### Error Handling
 
-You are able to intercept errors when an option does not exist in a similar way to `method_missing`.
+You are able to intercept errors when an option does not exist in a similar way to 
+`method_missing`.
 
     c = Clive.new do
       option_missing do |name|
@@ -133,7 +147,9 @@ You are able to intercept errors when an option does not exist in a similar way
     c.parse("--hey")
     #=> hey was used but not defined
 
-I was hoping to provide a similar way of intercepting commands as well but these could also be arguments which means it could result in unexpected results. For this reason I will not be implementing `command_missing`.
+I was hoping to provide a similar way of intercepting commands as well but these could 
+also be arguments which means it could result in unexpected results. For this reason I 
+will not be implementing `command_missing`.
 
 ### Putting It All Together
 
@@ -176,6 +192,42 @@ I was hoping to provide a similar way of intercepting commands as well but these
     #=> {:verbose => true, :add => {:framework => ["blueprint"], :min => true, :width => 200}}
     #=> ["~/Desktop/new_thing", "~/Desktop/another_thing"]
 
+ 
+## Clive::Output
+
+This is a new bit that allows you to colorize output from the command line, by patching a 
+few methods onto String.
+
+    require 'clive/output'
+    # or require 'clive'
+    
+    puts "I'm blue".blue  # will print blue text
+    puts "I'm red".red    # will print red text
+    puts "I'm green and bold".green.bold   # will print green and bold text
+    puts "Crazy".blue.l_yellow_bg.underline
+    # etc
+
+Methods available are:
+ - bold
+ - underline
+ - blink
+ - reverse
+ 
+ - white
+ - green
+ - red
+ - magenta
+ - yellow
+ - blue
+ - cyan
+ - black (light version called grey not l_black)
+ 
+ - + light versions of colours using l_colour)
+ - + background setters using colour_bg
+ - + light background using l_colour_bg
+
+    
+
 ## Note on Patches/Pull Requests
  
 * Fork the project.

data/lib/clive/output.rb

@@ -35,22 +35,56 @@ class String
     "#{code}#{self}\e[0m"
   end
   
-  {
-    "bold"      => "1",
-    "underline" => "4",
-    "blink"     => "5",
-    "white"     => "37",
-    "green"     => "32",
-    "red"       => "31",
-    "magenta"   => "35",
-    "yellow"    => "33",
-    "blue"      => "34",
-    "grey"      => "90"
-  }.each do |name, code|
-    define_method(name) do
+  COLOURS = {
+    "black"   => 0,
+    "red"     => 1,
+    "green"   => 2,
+    "yellow"  => 3,
+    "blue"    => 4,
+    "magenta" => 5,
+    "cyan"    => 6,
+    "white"   => 7
+  }
+  
+  ATTRIBUTES = {
+    "bold"      => 1,
+    "underline" => 4,
+    "blink"     => 5,
+    "reverse"   => 7
+  }
+  
+  ATTRIBUTES.each do |name, code|
+    define_method name do
       colour("\e[#{code}m")
     end
   end
+  
+  COLOURS.each do |name, code|
+    define_method name do
+      colour("\e[3#{code}m")
+    end
+    
+    define_method "#{name}_bg" do
+      colour("\e[4#{code}m")
+    end
+    
+    # Light white doesn't exist
+    unless name == "white"
+      # Change name to grey instead of l_black
+      _name = "l_#{name}"
+      if name == "black"
+        _name = "grey"
+      end
+      
+      define_method "#{_name}" do
+        colour("\e[9#{code}m")
+      end
+      
+      define_method "#{_name}_bg" do
+        colour("\e[10#{code}m")
+      end
+    end
+  end
 
 end
 

data/lib/clive/version.rb

@@ -0,0 +1,3 @@
+class Clive
+  VERSION = '0.6.2'
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 6
-  - 1
-  version: 0.6.1
+  - 2
+  version: 0.6.2
 platform: ruby
 authors: 
 - Joshua Hawxwell
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-20 00:00:00 +00:00
+date: 2010-12-21 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -40,6 +40,7 @@ files:
 - lib/clive/parser.rb
 - lib/clive/switch.rb
 - lib/clive/tokens.rb
+- lib/clive/version.rb
 - lib/clive.rb
 has_rdoc: false
 homepage: http://github.com/hawx/clive