key_value_coding 0.1.0

checksums.yaml

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-02-02
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Pierre de La Morinerie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,175 @@
+# KeyValueCoding
+
+This gem is a port of Cocoa's Key-Value Coding to Ruby.
+
+[Key-Value Coding](https://developer.apple.com/library/archive/documentation/General/Conceptual/DevPedia-CocoaCore/KeyValueCoding.html) is a paradigm introduced in Cocoa, that allows to:
+- query an object property using a string (like `public_send`),
+- traverse an object hierarchy using a key path (like `dig`).
+
+## Why?
+
+In Ruby, traversing an PORO hierarchy is easy:
+```ruby
+company.managers.first.name
+```
+
+Traversing a JSON-like hierarchy of arrays and hashes is also easy:
+```ruby
+data.dig(:company, :managers, 1, :name)
+```
+
+But only Array, Hashes and Struct implement `dig` – not all POROs. As a result:
+- operating on mixed hierarchies of POROs and hashes is painful,
+- operating on multiple collections items is painful.
+
+Key-Value Coding solves this with a common interface for POROs and hashes.
+
+### Common interface for POROs and hashes
+
+```ruby
+record.company                  # Specific to objects
+data[:company]                  # Specific to hashes
+object.value_for_key(:company)  # Works with both!
+```
+
+### Traversing a mixed hierarchy of PORO and hashes
+
+```ruby
+company.address[:street]             # Meh
+data.dig(:company, :address).street  # Ugh
+data.value_for_key_path("company.address.street") # 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!
+```
+
+### 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!
+```
+
+## 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
+```
+
+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
+```
+
+## Usage
+
+### `Object#value_for_key`
+
+```ruby
+manager.value_for_key(:name) # "Don Draper"
+```
+
+Get an object value (like `public_send`, but also operate on hashes and instance variables).
+
+- For objects, the value returned by invoking the corresponding method is returned, or the corresponding instance variable if any.
+   ```ruby
+   manager.value_for_key(:name) # "Don Draper"
+   ```
+- For hashes, the value for the corresponding hash key is returned.
+    ```ruby
+    { name: "Don Draper" }.value_for_key(:name) # "Don Draper"
+    ```
+- For arrays, the collection of key values for all items is returned (like ActiveSupport's `pick` method).
+   ```ruby
+   managers = [ { name: "Don Draper" }, { name: "Peggy Olson" }]
+   managers.value_for_key(:name) # [ "Don Draper", "Peggy Olson" ]
+   ```
+
+If the key doesn't exist, `value_for_undefined_key` is called (which usually results in a `KeyValueCoding::UndefinedKey` exception).
+
+### `Object#values_for_keys`
+
+```ruby
+manager.value_for_keys(:name, :birth_date) # { name: "Don Draper", birth_date: "01/06/1926" }
+```
+
+Get several values of an object (like `pluck` or `slice`, but works on objects as well as hashes).
+
+For each key, `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).
+
+### `Object#value_for_key_path`
+
+```ruby
+manager.value_for_key_path("name.length") # 10
+```
+
+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.
+
+If one of the keys doesn't exist, `value_for_undefined_key` is called (which usually results in a `KeyValueCoding::UndefinedKey` exception).
+
+### `Object#set_value(value, for_key:)`
+
+```ruby
+manager.set_value("Richard Whitman", for_key: :name)
+```
+
+Set the value of a key (like object assignement, but also work on hashes).
+
+If the key doesn't exist, `value_for_undefined_key` is called (which usually results in a `KeyValueCoding::UndefinedKey` exception).
+
+### `Object#set_value(value, for_key_path:)`
+
+```ruby
+record.set_value("Richard Whitman", for_key_path: "manager.name")
+```
+
+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.
+
+If one of the keys doesn't exist, `value_for_undefined_key` is called (which usually results in a `KeyValueCoding::UndefinedKey` exception).
+
+### `Object#value_for_undefined_key(key)`
+
+This method is called when a key (or a component in a key path) cannot be found in the target.
+
+The default implementation raises an `KeyValueCoding::UndefinedKey` exception. However this method can
+be subclassed to return a default value instead.
+
+## Future work
+
+- Allow all objects that respond to dig to return their values
+- Use refinements
+- Implement a more ruby-like method (drill? punch? pierce? scoop? shovel? grub? grab?)
+  grab(:companies, :employees, :name)
+
+## Development
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kemenaran/key_value_coding. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/kemenaran/key_value_coding/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the KeyValueCoding project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/key_value_coding/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/key_value_coding/array.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Array
+  def value_for_key(key)
+    map { it.value_for_key(key) }
+  end
+end

data/lib/key_value_coding/hash.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "debug"
+
+class Hash
+  # Allow both symbol and strings, for ease of use
+  def value_for_key(key)
+    if has_key?(key)
+      send("[]", key)
+    elsif has_key?(key.to_sym)
+      send("[]", key.to_sym)
+    else
+      value_for_undefined_key(key)
+    end
+  end
+end

data/lib/key_value_coding/object.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+class Object
+  def self.access_instance_variables_directly? = true
+
+  def value_for_key(key)
+    if respond_to?(key)
+      public_send(key)
+    elsif self.class.access_instance_variables_directly? && instance_variables.include?(:"@#{key}")
+      instance_variable_get(:"@#{key}")
+    else
+      value_for_undefined_key(key)
+    end
+  end
+
+  def values_for_keys(keys)
+    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) }
+  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)
+    else
+      raise ArgumentError("Either `for_key` or `for_key_path` must be provided")
+    end
+  end
+
+  def set_value_for_key(value, key)
+    if respond_to?(:"#{key}=")
+      public_send(:"#{key}=", value)
+    elsif self.class.access_instance_variables_directly? && instance_variables.include?(:"@#{key}")
+      instance_variable_set(:"@#{key}", value)
+    else
+      set_value_for_undefined_key(value, key)
+    end
+  end
+
+  def set_value_for_key_path(value, key_path)
+    *path, key = key_path.split(".")
+    target = value_for_key_path(path.join('.'))
+    target.set_value(value, for_key: key)
+  end
+
+  def value_for_undefined_key(key)
+    raise KeyValueCoding::UndefinedKey.new("Undefined key '#{key}' for object #{self}")
+  end
+
+  def set_value_for_undefined_key(value, key)
+    raise KeyValueCoding::UndefinedKey.new("Undefined key '#{key}' for object #{self}")
+  end
+end

