cape-cod 0.1.3 → 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 332b4b917a8ae3cc95e2afa4fd151232bbde77d8
+  data.tar.gz: aaab015b8cebd08e94d2ecdcbf246adc3d272a7c
+SHA512:
+  metadata.gz: d6811860f3219450e80b89e6eb84ea38c3ab01c61b8361bc71d8c6ac27c1914a1bdb695eeb4d7582af3a41608d00d582a70ef25ffa5d8f41f8ddcfd10cfcbf66
+  data.tar.gz: 4943d08838018b2a1255d099efb92d1fe453c25545b08307f9bf2dc10dfdd89ccc51a18911d984db9381f13bd0a5e112bf8e78610cbbb1d54495798176c0a95f

data/README.md

@@ -2,13 +2,14 @@ cape-cod
 ========
 
 [![Gem Version](https://badge.fury.io/rb/cape-cod.png)]
-(http://badge.fury.io/rb/cape-cod)
+               (http://badge.fury.io/rb/cape-cod)
 [![Build Status](https://travis-ci.org/fuadsaud/cape-cod.png?branch=master)]
-(https://travis-ci.org/fuadsaud/cape-cod)
+                (https://travis-ci.org/fuadsaud/cape-cod)
+[![Code Climate](https://codeclimate.com/github/fuadsaud/cape-cod.png)]
+                (https://codeclimate.com/github/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 your
-strings.
+HAR! bet you didn't see that coming - to your strings.
 
 ### *Hey, but don't we have a plenty of gems that do exactly the same thing?*
 
@@ -47,9 +48,13 @@ or simply:
 
 You can include cape-cod in you String class:
 
-    class String; include CapeCod end
+    require 'cape-cod/string'
 
-    puts "Praise R'hlor, for the night is dark and full of terrors".red
+    class String
+      include CapeCod::String
+    end
+
+    puts "OHAI".red
 
     puts 'This is BOLD'.bold
 
@@ -79,3 +84,4 @@ Please refer to [LICENSE.md](LICENSE.md).
 
 Check the guidelines at [CONTRIBUTING.md](CONTRIBUTING.md).
 
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/fuadsaud/cape-cod/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

data/Rakefile

@@ -1,16 +1,22 @@
+# encoding: utf-8
+
 require 'rake'
 require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+task default: [:spec, :rubocop]
 
 RSpec::Core::RakeTask.new
 
+desc 'Run RuboCop static analyzer'
+task :rubocop do
+  system 'rubocop lib/ spec/ Gemfile Rakefile *.gemspec'
+end
+
 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
+  # Do we have pry available?
+  repl = system('pry -v &> /dev/null') ? 'pry' : 'irb'
 
-desc 'run all specs'
-task default: :spec
+  system "#{repl} --require ./lib/cape-cod.rb"
+end

data/lib/cape-cod.rb

@@ -1,15 +1,6 @@
 # encoding: utf-8
 
-$LOAD_PATH.unshift File.expand_path(
-  File.join(File.dirname(__FILE__), '../lib'))
-
 module CapeCod
-
-  require 'cape-cod/version'
-  require 'cape-cod/color'
-
-  @enabled = STDOUT.tty?
-
   EFFECTS = {
     reset:         0,
     bold:          1,
@@ -23,77 +14,31 @@ module CapeCod
     strikethrough: 9
   }.freeze
 
+  require_relative 'cape-cod/version'
+  require_relative 'cape-cod/color'
+
   #
   # Define helper methods for applying the escape codes.
   #
-  Color::CODES.each do |color, _|
-
-    #
-    # Instance methods for background and foreground colors.
-    #
-    define_method color do
-      CapeCod.foreground(color, self)
-    end
-
-    define_method "on_#{color}".to_s do
-      CapeCod.background(color, self)
-    end
-
-    #
-    # Singleton methods for background and foreground colors.
-    #
-    define_singleton_method color do |obj = ''|
-      string = obj.to_s
-
-      foreground(color, string)
-    end
-
-    define_singleton_method "on_#{color}" do |obj = ''|
-      string = obj.to_s
-
-      background(color, string)
-    end
-  end
+  class << self
+    attr_accessor :enabled
+    alias_method  :enabled?, :enabled
 
-  EFFECTS.each do |effect, _|
+    Color::CODES.keys.each do |color|
+      define_method color do |target = ''|
+        CapeCod.foreground(color, target)
+      end
 
-    #
-    # Instance methods for effects.
-    #
-    define_method effect do
-      CapeCod.effect(effect, self)
+      define_method "on_#{color}".to_s do |target = ''|
+        CapeCod.background(color, target)
+      end
     end
 
-    #
-    # Singleton methods for effects.
-    #
-    define_singleton_method effect do |obj = ''|
-      string = obj.to_s
-
-      effect(effect, string)
+    EFFECTS.keys.each do |effect|
+      define_method effect do |target = ''|
+        CapeCod.effect(effect, target)
+      end
     end
-  end
-
-  def foreground(*color) # :nodoc:
-    CapeCod.foreground(*color, self)
-  end
-
-  def background(*color) # :nodoc:
-    CapeCod.background(*color, self)
-  end
-
-  def effect(effect)    # :nodoc:
-    CapeCod.effect(effect, self)
-  end
-
-  alias_method :fg, :foreground
-  alias_method :bg, :background
-  alias_method :fx, :effect
-
-  class << self
-
-    attr_accessor :enabled
-    alias_method  :enabled?, :enabled
 
     def foreground(*color, target) # :nodoc:
       apply_escape_sequence(color_code_for(*color, :foreground), target)
@@ -111,7 +56,7 @@ module CapeCod
     alias_method :bg, :background
     alias_method :fx, :effect
 
-    protected
+    private
 
     #
     # Returns the ANSI escape sequence for the given +color+.
@@ -127,8 +72,6 @@ module CapeCod
       EFFECTS.fetch(effect)
     end
 
-    private
-
     #
     # Returns the ANSI escape sequence for a given escape +code+.
     #
@@ -153,14 +96,19 @@ module CapeCod
       end
     end
 
-    def ensure_windows_dependencies!
+    def ensure_windows_dependencies
       if RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
         require 'Win32/Console/ANSI'
       end
     rescue LoadError
       self.enabled = false
     end
+
+    def ensure_environment_conditions
+      self.enabled = ENV['TERM'] != 'dumb' && (STDOUT.tty? && STDERR.tty?)
+    end
   end
 
-  ensure_windows_dependencies!
+  ensure_windows_dependencies
+  ensure_environment_conditions
 end

data/lib/cape-cod/color.rb

@@ -17,16 +17,6 @@ module CapeCod
       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.
     #
@@ -36,23 +26,14 @@ module CapeCod
     # +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
+      with_valid_color_and_ground *color, ground do |*c, g|
+        if c.size == 3
+          c = [(c[0] << 16) | (c[1] << 8) | c[2]]
+        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}".)
+        @ground = ground
+        @color  = c.first
       end
-
-      @ground = ground
-      @color  = color.first
     end
 
     #
@@ -77,5 +58,41 @@ module CapeCod
 
       "#{ground_code};5;#{color_code}"
     end
+
+    #
+    # Returns the ANSI domain code for the given RGB color packed
+    # into an Integer.
+    #
+    def self.hex_to_ansi(hex)
+      (6 * ((hex >> 16 & 0xff).quo(256))).to_i * 36 +
+      (6 * ((hex >>  8 & 0xff).quo(256))).to_i *  6 +
+      (6 * ((hex       & 0xff).quo(256))).to_i
+    end
+
+    def with_valid_color_and_ground(*color, ground)
+      validate_color!(*color) and
+        validate_ground!(ground) and yield *color, ground
+    end
+
+    def validate_color!(*color)
+      if color.empty? || color.size > 3 || color.size == 2
+        fail ArgumentError,
+              "wrong number of arguments (#{color.size + 1} for 2|4)."
+      elsif color.first.is_a?(Integer) && color.first < 0
+        fail ArgumentError, 'hex code must be positive.'
+      elsif color.first.is_a?(Symbol) && !CODES.has_key?(color.first)
+        fail ArgumentError, %(invalid color name "#{color.first}".)
+      else
+        color
+      end
+    end
+
+    def validate_ground!(ground)
+      if [:foreground, :background].include? ground
+        ground
+      else
+        fail ArgumentError, 'ground must be either foreground or background.'
+      end
+    end
   end
 end

data/lib/cape-cod/string.rb

@@ -0,0 +1,35 @@
+module CapeCod
+  module String
+    Color::CODES.keys.each do |color|
+      define_method color do
+        CapeCod.foreground(color, self)
+      end
+
+      define_method "on_#{color}".to_s do
+        CapeCod.background(color, self)
+      end
+    end
+
+    EFFECTS.keys.each do |effect|
+      define_method effect do
+        CapeCod.effect(effect, self)
+      end
+    end
+
+    def foreground(*color)
+      CapeCod.foreground(*color, self)
+    end
+
+    def background(*color)
+      CapeCod.background(*color, self)
+    end
+
+    def effect(effect)
+      CapeCod.effect(effect, self)
+    end
+
+    alias_method :fg, :foreground
+    alias_method :bg, :background
+    alias_method :fx, :effect
+  end
+end

data/lib/cape-cod/version.rb

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

data/spec/cape-cod_spec.rb

@@ -5,6 +5,31 @@ require 'spec_helper'
 describe CapeCod do
   it('has a version') { expect(CapeCod::VERSION).to be_a String }
 
+  describe 'environment defaults' do
+    context 'standard streams are tty' do
+      it 'is disabled' do
+        expect(STDOUT).to receive(:tty?).and_return(true)
+        expect(STDERR).to receive(:tty?).and_return(true)
+
+        CapeCod.send(:ensure_environment_conditions)
+
+        expect(CapeCod).to be_enabled
+      end
+    end
+
+    context 'standard streams are tty' do
+      it 'is enabled' do
+        expect(STDOUT).to receive(:tty?).and_return(true)
+        expect(STDERR).to receive(:tty?).and_return(false)
+
+        CapeCod.send(:ensure_environment_conditions)
+
+        expect(CapeCod).to_not be_enabled
+      end
+    end
+  end
+
+
   context 'disabled' do
     before(:all) { CapeCod.enabled = false }
 
@@ -14,7 +39,11 @@ describe CapeCod do
 
     context 'using instance methods' do
       before do
-        class StringWithCapeCodIncluded < String; include CapeCod end
+        require 'cape-cod/string'
+
+        StringWithCapeCodIncluded = Class.new(String).tap { |klass|
+          klass.send(:include, CapeCod::String)
+        }
       end
 
       let(:target) { StringWithCapeCodIncluded.new('some text') }
@@ -139,7 +168,11 @@ describe CapeCod do
     end
 
     context 'using instance methods' do
-      before(:all) { class String; include CapeCod end }
+      before :all do
+        class String
+          include CapeCod::String
+        end
+      end
 
       it('provides the "fx" alias') { String.public_method_defined? :fx }
       it('provides the "fg" alias') { String.public_method_defined? :fg }

metadata

@@ -1,87 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: cape-cod
 version: !ruby/object:Gem::Version
-  version: 0.1.3
-  prerelease: 
+  version: 0.1.4
 platform: ruby
 authors:
 - Fuad Saud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-27 00:00:00.000000000 Z
+date: 2013-12-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: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0.beta1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0.beta1
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: guard-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'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rubocop
   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: ! 'CapeCod offers you simple stupid way of colorizing and applying effects
-  to your
-
+description: |
+  CapeCod offers you simple stupid way of colorizing and applying effects to your
   terminal output, by appending ANSI escape sequences to your strings.
-
-'
-email: fuadksd@gmail.com
+email: fuadfsaud@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -90,6 +78,7 @@ files:
 - Rakefile
 - LICENSE.md
 - lib/cape-cod/color.rb
+- lib/cape-cod/string.rb
 - lib/cape-cod/version.rb
 - lib/cape-cod.rb
 - spec/cape-cod/color_spec.rb
@@ -98,30 +87,28 @@ files:
 homepage: http://github.com/fuadsaud/cape-cod
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: Make your strings look fancy with ANSI escape codes.
+specification_version: 4
+summary: Fancy terminal output with ANSI escape codes.
 test_files:
 - spec/cape-cod/color_spec.rb
 - spec/cape-cod_spec.rb
 - spec/spec_helper.rb
-has_rdoc: false