everythingrb 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81c7beca1a15139ecb5a59977740b65244d05f16b157ca45fb0d2995c7503bd3
-  data.tar.gz: d6b6fffa5d7be4890ac617b17c785e289e6e6f3385fa941a72f211f47e2a7c0c
+  metadata.gz: 8567a1a0f80fd1582946019cd0c378f916648f70d9a9087944f83f5ba29669be
+  data.tar.gz: 8f42ce110e7c57529f591615d7612d75556497fc3e80fe56f0ece352847df709
 SHA512:
-  metadata.gz: b3089b90018085b856d7fd34a133ec9174753a371d7c6d56088c82fbbd5c46a1e5c4c3a2c0d9e967b1eaf28d84dd322b5b8a919a93bd5f71157e2638bdfaabfd
-  data.tar.gz: 5f5e058681ad88168d0a37c7580fd29483f755a895d0fce088e8db9904136d7a118d6b7557375fc7675f8b157da16b61274eeaf0378a53e53863632723dcccc0
+  metadata.gz: 065ef8975736ca530d915f4d7780b1a35a6e85834f735aadbc244f5c05bd39845be26bd07102e52e649e9946769b255fb50d951ea4b335204d55c75eae213828
+  data.tar.gz: 6edcdc737cd2dda4395d5b685c463c3af0d2fedab7d1737193105a43ce4365e0b63bdbeb7bac336868b0dea1e9857d9e0d33b55ba0f693ab818f607611ca864d

data/CHANGELOG.md

@@ -23,6 +23,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+## [0.2.3] - 12025-03-09
+
+### Added
+
+- Added `Symbol#with_quotes` and `Symbol#in_quotes`
+
+
+## [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
@@ -88,7 +104,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.1...HEAD
+[unreleased]: https://github.com/itsthedevman/everythingrb/compare/v0.2.3...HEAD
+[0.2.3]: https://github.com/itsthedevman/everythingrb/compare/v0.2.2...v0.2.3
+[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

data/README.md

@@ -19,24 +19,31 @@ I'm currently looking for opportunities where I can tackle meaningful problems a
 - [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-1)
+    - [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-2)
+    - [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)
+  - [Symbol](#symbol)
+    - [with_quotes / in_quotes](#with_quotes--in_quotes-1)
 - [Requirements](#requirements)
 - [Contributing](#contributing)
 - [License](#license)
@@ -76,11 +83,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
@@ -124,6 +194,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`
@@ -242,6 +321,16 @@ Wraps the string in double quotes
 # => "\"Hello World\""
 ```
 
+### Symbol
+
+#### `with_quotes` / `in_quotes`
+Wraps the symbol in double quotes
+
+```ruby
+:hello_world.with_quotes
+# => :"\"hello_world\""
+```
+
 ## Contributing
 
 1. Fork it

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

@@ -85,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/symbol.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Symbol
+  #
+  # Returns self wrapped in double quotes.
+  #
+  # @return [Symbol]
+  #
+  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.1"
+  VERSION = "0.2.3"
 end

data/lib/everythingrb.rb

@@ -5,10 +5,12 @@ 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"
 require_relative "everythingrb/core/string"
+require_relative "everythingrb/core/symbol"
 
 module Everythingrb
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everythingrb
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Bryan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-01 00:00:00.000000000 Z
+date: 2025-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ostruct
@@ -58,12 +58,13 @@ 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
 - lib/everythingrb/core/string.rb
+- lib/everythingrb/core/symbol.rb
 - lib/everythingrb/version.rb
-- sig/everythingrb.rbs
 homepage: https://github.com/itsthedevman/everythingrb
 licenses:
 - MIT

data/sig/everythingrb.rbs

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