cape-cod 0.1.0

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fuad Saud
+
+MIT License
+
+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.md

@@ -0,0 +1,65 @@
+cape-cod
+========
+
+
+[![Build Status](https://travis-ci.org/fuadsaud/cape-cod.png?branch=master)]
+(https://travis-ci.org/fuadsaud/cape-cod)
+
+cape-cod makes it easy for you to append ANSI es<strong>CAPE-COD</strong>es - HAR! bet you didn't see
+that coming; I know, I know, I'm a genius - to you strings.
+
+### *Hey, but don't we have a plenty of gems that do exactly the same thing?*
+
+**YES**. We can cite [colored](http://github.com/defunkt/colored) - by @defunkt -,
+[colorize](http://github.com/fazibear/colorize) - by @fazibear -,
+[term-ansicolor](http://github.com/flori/term-ansicolor), and so on...
+They are really nice gems, and they solve the escape code problem in different manners
+but they're all abandoned, some accumulating 3 years old issues.
+
+My point with this gem is to implement many of the possible ways of appending ANSI escape
+codes to strings (monkey patching, blocks, etc) and let the user choose whatever he likes.
+I for instance prefer the colored's monkey patch approach, but for some people it
+doesn't suit, so other options should be offered.
+
+Please contribute!
+
+## Installation
+
+Add this line to your applications's gemfile:
+
+```gem 'cape-cod'```
+
+then run:
+
+```bundle```
+
+or simply:
+
+```gem install cape-cod```
+
+## Usage
+
+```require 'cap-cod'```
+
+You can include cape-cod in you String class:
+
+```
+  class String; include CapeCod end
+
+  puts 'Praise R'hlor, for the night is dark and full of terrors'.red
+```
+
+or use it like this:
+
+```
+  puts CapeCod.yellow('We all live in a yellow submarine!')
+```
+
+
+## Contributing
+
+Check the guidelines at [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+Please refer to [LICENSE.md](LICENSE.md).

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+desc 'Start an irb session with cape-cod loaded'
+task :console do
+  if `which pry`.empty?
+    system('irb -rubygems --require ./lib/cape-cod.rb')
+  else
+    system('pry --require ./lib/cape-cod.rb')
+  end
+end
+
+desc 'run all specs'
+task default: :spec

data/lib/cape-cod/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module CapeCod
+  VERSION = '0.1.0'
+end

data/lib/cape-cod.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift File.expand_path(
+  File.join(File.dirname(__FILE__), '../lib'))
+
+module CapeCod
+
+  require 'cape-cod/version'
+
+  ESCAPE_CODES = {
+    reset:          0,
+    bold:           1,
+    dark:           2,
+    italic:         3,
+    underline:      4,
+    blink:          5,
+    rapid_blink:    6,
+    negative:       7,
+    concealed:      8,
+    strikethrough:  9,
+
+    # Foreground color
+    black:         30,
+    red:           31,
+    green:         32,
+    yellow:        33,
+    blue:          34,
+    magenta:       35,
+    cyan:          36,
+    white:         37,
+
+    # Background color
+    on_black:      40,
+    on_red:        41,
+    on_green:      42,
+    on_yellow:     43,
+    on_blue:       44,
+    on_magenta:    45,
+    on_cyan:       46,
+    on_white:      47,
+    }.freeze
+
+  #
+  # Define helper methods for applying the escape codes
+  #
+  ESCAPE_CODES.each do |code, _|
+    define_method code do
+      CapeCod.apply_escape_sequence(code, self)
+    end
+
+    define_singleton_method code do |obj = '', &block|
+      string = obj.to_s
+      return CapeCod.escape_sequence_for(code) if string.empty? unless block
+
+      string += block.call if block
+
+      CapeCod.apply_escape_sequence(code, string)
+    end
+  end
+
+  private
+
+  #
+  # Returns the ANSI escape sequence for a given escape +code+.
+  #
+  def self.escape_sequence_for(code)
+    "\e[#{ESCAPE_CODES.fetch(code)}m"
+  end
+
+  #
+  # Prepends the given +string+ with the ANSI escape sequence for the given
+  # escape +code+ and append a reset sequence.
+  #
+  def self.apply_escape_sequence(code, string)
+    sequence = escape_sequence_for(code)
+
+    return sequence unless string
+
+    sequence << string << escape_sequence_for(:reset)
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: cape-cod
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Fuad Saud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make your strings look fancy with ANSI escape codes.
+email: fuadksd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- LICENSE.md
+- lib/cape-cod/version.rb
+- lib/cape-cod.rb
+homepage: http://github.com/fuadsaud/cape-cod
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Make your strings look fancy with ANSI escape codes.
+test_files: []
+has_rdoc: false