key_value_coding 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d930f48bc39ac156387930313364ad48abd30dc75720025cf6b13f6d57c1f1b
-  data.tar.gz: 2e9327e5880a0725081d2a7ca1566c1d0ced487d7664d31e889c7361506e503e
+  metadata.gz: 24584f6b8d22bd6093300ce6b4d69ee97265d21127c4bc939e696979cb951d4f
+  data.tar.gz: 0bfdff95bc24f469ea8805d87cd147ce1f6c9a6f0761630cd077daf655bab786
 SHA512:
-  metadata.gz: 1acec129c687cde176832bd4800526200f271a6d939128e0c28b4ad5050bcde81fa813b7e496f57f28f76d367b0958df87b7ef1c65658a8027734fa6a346ef54
-  data.tar.gz: 67a7dd6162051bce818add934625e74149b7fc99c2be70fc0fdac0a5b2073a18597939ab7d55102a9b294a69da899d79260d15d715b7a2408e18548e5ab1ef8e
+  metadata.gz: c5fa4a4c31d0fe521a08baca2abd5ad188e5112b4db3980e6ad3d078bc1797c5e639d7fe0d57804d9017ba9f787e74349de0a4d7aae5f065f718ccf503b405b5
+  data.tar.gz: a3272ffe2dea7c57108c78002bcf84bc3cb06114dc6e2f69b19f7c6332f0ca627d76a492b436057f1dd6bd7d794b1cac55fd53890e47074079f9a638d84f2f94

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-## [Unreleased]
+## [0.2.0] - 2026-02-02
+
+- Support symbols as key paths
 
 ## [0.1.0] - 2026-02-02
 

data/README.md

@@ -37,37 +37,35 @@ object.value_for_key(:company)  # Works with both!
 ```ruby
 company.address[:street]             # Meh
 data.dig(:company, :address).street  # Ugh
-data.value_for_key_path("company.address.street") # Nice!
+data.value_for_key_path(:company, :address :street) # Also nice!
 ```
 
 ### Operating on multiple collection items at once
 
 ```ruby
 company.managers.map { it[:name] }.map(&:upcase) # Meh
-company.value_for_key_path("name.upcase")        # Nice!
+company.value_for_key_path(:name, :upcase)       # Nice!
 ```
 
 ### Set a value on a mixed hierarchy of PORO and hashes
 
 ```ruby
-record.company?.address?[:street] = "Ash Tree Lane 12"                       # Meh
-record.set_value("Ash Tree Lane 12" for_key_path: "company.address.street")  # Nice!
+record.company.address[:street] = "Ash Tree Lane 12"                             # Meh
+record.set_value("Ash Tree Lane 12" for_key_path: [:company, :address, :street]) # Nice!
 ```
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add key_value_coding
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install key_value_coding
 ```
 
 ## Usage
@@ -111,12 +109,13 @@ If one of the keys doesn't exist, `value_for_undefined_key` is called (which usu
 ### `Object#value_for_key_path`
 
 ```ruby
-manager.value_for_key_path("name.length") # 10
+manager.value_for_key_path(:name, :length) # 10
+manager.value_for_key_path("name.length")  # Also works with dot-separated components
 ```
 
 Get the value of a chain of keys (like object traversal, but works also on hashes).
 
-For each dot-separated component of the key-path, `value_for_key` is used to retrieve the value.
+For each symbol or dot-separated component of the key-path, `value_for_key` is used to retrieve the value.
 
 If one of the keys doesn't exist, `value_for_undefined_key` is called (which usually results in a `KeyValueCoding::UndefinedKey` exception).
 
@@ -133,12 +132,13 @@ If the key doesn't exist, `value_for_undefined_key` is called (which usually res
 ### `Object#set_value(value, for_key_path:)`
 
 ```ruby
-record.set_value("Richard Whitman", for_key_path: "manager.name")
+record.set_value("Richard Whitman", for_key_path: [:manager, :name])
+record.set_value("Richard Whitman", for_key_path: "manager.name") # Also works with dot-separated components
 ```
 
 Set the value of a key-path (like object assignement, but also work on hashes).
 
-For each dot-separated component of the key-path, `value_for_key` is invoked to retrieve the value. On the last component, `set_value(value, for_key:)` is invoked to set the value.
+For each symbol or dot-separated component of the key-path, `value_for_key` is invoked to retrieve the value. On the last component, `set_value(value, for_key:)` is invoked to set the value.
 
 If one of the keys doesn't exist, `value_for_undefined_key` is called (which usually results in a `KeyValueCoding::UndefinedKey` exception).
 

data/lib/key_value_coding/hash.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "debug"
-
 class Hash
   # Allow both symbol and strings, for ease of use
   def value_for_key(key)

data/lib/key_value_coding/object.rb

@@ -17,17 +17,15 @@ class Object
     keys.map { |k| [k, value_for_key(k)] }.to_h
   end
 
-  def value_for_key_path(key_path)
-    key_path
-      .split(".")
-      .reduce(self) { |object, key| object.value_for_key(key) }
+  def value_for_key_path(*key_path, **nil)
+    normalized_key_path(*key_path).reduce(self) { |object, key| object.value_for_key(key) }
   end
 
   def set_value(value, for_key: nil, for_key_path: nil)
     if for_key
       set_value_for_key(value, for_key)
     elsif for_key_path
-      set_value_for_key_path(value, for_key_path)
+      set_value_for_key_path(value, *for_key_path)
     else
       raise ArgumentError("Either `for_key` or `for_key_path` must be provided")
     end
@@ -43,8 +41,8 @@ class Object
     end
   end
 
-  def set_value_for_key_path(value, key_path)
-    *path, key = key_path.split(".")
+  def set_value_for_key_path(value, *key_path)
+    *path, key = normalized_key_path(*key_path)
     target = value_for_key_path(path.join('.'))
     target.set_value(value, for_key: key)
   end
@@ -56,4 +54,15 @@ class Object
   def set_value_for_undefined_key(value, key)
     raise KeyValueCoding::UndefinedKey.new("Undefined key '#{key}' for object #{self}")
   end
+
+  private
+
+  def normalized_key_path(*key_path)
+    case key_path
+    in [String] then key_path.first.split(".")
+    in [Symbol] then key_path
+    in [Symbol, *] if key_path.all? { |k| k.is_a?(Symbol)} then key_path
+    else raise KeyValueCoding::InvalidPath.new("Expected a string or an array of symbols, but got '#{key_path}'")
+    end
+  end
 end

data/lib/key_value_coding/version.rb

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

data/lib/key_value_coding.rb

@@ -7,4 +7,5 @@ require_relative "key_value_coding/hash"
 
 module KeyValueCoding
   class UndefinedKey < StandardError; end
+  class InvalidPath < StandardError; end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: key_value_coding
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pierre de La Morinerie