paint 2.1.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bb231495a29211b0176150f329d87ac77db1d974828e8243af1477f434d2280
-  data.tar.gz: fc8a2e350c0416e3900086006c2af736cb28ebc258a91cf1a5b908b717da0b94
+  metadata.gz: 7658c217a56bead27d98cc354dc18b2ab31a9f0344d11982785b9a21916b042b
+  data.tar.gz: 5c94832fd5eae488e54c1bd010247d7d6c65a8b673982783c8bc95207f23d7ab
 SHA512:
-  metadata.gz: fc96a662c775f6a0f73138a56d30bfaa3c918b6c283b48957dc188230175ab93847365995d5844eb33d6f29675bda3a0ffd4f84dc09442833d6d78bda100f0ca
-  data.tar.gz: 01c0e588f1e753185fcd3d73fa38787002ddefcf072a6d68273a061ec3e17b42f7a174eb4d7352994466cf4d8691bbec3f43ca0c9770aa335cf7c7a9a2c96053
+  metadata.gz: 3a685f6489ea93f5c75bff1a529c3539fef1e6285ad65c2e2fff2a08ec974eb07c70ca1f4c20cc3e5d9e32fcca89d8cf1cd309c02bbcfd4d4e5a77975b479daf
+  data.tar.gz: 7d91307247aff2335d72f60e71ec00dcf00db66d3bfd2bd26124ddc0bc9387f3b4c2e96aa6cbabafde63dc46de3193b831b020f4e8a4ec88e7e574a2129912c7

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,68 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

data/.github/workflows/test.yml

@@ -0,0 +1,50 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Ruby ${{ matrix.ruby }} (${{ matrix.os }})
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    strategy:
+      matrix:
+        ruby:
+        - 3.1
+        - 3.0
+        - 2.7
+        - jruby-9.3.6.0
+        - truffleruby-22.1.0
+        os:
+        - ubuntu-latest
+        - macos-latest
+    runs-on: ${{matrix.os}}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake
+
+  test-windows:
+    name: Ruby ${{ matrix.ruby }} (windows-latest)
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    strategy:
+      matrix:
+        ruby:
+        - 3.1
+        - 3.0
+        - 2.7
+    runs-on: windows-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+        bundler-cache: true
+    - run: cinst ansicon
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # CHANGELOG
 
+### 2.3.0
+
+#### Paint.%() now returns different escape sequences!
+
+* Fix #30: Color/effect nesting restores the parent level correctly. More
+           verbose ASCII escape sequences are generated to ensure this.
+
+#### Other Fixes
+
+* Fix #31: Make paint work with frozen strings enabled
+    * Also make paint library itself frozen
+* Fix #29: Update dev dependencies
+
+### 2.2.1
+
+* Explicitly set mac's Terminal.app to 256 colors only, fixes #28
+
+### 2.2.0
+
+* Support NO_COLOR environment variable, implements #26 (see no-color.org)
+
 ### 2.1.1
 
 * Blacklist True Color support for urxvt, fixes #25

data/MIT-LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT LICENSE
 
-Copyright (c) 2011-2018 Jan Lelis
+Copyright (c) 2011-2021 Jan Lelis
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,12 +1,16 @@
-# Ruby Paint [<img src="https://badge.fury.io/rb/paint.svg" />](https://badge.fury.io/rb/paint) [<img src="https://travis-ci.org/janlelis/paint.svg" />](https://travis-ci.org/janlelis/paint)
+# Ruby Paint [<img src="https://badge.fury.io/rb/paint.svg" />](https://badge.fury.io/rb/paint) [<img src="https://github.com/janlelis/paint/workflows/Test/badge.svg" />](https://github.com/janlelis/paint/actions?query=workflow%3ATest)
 
 Paint creates terminal colors and effects for you. It combines the strengths of **term-ansicolor**, **rainbow**, and similar projects into a simple to use, however still flexible terminal colors gem with no core extensions by default.
 
+Supported Rubies: **3.1**, **3.0**, **2.7**
+
+Unsupported, but might still work: **2.6**, **2.5**, **2.4**, **2.3**, **2.2**, **2.1**, **2.0**, **1.9**
+
 ## Features
 
 * No string extensions (suitable for library development)
 * Simple API
