rainbow 1.99.0 → 2.0.0

data/lib/rainbow/wrapper.rb

@@ -1,76 +1,22 @@
-require 'rainbow/core'
-require 'rainbow/string_utils'
-require 'rainbow/color'
+require 'rainbow/presenter'
+require 'rainbow/null_presenter'
 
 module Rainbow
 
-  class Wrapper < ::String
+  class Wrapper
+    attr_accessor :enabled
 
-    # Sets foreground color of this text.
-    def foreground(*values)
-      wrap_with_sgr(Color.build(:foreground, values).codes)
+    def initialize(enabled = true)
+      @enabled = enabled
     end
 
-    alias_method :color, :foreground
-    alias_method :colour, :foreground
-
-    # Sets background color of this text.
-    def background(*values)
-      wrap_with_sgr(Color.build(:background, values).codes)
-    end
-
-    # Resets terminal to default colors/backgrounds.
-    #
-    # It shouldn't be needed to use this method because all methods
-    # append terminal reset code to end of string.
-    def reset
-      wrap_with_sgr(TERM_EFFECTS[:reset])
-    end
-
-    # Turns on bright/bold for this text.
-    def bright
-      wrap_with_sgr(TERM_EFFECTS[:bright])
-    end
-
-    # Turns on italic style for this text (not well supported by terminal
-    # emulators).
-    def italic
-      wrap_with_sgr(TERM_EFFECTS[:italic])
-    end
-
-    # Turns on underline decoration for this text.
-    def underline
-      wrap_with_sgr(TERM_EFFECTS[:underline])
-    end
-
-    # Turns on blinking attribute for this text (not well supported by terminal
-    # emulators).
-    def blink
-      wrap_with_sgr(TERM_EFFECTS[:blink])
+    def wrap(string)
+      if enabled
+        Rainbow::Presenter.new(string.to_s)
+      else
+        Rainbow::NullPresenter.new(string.to_s)
+      end
     end
-
-    # Inverses current foreground/background colors.
-    def inverse
-      wrap_with_sgr(TERM_EFFECTS[:inverse])
-    end
-
-    # Hides this text (set its color to the same as background).
-    def hide
-      wrap_with_sgr(TERM_EFFECTS[:hide])
-    end
-
-    private
-
-    def wrap_with_sgr(codes) #:nodoc:
-      return self unless Rainbow.enabled
-
-      self.class.new(StringUtils.wrap_with_sgr(self, [*codes]))
-    end
-
   end
 
 end
-
-def Rainbow(string)
-  Rainbow::Wrapper.new(string.to_s)
-end

data/lib/rainbow.rb

@@ -1,26 +1,24 @@
-require 'rainbow/core'
-require 'rainbow/wrapper'
-require 'rainbow/string'
+require 'rainbow/global'
 require 'rainbow/legacy'
 
-unless STDOUT.tty? && STDERR.tty?
-  Rainbow.enabled = false
-end
+module Rainbow
 
-if ENV['TERM'] == 'dumb'
-  Rainbow.enabled = false
-end
+  def self.new
+    Wrapper.new(global.enabled)
+  end
 
-if ENV['CLICOLOR_FORCE'] == '1'
-  Rainbow.enabled = true
-end
+  self.enabled = false unless STDOUT.tty? && STDERR.tty?
+  self.enabled = false if ENV['TERM'] == 'dumb'
+  self.enabled = true if ENV['CLICOLOR_FORCE'] == '1'
 
-# On Windows systems, try to load the local ANSI support library
-require 'rbconfig'
-if RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
-  begin
-    require 'Win32/Console/ANSI'
-  rescue LoadError
-    Rainbow.enabled = false
+  # On Windows systems, try to load the local ANSI support library
+  require 'rbconfig'
+  if RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+    begin
+      require 'Win32/Console/ANSI'
+    rescue LoadError
+      self.enabled = false
+    end
   end
+
 end

data/rainbow.gemspec

