term-ansicolor 1.7.2 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45d5c44dfe80380872b30c025fbbdb6da398482fce8adf8cbdb6353d81b6ca61
-  data.tar.gz: eed4f4cb1203e4ced32f053125e668ce6e9ffcca589b177cabcb40a675cc6e14
+  metadata.gz: 9718f060556740778ada5aec7993d0ed9e4b61548b037f437255c2b01697dafa
+  data.tar.gz: 2f8eebac308b3c1d46436916c4dd7e37d71bfce3bb4376ed0b88027da1a1af9e
 SHA512:
-  metadata.gz: 85098f326b4e01c3d3e0ae17dfcf00d3b76897625d5db09de1ca7c172b140b1250b05f98578a8534caf21032f24949a8a9ab81912d2d819a85aad4024c91b097
-  data.tar.gz: 23af07f3f3652f7867adab58eb360ed8f5d2adae614508ac92877d8aa6fbfd7e5a31501eb4dcb29f3ce0971f80e22b18a8667759d6d5dc78a30ef25abfcc3e53
+  metadata.gz: 3a59e5c5c1ba7d9ece81227fc207be44959ac5c6f9d2b6c89c35a16563217f0f36c70c1ea33fa8a7ed89fc9e47e0a3ebf9827401e08b89b770b2f9a1c28c9701
+  data.tar.gz: a842928574662464fd5ad2bbd18bb9bcf0a45b1bd354e674462004ca07f60d3f36ef8b18bccb60faeba08f416f19652be501e51f17b216fce96f8068d7efdec5

data/.all_images.yml

@@ -11,6 +11,7 @@ script: &script |-
   rake test
 
 images:
+  ruby:3.3-alpine: *script
   ruby:3.2-alpine: *script
   ruby:3.1-alpine: *script
   ruby:3.0-alpine: *script

data/.tool-versions

@@ -1 +1 @@
-ruby 3.2.3
+ruby 3.3.0

data/VERSION

@@ -1 +1 @@
-1.7.2
+1.8.0

data/examples/example.rb

@@ -88,3 +88,5 @@ print [
     uncolored { "not red anymore".red },
     uncolored("not red anymore".red)
   ].map { |x| x + "\n" } * ''
+
+puts "Use the " + "Source".hyperlink("https://github.com/flori/term-ansicolor") + ", Luke!"

data/lib/term/ansicolor/hyperlink.rb

@@ -0,0 +1,34 @@
+require 'tins/terminal'
+
+module Term
+  module ANSIColor
+    module Hyperlink
+      def hyperlink(link, string = nil, id: nil, as_link: false)
+        block_given? && string != nil && !respond_to?(:to_str) and
+          raise ArgumentError,
+          "Require either the string argument or a block argument"
+        if link.nil?
+          link = ''
+        end
+        if as_link && !link.empty?
+          string ||= link
+        end
+        result = ''
+        if Term::ANSIColor.coloring?
+          result = "\e]8;#{"id=#{id}" unless id.nil?};" << link.to_str << "\e\\"
+        end
+        if block_given?
+          result << yield.to_s
+        elsif string.respond_to?(:to_str)
+          result << string.to_str
+        elsif respond_to?(:to_str)
+          result << to_str
+        else
+          return result # only switch on
+        end
+        result << "\e]8;;\e\\" if Term::ANSIColor.coloring?
+        result
+      end
+    end
+  end
+end

data/lib/term/ansicolor/version.rb

@@ -1,6 +1,6 @@
 module Term::ANSIColor
   # Term::ANSIColor version
-  VERSION         = '1.7.2'
+  VERSION         = '1.8.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/lib/term/ansicolor.rb

@@ -15,8 +15,9 @@ module Term
     require 'term/ansicolor/attribute/intense_color8'
     require 'term/ansicolor/attribute/color256'
     require 'term/ansicolor/movement'
-
     include Term::ANSIColor::Movement
+    require 'term/ansicolor/hyperlink'
+    include Term::ANSIColor::Hyperlink
 
     # :stopdoc:
     ATTRIBUTE_NAMES = Attribute.named_attributes.map(&:name)
@@ -95,7 +96,7 @@ module Term
       elsif respond_to?(:to_str)
         result << to_str
       else
-        return result #only switch on
+        return result # only switch on
       end
       result << "\e[0m" if Term::ANSIColor.coloring?
       result.extend(Term::ANSIColor)

data/term-ansicolor.gemspec

@@ -1,31 +1,31 @@
 # -*- encoding: utf-8 -*-
-# stub: term-ansicolor 1.7.2 ruby lib
+# stub: term-ansicolor 1.8.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "term-ansicolor".freeze
-  s.version = "1.7.2"
+  s.version = "1.8.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Florian Frank".freeze]
-  s.date = "2024-03-15"
+  s.date = "2024-04-13"
   s.description = "This library uses ANSI escape sequences to control the attributes of terminal output".freeze
   s.email = "flori@ping.de".freeze
   s.executables = ["term_cdiff".freeze, "term_colortab".freeze, "term_decolor".freeze, "term_display".freeze, "term_mandel".freeze, "term_snow".freeze]
