shiny 0.2.1 → 0.3.1

data/README.rdoc

@@ -41,6 +41,17 @@ Some other html effect examples:
   "overline".html.overline
   "line-through".html.line_through
 
+Some terminal helper examples: (include Shiny::Helpers)
+
+  say("green day?", :color => :green)
+  say("fail!", :type => :error)
+
+  log("for later") # default: logfile.log
+  log("there please", "myfile.log")
+
+  wrap("I'm not alone") # surrounded with the default: # char
+  wrap("Oh...", "*") # surrounded with the * char
+
 == Note on Patches/Pull Requests
 
 * Fork the project.

data/lib/shiny.rb

@@ -1,4 +1,5 @@
 require 'shiny/core_ext/string'
+require 'shiny/helpers'
 
 module Shiny
 end

data/lib/shiny/ansi.rb

@@ -1,9 +1,9 @@
 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.
+  # The ansi class serve a great list of color and a few format
+  # methods. To get an overview of all the generetad method, just look
+  # at the CODES hash
   #
-  # Some colors examples:
+  # Some color examples:
   #
   # puts "magenta".shell.magenta
   # puts "bold blue".shell.bold.blue
@@ -21,43 +21,43 @@ module Shiny
 
     # ansi escape sequences list
     CODES = {
-      'black'             =>   "\e[30m",
-      'red'               =>   "\e[31m",
-      'green'             =>   "\e[32m",
-      'yellow'            =>   "\e[33m",
-      'blue'              =>   "\e[34m",
-      'magenta'           =>   "\e[35m",
-      'cyan'              =>   "\e[36m",
-      'white'             =>   "\e[37m",
-      'bright_black'      =>   "\e[90m",
-      'bright_red'        =>   "\e[91m",
-      'bright_green'      =>   "\e[92m",
-      'bright_yellow'     =>   "\e[93m",
-      'bright_blue'       =>   "\e[94m",
-      'bright_magenta'    =>   "\e[95m",
-      'bright_cyan'       =>   "\e[96m",
-      'bright_white'      =>   "\e[97m",
-      'on_black'          =>   "\e[40m",
-      'on_red'            =>   "\e[41m",
-      'on_green'          =>   "\e[42m",
-      'on_yellow'         =>   "\e[43m",
-      'on_blue'           =>   "\e[44m",
-      'on_magenta'        =>   "\e[45m",
-      'on_cyan'           =>   "\e[46m",
-      'on_white'          =>   "\e[47m",
-      'on_bright_black'   =>  "\e[100m",
-      'on_bright_red'     =>  "\e[101m",
-      'on_bright_green'   =>  "\e[102m",
-      'on_bright_yellow'  =>  "\e[103m",
-      'on_bright_blue'    =>  "\e[104m",
-      'on_bright_magenta' =>  "\e[105m",
-      'on_bright_cyan'    =>  "\e[106m",
-      'on_bright_white'   =>  "\e[107m",
-      'reset'             =>    "\e[0m",
-      'bold'              =>    "\e[1m",
-      'underline'         =>    "\e[4m",
-      'negative'          =>    "\e[7m",
-      'blink'             =>    "\e[5m"
+      :black             =>   "\e[30m",
+      :red               =>   "\e[31m",
+      :green             =>   "\e[32m",
+      :yellow            =>   "\e[33m",
+      :blue              =>   "\e[34m",
+      :magenta           =>   "\e[35m",
+      :cyan              =>   "\e[36m",
+      :white             =>   "\e[37m",
+      :bright_black      =>   "\e[90m",
+      :bright_red        =>   "\e[91m",
+      :bright_green      =>   "\e[92m",
+      :bright_yellow     =>   "\e[93m",
+      :bright_blue       =>   "\e[94m",
+      :bright_magenta    =>   "\e[95m",
+      :bright_cyan       =>   "\e[96m",
+      :bright_white      =>   "\e[97m",
+      :on_black          =>   "\e[40m",
+      :on_red            =>   "\e[41m",
+      :on_green          =>   "\e[42m",
+      :on_yellow         =>   "\e[43m",
+      :on_blue           =>   "\e[44m",
+      :on_magenta        =>   "\e[45m",
+      :on_cyan           =>   "\e[46m",
+      :on_white          =>   "\e[47m",
+      :on_bright_black   =>  "\e[100m",
+      :on_bright_red     =>  "\e[101m",
+      :on_bright_green   =>  "\e[102m",
+      :on_bright_yellow  =>  "\e[103m",
+      :on_bright_blue    =>  "\e[104m",
+      :on_bright_magenta =>  "\e[105m",
+      :on_bright_cyan    =>  "\e[106m",
+      :on_bright_white   =>  "\e[107m",
+      :reset             =>    "\e[0m",
+      :bold              =>    "\e[1m",
+      :underline         =>    "\e[4m",
+      :negative          =>    "\e[7m",
+      :blink             =>    "\e[5m"
     }
 
     # list of available ansi colors