@@ -4,14 +4,15 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rainbow/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rainbow"
-  spec.version       = Rainbow::VERSION
-  spec.authors       = ["Marcin Kulik"]
-  spec.email         = ["m@ku1ik.com"]
-  spec.description   = %q{Colorize printed text on ANSI terminals}
-  spec.summary       = %q{Colorize printed text on ANSI terminals}
-  spec.homepage      = "https://github.com/sickill/rainbow"
-  spec.license       = "MIT"
+  spec.name                  = "rainbow"
+  spec.version               = Rainbow::VERSION
+  spec.authors               = ["Marcin Kulik"]
+  spec.email                 = ["m@ku1ik.com"]
+  spec.description           = %q{Colorize printed text on ANSI terminals}
+  spec.summary               = %q{Colorize printed text on ANSI terminals}
+  spec.homepage              = "https://github.com/sickill/rainbow"
+  spec.license               = "MIT"
+  spec.required_ruby_version = '>= 1.9.2'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -21,5 +22,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency 'mime-types', '< 2.0.0' if RUBY_VERSION < "1.9.0"
 end

data/spec/integration/instance_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'rainbow'
+
+describe 'Custom Rainbow instance' do
+
+  it 'inherits enabled state from the global instance' do
+    Rainbow.enabled = :yep
+    expect(Rainbow.new.enabled).to eq(:yep)
+  end
+
+  it 'tracks its own state separately from the global instance' do
+    Rainbow.enabled = :yep
+    rainbow = Rainbow.new
+    expect(Rainbow.new.enabled).to eq(:yep)
+
+    rainbow.enabled = :nope
+    expect(Rainbow.enabled).to eq(:yep)
+    expect(rainbow.enabled).to eq(:nope)
+  end
+
+  it 'wraps string with escape codes when enabled' do
+    rainbow = Rainbow.new
+    rainbow.enabled = true
+
+    expect(rainbow.wrap('hello').green).to eq("\e[32mhello\e[0m")
+  end
+
+  it "doesn't wrap string with any escape code when disabled" do
+    rainbow = Rainbow.new
+    rainbow.enabled = false
+
+    expect(rainbow.wrap('hello').green).to eq('hello')
+  end
+
+end

data/spec/integration/rainbow_spec.rb

@@ -3,6 +3,10 @@ require 'rainbow'
 
 describe 'Rainbow() wrapper' do
 
+  before do
+    Rainbow.enabled = true
+  end
+
   it 'allows foreground coloring by color number' do
     result = Rainbow('hello').foreground(5)
     expect(result).to eq("\e[35mhello\e[0m")
@@ -13,6 +17,11 @@ describe 'Rainbow() wrapper' do
     expect(result).to eq("\e[31mhello\e[0m")
   end
 
+  it 'allows foreground coloring directly by method name' do
+    result = Rainbow('hello').red
+    expect(result).to eq("\e[31mhello\e[0m")
+  end
+
   it 'allows foreground coloring by color name (color alias)' do
     result = Rainbow('hello').color(:red)
     expect(result).to eq("\e[31mhello\e[0m")
@@ -100,19 +109,17 @@ describe 'Rainbow() wrapper' do
       inverse.
       hide
 
-    expect(result).to eq("\e[31m\e[1m\e[3m\e[48;5;215m\e[4m\e[34m\e[5m\e[7m\e[8mhello\e[0m")
+    expect(result).to eq(
+      "\e[31m\e[1m\e[3m\e[48;5;215m\e[4m\e[34m\e[5m\e[7m\e[8mhello\e[0m"
+    )
   end
 
   context "when Rainbow is disabled" do
+
     before do
-      @enabled = Rainbow.enabled
       Rainbow.enabled = false
     end
 
-    after do
-      Rainbow.enabled = @enabled
-    end
-
     it "allows chaining but doesn't wrap with escape codes" do
       result = Rainbow('hello').
         foreground(:red).

data/spec/integration/string_spec.rb

@@ -1,8 +1,12 @@
 require 'spec_helper'
-require 'rainbow/string'
+require 'rainbow/ext/string'
 
 describe 'String mixin' do
 
+  before do
+    Rainbow.enabled = true
+  end
+
   it 'proxies foreground to Rainbow().foreground' do
     expect('hello'.foreground(:red)).to eq(Rainbow('hello').foreground(:red))
   end
