tone 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 803a8df0924e05ab33d732bdcedcec8cec4a76c31fb5613127f2849425c8026b
-  data.tar.gz: d0247c2613d4ee0dcd776e829541b8af737b720ae3bc41bb3c2470df38544e5b
+  metadata.gz: 9545daf90651afc61d7c2746db9b12e99cdebf768f1930d5d7933b01573dc301
+  data.tar.gz: 124e32e3aa2201636dc3a6a269c10145dfa5e8c41b7c0b6597ef8254cf631082
 SHA512:
-  metadata.gz: a78cc339e5100a10fddc26d41f56550cc0961b2ee6f5c1da42d1ce2c3d5204be4ca0d1816657cc360c087e75dc6bd994f8db164da8073217e550d07eaa31c527
-  data.tar.gz: 2c5881cda025ebb59298c7e28a1ab108b14a00f38f025e8838f35881561ae1ce30ba2d9fa59e4a51a5430d8c741a0e891a03f2aa244bfc2a61051e2584d5bb79
+  metadata.gz: 9894a60b8dc02cf1624904dd802f3f824b9ef326b1632beca7c763ca131ea686032296d6d33aa49b3e5a1cfb2d1c72c4d889464d95bf46150bf8dcada2e47ee1
+  data.tar.gz: e81e5dfa92d3e42b789759fa0ea481abd9a3e785b3a0eb72d2de9d4be685e348bc6e5b5363f982c24435f68cf2f6cbe63748ccce86e5bee4d4ad395f75c40da4

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/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,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "tone"
-  spec.version = "0.1.0"
+  spec.version = "0.2.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/tone"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tone
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.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-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinements
@@ -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,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: A customizable ANSI text colorizer for your terminal.