@@ -66,19 +66,22 @@ module Shiny
     # list of available ansi effects
     EFFECTS = ['bold', 'underline', 'negative', 'blink']
 
-    # generate instance methods
+    # Generate color instance methods
+    # See CODES for a list of the created methods
     CODES.each do |code, value|
-      next if code == 'reset'
-      reset = CODES['reset']
+      next if code == :reset
+      reset = CODES[:reset]
       class_eval <<-DEF
-        def #{code}
+        def #{code.to_s}
           @string = "#{value}" + @string + "#{reset}"
           self
         end
       DEF
     end
 
-    # remove all ansi escape sequences
+    # Remove all ansi escape sequences from the string
+    #
+    # @return [String] from ansi escape sequences cleaned
     def blank
       @string.gsub(/\e\[[0-9]+m/,'')
     end

data/lib/shiny/basic.rb

@@ -1,9 +1,15 @@
 module Shiny
   class Basic
+    # Object initializer
+    #
+    # @param [String] To assign to @string
     def initialize(string)
       @string = string
     end
 
+    # Object printer
+    #
+    # @return [String]
     def to_s
       @string
     end

data/lib/shiny/core_ext/string.rb

@@ -2,16 +2,22 @@ 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.
+# Extend the ruby core string class with ansi escape
+# sequences and html methods through two proxy methods
 class String
+
+  # Serves ansi escape sequence method through a new ansi object
+  #
+  # @return [Shiny::ANSI] a new object
   def ansi
     Shiny::ANSI.new(self)
   end
 
   alias shell ansi
 
+  # Serves ansi escape sequence method through a new html object
+  #
+  # @return [Shiny::HTML] a new object
   def html
     Shiny::HTML.new(self)
   end

data/lib/shiny/helpers.rb

@@ -0,0 +1,77 @@
+module Shiny
+  module Helpers
+    # Send a message to the $stdout stream
+    #
+    # @example Print a message
+    #   "Shiny.message('What is that?')" #=> "What is that?\n"
+    #
+    # @example Print message whitout linebreak
+    #   "Shiny.message('What is that?', :linebreak => false)" #=> "What is that?"
+    #
+    # @example Print message in red
+    #   "Shiny.message('red!', :color => :red)" #=> "\e[31mred!\e[0m\n"
+    #
+    # @example Print a success message
+    #   "Shiny.message('success', :type => :success)" #=> "\e[32msuccess\e[0m\n"
+    #
+    # @param [String] the message which should send to $stdout
+    # @option options [Boolean] :linebreak ('true')
+    # @option options [Symbol] :color ('white') The message color
+    # @option options [Symbol] :type The message type ':error' or ':success'
+    def say(message, options={})
+      options[:linebreak] = true unless options.has_key?(:linebreak)
+
+      message = message.ansi.send(options[:color]) if options[:color]
+      message = format(message, options[:type]) unless options[:color]
+      message = message.to_s + "\n" if options[:linebreak]
+
+      $stdout.print message
+    end
+
+    # Log a message in to a logfile
+    #
+    # @param [String] the message which should be logged into file
+    # @param [String] filename ('logfile.log') the name of the logile
+    def log(message, filename="logfile.log")
+      File.open(filename, "a+") do |f|
+        f << "#{Time.now}: #{message}\n"
+      end
+    end
+
+    # Send a linebreak to the $stdout stream
+    #
+    # @param [Integer] amount ('1') Amount of linebreaks
+    def linebreak(amount=1)
+      $stdout.print "\n" * amount
+    end
+
+    # Wrap a message with a special sign and send it to the $stdout stream
+    #
+    # @param [String] the message which should be wrapped
+    # @param [String] sign ('#') The character around the message
+    def wrap(message, sign="#")
+      sign = sign[0] if  sign.length > 1
+      around = sign * (message.length + 4) + "\n"
+
+      output = ""
+      output << around
+      output << "#{sign} #{message} #{sign}\n"
+      output << around
+
+      $stdout.print output
+    end
+
+  private
+
+    def format(message, type)
+      message = case type
+                when :error    ; message.ansi.send(:red)
+                when :success  ; message.ansi.send(:green)
+                else
+                  message
+                end
+      message.to_s
+    end
+  end
+end
+

data/lib/shiny/html.rb

@@ -1,63 +1,69 @@
 module Shiny
   class HTML < Basic
-    # the 17 w3c supported color names
-    # http://www.w3.org/TR/CSS21/syndata.html#value-def-color
+    # List of the 17 w3c supported color names
+    # @see 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;">'
+      :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;">'
     }
 
+    # HTML span begin tag
     SPAN_BEGIN = "<span>"
+
+    # HTML span end tag
     SPAN_END   = "</span>"
 
-    # generate html format instance methods
+    # Generate html format instance methods
+    # See FORMATS for a list of created methods
     FORMATS.each do |name, value|
       class_eval <<-DEF
-        def #{name}
+        def #{name.to_s}
           @string = '#{value}' + @string + '#{SPAN_END}'
           self
         end
       DEF
     end
 