data/lib/key_value_coding/version.rb

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

data/lib/key_value_coding.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "key_value_coding/version"
+require_relative "key_value_coding/object"
+require_relative "key_value_coding/array"
+require_relative "key_value_coding/hash"
+
+module KeyValueCoding
+  class UndefinedKey < StandardError; end
+end

data/sig/key_value_coding.rbs

@@ -0,0 +1,4 @@
+module KeyValueCoding
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: key_value_coding
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pierre de La Morinerie
+bindir: exe
+cert_chain: []
+date: 2026-02-02 00:00:00.000000000 Z
+dependencies: []
+description: This gem exposes `value_for_key` and `set_value(:for_key)` methods, which
+  allows traversing a mixed hiearchy of objects, hashes and arrays using a common
+  interface.
+email:
+- kemenaran@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- lib/key_value_coding.rb
+- lib/key_value_coding/array.rb
+- lib/key_value_coding/hash.rb
+- lib/key_value_coding/object.rb
+- lib/key_value_coding/version.rb
+- sig/key_value_coding.rbs
+homepage: https://gitlab.com/pmorinerie/key_value_coding
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/pmorinerie/key_value_coding
+  source_code_uri: https://gitlab.com/pmorinerie/key_value_coding
+  changelog_uri: https://gitlab.com/pmorinerie/key_value_coding/-/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Port of Cocoa's Key-Value Coding to Ruby
+test_files: []