shiny 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Samuel Tonini
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,37 @@
+= 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
+
+Helpers to list available colors and effect methods (execute under terminal to see it in action)
+
+  Shiny.show_colors
+  Shiny.show_effects
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (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.
+
+== Copyright
+
+Copyright (c) 2010 Samuel Tonini. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+spec_files = Rake::FileList["spec/**/*_spec.rb"]
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = spec_files
+  t.spec_opts = ["-c"]
+end
+
+task :default => :spec

data/lib/shiny.rb

@@ -0,0 +1,76 @@
+require 'lib/shiny/ansi'
+
+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
+end

data/lib/shiny/ansi.rb

@@ -0,0 +1,44 @@
+module ANSI
+  ESCAPE_SEQUENCES = {
+      '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"
+  }
+
+  COLORS  = ['black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white']
+  EFFECTS = ['bold', 'underline', 'negative', 'blink']
+end

data/spec/shiny_spec.rb

@@ -0,0 +1,56 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Shiny do
+
+  # overwrite for testing
+  class Shiny
+    def ==(string)
+      to_s == string
+    end
+  end
+
+  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 == "\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 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 == "\e[4munderline\e[0m"
+  end
+
+  it 'should return a bold string' do
+    "bold".shell.bold == "\e[1mbold\e[0m"
+  end
+
+  it 'should return a negative string' do
+    "negative".shell.negative == "\e[7mnegative\e[0m"
+  end
+
+  it 'should return a blinking string' do
+    "blinking".shell.blink == "\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 == "red on white"
+  end
+
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$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

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: shiny
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Samuel Tonini
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-21 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"
+email: tonini.samuel@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/shiny/ansi.rb
+- lib/shiny.rb
+- spec/shiny_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- LICENSE
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/zastav/shiny
+licenses: []
+
+post_install_message: 
+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: 19
+      segments: 
+      - 1
+      - 3
+      - 4
+      version: 1.3.4
+requirements: []
+
+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
+test_files: []
+