contours 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4045b6e13180f9b89bda47ed3c389c467e804368f4d9bd48acd2b1a5ef0c0255
-  data.tar.gz: 8ceb930137c7479306379051a523c7baa49f9a7466e57d97e060f70f8b5b869d
+  metadata.gz: e5586515f8a3343dd3facd5738d1bff58a0643b0e630e633d67c374ae077c00c
+  data.tar.gz: d168143703695cddf4fe429502a296dabf85702fd013bc42920bc8270ca365d0
 SHA512:
-  metadata.gz: 4012d37792abdf2073efb3fffa0773424b8680721fabffd0552b6f3630774ca41041f5240bb27e2acff38b45bbee3c464a4ad821448efb9715aac7cdf1b7fdee
-  data.tar.gz: c214234c537c604499cc781e8e9e17d9a9504c191d19417a3142b2319aa7ffe2da9ea38245f867a061d2dc4b1e2bd6360997e081bee863b98f08a60c35157c29
+  metadata.gz: e1652a33ebb6e2ec2efbc5b8aa494b60369a181b15970eea362ad264b7812a062830400154a0f8dfc6d78713079672022251ff9660a16f9b87e06953eb581679
+  data.tar.gz: 6088095e1dd8b5c89e9f3cbc456709a553c6260d6d4016e69eda213ec190392a42f35230eccceb4893c50b02d000e743a471eb1842714a161c61e42572f0a4f2

data/README.md

@@ -44,7 +44,7 @@ You can specify a custom way to blend the values for the `@blended_keys`
 class Configuration < Contours::BlendedHash
   @blended_keys = %i[class data]
 
-  blend(:class, with: StructuredString)
+  blend(:class, with: Contours::StructuredString)
 
   blend :data do |existing, new_value|
     existing.sum(new_value.sum)
