pastel 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e0dff6fb46a4686e16dadf14dbc302c03bec710a
-  data.tar.gz: b3bb1f08fa7a1eb0c6a5529f32d1405419bcc024
+SHA256:
+  metadata.gz: '06693f6ff4f804468ff3802df48c725067fb8eb425e9ba4301627f7c496099bb'
+  data.tar.gz: 0752767e8bbe626d683e5eb8b576f5c1229c322f72475d41b1041f4f15eb2c11
 SHA512:
-  metadata.gz: 9aad90942603ae1740ee11c2e213b8e4a1058fb7fdffc52ee42bb3764d7e20b74bdd1759421b5a84513b7e140f3d7d72c6605f23b874d22f8d3654a44ba8233c
-  data.tar.gz: c021e7b94a64d5d3d63288fac62346064c99beb3fbec2f0f9a7c162e6d39d440d72a1f03960b2d5fe0f229ec397c53d2ccac197c13d5f3f7286b190406aeef56
+  metadata.gz: 2239724d8aa9165ec045a2f43b6b8ce336c35ad487bc9e5ca1a8005c0321c682a73fff711316710848fee9931790c47a72dc5469afda25e98975bf6c38a9dfc5
+  data.tar.gz: b8f59e4fa1c52973d91d41d4e3f8602da3b164a41125a7416c7f119f53f880e81f4d3a79ea52e25b4e9de4dcb338d37ff1045f9b7b4437056cb7dc1597ce87df

data/CHANGELOG.md

@@ -1,5 +1,44 @@
 # Change log
 
+## [v0.8.0] - 2020-07-04
+
+### Changed
+* Change gemspec to require Ruby 2.0 or higher
+* Change Pastel#new to use keyword arguments in place of hash options
+* Change to freeze all strings
+* Remove equatable dependency
+
+### Fixed
+* Fix Pastel#strip to recognise no-number reset by DanielVartanov(@DanielVartanov)
+* Fix Pastel#undecorate to correctly assign styles for nested colors
+
+## [v0.7.4] - 2020-05-08
+
+### Fixed
+* Fix ColorParser#undecorate to require direct dependency by Nick Pezza(@npezza93)
+
+## [v0.7.3] - 2019-06-16
+
+### Changed
+* Change gemspec to load required files directly without git
+* Change to update tty-color & equatable dependency versions
+
+### Fixed
+* Fix Delegator warning
+
+## [v0.7.2] - 2017-11-09
+
+### Changed
+* Change to load relative file paths
+* Change to allow `#alias_color` to accept multiple colors by Jared Ning (@ordinaryzelig)
+
+## [v0.7.1] - 2017-01-09
+
+### Changed
+* Change to load specific files when needed
+* Change to freeze ANSI attributes
+* Change to directly assign enabled attribute
+
 ## [v0.7.0] - 2016-12-27
 
 ### Changed
@@ -17,7 +56,7 @@
 ## [v0.6.0] - 2016-01-15
 
 ### Added
-* Add helper functions #foreground?, #backgroud?, #style to ANSI module
+* Add helper functions #foreground?, #background?, #style to ANSI module
 * Add ColorParser for parsing color symbols out of text
 * Add Pastel#undecorate for parsing color names out of strings
 
@@ -95,15 +134,20 @@
 * Change gemspec to include equatable as dependency
 * Change Delegator to stop creating instances and improve performance
 
