pastel 0.6.1 → 0.8.0

data/lib/pastel/decorator_chain.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Pastel
   # Collects a list of decorators for styling a string
@@ -6,17 +6,34 @@ module Pastel
   # @api private
   class DecoratorChain
     include Enumerable
-    include Equatable
 
-    def initialize(decorators = [])
+    # Create an empty decorator chain
+    #
+    # @return [DecoratorChain]
+    #
+    # @api public
+    def self.empty
+      @empty ||= self.new
+    end
+
+    # Create a decorator chain
+    #
+    # @api public
+    def initialize(decorators = [].freeze)
       @decorators = decorators
     end
 
     # Add decorator
     #
+    # @param [String] decorator
+    #
     # @api public
     def add(decorator)
-      self.class.new(decorators + [decorator])
+      if decorators.include?(decorator)
+        self.class.new(decorators)
+      else
+        self.class.new(decorators + [decorator])
+      end
     end
 
     # Iterate over list of decorators
@@ -26,13 +43,40 @@ module Pastel
       decorators.each(&block)
     end
 
-    # Create an empty decorator chain
+    # Compare colors for equality of attributes
     #
-    # @return [DecoratorChain]
+    # @return [Boolean]
     #
     # @api public
-    def self.empty
-      new([])
+    def eql?(other)
+      instance_of?(other.class) && decorators.eql?(other.decorators)
+    end
+
+    # Compare colors for equivalence of attributes
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def ==(other)
+      other.is_a?(self.class) && decorators == other.decorators
+    end
+
+    # Inspect this instance attributes
+    #
+    # @return [String]
+    #
+    # @api public
+    def inspect
+      "#<#{self.class.name} decorators=#{decorators.inspect}>"
+    end
+
+    # Hash for this instance and its attributes
+    #
+    # @return [Numeric]
+    #
+    # @api public
+    def hash
+      [self.class, decorators].hash
     end
 
     protected

data/lib/pastel/delegator.rb

@@ -1,4 +1,9 @@
-# coding: utf-8
+# frozen_string_literal: true
+
+require "forwardable"
+
+require_relative "color_parser"
+require_relative "decorator_chain"
 
 module Pastel
   # Wrapes the {DecoratorChain} to allow for easy resolution
@@ -7,13 +12,19 @@ module Pastel
   # @api private
   class Delegator
     extend Forwardable
-    include Equatable
 
-    def_delegators '@resolver.color', :valid?, :styles, :strip, :decorate,
+    def_delegators "@resolver.color", :valid?, :styles, :strip, :decorate,
                    :enabled?, :colored?, :alias_color, :lookup
 
     def_delegators ColorParser, :parse
-    alias_method :undecorate, :parse
+    alias undecorate parse
+
+    # Wrap resolver and chain
+    #
+    # @api public
+    def self.wrap(resolver, chain = DecoratorChain.empty)
+      new(resolver, chain)
+    end
 
     # Create Delegator
     #
@@ -21,20 +32,31 @@ module Pastel
     #
     # @param [ColorResolver] resolver
     #
-    # @param [DecoratorChain] base
+    # @param [DecoratorChain] chain
     #
     # @api private
-    def initialize(resolver, base)
+    def initialize(resolver, chain)
       @resolver = resolver
-      @base     = base
+      @chain = chain
     end
 
+    # Compare delegated objects for equality of attributes
+    #
+    # @return [Boolean]
+    #
     # @api public
-    def self.for(resolver, base)
-      new(resolver, base)
+    def eql?(other)
+      instance_of?(other.class) && chain.eql?(other.chain)
     end
 
-    remove_method :inspect
+    # Compare delegated objects for equivalence of attributes
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def ==(other)
+      other.is_a?(self.class) && chain == other.chain
+    end
 
     # Object string representation
     #
@@ -42,44 +64,53 @@ module Pastel
     #
     # @api
     def inspect