@@ -60,7 +60,16 @@ config.to_h # => {class: "test overwrite", data: 21}
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+This project is managed with [Reissue](https://github.com/SOFware/reissue).
+
+To release a new version, make your changes and be sure to update the CHANGELOG.md.
+
+To release a new version:
+
+1. `bundle exec rake build:checksum`
+2. `bundle exec rake release`
 
 ## Contributing
 

data/Rakefile

@@ -11,3 +11,10 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task default: :test
+
+require "reissue/gem"
+
+Reissue::Task.create do |t|
+  t.version_file = "lib/contours/version.rb"
+  t.version_limit = 3
+end

data/lib/contours/blended_hash.rb

@@ -27,8 +27,6 @@ module Contours
   #
   # See the source of this #{name} class for more details.
   class BlendedHash < DelegateClass(Hash)
-    alias_method :to_hash, :__getobj__
-
     # Ensure that the initial hash is a BlendedHash
     def self.init(initial_hash)
       if initial_hash.is_a?(BlendedHash)
@@ -44,11 +42,34 @@ module Contours
     # Otherwise, the default implementation will be used where the value of the
     # with argument is expected to receive 'init' with the original value and
     # then 'merge' with the extras value.
+    #
+    # @param key [Symbol] the key that should be blended
+    # @param with [BlendedHash] the class that should be used to blend the value
+    # @param block [Proc] the implementation of the blend method
+    #
+    # @example
+    #   class CssConfig < BlendedHash
+    #     @blended_keys = %i[class]
+    #     blend :class do |original, extras|
+    #       [original, extras].flatten.compact.uniq.join(" ")
+    #     end
+    #   end
+    #
+    #   CssConfig.new({class: "foo"}).merge({class: "bar"})
+    #
+    # @example
+    #   class CssConfig < BlendedHash
+    #     @blended_keys = %i[class]
+    #     blend :class, with: CssConfig
+    #   end
+    #
+    #   CssConfig.new({class: "foo"}).merge({class: "bar"})
+    #
     def self.blend(key, with: nil, &block)
       if block
-        define_method("blend_#{key}", &block)
+        define_method(:"blend_#{key}", &block)
       else
-        define_method("blend_#{key}") do |original, extras|
+        define_method(:"blend_#{key}") do |original, extras|
           with.init(original).merge(extras)
         end
       end
@@ -57,12 +78,28 @@ module Contours
     # Recursively check for keys that are specified as blended and apply
     # the blend method to them or execute the blend_#{key} method if it exists
     # to set the new value.
+    #
+    # @param overrides [Hash] the hash to merge with
+    #
+    # @return [BlendedHash] the new hash
+    #
+    # @example
+    #   class CssConfig < BlendedHash
+    #     @blended_keys = %i[class]
+    #     blend :class do |original, extras|
+    #       [original, extras].flatten.compact.uniq.join(" ")
+    #     end
+    #   end
+    #
+    #   config = CssConfig.new({class: "foo"}).merge({class: "bar"})
+    #   config[:class] # => "foo bar"
+    #
     def merge(overrides)
       return self if overrides.nil? || overrides.empty?
       self.class.new(overrides.each_with_object(to_hash.dup) do |(key, value), hash|
         hash[key] = if blended_keys.include?(key)
-          if respond_to?("blend_#{key}")
-            send("blend_#{key}", hash[key], value)
+          if respond_to?(:"blend_#{key}")
+            send(:"blend_#{key}", hash[key], value)
           else
             blend(hash[key], value)
           end
@@ -75,26 +112,29 @@ module Contours
 
     # Ensure that the return value of these methods is a BlendedHash
     def [](...)
-      if super.is_a?(Hash)
-        self.class.init(super)
+      super_result = super
+      if super_result.is_a?(Hash)
+        self.class.init(super_result)
       else
-        super
+        super_result
       end
     end
 
     def fetch(...)
-      if super.is_a?(Hash)
-        self.class.init(super)
+      super_result = super
+      if super_result.is_a?(Hash)
+        self.class.init(super_result)
       else
-        super
+        super_result
       end
     end
 
     def dig(...)
-      if super.is_a?(Hash)
-        self.class.init(super)
+      super_result = super
+      if super_result.is_a?(Hash)
+        self.class.init(super_result)
       else
-        super
+        super_result
       end
     end
 
@@ -110,7 +150,6 @@ module Contours
     # with a custom blend_#{key} method to customize the blending behavior for a
     # specific key.
     #
-
     def blend(original, extra)
       case original
       when BlendedHash, Hash
@@ -121,5 +160,24 @@ module Contours
         extra
       end
     end
+
+    def to_hash
+      deep_stringify_structured_strings(__getobj__)
+    end
+
+    private
+
+    def deep_stringify_structured_strings(obj)
+      case obj
+      when Hash
+        obj.transform_values { |v| deep_stringify_structured_strings(v) }
+      when Array
+        obj.map { |v| deep_stringify_structured_strings(v) }
+      when StructuredString
+        obj.to_s
+      else
+        obj
+      end
+    end
   end
 end

data/lib/contours/structured_string.rb

@@ -28,6 +28,16 @@ module Contours
 
     # Initialize with base string that is used to build the StructuredString
     # Other values will be added to the string in the order they are added.
+    #
+    # @param base [String] the initial string
+    # @param separator [String] the separator used to join the parts of the string
+    #
+    # @example
+    #   config = StructuredString.new("input")
+    #   config << "my-special-class"
+    #   config << "input-error"
+    #   config.to_s #=> "input my-special-class input-error"
+    #
     def initialize(base = "", separator: " ")
       @base = [base]
       @separator = separator
@@ -37,6 +47,14 @@ module Contours
     end
 
     # Add a value to the beginning of the string
+    #
+    # @param value [String] the value to add
+    #
+    # @example
+    #   config = StructuredString.new("input")
+    #   config.first("my-special-class")
+    #   config.to_s #=> "my-special-class input"
+    #
     def first(value)
       @first << value.to_s
       __setobj__ to_s
@@ -44,6 +62,14 @@ module Contours
     end
 
     # Add a value to the end of the string
+    #
+    # @param value [String] the value to add
+    #
+    # @example
+    #   config = StructuredString.new("input")
+    #   config.last("input-error")
+    #   config.to_s #=> "input input-error"
+    #
     def last(value)
       @last << value.to_s
       __setobj__ to_s
@@ -51,6 +77,14 @@ module Contours
     end
 
     # Add a value to the middle of the string
+    #
+    # @param value [String] the value to add
+    #
+    # @example
+    #   config = StructuredString.new("input")
+    #   config << "my-special-class"
+    #   config.to_s #=> "input my-special-class"
+    #
     def <<(other)
       @other << other.to_s
       __setobj__ to_s
@@ -58,6 +92,21 @@ module Contours
     end
 
     # Read a particular portion of the structured string or raise an error
+    #
+    # @param key [Symbol] the portion of the string to read
+    #
+    # @return [Array] the portion of the string
+    #
+    # @example
+    #   config = StructuredString.new("input")
+    #   config << "my-special-class"
+    #   config.first("first-class")
+    #   config.last("last-class")
+    #   config.read(:base) #=> ["input"]
+    #   config.read(:first) #=> ["first-class"]
+    #   config.read(:last) #=> ["last-class"]
+    #   config.read(:other) #=> ["my-special-class"]
+    #
     def read(key)
       case key
       when :first
@@ -109,6 +158,17 @@ module Contours
     end
 
     # Return the string representation of the StructuredString
+    #
+    # @return [String] the string
+    #
+    # @example
+    #   config = StructuredString.new("input")
+    #   config << "my-special-class"
+    #   config.last("last-class")
+    #   config.first("first-class")
+    #   config << "input-error"
+    #   config.to_s #=> "first-class input my-special-class input-error last-class"
+    #
     def to_s
       [@first, @base, @other, @last]
         .flatten
@@ -120,6 +180,14 @@ module Contours
     alias_method :to_str, :to_s
     alias_method :inspect, :to_s
 
+    def as_json(*)
+      to_s
+    end
+
+    def to_json(*)
+      to_s.to_json
+    end
+
     def ==(other)
       to_s == other.to_s
     end

data/lib/contours/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Contours
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: contours
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jim Gay
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-10 00:00:00.000000000 Z
+date: 2025-06-22 00:00:00.000000000 Z
 dependencies: []
 description: |
   Provides objects with which you can define a configuration object
@@ -32,7 +31,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/SOFware/contours
   source_code_uri: https://github.com/SOFware/contours.git
-post_install_message:
+  changelog_uri: https://github.com/SOFware/contours/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -47,8 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Support for building customizable configuration objects.
 test_files: []