hash-normalizekeys 1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f79ed0592697fd0613c1912b7c3c0bbe495525155eea2a4e00e69ce59685ed78
+  data.tar.gz: bdba8e1c44ecea82fa8f18c01fd8d95a1757d3b0ab3742ac9fcd82f1dd2a90cb
+SHA512:
+  metadata.gz: 7502d8e23034bb00305c17915b477e02e2cd815fb20e3e7557478dc0d14cb9cb93e39eecef44851faf33ce54ec263807539bac779a54af11576e33c2c98c4251
+  data.tar.gz: abdba210fbd7914a805afd18b3c2c2c45e439200be0a87a1a722bc2d95942e13cdc9d9406ce99120d4dfc5e9f952ad9c80926ff0fbfcc52af1c08f6e3ca8cae1

data/README.md

@@ -0,0 +1,38 @@
+# StringKeys
+
+A StringKeys object works like a hash, except keys which are not strings are
+converted to strings.
+
+```ruby
+require 'stringkeys'
+sk = StringKeys.new
+sk[:name] = 'Fred'
+sk.keys[0].class #=> String
+```
+
+The idea is simple. When a key comes in, whether for `[]` or `[]=`, if it is
+not a string, then its `.to_s` method is called and the result is used for the
+key. So the following lines produce identical results:
+
+```ruby
+sk[MyClass] = 1
+sk[:MyClass] = 1
+sk['MyClass'] = 1
+```
+
+# Installation
+
+```
+gem install stringkeys
+```
+
+## Author
+
+Mike O'Sullivan
+mike@idocs.com
+
+## History
+
+| version | date        | notes                                                 |
+|---------|-------------|-------------------------------------------------------|
+| 1.0     | Mar 1, 2020 | Initial upload.                                       |

data/lib/hash/normalizekeys.rb

@@ -0,0 +1,154 @@
+#===============================================================================
+# Hash::NormalizeKeys
+#
+class Hash::NormalizeKeys
+	# version
+	VERSION = '1.3'
+	
+	# new() takes the same params as Hash.new.
+	def initialize(*opts, &block)
+		@hsh = Hash.new(*opts, &block)
+	end
+	
+	# Returns the underlying hash's respond_to? method.
+	def respond_to?(m)
+		return @hsh.respond_to?(m)
+	end
+	
+	# Returns a new NormalizeKeys object by combining this object and the other
+	# object, with keys being normalized.
+	def merge(other)
+		rv = self.class.new
+		
+		# initialize with own elements
+		self.each do |k, v|
+			rv[k] = v
+		end
+		
+		# merge in other's elements
+		other.each do |k, v|
+			rv[k] = v
+		end
+		
+		# return
+		return rv
+	end
+	
+	# Merges other into the NormalizeKey object, with other's keys being normalized.
+	def merge!(other)
+		# merge in other's elements
+		other.each do |k, v|
+			self[k] = v
+		end
+		
+		# return
+		return self
+	end
+	
+	# works just like merge!
+	alias_method :update, :merge!
+	
+	# Works like Hash#replace, with keys being normalized.
+	def replace(other)
+		# reset @hsh
+		@hsh.clear
+		
+		# merge in other's elements
+		other.each do |k, v|
+			self[k] = v
+		end
+		
+		# return
+		return self
+	end
+	
+	# Works just like Hash#slice, except the key values are normalized.
+	def slice(*org_keys)
+		use_keys = {}
+		
+		org_keys.each do |org_key|
+			use_keys[self.class.normalize_key(org_key)] = nil
+		end
+		
+		return @hsh.slice(*use_keys.keys)
+	end
+	
+	# Returns the results of the underlying hash's to_s method.
+	def to_s
+		return @hsh.to_s
+	end
+	
+	# Works like Hash#invert, except the new object is a NormalizeKey object and
+	# the keys have been normalized.
+	def invert
+		rv = self.class.new
+		
+		self.each do |k, v|
+			rv[v] = k
+		end
+		
+		return rv
+	end
+	
+	# Works like Hash#values_at, except the key values are normalized.
+	def values_at(*keys)
+		rv = []
+		
+		keys.each do |key|
+			rv.push self[key]
+		end
+		
+		return rv
+	end
+	
+	# private
+	private
+	
+	# a list of methods that need the first param normalized
+	COERCES = %w(
+		[] []=
+		include? has_key? key? member?
+		fetch delete assoc dig store);
+	
+	# All methods not already defined are passed to @hsh. If the method is
+	# listed in COERCES then the first arg is normalized.
+	def method_missing(m, *args, &block)
+		if COERCES.include?(m.to_s) and (args.length > 0)
+			args = *args
+			args[0] = self.class.normalize_key(args[0])
+		end
+		
+		return @hsh.send(m, *args, &block)
+	end
+	
+	# normalize_key
+	def self.normalize_key(key)
+		raise 'override-normalize_key'
+	end
+end
+#
+# Hash::NormalizeKeys
+#===============================================================================
+
+
+#===============================================================================
+# Hash::NormalizeKeys::String
+#
+
+# An implementation of Hash::NormalizeKeys in which the keys are normalized
+# to strings.
+class Hash::NormalizeKeys::String < Hash::NormalizeKeys
+	private
+	
+	# normalize_key
+	def self.normalize_key(key)
+		if key.is_a?(String)
+			return key
+		else
+			key.to_s
+		end
+	end
+end
+#
+# Hash::NormalizeKeys::String
+#===============================================================================

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: hash-normalizekeys
+version: !ruby/object:Gem::Version
+  version: '1.3'
+platform: ruby
+authors:
+- Mike O'Sullivan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-02 00:00:00.000000000 Z
+dependencies: []
+description: Hash in which all keys are strings
+email: mike@idocs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/hash/normalizekeys.rb
+homepage: https://rubygems.org/gems/hash-normalizekeys
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Hash-like structure in which all keys are converted to strings
+test_files: []