colorputs 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ae9a10c9171d187ce40cb99a92850bddc386d95
-  data.tar.gz: a30994927b620ea14c80948490dbebaf9786d53b
+  metadata.gz: 3341f3b8c950f5e4cffac502ea3d3e1c9692135f
+  data.tar.gz: 5743ea6b1498682d889aa783cd6606718f4ee27d
 SHA512:
-  metadata.gz: 5f9a1aa2d96ab7402f45eb9fdb6a28d9752f468ad0a513c0d3db797b533a4f4885ca3de5fe8f1380a6d4e0debb0332a1f0b3a182700327e8725f3aa2ba66f34d
-  data.tar.gz: f2b0d11d8db402a6efab3b07f595dd3775f0b2f474fb23a695ff425b6d369b62772ae8dd855ec9fc72e5d0b7047bf766b59466560d74b5493e99a01b5d8e85b8
+  metadata.gz: 7ea532ed1c779e1eee930a52cba7eef2542c67f4d004e5124658c8356c5e0778361fb931e28a35e7af4e6198d8f9d457ea8667d5b910c4c62b96e561c0a49922
+  data.tar.gz: c8fbc7f87042f17424c3679055da10043637e70222445fa0c3f3593b7b6a3be9ad54cb8166ad3f0ef871947ab4db38a9c4489bc2d9fd2f17fe46ea58ea4572d2

data/AUTHORS.md

