first commit
CI / Build (clang, clang++, ubuntu-22.04, linux, 3.10, master, x86,x86_64) (push) Canceled after 0s
CI / Build (clang, clang++, windows-2022, windows, 3.10, master, x86,x86_64) (push) Canceled after 0s
CI / Release (push) Canceled after 0s

This commit is contained in:
2026-09-13 22:18:11 +01:00
commit 08c03ac533
6701 changed files with 1577314 additions and 0 deletions
@@ -0,0 +1,6 @@
MRuby::Gem::Specification.new('mruby-hash-ext') do |spec|
spec.license = 'MIT'
spec.author = 'mruby developers'
spec.summary = 'Hash class extension'
spec.add_dependency 'mruby-array-ext', core: 'mruby-array-ext'
end
@@ -0,0 +1,500 @@
class Hash
# ISO does not define Hash#each_pair, so each_pair is defined in gem.
alias each_pair each
##
# call-seq:
# Hash[ key, value, ... ] -> new_hash
# Hash[ [ [key, value], ... ] ] -> new_hash
# Hash[ object ] -> new_hash
#
# Creates a new hash populated with the given objects.
#
# Similar to the literal `{ _key_ => _value_, ... }`. In the first
# form, keys and values occur in pairs, so there must be an even number of
# arguments.
#
# The second and third form take a single argument which is either an array
# of key-value pairs or an object convertible to a hash.
#
# Hash["a", 100, "b", 200] #=> {"a"=>100, "b"=>200}
# Hash[ [ ["a", 100], ["b", 200] ] ] #=> {"a"=>100, "b"=>200}
# Hash["a" => 100, "b" => 200] #=> {"a"=>100, "b"=>200}
#
def self.[](*object)
length = object.length
if length == 1
o = object[0]
if Hash === o
h = self.new
o.each { |k, v| h[k] = v }
return h
elsif o.respond_to?(:to_a)
h = self.new
o.to_a.each do |i|
raise ArgumentError, "wrong element type #{i.class} (expected array)" unless i.respond_to?(:to_a)
k, v = nil
case i.size
when 2
k = i[0]
v = i[1]
when 1
k = i[0]
else
raise ArgumentError, "invalid number of elements (#{i.size} for 1..2)"
end
h[k] = v
end
return h
end
end
unless length % 2 == 0
raise ArgumentError, 'odd number of arguments for Hash'
end
h = self.new
0.step(length - 2, 2) do |i|
h[object[i]] = object[i + 1]
end
h
end
##
# call-seq:
# hsh.merge!(other_hash) -> hsh
# hsh.merge!(other_hash){|key, oldval, newval| block} -> hsh
#
# Adds the contents of _other_hash_ to _hsh_. If no block is specified,
# entries with duplicate keys are overwritten with the values from
# _other_hash_, otherwise the value of each duplicate key is determined by
# calling the block with the key, its value in _hsh_ and its value in
# _other_hash_.
#
# h1 = { "a" => 100, "b" => 200 }
# h2 = { "b" => 254, "c" => 300 }
# h1.merge!(h2) #=> {"a"=>100, "b"=>254, "c"=>300}
#
# h1 = { "a" => 100, "b" => 200 }
# h2 = { "b" => 254, "c" => 300 }
# h1.merge!(h2) { |key, v1, v2| v1 }
# #=> {"a"=>100, "b"=>200, "c"=>300}
#
def merge!(other, &block)
raise TypeError, "Hash required (#{other.class} given)" unless Hash === other
if block
other.each_key{|k|
self[k] = (self.has_key?(k))? block.call(k, self[k], other[k]): other[k]
}
else
other.each_key{|k| self[k] = other[k]}
end
self
end
alias update merge!
##
# call-seq:
# hsh.compact! -> hsh
#
# Removes all nil values from the hash. Returns the hash.
# Returns nil if the hash does not contain nil values.
#
# h = { a: 1, b: false, c: nil }
# h.compact! #=> { a: 1, b: false }
#
def compact!
keys = self.keys
nk = keys.select{|k|
self[k] != nil
}
return nil if (keys.size == nk.size)
h = {}
nk.each {|k|
h[k] = self[k]
}
h
self.replace(h)
end
##
# call-seq:
# hsh.compact -> new_hsh
#
# Returns a new hash with the nil values/key pairs removed
#
# h = { a: 1, b: false, c: nil }
# h.compact #=> { a: 1, b: false }
# h #=> { a: 1, b: false, c: nil }
#
def compact
h = {}
self.keys.select{|k|
self[k] != nil
}.each {|k|
h[k] = self[k]
}
h
end
##
# call-seq:
# hsh.fetch(key [, default] ) -> obj
# hsh.fetch(key) {| key | block } -> obj
#
# Returns a value from the hash for the given key. If the key can't be
# found, there are several options: With no other arguments, it will
# raise an <code>KeyError</code> exception; if <i>default</i> is
# given, then that will be returned; if the optional code block is
# specified, then that will be run and its result returned.
#
# h = { "a" => 100, "b" => 200 }
# h.fetch("a") #=> 100
# h.fetch("z", "go fish") #=> "go fish"
# h.fetch("z") { |el| "go fish, #{el}"} #=> "go fish, z"
#
# The following example shows that an exception is raised if the key
# is not found and a default value is not supplied.
#
# h = { "a" => 100, "b" => 200 }
# h.fetch("z")
#
# <em>produces:</em>
#
# prog.rb:2:in 'fetch': key not found (KeyError)
# from prog.rb:2
#
def fetch(key, none=NONE, &block)
unless self.key?(key)
if block
block.call(key)
elsif none != NONE
none
else
raise KeyError, "Key not found: #{key.inspect}"
end
else
self[key]
end
end
##
# call-seq:
# hsh.delete_if {| key, value | block } -> hsh
# hsh.delete_if -> an_enumerator
#
# Deletes every key-value pair from <i>hsh</i> for which <i>block</i>
# evaluates to <code>true</code>.
#
# If no block is given, an enumerator is returned instead.
#
# h = { "a" => 100, "b" => 200, "c" => 300 }
# h.delete_if {|key, value| key >= "b" } #=> {"a"=>100}
#
def delete_if(&block)
return to_enum :delete_if unless block
self.each do |k, v|
self.delete(k) if block.call(k, v)
end
self
end
##
# call-seq:
# hash.flatten -> an_array
# hash.flatten(level) -> an_array
#
# Returns a new array that is a one-dimensional flattening of this
# hash. That is, for every key or value that is an array, extract
# its elements into the new array. Unlike Array#flatten, this
# method does not flatten recursively by default. The optional
# <i>level</i> argument determines the level of recursion to flatten.
#
# a = {1=> "one", 2 => [2,"two"], 3 => "three"}
# a.flatten # => [1, "one", 2, [2, "two"], 3, "three"]
# a.flatten(2) # => [1, "one", 2, 2, "two", 3, "three"]
#
def flatten(level=1)
self.to_a.flatten(level)
end
##
# call-seq:
# hsh.invert -> new_hash
#
# Returns a new hash created by using <i>hsh</i>'s values as keys, and
# the keys as values.
#
# h = { "n" => 100, "m" => 100, "y" => 300, "d" => 200, "a" => 0 }
# h.invert #=> {0=>"a", 100=>"m", 200=>"d", 300=>"y"}
#
def invert
h = self.class.new
self.each {|k, v| h[v] = k }
h
end
##
# call-seq:
# hsh.keep_if {| key, value | block } -> hsh
# hsh.keep_if -> an_enumerator
#
# Deletes every key-value pair from <i>hsh</i> for which <i>block</i>
# evaluates to false.
#
# If no block is given, an enumerator is returned instead.
#
def keep_if(&block)
return to_enum :keep_if unless block
keys = []
self.each do |k, v|
unless block.call([k, v])
self.delete(k)
end
end
self
end
##
# call-seq:
# hsh.key(value) -> key
#
# Returns the key of an occurrence of a given value. If the value is
# not found, returns <code>nil</code>.
#
# h = { "a" => 100, "b" => 200, "c" => 300, "d" => 300 }
# h.key(200) #=> "b"
# h.key(300) #=> "c"
# h.key(999) #=> nil
#
def key(val)
self.each do |k, v|
return k if v == val
end
nil
end
##
# call-seq:
# hsh.to_h -> hsh or new_hash
#
# Returns +self+. If called on a subclass of Hash, converts
# the receiver to a Hash object.
#
def to_h
self
end
##
# call-seq:
# hash < other -> true or false
#
# Returns <code>true</code> if <i>hash</i> is subset of
# <i>other</i>.
#
# h1 = {a:1, b:2}
# h2 = {a:1, b:2, c:3}
# h1 < h2 #=> true
# h2 < h1 #=> false
# h1 < h1 #=> false
#
def <(hash)
raise TypeError, "can't convert #{hash.class} to Hash" unless Hash === hash
size < hash.size and all? {|key, val|
hash.key?(key) and hash[key] == val
}
end
##
# call-seq:
# hash <= other -> true or false
#
# Returns <code>true</code> if <i>hash</i> is subset of
# <i>other</i> or equals to <i>other</i>.
#
# h1 = {a:1, b:2}
# h2 = {a:1, b:2, c:3}
# h1 <= h2 #=> true
# h2 <= h1 #=> false
# h1 <= h1 #=> true
#
def <=(hash)
raise TypeError, "can't convert #{hash.class} to Hash" unless Hash === hash
size <= hash.size and all? {|key, val|
hash.key?(key) and hash[key] == val
}
end
##
# call-seq:
# hash > other -> true or false
#
# Returns <code>true</code> if <i>other</i> is subset of
# <i>hash</i>.
#
# h1 = {a:1, b:2}
# h2 = {a:1, b:2, c:3}
# h1 > h2 #=> false
# h2 > h1 #=> true
# h1 > h1 #=> false
#
def >(hash)
raise TypeError, "can't convert #{hash.class} to Hash" unless Hash === hash
size > hash.size and hash.all? {|key, val|
key?(key) and self[key] == val
}
end
##
# call-seq:
# hash >= other -> true or false
#
# Returns <code>true</code> if <i>other</i> is subset of
# <i>hash</i> or equals to <i>hash</i>.
#
# h1 = {a:1, b:2}
# h2 = {a:1, b:2, c:3}
# h1 >= h2 #=> false
# h2 >= h1 #=> true
# h1 >= h1 #=> true
#
def >=(hash)
raise TypeError, "can't convert #{hash.class} to Hash" unless Hash === hash
size >= hash.size and hash.all? {|key, val|
key?(key) and self[key] == val
}
end
##
# call-seq:
# hsh.dig(key,...) -> object
#
# Extracts the nested value specified by the sequence of <i>key</i>
# objects by calling +dig+ at each step, returning +nil+ if any
# intermediate step is +nil+.
#
def dig(idx,*args)
n = self[idx]
if args.size > 0
n&.dig(*args)
else
n
end
end
##
# call-seq:
# hsh.transform_keys {|key| block } -> new_hash
# hsh.transform_keys -> an_enumerator
#
# Returns a new hash, with the keys computed from running the block
# once for each key in the hash, and the values unchanged.
#
# If no block is given, an enumerator is returned instead.
#
def transform_keys(&block)
return to_enum :transform_keys unless block
hash = {}
self.keys.each do |k|
new_key = block.call(k)
hash[new_key] = self[k]
end
hash
end
##
# call-seq:
# hsh.transform_keys! {|key| block } -> hsh
# hsh.transform_keys! -> an_enumerator
#
# Invokes the given block once for each key in <i>hsh</i>, replacing it
# with the new key returned by the block, and then returns <i>hsh</i>.
#
# If no block is given, an enumerator is returned instead.
#
def transform_keys!(&block)
return to_enum :transform_keys! unless block
self.keys.each do |k|
value = self[k]
self.__delete(k)
k = block.call(k) if block
self[k] = value
end
self
end
##
# call-seq:
# hsh.transform_values {|value| block } -> new_hash
# hsh.transform_values -> an_enumerator
#
# Returns a new hash with the results of running the block once for
# every value.
# This method does not change the keys.
#
# If no block is given, an enumerator is returned instead.
#
def transform_values(&b)
return to_enum :transform_values unless block_given?
hash = {}
self.keys.each do |k|
hash[k] = yield(self[k])
end
hash
end
##
# call-seq:
# hsh.transform_values! {|key| block } -> hsh
# hsh.transform_values! -> an_enumerator
#
# Invokes the given block once for each value in the hash, replacing
# with the new value returned by the block, and then returns <i>hsh</i>.
#
# If no block is given, an enumerator is returned instead.
#
def transform_values!(&b)
return to_enum :transform_values! unless block_given?
self.keys.each do |k|
self[k] = yield(self[k])
end
self
end
def to_proc
->x{self[x]}
end
##
# call-seq:
# hsh.fetch_values(key, ...) -> array
# hsh.fetch_values(key, ...) { |key| block } -> array
#
# Returns an array containing the values associated with the given keys
# but also raises <code>KeyError</code> when one of keys can't be found.
# Also see <code>Hash#values_at</code> and <code>Hash#fetch</code>.
#
# h = { "cat" => "feline", "dog" => "canine", "cow" => "bovine" }
#
# h.fetch_values("cow", "cat") #=> ["bovine", "feline"]
# h.fetch_values("cow", "bird") # raises KeyError
# h.fetch_values("cow", "bird") { |k| k.upcase } #=> ["bovine", "BIRD"]
#
def fetch_values(*keys, &block)
keys.map do |k|
self.fetch(k, &block)
end
end
alias filter select
alias filter! select!
end
@@ -0,0 +1,83 @@
/*
** hash.c - Hash class
**
** See Copyright Notice in mruby.h
*/
#include <mruby.h>
#include <mruby/array.h>
#include <mruby/hash.h>
/*
* call-seq:
* hsh.values_at(key, ...) -> array
*
* Return an array containing the values associated with the given keys.
* Also see <code>Hash.select</code>.
*
* h = { "cat" => "feline", "dog" => "canine", "cow" => "bovine" }
* h.values_at("cow", "cat") #=> ["bovine", "feline"]
*/
static mrb_value
hash_values_at(mrb_state *mrb, mrb_value hash)
{
mrb_value *argv, result;
mrb_int argc, i;
int ai;
mrb_get_args(mrb, "*", &argv, &argc);
result = mrb_ary_new_capa(mrb, argc);
ai = mrb_gc_arena_save(mrb);
for (i = 0; i < argc; i++) {
mrb_ary_push(mrb, result, mrb_hash_get(mrb, hash, argv[i]));
mrb_gc_arena_restore(mrb, ai);
}
return result;
}
/*
* call-seq:
* hsh.slice(*keys) -> a_hash
*
* Returns a hash containing only the given keys and their values.
*
* h = { a: 100, b: 200, c: 300 }
* h.slice(:a) #=> {:a=>100}
* h.slice(:b, :c, :d) #=> {:b=>200, :c=>300}
*/
static mrb_value
hash_slice(mrb_state *mrb, mrb_value hash)
{
mrb_value *argv, result;
mrb_int argc, i;
mrb_get_args(mrb, "*", &argv, &argc);
result = mrb_hash_new_capa(mrb, argc);
if (argc == 0) return result; /* empty hash */
for (i = 0; i < argc; i++) {
mrb_value key = argv[i];
mrb_value val;
val = mrb_hash_fetch(mrb, hash, key, mrb_undef_value());
if (!mrb_undef_p(val)) {
mrb_hash_set(mrb, result, key, val);
}
}
return result;
}
void
mrb_mruby_hash_ext_gem_init(mrb_state *mrb)
{
struct RClass *h;
h = mrb->hash_class;
mrb_define_method(mrb, h, "values_at", hash_values_at, MRB_ARGS_ANY());
mrb_define_method(mrb, h, "slice", hash_slice, MRB_ARGS_ANY());
}
void
mrb_mruby_hash_ext_gem_final(mrb_state *mrb)
{
}
@@ -0,0 +1,290 @@
##
# Hash(Ext) Test
assert('Hash.[] Hash') do
a = Hash['a_key' => 'a_value']
assert_equal({'a_key' => 'a_value'}, a)
end
assert('Hash.[] [ [ ["b_key", "b_value" ] ] ]') do
a = Hash[ [ ['b_key', 'b_value'] ] ]
assert_equal({'b_key' => 'b_value'}, a)
a = Hash[ [ ] ]
assert_equal({}, a)
assert_raise(ArgumentError) do
Hash[ [ ['b_key', 'b_value', 'b_over'] ] ]
end
assert_raise(ArgumentError) do
Hash[ [ [] ] ]
end
end
assert('Hash.[] "c_key", "c_value"') do
a = Hash['c_key', 'c_value', 'd_key', 1]
assert_equal({'c_key' => 'c_value', 'd_key' => 1}, a)
a = Hash[]
assert_equal({}, a)
assert_raise(ArgumentError) do
Hash['d_key']
end
end
assert('Hash.[] for sub class') do
sub_hash_class = Class.new(Hash)
sub_hash = sub_hash_class[]
assert_equal(sub_hash_class, sub_hash.class)
end
assert('Hash#merge!') do
a = { 'abc_key' => 'abc_value', 'cba_key' => 'cba_value' }
b = { 'cba_key' => 'XXX', 'xyz_key' => 'xyz_value' }
result_1 = a.merge! b
a = { 'abc_key' => 'abc_value', 'cba_key' => 'cba_value' }
result_2 = a.merge!(b) do |key, original, new|
original
end
assert_equal({'abc_key' => 'abc_value', 'cba_key' => 'XXX',
'xyz_key' => 'xyz_value' }, result_1)
assert_equal({'abc_key' => 'abc_value', 'cba_key' => 'cba_value',
'xyz_key' => 'xyz_value' }, result_2)
assert_raise(TypeError) do
{ 'abc_key' => 'abc_value' }.merge! "a"
end
end
assert('Hash#values_at') do
h = { "cat" => "feline", "dog" => "canine", "cow" => "bovine" }
assert_equal ["bovine", "feline"], h.values_at("cow", "cat")
keys = []
(0...1000).each { |v| keys.push "#{v}" }
h = Hash.new { |hash,k| hash[k] = k }
assert_equal keys, h.values_at(*keys)
end
assert('Hash#compact') do
h = { "cat" => "feline", "dog" => nil, "cow" => false }
assert_equal({ "cat" => "feline", "cow" => false }, h.compact)
assert_equal({ "cat" => "feline", "dog" => nil, "cow" => false }, h)
end
assert('Hash#compact!') do
h = { "cat" => "feline", "dog" => nil, "cow" => false }
h.compact!
assert_equal({ "cat" => "feline", "cow" => false }, h)
end
assert('Hash#fetch') do
h = { "cat" => "feline", "dog" => "canine", "cow" => "bovine" }
assert_equal "feline", h.fetch("cat")
assert_equal "mickey", h.fetch("mouse", "mickey")
assert_equal "minny", h.fetch("mouse"){"minny"}
assert_equal "mouse", h.fetch("mouse"){|k| k}
assert_raise(KeyError) do
h.fetch("gnu")
end
end
assert("Hash#delete_if") do
base = { 1 => 'one', 2 => false, true => 'true', 'cat' => 99 }
h1 = { 1 => 'one', 2 => false, true => 'true' }
h2 = { 2 => false, 'cat' => 99 }
h3 = { 2 => false }
h = base.dup
assert_equal(h, h.delete_if { false })
assert_equal({}, h.delete_if { true })
h = base.dup
assert_equal(h1, h.delete_if {|k,v| k.instance_of?(String) })
assert_equal(h1, h)
h = base.dup
assert_equal(h2, h.delete_if {|k,v| v.instance_of?(String) })
assert_equal(h2, h)
h = base.dup
assert_equal(h3, h.delete_if {|k,v| v })
assert_equal(h3, h)
h = base.dup
n = 0
h.delete_if {|*a|
n += 1
assert_equal(2, a.size)
assert_equal(base[a[0]], a[1])
h.shift
true
}
assert_equal(base.size, n)
end
assert("Hash#flatten") do
a = {1=> "one", 2 => [2,"two"], 3 => [3, ["three"]]}
assert_equal [1, "one", 2, [2, "two"], 3, [3, ["three"]]], a.flatten
assert_equal [[1, "one"], [2, [2, "two"]], [3, [3, ["three"]]]], a.flatten(0)
assert_equal [1, "one", 2, [2, "two"], 3, [3, ["three"]]], a.flatten(1)
assert_equal [1, "one", 2, 2, "two", 3, 3, ["three"]], a.flatten(2)
assert_equal [1, "one", 2, 2, "two", 3, 3, "three"], a.flatten(3)
end
assert("Hash#invert") do
h = { 1 => 'one', 2 => 'two', 3 => 'three',
true => 'true', nil => 'nil' }.invert
assert_equal 1, h['one']
assert_equal true, h['true']
assert_equal nil, h['nil']
h = { 'a' => 1, 'b' => 2, 'c' => 1 }.invert
assert_equal(2, h.length)
assert_include(%w[a c], h[1])
assert_equal('b', h[2])
end
assert("Hash#invert with sub class") do
sub_hash_class = Class.new(Hash)
sub_hash = sub_hash_class.new
assert_equal(sub_hash_class, sub_hash.invert.class)
end
assert("Hash#keep_if") do
h = { 1 => 2, 3 => 4, 5 => 6 }
assert_equal({3=>4,5=>6}, h.keep_if {|k, v| k + v >= 7 })
h = { 1 => 2, 3 => 4, 5 => 6 }
assert_equal({ 1 => 2, 3=> 4, 5 =>6} , h.keep_if { true })
end
assert("Hash#key") do
h = { "a" => 100, "b" => 200, "c" => 300, "d" => 300, nil => 'nil', 'nil' => nil }
assert_equal "b", h.key(200)
assert_equal "c", h.key(300)
assert_nil h.key(999)
assert_nil h.key('nil')
assert_equal 'nil', h.key(nil)
end
assert("Hash#to_h") do
h = { "a" => 100, "b" => 200 }
assert_equal Hash, h.to_h.class
assert_equal h, h.to_h
end
assert('Hash#<') do
h1 = {a:1, b:2}
h2 = {a:1, b:2, c:3}
assert_false(h1 < h1)
assert_true(h1 < h2)
assert_false(h2 < h1)
assert_false(h2 < h2)
h1 = {a:1}
h2 = {a:2}
assert_false(h1 < h1)
assert_false(h1 < h2)
assert_false(h2 < h1)
assert_false(h2 < h2)
end
assert('Hash#<=') do
h1 = {a:1, b:2}
h2 = {a:1, b:2, c:3}
assert_true(h1 <= h1)
assert_true(h1 <= h2)
assert_false(h2 <= h1)
assert_true(h2 <= h2)
h1 = {a:1}
h2 = {a:2}
assert_true(h1 <= h1)
assert_false(h1 <= h2)
assert_false(h2 <= h1)
assert_true(h2 <= h2)
end
assert('Hash#>=') do
h1 = {a:1, b:2}
h2 = {a:1, b:2, c:3}
assert_true(h1 >= h1)
assert_false(h1 >= h2)
assert_true(h2 >= h1)
assert_true(h2 >= h2)
h1 = {a:1}
h2 = {a:2}
assert_true(h1 >= h1)
assert_false(h1 >= h2)
assert_false(h2 >= h1)
assert_true(h2 >= h2)
end
assert('Hash#>') do
h1 = {a:1, b:2}
h2 = {a:1, b:2, c:3}
assert_false(h1 > h1)
assert_false(h1 > h2)
assert_true(h2 > h1)
assert_false(h2 > h2)
h1 = {a:1}
h2 = {a:2}
assert_false(h1 > h1)
assert_false(h1 > h2)
assert_false(h2 > h1)
assert_false(h2 > h2)
end
assert("Hash#dig") do
h = {a:{b:{c:1}}}
assert_equal(1, h.dig(:a, :b, :c))
assert_nil(h.dig(:d))
end
assert("Hash#transform_keys") do
h = {"1" => 100, "2" => 200}
assert_equal({"1!" => 100, "2!" => 200},
h.transform_keys{|k| k+"!"})
assert_equal({1 => 100, 2 => 200},
h.transform_keys{|k|k.to_i})
assert_same(h, h.transform_keys!{|k|k.to_i})
assert_equal({1 => 100, 2 => 200}, h)
end
assert("Hash#transform_values") do
h = {a: 1, b: 2, c: 3}
assert_equal({a: 2, b: 5, c: 10},
h.transform_values{|v| v * v + 1})
assert_equal({a: "1", b: "2", c: "3"},
h.transform_values{|v|v.to_s})
assert_same(h, h.transform_values!{|v|v.to_s})
assert_equal({a: "1", b: "2", c: "3"}, h)
end
assert("Hash#slice") do
h = { a: 100, b: 200, c: 300 }
assert_equal({:a=>100}, h.slice(:a))
assert_equal({:b=>200, :c=>300}, h.slice(:b, :c, :d))
end