pastel 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c72f523b7b029e20d23f6afb74069e0070b92570
-  data.tar.gz: b43c69c5d821695a6747c7e4d7cedd711652a352
+  metadata.gz: 391313f0e40b883c29f307c2484cabe9585f0e5a
+  data.tar.gz: 4ed8c3fce07de31b31b1d1ebe374d47c89f01ab5
 SHA512:
-  metadata.gz: 21ea3c6f41608ee42238fca82f7e020da175d72826515cf80b920f597ceefa65a5f96a452634063fa7661fc1358310a9af90f546b4ef83ddc32182729ca24f69
-  data.tar.gz: b5fbc770acb2527367996901cd33a66a76681aa6f118f8899a2aa8f955d5e33f5fa974697c589e42b6a03c8f5c3ceca69ba3449ce9c43c6efdfc48db40f481c6
+  metadata.gz: 549b782b7c6c4db583298d765ee8d8bc07c42ad317153b5fd2450cc07734a4bfcc0cf4d5460cfa3978b1504c457ed25b218dae1dd73b9d0f2013021cddc0ab69
+  data.tar.gz: 75c0f16901dae62dbec9f3cd3790162a30a29ac0cffedd2dc930a75dd2d0d7bd57212dd669ae0f5b935ff36d3d6ced914fd25dfbbabb995c392ae5466776b2f5

data/.travis.yml

@@ -1,4 +1,7 @@
+---
 language: ruby
+sudo: false
+cache: bundler
 bundler_args: --without yard benchmarks
 script: "bundle exec rake ci"
 rvm:
@@ -6,15 +9,12 @@ rvm:
   - 2.0
   - 2.1
   - 2.2
+  - rbx-2
+  - jruby-19mode
+  - jruby
+  - jruby-head
   - ruby-head
 matrix:
-  include:
-    - rvm: jruby-19mode
-    - rvm: jruby-20mode
-    - rvm: jruby-21mode
-    - rvm: jruby-9000
-    - rvm: jruby-head
-    - rvm: rbx-2
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head

data/CHANGELOG.md

@@ -1,44 +1,93 @@
-0.5.3 (Jan 05, 2015)
+# Change log
 
+## [v0.6.0] - 2016-01-15
+
+### Added
+* Add helper functions #foreground?, #backgroud?, #style to ANSI module
+* Add ColorParser for parsing color symbols out of text
+* Add Pastel#undecorate for parsing color names out of strings
+
+### Changed
+* Change to use tty-color for color capabilities detection
+* Change to move enabled option to Pastel#new
+* Improve performance of Color#lookup
+* Change Color#decorate performance to be 6x faster!
+* Change Color DSL styling to be 3x faster!
+
+### Fixed
+* Fix #strip to only remove color sequences
+* Fix #decorate to pass through original text when decorating without colors
+* Fix #decorate to work correctly with nested background colors
+
+## [v0.5.3] - 2015-01-05
+
+### Fixed
 * Change gemspec to fix dependencies requirement
 
-0.5.2 (Nov 27, 2015)
+## [v0.5.2] - 2015-11-27 (Nov 27, 2015)
 
 * Change Color#decorate to accept non-string values and immediately return
 
-0.5.1 (Sept 18, 2015)
+## [v0.5.1] - 2015-09-18
 
+### Added
 * Add ability to call detached instance with array access
 
-0.5.0 (Sept 13, 2015)
+## [v0.5.0] - 2015-09-13
 
+### Added
 * Add external dependency to check for color support
 * Add #colored? to check if string has color escape codes
 * Add #eachline option to allow coloring of multiline strings
+
+### Changed
 * Further refine #strip method accuracy
+
+### Fixed
 * Fix redefining inspect method
 * Fix string representation for pastel instance
 
-0.4.0 (November 22, 2014)
+## [v0.4.0] - 2014-11-22
 
-* Fix Delegator#respond_to method to correctly report existence of methods
+### Added
 * Add ability to #detach color combination for later reuse
 * Add ability to nest styles with blocks
 
