hash_of 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f6322a6bce710e4750c5b19e16dac50bc6825bb38d2b5bbebf16ca3b274589e
+  data.tar.gz: 304958f8ad10f093939b6d1659b0412323675a1f841c964e61fa92ca86448e1c
+SHA512:
+  metadata.gz: 65c815ac49e03d228e59d917fbfe70f79c8a47c1d6c26f1f5f91045d848f8a0a8dcec8861aca077973b8fff467a6acac3f7c83ed7d84dde3203e59cee1992d1c
+  data.tar.gz: 274bbdcfc14daa3f16a12faa0c64fd960080626219178783c00d2069f8f679f47aa0351911bb86bace66861f290d8d23bf109525c614466326fa1eafc5be95a9

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 1.0.0 (February 4, 2024)
+
+## Features:
+
+- Initial release
+- Introduces `Hash.of` to create a new hash where unrecognized keys are new objects as specified
+  - `Hash.of(:array)[:any_key] #=> []`
+  - `Hash.of(:hash)[:any_key] #=> {}`
+  - `Hash.of(:hash, recursive: true)[:any_key][:and_another][:or_more] #=> {}`

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Aaron Rosenberg
+
+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,82 @@
+# HashOf
+
+Mostly syntactic sugar to quickly and tersely create hashes of arrays or hashes, and optionally, recursive hashes.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add hash_of
+
+Alternatively add to your Gemfile via
+
+    gem "hash_of", "~> 1.0"
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install hash_of
+
+
+## Usage
+
+Adds the `Hash.of` method providing the following uses
+
+### 1. `Hash.of(:array)`
+
+Returns a new hash whose unrecognized keys will be a new array.
+
+```ruby
+hash_of_arrays = Hash.of(:array)
+hash_of_arrays[:any_key]
+# => []
+hash_of_arrays[:numbers_with_one] << 1
+# => [1]
+hash_of_arrays
+# => {:any_key=>[], :numbers_with_one=>[1]}
+```
+
+### 2. `Hash.of(:hash)`
+
+Returns a new hash whose unrecognized keys will be a new hash.
+
+```ruby
+hash_of_hashes = Hash.of(:hash)
+hash_of_hashes[:any_key]
+# => {}
+hash_of_hashes[:names_and_numbers][:one]
+# => nil
+hash_of_hashes[:names_and_numbers][:one] = 1
+# => 1
+hash_of_hashes
+# => {:any_key=>{}, :names_and_numbers=>{:one=>1}}
+```
+
+### 3. `Hash.of(:hash, recursive: true)`
+
+Returns a hash where each unrecognized key is a hash where each unrecognized key is a hash … and so on.
+
+```ruby
+recursive_hash_of_hashes = Hash.of(:hash, recursive: true)
+recursive_hash_of_hashes[:any_key]
+# => {}
+recursive_hash_of_hashes[:any_key][:and_another]
+# => {}
+recursive_hash_of_hashes[:any_key][:and_another][:one_more]
+# => {}
+recursive_hash_of_hashes[:any_key][:and_another][:one_more] = "abc"
+# => "abc"
+recursive_hash_of_hashes
+# => {:any_key=>{:and_another=>{:one_more=>"abc"}}}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests and Rubocop. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hash_of.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/hash_of/version.rb

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

data/lib/hash_of.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "hash_of/version"
+
+# Module to contain the constants, subclass, and class method Hash will extend
+module HashOf
+  OF_ARRAY_LAMBDA = ->(hash, key) { hash[key] = [] }
+  OF_HASH_LAMBDA = ->(hash, key) { hash[key] = {} }
+
+  # Produce new Hashes with their default proc set to create hashes recursively
+  class OfHash < Hash
+    def initialize = super { |hash, key| hash[key] = OfHash.new }
+  end
+
+  def of(type, recursive: false)
+    case type
+    when :array
+      Hash.new(&OF_ARRAY_LAMBDA)
+    when :hash
+      recursive ? OfHash.new : Hash.new(&OF_HASH_LAMBDA)
+    end
+  end
+end
+
+Hash.extend(HashOf)

data/sig/hash_of.rbs

@@ -0,0 +1,13 @@
+# Module to contain the constants, subclass, and class method Hash will extend
+module HashOf
+  OF_ARRAY_LAMBDA: Lambda
+  OF_HASH_LAMBDA: Lambda
+  VERSION: String
+
+  # Produce new Hashes with their default proc set to create hashes recursively
+  class OfHash < Hash
+    def initialize: () -> void
+  end
+
+  def of: (Symbol type, ?recursive: bool) -> Hash
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: hash_of
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aaron Rosenberg
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-04 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- aarongrosenberg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/hash_of.rb
+- lib/hash_of/version.rb
+- sig/hash_of.rbs
+homepage: https://github.com/agrberg/hash_of
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/agrberg/hash_of/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/agrberg/hash_of
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/agrberg/hash_of
+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.5
+signing_key:
+specification_version: 4
+summary: Syntactic sugar to create hashes of hashes or arrays and ability to make
+  them recursive.
+test_files: []