pastel 0.5.3 → 0.6.0

data/lib/pastel/color_parser.rb

@@ -0,0 +1,117 @@
+# encoding: utf-8
+
+module Pastel
+  # Responsible for parsing color symbols out of text with color escapes
+  #
+  # Used internally by {Color}.
+  #
+  # @api private
+  class ColorParser
+    include ANSI
+
+    ESC = "\x1b".freeze
+    CSI = "\[".freeze
+
+    # Parse color escape sequences into a list of hashes
+    # corresponding to the color attributes being set by these
+    # sequences
+    #
+    # @example
+    #   parse("\e[32mfoo\e[0m") # => [{colors: [:green], text: 'foo'}
+    #
+    # @param [String] text
+    #   the text to parse for presence of color ansi codes
+    #
+    # @return [Array[Hash[Symbol,String]]]
+    #
+    # @api public
+    def self.parse(text)
+      scanner = StringScanner.new(text)
+      state = {}
+      result = []
+      ansi_stack = []
+      text_chunk = ''
+
+      until scanner.eos?
+        char = scanner.getch
+        # match control
+        if char == ESC && (delim = scanner.getch) == CSI
+          if scanner.scan(/^0m/)
+            unpack_ansi(ansi_stack) { |attr, name| state[attr] = name }
+            ansi_stack = []
+          elsif scanner.scan(/^([1-9;:]+)m/)
+            # ansi codes separated by text
+            if !text_chunk.empty? && !ansi_stack.empty?
+              unpack_ansi(ansi_stack) { |attr, name| state[attr] = name }
+              ansi_stack = []
+            end
+            scanner[1].split(/:|;/).each do |code|
+              ansi_stack << code
+            end
+          end
+
+          if !text_chunk.empty?
+            state[:text] = text_chunk
+            result.push(state)
+            state = {}
+            text_chunk = ''
+          end
+        elsif char == ESC # broken escape
+          text_chunk << char + delim.to_s
+        else
+          text_chunk << char
+        end
+      end
+
+      if !text_chunk.empty?
+        state[:text] = text_chunk
+      end
+      if !ansi_stack.empty?
+        unpack_ansi(ansi_stack) { |attr, name| state[attr] = name}
+      end
+      if state.values.any? { |val| !val.empty? }
+        result.push(state)
+      end
+      result
+    end
+
+    # Remove from current stack all ansi codes
+    #
+    # @param [Array[Integer]] ansi_stack
+    #   the stack with all the ansi codes
+    #
+    # @yield [Symbol, Symbol] attr, name
+    #
+    # @api private
+    def self.unpack_ansi(ansi_stack)
+      ansi_stack.each do |ansi|
+        name = ansi_for(ansi)
+        attr = attribute_for(ansi)
+        yield attr, name
+      end
+    end
+
+    # Decide attribute name for ansi
+    #
+    # @param [Integer] ansi
+    #   the ansi escape code
+    #
+    # @return [Symbol]
+    #
+    # @api private
+    def self.attribute_for(ansi)
+      if ANSI.foreground?(ansi)
+        :foreground
+      elsif ANSI.background?(ansi)
+        :background
+      elsif ANSI.style?(ansi)
+        :style
+      end
+    end
+
+    # @api private
+    def self.ansi_for(ansi)
+      ATTRIBUTES.key(ansi.to_i)
+    end
+  end # Parser
+end # Pastel

data/lib/pastel/color_resolver.rb

@@ -7,6 +7,8 @@ module Pastel
   #
   # @api private
   class ColorResolver
+    # The color instance
+    # @api public
     attr_reader :color
 
     # Initialize ColorResolver
@@ -14,7 +16,7 @@ module Pastel
     # @param [Color] color
     #
     # @api private
-    def initialize(color = Color.new)
+    def initialize(color)
       @color = color
     end
 

data/lib/pastel/delegator.rb

@@ -10,7 +10,10 @@ module Pastel
     include Equatable
 
     def_delegators '@resolver.color', :valid?, :styles, :strip, :decorate,
-                   :enabled?, :colored?, :alias_color
+                   :enabled?, :colored?, :alias_color, :lookup
+
+    def_delegators ColorParser, :parse
+    alias_method :undecorate, :parse
 
     # Create Delegator
     #

data/lib/pastel/version.rb

@@ -1,5 +1,5 @@
 # coding: utf-8
 
 module Pastel
-  VERSION = "0.5.3"
+  VERSION = "0.6.0"
 end

data/pastel.gemspec

@@ -15,11 +15,12 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "equatable",  "~> 0.5.0"
-  spec.add_dependency "tty-screen", "~> 0.4.3"
+  spec.add_dependency 'equatable', '~> 0.5.0'
+  spec.add_dependency 'tty-color', '~> 0.3.0'
 
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
+  spec.add_development_dependency 'rake'
 end

data/spec/unit/alias_color_spec.rb

@@ -1,8 +1,6 @@
 # coding: utf-8
 
