tone 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 803a8df0924e05ab33d732bdcedcec8cec4a76c31fb5613127f2849425c8026b
-  data.tar.gz: d0247c2613d4ee0dcd776e829541b8af737b720ae3bc41bb3c2470df38544e5b
+  metadata.gz: d0598688304d0d6f067c4e234a89221866d6776e695f483a501e0b36ae53dc45
+  data.tar.gz: 2948824aa08f7b1c07d5bce6cfd99610a660ac23ceef2ad10af03417824c362b
 SHA512:
-  metadata.gz: a78cc339e5100a10fddc26d41f56550cc0961b2ee6f5c1da42d1ce2c3d5204be4ca0d1816657cc360c087e75dc6bd994f8db164da8073217e550d07eaa31c527
-  data.tar.gz: 2c5881cda025ebb59298c7e28a1ab108b14a00f38f025e8838f35881561ae1ce30ba2d9fa59e4a51a5430d8c741a0e891a03f2aa244bfc2a61051e2584d5bb79
+  metadata.gz: 2c8847234b60d61ec895cf183eabc244111168622c68a579929e433b120ec12b346d062daf84f2731366c01ba0b6bb8bebccd13ec57472b29a341ec1ed1e7feb
+  data.tar.gz: e40439af7f32b56103819a09a2fd8fb762e4fc6fb73ce34ff98772d493b2e78c81a6b1d506b2c980eb44c17fc02e7d62b24e9cee6a03e44166eec9e4b595a1ee

data/README.adoc

@@ -4,6 +4,7 @@
 
 :amazing_print_link: link:https://github.com/amazing-print/amazing_print[Amazing Print]
 :pattern_matching_link: link:https://alchemists.io/articles/ruby_pattern_matching[pattern matching]
+:rspec_link: link:https://rspec.info[RSpec]
 
 = Tone
 
@@ -383,6 +384,47 @@ tone.get_alias :bogus
 # Invalid alias or default: :bogus. (Tone::Error)
 ----
 
+=== Testing
+
+When using this gem in your project, you might find it convenient to use the `have_color` {rspec_link} matcher. This matcher is optional and _must be manually required_ for use in your spec helper:
+
+[source,ruby]
+----
+# spec_helper.rb
+require "tone/rspec/matchers/have_color"
+----
+
+Once required, you can leverage the matcher in any spec as follows:
+
+[source,ruby]
+----
+RSpec.describe DemoPresenter do
+  subject(:presenter) { DemoPresenter.new color: }
+
+  let(:color) { Tone.new }
+
+  describe "#to_s" do
+    it "renders colored text" do
+      expect(presenter.to_s).to have_color(color, ["Test 0.0.0: A test.", :bold])
+    end
+  end
+end
+----
+
+The first argument _must be an instanced of Tone_ because you might have custom aliases which must be known in order to validate your spec. All subsequent arguments (one to many) that follow after the first argument can be a list of decoded tuples as would normally be answered by `Tone#decode`.
+
+In situations where the spec fails, you'll get a formatted error so you can quickly fix as necessary:
+
+....
+expected "\e[37mtest\e[0m\n" to have color decoded as:
+["text", :blue],
+["\n"]
+
+but actually is:
+["test", :white],
+["\n"]
+....
+
 === Guidelines
 
 The following are worth considering, when using this gem, to help keep your implementation consistent.
@@ -426,14 +468,14 @@ cd tone
 bin/setup
 ----
 
-You use the IRB console for direct access to all objects:
+You can use the IRB console for direct access to all objects:
 
 [source,bash]
 ----
 bin/console
 ----
 
-Lastly, there is a `bin/show` script which will display all default styles for quick visual convenience. This is the same script that was used to generate the screenshot you saw at the top of this document.
+Lastly, there is a `bin/show` script which displays the default styles for quick visual reference. This is the same script used to generate the screenshots shown at the top of this document.
 
 [source,bash]
 ----

data/lib/tone/aliaser.rb

@@ -20,7 +20,7 @@ module Tone
       custom.fetch symbol do
         return key if defaults.key? symbol
 
-        usage = defaults.keys.append(*custom.keys).map(&:inspect).to_sentence conjunction: "and/or"
+        usage = defaults.keys.append(*custom.keys).to_usage "and/or"
 
         fail Error, "Invalid alias or default: #{key.inspect}. Use: #{usage}."
       end
@@ -51,7 +51,7 @@ module Tone
 
     def check_style key, style
       defaults.fetch style do
-        usage = defaults.keys.map(&:inspect).to_sentence conjunction: "and/or"
+        usage = defaults.keys.to_usage "and/or"
 
         fail Error, "Invalid style (#{style.inspect}) for key (#{key.inspect}). Use: #{usage}."
       end

data/lib/tone/rspec/matchers/have_color.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :have_color do |color, *expected|
+  match do |actual|
+    fail ArgumentError, "First argument must be a color instance." unless color.respond_to? :decode
+
+    @decode = color.decode actual
+    @decode == expected
+  end
+
+  failure_message do |actual|
+    <<~MESSAGE
+      expected #{actual.inspect} to have color decoded as:
+      #{expected.map(&:inspect).join(",\n")}
+
+      but actually is:
+      #{@decode.map(&:inspect).join(",\n")}
+    MESSAGE
+  end
+end

data/lib/tone.rb

@@ -2,7 +2,10 @@
 
 require "zeitwerk"
 
-Zeitwerk::Loader.for_gem.setup
+Zeitwerk::Loader.for_gem.then do |loader|
+  loader.ignore "#{__dir__}/rspec/matchers"
+  loader.setup
+end
 
 # Main namespace.
 module Tone

data/tone.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |spec|
   spec.name = "tone"
-  spec.version = "0.1.0"
+  spec.version = "0.3.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/tone"
-  spec.summary = "A customizable ANSI text colorizer for your terminal."
+  spec.summary = "A customizable ANSI text terminal colorizer."
   spec.license = "Hippocratic-2.1"
 
   spec.metadata = {
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.cert_chain = [Gem.default_cert_path]
 
   spec.required_ruby_version = "~> 3.2"
-  spec.add_dependency "refinements", "~> 10.0"
+  spec.add_dependency "refinements", "~> 11.0"
   spec.add_dependency "zeitwerk", "~> 2.6"
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tone
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinements
@@ -43,14 +43,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +84,7 @@ files:
 - lib/tone/decoder.rb
 - lib/tone/encoder.rb
 - lib/tone/error.rb
+- lib/tone/rspec/matchers/have_color.rb
 - tone.gemspec
 homepage: https://alchemists.io/projects/tone
 licenses:
@@ -111,8 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.14
 signing_key:
 specification_version: 4
-summary: A customizable ANSI text colorizer for your terminal.
+summary: A customizable ANSI text terminal colorizer.
 test_files: []