@@ -47,4 +51,26 @@ describe 'String mixin' do
     expect('hello'.reset).to eq(Rainbow('hello').reset)
   end
 
+  context "when Rainbow is disabled" do
+
+    before do
+      Rainbow.enabled = false
+    end
+
+    it "allows chaining but doesn't wrap with escape codes" do
+      result = 'hello'.
+        foreground(:red).
+        bright.
+        italic.
+        background('#ff8040').
+        underline.
+        color(:blue).
+        blink.
+        inverse.
+        hide
+
+      expect(result).to eq('hello')
+    end
+  end
+
 end

data/spec/spec_helper.rb

@@ -3,8 +3,4 @@ if ENV["CI"] && (!defined?(RUBY_ENGINE) || RUBY_ENGINE == "ruby")
   Coveralls.wear!
 end
 
-RSpec.configure do |config|
-  config.before(:each) do
-    Rainbow.enabled = true
-  end
-end
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |file| require file }

data/spec/support/presenter_shared_examples.rb

@@ -0,0 +1,9 @@
+shared_examples_for "presenter with shortcut color methods" do
+  [:black, :red, :green, :yellow, :blue, :magenta, :cyan, :white].each do |name|
+    describe "##{name}" do
+      subject { presenter.public_send(name) }
+
+      it { should eq(presenter.color(name)) }
+    end
+  end
+end

data/spec/unit/null_presenter_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+require 'rainbow/null_presenter'
+
+module Rainbow
+  describe NullPresenter do
+
+    let(:presenter) { described_class.new('hello') }
+
+    shared_examples_for "rainbow null string method" do
+      it "doesn't wrap the text with any sgr sequence" do
+        expect(subject).to eq('hello')
+      end
+
+      it "returns an instance of Rainbow::NullPresenter" do
+        expect(subject).to be_kind_of(Rainbow::NullPresenter)
+      end
+    end
+
+    describe '#color' do
+      subject { presenter.color(:arg1, 'arg2') }
+
+      it_behaves_like "rainbow null string method"
+    end
+
+    describe '#foreground' do
+      subject { presenter.foreground(:arg1, 'arg2') }
+
+      it_behaves_like "rainbow null string method"
+    end
+
+    describe '#fg' do
+      subject { presenter.fg(:arg1, 'arg2') }
+
+      it_behaves_like "rainbow null string method"
+    end
+
+    describe '#background' do
+      subject { presenter.background(:arg1, 'arg2') }
+
+      it_behaves_like "rainbow null string method"
+    end
+
+    describe '#bg' do
+      subject { presenter.bg(:arg1, 'arg2') }
+
+      it_behaves_like "rainbow null string method"
+    end
+
+    describe '#reset' do
+      subject { presenter.reset }
+
+      it_behaves_like "rainbow null string method"
+    end
+
+    describe '#bright' do
+      subject { presenter.bright }
+
+      it_behaves_like "rainbow null string method"
+    end
+
+    describe '#italic' do
+      subject { presenter.italic }
+
+      it_behaves_like "rainbow null string method"
+    end
+
+    describe '#underline' do
+      subject { presenter.underline }
+
+      it_behaves_like "rainbow null string method"
+    end
+
+    describe '#blink' do
+      subject { presenter.blink }
+
+      it_behaves_like "rainbow null string method"
+    end
+
+    describe '#inverse' do
+      subject { presenter.inverse }
+
+      it_behaves_like "rainbow null string method"
+    end
+
+    describe '#hide' do
+      subject { presenter.hide }
+
+      it_behaves_like "rainbow null string method"
+    end
+
+    it_behaves_like "presenter with shortcut color methods"
+  end
+end

data/spec/unit/presenter_spec.rb

