cape-cod 0.1.1 → 0.1.2

data/README.md

@@ -65,10 +65,11 @@ or use it like this:
 
 All the public instance methods are available as module methods.
 
+## License
+
+Please refer to [LICENSE.md](LICENSE.md).
+
 ## Contributing
 
 Check the guidelines at [CONTRIBUTING.md](CONTRIBUTING.md).
 
-## License
-
-Please refer to [LICENSE.md](LICENSE.md).

data/lib/cape-cod.rb

@@ -6,6 +6,7 @@ $LOAD_PATH.unshift File.expand_path(
 module CapeCod
 
   require 'cape-cod/version'
+  require 'cape-cod/color'
 
   @enabled = STDOUT.tty?
 
@@ -22,21 +23,10 @@ module CapeCod
     strikethrough: 9
   }.freeze
 
-  COLORS = {
-    black:    0,
-    red:      1,
-    green:    2,
-    yellow:   3,
-    blue:     4,
-    magenta:  5,
-    cyan:     6,
-    white:    7,
-  }.freeze
-
   #
   # Define helper methods for applying the escape codes.
   #
-  COLORS.each do |color, _|
+  Color::CODES.each do |color, _|
 
     #
     # Instance methods for background and foreground colors.
@@ -128,7 +118,7 @@ module CapeCod
     # Returns the ANSI escape sequence for the given +color+.
     #
     def color_code_for(color, ground)
-      COLORS.fetch(color) + (ground == :foreground ? 30 : 40)
+      Color.new(color, ground).ansi_code
     end
 
     #

data/lib/cape-cod/color.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+
+module CapeCod
+  class Color
+
+    #
+    # The ANSI color codes.
+    #
+    CODES = {
+      black:    0,
+      red:      1,
+      green:    2,
+      yellow:   3,
+      blue:     4,
+      magenta:  5,
+      cyan:     6,
+      white:    7,
+    }.freeze
+
+    #
+    # Returns the ANSI domain code for the given RGB color packed
+    # into an Integer.
+    #
+    def self.hex_to_ansi(hex)
+      (6 * ((hex >> 16 & 0xff) / 256.0)).to_i * 36 +
+      (6 * ((hex >>  8 & 0xff) / 256.0)).to_i *  6 +
+      (6 * ((hex       & 0xff) / 256.0)).to_i
+    end
+
+    #
+    # Initializes a the color.
+    #
+    # +color+ may be either a single Integer representation of a RGB
+    # color, a Symbol with the color name (valid color names are listed
+    # in the COLORS hash), or three integers representing the RGB channels.
+    # +ground+ is either :background or :foreground.
+    #
+    def initialize(*color, ground)
+      unless [:foreground, :background].include? ground
+        raise ArgumentError, 'color must be either foreground or background.'
+      end
+
+      if color.empty? || color.size > 3 || color.size == 2
+        raise ArgumentError,
+                      "wrong number of arguments (#{color.size + 1} for 2|4)."
+      elsif color.size == 3
+        color = [(color[0] << 16) | (color[1] << 8) | color[2]]
+      elsif color.first.is_a?(Integer) && color.first < 0
+        raise ArgumentError, 'hex code must be positive.'
+      elsif color.first.is_a?(Symbol) && !CODES.has_key?(color.first)
+        raise ArgumentError, %(invalid color name "#{color.first}".)
+      end
+
+      @ground = ground
+      @color  = color.first
+    end
+
+    #
+    # Returns a string representing the ANSI escape code for this color.
+    #
+    def ansi_code
+      case @color
+      when Symbol  then code_from_name
+      when Integer then code_from_hex
+      end
+    end
+
+    private
+
+    def code_from_name
+      CODES[@color].+(@ground == :foreground ? 30 : 40).to_s
+    end
+
+    def code_from_hex
+      ground_code = @ground == :foreground ? 38 : 48
+      color_code  = self.class.hex_to_ansi(@color)
+
+      "#{ground_code};5;#{color_code}"
+    end
+  end
+end

data/lib/cape-cod/version.rb

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

