everythingrb 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d4d1ff4ff501fb2c458bf0d23207db00f048f87337651a9acbb32fac3130892
-  data.tar.gz: fef2dcb4bca0bbb191173456278766deb3718105fd74fbda82c14e95ca05381a
+  metadata.gz: 1dd9fbbf9f007e0996405d8689b8a288bc68968d0df0cf291a7a8a80a04c73b2
+  data.tar.gz: fa4d6d91ccfa3af739bc3726d406adec90215c639326741c18071d51dffae1aa
 SHA512:
-  metadata.gz: 3b010d9ad8a8816cee802e130d8559bfd52bd2928973fb5af78d85700837ccc5fbdc0652f546450c5b8f466d92ee694edef3f66b8337176c2e05070f5ddd9e22
-  data.tar.gz: 74038bc5467bb76fc296015f631fce28c4a5a533f8630794d1fc68f0215b8a29bcc9f7d1d4329d2140b9811dfe4db2f8bc6312bbbf272432051dd4a52cd9330c
+  metadata.gz: 2cf84c56c48419113d3736d5702ba9cfc918cbf5e1ff49277f024505ec190f60d5db5b727520ae7e16d39498173b1c8b7c39df9243ba65474632c1604db3dd3b
+  data.tar.gz: 316b7b50250d7538d9ae6635ae7df4f95a4e774ae652f6a4c4b6ec5e7405f9f5c06e8917ee63e20f421c2c73556d3f5baa8555746f73c6531ba9036ce79a53ea

data/CHANGELOG.md

@@ -15,6 +15,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 -->
 
+## [1.1.0] - 12026-07-19
+
+### Added
+
+- **Added `Datum`** - an immutable, dot-notation value object built in a single call (e.g. `Datum.new(host: "localhost", port: 3000)`). Think of it as the sealed counterpart to OpenStruct: OpenStruct's ergonomics with Data's immutability. Values are stored as-is, so it's immutable at the top level only. Unlike a bare `Data.define(...)`, Datums compare by attributes, so two Datums with the same members and values are equal and hash alike.
+- **Added `Hash#to_datum` and `String#to_datum`** - convert into a `Datum`, recursing through nested hashes and arrays. These replace the deprecated `#to_istruct`.
+
+### Deprecated
+
+- **Deprecated `Hash#to_istruct` and `String#to_istruct`** - use `#to_datum` instead. Both still work but now emit a deprecation warning, and will be removed in v2.0.0.
+
 ## [1.0.2] - 12026-05-30
 
 ### Changed

data/lib/everythingrb/all.rb

@@ -3,6 +3,7 @@
 require_relative "array"
 require_relative "boolean"
 require_relative "data"
+require_relative "datum"
 require_relative "date"
 require_relative "enumerable"
 require_relative "hash"

data/lib/everythingrb/datum.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+#
+# An immutable, dot-notation object built from attributes in a single call
+#
+# Think of it as the sealed counterpart to OpenStruct: the ergonomics of OpenStruct.new(hash) with the
+# immutability of Data. Values are stored as-is (nested hashes and arrays are left untouched), so the object is
+# immutable only at the top level. Use Hash#to_datum when you want the conversion to recurse.
+#
+# @example Build an object inline
+#   config = Datum.new(host: "localhost", port: 3000)
+#   config.host # => "localhost"
+#
+# @example Nested data is left as-is
+#   data = Datum.new(name: "Bob", meta: {role: "admin"})
+#   data.meta # => {role: "admin"} (still a Hash)
+#
+# @example Structural equality
+#   Datum.new(a: 1) == Datum.new(a: 1) # => true
+#
+class Datum < Data
+  #
+  # Builds an immutable object from the given attributes
+  #
+  # @param attributes [Hash] The members and their values for the new object
+  #
+  # @return [Datum] An object whose members match the given keys
+  #
+  # @example
+  #   Datum.new(host: "localhost", port: 3000)
+  #
+  def self.new(attributes = {})
+    define(*attributes.keys.map(&:to_sym)).new(*attributes.values)
+  end
+
+  #
+  # Compares against another Datum by attributes rather than by class
+  #
+  # Every Datum is backed by its own anonymous Data class, so the default
+  # comparison (which requires an identical class) would never match. This
+  # compares the underlying attributes instead.
+  #
+  # @param other [Object] The object to compare against
+  #
+  # @return [Boolean] True when other is a Datum with equal attributes
+  #
+  def ==(other)
+    other.is_a?(Datum) && to_h == other.to_h
+  end
+
+  alias_method :eql?, :==
+
+  #
+  # Returns a hash code derived from the attributes
+  #
+  # Keeps #hash consistent with #eql? so equal Datums collapse to the same
+  # Hash key or Set member.
+  #
+  # @return [Integer]
+  #
+  def hash
+    to_h.hash
+  end
+end

data/lib/everythingrb/hash.rb

