mug 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 176afb1c7d977358227e76adffe6aa5651790298
-  data.tar.gz: 53f517bf29dcdf3ada2b4cdfede2d250b17e97cb
+  metadata.gz: f3ad7fb03114e7062b93539759918f1ebbe542a9
+  data.tar.gz: 35ffe2f0573509eced89ea9e2b73efb991cbd619
 SHA512:
-  metadata.gz: 60af159ec430300b58fae685df79eaeda031499c9b0f6ab092301edcec48e5560bb64ba2bd713130380266a9011449dc4946c8bd512aaed9d7099c2f96217a72
-  data.tar.gz: 654b5b73f1da2c2642c01ee5c75569c9aeeafb2cb86ca70c108746ff9dc6a99277fdfe1c1c4909f7d460477f5bcd8519cba8e06c32374a444d2e1f5efadf0c17
+  metadata.gz: be694ddef15890b59a471dcea87d24f1b9df9da15c89d0d69c4c1c3786bd3f3c0bff56b876b06ecad0e4c439552610c81d2be46cd527a494b16749ffb7ff7510
+  data.tar.gz: 524a47ce38c90eabea52a6659154cbe08869a5f59b1ba6230f0b17d48c0fd9e1f6ccb5739d95fd6e8edd5f0227365644a07647039691fc072c01a311077c7ba8

data/lib/mug/bool.rb

@@ -110,3 +110,19 @@ class Exception
 	end
 end
 
+=begin
+Copyright (c) 2013, Matthew Kerwin <matthew@kerwin.net.au>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+=end
+

data/lib/mug/fragile-method-chain.rb

@@ -51,3 +51,20 @@ class Object
 		FragileMethodChain.new(self)
 	end
 end
+
+=begin
+Copyright (c) 2013, Matthew Kerwin <matthew@kerwin.net.au>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+=end
+

data/lib/mug/hashmap.rb

@@ -0,0 +1,100 @@
+
+class Hash
+	#
+	# Returns a new hash which is a copy of the current hash but each
+	# value is replaced by the result of running it through +block+.
+	#
+	#   {'a'=>1, 'b'=>2}.map_values { |v| v*2 } #=> {'a'=>2, 'b'=>4}
+	#   {'a'=>1, 'b'=>2}.map_values { "cat" }   #=> {'a'=>"cat", 'b'=>"cat"}
+	#
+	def map_values &block # :yields: value
+		hsh = {}
+		each do |k, v|
+			hsh[k] = yield v
+		end
+		hsh
+	end
+
+	#
+	# Replaces the values in +hsh+ by running them each through +block+.
+	#
+	# See: #map_values
+	#
+	def map_values! &block # :yields: value
+		replace map_values(&block)
+	end
+
+	#
+	# Returns a new hash which is a copy of the current hash but each
+	# key is replaced by the result of running it through +block+.
+	#
+	# If +block+ returns duplicate keys, they will be overwritten in
+	# the resulting hash.
+	#
+	#   {'a'=>1, 'b'=>2}.map_keys { |k| k*2 } #=> {'aa'=>1, 'bb'=>2}
+	#   {'a'=>1, 'b'=>2}.map_keys { "cat" }   #=> {'cat'=>2}
+	#
+	def map_keys &block # :yields: key
+		hsh = {}
+		each do |k, v|
+			hsh[ yield k ] = v
+		end
+		hsh
+	end
+
+	#
+	# Replaces the keys in +hsh+ by running them each through +block+.
+	#
+	# If +block+ returns duplicate keys, they will be overwritten in turn.
+	#
+	# See: #map_keys
+	#
+	def map_keys! &block # :yields: key
+		replace map_keys(&block)
+	end
+
+	#
+	# Returns a new hash which is a copy of the current hash but each
+	# key-value pair is replaced by the result of running it through +block+.
+	#
+	# If +block+ returns duplicate keys, they will be overwritten in
+	# the resulting hash.
+	#
+	#   {'a'=>1, 'b'=>2}.map_pairs { |k,v| [k*2, v+1] } #=> {'aa'=>2, 'bb'=>3}
+	#   {'a'=>1, 'b'=>2}.map_pairs { ["cat","dog"] }   #=> {'cat'=>'dog'}
+	#
+	def map_pairs &block # :yields: key, value
+		hsh = {}
+		each do |k, v|
+			a, b = yield k, v
+			hsh[a] = b
+		end
+		hsh
+	end
+
+	#
+	# Replaces the values in +hsh+ by running them each through +block+.
+	#
+	# See: #map_values
+	#
+	def map_pairs! &block # :yields: key, value
+		replace map_pairs(&block)
+	end
+end
+
+=begin
+Copyright (c) 2013, Matthew Kerwin <matthew@kerwin.net.au>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+=end
+

data/lib/mug/iterator/for.rb

@@ -10,3 +10,20 @@ class Object
 	end
 	alias :to_iter :iter_for
 end
+
+=begin
+Copyright (c) 2013, Matthew Kerwin <matthew@kerwin.net.au>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+=end
+

data/lib/mug/iterator/method.rb

@@ -10,3 +10,20 @@ class Method
 		Iterator.new receiver, name, *args
 	end
 end
