mug 0.1.0 → 0.2.0

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

@@ -1,70 +1,70 @@
-
-#
-# Invokes a method chain until one method returns a falsy value.
-#
-# For example:
-#
-#     a._?.b.c.d._!
-#     nested_hash._?[:a][:b][:c]._!
-#
-class FragileMethodChain
-	#
-	# Creates a FragileMethodChain which will send its first method to +o+
-	#
-	def initialize o
-		@o = o
-		@chain = []
-	end
-
-	#
-	# Finalises the FragileMethodChain.
-	#
-	# The final result will be the first +nil+ or +false+ value
-	# returned in the chain, or its end result.
-	#
-	def _!
-		@chain.inject(@o) do |o,x|
-			a,b = x
-			break o unless o
-			o.__send__(*a, &b)
-		end
-	end
-
-	# Record the method args/block
-	def method_missing *a, &b #:nodoc:
-		@chain << [a,b]
-		self
-	end
-
-	# Explicitly record :_? as a method in the chain.
-	def _? #:nodoc:
-		@chain << [[ :_? ],nil]
-		self
-	end
-end
-
-class Object
-	#
-	# Begins a FragileMethodChain.
-	#
-	def _?
-		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
-
+
+#
+# Invokes a method chain until one method returns a falsy value.
+#
+# For example:
+#
+#     a._?.b.c.d._!
+#     nested_hash._?[:a][:b][:c]._!
+#
+class FragileMethodChain
+	#
+	# Creates a FragileMethodChain which will send its first method to +o+
+	#
+	def initialize o
+		@o = o
+		@chain = []
+	end
+
+	#
+	# Finalises the FragileMethodChain.
+	#
+	# The final result will be the first +nil+ or +false+ value
+	# returned in the chain, or its end result.
+	#
+	def _!
+		@chain.inject(@o) do |o,x|
+			a,b = x
+			break o unless o
+			o.__send__(*a, &b)
+		end
+	end
+
+	# Record the method args/block
+	def method_missing *a, &b #:nodoc:
+		@chain << [a,b]
+		self
+	end
+
+	# Explicitly record :_? as a method in the chain.
+	def _? #:nodoc:
+		@chain << [[ :_? ],nil]
+		self
+	end
+end
+
+class Object
+	#
+	# Begins a FragileMethodChain.
+	#
+	def _?
+		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/hash.rb

@@ -0,0 +1,2 @@
+require_relative 'hash/map'
+require_relative 'hash/operations'

data/lib/mug/hash/map.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/hash/operations.rb

@@ -0,0 +1,54 @@
+
+class Hash
+
+	#
+	# Returns a new Hash, whose value is the same as this
+	# one, with any extras in +other_hash+ added in.
+	#
+	# Useful for default options.
+	#
+	# Example:
+	#     opts = {:a => 1, :b => 2 }
+	#     dflt = {:a => 0, :x => 9 }
+	#     opts |= dflt # => opts = {:a=>1, :b=>2, :x=>9}
+	#
+	def | other_hash
+		other_hash.merge self
+	end
+
+	#
+	# Adds the contents of +other_hash+ to +hsh+.
+	# Entries with duplicate keys are overwritten with the
+	# values from +other_hash+
+	#
+	def + other_hash
+		merge other_hash
+	end
+
+	#
+	# Appends stuff to the hash.
+	#
+	# If +o+ is a Hash, this is identical to calling #merge!
+	# If +o+ is an Array with two elements, it is interpreted as [key,value]
+	# If +o+ can be converted to a hash with #to_h, this is identical to calling #merge!
+	# Otherwise an ArgumentError is raised.
+	#
+	# Example:
+	#     h = {}
+	#     h << {:a=>0}       # h = {:a=>0}
+	#     h << {:b=>2,:c=>3} # h = {:a=>0,:b=>2,:c=>3}
+	#     h << [:a,1]        # h = {:a=>1,:b=>2,:c=>3}
+	#
+	def << o
+		if o.respond_to? :to_hash
+			merge! o.to_hash
+		elsif o.respond_to?(:to_a) && (a = o.to_a) && a.length == 2
+			tap { store a[0], a[1] }
+		elsif o.respond_to? :to_h
+			merge! o.to_h
+		else
+			raise ArgumentError, "#{o.class.name} is not a Hash"
+		end
+	end
+end
+

data/lib/mug/hashmap.rb

@@ -1,100 +1,2 @@
-
-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
-
+warn 'mug/hashmap is deprecated, use /mug/hash/map'
+require_relative 'hash/map'

data/lib/mug/hashop.rb

@@ -1,54 +1,2 @@
-
-class Hash
-
-	#
-	# Returns a new Hash, whose value is the same as this
-	# one, with any extras in +other_hash+ added in.
-	#
-	# Useful for default options.
-	#
-	# Example:
-	#     opts = {:a => 1, :b => 2 }
-	#     dflt = {:a => 0, :x => 9 }
-	#     opts |= dflt # => opts = {:a=>1, :b=>2, :x=>9}
-	#
-	def | other_hash
-		other_hash.merge self
-	end
-
-	#
-	# Adds the contents of +other_hash+ to +hsh+.
-	# Entries with duplicate keys are overwritten with the
-	# values from +other_hash+
-	#
-	def + other_hash
-		merge other_hash
-	end
-
-	#
-	# Appends stuff to the hash.
-	#
-	# If +o+ is a Hash, this is identical to calling #merge!
-	# If +o+ is an Array with two elements, it is interpreted as [key,value]
-	# If +o+ can be converted to a hash with #to_h, this is identical to calling #merge!
-	# Otherwise an ArgumentError is raised.
-	#
-	# Example:
-	#     h = {}
-	#     h << {:a=>0}       # h = {:a=>0}
-	#     h << {:b=>2,:c=>3} # h = {:a=>0,:b=>2,:c=>3}
-	#     h << [:a,1]        # h = {:a=>1,:b=>2,:c=>3}
-	#
-	def << o
-		if o.respond_to? :to_hash
-			merge! o.to_hash
-		elsif o.respond_to?(:to_a) && (a = o.to_a) && a.length == 2
-			tap { store a[0], a[1] }
-		elsif o.respond_to? :to_h
-			merge! o.to_h
-		else
-			raise ArgumentError, "#{o.class.name} is not a Hash"
-		end
-	end
-end
-
+warn 'mug/hashop is deprecated, use /mug/hash/operations'
+require_relative 'hash/operations'