-      "#<Pastel @styles=#{base.map(&:to_s)}>"
+      "#<Pastel styles=#{chain.map(&:to_s)}>"
+    end
+    alias to_s inspect
+
+    # Hash for this instance and its attributes
+    #
+    # @return [Numeric]
+    #
+    # @api public
+    def hash
+      [self.class, chain].hash
     end
-    alias_method :to_s, :inspect
 
     protected
 
-    attr_reader :base
+    attr_reader :chain
 
     attr_reader :resolver
 
-    # Wrap colors
+    # Handles color method calls
     #
     # @api private
-    def wrap(base)
-      self.class.new(resolver, base)
-    end
-
     def method_missing(method_name, *args, &block)
-      new_base  = base.add(method_name)
-      delegator = wrap(new_base)
-      if args.empty? && !(method_name.to_sym == :detach)
+      new_chain = chain.add(method_name)
+      delegator = self.class.wrap(resolver, new_chain)
+      if args.empty? && method_name.to_sym != :detach
         delegator
       else
-        string = args.join
-        string << evaluate_block(&block) if block_given?
-        resolver.resolve(new_base, string)
+        strings = args.dup
+        strings << evaluate_block(&block) if block_given?
+        resolver.resolve(new_chain, strings.join)
       end
     end
 
+    # Check if color is valid
+    #
+    # @api private
     def respond_to_missing?(name, include_all = false)
-      resolver.color.respond_to?(name, include_all) || valid?(name) || super
+      resolver.color.respond_to?(name, include_all) ||
+        resolver.color.valid?(name) || super
     end
 
     # Evaluate color block
     #
     # @api private
     def evaluate_block(&block)
-      delegator = self.class.new(resolver, DecoratorChain.empty)
+      delegator = self.class.wrap(resolver)
       delegator.instance_eval(&block)
     end
   end # Delegator

data/lib/pastel/detached.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Pastel
   # A class representing detached color
   class Detached
-    include Equatable
-
     # Initialize a detached object
     #
     # @param [Pastel::Color] color
@@ -22,6 +20,8 @@ module Pastel
     # Decorate the values corresponding to styles
     #
     # @example
+    #   Detached(Color.new, :red, :bold).call("hello")
+    #   # => "\e[31mhello\e[0m"
     #
     # @param [String] value
     #   the stirng to decorate with styles
@@ -33,14 +33,50 @@ module Pastel
       value = args.join
       @color.decorate(value, *styles)
     end
-    alias_method :[], :call
+    alias [] call
 
     # @api public
     def to_proc
       self
     end
 
-    private
+    # Compare detached objects for equality of attributes
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def eql?(other)
+      instance_of?(other.class) && styles.eql?(other.styles)
+    end
+
+    # Compare detached objects for equivalence of attributes
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def ==(other)
+      other.is_a?(self.class) && styles == other.styles
+    end
+
+    # Inspect this instance attributes
+    #
+    # @return [String]
+    #
+    # @api public
+    def inspect
+      "#<#{self.class.name} styles=#{styles.inspect}>"
+    end
+
+    # Hash for this instance and its attributes
+    #
+    # @return [Numeric]
+    #
+    # @api public
+    def hash
+      [self.class, styles].hash
+    end
+
+    protected
 
     # @api private
     attr_reader :styles

data/lib/pastel/version.rb

@@ -1,5 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 module Pastel
-  VERSION = '0.6.1'
+  VERSION = "0.8.0"
 end

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.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

metadata

@@ -1,97 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: pastel
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-04-09 00:00:00.000000000 Z
+date: 2020-07-04 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: equatable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: tty-color
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-    - - <
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-    - - <
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: Terminal strings styling with intuitive and clean API.
 email:
-- ''
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
-- .gitignore
-- .rspec
-- .travis.yml
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- assets/pastel_logo.png
-- assets/screenshot.png
-- benchmarks/nesting_speed.rb
-- benchmarks/speed.rb
-- examples/palette.rb
 - lib/pastel.rb
 - lib/pastel/alias_importer.rb
 - lib/pastel/ansi.rb
