everythingrb 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecda2000911c11e9c9d062c641b463191810717826f019df27d75c61d41dd0c7
-  data.tar.gz: 5eb00d7c4cf95854d2d32385a3fe5a9d347d69bf7dbf0eed0e706e57bbff45f1
+  metadata.gz: 637e088cea35038c9cea8b54e127e795ddb06c1d7c0011e55accd5930cf2217d
+  data.tar.gz: '059758659229885856daaa52dfcfd33e6b4bdad6e29923e71e3dd887f7de390d'
 SHA512:
-  metadata.gz: 9892d5e1391446ca9f1a792f4870575e84bfb5c45118b82c636c0c6d6fe7d6f59c22d089811c56ee7fc4056b7728bca2d331e8fd80eabd1ac0c65e388e35055a
-  data.tar.gz: 631f5da0c0b9dd3afeb4204988bfdf79210975b1e6826bce45a09563473cbe62a41efabe23192edf83678874004f93e9d0b1eecf3cb81cc461d534a0bb753579
+  metadata.gz: 97b3766b8382f7e160e5996ce03497368770450cc76d91acfa094c80dc9812ae1d27ed66d95988e9918bdd3b6887b84bcc52ed4df70aacac5453872bab0104ca
+  data.tar.gz: f4991d65bf9ef6a3398e0808fa4d794816e4e53874ee712a66f18728ff6cd495d7f2f1f2a86ee40af5a3e5a435b78ff10defca50ea120bd423af30cf5953a90e

data/CHANGELOG.md

@@ -5,6 +5,7 @@ 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]
 
 ### Added
@@ -12,6 +13,34 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 ### Removed
+-->
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Removed
+
+## [0.2.2] - 12025-03-03
+
+### Added
+
+- Added `Array#key_map` and `Array#dig_map` for mapping over `Hash`
+- Added `with_index:` keyword argument to `Array#join_map`. Defaults to `false`
+- Added `Enumerable#join_map`
+- Added `Array#deep_freeze` and `Hash#deep_freeze` to recursively freeze the underlying values
+
+## [0.2.1] - 12025-03-01
+
+### Added
+
+- Added `with_quotes` / `in_quotes` to `String`
+
+### Removed
+
+- Removed `Data` definition check for `to_istruct`
 
 
 ## [0.2.0] - 12025-02-17
@@ -68,7 +97,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Added alias `each` to `each_pair` in OpenStruct for better enumerable compatibility
 
-[unreleased]: https://github.com/itsthedevman/everythingrb/compare/v0.2.0...HEAD
+[unreleased]: https://github.com/itsthedevman/everythingrb/compare/v0.2.2...HEAD
+[0.2.2]: https://github.com/itsthedevman/everythingrb/compare/v0.2.1...v0.2.2
+[0.2.1]: https://github.com/itsthedevman/everythingrb/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/itsthedevman/everythingrb/compare/v0.1.2...v0.2.0
 [0.1.2]: https://github.com/itsthedevman/everythingrb/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/itsthedevman/everythingrb/compare/v0.1.0...v0.1.1

data/README.md