+
+=begin
+Copyright (c) 2013, Matthew Kerwin <matthew@kerwin.net.au>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+=end
+

data/lib/mug/iterator_c.rb

@@ -25,3 +25,20 @@ class Iterator < Enumerator
 		end
 	end
 end
+
+=begin
+Copyright (c) 2013, Matthew Kerwin <matthew@kerwin.net.au>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+=end
+

data/lib/mug/maybe.rb

@@ -40,3 +40,20 @@ class Object
 		end
 	end
 end
+
+=begin
+Copyright (c) 2013, Matthew Kerwin <matthew@kerwin.net.au>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+=end
+

data/lib/mug/self.rb

@@ -14,3 +14,20 @@ class Object
 		end
 	end
 end
+
+=begin
+Copyright (c) 2013, Matthew Kerwin <matthew@kerwin.net.au>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+=end
+

data/lib/mug/to_h.rb

@@ -0,0 +1,44 @@
+
+unless {}.respond_to? :to_h
+	warn %|Warning: "mug/to_h" does not make much sense without "to_h" (https://rubygems.org/gems/to_h)|
+end
+
+module Enumerable
+	#
+	# Converts +enum+ to a Hash.
+	#
+	# Each element of +enum+ must be a single item, or an array of two items.
+	# Duplicate keys are overwritten in order.
+	#
+	#    [].to_h             #=> {}
+	#    [1,2].to_h          #=> {1=>nil, 2=>nil}
+	#    (1..2).to_h         #=> {1=>nil, 2=>nil}
+	#    [[1,2],[3,4]].to_h  #=> {1=>2, 3=>4}
+	#    [[1,2],[1,4]].to_h  #=> {1=>4}
+	#
+	def to_h
+		hsh = {}
+		each do |k,v,*x|
+			raise ArgumentError, "invalid number of elements (#{x.length+1} for 1..2)" if x.any?
+			hsh[k] = v
+		end
+		hsh
+	end
+end
+
+=begin
+Copyright (c) 2013, Matthew Kerwin <matthew@kerwin.net.au>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+=end
+

data/lib/mug.rb

@@ -1,7 +1,10 @@
 
 require_relative 'mug/bool'
+require_relative 'mug/hashmap'
 require_relative 'mug/fragile-method-chain'
 require_relative 'mug/iterator/for'
 require_relative 'mug/iterator/method'
 require_relative 'mug/maybe'
 require_relative 'mug/self'
+require_relative 'mug/to_h'
+

data/test/test-hashmap.rb

@@ -0,0 +1,24 @@
+require 'test/unit'
+$VERBOSE = true
+
+if RUBY_VERSION.to_f < 1.9
+	class Symbol
+		def next
+			to_s.next.to_sym
+		end
+	end
+end
+
+require_relative '../lib/mug/hashmap'
+class Test_hashmap < Test::Unit::TestCase
+	def test_hashmap
+		h        = {'s'=>1, :x=>2, 3=>'a'}
+		h_k_next = {'t'=>1, :y=>2, 4=>'a'}
+		h_v_next = {'s'=>2, :x=>3, 3=>'b'}
+		h_p_next = {'t'=>2, :y=>3, 4=>'b'}
+		assert_equal( h_k_next, h.map_keys  {|k| k.next } )
+		assert_equal( h_v_next, h.map_values{|v| v.next } )
+		assert_equal( h_p_next, h.map_pairs {|k,v| [k.next,v.next] } )
+	end
+end
+

data/test/test-to_h.rb

@@ -0,0 +1,15 @@
+require 'test/unit'
+
+$VERBOSE = true
+require_relative '../lib/mug/to_h'
+class Test_enum_to_h < Test::Unit::TestCase
+	def test_enum_to_h
+		assert_equal( {}, [].to_h )
+		assert_equal( {1=>nil,2=>nil}, [1,2].to_h )
+		assert_equal( {1=>nil,2=>nil}, (1..2).to_h )
+		assert_equal( {1=>2,3=>4}, [[1,2],[3,4]].to_h )
+		assert_equal( {1=>4}, [[1,2],[1,4]].to_h )
+		assert_raise(ArgumentError) { [[1,2,3]].to_h }
+	end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mug
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Matthew Kerwin
@@ -21,6 +21,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/mug.rb
+- lib/mug/hashmap.rb
+- lib/mug/to_h.rb
 - lib/mug/fragile-method-chain.rb
 - lib/mug/self.rb
 - lib/mug/iterator.rb
@@ -31,10 +33,12 @@ files:
 - lib/mug/bool.rb
 - test/test-self.rb
 - test/test-bool.rb
+- test/test-to_h.rb
 - test/test-fragile-method-chain.rb
 - test/test-iterator-method.rb
 - test/test-iterator-for.rb
 - test/test-maybe.rb
+- test/test-hashmap.rb
 homepage: http://phluid61.github.com/mug
 licenses:
 - ISC License
@@ -62,7 +66,9 @@ summary: 'MUG: Matty''s Ultimate Gem'
 test_files:
 - test/test-self.rb
 - test/test-bool.rb
+- test/test-to_h.rb
 - test/test-fragile-method-chain.rb
 - test/test-iterator-method.rb
 - test/test-iterator-for.rb
 - test/test-maybe.rb
+- test/test-hashmap.rb