-0.3.0 (November 8, 2014)
+### Fixed
+* Fix Delegator#respond_to method to correctly report existence of methods
+
+## [v0.3.0] - 2014-11-08
 
+### Added
 * Add ability to alias colors through #alias_color method
 * Add ability to alias colors through the environment variable
 * Improve performance of Pastel::Color styles and lookup methods
+
+### Fixed
 * Fix bug concerned with lack of escaping for nested styles
 
-0.2.1 (October 13, 2014)
+## [v0.2.1] - 2014-10-13
 
+### Fixed
 * Fix issue #1 with unitialize dependency
 
-0.2.0 (October 12, 2014)
+## [v0.2.0] - 2014-10-12
 
-* Change gemspec to include equatable as dependency
+### Added
 * Add #supports? to Color to check for terminal color support
 * Add ability to force color support through :enabled option
+
+### Changed
+* Change gemspec to include equatable as dependency
 * Change Delegator to stop creating instances and improve performance
+
+[v0.6.0]: https://github.com/peter-murach/pastel/compare/v0.5.3...v0.6.0
+[v0.5.3]: https://github.com/peter-murach/pastel/compare/v0.5.2...v0.5.3
+[v0.5.2]: https://github.com/peter-murach/pastel/compare/v0.5.1...v0.5.2
+[v0.5.1]: https://github.com/peter-murach/pastel/compare/v0.5.0...v0.5.1
+[v0.5.0]: https://github.com/peter-murach/pastel/compare/v0.4.0...v0.5.0
+[v0.4.0]: https://github.com/peter-murach/pastel/compare/v0.3.0...v0.4.0
+[v0.3.0]: https://github.com/peter-murach/pastel/compare/v0.2.1...v0.3.0
+[v0.2.1]: https://github.com/peter-murach/pastel/compare/v0.2.0...v0.2.1
+[v0.2.0]: https://github.com/peter-murach/pastel/compare/v0.1.0...v0.2.0
+[v0.1.0]: https://github.com/peter-murach/pastel/compare/v0.1.0

data/Gemfile

@@ -3,7 +3,6 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'rake',  '~> 10.4.2'
   gem 'rspec', '~> 3.4.0'
   gem 'yard',  '~> 0.8.7'
   gem 'benchmark-ips', '~> 2.0.0'

data/README.md