@@ -4,7 +4,7 @@
 # Extensions to Ruby's core Hash class
 #
 # Provides:
-# - #to_struct, #to_ostruct, #to_istruct: Convert hashes to different structures
+# - #to_struct, #to_ostruct, #to_datum: Convert hashes to different structures (#to_istruct is deprecated, use #to_datum)
 # - #join_map: Combine filter_map and join operations
 # - #transform_values.with_key: Transform values with access to keys
 # - #transform, #transform!: Transform keys and values
@@ -74,29 +74,53 @@ class Hash
   end
 
   #
-  # Converts hash to an immutable Data structure
+  # Recursively converts hash to an immutable Datum
   #
-  # @return [Data] An immutable Data object with the same structure
+  # Nested hashes and arrays are converted too. Unlike a raw Data object, two
+  # Datums with the same attributes are equal, so the result is safe to compare
+  # or use as a Hash key.
+  #
+  # @return [Datum] An immutable object mirroring the hash structure
   #
   # @example
   #   hash = { person: { name: "Bob", age: 30 } }
-  #   data = hash.to_istruct
+  #   data = hash.to_datum
   #   data.person.name # => "Bob"
-  #   data.class # => Data
   #
-  def to_istruct
-    recurse = lambda do |input|
-      case input
+  def to_datum
+    recurse = lambda do |value|
+      case value
       when Hash
-        input.to_istruct
+        value.to_datum
       when Array
-        input.map(&recurse)
+        value.map(&recurse)
       else
-        input
+        value
       end
     end
 
-    Data.define(*keys.map(&:to_sym)).new(*values.map { |value| recurse.call(value) })
+    Datum.new(transform_values { |value| recurse.call(value) })
+  end
+
+  #
+  # Recursively converts hash to an immutable Data structure
+  #
+  # @deprecated Use {#to_datum} instead. Will be removed in v2.0.0.
+  #
+  # @return [Datum] An immutable object mirroring the hash structure
+  #
+  # @example
+  #   hash = { person: { name: "Bob", age: 30 } }
+  #   data = hash.to_istruct
+  #   data.person.name # => "Bob"
+  #
+  def to_istruct
+    Everythingrb.deprecator.warn(
+      "Hash#to_istruct is deprecated and will be removed in v2.0.0. " \
+      "Use Hash#to_datum instead."
+    )
+
+    to_datum
   end
 
   #

data/lib/everythingrb/string.rb

@@ -5,7 +5,7 @@
 #
 # Provides:
 # - #parse_json: Parse JSON strings with error handling
-# - #to_ostruct, #to_istruct, #to_struct: Convert JSON to data structures
+# - #to_ostruct, #to_datum, #to_struct: Convert JSON to data structures (#to_istruct is deprecated, use #to_datum)
 # - #with_quotes, #in_quotes: Wrap strings in quotes
 # - #to_camelcase: Convert strings to camelCase or PascalCase
 #
@@ -52,18 +52,39 @@ class String
     nil
   end
 
+  #
+  # Attempts to parse JSON and convert to an immutable Datum.
+  # Returns nil if string does not contain valid JSON
+  #
+  # @return [Datum, nil] Immutable object or nil if invalid JSON
+  #
+  # @example
+  #   '{"name": "Alice"}'.to_datum      # => #<data name="Alice">
+  #   "not json".to_datum               # => nil
+  #
+  def to_datum
+    parse_json&.to_datum
+  end
+
   #
   # Attempts to parse JSON and convert to Data struct.
   # Returns nil if string does not contain valid JSON
   #
-  # @return [Data, nil] Immutable Data structure or nil if invalid JSON
+  # @deprecated Use {#to_datum} instead. Will be removed in v2.0.0.
+  #
+  # @return [Datum, nil] Immutable object or nil if invalid JSON
   #
   # @example
   #   '{"name": "Alice"}'.to_istruct      # => #<data name="Alice">
   #   "not json".to_istruct               # => nil
   #
   def to_istruct
-    parse_json&.to_istruct
+    Everythingrb.deprecator.warn(
+      "String#to_istruct is deprecated and will be removed in v2.0.0. " \
+      "Use String#to_datum instead."
+    )
+
+    parse_json&.to_datum
   end
 
   #

data/lib/everythingrb/version.rb

@@ -7,5 +7,5 @@
 #
 module Everythingrb
   # Current version of the everythingrb gem
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everythingrb
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Bryan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-30 00:00:00.000000000 Z
+date: 2026-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ostruct
@@ -72,6 +72,7 @@ files:
 - lib/everythingrb/boolean.rb
 - lib/everythingrb/data.rb
 - lib/everythingrb/date.rb
+- lib/everythingrb/datum.rb
 - lib/everythingrb/enumerable.rb
 - lib/everythingrb/extensions.rb
 - lib/everythingrb/extensions/quotable.rb