-    # remove all html span format tags
+    # Remove all html span format tags
+    #
+    # @return [String] from span tags cleaned
     def blank
       @string.gsub(/(<span [^>]+>|<\/span>)/, '')
     end

data/spec/shiny_spec.rb

@@ -1,88 +1,76 @@
+# -*- coding: utf-8 -*-
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Shiny do
 
-  # overwrite for testing
-  class Shiny::Basic
-    def ==(string)
-      to_s == string
-    end
-  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 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.should == "\e[47m\e[31mred on white\e[0m\e[0m"
-    end
+  include Shiny::Helpers
 
-    it 'should return a bright blue string' do
-      "bright blue".shell.bright_blue.should == "\e[94mbright blue\e[0m"
+  describe "#say" do
+    it "should print string to the stdout stream" do
+      $stdout.should_receive(:print).with("hey dude!\n")
+      say("hey dude!")
     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"
+    it "should print string without a linebreak" do
+      $stdout.should_receive(:print).with("hey dude, no linebreak please")
+      say("hey dude, no linebreak please", :linebreak => false)
     end
 
-    it 'should return an underlined string' do
-      "underline".shell.underline.should == "\e[4munderline\e[0m"
+    it "should print the string as error formated"do
+      $stdout.should_receive(:print).with("\e[31mOh, there is an error!\e[0m\n")
+      say("Oh, there is an error!", :type => :error)
     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.should == "\e[7mnegative\e[0m"
-    end
-
-    it 'should return a blinking string' do
-      "blinking".shell.blink.should == "\e[5mblinking\e[0m"
+    it "should print the string as success formated"do
+      $stdout.should_receive(:print).with("\e[32mSuccessfully\e[0m\n")
+      say("Successfully", :type => :success)
     end
+  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"
+  describe "#linebreak" do
+    it "should print a linebreak" do
+      $stdout.should_receive(:print).with("\n")
+      linebreak
     end
 
-    it 'should run also with the alias method' do
-      "try the alias method".shell.red.should == "\e[31mtry the alias method\e[0m"
+    it "should print 3 linebreaks" do
+      $stdout.should_receive(:print).with("\n\n\n")
+      linebreak(3)
     end
   end
 
-  describe "#html" do
-    it 'should return a bold string' do
-      "bold".html.bold.should == '<span style="font-weight: bold;">bold</span>'
-    end
+  describe "#wrap" do
+    it "should print a wrapped string" do
+      output =  "#####################\n"
+      output += "# Hello I'm wrapped #\n"
+      output += "#####################\n"
 
-    it 'should return a underlined string' do
-      "underline".html.underline.should == '<span style="text-decoration: underline;">underline</span>'
+      $stdout.should_receive(:print).with(output)
+      wrap("Hello I'm wrapped")
     end
 
-    it 'should return a overlined string' do
-      "overline".html.overline.should == '<span style="text-decoration: overline;">overline</span>'
-    end
+    it "should print a wrapped string with other wrap sign" do
+      output =  "*********************\n"
+      output += "* Hello I'm wrapped *\n"
+      output += "*********************\n"
 
-    it 'should return a line-through string' do
-      "line-through".html.line_through.should == '<span style="text-decoration: line-through;">line-through</span>'
+      $stdout.should_receive(:print).with(output)
+      wrap("Hello I'm wrapped", "*")
     end
+  end
 
-    it 'should return a blinking string' do
-      "blink".html.blink.should == '<span style="text-decoration: blink;">blink</span>'
+  describe "#log" do
+    it "should log the message in a log file" do
+      log("please log me in!")
+      File.exists?("logfile.log").should == true
+      File.delete("logfile.log")
     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!"
+    it "should log the message to the 'mylogfile.log' file" do
+      log("Arrrr, another filename", "mylogfile.log")
+      File.exists?("mylogfile.log").should == true
+      File.delete("mylogfile.log")
     end
   end
-
 end
+

data/spec/string_spec.rb

@@ -0,0 +1,87 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe String do
+
+  # overwrite for testing
+  class Shiny::Basic
+    def ==(string)
+      to_s == string
+    end
+  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 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.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 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.should == "\e[4munderline\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.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 run also with the alias method' do
+      "try the alias method".shell.red.should == "\e[31mtry the alias method\e[0m"
+    end
+  end
+
+  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

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 1
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Samuel Tonini
@@ -14,10 +14,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-27 00:00:00 +02:00
+date: 2010-11-16 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id001
 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: []
@@ -30,10 +44,12 @@ files:
 - lib/shiny/ansi.rb
 - lib/shiny/basic.rb
 - lib/shiny/core_ext/string.rb
+- lib/shiny/helpers.rb
 - lib/shiny/html.rb
 - lib/shiny.rb
 - spec/shiny_spec.rb
 - spec/spec_helper.rb
+- spec/string_spec.rb
 - LICENSE
 - README.rdoc
 has_rdoc: true