-require 'spec_helper'
-
-RSpec.describe Pastel, '.alias_color' do
+RSpec.describe Pastel, '#alias_color' do
 
   subject(:pastel) { described_class.new(enabled: true) }
 

data/spec/unit/alias_importer_spec.rb

@@ -1,31 +1,28 @@
 # coding: utf-8
 
-require 'spec_helper'
-
-RSpec.describe Pastel::AliasImporter, '.import' do
+RSpec.describe Pastel::AliasImporter, '#import' do
   let(:color) { spy(:color, alias_color: true) }
   let(:output) { StringIO.new }
 
-  subject(:importer) { described_class.new(color, output) }
-
   it "imports aliases from environment" do
     color_aliases = "funky=red,base=bright_yellow"
-    allow(ENV).to receive(:[]).with('PASTEL_COLORS_ALIASES').
-      and_return(color_aliases)
+    env = {'PASTEL_COLORS_ALIASES' => color_aliases}
+    importer = described_class.new(color, env)
 
     importer.import
 
-    expect(color).to have_received(:alias_color).twice
+    expect(color).to have_received(:alias_color).with(:funky, :red)
+    expect(color).to have_received(:alias_color).with(:base, :bright_yellow)
   end
 
   it "fails to import incorrectly formatted colors" do
     color_aliases = "funky red,base=bright_yellow"
-    allow(ENV).to receive(:[]).with('PASTEL_COLORS_ALIASES').
-      and_return(color_aliases)
+    env = {'PASTEL_COLORS_ALIASES' => color_aliases}
+    importer = described_class.new(color, env, output)
+    output.rewind
 
     importer.import
 
-    output.rewind
     expect(output.string).to eq("Bad color mapping `funky red`\n")
     expect(color).to have_received(:alias_color).with(:base, :bright_yellow)
   end

data/spec/unit/color/alias_color_spec.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-require 'spec_helper'
-
 RSpec.describe Pastel::Color, '.alias_color' do
 
   subject(:color) { described_class.new(enabled: true) }

data/spec/unit/color/code_spec.rb

@@ -1,8 +1,6 @@
 # encoding: utf-8
 
-require 'spec_helper'
-
-RSpec.describe Pastel::Color, '.code' do
+RSpec.describe Pastel::Color, '#code' do
   let(:string) { "This is a \e[1m\e[34mbold blue text\e[0m" }
 
   subject(:color) { described_class.new(enabled: true) }

data/spec/unit/color/colored_spec.rb

@@ -1,8 +1,6 @@
 # encoding: utf-8
 
-require 'spec_helper'
-
-RSpec.describe Pastel::Color, '.colored?' do
+RSpec.describe Pastel::Color, '#colored?' do
   subject(:color) { described_class.new(enabled: true) }
 
   it "checks if string has color codes" do

data/spec/unit/color/decorate_spec.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-require 'spec_helper'
-
 RSpec.describe Pastel::Color, '.decorate' do
   let(:string) { 'string' }
 
@@ -16,6 +14,10 @@ RSpec.describe Pastel::Color, '.decorate' do
     expect(color.decorate('')).to eq('')
   end
 
+  it "doesn't decorate without color" do
+    expect(color.decorate(string)).to eq(string)
+  end
+
   it 'applies green text to string' do
     expect(color.decorate(string, :green)).to eq("\e[32m#{string}\e[0m")
   end
@@ -35,7 +37,7 @@ RSpec.describe Pastel::Color, '.decorate' do
 
   it "applies styles to nested text" do
     decorated = color.decorate(string + color.decorate(string, :red) + string, :green)
-    expect(decorated).to eq("\e[32m#{string}\e[31m#{string}\e[32m#{string}\e[0m")
+    expect(decorated).to eq("\e[32m#{string}\e[31m#{string}\e[0m\e[32m#{string}\e[0m")
   end
 
   it "decorates multiline string as regular by default" do

data/spec/unit/color/equal_spec.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-require 'spec_helper'
-
 RSpec.describe Pastel::Color, '#==' do
   it "is true with the same enabled and eachline attributes" do
     expect(Pastel::Color.new(enabled: false, eachline: "\n")).

data/spec/unit/color/lookup_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+RSpec.describe Pastel::Color, '#lookup' do
+  it "looksup colors" do
+    color = described_class.new(enabled: true)
+    expect(color.lookup(:red, :on_green, :bold)).to eq("\e[31;42;1m")
+  end
+
+  it "caches color lookups" do
+    color = described_class.new(enabled: true)
+    allow(color).to receive(:code).and_return([31])
+    color.lookup(:red, :on_green)
+    color.lookup(:red, :on_green)
+    color.lookup(:red, :on_green)
+    expect(color).to have_received(:code).once
+  end
+end

data/spec/unit/color/new_spec.rb

@@ -1,24 +1,10 @@
 # encoding: utf-8
 
