rainbow 3.0.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 831ab2db7f80a9a72f2993f1e7b4f3ffa08a4495
-  data.tar.gz: 0f842d288049511c94a95ce9b8a9210cf5e2344b
+SHA256:
+  metadata.gz: 7367f9386ef2460491f123bd207091956c6dcce6300dcf3957a48c126a1ec900
+  data.tar.gz: 1c123ecd4c6ee30422ff9df560df3ec4f5d4c8bcb6010e3a0c5be4435848894a
 SHA512:
-  metadata.gz: ecde479bb8ea6f267200efaf03be79e7141bf6fccd7a7191960b2f9f52d809120a943a341f467f0a01c982ff11bf8bd23e66c8732d3af0b22643be5da13b55ec
-  data.tar.gz: b11241f918993558e8a4d248d9eb4b458793e926e10e7e387d5dabaf9e15a988adeda1441c93b3be9d051c939fbf566b2493ba9f8df8eff0bbf629bf36798cac
+  metadata.gz: 64ddf54fa7edd4f0f05301270503025bfb63cbca6db7e940b4cf6c62cbd860b3cf939c885f5e69becd1f4faf39c9d2fe1e8a35597dd28fe1b30df26e52f334f0
+  data.tar.gz: 74550a67235dcca95dbd6404023576843e626e0ec00e557c0e38fbd145f778983b6c63136008d39da958a4fc83dc73e7a62758a40c8ead76c24066e968b66b6e

data/Changelog.md

@@ -1,10 +1,18 @@
 # Rainbow changelog
 
-## 3.0.0 (2017-10-24)
+## 3.1.0 (2020-08-26)
 
+- added `cross_out` aka `strike`
+- hexadecimal color names supported better, see #83
+- gemspec: list files using a Ruby expression, avoiding git
+
+## 3.0.0 (2017-11-29)
+
+* added String refinement
+* added new `Rainbow.uncolor` method
 * dropped MRI 1.9.3 compatibility
 * dropped MRI 2.0 compatibility
-* removed rake dependency
+* removed Rake dependency
 
 ## 2.2.2 (2017-04-21)
 

data/README.markdown