@@ -0,0 +1,168 @@
+require 'spec_helper'
+require 'rainbow/presenter'
+
+module Rainbow
+  describe Presenter do
+
+    let(:presenter) { described_class.new('hello') }
+
+    shared_examples_for "rainbow string method" do
+      it "wraps the text with a sgr sequence" do
+        expect(subject).to eq('[hello]')
+      end
+
+      it "returns an instance of Rainbow::Presenter" do
+        expect(subject).to be_kind_of(Rainbow::Presenter)
+      end
+    end
+
+    shared_examples_for "text color method" do
+      let(:color) { double('color', codes: [1, 2]) }
+
+      before do
+        allow(Color).to receive(:build).
+          with(:foreground, [:arg1, 'arg2']) { color }
+      end
+
+      it_behaves_like "rainbow string method"
+
+      it 'wraps with color codes' do
+        subject
+        expect(StringUtils).to have_received(:wrap_with_sgr).
+          with('hello', [1, 2])
+      end
+    end
+
+    shared_examples_for "text background method" do
+      let(:color) { double('color', codes: [1, 2]) }
+
+      before do
+        allow(Color).to receive(:build).
+          with(:background, [:arg1, 'arg2']) { color }
+      end
+
+      it_behaves_like "rainbow string method"
+
+      it 'wraps with color codes' do
+        subject
+        expect(StringUtils).to have_received(:wrap_with_sgr).
+          with('hello', [1, 2])
+      end
+    end
+
+    before do
+      allow(StringUtils).to receive(:wrap_with_sgr) { '[hello]' }
+    end
+
+    describe '#color' do
+      subject { presenter.color(:arg1, 'arg2') }
+
+      it_behaves_like "text color method"
+    end
+
+    describe '#foreground' do
+      subject { presenter.foreground(:arg1, 'arg2') }
+
+      it_behaves_like "text color method"
+    end
+
+    describe '#fg' do
+      subject { presenter.fg(:arg1, 'arg2') }
+
+      it_behaves_like "text color method"
+    end
+
+    describe '#background' do
+      subject { presenter.background(:arg1, 'arg2') }
+
+      it_behaves_like "text background method"
+    end
+
+    describe '#bg' do
+      subject { presenter.bg(:arg1, 'arg2') }
+
+      it_behaves_like "text background method"
+    end
+
+    describe '#reset' do
+      subject { presenter.reset }
+
+      it_behaves_like "rainbow string method"
+
+      it 'wraps with 0 code' do
+        subject
+        expect(StringUtils).to have_received(:wrap_with_sgr).with('hello', [0])
+      end
+    end
+
+    describe '#bright' do
+      subject { presenter.bright }
+
+      it_behaves_like "rainbow string method"
+
+      it 'wraps with 1 code' do
+        subject
+        expect(StringUtils).to have_received(:wrap_with_sgr).with('hello', [1])
+      end
+    end
+
+    describe '#italic' do
+      subject { presenter.italic }
+
+      it_behaves_like "rainbow string method"
+
+      it 'wraps with 3 code' do
+        subject
+        expect(StringUtils).to have_received(:wrap_with_sgr).
+          with('hello', [3])
+      end
+    end
+
+    describe '#underline' do
+      subject { presenter.underline }
+
+      it_behaves_like "rainbow string method"
+
+      it 'wraps with 4 code' do
+        subject
+        expect(StringUtils).to have_received(:wrap_with_sgr).with('hello', [4])
+      end
+    end
+
+    describe '#blink' do
+      subject { presenter.blink }
+
+      it_behaves_like "rainbow string method"
+
+      it 'wraps with 5 code' do
+        subject
+        expect(StringUtils).to have_received(:wrap_with_sgr).with('hello', [5])
+      end
+    end
+
+    describe '#inverse' do
+      subject { presenter.inverse }
+
+      it_behaves_like "rainbow string method"
+
+      it 'wraps with 7 code' do
+        subject
+        expect(StringUtils).to have_received(:wrap_with_sgr).with('hello', [7])
+      end
+    end
+
+    describe '#hide' do
+      subject { presenter.hide }
+
+      it_behaves_like "rainbow string method"
+
+      it 'wraps with 8 code' do
+        subject
+        expect(StringUtils).to have_received(:wrap_with_sgr).with('hello', [8])
+      end
+    end
+
+    it_behaves_like "presenter with shortcut color methods"
+
+  end
+end