@@ -1,11 +1,61 @@
 # EverythingRB
 
 [![Gem Version](https://badge.fury.io/rb/everythingrb.svg)](https://badge.fury.io/rb/everythingrb)
+![Ruby Version](https://img.shields.io/badge/ruby-3.3.7-ruby)
 [![Tests](https://github.com/itsthedevman/everythingrb/actions/workflows/main.yml/badge.svg)](https://github.com/everythingrb/sortsmith/actions/workflows/main.yml)
-![Ruby Version](https://img.shields.io/badge/ruby-3.3.6-ruby)
 
 Useful extensions to Ruby core classes that you never knew you needed until now.
 
+## Looking for a Software Engineer?
+
+I'm currently looking for opportunities where I can tackle meaningful problems and help build reliable software while mentoring the next generation of developers. If you're looking for a senior engineer with full-stack Rails expertise and a passion for clean, maintainable code, let's talk!
+
+[bryan@itsthedevman.com](mailto:bryan@itsthedevman.com)
+
+# Table of Contents
+
+- [Compatibility](#compatibility)
+- [Installation](#installation)
+- [Core Extensions](#core-extensions)
+  - [Array](#array)
+    - [join_map](#join_map)
+    - [key_map](#key_map)
+    - [dig_map](#dig_map)
+  - [Enumerable](#enumerable)
+    - [join_map](#join_map-1)
+  - [Hash](#hash)
+    - [to_struct](#to_struct)
+    - [to_ostruct](#to_ostruct)
+    - [to_istruct](#to_istruct)
+    - [join_map](#join_map-2)
+  - [Module](#module)
+    - [attr_predicate](#attr_predicate)
+  - [OpenStruct](#openstruct)
+    - [each](#each)
+    - [map](#map)
+    - [filter_map](#filter_map)
+    - [join_map](#join_map-3)
+  - [String](#string)
+    - [to_h / to_a](#to_h--to_a)
+    - [to_istruct](#to_istruct-1)
+    - [to_ostruct](#to_ostruct-1)
+    - [to_struct](#to_struct-1)
+    - [to_deep_h](#to_deep_h)
+    - [with_quotes / in_quotes](#with_quotes--in_quotes)
+- [Requirements](#requirements)
+- [Contributing](#contributing)
+- [License](#license)
+- [Changelog](#changelog)
+- [Credits](#credits)
+
+Also see: [API Documentation](https://itsthedevman.com/docs/everythingrb)
+
+## Compatibility
+
+Currently tested on:
+- MRI Ruby 3.2+
+- NixOS (see `flake.nix` for details)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -31,11 +81,74 @@ $ gem install everythingrb
 ### Array
 
 #### `join_map`
-Combines `filter_map` and `join` operations in one convenient method.
+Combines `filter_map` and `join` operations in one convenient method. Optionally provides the index to the block.
 
 ```ruby
+# Without index
 [1, 2, nil, 3].join_map(" ") { |n| n&.to_s if n&.odd? }
 # => "1 3"
+
+# With index
+["a", "b", "c"].join_map(", ", with_index: true) { |char, i| "#{i}:#{char}" }
+# => "0:a, 1:b, 2:c"
+
+# Default behavior without block
+[1, 2, nil, 3].join_map(", ")
+# => "1, 2, 3"
+```
+
+#### `key_map`
+Extracts a specific key from each hash in an array.
+
+```ruby
+users = [
+  { name: "Alice", age: 30 },
+  { name: "Bob", age: 25 }
+]
+
+users.key_map(:name)
+# => ["Alice", "Bob"]
+```
+
+#### `dig_map`
+Extracts nested values from each hash in an array using the `dig` method.
+
+```ruby
+data = [
+  { user: { profile: { name: "Alice" } } },
+  { user: { profile: { name: "Bob" } } }
+]
+
+data.dig_map(:user, :profile, :name)
+# => ["Alice", "Bob"]
+```
+
+#### `deep_freeze`
+Recursively freezes an array and all of its nested elements.
+
+```ruby
+array = ["hello", { name: "Alice" }, [1, 2, 3]]
+array.deep_freeze
+# => All elements and nested structures are now frozen
+```
+
+### Enumerable
+
+#### `join_map`
+Combines filtering, mapping and joining operations into one convenient method.
+
+```ruby
+# Basic usage with arrays
+[1, 2, nil, 3].join_map(", ") { |n| n&.to_s if n&.odd? }
+# => "1, 3"
+
+# Works with any Enumerable
+(1..10).join_map(" | ") { |n| "num#{n}" if n.even? }
+# => "num2 | num4 | num6 | num8 | num10"
+
+# Supports with_index option
+%w[a b c].join_map("-", with_index: true) { |char, i| "#{i}:#{char}" }
+# => "0:a-1:b-2:c"
 ```
 
 ### Hash
@@ -62,7 +175,7 @@ config.config.api_key # => "secret"
 ```
 
 #### `to_istruct`
-Recursively converts a hash into an immutable Data structure (requires Ruby 3.2+).
+Recursively converts a hash into an immutable Data structure.
 
 ```ruby
 hash = { person: { name: "Bob", age: 30 } }
@@ -79,6 +192,15 @@ Similar to Array#join_map but operates on hash values.
 # => "a 1 b 2 d 3"
 ```
 
+#### `deep_freeze`
+Recursively freezes a hash and all of its nested values.
+
+```ruby
+hash = { user: { name: "Alice", roles: ["admin", "user"] } }
+hash.deep_freeze
+# => Hash and all nested structures are now frozen
+```
+
 ### Module
 
 #### `attr_predicate`
@@ -152,7 +274,7 @@ Parses JSON string into a Ruby Hash or Array.
 ```
 
 #### `to_istruct`
-Parses JSON string into an immutable Data structure (requires Ruby 3.2+).
+Parses JSON string into an immutable Data structure.
 
 ```ruby
 '{"user": {"name": "Alice"}}'.to_istruct
@@ -189,10 +311,13 @@ nested_json.to_deep_h
 # => {users: [{name: "Alice", roles: ["admin", "user"]}]}
 ```
 
-## Requirements
+#### `with_quotes` / `in_quotes`
+Wraps the string in double quotes
 
-- Ruby 3.0+
-- Ruby 3.2+ for `to_istruct` functionality
+```ruby
+"Hello World".with_quotes
+# => "\"Hello World\""
+```
 
 ## Contributing
 

data/lib/everythingrb/core/array.rb

@@ -5,22 +5,80 @@ class Array
   # Combines filter_map and join operations
   #
   # @param join_with [String] The delimiter to join elements with (defaults to empty string)
+  # @param with_index [Boolean] Whether to include the index in the block (defaults to false)
   #
-  # @yield [Object] Block that filters and transforms array elements
+  # @yield [element, index] Block that filters and transforms array elements
+  # @yieldparam element [Object] The current element
+  # @yieldparam index [Integer] The index of the current element (only if with_index: true)
   #
   # @return [String] Joined string of filtered and transformed elements
   #
-  # @example
+  # @example Without index
   #   [1, 2, nil, 3].join_map(" ") { |n| n&.to_s if n&.odd? }
   #   # => "1 3"
   #
-  # @example
+  # @example With index
+  #   ["a", "b", "c"].join_map(", ", with_index: true) { |char, i| "#{i}:#{char}" }
+  #   # => "0:a, 1:b, 2:c"
+  #
+  # @example Default behavior without block
   #   [1, 2, nil, 3].join_map(", ")
   #   # => "1, 2, 3"
   #
-  def join_map(join_with = "", &block)
+  def join_map(join_with = "", with_index: false, &block)
     block = ->(i) { i } if block.nil?
 
-    filter_map(&block).join(join_with)
+    if with_index
+      filter_map.with_index(&block).join(join_with)
+    else
+      filter_map(&block).join(join_with)
+    end
+  end
+
+  #
+  # Maps over hash keys to extract values for a specific key
+  #
+  # @param key [Symbol, String] The key to extract
+  #
+  # @return [Array] Array of values
+  #
+  # @example
+  #   [{name: 'Alice', age: 30}, {name: 'Bob', age: 25}].key_map(:name)
+  #   # => ['Alice', 'Bob']
+  #
+  def key_map(key)
+    map { |v| v[key] }
+  end
+
+  #
+  # Maps over hash keys to extract nested values using dig
+  #
+  # @param keys [Array<Symbol, String>] The keys to dig through
+  #
+  # @return [Array] Array of nested values
+  #
+  # @example
+  #   [
+  #     {user: {profile: {name: 'Alice'}}},
+  #     {user: {profile: {name: 'Bob'}}}
+  #   ].dig_map(:user, :profile, :name)
+  #   # => ['Alice', 'Bob']
+  #
+  def dig_map(*keys)
+    map { |v| v.dig(*keys) }
+  end
+
+  #
+  # Recursively freezes self and all of its contents
+  #
+  # @return [self] Returns the frozen array
+  #
+  # @example Freeze an array with nested structures
+  #   ["hello", { name: "Alice" }, [1, 2, 3]].deep_freeze
+  #   # => All elements and nested structures are now frozen
+  #
+  def deep_freeze
+    each { |v| v.respond_to?(:deep_freeze) ? v.deep_freeze : v.freeze }
+    freeze
   end
 end

data/lib/everythingrb/core/enumerable.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Enumerable
+  #
+  # Combines filter_map and join operations
+  #
+  # @param join_with [String] The delimiter to join elements with (defaults to empty string)
+  # @param with_index [Boolean] Whether to include the index in the block (defaults to false)
+  #
+  # @yield [element, index] Block that filters and transforms array elements
+  # @yieldparam element [Object] The current element
+  # @yieldparam index [Integer] The index of the current element (only if with_index: true)
+  #
+  # @return [String] Joined string of filtered and transformed elements
+  #
+  # @example Without index
+  #   [1, 2, nil, 3].join_map(" ") { |n| n&.to_s if n&.odd? }
+  #   # => "1 3"
+  #
+  # @example With index
+  #   ["a", "b", "c"].join_map(", ", with_index: true) { |char, i| "#{i}:#{char}" }
+  #   # => "0:a, 1:b, 2:c"
+  #
+  # @example Default behavior without block
+  #   [1, 2, nil, 3].join_map(", ")
+  #   # => "1, 2, 3"
+  #
+  def join_map(join_with = "", with_index: false, &block)
+    block = ->(i) { i } if block.nil?
+
+    if with_index
+      filter_map.with_index(&block).join(join_with)
+    else
+      filter_map(&block).join(join_with)
+    end
+  end
+end

data/lib/everythingrb/core/hash.rb

@@ -26,27 +26,24 @@ class Hash
     filter_map(&block).join(join_with)
   end
 
-  # to_istruct relies on Data class
-  if defined?(Data)
-    #
-    # Converts hash to an immutable Data structure
-    #
-    # @return [Data]
-    #
-    def to_istruct
-      recurse = lambda do |input|
-        case input
-        when Hash
-          input.to_istruct
-        when Array
-          input.map(&recurse)
-        else
-          input
-        end
+  #
+  # Converts hash to an immutable Data structure
+  #
+  # @return [Data]
+  #
+  def to_istruct
+    recurse = lambda do |input|
+      case input
+      when Hash
+        input.to_istruct
+      when Array
+        input.map(&recurse)
+      else
+        input
       end
-
-      Data.define(*keys.map(&:to_sym)).new(*values.map { |value| recurse.call(value) })
     end
+
+    Data.define(*keys.map(&:to_sym)).new(*values.map { |value| recurse.call(value) })
   end
 
   #
@@ -88,4 +85,18 @@ class Hash
 
     OpenStruct.new(**transform_values { |value| recurse.call(value) })
   end
+
+  #
+  # Recursively freezes self and all of its values
+  #
+  # @return [self] Returns the frozen hash
+  #
+  # @example Freeze a hash with nested structures
+  #   { user: { name: "Alice", roles: ["admin"] } }.deep_freeze
+  #   # => Hash and all nested structures are now frozen
+  #
+  def deep_freeze
+    each_value { |v| v.respond_to?(:deep_freeze) ? v.deep_freeze : v.freeze }
+    freeze
+  end
 end

data/lib/everythingrb/core/string.rb

@@ -72,4 +72,15 @@ class String
   def to_struct
     to_h&.to_struct
   end
+
+  #
+  # Returns self wrapped in double quotes.
+  #
+  # @return [String]
+  #
+  def with_quotes
+    %("#{self}")
+  end
+
+  alias_method :in_quotes, :with_quotes
 end

data/lib/everythingrb/version.rb

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

data/lib/everythingrb.rb

@@ -5,6 +5,7 @@ require "json"
 
 require_relative "everythingrb/version"
 require_relative "everythingrb/core/array"
+require_relative "everythingrb/core/enumerable"
 require_relative "everythingrb/core/hash"
 require_relative "everythingrb/core/module"
 require_relative "everythingrb/core/ostruct"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everythingrb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Bryan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-17 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ostruct
@@ -58,6 +58,7 @@ files:
 - flake.nix
 - lib/everythingrb.rb
 - lib/everythingrb/core/array.rb
+- lib/everythingrb/core/enumerable.rb
 - lib/everythingrb/core/hash.rb
 - lib/everythingrb/core/module.rb
 - lib/everythingrb/core/ostruct.rb