tone 0.0.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d3017ae0f1faf02c19825100422d443e068b901b29e6568c0b07d912452970f
-  data.tar.gz: 4d86df41de0b4f81cfac5924e065f7f17fa5e73e484e86c7071fcc5218fcb906
+  metadata.gz: 9545daf90651afc61d7c2746db9b12e99cdebf768f1930d5d7933b01573dc301
+  data.tar.gz: 124e32e3aa2201636dc3a6a269c10145dfa5e8c41b7c0b6597ef8254cf631082
 SHA512:
-  metadata.gz: b5701133e078fa303fdeb3fa3be36a2b7e0059fe0f0b42f7dae2a5320ed6744dc51021ea19d0d2ec107ed15e312a0c1a8c0e0a8eef295f84afa600941e1a972d
-  data.tar.gz: 2f18052fcd993427dd8e0accf3df23ca0cfbfdb59b38c29f72930864025bb01c2837c9c7401312d69759a32235c536f5ccfaa4eaeea574a37b9245e6fa669582
+  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
 
@@ -18,31 +19,45 @@ toc::[]
 * Provides aliasing of color configurations.
 * Provides quick access to default and aliased styles.
 
+== Screenshots
+
+image::https://alchemists.io/images/projects/tone/screenshot.png[A screenshot of colors,width=200,height=900,role=focal_point]
+
 == Requirements
 
 . link:https://www.ruby-lang.org[Ruby].
 
 == Setup
 
-To install, run:
+To install _with_ security, run:
 
-[source,ruby]
+[source,bash]
+----
+# 💡 Skip this line if you already have the public certificate installed.
+gem cert --add <(curl --compressed --location https://alchemists.io/gems.pem)
+gem install tone --trust-policy HighSecurity
+----
+
+To install _without_ security, run:
+
+[source,bash]
 ----
 gem install tone
 ----
 
-You can also add the gem directly to your project (preferred):
+You can also add the gem directly to your project:
 
-[source,ruby]
+[source,bash]
 ----
 bundle add tone
 ----
 
 Once the gem is installed, you only need to require it:
 
-```
+[source,ruby]
+----
 require "tone"
-```
+----
 
 == Usage
 
@@ -369,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.
@@ -412,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 can be run to display all default styles for quick visual convenience:
+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

@@ -46,10 +46,7 @@ module Tone
     end
 
     def check_duplicate key
-      kind = key.inspect
-
-      fail Error, "Duplicate alias detected (already exists): #{kind}." if custom.key? key
-      fail Error, "Alias mustn't duplicate (override) default: #{kind}." if defaults.key? key
+      fail Error, "Alias mustn't duplicate (override) default: #{key.inspect}." if defaults.key? key
     end
 
     def check_style key, style

data/lib/tone/client.rb

@@ -34,6 +34,8 @@ module Tone
 
     def find_symbols(*codes) = defaults.invert.values_at(*codes)
 
+    def inspect = %(#<#{self.class} @encoder=#{encoder} @decoder=#{decoder} @aliaser=#{aliaser})
+
     private
 
     attr_reader :aliaser, :encoder, :decoder

data/lib/tone/configuration/loader.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
+require "pathname"
 require "yaml"
 
 module Tone
   module Configuration
     # Loads the default configuration into memory as a frozen hash.
     class Loader
-      def initialize path: Pathname("#{__dir__}/defaults.yml")
+      def initialize path = Pathname("#{__dir__}/defaults.yml")
         @path = path
       end
 
-      def call = YAML.safe_load(path.read, symbolize_names: true).freeze
+      def call = YAML.safe_load_file path, symbolize_names: true, freeze: true
 
       private
 

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.0.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.0.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-01 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.