-* Faster than other terminal color gems ([as of December 2018](https://gist.github.com/janlelis/91413b9295c81ee873dc))
+* Faster than other terminal color gems ([as of July 2022](https://gist.github.com/janlelis/91413b9295c81ee873dc))
 * Supports *true color* or 256 colors (for capable terminals)
 * Allows you to set any terminal effects
 * `Paint.mode`: Fall-back modes for terminals with less colors, supported modes:
@@ -23,14 +27,6 @@ Starting with **Paint 2.0**, *true color* mode is the new default mode, since mo
 - Manually set `Paint.mode = 256` at the beginning of your code
 - Please [open a new issue](https://github.com/janlelis/paint/issues/new) so we can figure out how to blacklist the terminal used
 
-## Supported Rubies
-
-* **2.6**, **2.5**, **2.4**, **2.3**
-
-Unsupported, but might still work:
-
-* **2.2**, **2.1**, **2.0**, **1.9**
-
 ## Setup
 
 Add to `Gemfile`:
@@ -79,7 +75,7 @@ When you pass multiple colors, the first one is taken as foreground color and th
 
 ## Windows Support
 
-For ANSI support in Windows OS, you can use [ansicon](https://github.com/adoxa/ansicon) or [ConEmu](https://conemu.github.io/) or WSL(https://docs.microsoft.com/en-us/windows/wsl/install-win10).
+For ANSI support in Windows OS, you can use [ansicon](https://github.com/adoxa/ansicon) or [ConEmu](https://conemu.github.io/) or [WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
 
 ## `Paint.mode`
 
@@ -93,8 +89,12 @@ You can choose between five ways to use `Paint.[]` by setting `Paint.mode` to on
 
 Paint tries to automatically detect the proper value your terminal is capable of, please [open an issue](https://github.com/janlelis/paint/issues/new) if `Paint.detect_mode` yields a wrong value for you.
 
+`Paint.detect_mode` will return 0 if the [NO_COLOR environment variable is set](https://github.com/jcs/no_color/).
+
 ## More Details About Terminal Colors and Effects
 
+<img src="https://pbs.twimg.com/media/ENyLvgVXUAgeDTn.jpg" />
+
 Terminal colors/effects get created by [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code). These are strings that look like this: `\e[X;X;X;X;X]m` where X are integers with some meaning. For example, `0` means *reset*, `31` means *red foreground* and `41` stands for red background. When you tell **Paint** to use one of the eight ANSI base colors as foreground color, it just inserts a number between `30` and `37` into the sequence. The following colors are available:
 
 * `:black`
@@ -157,9 +157,11 @@ From time to time, you might find yourself in a situation where you want to colo
 Paint%['Yellow string with a %{blue_text} in it', :yellow,
   blue_text: ["blue text", :blue]
 ]
-# => "\e[33mYellow string with a \e[34mblue text\e[33m in it\e[0m"
+# => "\e[33mYellow string with a \e[34mblue text\e[0m\e[33m in it\e[0m"
 ```
 
+Please note that the resulting ASCII escape sequence can be quite verbose since it restores the parent context after the substitution.
+
 ## Utilities
 
 The `Paint.random` method generates a random ANSI color you can pass into `Paint.[]`:
@@ -184,11 +186,11 @@ pa "Ruby", :red, :underline  # same as puts Paint["Ruby", :red, :underline]
 
 ## Advanced Usage: Shortcuts
 
-There is an extension gem available which allows you to define custom color definitions, which you can reuse later. See [SHORTCUTS.md](https://github.com/janlelis/paint/blob/master/SHORTCUTS.md) for documentation. This is completely optional.
+There is an extension gem available which allows you to define custom color definitions, which you can reuse later. See [SHORTCUTS.md](https://github.com/janlelis/paint/blob/main/SHORTCUTS.md) for documentation. This is completely optional.
 
 ## J-_-L
 
-Copyright (c) 2011-2018 Jan Lelis <https://janlelis.com>, released under the
+Copyright (c) 2011-2021 Jan Lelis <https://janlelis.com>, released under the
 MIT license.
 
 Thank you to [rainbow](https://github.com/sickill/rainbow) and [term-ansicolor](https://github.com/flori/term-ansicolor) for ideas and inspiration. Also, a lot of thanks to all the [contributors](https://github.com/janlelis/paint/contributors)!

data/Rakefile

@@ -35,7 +35,7 @@ desc "Install the gem locally"
 task :install => :gems do
   gemspecs.each{ |gemspec|
     spec = gemspec_spec_for(gemspec)
-    sh %{gem install pkg/#{spec.name}-#{spec.version}.gem --no-rdoc --no-ri}
+    sh %{gem install pkg/#{spec.name}-#{spec.version}.gem --no-doc}
   }
 end
 
@@ -52,3 +52,8 @@ task :rainbow256 do
   }
   puts
 end
+
+desc "Start console session with libraries loaded"
+task :irb do
+  sh "irb -I ./lib -r paint -r paint/shortcuts"
+end

data/lib/paint/constants.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Paint
   # Clears all colors
-  NOTHING = "\033[0m".freeze
+  NOTHING = "\033[0m"
 
   # Number of possible colors in TRUE COLOR mode
   TRUE_COLOR = 0xFFFFFF

data/lib/paint/pa.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'paint'
 
 module Kernel

data/lib/paint/rgb_colors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "zlib"
 
 module Paint

data/lib/paint/util.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Paint
   # Standalone helpers which add functionality you sometimes need when working with terminal colors
   class << self

data/lib/paint/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Paint
-  VERSION = "2.1.1"
+  VERSION = "2.3.0"
 end

data/lib/paint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'paint/version'
 require_relative 'paint/constants'
 require_relative 'paint/util'
@@ -25,9 +27,11 @@ module Paint
       # Substitutions & Nesting
       if substitutions
         substitutions.each{ |key, value|
-          string.gsub!(
+          string = string.gsub(
             "%{#{key}}",
-            (value.is_a?(Array) ? self.%(value, current_color) : value.to_s)
+            value.is_a?(Array) ?
+            self.%(value, clear_color + current_color) :
+            value.to_s
           )
         }
       end
@@ -172,7 +176,9 @@ module Paint
     # Determine supported colors
     # Note: there's no reliable test for 24-bit color support
     def detect_mode
-      if RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ # windows
+      if ENV['NO_COLOR'] # see https://no-color.org/
+        0
+      elsif RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ # windows
         if ENV['ANSICON']
           16
         elsif ENV['ConEmuANSI'] == 'ON'
@@ -180,6 +186,8 @@ module Paint
         else
           0
         end
+      elsif ENV['TERM_PROGRAM'] == 'Apple_Terminal'
+        256
       else
         case ENV['TERM']
         when /^rxvt-(?:.*)-256color$/

data/paint.gemspec

@@ -6,17 +6,19 @@ Gem::Specification.new do |s|
   s.name        = "paint"
   s.version     = Paint::VERSION
   s.authors     = ["Jan Lelis"]
-  s.email       = "mail@janlelis.de"
+  s.email       = ["hi@ruby.consulting"]
   s.homepage    = "https://github.com/janlelis/paint"
   s.summary     = "Terminal painter!"
-  s.description = "Terminal painter: No string extensions / RGB and 256 color support / effect support. Usage: Paint['string', :red, :bright]"
+  s.description = "Terminal painter with RGB and 256 (fallback) color and terminal effects support. No string extensions! Usage: Paint['string', :red, :bright]"
   s.license = 'MIT'
+  s.metadata    = { "rubygems_mfa_required" => "true" }
 
   s.files = %w[
     paint.gemspec
     Rakefile
     .rspec
-    .travis.yml
+    .github/workflows/test.yml
+    .github/workflows/codeql-analysis.yml
     lib/paint.rb
     lib/paint/pa.rb
     lib/paint/rgb_colors.rb
@@ -32,12 +34,7 @@ Gem::Specification.new do |s|
   ]
 
   s.required_ruby_version = '>= 1.9.3'
-  s.add_development_dependency 'rspec', '~> 3.2'
-  s.add_development_dependency 'rake', '~> 12.3'
-  s.add_development_dependency 'benchmark-ips', '~> 2.7'
-  s.add_development_dependency 'rainbow', '~> 3.0'
-  s.add_development_dependency 'term-ansicolor', '~> 1.4'
-  s.add_development_dependency 'ansi', '~> 1.5'
-  s.add_development_dependency 'hansi', '~> 0.2'
-  s.add_development_dependency 'pastel', '~> 0.6'
+  s.add_development_dependency 'rspec', '~> 3.11'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'benchmark-ips', '~> 2.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paint
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-28 00:00:00.000000000 Z
+date: 2022-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -16,115 +16,46 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
-- !ruby/object:Gem::Dependency
-  name: rainbow
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: term-ansicolor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: ansi
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: hansi
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: pastel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-description: 'Terminal painter: No string extensions / RGB and 256 color support /
-  effect support. Usage: Paint[''string'', :red, :bright]'
-email: mail@janlelis.de
+        version: '2.10'
+description: 'Terminal painter with RGB and 256 (fallback) color and terminal effects
+  support. No string extensions! Usage: Paint[''string'', :red, :bright]'
+email:
+- hi@ruby.consulting
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -132,8 +63,9 @@ extra_rdoc_files:
 - CHANGELOG.md
 - MIT-LICENSE.txt
 files:
+- ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/test.yml"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - MIT-LICENSE.txt
 - README.md
@@ -149,7 +81,8 @@ files:
 homepage: https://github.com/janlelis/paint
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -165,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Terminal painter!

data/.travis.yml

@@ -1,25 +0,0 @@
-sudo: false
-language: ruby
-
-rvm:
-- 2.6.0
-- 2.5.3
-- 2.4.5
-- 2.3.8
-- 2.2
-- 2.1
-- 2.0
-- 1.9.3
-- ruby-head
-- jruby-head
-- jruby-9.2.5.0
-- truffleruby
-
-matrix:
-  allow_failures:
-    - rvm: jruby-head
-    - rvm: 2.2
-    - rvm: 2.1
-    - rvm: 2.0
-    - rvm: 1.9.3
-    - rvm: truffleruby