@@ -6,7 +6,7 @@
 [![Build Status](https://secure.travis-ci.org/peter-murach/pastel.svg?branch=master)][travis]
 [![Code Climate](https://codeclimate.com/github/peter-murach/pastel/badges/gpa.svg)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/peter-murach/pastel/badge.svg)][coverage]
-[![Inline docs](http://inch-ci.org/github/peter-murach/tty.svg?branch=master)][inchpages]
+[![Inline docs](http://inch-ci.org/github/peter-murach/pastel.svg?branch=master)][inchpages]
 
 [gem]: http://badge.fury.io/rb/pastel
 [travis]: http://travis-ci.org/peter-murach/pastel
@@ -51,16 +51,19 @@ Or install it yourself as:
 * [2. Interface](#2-interface)
   * [2.1 Color](#21-color)
   * [2.2 Decorate](#22-decorate)
-  * [2.3 Detach](#23-detach)
-  * [2.4 Strip](#24-strip)
-  * [2.5 Styles](#25-styles)
-  * [2.6 Valid?](#26-valid)
-  * [2.7 Colored?](#27-colored)
-  * [2.8 Enabled?](#28-enabled)
-  * [2.9 Eachline](#29-eachline)
-  * [2.10 Alias Color](#30-alias-color)
+  * [2.3 Undecorate](#23-undecorate)
+  * [2.4 Detach](#24-detach)
+  * [2.5 Strip](#25-strip)
+  * [2.6 Styles](#26-styles)
+  * [2.7 Lookup](#27-lookup)
+  * [2.8 Valid?](#28-valid)
+  * [2.9 Colored?](#29-colored)
+  * [2.10 Enabled?](#30-enabled)
+  * [2.11 Eachline](#211-eachline)
+  * [2.12 Alias Color](#212-alias-color)
 * [3. Supported Colors](#3-supported-colors)
 * [4. Environment](#4-environment)
+* [5. Command line](#5-command-line)
 
 ## 1 Usage
 
@@ -130,6 +133,12 @@ puts error.('Error!')
 puts warning.('Warning')
 ```
 
+**Pastel** has companion library called `pastel-cli` that allows you to style text in terminal via `pastel` executable:
+
+```bash
+$ pastel green 'Unicorns & rainbows!'
+```
+
 ## 2 Interface
 
 ### 2.1 Color
@@ -154,7 +163,18 @@ pastel.decorate('Unicorn', :green, :on_blue, :bold)
 
 This method will be useful in situations where colors are provided as a list of parameters that have been generated dynamically.
 
-### 2.3 Detach
+### 2.3 Undecorate
+
+It performs the opposite to `decorate` method by turning color escape sequences found in the string into a list of hash objects corresponding with the attribute names set by those sequences. Depending on the parsed string, each hash object may contain `:foreground`, `:background`, `:text` and/or `:style` keys.
+
+```ruby
+pastel.undecorate("\e[32mfoo\e[0m \e[31mbar\e[0m")
+# => [{foreground: :green, text: 'foo'}, {text: ' '}, {foreground: :red, text: 'bar'}]
+```
+
+To translate the color name into sequence use [lookup](#27-lookup)
+
+### 2.4 Detach
 
 The `detach` method allows to keep all the associated colors with the detached instance for later reference. This method is useful when detached colors are being reused frequently and thus shorthand version is preferred. The detached object can be invoked using `call` method or it's shorthand `.()`, as well as array like access `[]`. For example, the following are equivalent examples of detaching colors:
 
@@ -166,15 +186,15 @@ notice.('Unicorns running')
 notice['Unicorns running']
 ```
 
-### 2.4 Strip
+### 2.5 Strip
 
 Strip only color sequence characters from the provided strings and preserve any movement codes or other escape sequences. The return value will be either array of modified strings or a single string. The arguments are not modified.
 
 ```ruby
-pastel.strip("\e[1m\e[34mbold blue text\e[0m")  # => "bold blue text"
+pastel.strip("\e[1A\e[1m\e[34mbold blue text\e[0m")  # => "\e[1Abold blue text"
 ```
 
-### 2.5 Styles
+### 2.6 Styles
 
 To get a full list of supported styles with the corresponding color codes do:
 
@@ -182,7 +202,15 @@ To get a full list of supported styles with the corresponding color codes do:
 pastel.styles
 ```
 
-### 2.6 Valid?
+### 2.7 Lookup
+
+To perform translation of color name into ansi escape code use `lookup`:
+
+```ruby
+color.lookup(:red)  # => "\e[31m"
+```
+
+### 2.8 Valid?
 
 Determine whether a color or a list of colors are valid. `valid?` takes one or more attribute strings or symbols and returns true if all attributes are known and false otherwise.
 
@@ -191,7 +219,7 @@ pastel.valid?(:red, :blue) # => true
 pastel.valid?(:unicorn)    # => false
 ```
 
-### 2.7 Colored?
+### 2.9 Colored?
 
 In order to determine if string has color escape codes use `colored?` like so
 
@@ -199,7 +227,7 @@ In order to determine if string has color escape codes use `colored?` like so
 pastel.colored?("\e[31mcolorful\e[0m")  # => true
 ```
 
-### 2.8 Enabled?
+### 2.10 Enabled?
 
 In order to detect if your terminal supports coloring do:
 
@@ -214,7 +242,7 @@ pastel = Pastel.new(enabled: true)
 pastel.enabled?   # => true
 ```
 
-### 2.9 Eachline
+### 2.11 Eachline
 
 Normally **Pastel** colors string by putting color codes at the beginning and end of the string, but if you provide `eachline` option set to some string, that string will be considered the line delimiter. Consequently, each line will be separately colored with escape sequence and reset code at the end. This option is desirable if the output string contains newlines and you're using background colors. Since color code that spans more than one line is often interpreted by terminal as providing background for all the lines that follow. This in turn may cause programs such as pagers to spill the colors throughout the text. In most cases you will want to set `eachline` to `\n` character like so:
 
@@ -223,7 +251,7 @@ pastel = Pastel.new(eachline: "\n")
 pastel.red("foo\nbar")  # => "\e[31mfoo\e[0m\n\e[31mbar\e[0m"
 ```
 
-### 2.10 Alias Color
+### 2.12 Alias Color
 
 In order to setup an alias for the standard color do:
 
@@ -310,6 +338,14 @@ Only alphanumeric and `_` are allowed in the alias names with the following form
 PASTEL_COLORS_ALIASES='newcolor_1=red,newcolor_2=on_green'
 ```
 
+## 5. Command line
+
+You can also install [pastel-cli](https://github.com/peter-murach/pastel-cli) to use `pastel` executable in terminal:
+
+```bash
+$ pastel green 'Unicorns & rainbows!'
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/peter-murach/pastel/fork )
@@ -320,4 +356,4 @@ PASTEL_COLORS_ALIASES='newcolor_1=red,newcolor_2=on_green'
 
 ## Copyright
 
-Copyright (c) 2014-2015 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2014-2016 Piotr Murach. See LICENSE for further details.

data/benchmarks/nesting_speed.rb

@@ -22,5 +22,20 @@ Benchmark.ips do |bench|
   bench.compare!
 end
 
+# version 0.6.0
+
+# Calculating -------------------------------------
+#      regular nesting      1282 i/100ms
+#        block nesting      1013 i/100ms
+# -------------------------------------------------
+#      regular nesting    13881.5 (±16.3%) i/s -      67946 in   5.043220s
+#        block nesting    11411.6 (±25.4%) i/s -      53689 in   5.088911s
+#
+# Comparison:
+#      regular nesting:    13881.5 i/s
+#        block nesting:    11411.6 i/s - 1.22x slower
+
+# version 0.5.3
+
 # regular nesting: 2800/s
 # block nesting:   2600/s

data/benchmarks/speed.rb

@@ -17,5 +17,29 @@ Benchmark.ips do |bench|
   bench.compare!
 end
 
-# color decorate: 14K/s
-# dsl styling:    10K/s
+# version 0.6.0
+
+# Calculating -------------------------------------
+#       color decorate      7346 i/100ms
+#          dsl styling      3436 i/100ms
+# -------------------------------------------------
+#       color decorate    96062.1 (±7.9%) i/s -     484836 in   5.081126s
+#          dsl styling    38761.1 (±13.9%) i/s -     192416 in   5.065053s
+#
+# Comparison:
+#       color decorate:    96062.1 i/s
+#          dsl styling:    38761.1 i/s - 2.48x slower
+
+# version 0.5.3
+
+# Calculating -------------------------------------
+#       color decorate      1428 i/100ms
+#          dsl styling      1174 i/100ms
+# -------------------------------------------------
+#       color decorate    16113.1 (±21.5%) i/s -      77112 in   5.054487s
+#          dsl styling    12622.9 (±20.8%) i/s -      61048 in   5.076738s
+#
+# Comparison:
+#       color decorate:    16113.1 i/s
+#          dsl styling:    12622.9 i/s - 1.28x slower
+#

data/lib/pastel.rb

@@ -2,11 +2,12 @@
 
 require 'forwardable'
 require 'equatable'
-require 'tty-screen'
+require 'tty-color'
 
 require 'pastel/ansi'
 require 'pastel/alias_importer'
 require 'pastel/color'
+require 'pastel/color_parser'
 require 'pastel/color_resolver'
 require 'pastel/delegator'
 require 'pastel/detached'
@@ -29,8 +30,11 @@ module Pastel
   #
   # @api public
   def new(options = {})
+    unless options.key?(:enabled)
+      options.merge!(enabled: TTY::Color.color?)
+    end
     color    = Color.new(options)
-    importer = AliasImporter.new(color)
+    importer = AliasImporter.new(color, ENV)
     importer.import
     resolver = ColorResolver.new(color)
     Delegator.for(resolver, DecoratorChain.empty)

data/lib/pastel/alias_importer.rb

@@ -6,11 +6,12 @@ module Pastel
     # Create alias importer
     #
     # @example
-    #   importer = Pastel::AliasImporter.new(Pastel::Color.new)
+    #   importer = Pastel::AliasImporter.new(Pastel::Color.new, {})
     #
     # @api public
-    def initialize(color, output = $stderr)
+    def initialize(color, env, output = $stderr)
       @color  = color
+      @env    = env
       @output = output
     end
 
@@ -24,7 +25,7 @@ module Pastel
     #
     # @api public
     def import
-      color_aliases = ENV['PASTEL_COLORS_ALIASES']
+      color_aliases = env['PASTEL_COLORS_ALIASES']
       return unless color_aliases
       color_aliases.split(',').each do |color_alias|
         new_color, old_color = color_alias.split('=').map(&:to_sym)
@@ -38,6 +39,6 @@ module Pastel
 
     protected
 
-    attr_reader :color, :output
+    attr_reader :color, :output, :env
   end # AliasImporter
 end # Pastel

data/lib/pastel/ansi.rb

@@ -52,5 +52,19 @@ module Pastel
       on_bright_cyan:    106,
       on_bright_white:   107
     }
+
+    module_function
+
+    def foreground?(code)
+      [*(30..37), *(90..97)].include?(code.to_i)
+    end
+
+    def background?(code)
+      [*(40..47), *(100..107)].include?(code.to_i)
+    end
+
+    def style?(code)
+      (1..9).include?(code.to_i)
+    end
   end # ANSI
 end # Pastel

data/lib/pastel/color.rb

@@ -6,9 +6,11 @@ module Pastel
     include Equatable
     include ANSI
 
+    # All color aliases
     ALIASES = {}
 
-    ANSI_REGEX = /(\[)?\033(\[)?[:;?\d]*[\dA-Za-z](\])?/o.freeze
+    # Match all color escape sequences
+    ANSI_COLOR_REGEXP = /\x1b+(\[|\[\[)[0-9;:?]+m/mo.freeze
 
     BLANK_REGEX = /\A[[:space:]]*\z/o.freeze
 
@@ -21,9 +23,9 @@ module Pastel
     #
     # @api public
     def initialize(options = {})
-      @enabled  = options.fetch(:enabled) { TTY::Screen.color? }
+      @enabled  = options[:enabled]
       @eachline = options.fetch(:eachline) { false }
-      freeze
+      @cache    = {}
     end
 
     # Disable coloring of this terminal session
@@ -35,6 +37,8 @@ module Pastel
 
     # Apply ANSI color to the given string.
     #
+    # Wraps eachline with clear escape.
+    #
     # @param [String] string
     #   text to add ANSI strings
     #
@@ -49,78 +53,39 @@ module Pastel
     #
     # @api public
     def decorate(string, *colors)
-      return string if blank?(string) || !enabled
+      return string if blank?(string) || !enabled || colors.empty?
 
       ansi_colors = lookup(*colors)
-      ansi_string = wrap_eachline(string, ansi_colors)
-      ansi_string = nest_color(collapse_reset(ansi_string), ansi_colors)
-      ansi_string
-    end
-
-    # Reset sequence
-    #
-    # @api public
-    def clear
-      lookup(:clear)
-    end
-
-    # Wraps eachline with clear character
-    #
-    # @param [String] string
-    #   string to wrap with multiline characters
-    #
-    # @param [String] ansi_colors
-    #   colors to apply to string
-    #
-    # @return [String]
-    #
-    # @api private
-    def wrap_eachline(string, ansi_colors)
       if eachline
-        string.split(eachline).map do |line|
-          "#{ansi_colors}#{line}#{clear}"
+        string.dup.split(eachline).map! do |line|
+          apply_codes(line, ansi_colors)
         end.join(eachline)
       else
-        "#{ansi_colors}#{string}#{clear}"
+        apply_codes(string.dup, ansi_colors)
       end
     end
 
-    # Collapse reset
+    # Apply escape codes to the string
     #
     # @param [String] string
-    #   the string to remove duplicates from
+    #   the string to apply escapes to
+    # @param [Strin] ansi_colors
+    #   the ansi colors to apply
     #
     # @return [String]
+    #   return the string surrounded by escape codes
     #
     # @api private
-    def collapse_reset(string)
-      ansi_string = string.dup
-      if ansi_string =~ /(#{Regexp.quote(clear)}){2,}/
-        ansi_string.gsub!(/(#{Regexp.quote(clear)}){2,}/, clear)
-      end
-      ansi_string
+    def apply_codes(string, ansi_colors)
+      "#{ansi_colors}#{string.gsub(/(\e\[0m)([^\e]+)$/, "\\1#{ansi_colors}\\2")}\e[0m"
     end
 
-    # Nest color
-    #
-    # @param [String] string
-    #   the string to decorate
-    #
-    # @param [String] ansi_colors
-    #   the ansi colors to apply
-    #
-    # @return [String]
+    # Reset sequence
     #
-    # @api private
-    def nest_color(string, ansi_colors)
-      ansi_string = string.dup
-      matches = ansi_string.scan(/#{Regexp.quote(clear)}/)
-      if matches.length > 1 && !eachline
-        ansi_string.sub!(/#{Regexp.quote(clear)}/, ansi_colors)
-      end
-      ansi_string
+    # @api public
+    def clear
+      lookup(:clear)
     end
-    private :collapse_reset, :nest_color
 
     # Strip ANSI color codes from a string.
     #
@@ -137,7 +102,7 @@ module Pastel
     #
     # @api public
     def strip(*strings)
-      modified = strings.map { |string| string.dup.gsub(ANSI_REGEX, '') }
+      modified = strings.map { |string| string.dup.gsub(ANSI_COLOR_REGEXP, '') }
       modified.size == 1 ? modified[0] : modified
     end
 
@@ -151,7 +116,28 @@ module Pastel
     #
     # @api public
     def colored?(string)
-      !ANSI_REGEX.match(string).nil?
+      !ANSI_COLOR_REGEXP.match(string).nil?
+    end
+
+    # Find the escape code for a given set of color attributes
+    #
+    # @example
+    #   color.lookup(:red, :on_green) # => "\e[31;42m"
+    #
+    # @param [Array[Symbol]] colors
+    #   the list of color name(s) to lookup
+    #
+    # @return [String]
+    #   the ANSI code(s)
+    #
+    # @raise [InvalidAttributeNameError]
+    #   exception raised for any invalid color name
+    #
+    # @api private
+    def lookup(*colors)
+      @cache.fetch(colors) do
+        @cache[colors] = "\e[#{code(*colors).join(';')}m"
+      end
     end
 
     # Return raw color code without embeding it into a string.
@@ -173,20 +159,6 @@ module Pastel
       attribute
     end
 
-    # Find the escape code for color attribute.
-    #
-    # @param [Symbol,String] colors
-    #   the color name(s) to lookup
-    #
-    # @return [String]
-    #   the ANSI code(s)
-    #
-    # @api private
-    def lookup(*colors)
-      attribute = code(*colors)
-      "\e[#{attribute.join(';')}m"
-    end
-
     # Expose all ANSI color names and their codes
     #
     # @return [Hash[Symbol]]