-[v0.7.0]: https://github.com/peter-murach/pastel/compare/v0.6.1...v0.7.0
-[v0.6.1]: https://github.com/peter-murach/pastel/compare/v0.6.0...v0.6.1
-[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
+[v0.8.0]: https://github.com/piotrmurach/pastel/compare/v0.7.4...v0.8.0
+[v0.7.4]: https://github.com/piotrmurach/pastel/compare/v0.7.3...v0.7.4
+[v0.7.3]: https://github.com/piotrmurach/pastel/compare/v0.7.2...v0.7.3
+[v0.7.2]: https://github.com/piotrmurach/pastel/compare/v0.7.1...v0.7.2
+[v0.7.1]: https://github.com/piotrmurach/pastel/compare/v0.7.0...v0.7.1
+[v0.7.0]: https://github.com/piotrmurach/pastel/compare/v0.6.1...v0.7.0
+[v0.6.1]: https://github.com/piotrmurach/pastel/compare/v0.6.0...v0.6.1
+[v0.6.0]: https://github.com/piotrmurach/pastel/compare/v0.5.3...v0.6.0
+[v0.5.3]: https://github.com/piotrmurach/pastel/compare/v0.5.2...v0.5.3
+[v0.5.2]: https://github.com/piotrmurach/pastel/compare/v0.5.1...v0.5.2
+[v0.5.1]: https://github.com/piotrmurach/pastel/compare/v0.5.0...v0.5.1
+[v0.5.0]: https://github.com/piotrmurach/pastel/compare/v0.4.0...v0.5.0
+[v0.4.0]: https://github.com/piotrmurach/pastel/compare/v0.3.0...v0.4.0
+[v0.3.0]: https://github.com/piotrmurach/pastel/compare/v0.2.1...v0.3.0
+[v0.2.1]: https://github.com/piotrmurach/pastel/compare/v0.2.0...v0.2.1
+[v0.2.0]: https://github.com/piotrmurach/pastel/compare/v0.1.0...v0.2.0
+[v0.1.0]: https://github.com/piotrmurach/pastel/compare/v0.1.0

data/README.md

@@ -1,7 +1,9 @@
 <div align="center">
   <img width="215" src="https://cdn.rawgit.com/piotrmurach/pastel/master/assets/pastel_logo.png" alt="pastel logo" />
 </div>
+
 # Pastel
+
 [![Gem Version](https://badge.fury.io/rb/pastel.svg)][gem]
 [![Build Status](https://secure.travis-ci.org/piotrmurach/pastel.svg?branch=master)][travis]
 [![Build status](https://ci.appveyor.com/api/projects/status/9blbjfq42o4v1rk4?svg=true)][appveyor]
@@ -37,7 +39,7 @@
 
 Add this line to your application's Gemfile:
 
-    gem 'pastel'
+    gem "pastel"
 
 And then execute:
 
@@ -74,7 +76,7 @@ Or install it yourself as:
 ```ruby
 pastel = Pastel.new
 
-puts pastel.red('Unicorns!')
+puts pastel.red("Unicorns!")
 ```
 
 **Pastel** doesn't print the colored string out, just returns it, you'll have to print it yourself.
@@ -82,46 +84,46 @@ puts pastel.red('Unicorns!')
 You can compose multiple styles through chainable API:
 
 ```ruby
-pastel.red.on_green.bold('Unicorns!')
+pastel.red.on_green.bold("Unicorns!")
 ```
 
 It allows you to combine styled strings with unstyled ones:
 
 ```ruby
-pastel.red('Unicorns') + ' will rule ' + pastel.green('the World!')
+pastel.red("Unicorns") + " will rule " + pastel.green("the World!")
 ```
 
 It supports variable number of arguments:
 
 ```ruby
-pastel.red('Unicorns', 'are', 'running', 'everywhere!')
+pastel.red("Unicorns", "are", "running", "everywhere!")
 ```
 
 You can also nest styles as follows:
 
 ```ruby
-pastel.red('Unicorns ', pastel.on_green('everywhere!'))
+pastel.red("Unicorns ", pastel.on_green("everywhere!"))
 ```
 
 Nesting is smart enough to know where one color ends and another one starts:
 
 ```ruby
-pastel.red('Unicorns ' + pastel.green('everywhere') + pastel.on_yellow('!'))
+pastel.red("Unicorns " + pastel.green("everywhere") + pastel.on_yellow("!"))
 ```
 
 You can also nest styles inside blocks:
 
 ```ruby
-pastel.red.on_green('Unicorns') {
-  green.on_red('will ', 'dominate') {
-    yellow('the world!')
+pastel.red.on_green("Unicorns") {
+  green.on_red("will ", "dominate") {
+    yellow("the world!")
   }
 }
 ```
 
-When dealing with multiline strings you can set `eachline` option(more info see [eachline](#29-eachline)):
+When dealing with multiline strings you can set `eachline` option(more info see [eachline](#211-eachline)):
 
-```
+```ruby
 pastel = Pastel.new(eachline: "\n")
 ```
 
@@ -131,8 +133,8 @@ You can also predefine needed styles and reuse them:
 error    = pastel.red.bold.detach
 warning  = pastel.yellow.detach
 
-puts error.('Error!')
-puts warning.('Warning')
+puts error.("Error!")
+puts warning.("Warning")
 ```
 
 If your output is redirected to a file, you probably don't want Pastel to add color to your text.
@@ -141,7 +143,7 @@ See https://github.com/piotrmurach/pastel#210-enabled for a way to easily accomp
 **Pastel** has companion library called `pastel-cli` that allows you to style text in terminal via `pastel` executable:
 
 ```bash
-$ pastel green 'Unicorns & rainbows!'
+$ pastel green "Unicorns & rainbows!"
 ```
 
 ## 2 Interface
@@ -153,7 +155,7 @@ pastel.`[....](string, [string...])`
 Color styles are invoked as method calls with a string argument. A given color can take any number of strings as arguments. Then it returns a colored string which isn't printed out to terminal. You need to print it yourself if you need to. This is done so that you can save it as a string, pass to something else, send it to a file handle and so on.
 
 ```ruby
-pastel.red('Unicorns ', pastel.bold.underline('everywhere'), '!')
+pastel.red("Unicorns ", pastel.bold.underline("everywhere"), "!")
 ```
 
 Please refer to [3. Supported Colors](#3-supported-colors) section for full list of supported styles.
@@ -163,7 +165,7 @@ Please refer to [3. Supported Colors](#3-supported-colors) section for full list
 This method is a lower level string styling call that takes as the first argument the string to style followed by any number of color attributes, and returns string wrapped in styles.
 
 ```ruby
-pastel.decorate('Unicorn', :green, :on_blue, :bold)
+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.
@@ -174,7 +176,7 @@ It performs the opposite to `decorate` method by turning color escape sequences
 
 ```ruby
 pastel.undecorate("\e[32mfoo\e[0m \e[31mbar\e[0m")
-# => [{foreground: :green, text: 'foo'}, {text: ' '}, {foreground: :red, text: 'bar'}]
+# => [{foreground: :green, text: "foo"}, {text: " "}, {foreground: :red, text: "bar"}]
 ```
 
 To translate the color name into sequence use [lookup](#27-lookup)
@@ -186,9 +188,9 @@ The `detach` method allows to keep all the associated colors with the detached i
 ```ruby
 notice = pastel.blue.bold.detach
 
-notice.call('Unicorns running')
-notice.('Unicorns running')
-notice['Unicorns running']
+notice.call("Unicorns running")
+notice.("Unicorns running")
+notice["Unicorns running"]
 ```
 
 ### 2.5 Strip
@@ -212,7 +214,8 @@ pastel.styles
 To perform translation of color name into ansi escape code use `lookup`:
 
 ```ruby
-color.lookup(:red)  # => "\e[31m"
+pastel.lookup(:red)   # => "\e[31m"
+pastel.lookup(:reset) # => "\e[0m"
 ```
 
 ### 2.8 Valid?
@@ -266,16 +269,16 @@ pastel.red("foo\nbar")  # => "\e[31mfoo\e[0m\n\e[31mbar\e[0m"
 
 ### 2.12 Alias Color
 
-In order to setup an alias for the standard color do:
+In order to setup an alias for standard colors do:
 
 ```ruby
-pastel.alias_color(:funky, :red)
+pastel.alias_color(:funky, :red, :bold)
 ```
 
-From that point forward, `:funky` alias can be passed to `decorate`, `valid?` with the same meaning as standard color:
+From that point forward, `:funky` alias can be passed to `decorate`, `valid?` with the same meaning as standard colors:
 
 ```ruby
-pastel.funky.on_green('unicorn')   # => will use :red color
+pastel.funky.on_green("unicorn")   # => will use :red, :bold color
 ```
 
 This method allows you to give more meaningful names to existing colors.
@@ -345,10 +348,10 @@ Generic styles:
 
 This environment variable allows you to specify custom color aliases at runtime that will be understood by **Pastel**. The environment variable is read and used when the instance of **Pastel** is created. You can also use `alias_color` to create aliases.
 
-Only alphanumeric and `_` are allowed in the alias names with the following format:
+Only alphanumeric and `_` and `.` are allowed in the alias names with the following format:
 
 ```ruby
-PASTEL_COLORS_ALIASES='newcolor_1=red,newcolor_2=on_green'
+PASTEL_COLORS_ALIASES="newcolor_1=red,newcolor_2=on_green,funky=red.bold"
 ```
 
 ## 5. Command line
@@ -367,6 +370,10 @@ $ pastel green 'Unicorns & rainbows!'
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+## Code of Conduct
+
+Everyone interacting in the Pastel project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/pastel/blob/master/CODE_OF_CONDUCT.md).
+
 ## Copyright
 
-Copyright (c) 2014-2017 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2014 Piotr Murach. See LICENSE for further details.

data/lib/pastel.rb

@@ -1,18 +1,12 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'forwardable'
-require 'equatable'
-require 'tty-color'
+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'
-require 'pastel/decorator_chain'
-require 'pastel/version'
+require_relative "pastel/alias_importer"
+require_relative "pastel/color"
+require_relative "pastel/color_resolver"
+require_relative "pastel/delegator"
+require_relative "pastel/version"
 
 module Pastel
   # Raised when the style attribute is not supported
@@ -26,19 +20,23 @@ module Pastel
   # @example
   #   pastel = Pastel.new enabled: true
   #
+  # @param [Boolean] :enabled
+  #   whether or not to disable coloring
+  # @param [Boolean] :eachline
+  #   whether or not to wrap eachline with separate coloring
+  #
   # @return [Delegator]
   #
   # @api public
-  def new(options = {})
-    unless options.key?(:enabled)
-      options.merge!(enabled: TTY::Color.windows? || TTY::Color.color?)
+  def new(enabled: nil, eachline: false)
+    if enabled.nil?
+      enabled = (TTY::Color.windows? || TTY::Color.color?)
     end
-    color    = Color.new(options)
+    color    = Color.new(enabled: enabled, eachline: eachline)
     importer = AliasImporter.new(color, ENV)
     importer.import
     resolver = ColorResolver.new(color)
-    Delegator.for(resolver, DecoratorChain.empty)
+    Delegator.wrap(resolver)
   end
-
   module_function :new
 end # Pastel

data/lib/pastel/alias_importer.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Pastel
   # A class responsible for importing color aliases
@@ -18,21 +18,23 @@ module Pastel
     # Import aliases from the environment
     #
     # @example
-    #   importer = Pastel::AliasImporter.new(Pastel::Color.new)
+    #   importer = Pastel::AliasImporter.new(Pastel::Color.new, {})
     #   importer.import
     #
     # @return [nil]
     #
     # @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)
-        if !new_color || !old_color
+
+      color_aliases.split(",").each do |color_alias|
+        new_color, old_colors = color_alias.split("=")
+        if !new_color || !old_colors
           output.puts "Bad color mapping `#{color_alias}`"
         else
-          color.alias_color(new_color, old_color)
+          color.alias_color(new_color.to_sym,
+                            *old_colors.split(".").map(&:to_sym))
         end
       end
     end

data/lib/pastel/ansi.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Pastel
   # Mixin that provides ANSI codes
@@ -51,7 +51,7 @@ module Pastel
       on_bright_magenta: 105,
       on_bright_cyan:    106,
       on_bright_white:   107
-    }
+    }.freeze
 
     module_function
 

data/lib/pastel/color.rb

@@ -1,28 +1,29 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require_relative "ansi"
 
 module Pastel
   # A class responsible for coloring strings.
   class Color
-    include Equatable
     include ANSI
 
     # All color aliases
     ALIASES = {}
 
     # Match all color escape sequences
-    ANSI_COLOR_REGEXP = /\x1b+(\[|\[\[)[0-9;:?]+m/mo.freeze
+    ANSI_COLOR_REGEXP = /\x1b\[{1,2}[0-9;:?]*m/mo.freeze
 
     attr_reader :enabled
-    alias_method :enabled?, :enabled
+    alias enabled? enabled
 
     attr_reader :eachline
 
     # Initialize a Terminal Color
     #
     # @api public
-    def initialize(options = {})
-      @enabled  = options[:enabled]
-      @eachline = options.fetch(:eachline) { false }
+    def initialize(enabled: nil, eachline: false)
+      @enabled  = enabled
+      @eachline = eachline
       @cache    = {}
     end
 
@@ -100,7 +101,7 @@ module Pastel
     #
     # @api public
     def strip(*strings)
-      modified = strings.map { |string| string.dup.gsub(ANSI_COLOR_REGEXP, '') }
+      modified = strings.map { |string| string.dup.gsub(ANSI_COLOR_REGEXP, "") }
       modified.size == 1 ? modified[0] : modified
     end
 
@@ -191,29 +192,67 @@ module Pastel
       colors.all? { |color| style_names.include?(color.to_sym) }
     end
 
-    # Define a new color alias
+    # Define a new colors alias
     #
     # @param [String] alias_name
-    #   the color alias to define
-    # @param [String] color
-    #   the color the alias will correspond to
+    #   the colors alias to define
+    # @param [Array[Symbol,String]] color
+    #   the colors the alias will correspond to
     #
-    # @return [String]
-    #   the standard color value of the alias
+    # @return [Array[String]]
+    #   the standard color values of the alias
     #
     # @api public
-    def alias_color(alias_name, color)
-      validate(color)
+    def alias_color(alias_name, *colors)
+      validate(*colors)
 
       if !(alias_name.to_s =~ /^[\w]+$/)
-        fail InvalidAliasNameError, "Invalid alias name `#{alias_name}`"
+        raise InvalidAliasNameError, "Invalid alias name `#{alias_name}`"
       elsif ANSI::ATTRIBUTES[alias_name]
-        fail InvalidAliasNameError,
-             "Cannot alias standard color `#{alias_name}`"
+        raise InvalidAliasNameError,
+              "Cannot alias standard color `#{alias_name}`"
       end
 
-      ALIASES[alias_name.to_sym] = ANSI::ATTRIBUTES[color]
-      color
+      ALIASES[alias_name.to_sym] = colors.map(&ANSI::ATTRIBUTES.method(:[]))
+      colors
+    end
+
+    # Compare colors for equality of attributes
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def eql?(other)
+      instance_of?(other.class) &&
+        enabled.eql?(other.enabled) && eachline.eql?(other.eachline)
+    end
+
+    # Compare colors for equivalence of attributes
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def ==(other)
+      other.is_a?(self.class) &&
+        enabled == other.enabled && eachline == other.eachline
+    end
+
+    # Inspect this instance attributes
+    #
+    # @return [String]
+    #
+    # @api public
+    def inspect
+      "#<#{self.class.name} enabled=#{enabled.inspect} eachline=#{eachline.inspect}>"
+    end
+
+    # Hash for this instance and its attributes
+    #
+    # @return [Numeric]
+    #
+    # @api public
+    def hash
+      [self.class, enabled, eachline].hash
     end
 
     private
@@ -224,13 +263,14 @@ module Pastel
     #
     # @api private
     def blank?(value)
-      value.nil? || !value.respond_to?(:to_str) || value.to_s == ''
+      value.nil? || !value.respond_to?(:to_str) || value.to_s == ""
     end
 
     # @api private
     def validate(*colors)
       return if valid?(*colors)
-      fail InvalidAttributeNameError, 'Bad style or unintialized constant, ' \
+
+      raise InvalidAttributeNameError, "Bad style or unintialized constant, " \
         " valid styles are: #{style_names.join(', ')}."
     end
   end # Color