colored2 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a23ca7f2255c16d188e9666fe9ef292129470141
+  data.tar.gz: c242e7fa809669503778e851d6cd68a8079c3830
+SHA512:
+  metadata.gz: 9be8019ddb511d36eb5021459700946d514430744e75ffacce4976c41ce920847ac27aa6bb973c672be89cf1939073617802b01712c265bf8801d18d7afd1d76
+  data.tar.gz: 220144edad3f117953a5abfb390dd0404b71dce699a2156d1de5213a4ec5dd276e25c594a6769935cf891a202331917cd8a578f84d0efe534a9305620566f481

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Konstantin Gredeskoul
+
+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,31 @@
+[![Gem Version](https://badge.fury.io/rb/colored2.svg)](https://badge.fury.io/rb/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)
+
+## Colored2
+
+This is a fork of Chris (defunkt) Wanstrath's colored gem, which appears to be no longer supported.
+
+This fork comes with a slightly spruced up syntax and rspecs.
+
+## 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.
+
+![](doc/colored2-session1.png)
+
+## Usage in Other Classes
+
+You can decorate and color not just strings. 
+
+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.
+
+Below is an `IRB` session that shows a slightly more advanced usage.
+
+![](doc/colored2-session2.png)

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rake/clean'
+
+CLEAN.include %w(pkg coverage *.gem)
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => [:spec]

data/lib/colored2.rb

@@ -0,0 +1,77 @@
+require 'colored2/constants'
+require 'colored2/ascii_decorator'
+
+module Colored2
+  def self.decorate(a_class)
+    a_class.send(:include, Colored2)
+  end
+
+  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?
+                       Colored2.foreground_next!
+                       :background
+                     else
+                       :foreground
+                     end
+
+        if color_self then
+          opts = { beginning: :on, end: :off, color_type => color_or_effect, effect: color_or_effect }
+          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}
+          colored = Colored2::AsciiDecorator.new(self).decorate(opts)
+          if string || block
+            arg = "#{string}#{block.call if block}"
+            colored << Colored2::AsciiDecorator.new(arg).decorate(opts.merge(end: :off)) if arg.length > 0
+          end
+        end
+        colored
+      end
+
+      def on
+        Colored2.background_next!
+        self
+      end
+    end
+
+    from_class.instance_eval do
+      COLORS.keys.each do |color|
+        define_method(color) do |string = nil, &block|
+          surround_with_color(color, true, string, &block)
+        end
+
+        define_method("#{color}!".to_sym) do |string = nil, &block|
+          surround_with_color(color, false, string, &block)
+        end
+      end
+
+      EFFECTS.keys.each do |effect|
+        next if effect == 'clear'
+        define_method(effect) do |string = nil, &block|
+          surround_with_color(effect, true, string, &block)
+        end
+
+        define_method("#{effect}!".to_sym) do |string = nil, &block|
+          surround_with_color(effect, false, string, &block)
+        end
+      end
+
+      define_method(:to_eol) do
+        tmp = sub(/^(\e\[[\[\e0-9;m]+m)/, "\\1\e[2K")
+        if tmp == self
+          return "\e[2K" << self
+        end
+        tmp
+      end
+    end
+  end
+end
+
+require 'colored2/strings'

data/lib/colored2/ascii_decorator.rb

@@ -0,0 +1,101 @@
+require_relative 'constants'
+require 'forwardable'
+
+module Colored2
+  def self.enable!
+    Colored2::AsciiDecorator.enable!
+  end
+  def self.disable!
+    Colored2::AsciiDecorator.disable!
+  end
+  def self.background_next!
+    Colored2::AsciiDecorator.background_next!
+  end
+  def self.foreground_next!
+    Colored2::AsciiDecorator.foreground_next!
+  end
+  def self.background_next?
+    Colored2::AsciiDecorator.background_next?
+  end
+
+  class AsciiDecorator
+    @__background_next = false
+    @__colors_disabled = false
+    class << self
+      attr_accessor :__background_next, :__colors_disabled
+      def enable!
+        self.__colors_disabled = false
+      end
+      def enabled?
+        !self.__colors_disabled
+      end
+      def disable!
+        self.__colors_disabled = true
+      end
+      def background_next!
+        self.__background_next = true
+      end
+      def foreground_next!
+        self.__background_next = false
+      end
+      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
+
+    attr_accessor :string, :my_class
+
+    def initialize(a_string)
+      self.string = a_string.instance_of?(Object) ? '' : a_string.to_s
+      self.my_class = self.class
+    end
+
+    # options[:start] = :color
+    # options[:end]   = :color | :clear
+    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])
+      ].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 << escape_sequence if options[:end] == :on
+      end
+      colored
+    end
+
+    def un_decorate
+      string.gsub(%r{\e\[\d+(;\d+)*m}, '')
+    end
+
+  end
+end

data/lib/colored2/constants.rb

@@ -0,0 +1,23 @@
+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/lib/colored2/numbers.rb

@@ -0,0 +1,3 @@
+require 'colored2'
+Colored2.decorate(Fixnum)
+Colored2.decorate(Float)

data/lib/colored2/object.rb

@@ -0,0 +1,2 @@
+require 'colored2'
+Colored2.decorate(Object)

data/lib/colored2/strings.rb

@@ -0,0 +1,2 @@
+require 'colored2'
+Colored2.decorate(String)

data/lib/colored2/version.rb

@@ -0,0 +1,3 @@
+module Colored2
+  VERSION = '2.0.0'
+end

data/spec/colored2_numbers_spec.rb

@@ -0,0 +1,19 @@
+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

data/spec/colored2_object_spec.rb

@@ -0,0 +1,24 @@
+require_relative 'spec_helper'
+require_relative '../lib/colored2/object'
+
+subject1 = red('hello')
+subject2 = red('blue').on.blue
+subject3 = on.yellow('on yellow')
+
+RSpec.describe Object do
+
+  describe 'with foreground and background colors' do
+    it 'should work with one color' do
+      expect(subject1).to eql('hello'.red)
+    end
+
+    it 'should work with color on color' do
+      expect(subject2).to eql('blue'.red.on.blue)
+    end
+
+    it 'should add background color using on_<color>' do
+      expect(subject3).to eql('on yellow'.on.yellow)
+    end
+
+  end
+end

data/spec/colored2_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'colored2/strings'
+
+RSpec.describe Colored2 do
+  describe 'global enable and disable' do
+    before do
+      Colored2.disable!
+    end
+    after do
+      Colored2.enable!
+    end
+    let(:sample) { 'sample string' }
+
+    describe 'colors' do
+      subject { sample.red.on.blue }
+      it { should eql(sample) }
+    end
+    describe 'effects' do
+      subject { sample.bold.on.red }
+      it { should eql(sample) }
+    end
+  end
+end

data/spec/colored2_string_spec.rb

@@ -0,0 +1,77 @@
+require_relative 'spec_helper'
+require_relative '../lib/colored2/strings'
+
+RSpec.describe String do
+  before do
+    Colored2.decorate(String)
+  end
+
+  describe 'with foreground and background colors' do
+    it 'should work with one color' do
+      expect('red'.red).to eql("\e[31mred\e[0m")
+    end
+
+    it 'should add two colors chained' do
+      expect('blue'.red.blue).to eql("\e[34m\e[31mblue\e[0m")
+    end
+
+    it 'should add background color using on_<color>' do
+      expect('on yellow'.on.yellow).to eql("\e[43mon yellow\e[0m")
+    end
+
+    it 'should work with <color>_on_<color> syntax' do
+      expect('red on blue'.red.on.blue).to eql("\e[44m\e[31mred on blue\e[0m")
+    end
+  end
+
+  describe 'with effects' do
+    it 'should add a bold modifier' do
+      expect('way bold'.bold).to eql("\e[1mway bold\e[0m")
+    end
+
+    it 'should let modifiers stack' do
+      expect('underlinedd bold'.bold.underlined).to eql("\e[4m\e[1munderlinedd bold\e[0m")
+    end
+
+    it 'should let modifiers stack with colors' do
+      expect('cyan underlinedd bold'.bold.underlined.cyan).to eql("\e[36m\e[4m\e[1mcyan underlinedd bold\e[0m")
+    end
+  end
+
+  describe 'new block syntax' do
+    it 'should defined block syntax nested colors' do
+      expect('No Color, then'.blue!('blue inside')).to eql('No Color, then' + 'blue inside'.blue)
+    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)
+    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!)
+    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!
+        end
+      end
+      expect(expectation).to eql('this is regular, but '.red! << 'this is red '.yellow! << ' and yellow'.clear!)
+    end
+  end
+
+  describe 'end of line' do
+    it 'should work with eol' do
+      expect('nothing to see here really.'.to_eol).to eql("\e[2Knothing to see here really.")
+    end
+
+    it 'should work with eol_with_with_two_colors' do
+      expect('blue'.red.blue.to_eol).to eql("\e[34m\e[31m\e[2Kblue\e[0m")
+    end
+
+    it 'should work with eol_with_modifiers_stack_with_colors' do
+      expect('cyan underlinedd bold'.bold.underlined.cyan.to_eol).to eql("\e[36m\e[4m\e[1m\e[2Kcyan underlinedd bold\e[0m")
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: colored2
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Konstantin Gredeskoul
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |+
+  This is a heavily modified fork of http://github.com/defunkt/colored gem, with many
+  sensible pull requests combined. Since the authors of the original gem no longer support it,
+  this might, perhaps, be considered a good alternative.
+
+  Simple gem that adds various color methods to String class, and can be used as follows:
+
+    require 'colored2'
+
+    puts 'this is red'.red
+    puts 'this is red with a yellow background'.red.on.yellow
+    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! do
+      'this is red '.yellow! do
+        ' and yellow.'.clear!
+      end
+    end)
+
+email: kig@reinvent.one
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/colored2.rb
+- lib/colored2/ascii_decorator.rb
+- lib/colored2/constants.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_spec.rb
+- spec/colored2_string_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kigster/colored
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+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_spec.rb
+- spec/colored2_string_spec.rb
+- spec/spec_helper.rb