nested_hash_builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '03238f7b928506bf5341118b4436d3aad87ada5ba3c686b4779425ba8d0c46db'
+  data.tar.gz: 9dc3320dca3c8f6e2b1fe8c2f9df430ae7636110f92250db8e8e9aefdae32e48
+SHA512:
+  metadata.gz: a92b4f9fdad9763c7304caaa141e7893f984bdc6fbc754a941891e4e0c4dc1b18387c97204cca7056d492d23afabf9b2d1c6037b35aa562480dfc44e2f047c1c
+  data.tar.gz: '068689310d882ca23447531ea9a2cc919ec3de80db0546e63609a3673e0be7a23a018901d41b83d10d744b4a738e10e583ad1669a6ff97f7769359dec09eedc8'

data/.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: CI Ruby
+
+on:
+  push:
+    branches: [ 'main', 'master', 'develop' ]
+  pull_request:
+    branches: [ 'main', 'master', 'develop' ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    strategy:
+      matrix:
+        ruby-version: ['3.2', '3.3', '3.4']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run unit tests
+        run: bundle exec rake test
+
+  typecheck_and_lint:
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+      - name: Lint Ruby files
+        run: bundle exec rubocop --parallel
+      - name: Typecheck
+        run: bundle exec srb tc

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+Add changes in new features here. Do not change the gem's version in pull/merge requests.
+
+### Changes
+-
+
+## [0.1.0] - 2025-08-13
+
+[Diff](https://github.com/Verseth/ruby-nested_hash_builder/compare/v0.0.0...v0.1.0)
+
+- Initial release

data/README.md

@@ -0,0 +1,83 @@
+# NestedHashBuilder
+
+This Ruby gem allows you to easily build nested Ruby Hashes.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add nested_hash_builder
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install nested_hash_builder
+```
+
+## Usage
+
+You can use the `NestedHashBuilder::build` method to easily
+create nested hashed with arrays etc.
+
+```ruby
+require 'nested_hash_builder'
+
+hash = NestedHashBuilder.build do |h|
+  h.user do
+    h.name "John"
+    h.address do
+      h.street "123 Main St"
+      h.city "Anytown"
+      h.zip "12345"
+    end
+    h.key!("SOME:STRANGE:KEY", 2)
+    h.array!(:contacts) do |c|
+      c << h.entry! do |e|
+        e.email "john@example.com"
+        e.phone "555-1234"
+      end
+      c << h.entry! do |e|
+        e.email "foo@example.com"
+        e.phone "222-1234"
+      end
+    end
+  end
+end
+
+# The resulting hash looks like:
+# {
+#   user: {
+#     name: "John",
+#     address: {
+#       street: "123 Main St",
+#       city: "Anytown",
+#       zip: "12345"
+#     },
+#     "SOME:STRANGE:KEY": 2,
+#     contacts: [
+#       {
+#         email: "john@example.com",
+#         phone: "555-1234"
+#       },
+#       {
+#         email: "foo@example.com",
+#         phone: "222-1234"
+#       },
+#     ],
+#   }
+# }
+```
+
+
+
+## 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/Verseth/nested_hash_builder.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+::Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = ::FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test]

data/lib/nested_hash_builder/version.rb

@@ -0,0 +1,6 @@
+# typed: true
+# frozen_string_literal: true
+
+module NestedHashBuilder
+  VERSION = '0.1.0'
+end

data/lib/nested_hash_builder.rb

@@ -0,0 +1,177 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require_relative 'nested_hash_builder/version'
+
+# A module that provides a simple DSL
+# for defining complex, nested Hashes.
+#
+#     hash = NestedHashBuilder.call do |h|
+#       h.price 10
+#       h.client do
+#         h.first_name 'Patrick'
+#         h.last_name = 'Stewart' # setter syntax is optional
+#         h.full_name = "#{h.local_dig!(:first_name)} #{h.local_dig!(:last_name)}"
+#       end
+#       h.inexistent = :i_wont_be_there if h.dig!(:price) == 15
+#     end
+#
+#     p hash
+#     #=> {:price=>10, :client=>{:first_name=>"Patrick", :last_name=>"Stewart", :full_name=>"Patrick Stewart"}}
+#
+module NestedHashBuilder
+  class << self
+    #: (?base: Hash[untyped, untyped], ?symbolize: bool) { (Proxy) -> void } -> Hash[untyped, untyped]
+    def call(base: {}, symbolize: true, &block)
+      block.call(proxy = Proxy.new(base: base, symbolize: symbolize))
+      proxy.to_h
+    end
+
+    alias build call
+  end
+
+  # Object that is the receiver of all
+  # the building methods.
+  class Proxy < ::BasicObject
+    #: (?base: Hash[untyped, untyped], ?symbolize: bool) -> void
+    def initialize(base: {}, symbolize: true)
+      @hash = base.dup
+      @symbolize = symbolize
+      @current_parent = @hash
+    end
+
+    # Creates an array.
+    #
+    #: (Symbol | String) { (Array[untyped]) -> void } -> void
+    def ary!(name, &block)
+      array = []
+      block.call(array)
+      key! name, array
+    end
+
+    alias array! ary!
+
+    # Add a key with the specified value to the hash.
+    # Creates a nested hash if a block is passed.
+    #
+    #: (String | Symbol, ?top) ?{ -> void } -> void
+    def key!(name, value = nil, &block)
+      name = name.to_s.delete_suffix('=')
+      name = name.to_sym if @symbolize
+
+      return hash!(name, &block) if block
+
+      @current_parent[name] = value
+      @hash
+    end
+
+    #: { (Proxy) -> void } -> Hash[untyped, untyped]
+    def entry!(&block)
+      p = Proxy.new(symbolize: @symbolize)
+      block.call(p)
+      p.to_h
+    end
+
+    # Creates a nested hash.
+    #
+    #: (String | Symbol) -> void
+    def hash!(name)
+      previous_parent = @current_parent
+      @current_parent = (@current_parent[name] ||= {})
+      yield
+      @current_parent = previous_parent
+    end
+
+    # Gets a value of a particular key.
+    #
+    #     HashBuilder.call do |h|
+    #       h.price 10
+    #       h.client do
+    #         h.first_name 'Patrick'
+    #         h.last_name 'Stewart'
+    #         h.full_name "#{h.dig!(:client, :first_name)} #{h.dig!(:client, :last_name)}"
+    #         h.card do
+    #           h.number '4242424242424242'
+    #           h.expiry_date = Time.now
+    #         end
+    #       end
+    #       h.price_copy = h.dig!(:price) #=> 10
+    #       h.card_copy = h.dig!(:client, :card, :number) #=> '4242424242424242'
+    #     end
+    #
+    #: (*Symbol | String) -> untyped
+    def dig!(*names)
+      @hash.dig(*names)
+    end
+
+    # Checks if a given key is defined.
+    #
+    #     HashBuilder.call do |h|
+    #       h.price 10
+    #       h.client do
+    #         h.name 'Patrick Stewart'
+    #         h.card do
+    #           h.number '4242424242424242'
+    #           h.expiry_date = Time.now
+    #         end
+    #       end
+    #       h.price_present = h.key?(:price) #=> true
+    #       h.card_present = h.key?(:client, :card) #=> true
+    #     end
+    #
+    # @param names [Array<Symbol>]
+    #: (*Symbol | String) -> bool
+    def key?(*names)
+      !::T.unsafe(self).dig!(*names).nil?
+    end
+
+    # Gets a value of a particular key in the current context.
+    #
+    #     HashBuilder.call do |h|
+    #       h.price 10
+    #       h.client do
+    #         h.first_name 'Patrick'
+    #         h.last_name 'Stewart'
+    #         h.full_name "#{h.local_dig!(:first_name)} #{h.local_dig!(:last_name)}"
+    #       end
+    #     end
+    #
+    #: (*Symbol | String) -> untyped
+    def local_dig!(*names)
+      @current_parent.dig(*names)
+    end
+
+    # Checks if a given key is defined in the local context.
+    #
+    #     HashBuilder.call do |h|
+    #       h.price 10
+    #       h.client do
+    #         h.name 'Patrick Stewart'
+    #         h.surname 'Stewart' if h.local_key?(:name) # true
+    #       end
+    #     end
+    #
+    #: (*Symbol | String) -> bool
+    def local_key?(*names)
+      !::T.unsafe(self).local_dig!(*names).nil?
+    end
+
+    #: -> Hash[Symbol | String, untyped]
+    def to_h
+      @hash
+    end
+
+    def method_missing(method_name, *args, &block)
+      super if method_name.end_with?('?') || method_name.end_with?('!')
+
+      key!(method_name, args.first, &block)
+    end
+
+    def respond_to_missing?(method_name, *_args)
+      return false if method_name.end_with?('?') || method_name.end_with?('!')
+
+      true
+    end
+  end
+end

data/sig/nested_hash_builder.rbs

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

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: nested_hash_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mateusz Drewniak
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: A Ruby library for building nested Hashes
+email:
+- m.drewniak@espago.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/nested_hash_builder.rb
+- lib/nested_hash_builder/version.rb
+- sig/nested_hash_builder.rbs
+homepage: https://github.com/Verseth/ruby-nested_hash_builder
+licenses: []
+metadata:
+  homepage_uri: https://github.com/Verseth/ruby-nested_hash_builder
+  source_code_uri: https://github.com/Verseth/ruby-nested_hash_builder
+  changelog_uri: https://raw.githubusercontent.com/Verseth/ruby-nested_hash_builder/refs/heads/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+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.7.1
+specification_version: 4
+summary: A Ruby library for building nested Hashes
+test_files: []