shiny 0.1.1 → 0.2.0

data/README.rdoc

@@ -1,26 +1,45 @@
 = shiny
 
-Shiny gives you some common ansi escape sequences, which are available over a defined proxy method called 'shell', in the core ruby String class.
+Shiny extends the ruby core string class with two methods, ansi and html. These two are proxy methods to provide a bunch of color and text formating methods.
+Over ansi there are the commen known ansi escape sequences available, bold, blink, underline and the whole colorful format things. The method html serves the same but in the html way, it makes the
+standart w3c color names available and also a few other formats like overline, underline, blink etc.
 
-Some colors examples:
+== Installation
 
-  puts "magenta".shell.magenta
-  puts "bold blue".shell.bold.blue
-  puts "yellow on cyan".shell.yellow.on_cyan
-  puts "bright blue on green".shell.bright_blue.on_green
-  puts "red on bright blue".shell.red.on_bright_blue
+  $ gem install shiny
 
-Some other effect examples:
+== Usage
 
-  puts "bold".shell.bold
-  puts "oh! i'm blinking".shell.blink
-  puts "nice and underlined".shell.underline
-  puts "other side, please".shell.negative
+Some ansi color examples:
 
-Helpers to list available colors and effect methods (execute under terminal to see it in action)
+  puts "magenta".ansi.magenta
+  puts "bold blue".ansi.bold.blue
+  puts "yellow on cyan".ansi.yellow.on_cyan
+  puts "bright blue on green".ansi.bright_blue.on_green
+  puts "red on bright blue".ansi.red.on_bright_blue
 
-  Shiny.show_colors
-  Shiny.show_effects
+Some other ansi effect examples:
+
+  puts "bold".ansi.bold
+  puts "oh! i'm blinking".ansi.blink
+  puts "nice and underlined".ansi.underline
+  puts "other side, please".ansi.negative
+
+Some html color examples: (the html formats should be used in the browser ;)
+
+  "orange".html.orange
+  "bold red".html.bold.red
+  "yellow on olive".html.yellow.on_olive
+  "blue on teal".html.blue.on_teal
+  "fuchsia".html.fuchsia
+
+Some other html effect examples:
+
+  "bold".html.bold
+  "oh! i'm blinking".html.blink
+  "nice and underlined".html.underline
+  "overline".html.overline
+  "line-through".html.line_through
 
 == Note on Patches/Pull Requests
 

data/lib/shiny.rb

@@ -1,76 +1,4 @@
-require 'shiny/ansi'
+require 'shiny/core_ext/string'
 
