colored2 2.0.2 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 621fbf237db4190687d51e14d05878a4a174c69c
-  data.tar.gz: d198d7985aa414c065726eaa491d8f8c7b2228c9
+  metadata.gz: 924031901113f03f0694ea75208745920d7f38ab
+  data.tar.gz: 835ee416fa88d5d903546a021da1e0792d6529fc
 SHA512:
-  metadata.gz: 00642c7bff03d7efdd3ec2da55ed4d8100e2c26a707c58b6b5af860107a599bfcc48836fd021ee47f51cdd07957d65280b85ca16470f237a26bc94c392deaaee
-  data.tar.gz: ec17f680b8e2fdf94ec1f70633de7f5a96818a704128b8e9eccdcda74af95639e088bd09663c1af5cfae84fd20d1759c4e27d3ba741a7133fed6df20795a2608
+  metadata.gz: '008631053e811a6694c199ddc6c0c5b2636c7c863a5a794835766effb93cb9afea9af5a51802f8b9943a206138b9555002b33e68eeb148b9f05ded8fc6fe2f5f'
+  data.tar.gz: a3d40c57634d3753a2dcd9073f6841ef2f40d1b21b1a141a34ade7eff762a934e878f2e8b91051c0f072e8b392cff5abd77456b6415d2d0cb4f28fbcb4c473f8

data/README.md