-  s.extra_rdoc_files = ["README.md".freeze, "lib/term/ansicolor.rb".freeze, "lib/term/ansicolor/attribute.rb".freeze, "lib/term/ansicolor/attribute/color256.rb".freeze, "lib/term/ansicolor/attribute/color8.rb".freeze, "lib/term/ansicolor/attribute/intense_color8.rb".freeze, "lib/term/ansicolor/attribute/text.rb".freeze, "lib/term/ansicolor/hsl_triple.rb".freeze, "lib/term/ansicolor/movement.rb".freeze, "lib/term/ansicolor/ppm_reader.rb".freeze, "lib/term/ansicolor/rgb_color_metrics.rb".freeze, "lib/term/ansicolor/rgb_triple.rb".freeze, "lib/term/ansicolor/version.rb".freeze]
-  s.files = [".all_images.yml".freeze, ".gitignore".freeze, ".tool-versions".freeze, "CHANGES".freeze, "COPYING".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/term_cdiff".freeze, "bin/term_colortab".freeze, "bin/term_decolor".freeze, "bin/term_display".freeze, "bin/term_mandel".freeze, "bin/term_snow".freeze, "examples/example.rb".freeze, "examples/lambda-red-plain.ppm".freeze, "examples/lambda-red.png".freeze, "examples/lambda-red.ppm".freeze, "lib/term/ansicolor.rb".freeze, "lib/term/ansicolor/.keep".freeze, "lib/term/ansicolor/attribute.rb".freeze, "lib/term/ansicolor/attribute/color256.rb".freeze, "lib/term/ansicolor/attribute/color8.rb".freeze, "lib/term/ansicolor/attribute/intense_color8.rb".freeze, "lib/term/ansicolor/attribute/text.rb".freeze, "lib/term/ansicolor/hsl_triple.rb".freeze, "lib/term/ansicolor/movement.rb".freeze, "lib/term/ansicolor/ppm_reader.rb".freeze, "lib/term/ansicolor/rgb_color_metrics.rb".freeze, "lib/term/ansicolor/rgb_triple.rb".freeze, "lib/term/ansicolor/version.rb".freeze, "term-ansicolor.gemspec".freeze, "tests/ansicolor_test.rb".freeze, "tests/attribute_test.rb".freeze, "tests/hsl_triple_test.rb".freeze, "tests/ppm_reader_test.rb".freeze, "tests/rgb_color_metrics_test.rb".freeze, "tests/rgb_triple_test.rb".freeze, "tests/test_helper.rb".freeze]
+  s.extra_rdoc_files = ["README.md".freeze, "lib/term/ansicolor.rb".freeze, "lib/term/ansicolor/attribute.rb".freeze, "lib/term/ansicolor/attribute/color256.rb".freeze, "lib/term/ansicolor/attribute/color8.rb".freeze, "lib/term/ansicolor/attribute/intense_color8.rb".freeze, "lib/term/ansicolor/attribute/text.rb".freeze, "lib/term/ansicolor/hsl_triple.rb".freeze, "lib/term/ansicolor/hyperlink.rb".freeze, "lib/term/ansicolor/movement.rb".freeze, "lib/term/ansicolor/ppm_reader.rb".freeze, "lib/term/ansicolor/rgb_color_metrics.rb".freeze, "lib/term/ansicolor/rgb_triple.rb".freeze, "lib/term/ansicolor/version.rb".freeze]
+  s.files = [".all_images.yml".freeze, ".gitignore".freeze, ".tool-versions".freeze, "CHANGES".freeze, "COPYING".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/term_cdiff".freeze, "bin/term_colortab".freeze, "bin/term_decolor".freeze, "bin/term_display".freeze, "bin/term_mandel".freeze, "bin/term_snow".freeze, "examples/example.rb".freeze, "examples/lambda-red-plain.ppm".freeze, "examples/lambda-red.png".freeze, "examples/lambda-red.ppm".freeze, "lib/term/ansicolor.rb".freeze, "lib/term/ansicolor/.keep".freeze, "lib/term/ansicolor/attribute.rb".freeze, "lib/term/ansicolor/attribute/color256.rb".freeze, "lib/term/ansicolor/attribute/color8.rb".freeze, "lib/term/ansicolor/attribute/intense_color8.rb".freeze, "lib/term/ansicolor/attribute/text.rb".freeze, "lib/term/ansicolor/hsl_triple.rb".freeze, "lib/term/ansicolor/hyperlink.rb".freeze, "lib/term/ansicolor/movement.rb".freeze, "lib/term/ansicolor/ppm_reader.rb".freeze, "lib/term/ansicolor/rgb_color_metrics.rb".freeze, "lib/term/ansicolor/rgb_triple.rb".freeze, "lib/term/ansicolor/version.rb".freeze, "term-ansicolor.gemspec".freeze, "tests/ansicolor_test.rb".freeze, "tests/attribute_test.rb".freeze, "tests/hsl_triple_test.rb".freeze, "tests/hyperlink_test.rb".freeze, "tests/ppm_reader_test.rb".freeze, "tests/rgb_color_metrics_test.rb".freeze, "tests/rgb_triple_test.rb".freeze, "tests/test_helper.rb".freeze]
   s.homepage = "https://github.com/flori/term-ansicolor".freeze
   s.licenses = ["Apache-2.0".freeze]
   s.rdoc_options = ["--title".freeze, "Term-ansicolor - Ruby library that colors strings using ANSI escape sequences".freeze, "--main".freeze, "README.md".freeze]
-  s.rubygems_version = "3.4.19".freeze
+  s.rubygems_version = "3.5.3".freeze
   s.summary = "Ruby library that colors strings using ANSI escape sequences".freeze
-  s.test_files = ["tests/ansicolor_test.rb".freeze, "tests/attribute_test.rb".freeze, "tests/hsl_triple_test.rb".freeze, "tests/ppm_reader_test.rb".freeze, "tests/rgb_color_metrics_test.rb".freeze, "tests/rgb_triple_test.rb".freeze, "tests/test_helper.rb".freeze]
+  s.test_files = ["tests/ansicolor_test.rb".freeze, "tests/attribute_test.rb".freeze, "tests/hsl_triple_test.rb".freeze, "tests/hyperlink_test.rb".freeze, "tests/ppm_reader_test.rb".freeze, "tests/rgb_color_metrics_test.rb".freeze, "tests/rgb_triple_test.rb".freeze, "tests/test_helper.rb".freeze]
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.14.0"])
-  s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
-  s.add_development_dependency(%q<test-unit>.freeze, [">= 0"])
-  s.add_development_dependency(%q<utils>.freeze, [">= 0"])
-  s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.0"])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.15.0".freeze])
+  s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<test-unit>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<utils>.freeze, [">= 0".freeze])
+  s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.0".freeze])
 end