@@ -102,75 +75,33 @@ files:
 - lib/pastel/delegator.rb
 - lib/pastel/detached.rb
 - lib/pastel/version.rb
-- pastel.gemspec
-- spec/spec_helper.rb
-- spec/unit/alias_color_spec.rb
-- spec/unit/alias_importer_spec.rb
-- spec/unit/color/alias_color_spec.rb
-- spec/unit/color/code_spec.rb
-- spec/unit/color/colored_spec.rb
-- spec/unit/color/decorate_spec.rb
-- spec/unit/color/equal_spec.rb
-- spec/unit/color/lookup_spec.rb
-- spec/unit/color/new_spec.rb
-- spec/unit/color/strip_spec.rb
-- spec/unit/color/styles_spec.rb
-- spec/unit/color/valid_spec.rb
-- spec/unit/color_parser_spec.rb
-- spec/unit/decorate_dsl_spec.rb
-- spec/unit/decorator_chain_spec.rb
-- spec/unit/delegator_spec.rb
-- spec/unit/detach_spec.rb
-- spec/unit/new_spec.rb
-- spec/unit/respond_to_spec.rb
-- spec/unit/undecorate_spec.rb
-- tasks/console.rake
-- tasks/coverage.rake
-- tasks/spec.rake
-homepage: https://github.com/piotrmurach/pastel
+homepage: https://ttytoolkit.org
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/pastel/issues
+  changelog_uri: https://github.com/piotrmurach/pastel/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/pastel
+  homepage_uri: https://ttytoolkit.org
+  source_code_uri: https://github.com/piotrmurach/pastel
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Terminal strings styling with intuitive and clean API.
-test_files:
-- spec/spec_helper.rb
-- spec/unit/alias_color_spec.rb
-- spec/unit/alias_importer_spec.rb
-- spec/unit/color/alias_color_spec.rb
-- spec/unit/color/code_spec.rb
-- spec/unit/color/colored_spec.rb
-- spec/unit/color/decorate_spec.rb
-- spec/unit/color/equal_spec.rb
-- spec/unit/color/lookup_spec.rb
-- spec/unit/color/new_spec.rb
-- spec/unit/color/strip_spec.rb
-- spec/unit/color/styles_spec.rb
-- spec/unit/color/valid_spec.rb
-- spec/unit/color_parser_spec.rb
-- spec/unit/decorate_dsl_spec.rb
-- spec/unit/decorator_chain_spec.rb
-- spec/unit/delegator_spec.rb
-- spec/unit/detach_spec.rb
-- spec/unit/new_spec.rb
-- spec/unit/respond_to_spec.rb
-- spec/unit/undecorate_spec.rb
-has_rdoc: 
+test_files: []

data/.gitignore

@@ -1,22 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/.rspec

@@ -1,3 +0,0 @@
---color
---require spec_helper
---warnings

data/.travis.yml

@@ -1,25 +0,0 @@
----
-language: ruby
-sudo: false
-cache: bundler
-bundler_args: --without yard benchmarks
-script: "bundle exec rake ci"
-rvm:
-  - 1.9.3
-  - 2.0
-  - 2.1
-  - 2.2
-  - rbx-2
-  - jruby-19mode
-  - jruby
-  - jruby-head
-  - ruby-head
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-  fast_finish: true
-branches:
-  only: master
-notifications:
-  email: false

data/Gemfile

@@ -1,15 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :development do
-  gem 'rspec', '~> 3.4.0'
-  gem 'yard',  '~> 0.8.7'
-  gem 'benchmark-ips', '~> 2.0.0'
-end
-
-group :metrics do
-  gem 'coveralls', '~> 0.8.9'
-  gem 'simplecov', '~> 0.10.0'
-  gem 'yardstick', '~> 0.9.9'
-end

data/Rakefile

@@ -1,8 +0,0 @@
-# encoding: utf-8
-
-require "bundler/gem_tasks"
-
-FileList['tasks/**/*.rake'].each(&method(:import))
-
-desc 'Run all specs'
-task ci: %w[ spec ]