@@ -1,31 +1,93 @@
 [![Gem Version](https://badge.fury.io/rb/colored2.svg)](https://badge.fury.io/rb/colored2)
+[![Downloads](http://ruby-gem-downloads-badge.herokuapp.com/colored2?type=total)](https://rubygems.org/gems/colored2)
+[![Gitter](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/colored2)
+
 [![Build Status](https://travis-ci.org/kigster/colored2.svg?branch=master)](https://travis-ci.org/kigster/colored2)
-[![Code Climate](https://codeclimate.com/repos/56dff58d80b254164b003d80/badges/176e4c39b20bfed90478/gpa.svg)](https://codeclimate.com/repos/56dff58d80b254164b003d80/feed)
-[![Test Coverage](https://codeclimate.com/repos/56dff58d80b254164b003d80/badges/176e4c39b20bfed90478/coverage.svg)](https://codeclimate.com/repos/56dff58d80b254164b003d80/coverage)
-[![Issue Count](https://codeclimate.com/repos/56dff58d80b254164b003d80/badges/176e4c39b20bfed90478/issue_count.svg)](https://codeclimate.com/repos/56dff58d80b254164b003d80/feed)
+[![Test Coverage](https://codeclimate.com/github/kigster/colored2/badges/coverage.svg)](https://codeclimate.com/github/kigster/colored2/coverage)
+[![Code Climate](https://codeclimate.com/github/kigster/colored2/badges/gpa.svg)](https://codeclimate.com/github/kigster/colored2)
+[![Issue Count](https://codeclimate.com/github/kigster/colored2/badges/issue_count.svg)](https://codeclimate.com/github/kigster/colored2)
 
 ## Colored2
 
-This is a fork of Chris (defunkt) Wanstrath's colored gem, which appears to be no longer supported.
+This is an actively maintained fork of Chris (defunkt) Wanstrath's gem [colored](https://github.com/defunkt/colored), which appears to be no longer supported.
 
-This fork comes with a slightly spruced up syntax and rspecs.
+This fork comes with a slightly spruced up syntax, some additional features, and a test suite written in [RSpec](http://rspec.info/).
 
 ## Usage
 
-In addition to the simple syntax of the original gem, which affected only the string to the left of the method call, 
-the "bang" syntax affects a string to the right. If the block or a method argument is provided,
-the contents is wrapped in the color, and the color is then reset back. If no block
-or argument is provided, the color is left open-ended, and must be explicitly reset – when using the 'bang' notation.
+In addition to the simple syntax of the original gem, which affected only the string to the left of the method call, the new "bang" syntax affects a string to the right. If the block or a method argument is provided, the contents is wrapped in the color, and the color is then reset back. 
+
+If no block or argument is provided, the color is left open-ended, and must be explicitly reset – when using the 'bang' notation.
 
 ![](doc/colored2-session1.png)
 
+### Complete set of colors:
+
+ * black
+ * red
+ * green
+ * yellow
+ * blue
+ * magenta
+ * cyan
+ * white
+
+### Complete Set of Effects
+
+> Note: previous versions used method name `clear` instead of `no_color`, which clashed with many 3rd party frameworks that defined similarly named method in the global namespace.
+> This highlights the dangers of introducing so many words into the `String` namespace.
+
+ * no_color
+ * bold
+ * dark
+ * italic
+ * underlined
+ * reversed 
+ * plain
+ * normal   
+ 
 ## Usage in Other Classes
 
-You can decorate and color not just strings. 
+With this gem you can add color to not just strings, but to any other class. `String` class is automatically decorated as soon as `require 'colored2'` is parsed by the ruby interpreter. Note that future versions may refrain from auto-requiring `colored2/strings`, and rely on explicitly requiring components they need colorized, eg `require 'colored2/numbers'`.
 
-To color numbers, require the following file, which automatically decorates `Fixnum` and `Float`.  You can also add color methods 
-to the `Object`. Finally, you can add the methods to any custom class by including the `Colored2` Module.
+To color numbers, require the following file, which automatically decorates `Integer` and `Float`.  You can also add color methods to the `Object`. Finally, you can add the methods to any custom class by including the `Colored2` Module.
 
-Below is an `IRB` session that shows a slightly more advanced usage.
+Below is an `IRB` — session that shows a slightly more advanced usage.
 
 ![](doc/colored2-session2.png)
+
+##  Additional Helpers
+
+There are several additional helpers tucked onto the `String` class.
+
+ * `#to_bol` (to beginning of the line) will rewind the cursor back to the beginning of the current line.
+ * `#to_eol` (to end of line)
+ 
+## Installation
+
+Add this line to your application's Gemfile:
+
+
+    gem 'colored2'
+
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install colored2
+
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/kigster/colored2](https://github.com/kigster/colored2).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/colored2.rb

@@ -1,4 +1,4 @@
-require 'colored2/constants'
+require 'colored2/codes'
 require 'colored2/ascii_decorator'
 
 module Colored2
@@ -9,23 +9,27 @@ module Colored2
   def self.included(from_class)
     from_class.class_eval do
 
-      def surround_with_color(color_or_effect, color_self, string = nil, &block)
-        color_type = if Colored2.background_next?
+      def surround_with_color(color: nil, effect: nil, color_self: nil, string: nil, &block)
+        color_type = if Colored2.background_next? && effect.nil?
                        Colored2.foreground_next!
                        :background
                      else
                        :foreground
                      end
 
+       opts = {}
+       opts.merge!(color_type => color) if color
+       opts.merge!(effect: effect) if effect
+
         if color_self then
-          opts = { beginning: :on, end: :off, color_type => color_or_effect, effect: color_or_effect }
+          opts.merge!( beginning: :on, end: :off)
           colored = Colored2::AsciiDecorator.new(self).decorate(opts)
           if string || block
             arg = "#{string}#{block.call if block}"
             colored << Colored2::AsciiDecorator.new(arg).decorate(opts) if arg.length > 0
           end
         else
-          opts = { end: :on, color_type => color_or_effect, effect: color_or_effect}
+          opts.merge!( end: :on )
           colored = Colored2::AsciiDecorator.new(self).decorate(opts)
           if string || block
             arg = "#{string}#{block.call if block}"
@@ -44,22 +48,22 @@ module Colored2
     from_class.instance_eval do
       COLORS.keys.each do |color|
         define_method(color) do |string = nil, &block|
-          surround_with_color(color, true, string, &block)
+          surround_with_color(color: color, color_self: true, string: string, &block)
         end
 
         define_method("#{color}!".to_sym) do |string = nil, &block|
-          surround_with_color(color, false, string, &block)
+          surround_with_color(color: color, color_self: false, string: string, &block)
         end
       end
 
       EFFECTS.keys.each do |effect|
-        next if effect == 'clear'
+        next if effect == 'no_color'
         define_method(effect) do |string = nil, &block|
-          surround_with_color(effect, true, string, &block)
+          surround_with_color(effect: effect, color_self: true, string: string, &block)
         end
 
         define_method("#{effect}!".to_sym) do |string = nil, &block|
-          surround_with_color(effect, false, string, &block)
+          surround_with_color(effect: effect, color_self: false, string: string, &block)
         end
       end
 
@@ -70,6 +74,10 @@ module Colored2
         end
         tmp
       end
+
+      define_method(:to_bol) do
+        "#{self}\033[#{length}D\033[0D"
+      end
     end
   end
 end

data/lib/colored2/ascii_decorator.rb

@@ -1,4 +1,4 @@
-require_relative 'constants'
+require 'colored2/codes'
 require 'forwardable'
 
 module Colored2
@@ -41,29 +41,10 @@ module Colored2
       def background_next?
         self.__background_next
       end
-
-      def clear
-        effect(:clear)
-      end
-
-      def colors
-        @colors ||= COLORS.keys.sort
-      end
-
-      def effect(effect_name)
-        "\e[#{EFFECTS[effect_name]}m" if effect_name && EFFECTS[effect_name.to_sym]
-      end
-
-      def color(color_name:, type:)
-        background_code = (type == :background) ? 10 : 0
-        if color_name && COLORS[color_name.to_sym]
-          "\e[#{COLORS[color_name.to_sym] + background_code}m"
-        end
-      end
     end
 
     extend Forwardable
-    def_delegators :@my_class, :enable!, :disable!, :clear, :colors, :effect, :color
+    def_delegators :@my_class, :enable!, :disable!
 
     attr_accessor :string, :my_class
 
@@ -73,21 +54,20 @@ module Colored2
     end
 
     # options[:start] = :color
-    # options[:end]   = :color | :clear
+    # options[:end]   = :color | :no_color
     def decorate(options = {})
-
       return string if !self.class.enabled? || string.length == 0
       escape_sequence = [
-        color(color_name: options[:foreground], type: :foreground),
-        color(color_name: options[:background], type: :background),
-        effect(options[:effect])
+        Colored2::TextColor.new(options[:foreground]),
+        Colored2::BackgroundColor.new(options[:background]),
+        Colored2::Effect.new(options[:effect])
       ].compact.join
 
       colored = ''
       colored << escape_sequence if options[:beginning] == :on
       colored << string
       if options[:end]
-        colored << clear if options[:end] == :off && !colored.end_with?(clear)
+        colored << no_color if options[:end] == :off && !colored.end_with?(no_color)
         colored << escape_sequence if options[:end] == :on
       end
       colored
@@ -97,5 +77,10 @@ module Colored2
       string.gsub(%r{\e\[\d+(;\d+)*m}, '')
     end
 
+    private
+
+    def no_color
+      @no_color ||= Colored2::Effect.new(:no_color).to_s
+    end
   end
 end

data/lib/colored2/codes.rb

@@ -0,0 +1,63 @@
+module Colored2
+
+  COLORS  = {
+    black:     30,
+    red:       31,
+    green:     32,
+    yellow:    33,
+    blue:      34,
+    magenta:   35,
+    cyan:      36,
+    white:     37
+  }
+
+  EFFECTS = {
+    no_color:   0,
+    bold:       1,
+    dark:       2,
+    italic:     3,
+    underlined: 4,
+    reversed:   7,
+    plain:      21, # non-bold
+    normal:     22
+  }
+
+  class Code
+    attr_accessor :name, :escape
+    def initialize(name)
+      @name = name
+      return if name.nil?
+      @escape = codes[name.to_sym]
+      raise ArgumentError.new("No color or effect named #{name} exists for #{self.class}.") if @escape.nil?
+    end
+
+    def value(shift = nil)
+      escape_code = escape
+      escape_code += shift if shift && escape_code
+      name && escape ? "\e[#{escape_code}m" : ''
+    end
+
+    def to_s
+      value
+    end
+  end
+
+  class Effect < Code
+    def codes
+      EFFECTS
+    end
+  end
+
+  class TextColor < Code
+    def codes
+      COLORS
+    end
+  end
+
+  class BackgroundColor < TextColor
+    def value
+      super 10
+    end
+  end
+
+end

data/lib/colored2/numbers.rb

@@ -1,3 +1,11 @@
-require 'colored2'
-Colored2.decorate(Fixnum)
+require 'colored2' unless defined?(Colored2) && Colored2.respond_to?(:decorate)
+
+module Colored2
+  def self.integer_class
+    major, minor = RUBY_VERSION.split(/\./).map(&:to_i)
+    major >= 2 && minor >= 4 ? Integer : Kernel.const_get(:Fixnum)
+  end
+end
+
+Colored2.decorate(Colored2.integer_class)
 Colored2.decorate(Float)

data/lib/colored2/object.rb

@@ -1,2 +1,2 @@
-require 'colored2'
+require 'colored2' unless defined?(Colored2) && Colored2.respond_to?(:decorate)
 Colored2.decorate(Object)

data/lib/colored2/strings.rb

@@ -1,2 +1,2 @@
-require 'colored2'
+require 'colored2' unless defined?(Colored2) && Colored2.respond_to?(:decorate)
 Colored2.decorate(String)

data/lib/colored2/version.rb

@@ -1,3 +1,3 @@
 module Colored2
-  VERSION = '2.0.2'
+  VERSION = '3.1.2'
 end

data/spec/colored2/numbers_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path('spec/spec_helper')
+require 'colored2/numbers'
+require 'colored2/strings'
+
+RSpec.describe Colored2.integer_class do
+  describe 'with foreground and background colors' do
+    it 'should work with one color' do
+      expect(32.red).to eql('32'.red)
+    end
+    it 'should insert escape sequences' do
+      expect(32.red).to eql("\e[31m32\e[0m")
+    end
+  end
+end
+
+RSpec.describe Float do
+  describe 'with foreground and background colors' do
+    it 'should add two colors chained' do
+      expect((32.5).blue.on.red).to eql('32.5'.blue.on.red)
+    end
+
+    it 'should insert escape sequences' do
+      expect((32.5).blue.on.red).to eql("\e[41m\e[34m32.5\e[0m")
+    end
+  end
+end

data/spec/{colored2_object_spec.rb → colored2/object_spec.rb}

@@ -1,5 +1,5 @@
-require_relative 'spec_helper'
-require_relative '../lib/colored2/object'
+require File.expand_path('spec/spec_helper')
+require 'colored2/object'
 
 subject1 = red('hello')
 subject2 = red('blue').on.blue

data/spec/{colored2_string_spec.rb → colored2/strings_spec.rb}

@@ -1,5 +1,5 @@
-require_relative 'spec_helper'
-require_relative '../lib/colored2/strings'
+require File.expand_path('spec/spec_helper')
+require 'colored2/strings'
 
 RSpec.describe String do
   before do
@@ -44,20 +44,20 @@ RSpec.describe String do
     end
 
     it 'should defined block syntax nested colors two levels deep' do
-      expect('regular here'.blue! + 'blue here'.clear!).to eql('regular here' << 'blue here'.blue)
+      expect('regular here'.blue! + 'blue here'.no_color!).to eql('regular here' << 'blue here'.blue)
     end
 
     it 'should defined block syntax nested colors two levels deep' do
-      expect('regular here'.blue! { 'something else'.red!('red riding hood') }).to eql('regular here'.blue! << 'something else'.red! << 'red riding hood'.clear!)
+      expect('regular here'.blue! { 'something else'.red!('red riding hood') }).to eql('regular here'.blue! << 'something else'.red! << 'red riding hood'.no_color!)
     end
 
     it 'should defined block syntax nested colors two levels deep' do
       expectation = 'this is regular, but '.red! do
         'this is red '.yellow! do
-          ' and yellow'.clear!
+          ' and yellow'.no_color!
         end
       end
-      expect(expectation).to eql('this is regular, but '.red! << 'this is red '.yellow! << ' and yellow'.clear!)
+      expect(expectation).to eql('this is regular, but '.red! << 'this is red '.yellow! << ' and yellow'.no_color!)
     end
   end
 

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
+require 'simplecov'
+SimpleCov.start
 
 require 'rspec/core'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: colored2
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.1.2
 platform: ruby
 authors:
 - Chris Wanstrath
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2017-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -67,10 +67,10 @@ description: |+
     puts 'this is red with and italic'.red.italic
     puts 'this is green bold'.green.bold << ' and regular'.green
     puts 'this is really bold blue on white but reversed'.bold.blue.on.white.reversed
-    puts 'this is regular, but '.red! << 'this is red '.yellow! << ' and yellow.'.clear!
+    puts 'this is regular, but '.red! << 'this is red '.yellow! << ' and yellow.'.no_color!
     puts ('this is regular, but '.red! do
       'this is red '.yellow! do
-        ' and yellow.'.clear!
+        ' and yellow.'.no_color!
       end
     end)
 
@@ -84,15 +84,15 @@ files:
 - Rakefile
 - lib/colored2.rb
 - lib/colored2/ascii_decorator.rb
-- lib/colored2/constants.rb
+- lib/colored2/codes.rb
 - lib/colored2/numbers.rb
 - lib/colored2/object.rb
 - lib/colored2/strings.rb
 - lib/colored2/version.rb
-- spec/colored2_numbers_spec.rb
-- spec/colored2_object_spec.rb
+- spec/colored2/numbers_spec.rb
+- spec/colored2/object_spec.rb
+- spec/colored2/strings_spec.rb
 - spec/colored2_spec.rb
-- spec/colored2_string_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/kigster/colored2
 licenses:
@@ -114,13 +114,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Add even more color to your life.
 test_files:
-- spec/colored2_numbers_spec.rb
-- spec/colored2_object_spec.rb
+- spec/colored2/numbers_spec.rb
+- spec/colored2/object_spec.rb
+- spec/colored2/strings_spec.rb
 - spec/colored2_spec.rb
-- spec/colored2_string_spec.rb
 - spec/spec_helper.rb

data/lib/colored2/constants.rb

@@ -1,23 +0,0 @@
-module Colored2
-  COLORS  = {
-    black:     30,
-    red:       31,
-    green:     32,
-    yellow:    33,
-    blue:      34,
-    magenta:   35,
-    cyan:      36,
-    white:     37
-  }
-  EFFECTS = {
-    clear:      0,
-    bold:       1,
-    dark:       2,
-    italic:     3,
-    underlined: 4,
-    reversed:   7,
-    plain:      21, # non-bold
-    normal:     22
-  }
-  ESCAPES = COLORS.merge(EFFECTS)
-end

data/spec/colored2_numbers_spec.rb

@@ -1,19 +0,0 @@
-require_relative 'spec_helper'
-require_relative '../lib/colored2/numbers'
-require_relative '../lib/colored2/strings'
-
-RSpec.describe Fixnum do
-  describe 'with foreground and background colors' do
-    it 'should work with one color' do
-      expect(32.red).to eql('32'.red)
-    end
-  end
-end
-
-RSpec.describe Float do
-  describe 'with foreground and background colors' do
-    it 'should add two colors chained' do
-      expect((32.5).blue.on.red).to eql('32.5'.blue.on.red)
-    end
-  end
-end