@@ -29,6 +29,8 @@ puts Rainbow("this is red").red + " and " + Rainbow("this on yellow bg").bg(:yel
 # => "\e[31mthis is red\e[0m and \e[43mthis on yellow bg\e[0m and \e[4m\e[1meven bright underlined!\e[0m"
 ```
 
+![Screenshot of the previous code in a terminal](https://user-images.githubusercontent.com/132/132943811-93747cc5-bdaf-43a2-a1a4-a1f18e805eba.png)
+
 Or, [watch this video example](https://asciinema.org/a/J928KpHoUQ0sl54ulOSOLE71E?rows=20&speed=2.5)
 
 ### Rainbow presenter API
@@ -44,6 +46,7 @@ Rainbow presenter adds the following methods to presented string:
 * `hide`
 * `faint` (not well supported by terminal emulators)
 * `italic` (not well supported by terminal emulators)
+* `cross_out`, `strike`
 
 Text color can also be changed by calling a method named by a color:
 

data/lib/rainbow/color.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rainbow
   class Color
     attr_reader :ground
@@ -36,6 +38,11 @@ module Rainbow
     end
 
     def self.parse_hex_color(hex)
+      unless hex =~ /^#?[a-f0-9]{6}/i
+        raise ArgumentError,
+              "Invalid hexadecimal RGB triplet. Valid format: /^#?[a-f0-9]{6}/i"
+      end
+
       hex = hex.sub(/^#/, '')
       r   = hex[0..1].to_i(16)
       g   = hex[2..3].to_i(16)
@@ -61,14 +68,14 @@ module Rainbow
 
     class Named < Indexed
       NAMES = {
-        black:   0,
-        red:     1,
-        green:   2,
-        yellow:  3,
-        blue:    4,
+        black: 0,
+        red: 1,
+        green: 2,
+        yellow: 3,
+        blue: 4,
         magenta: 5,
-        cyan:    6,
-        white:   7,
+        cyan: 6,
+        white: 7,
         default: 9
       }.freeze
 
@@ -98,7 +105,7 @@ module Rainbow
       end
 
       def initialize(ground, *values)
-        if values.min < 0 || values.max > 255
+        if values.min.negative? || values.max > 255
           raise ArgumentError, "RGB value outside 0-255 range"
         end
 

data/lib/rainbow/ext/string.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rainbow'
 
 module Rainbow
@@ -46,9 +48,17 @@ module Rainbow
         def hide
           Rainbow(self).hide
         end
+
+        def cross_out
+          Rainbow(self).cross_out
+        end
+
+        alias strike cross_out
       end
     end
   end
 end
 
-::String.send(:include, Rainbow::Ext::String::InstanceMethods)
+class String
+  include Rainbow::Ext::String::InstanceMethods
+end

data/lib/rainbow/global.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'wrapper'
 
 module Rainbow

data/lib/rainbow/null_presenter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rainbow
   class NullPresenter < ::String
     def color(*_values)
@@ -40,6 +42,10 @@ module Rainbow
       self
     end
 
+    def cross_out
+      self
+    end
+
     def black
       self
     end
@@ -89,5 +95,6 @@ module Rainbow
     alias bg background
     alias bold bright
     alias dark faint
+    alias strike cross_out
   end
 end

data/lib/rainbow/presenter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'string_utils'
 require_relative 'x11_color_names'
 require_relative 'color'
@@ -5,14 +7,15 @@ require_relative 'color'
 module Rainbow
   class Presenter < ::String
     TERM_EFFECTS = {
-      reset:     0,
-      bright:    1,
-      faint:     2,
-      italic:    3,
+      reset: 0,
+      bright: 1,
+      faint: 2,
+      italic: 3,
       underline: 4,
-      blink:     5,
-      inverse:   7,
-      hide:      8
+      blink: 5,
+      inverse: 7,
+      hide: 8,
+      cross_out: 9
     }.freeze
 
     # Sets color of this text.
@@ -80,6 +83,12 @@ module Rainbow
       wrap_with_sgr(TERM_EFFECTS[:hide])
     end
 
+    def cross_out
+      wrap_with_sgr(TERM_EFFECTS[:cross_out])
+    end
+
+    alias strike cross_out
+
     def black
       color(:black)
     end

data/lib/rainbow/refinement.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'presenter'
 require_relative 'global'
 

data/lib/rainbow/string_utils.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
+
 module Rainbow
   class StringUtils
     def self.wrap_with_sgr(string, codes)
       return string if codes.empty?
 
       seq = "\e[" + codes.join(";") + "m"
-      match = string.match(/^(\e\[([\d;]+)m)*/)
-      seq_pos = match.end(0)
-      string = string[0...seq_pos] + seq + string[seq_pos..-1]
 
-      string += "\e[0m" unless string =~ /\e\[0m$/
+      string = string.sub(/^(\e\[([\d;]+)m)*/) { |m| m + seq }
+
+      return string if string.end_with? "\e[0m"
 
-      string
+      string + "\e[0m"
     end
 
     def self.uncolor(string)

data/lib/rainbow/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rainbow
-  VERSION = "3.0.0".freeze
+  VERSION = "3.1.1"
 end

data/lib/rainbow/wrapper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'presenter'
 require_relative 'null_presenter'
 

data/lib/rainbow/x11_color_names.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rainbow
   module X11ColorNames
     NAMES = {

data/lib/rainbow.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'rainbow/global'
 
 module Rainbow

metadata

@@ -1,30 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: rainbow
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Marcin Kulik
 - Olle Jonsson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-29 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: Colorize printed text on ANSI terminals
 email:
 - m@ku1ik.com
@@ -32,17 +38,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
 - Changelog.md
-- Gemfile
-- Guardfile
 - LICENSE
 - README.markdown
-- Rakefile
-- appveyor.yml
 - lib/rainbow.rb
 - lib/rainbow/color.rb
 - lib/rainbow/ext/string.rb
@@ -54,24 +52,11 @@ files:
 - lib/rainbow/version.rb
 - lib/rainbow/wrapper.rb
 - lib/rainbow/x11_color_names.rb
-- rainbow.gemspec
-- spec/integration/instance_spec.rb
-- spec/integration/rainbow_spec.rb
-- spec/integration/refinement_spec.rb
-- spec/integration/string_spec.rb
-- spec/integration/uncolor_spec.rb
-- spec/spec_helper.rb
-- spec/support/presenter_shared_examples.rb
-- spec/unit/color_spec.rb
-- spec/unit/null_presenter_spec.rb
-- spec/unit/presenter_spec.rb
-- spec/unit/string_utils_spec.rb
-- spec/unit/wrapper_spec.rb
 homepage: https://github.com/sickill/rainbow
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -79,28 +64,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Colorize printed text on ANSI terminals
-test_files:
-- spec/integration/instance_spec.rb
-- spec/integration/rainbow_spec.rb
-- spec/integration/refinement_spec.rb
-- spec/integration/string_spec.rb
-- spec/integration/uncolor_spec.rb
-- spec/spec_helper.rb
-- spec/support/presenter_shared_examples.rb
-- spec/unit/color_spec.rb
-- spec/unit/null_presenter_spec.rb
-- spec/unit/presenter_spec.rb
-- spec/unit/string_utils_spec.rb
-- spec/unit/wrapper_spec.rb
+test_files: []

data/.gitignore

@@ -1,17 +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

data/.rubocop.yml

@@ -1,20 +0,0 @@
-inherit_from: .rubocop_todo.yml
-
-AllCops:
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  TargetRubyVersion: "2.1"
-  Exclude:
-    - "spec/**/*"
-    - "vendor/**/*"
-Documentation:
-  Enabled: false
-
-HashSyntax:
-  Enabled: false
-
-MethodName:
-  Enabled: false
-
-StringLiterals:
-  Enabled: false

data/.rubocop_todo.yml

@@ -1,29 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2017-06-30 12:37:52 +0200 using RuboCop version 0.49.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-Metrics/AbcSize:
-  Max: 25
-
-# Offense count: 1
-Metrics/CyclomaticComplexity:
-  Max: 9
-
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 23
-
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ModuleLength:
-  Max: 147
-
-# Offense count: 1
-Metrics/PerceivedComplexity:
-  Max: 8

data/.travis.yml

@@ -1,24 +0,0 @@
-language: ruby
-cache:
-  bundler: true
-
-before_install:
-  - gem install bundler
-
-bundler_args: --without guard development
-
-matrix:
-  include:
-    - rvm: 2.1.10
-    - rvm: 2.2.7
-    - rvm: 2.3.4
-    - rvm: 2.4.1
-    - rvm: jruby-9.1.14.0
-      jdk: oraclejdk8
-    - rvm: 2.2.7
-      install: true # This skips 'bundle install'
-      script: gem build rainbow && gem install *.gem
-
-env:
-  global:
-    - JRUBY_OPTS=--debug

data/Gemfile

@@ -1,28 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'rake'
-
-group :test do
-  gem 'coveralls', require: false
-  gem 'rspec'
-end
-
-group :development do
-  gem 'mutant-rspec'
-end
-
-group :test, :development do
-  gem 'rubocop', '~> 0.51.0'
-end
-
-group :guard do
-  gem 'guard'
-  gem 'guard-rspec'
-end
-
-platform :rbx do
-  gem 'json'
-  gem 'rubysl'
-end

data/Guardfile

@@ -1,8 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard :rspec, cmd: 'rspec --color' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { "spec" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end

data/Rakefile

@@ -1,9 +0,0 @@
-require "bundler/gem_tasks"
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new
-
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/appveyor.yml

@@ -1,40 +0,0 @@
----
-
-version: "{build}"
-
-install:
-  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
-  - bundle config --local path vendor/bundle
-  - bundle install --jobs 3 --retry 3 --without guard development 
-
-build: off
-
-cache:
-  - vendor/bundle
-
-init:
-  - git config --global core.autocrlf true
-
-before_test:
-  - ruby -v
-  - gem -v
-  - bundle -v
-
-test_script:
-  - bundle exec rake
-
-environment:
-  matrix:
-    - RUBY_VERSION: 21
-    - RUBY_VERSION: 21-x64
-    - RUBY_VERSION: 22
-    - RUBY_VERSION: 22-x64
-    - RUBY_VERSION: 23
-    - RUBY_VERSION: 23-x64
-
-matrix:
-  fast_finish: true
-
-branches:
-  only:
-    - master

data/rainbow.gemspec

@@ -1,22 +0,0 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rainbow/version'
-
-Gem::Specification.new do |spec|
-  spec.name                  = "rainbow"
-  spec.version               = Rainbow::VERSION
-  spec.authors               = ["Marcin Kulik", "Olle Jonsson"]
-  spec.email                 = ["m@ku1ik.com"]
-  spec.description           = 'Colorize printed text on ANSI terminals'
-  spec.summary               = 'Colorize printed text on ANSI terminals'
-  spec.homepage              = "https://github.com/sickill/rainbow"
-  spec.license               = "MIT"
-  spec.required_ruby_version = '>= 2.1.0'
-
-  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-end

data/spec/integration/instance_spec.rb

@@ -1,33 +0,0 @@
-require 'spec_helper'
-require 'rainbow'
-
-RSpec.describe 'Custom Rainbow instance' do
-  it 'inherits enabled state from the global instance' do
-    Rainbow.enabled = :yep
-    expect(Rainbow.new.enabled).to eq(:yep)
-  end
-
-  it 'tracks its own state separately from the global instance' do
-    Rainbow.enabled = :yep
-    rainbow = Rainbow.new
-    expect(Rainbow.new.enabled).to eq(:yep)
-
-    rainbow.enabled = :nope
-    expect(Rainbow.enabled).to eq(:yep)
-    expect(rainbow.enabled).to eq(:nope)
-  end
-
-  it 'wraps string with escape codes when enabled' do
-    rainbow = Rainbow.new
-    rainbow.enabled = true
-
-    expect(rainbow.wrap('hello').green).to eq("\e[32mhello\e[0m")
-  end
-
-  it "doesn't wrap string with any escape code when disabled" do
-    rainbow = Rainbow.new
-    rainbow.enabled = false
-
-    expect(rainbow.wrap('hello').green).to eq('hello')
-  end
-end