hmap 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b91ede0c8bd571c77da15568b4418141005fd68b
-  data.tar.gz: 5d3be03169ec696f3a4c5787a54eed3a7a82e4f1
+SHA256:
+  metadata.gz: 77e9c393f40df641e51a65b9279fc479c5b3e85bb90e74cd6d13a836147c1b56
+  data.tar.gz: f1f9f8c51498c80c4de446917dc60462aa020e74a5721684de983d5b2a728211
 SHA512:
-  metadata.gz: 4490aad3efaa67f76f58fd9af4a61e5cf26c919140ecef9b11ac637b37d4b763b191efc84c218d7e6e3e7e0441deaff432201014756754e64384d16e6daadf7c
-  data.tar.gz: 2b443f56320051e2f824eb147de39ed6ecb8b9559041cee6692ed6986ad57b13078503c40b3206e409f4a682c3779977d4d13f110b24d3073380967f05a474fb
+  metadata.gz: e925a388dcc787b0b5413d894b363e65f09ebdadf3dd3e25f9f33430421f5b350e494b1aed3d896ad11165555b72a711cd4c8488556dc539b82d9b12191684a2
+  data.tar.gz: 98b1d1082abf8af745cda978df664ecfd0565d685beb835ed0e4fd2fd68278d47ef969068d566de061c26086e1aef4492a7e7da29520885c232d99edcd3de68c

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+### 1.1.0  (2026-11-03)
+- require Ruby >= 3.2
+- fix FrozenError from hmap, kmap, and vmap on frozen hashes
+- raise ArgumentError when called without a block
+- hmap and Hash.hmap raise on malformed pairs, e.g. [key], instead of filling in a nil value
+- kmap and vmap pass the key and value to blocks with an optional second param, e.g. |k, v = nil|
+
+###  1.0.1  (2024-07-12)
+- fix changelog
+- rebuild
+- codecov
+- readme
+- upgrades
+- update libs
+
+### 1.0.0, 2018-12-03
+- launch

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    hmap (1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    debug (1.11.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.6.2)
+    erb (6.0.7)
+    io-console (0.9.5)
+    irb (1.18.0)
+      pp (>= 0.6.0)
+      prism (>= 1.3.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    logger (1.7.0)
+    pp (0.6.4)
+      prettyprint
+    prettyprint (0.2.1)
+    prism (2.1.0)
+    rbs (4.2.0)
+      logger
+      prism (>= 1.6.0)
+      tsort
+    rdoc (8.1.0)
+      erb
+      prism (>= 1.6.0)
+      rbs (>= 4.0.0)
+      tsort
+    reline (0.7.0)
+      io-console (~> 0.5)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-debugging (0.0.5)
+      debug (>= 1.10)
+      rspec-core (>= 3.10)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    simplecov (1.3.2)
+    tsort (0.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debug (>= 1)
+  hmap!
+  rspec (>= 3.10)
+  rspec-debugging
+  simplecov (>= 0.22)
+
+BUNDLED WITH
+   2.5.15

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Daniel Pepper
+
+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,74 @@
+Hmap
+======
+
+Improved Hash mapping functions
+
+### Install
+```gem install hmap```
+
+
+### Usage
+#### Hash.map
+Create a Hash using an Enumerable by mapping its items into corresponding hash values
+```ruby
+Hash.map [:a, :bb, :ccc] {|v| v.length }
+=> { a: 1, bb: 2, ccc: 3 }
+```
+
+#### hmap
+Map an Enumerable into a Hash, like Hash[obj.map ... ]
+```ruby
+Hash.hmap [ 1, 2, 3 ] { |v| [ v, v * 2 ] }
+=> { 1 => 2, 2 => 4, 3 => 6 }
+
+{
+  'a' => 1,
+  'b' => 2,
+  'c' => 3,
+}.hmap {|k, v| [ k * v, v ** 2 ] }
+=> { 'a' => 1, 'bb' => 4, 'ccc' => 9 }
+```
+
+#### vmap
+Transform the values of a Hash
+```ruby
+{
+  a: 1,
+  b: 2,
+  c: 3,
+}.vmap {|v| v * 2 }
+=> { a: 2, b: 4, c: 6 }
+
+{
+  a: 1,
+  b: 2,
+  c: 3,
+}.vmap &:to_s
+=> { a: '1', b: '2', c: '3' }
+```
+
+#### kmap
+Transform the keys of a Hash
+```ruby
+{
+  'a' => 1,
+  'b' => 2,
+  'c' => 3,
+}.kmap {|k, v| k * v }
+=> { 'a' => 1, 'bb' => 2, 'ccc' => 3 }
+
+{
+  'a' => 1,
+  'b' => 2,
+  'c' => 3,
+}.kmap &:to_sym
+=> { a: 1, b: 2, c: 3 }
+```
+
+
+##
+Thanks to [J. Pablo Fernández](https://github.com/pupeno/hmap)
+
+----
+![Gem](https://img.shields.io/gem/dt/hmap?style=plastic)
+[![codecov](https://codecov.io/gh/dpep/rb_hmap/branch/main/graph/badge.svg)](https://codecov.io/gh/dpep/rb_hmap)

data/hmap.gemspec

@@ -0,0 +1,19 @@
+require_relative "lib/hmap/version"
+
+Gem::Specification.new do |s|
+  s.authors     = ["Daniel Pepper"]
+  s.description = "Improved Hash mapping functions"
+  s.files       = `git ls-files * ":!:spec"`.split("\n")
+  s.homepage    = "https://github.com/dpep/rb_hmap"
+  s.license     = "MIT"
+  s.name        = "hmap"
+  s.summary     = "Hmap"
+  s.version     = Hmap::VERSION
+
+  s.required_ruby_version = ">= 3.2"
+
+  s.add_development_dependency "debug", ">= 1"
+  s.add_development_dependency "rspec", ">= 3.10"
+  s.add_development_dependency "rspec-debugging"
+  s.add_development_dependency "simplecov", ">= 0.22"
+end

data/lib/hmap/hmap.rb

@@ -1,65 +1,66 @@
-class Hash
+module Hmap
+  # create Hash from given keys and mapped values
+  def map(obj, &block)
+    raise ArgumentError, "no block given" unless block
 
-  class << self
-
-    # create Hash from given keys and mapped values
-    def map(obj, &block)
-      res = obj.map do |*args|
-        block.call(*args)
-      end
-
-      Hash[obj.zip res]
-    end
-
-
-    # map an Enumerable into a Hash, like Hash[obj.map ... ]
-    def hmap(obj, &block)
-      Hash[
-        obj.map do |*args|
-          block.call(*args)
-        end.compact
-      ]
-    end
+    obj.zip(obj.map(&block)).to_h
+  end
 
-  end  # class << self
+  # map an Enumerable into a Hash, like obj.map { ... }.to_h
+  def hmap(obj, &block)
+    raise ArgumentError, "no block given" unless block
 
+    obj.map(&block).compact.to_h
+  end
 
-  # map the block's results back to a hash
-  def hmap(&block)
-    clone.hmap!(&block)
+  # call with (key, value) if the block takes both, else just the one
+  def self.yield_pair(block, one, key, value)
+    positional = block.parameters.count { |type, _| type == :req || type == :opt }
+    positional >= 2 ? block.call(key, value) : block.call(one)
   end
 
-  def hmap!(&block)
-    data = Hash.hmap(self, &block)
-    clear
-    merge! data
+  def self.extended(base)
+    base.include(InstanceMethods)
   end
 
+  module InstanceMethods
+    # map the block's results back to a hash
+    def hmap(&block)
+      dup.hmap!(&block)
+    end
 
-  # map keys, but preserve associated values
-  # ie. http://apidock.com/rails/v4.2.7/Hash/transform_keys
-  def kmap(&block)
-    clone.kmap!(&block)
-  end
+    def hmap!(&block)
+      data = Hash.hmap(self, &block)
+      clear
+      merge! data
+    end
 
-  def kmap!(&block)
-    hmap! do |k, v|
-      [ block.arity <= 1 ? block.call(k) : block.call(k, v), v ]
+    # map keys, but preserve associated values
+    # ie. http://apidock.com/rails/v4.2.7/Hash/transform_keys
+    def kmap(&block)
+      dup.kmap!(&block)
     end
-  end
 
+    def kmap!(&block)
+      raise ArgumentError, "no block given" unless block
 
-  # map values, but preserve associated keys
-  # ie. http://apidock.com/rails/v4.2.7/Hash/transform_values
-  def vmap(&block)
-    clone.vmap!(&block)
-  end
+      hmap! do |k, v|
+        [ Hmap.yield_pair(block, k, k, v), v ]
+      end
+    end
 
-  def vmap!(&block)
-    each do |k, v|
-      self[k] = block.arity <= 1 ? block.call(v) : block.call(k, v)
+    # map values, but preserve associated keys
+    # ie. http://apidock.com/rails/v4.2.7/Hash/transform_values
+    def vmap(&block)
+      dup.vmap!(&block)
     end
-  end
 
+    def vmap!(&block)
+      raise ArgumentError, "no block given" unless block
 
+      each do |k, v|
+        self[k] = Hmap.yield_pair(block, v, k, v)
+      end
+    end
+  end
 end

data/lib/hmap/version.rb

@@ -0,0 +1,3 @@
+module Hmap
+  VERSION = "1.1.0"
+end

data/lib/hmap.rb

@@ -1,6 +1,4 @@
 require_relative 'hmap/hmap'
+require_relative 'hmap/version'
 
-
-module Hmap
-  VERSION = '1.0.0'
-end
+Hash.extend(Hmap)

metadata

@@ -1,45 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: hmap
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Daniel Pepper
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec-debugging
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,20 +51,38 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.22'
 description: Improved Hash mapping functions
-email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- hmap.gemspec
 - lib/hmap.rb
 - lib/hmap/hmap.rb
-- test/test_hmap.rb
+- lib/hmap/version.rb
 homepage: https://github.com/dpep/rb_hmap
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -73,17 +90,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Hmap
-test_files:
-- test/test_hmap.rb
+test_files: []

data/test/test_hmap.rb

@@ -1,279 +0,0 @@
-require 'minitest/autorun'
-require 'hmap'
-
-
-class HmapTest < Minitest::Test
-
-  def test_Hash_map
-    data = {
-      c: 2,
-      b: 3,
-      a: 1,
-    }
-
-    assert_equal(
-      data,
-      Hash.map(data.keys) {|x| data[x]}
-    )
-
-    assert_equal(
-      {},
-      Hash.map([]) {|x| nil}
-    )
-
-    assert_equal(
-      {
-        1 => nil,
-        2 => nil,
-        3 => nil,
-      },
-      Hash.map([1,2,3]) {|x| nil}
-    )
-
-    assert_equal(
-      {
-        1 => false,
-        2 => false,
-        3 => true,
-      },
-      Hash.map([1,2,3]) {|x| x > 2 }
-    )
-
-    assert_equal(
-      { 1 => [ 2, 3 ] },
-      Hash.map([1]) {|x| [ 2, 3 ] }
-    )
-  end
-
-
-  def test_Hash_hmap
-    data = {
-      c: 2,
-      b: 3,
-      a: 1,
-    }
-
-    assert_equal(
-      data,
-      Hash.hmap(data) {|k, v| [k, v]}
-    )
-
-    assert_equal(
-      { a: 2, b: 6, c: 4 },
-      Hash.hmap(data) {|k, v| [k, v * 2]}
-    )
-
-    assert_equal(
-      { 1 => 2, 2 => 4 },
-      Hash.hmap([1, 2]) {|x| [ x, x * 2 ] }
-    )
-
-    assert_equal(
-      data,
-      Hash.hmap(data.keys) {|x| [x, data[x]]}
-    )
-
-    assert_equal(
-      { nil => 3 },
-      Hash.hmap([1,2,3]) {|x| [nil, x]}
-    )
-
-    assert_equal(
-      {},
-      Hash.hmap([]) {|x| nil}
-    )
-
-    assert_equal(
-      {},
-      Hash.hmap([1, 2, 3]) {|x| nil}
-    )
-  end
-
-
-  def test_hmap
-    data = {
-      c: 2,
-      b: 3,
-      a: 1,
-    }
-
-    assert_equal(
-      {
-        c: 4,
-        b: 6,
-        a: 2,
-      },
-      data.hmap {|k, v| [k, v * 2]}
-    )
-
-    assert_equal(
-      {
-        cc: 4,
-        bb: 6,
-        aa: 2,
-      },
-      data.hmap {|k, v| [(k.to_s * 2).to_sym, v * 2]}
-    )
-
-    assert_equal(
-      {},
-      {}.hmap {|k, v| [k, v * 2]}
-    )
-
-    assert_equal(
-      {},
-      {a: 1}.hmap {|k, v| nil}
-    )
-
-
-    assert_equal(
-      {
-        c: 4,
-        b: 6,
-        a: 2,
-      },
-      data.hmap! {|k, v| [k, v * 2]}
-    )
-    assert_equal(
-      {
-        c: 4,
-        b: 6,
-        a: 2,
-      },
-      data
-    )
-  end
-
-
-  def test_kmap
-    data = {
-      'a' => 1,
-      'b' => 2,
-      'c' => 3,
-    }
-
-    assert_equal(
-      data,
-      data.kmap(&:to_s)
-    )
-
-    assert_equal(
-      {
-        'aa' => 1,
-        'bb' => 2,
-        'cc' => 3,
-      },
-      data.kmap {|k| k * 2}
-    )
-
-    assert_equal(
-      {
-        'aa' => 1,
-        'bb' => 2,
-        'cc' => 3,
-      },
-      data.kmap {|k, v| k * 2}
-    )
-
-    assert_equal(
-      {
-        'aa' => 1,
-        'bb' => 2,
-        'cc' => 3,
-      },
-      data.kmap! {|k, v| k * 2}
-    )
-    assert_equal(
-      {
-        'aa' => 1,
-        'bb' => 2,
-        'cc' => 3,
-      },
-      data
-    )
-  end
-
-
-  def test_vmap
-    data = {
-      a: 1,
-      b: 2,
-      c: 3,
-    }
-
-    assert_equal(
-      {
-        a: 1.0,
-        b: 2.0,
-        c: 3.0,
-      },
-      data.vmap(&:to_f)
-    )
-
-    assert_equal(
-      {
-        a: 2,
-        b: 4,
-        c: 6,
-      },
-      data.vmap {|v| v * 2}
-    )
-
-    assert_equal(
-      {
-        a: 2,
-        b: 4,
-        c: 6,
-      },
-      data.vmap {|k, v| v * 2}
-    )
-
-    assert_equal(
-      {
-        a: :a,
-        b: :b,
-        c: :c,
-      },
-      data.vmap {|k, v| k}
-    )
-
-
-    assert_equal(
-      {
-        a: 2,
-        b: 4,
-        c: 6,
-      },
-      data.vmap! {|v| v * 2}
-    )
-    assert_equal(
-      {
-        a: 2,
-        b: 4,
-        c: 6,
-      },
-      data
-    )
-  end
-
-
-  def test_default_value
-    data = Hash.new 123
-
-    assert_equal(
-      123,
-      data.kmap {|v| nil }[:abc]
-    )
-
-    assert_equal(
-      123,
-      data.vmap {|v| nil }[:abc]
-    )
-
-    assert_equal(
-      123,
-      data.hmap {|v| nil }[:abc]
-    )
-  end
-
-end