data/tests/hyperlink_test.rb

@@ -0,0 +1,54 @@
+class HyperlinkTest < Test::Unit::TestCase
+  include Term::ANSIColor
+
+  def setup
+    @link = 'https://foo.example.com'
+  end
+
+  def test_hyperlink_switch_on
+    assert_equal(
+      "\e]8;;#@link\e\\",
+      hyperlink(@link)
+    )
+  end
+
+  def test_hyperlink_switch_off
+    assert_equal(
+      "\e]8;;\e\\",
+      hyperlink(nil)
+    )
+  end
+
+  def test_hyperlink_as_link
+    assert_equal(
+      hyperlink(@link, as_link: true),
+      "\e]8;;#@link\e\\#@link\e]8;;\e\\",
+    )
+  end
+
+  def test_hyperlink_two_args
+    assert_equal(
+      "\e]8;;#@link\e\\foo\e]8;;\e\\",
+      hyperlink(@link, 'foo')
+    )
+  end
+
+  def test_hyperlink_two_args_with_id
+    assert_equal(
+      "\e]8;id=666;#@link\e\\foo\e]8;;\e\\",
+      hyperlink(@link, 'foo', id: 666)
+    )
+  end
+
+  def test_hyperlink_block_arg
+    assert_raise(ArgumentError) { hyperlink(@link, 'bar') { 'baz' } }
+    assert_equal(
+      "\e]8;;#@link\e\\foo\e]8;;\e\\",
+      hyperlink(@link) { 'foo' }
+    )
+  end
+
+  def test_with_stringy_self
+    assert_equal "\e]8;;#@link\e\\foo\e]8;;\e\\", "foo".hyperlink(@link)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: term-ansicolor
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.8.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-15 00:00:00.000000000 Z
+date: 2024-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +100,7 @@ extra_rdoc_files:
 - lib/term/ansicolor/attribute/intense_color8.rb
 - lib/term/ansicolor/attribute/text.rb
 - lib/term/ansicolor/hsl_triple.rb
+- lib/term/ansicolor/hyperlink.rb
 - lib/term/ansicolor/movement.rb
 - lib/term/ansicolor/ppm_reader.rb
 - lib/term/ansicolor/rgb_color_metrics.rb
@@ -133,6 +134,7 @@ files:
 - lib/term/ansicolor/attribute/intense_color8.rb
 - lib/term/ansicolor/attribute/text.rb
 - lib/term/ansicolor/hsl_triple.rb
+- lib/term/ansicolor/hyperlink.rb
 - lib/term/ansicolor/movement.rb
 - lib/term/ansicolor/ppm_reader.rb
 - lib/term/ansicolor/rgb_color_metrics.rb
@@ -142,6 +144,7 @@ files:
 - tests/ansicolor_test.rb
 - tests/attribute_test.rb
 - tests/hsl_triple_test.rb
+- tests/hyperlink_test.rb
 - tests/ppm_reader_test.rb
 - tests/rgb_color_metrics_test.rb
 - tests/rgb_triple_test.rb
@@ -169,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Ruby library that colors strings using ANSI escape sequences
@@ -177,6 +180,7 @@ test_files:
 - tests/ansicolor_test.rb
 - tests/attribute_test.rb
 - tests/hsl_triple_test.rb
+- tests/hyperlink_test.rb
 - tests/ppm_reader_test.rb
 - tests/rgb_color_metrics_test.rb
 - tests/rgb_triple_test.rb