@@ -0,0 +1,6 @@
+## Colorputs Contributors
+
+Colorputs is written by Agustín Bea (https://github.com/agus22lp) and Lautaro (https://github.com/lndl).<br>
+Besides, we have these contributors:
+
+- F-3r (https://github.com/F-3r)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Lautaro
+
+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,57 @@
+colorputs
+=========
+
+Color in p and puts method!
+
+Description
+-----------
+
+Colorputs provides a beatiful color printing for Ruby console-based applications
+
+Instalation
+-----------
+
+    gem install colorputs
+    
+Examples of usage
+-----------------
+
+    p 'Hello world!', :red
+    
+Will print out "Hello world!" colored in red.
+
+Availables colors and modes
+---------------------------
+
+<table>
+  <tr>
+    <th>Symbol</th><th>Color/Mode</th>
+  </tr>
+  <tr>
+    <td>:red</td><td>Red</td>
+  </tr>
+  <tr>
+    <td>:blue</td><td>Blue</td>
+  </tr>
+  <tr>
+    <td>:green</td><td>Green</td>
+  </tr>
+  <tr>
+    <td>:yellow</td><td>Yellow</td>
+  </tr>
+  <tr>
+    <td>:cyan</td><td>Cyan</td>
+  </tr>
+  <tr>
+    <td>:magenta</td><td>Magenta</td>
+  </tr>
+  <tr>
+    <td>:white</td><td>White</td>
+  </tr>
+  <tr>
+    <td>:black</td><td>Black</td>
+  </tr>
+  <tr>
+    <td>:rainbow</td><td>Rainbow colors!</td>
+  </tr>
+</table>

data/colorputs.gemspec

@@ -0,0 +1,17 @@
+lib = File.expand_path(File.join('..', 'lib'), __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = 'colorputs'
+  s.version       = '0.2.3'
+  s.date          = '2013-11-27'
+  s.summary       = "Color in puts method!!"
+  s.description   = "Enables to use puts and p standard methods with a easy color interface"
+  s.authors       = ["Agustín Beamurguía, Lautaro De León"]
+  s.email         = ['agus.beam@gmail.com, laudleon@gmail.com']
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files | grep specs/`.split("\n")
+  s.require_paths = ["lib/"]
+  s.homepage      = 'http://github.com/lndl/colorputs'
+  s.license       = 'MIT'
+end

data/lib/colorputs.rb

@@ -1,36 +1,5 @@
-module Kernel
+require 'colorputs/main.rb'
 
-  colors = Hash.new
-
-  std_coloring = proc do |color_code, str|
-    "\e#{color_code}#{str}\e[0m"
-  end.curry()
-
-  rainbow_coloring = proc do |str|
-    str.chars.inject("") { |acc,c| acc + colors.values[rand(colors.size - 2)].(c) }
-  end
-
-  colors.merge!({
-    red:     std_coloring.('[91m'),
-    green:   std_coloring.('[92m'),
-    yellow:  std_coloring.('[93m'),
-    blue:    std_coloring.('[94m'),
-    magenta: std_coloring.('[95m'),
-    cyan:    std_coloring.('[96m'),
-    white:   std_coloring.('[37m'),
-    black:   std_coloring.('[30m'),
-    rainbow: rainbow_coloring
-  })
-
-  old_puts = method :puts
-
-  p_color_body = proc do |print_m_sym, obj, *args|
-    maybe_color = args.last
-    fancy_str = colors[maybe_color].(obj.send(print_m_sym)) rescue obj
-    args.pop unless fancy_str == obj
-    old_puts.(fancy_str, args)
-  end.curry()
-
-  define_method :puts, p_color_body.(:to_s)
-  define_method :p, p_color_body.(:inspect)
+class Object
+  include Colorputs
 end

data/lib/colorputs/main.rb

@@ -0,0 +1,63 @@
+module Colorputs
+
+  colors = Hash.new
+  modes  = Hash.new
+
+  format_wrapper = ->(start_code, str, end_code) { "\e[#{start_code}m#{str}\e[#{end_code}m" }
+
+  std_mode = proc do |start_mode, end_mode, str|
+    format_wrapper.(start_mode, str, end_mode)
+  end.curry()
+
+  std_coloring = proc do |color_code, str|
+    format_wrapper.(color_code, str, 39)
+  end.curry()
+
+  rainbow_coloring = proc do |str|
+    str.chars.inject("") { |acc,c| acc + colors.values[rand(colors.size - 2)].(c) }
+  end
+
+  modes.merge!({
+    b:  std_mode.(1,21), # Bold
+    bl: std_mode.(5,25), # Blinking
+    u:  std_mode.(4,24), # Underlined
+    r:  std_mode.(7,27)  # Reversed
+  })
+
+  colors.merge!({
+    red:     std_coloring.('91'),
+    green:   std_coloring.('92'),
+    yellow:  std_coloring.('93'),
+    blue:    std_coloring.('94'),
+    magenta: std_coloring.('95'),
+    cyan:    std_coloring.('96'),
+    white:   std_coloring.('37'),
+    black:   std_coloring.('30'),
+    rainbow: rainbow_coloring
+  })
+
+  old_puts = Kernel.method :puts
+
+  fancyner = proc do |normal_str, maybe_Cp_code| 
+    if maybe_Cp_code.instance_of? Symbol
+      maybe_color, maybe_mode = maybe_Cp_code.to_s.split('_').map(&:to_sym)
+      fancy_str = colors[maybe_color].(normal_str) rescue normal_str
+      fancy_str = modes[maybe_mode].(fancy_str)    rescue fancy_str
+      fancy_str
+    else
+      normal_str
+    end
+  end
+
+  p_color_body = proc do |print_m_sym, ret_lambda, obj, *args|
+    maybe_Cp_code = args.last # Cp -> Colorputs ;)
+    normal_str = obj.send(print_m_sym)
+    fancy_str  = fancyner.(normal_str, maybe_Cp_code)
+    args.pop unless fancy_str == normal_str
+    old_puts.(fancy_str, args)
+    ret_lambda.(obj,args)
+  end.curry()
+
+  define_method :puts, p_color_body.(:to_s,    ->(_  , _)    { nil })
+  define_method :p,    p_color_body.(:inspect, ->(obj, args) { (args == []) ? obj : [obj] + args })
+end

data/specs/spec_colorputs.rb

@@ -0,0 +1,122 @@
+require './spec_helper'
+
+describe 'Colorputs:' do
+  before do
+    class MyColorizedObject
+      include Colorputs
+    end
+    @mco = MyColorizedObject.new
+  end
+
+  describe '::p ->' do
+    describe 'when no Colorputs specifics args are sent,' do
+      it 'must return like the original p method' do
+        @mco.send(:p, 'Hello').should eql(p 'Hello')
+      end
+    end
+
+    describe 'when some color is sent,' do
+      describe 'when only one argument is sent to print,' do
+        it 'must return like the original p method' do
+          @mco.send(:p, 'Hello', :red).should eql(p 'Hello')
+        end
+        it 'must return only one valid string argument' do
+          @mco.send(:p, 'Hello', :red).should be_a_kind_of String
+        end
+      end
+      describe 'when an argument list is sent to print,' do
+        it 'must return like the original p method' do
+          @mco.send(:p, 'Hello','How','Are','You', :blue, :red).should eql(p 'Hello', 'How', 'Are', 'You', :blue)
+        end
+        it 'must return the whole argument list, except the color' do
+          @mco.send(:p, 'Hello','How','Are','You', :blue, :red).should be_a_kind_of Array 
+          @mco.send(:p, 'Hello','How','Are','You', :blue, :red).size.should eql(5) 
+        end
+      end
+    end
+
+    describe 'when a wrong color is sent,' do
+      it 'safely ignore it and returns like an ordinary p method' do
+        @mco.send(:p, 'Hello', :wrong).should eql(p 'Hello', :wrong)
+      end
+
+      it 'must return the whole argument list, including the wrong color label' do
+        @mco.send(:p, 'Hello', :wrong).should be_a_kind_of Array 
+        @mco.send(:p, 'Hello', :wrong).size.should eql(2)
+      end
+    end
+
+    describe 'when a valid color/mode string is sent, ' do
+      it 'must ignore it (only symboles are accepted)' do
+        @mco.send(:p, 'Hello', 'green_b').should eql(p 'Hello', 'green_b')
+        @mco.send(:p, 'Hello', 'green_b').size.should eql(2)
+      end
+    end
+
+    describe 'when mode suffix is sent,' do
+      describe 'when is used in combination with color' do
+        it 'must return like the original p method' do
+          @mco.send(:p, 'Hello', :red_b).should eql(p 'Hello')
+        end
+        it 'must return only one valid string argument' do
+          @mco.send(:p, 'Hello', :red_b).should be_a_kind_of String
+        end
+      end
+      describe 'when is not used in combination with color' do
+        it 'must return like the original p method' do
+          @mco.send(:p, 'Hello', :_b).should eql(p 'Hello')
+        end
+        it 'must return only one valid string argument' do
+          @mco.send(:p, 'Hello', :_b).should be_a_kind_of String
+        end
+      end
+    end
+  end
+
+  describe '::puts ->' do
+    describe 'when no Colorputs specifics args are sent,' do
+      it 'must return like the original puts method' do
+        @mco.send(:puts, 'Hello').should eql(puts 'Hello')
+      end
+    end
+
+    describe 'when some color is sent,' do
+      describe 'when only one argument is sent to print,' do
+        it 'must return like the original puts method' do
+          @mco.send(:puts, 'Hello', :red).should eql(puts 'Hello')
+        end
+      end
+      describe 'when an argument list is sent to print,' do
+        it 'must return like the original puts method' do
+          @mco.send(:puts, 'Hello','How','Are','You', :blue, :red).should eql(puts 'Hello', 'How', 'Are', 'You', :blue)
+        end
+      end
+    end
+
+    describe 'when a wrong color is sent,' do
+      it 'safely ignore it and returns like an ordinary puts method' do
+        @mco.send(:puts, 'Hello', :wrong).should eql(puts 'Hello', :wrong)
+      end
+    end
+
+    describe 'when a valid color/mode string is sent, ' do
+      it 'must ignore it (only symboles are accepted)' do
+        @mco.send(:puts, 'Hello', 'green_b').should eql(puts 'Hello', 'green_b')
+      end
+    end
+
+    describe 'when mode suffix is sent,' do
+      describe 'when is used in combination with color' do
+        it 'must return like the original p method' do
+          @mco.send(:puts, 'Hello', :red_b).should eql(puts 'Hello')
+        end
+      end
+      describe 'when is not used in combination with color' do
+        it 'must return like the original p method' do
+          @mco.send(:puts, 'Hello', :_b).should eql(puts 'Hello')
+        end
+      end
+    end
+  end
+
+end

data/specs/spec_helper.rb

@@ -0,0 +1,2 @@
+require "#{ File.dirname(__FILE__) }/../lib/colorputs/main"
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: colorputs
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Agustín Beamurguía, Lautaro De León
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-07 00:00:00.000000000 Z
+date: 2013-11-27 00:00:00.000000000 Z
 dependencies: []
 description: Enables to use puts and p standard methods with a easy color interface
 email:
@@ -17,7 +17,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- AUTHORS.md
+- Gemfile
+- LICENSE
+- README.md
+- colorputs.gemspec
 - lib/colorputs.rb
+- lib/colorputs/main.rb
+- specs/spec_colorputs.rb
+- specs/spec_helper.rb
 homepage: http://github.com/lndl/colorputs
 licenses:
 - MIT
@@ -42,4 +50,6 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Color in puts method!!
-test_files: []
+test_files:
+- specs/spec_colorputs.rb
+- specs/spec_helper.rb