data/spec/cape-cod/color_spec.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe CapeCod do
+  describe CapeCod::Color do
+    context 'when instantiated with valid args' do
+      it 'produces proper color representation' do
+        color_from_symbol = CapeCod::Color.new(:yellow, :foreground).ansi_code
+        color_from_hex = CapeCod::Color.new(0xffff00, :foreground).ansi_code
+        color_from_rgb = CapeCod::Color.new(255, 255, 0, :foreground).ansi_code
+
+        expect(color_from_symbol).to eql '33'
+        expect(color_from_hex).to eql '38;5;210'
+        expect(color_from_rgb).to eql '38;5;210'
+      end
+    end
+
+    context 'when instantiated with invalid args' do
+      it 'fails initialization' do
+        expect {
+          CapeCod::Color.new(:not_a_color, :foreground).ansi_code
+        }.to raise_error(ArgumentError)
+
+        expect {
+          CapeCod::Color.new(:yellow, :not_a_ground).ansi_code
+        }.to raise_error(ArgumentError)
+
+        expect {
+          CapeCod::Color.new(155, 155, :foreground).ansi_code
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/cape-cod_spec.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe CapeCod do
+  it('has a version') { expect(CapeCod::VERSION).to be_a String }
+
+  context 'when disabled' do
+    before do
+      class String; include CapeCod end
+
+      CapeCod.enabled = false
+    end
+
+    it 'does nothing' do
+      expect(CapeCod.bold).to be_empty
+      expect(CapeCod.red('some text')).to eql('some text')
+      expect('some text'.red.bold.fx(:italic).bg(:cyan)).to eql('some text')
+    end
+  end
+
+  context 'when enabled' do
+    before(:all) do CapeCod.enabled = true end
+
+    it 'generates proper escape sequences' do
+      expect(CapeCod.reset).to eq("\e[0m")
+    end
+
+    context 'when using singleton methods' do
+      context 'no params given' do
+        it 'returns the escape sequence' do
+          expect(CapeCod.red).to    eq("\e[31m")
+          expect(CapeCod.on_red).to eq("\e[41m")
+          expect(CapeCod.bold).to   eq("\e[1m")
+        end
+      end
+
+      context 'when object param given' do
+        let(:obj) { ['foo', 10, :bar] }
+
+        it 'prepends the escape sequence and append a reset' do
+
+          expect(CapeCod.red(obj)).to    eq("\e[31m#{obj.to_s}\e[0m")
+          expect(CapeCod.on_red(obj)).to eq("\e[41m#{obj.to_s}\e[0m")
+          expect(CapeCod.bold(obj)).to   eq("\e[1m#{obj.to_s}\e[0m")
+        end
+      end
+    end
+
+    context 'when using instance methods' do
+      before { class String; include CapeCod end }
+
+      let(:string)    { 'foo bar baz' }
+      let(:bold)      { "\e[1m#{string}\e[0m" }
+      let(:red)       { "\e[31m#{string}\e[0m" }
+      let(:on_yellow) { "\e[43m#{string}\e[0m" }
+      let(:r_on_y)    { "\e[43m\e[31mfoo bar baz\e[0m\e[0m" }
+      let(:r_on_y_b)  { "\e[1m\e[43m\e[31mfoo bar baz\e[0m\e[0m\e[0m" }
+
+
+      it 'returns a new string with the proper escape codes applied' do
+
+        expect(string.bold).to_not eql(string)
+
+        expect(string.bold).to      eql(bold)
+        expect(string.red).to       eql(red)
+        expect(string.on_yellow).to eql(on_yellow)
+
+        expect(string.effect(:bold)).to       eql(bold)
+        expect(string.foreground(:red)).to    eql(red)
+        expect(string.background(:yellow)).to eql(on_yellow)
+        expect(string.fx(:bold)).to           eql(bold)
+        expect(string.fg(:red)).to            eql(red)
+        expect(string.bg(:yellow)).to         eql(on_yellow)
+
+        expect(string.red.on_yellow).to eql(r_on_y)
+        expect(string.fg(:red).bg(:yellow)).to eql(r_on_y)
+
+        expect(string.red.on_yellow.bold).to eql(r_on_y_b)
+        expect(string.fg(:red).bg(:yellow).effect(:bold)).to eql(r_on_y_b)
+    end
+  end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+require 'rspec'
+
+require 'cape-cod'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cape-cod
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-29 00:00:00.000000000 Z
+date: 2013-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -27,22 +27,6 @@ dependencies:
     - - ! '>='
       - !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
@@ -73,10 +57,15 @@ files:
 - README.md
 - Rakefile
 - LICENSE.md
+- lib/cape-cod/color.rb
 - lib/cape-cod/version.rb
 - lib/cape-cod.rb
+- spec/cape-cod/color_spec.rb
+- spec/cape-cod_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/fuadsaud/cape-cod
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -86,7 +75,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -99,5 +88,8 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Make your strings look fancy with ANSI escape codes.
-test_files: []
+test_files:
+- spec/cape-cod/color_spec.rb
+- spec/cape-cod_spec.rb
+- spec/spec_helper.rb
 has_rdoc: false