otoindiff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3ca434647f9c7853413d2a3cd0fd2965b763bfd50c404f583af67a98651b47b
+  data.tar.gz: 9a3bde8b5cbe13efc52f585b77e5bad3a57ab1dc13eae88700a162238c5c986f
+SHA512:
+  metadata.gz: a2bae63aaa05d12a3bac9e30df8e91f98e3e871fa0d445ccb6804c8f94b5c3c4453eacfbccac675983ac29d71ef4e0a71878eb2a543e105c45e00a5d7f6c1f63
+  data.tar.gz: 983e9a7ccefdff0be3b9ff135a13c1a6df970c0ce1c00c5ea31e4b5a35cda5597e77aad7395ea145b5946ffe571ffcb5c097669eeb2c7e1010874efe10dd7021

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-12
+
+- Initial release

data/README.md

@@ -0,0 +1,17 @@
+# Otoindiff
+
+`otoindiff` is a Ruby gem that globally enhances the behavior of Ruby's `Hash` class to support **indifferent access** by default. With `otoindiff`, you can access hash keys using either symbols or strings interchangeably without any extra steps like calling `with_indifferent_access`.
+
+## Features
+
+- Seamlessly access hash keys as symbols or strings.
+- Works with nested hashes and supports methods like `dig` and `fetch`.
+- No need to manually call `with_indifferent_access` on hashes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'otoindiff'
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+task default: :test

data/benchmarks/oto_benchmarks.rb

@@ -0,0 +1,23 @@
+require_relative '../lib/otoindiff'
+require 'benchmark'
+
+sample_hash = {
+  foo: 'bar',
+  'baz' => 'qux',
+  'nested' => { 'level1' => { 'level2' => 'value' } }
+}
+
+Benchmark.bm do |x|
+  x.report('[] method (symbol key):') { 100_000.times { sample_hash[:foo] } }
+  x.report('[] method (string key):') { 100_000.times { sample_hash['foo'] } }
+end
+
+Benchmark.bm do |x|
+  x.report('dig method (nested):') { 100_000.times { sample_hash.dig('nested', 'level1', 'level2') } }
+  x.report('dig method (non-nested):') { 100_000.times { sample_hash.dig(:foo) } }
+end
+
+Benchmark.bm do |x|
+  x.report('fetch method (symbol key):') { 100_000.times { sample_hash.fetch(:foo) } }
+  x.report('fetch method (string key):') { 100_000.times { sample_hash.fetch('foo') } }
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'otoindiff'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/release

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+desc 'Run tests and release the gem'
+task release: [:test] do
+  system('gem build otoindiff.gemspec')
+
+  version = `grep -m1 'version =' otoindiff.gemspec`.split("'")[1]
+
+  if system("gem push otoindiff-#{version}.gem")
+    puts "Successfully released otoindiff version #{version}"
+    system("rm otoindiff-#{version}.gem")
+  else
+    puts 'Failed to push gem'
+    exit 1
+  end
+end
+
+task default: :release

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/otoindiff/version.rb

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

data/lib/otoindiff.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative 'otoindiff/version'
+
+require 'active_support'
+require 'active_support/core_ext/hash/indifferent_access'
+
+# Extends Ruby's Hash class with more flexible key access methods
+#
+# This extension provides enhanced hash key lookup capabilities:
+# - Allows interchangeable use of string and symbol keys
+# - Provides more forgiving key access methods
+# - Maintains original Hash behavior while adding convenience
+#
+# @example Flexible key access
+#   hash = { foo: 'bar', 'baz' => 'qux' }
+#   hash[:foo]    # => 'bar'
+#   hash['foo']   # => 'bar'
+#   hash.dig('baz', :key)  # Nested key access with mixed key types
+#
+# @note This extension is designed to be non-intrusive and backwards compatible
+class Hash
+  alias original_brackets []
+  alias original_dig dig
+  alias original_fetch fetch
+
+  # Retrieve a hash value with flexible key type conversion
+  #
+  # @param key [Object] The key to retrieve
+  # @return [Object, nil] The value associated with the key, or nil if not found
+  def [](key)
+    return original_brackets(key) if key?(key)
+
+    if key.is_a?(String) || key.is_a?(Symbol)
+      original_brackets(key.to_s) || original_brackets(key.to_sym)
+    else
+      original_brackets(key)
+    end
+  end
+
+  # Dig into a nested hash with flexible key type conversion
+  #
+  # @param keys [Array<Object>] Path of keys to traverse
+  # @return [Object, nil] The nested value, or nil if path is invalid
+  def dig(*keys)
+    keys.reduce(self) do |current, key|
+      break nil unless current.is_a?(Hash)
+
+      if key.is_a?(String) || key.is_a?(Symbol)
+        current.original_brackets(key) ||
+          current.original_brackets(key.to_s) ||
+          current.original_brackets(key.to_sym)
+      else
+        current.original_brackets(key)
+      end
+    end
+  end
+
+  # Fetch a hash value with flexible key type conversion and error handling
+  #
+  # @param key [Object] The key to retrieve
+  # @param args [Array] Optional default value or block
+  # @return [Object] The value associated with the key
+  # @raise [KeyError] If key is not found and no default is provided
+  def fetch(key, *args, &block)
+    return original_fetch(key, *args, &block) if key?(key)
+
+    if key.is_a?(String) || key.is_a?(Symbol)
+      begin
+        original_fetch(key.to_s, *args, &block)
+      rescue KeyError
+        original_fetch(key.to_sym, *args, &block)
+      end
+    else
+      original_fetch(key, *args, &block)
+    end
+  end
+end

data/sig/otoindiff.rbs

@@ -0,0 +1,31 @@
+module Otoindiff
+  VERSION: String
+
+  # Extended methods for Hash class with flexible key access
+  module HashExtensions
+    # Retrieve a value with flexible key type conversion
+    #
+    # @param key [String | Symbol | Object] The key to retrieve
+    # @return [Object?] The value associated with the key, or nil if not found
+    def [](key: String | Symbol | Object): Object?
+
+    # Dig into a nested hash with flexible key type conversion
+    #
+    # @param keys [Array<String | Symbol | Object>] Path of keys to traverse
+    # @return [Object?] The nested value, or nil if path is invalid
+    def dig(*keys: String | Symbol | Object): Object?
+
+    # Fetch a hash value with flexible key type conversion
+    #
+    # @param key [String | Symbol | Object] The key to retrieve
+    # @param default [Object?] Optional default value
+    # @param block [Proc?] Optional block for default value computation
+    # @return [Object] The value associated with the key
+    # @raise [KeyError] If key is not found and no default is provided
+    def fetch(
+      key: String | Symbol | Object, 
+      default: Object?, 
+      &block: -> Object?
+    ): Object
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: otoindiff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- bugloper
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description: The otoindiff gem modifies all Ruby Hash objects to support indifferent
+  access by default, allowing seamless use of string or symbol keys interchangeably.
+email:
+- bugloper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- Rakefile
+- benchmarks/oto_benchmarks.rb
+- bin/console
+- bin/release
+- bin/setup
+- lib/otoindiff.rb
+- lib/otoindiff/version.rb
+- sig/otoindiff.rbs
+homepage: https://github.com/bugloper/otoindiff
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/bugloper/otoindiff
+  source_code_uri: https://github.com/bugloper/otoindiff
+  changelog_uri: https://github.com/bugloper/otoindiff/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'false'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Enhances Ruby hashes with default indifferent access.
+test_files: []