-class Shiny
-
-  # Shiny gives you some common ansi escape sequences, which
-  # are available over a defined proxy method called 'shell', in
-  # the core ruby String class.
-  #
-  # Some colors examples:
-  #
-  # puts "magenta".shell.magenta
-  # puts "bold blue".shell.bold.blue
-  # puts "yellow on cyan".shell.yellow.on_cyan
-  # puts "bright blue on green".shell.bright_blue.on_green
-  # puts "red on bright blue".shell.red.on_bright_blue
-  #
-  # Some other effect examples:
-  #
-  # puts "bold".shell.bold
-  # puts "oh! i'm blinking".shell.blink
-  # puts "nice and underlined".shell.underline
-  # puts "other side, please".shell.negative
-  def initialize(string)
-    @string = string
-  end
-
-  ANSI::ESCAPE_SEQUENCES.each do |code, value|
-    next if code == 'reset'
-    reset = ANSI::ESCAPE_SEQUENCES['reset']
-    class_eval <<-DEF
-      def #{code}
-        @string = "#{value}" + @string + "#{reset}"
-        Shiny.new(@string)
-      end
-    DEF
-  end
-
-  def to_s
-    @string
-  end
-
-  def blank
-    @string.gsub(/\e\[[0-9]+m/,'')
-  end
-
-  # some helpers to see how shiny the ansi sequences are
-  class << self
-    def colors
-      ANSI::COLORS
-    end
-
-    def effects
-      ANSI::EFFECTS
-    end
-
-    def show_colors
-      ANSI::COLORS.each do |color|
-        [color, "bright_#{color}", "on_#{color}", "on_bright_#{color}"].each do |code|
-          $stdout.puts ANSI::ESCAPE_SEQUENCES[code] + code + ANSI::ESCAPE_SEQUENCES['reset']
-        end
-      end
-      $stdout.flush
-    end
-
-    def show_effects
-      ANSI::EFFECTS.each do |code|
-        $stdout.puts ANSI::ESCAPE_SEQUENCES[code] + code + ANSI::ESCAPE_SEQUENCES['reset']
-      end
-      $stdout.flush
-    end
-  end
-end
-
-class String
-  def shell; Shiny.new(self); end
+module Shiny
 end

data/lib/shiny/ansi.rb

@@ -1,5 +1,26 @@
-module ANSI
-  ESCAPE_SEQUENCES = {
+module Shiny
+  # Shiny::ANSI gives you some common ansi escape sequences, which
+  # are available over a defined proxy method called 'shell', in
+  # the core ruby String class.
+  #
+  # Some colors examples:
+  #
+  # puts "magenta".shell.magenta
+  # puts "bold blue".shell.bold.blue
+  # puts "yellow on cyan".shell.yellow.on_cyan
+  # puts "bright blue on green".shell.bright_blue.on_green
+  # puts "red on bright blue".shell.red.on_bright_blue
+  #
+  # Some other effect examples:
+  #
+  # puts "bold".shell.bold
+  # puts "oh! i'm blinking".shell.blink
+  # puts "nice and underlined".shell.underline
+  # puts "other side, please".shell.negative
+  class ANSI < Basic
+
+    # ansi escape sequences list
+    CODES = {
       'black'             =>   "\e[30m",
       'red'               =>   "\e[31m",
       'green'             =>   "\e[32m",
@@ -37,8 +58,29 @@ module ANSI
       'underline'         =>    "\e[4m",
       'negative'          =>    "\e[7m",
       'blink'             =>    "\e[5m"
-  }
+    }
+
+    # list of available ansi colors
+    COLORS  = ['black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white']
+
+    # list of available ansi effects
+    EFFECTS = ['bold', 'underline', 'negative', 'blink']
+
+    # generate instance methods
+    CODES.each do |code, value|
+      next if code == 'reset'
+      reset = CODES['reset']
+      class_eval <<-DEF
+        def #{code}
+          @string = "#{value}" + @string + "#{reset}"
+          self
+        end
+      DEF
+    end
 
-  COLORS  = ['black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white']
-  EFFECTS = ['bold', 'underline', 'negative', 'blink']
+    # remove all ansi escape sequences
+    def blank
+      @string.gsub(/\e\[[0-9]+m/,'')
+    end
+  end
 end

data/lib/shiny/basic.rb

@@ -0,0 +1,11 @@
+module Shiny
+  class Basic
+    def initialize(string)
+      @string = string
+    end
+
+    def to_s
+      @string
+    end
+  end
+end

data/lib/shiny/core_ext/string.rb

@@ -0,0 +1,20 @@
+require 'shiny/basic'
+require 'shiny/ansi'
+require 'shiny/html'
+
+# instead to extend the ruby core string class with all the ansi
+# escape and html methods, there are two proxy methods called ansi and
+# html, to serve all the functionality.
+class String
+  def ansi
+    Shiny::ANSI.new(self)
+  end
+
+  alias shell ansi
+
+  def html
+    Shiny::HTML.new(self)
+  end
+
+  alias browser html
+end

data/lib/shiny/html.rb

@@ -0,0 +1,65 @@
+module Shiny
+  class HTML < Basic
+    # the 17 w3c supported color names
+    # http://www.w3.org/TR/CSS21/syndata.html#value-def-color
+    FORMATS = {
+      'black'        => "<span style='color: black;'>",
+      'silver'       => "<span style='color: silver;'>",
+      'gray'         => "<span style='color: gray;'>",
+      'white'        => "<span style='color: white;'>",
+      'maroon'       => "<span style='color: maroon;'>",
+      'red'          => "<span style='color: red;'>",
+      'purple'       => "<span style='color: purple;'>",
+      'fuchsia'      => "<span style='color: fuchsia;'>",
+      'green'        => "<span style='color: green;'>",
+      'lime'         => "<span style='color: lime;'>",
+      'olive'        => "<span style='color: olive;'>",
+      'yellow'       => "<span style='color: yellow;'>",
+      'navy'         => "<span style='color: navy;'>",
+      'blue'         => "<span style='color: blue;'>",
+      'teal'         => "<span style='color: teal;'>",
+      'aqua'         => "<span style='color: aqua;'>",
+      'orange'       => "<span style='color: orange;'>",
+      'on_black'     => "<span style='background-color: black;'>",
+      'on_silver'    => "<span style='background-color: silver;'>",
+      'on_gray'      => "<span style='background-color: gray;'>",
+      'on_white'     => "<span style='background-color: white;'>",
+      'on_maroon'    => "<span style='background-color: maroon;'>",
+      'on_red'       => "<span style='background-color: red;'>",
+      'on_purple'    => "<span style='background-color: purple;'>",
+      'on_fuchsia'   => "<span style='background-color: fuchsia;'>",
+      'on_green'     => "<span style='background-color: green;'>",
+      'on_lime'      => "<span style='background-color: lime;'>",
+      'on_olive'     => "<span style='background-color: olive;'>",
+      'on_yellow'    => "<span style='background-color: yellow;'>",
+      'on_navy'      => "<span style='background-color: navy;'>",
+      'on_blue'      => "<span style='background-color: blue;'>",
+      'on_teal'      => "<span style='background-color: teal;'>",
+      'on_aqua'      => "<span style='background-color: aqua;'>",
+      'on_orange'    => "<span style='background-color: orange;'>",
+      'bold'         => "<span style='font-weight: bold;'>",
+      'underline'    => "<span style='text-decoration: underline;'>",
+      'overline'     => "<span style='text-decoration: overline;'>",
+      'line_through' => "<span style='text-decoration: line-through;'>",
+      'blink'        => "<span style='text-decoration: blink;'>"
+    }
+
+    SPAN_BEGIN = "<span>"
+    SPAN_END   = "</span>"
+
+    # generate html format instance methods
+    FORMATS.each do |name, value|
+      class_eval <<-DEF
+        def #{name}
+          @string = "#{value}" + @string + "#{SPAN_END}"
+          self
+        end
+      DEF
+    end
+
+    # remove all html span format tags
+    def blank
+      @string.gsub(/(<span [^>]+>|<\/span>)/, '')
+    end
+  end
+end

data/spec/shiny_spec.rb

@@ -3,54 +3,86 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 describe Shiny do
 
   # overwrite for testing
-  class Shiny
+  class Shiny::Basic
     def ==(string)
       to_s == string
     end
   end
 
-  it 'should return a green string' do
-    "green".shell.green.should == "\e[32mgreen\e[0m"
-  end
+  describe "#ansi" do
+    it 'should return a green string' do
+      "green".shell.green.should == "\e[32mgreen\e[0m"
+    end
 
-  it 'should return an on yellow string' do
-    "on yellow".shell.on_yellow.should == "\e[43mon yellow\e[0m"
-  end
+    it 'should return an on yellow string' do
+      "on yellow".shell.on_yellow.should == "\e[43mon yellow\e[0m"
+    end
 
-  it 'should return an on bright magenta string' do
-    "on bright magenta".shell.on_bright_magenta == "\e[105mon bright magenta\e[0m"
-  end
+    it 'should return an on bright magenta string' do
+      "on bright magenta".shell.on_bright_magenta.should == "\e[105mon bright magenta\e[0m"
+    end
 
-  it 'should return a red on white string' do
-    "red on white".shell.red.on_white == "\e[47m\e[31mred on white\e[0m\e[0m"
-  end
+    it 'should return a red on white string' do
+      "red on white".shell.red.on_white.should == "\e[47m\e[31mred on white\e[0m\e[0m"
+    end
 
-  it 'should return a bright blue string' do
-    "bright blue".shell.bright_blue.should == "\e[94mbright blue\e[0m"
-  end
+    it 'should return a bright blue string' do
+      "bright blue".shell.bright_blue.should == "\e[94mbright blue\e[0m"
+    end
 
-  it 'should return a black on bright green string' do
-    "black on bright green".shell.black.on_bright_green.should == "\e[102m\e[30mblack on bright green\e[0m\e[0m"
-  end
+    it 'should return a black on bright green string' do
+      "black on bright green".shell.black.on_bright_green.should == "\e[102m\e[30mblack on bright green\e[0m\e[0m"
+    end
 
-  it 'should return an underlined string' do
-    "underline".shell.underline == "\e[4munderline\e[0m"
-  end
+    it 'should return an underlined string' do
+      "underline".shell.underline.should == "\e[4munderline\e[0m"
+    end
 
-  it 'should return a bold string' do
-    "bold".shell.bold == "\e[1mbold\e[0m"
-  end
+    it 'should return a bold string' do
+      "bold".shell.bold.should == "\e[1mbold\e[0m"
+    end
 
-  it 'should return a negative string' do
-    "negative".shell.negative == "\e[7mnegative\e[0m"
-  end
+    it 'should return a negative string' do
+      "negative".shell.negative.should == "\e[7mnegative\e[0m"
+    end
+
+    it 'should return a blinking string' do
+      "blinking".shell.blink.should == "\e[5mblinking\e[0m"
+    end
+
+    it 'should clear all ansi escape sequences from string' do
+      "\e[47m\e[31mred on white\e[0m\e[0m".shell.blank.should == "red on white"
+    end
 
-  it 'should return a blinking string' do
-    "blinking".shell.blink == "\e[5mblinking\e[0m"
+    it 'should run also with the alias method' do
+      "try the alias method".shell.red.should == "\e[31mtry the alias method\e[0m"
+    end
   end
 
-  it 'should clear all ansi escape sequences from string' do
-    "\e[47m\e[31mred on white\e[0m\e[0m".shell.blank == "red on white"
+  describe "#html" do
+    it 'should return a bold string' do
+      "bold".html.bold.should == "<span style='font-weight: bold;'>bold</span>"
+    end
+
+    it 'should return a underlined string' do
+      "underline".html.underline.should == "<span style='text-decoration: underline;'>underline</span>"
+    end
+
+    it 'should return a overlined string' do
+      "overline".html.overline.should == "<span style='text-decoration: overline;'>overline</span>"
+    end
+
+    it 'should return a line-through string' do
+      "line-through".html.line_through.should == "<span style='text-decoration: line-through;'>line-through</span>"
+    end
+
+    it 'should return a blinking string' do
+      "blink".html.blink.should == "<span style='text-decoration: blink;'>blink</span>"
+    end
+
+    it 'should clear all html formats from string' do
+      "<span style='font-weight: bold;'>i'm blank now!</span>".html.blank.should == "i'm blank now!"
+    end
   end
 
 end

data/spec/spec_helper.rb

@@ -1,9 +1,3 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'shiny'
-require 'spec'
-require 'spec/autorun'
 
-Spec::Runner.configure do |config|
-  
-end
+require 'shiny'

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: shiny
 version: !ruby/object:Gem::Version 
-  hash: 25
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Samuel Tonini
@@ -15,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-21 00:00:00 +02:00
+date: 2010-10-25 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
-description: "  Shiny gives you some common ansi escape sequences, which\n  are available over a defined proxy method called 'shell', in\n  the core ruby String class.\n\n  Some colors examples:\n\n  puts \"magenta\".shell.magenta\n  puts \"bold blue\".shell.bold.blue\n  puts \"yellow on cyan\".shell.yellow.on_cyan\n  puts \"bright blue on green\".shell.bright_blue.on_green\n  puts \"red on bright blue\".shell.red.on_bright_blue\n\n  Some other effect examples:\n\n  puts \"bold\".shell.bold\n  puts \"oh! i'm blinking\".shell.blink\n  puts \"nice and underlined\".shell.underline\n  puts \"other side, please\".shell.negative\n"
+description: Some common nice and shiny ansi escapse sequences and html format tags for the daily grind in the shell and browser.
 email: tonini.samuel@gmail.com
 executables: []
 
@@ -29,9 +28,11 @@ extra_rdoc_files: []
 
 files: 
 - lib/shiny/ansi.rb
+- lib/shiny/basic.rb
+- lib/shiny/core_ext/string.rb
+- lib/shiny/html.rb
 - lib/shiny.rb
 - spec/shiny_spec.rb
-- spec/spec.opts
 - spec/spec_helper.rb
 - LICENSE
 - Rakefile
@@ -50,7 +51,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -59,7 +59,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 19
       segments: 
       - 1
       - 3
@@ -71,6 +70,6 @@ rubyforge_project: shiny
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: some common nice and shiny ansi escapse sequences for the daily grind in the shell
+summary: Shiny ansi and html format methods.
 test_files: []
 

data/spec/spec.opts

@@ -1 +0,0 @@
---color