-require 'spec_helper'
-
-RSpec.describe Pastel::Color, '.new' do
-  it "is immutable" do
-    expect(described_class.new).to be_frozen
-  end
-
+RSpec.describe Pastel::Color, '::new' do
   it "allows to disable coloring" do
     color = described_class.new(enabled: false)
 
     expect(color.enabled?).to eq(false)
     expect(color.decorate("Unicorn", :red)).to eq("Unicorn")
   end
-
-  it "invokes screen dependency to check color support" do
-    allow(TTY::Screen).to receive(:color?).and_return(true)
-    color = described_class.new
-
-    expect(color.enabled?).to eq(true)
-    expect(TTY::Screen).to have_received(:color?)
-  end
 end

data/spec/unit/color/strip_spec.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-require 'spec_helper'
-
 RSpec.describe Pastel::Color, '.strip' do
 
   subject(:color) { described_class.new(enabled: true) }
@@ -18,7 +16,7 @@ RSpec.describe Pastel::Color, '.strip' do
 
   it 'preserves movement characters' do
     # [176A - move cursor up n lines
-    expect(color.strip("foo\e[176Abar")).to eq('foobar')
+    expect(color.strip("foo\e[176Abar")).to eq("foo\e[176Abar")
   end
 
   it 'strips reset/setfg/setbg/italics/strike/underline sequence' do
@@ -28,7 +26,7 @@ RSpec.describe Pastel::Color, '.strip' do
 
   it 'strips octal in encapsulating brackets' do
     string = "\[\033[01;32m\]u@h \[\033[01;34m\]W $ \[\033[00m\]"
-    expect(color.strip(string)).to eq('u@h W $ ')
+    expect(color.strip(string)).to eq('[]u@h []W $ []')
   end
 
   it 'strips octal codes without brackets' do
@@ -37,7 +35,7 @@ RSpec.describe Pastel::Color, '.strip' do
   end
 
   it 'strips octal with multiple colors' do
-    string = "\e[3;0;0;tfoo\e[8;50;0t"
+    string = "\e[3;0;0;mfoo\e[8;50;0m"
     expect(color.strip(string)).to eq('foo')
   end
 

data/spec/unit/color/styles_spec.rb

@@ -1,8 +1,6 @@
 # coding: utf-8
 
-require 'spec_helper'
-
-RSpec.describe Pastel::Color do
+RSpec.describe Pastel::Color, '#styles' do
 
   subject(:color) { described_class.new(enabled: true) }
 

data/spec/unit/color/valid_spec.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-require 'spec_helper'
-
 RSpec.describe Pastel::Color, '.valid?' do
   it "detects valid colors" do
     color = described_class.new

data/spec/unit/color_parser_spec.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+RSpec.describe Pastel::ColorParser, '::parse' do
+  subject(:parser) { described_class }
+
+  it "parses string with no color" do
+    expect(parser.parse("foo")).to eq([{text: 'foo'}])
+  end
+
+  it "parses simple color" do
+    expect(parser.parse("\e[32mfoo\e[0m")).to eq([
+     {foreground: :green, text: 'foo'}
+    ])
+  end
+
+  it "parses simple color and style" do
+    expect(parser.parse("\e[32;1mfoo\e[0m")).to eq([
+      {foreground: :green, style: :bold, text: 'foo'}
+    ])
+  end
+
+  it "parses chained colors in shorthand syntax" do
+    expect(parser.parse("\e[32;44mfoo\e[0m")).to eq([
+      {foreground: :green, background: :on_blue, text: 'foo'}
+    ])
+  end
+
+  it "parses chained colors in regular syntax" do
+    expect(parser.parse("\e[32m\e[44mfoo\e[0m")).to eq([
+      {foreground: :green, background: :on_blue, text: 'foo'}
+    ])
+  end
+
+  it "parses many colors" do
+    expect(parser.parse("\e[32mfoo\e[0m \e[31mbar\e[0m")).to eq([
+      {foreground: :green, text: 'foo'},
+      {text: ' '},
+      {foreground: :red, text: 'bar'}
+    ])
+  end
+
+  it "parses nested colors with one reset" do
+    expect(parser.parse("\e[32mfoo\e[31mbar\e[0m")).to eq([
+      {foreground: :green, text: 'foo'},
+      {foreground: :red, text: 'bar'}
+    ])
+  end
+
+  it "parses nested colors with two resets" do
+    expect(parser.parse("\e[32mfoo\e[31mbar\e[0m\e[0m")).to eq([
+      {foreground: :green, text: 'foo'},
+      {foreground: :red, text: 'bar'}
+    ])
+  end
+
+  it "parses unrest color" do
+    expect(parser.parse("\e[32mfoo")).to eq([
+      {foreground: :green, text: 'foo'}
+    ])
+  end
+
+  it "parses malformed control sequence" do
+    expect(parser.parse("\eA foo bar ESC\e")).to eq([
+      {text: "\eA foo bar ESC\e"}
+    ])
+  end
+end