mug 0.2.6 → 0.2.7

data/lib/mug.rb

@@ -3,6 +3,7 @@ require_relative 'mug/and-or'
 require_relative 'mug/apply'
 require_relative 'mug/array/extend'
 require_relative 'mug/bool'
+require_relative 'mug/clamp'
 require_relative 'mug/counts'
 require_relative 'mug/fragile-method-chain'
 require_relative 'mug/hash/map'

data/lib/mug/clamp.rb

@@ -0,0 +1,62 @@
+
+class Numeric
+
+	#
+	# Clamps num so that lower <= new_num <= higher.
+	#
+	# Returns lower when num < lower, higher when num > higher, otherwise
+	# num itself.
+	#
+	# Raises an exception if lower > higher
+	#
+	def clamp lower, higher=nil
+		return lower.bound(self) if lower.is_a?(Range) && higher.nil?
+		raise ArgumentError, 'range must not be negative' if lower > higher
+		[[lower, self].max, higher].min
+	end
+
+end
+
+class Range
+
+	#
+	# Bounds val so that first <= new_val <= last.
+	#
+	# Returns first when val < first, last when val > last, otherwise
+	# val itself.
+	#
+	# Raises an exception if val >= end and the range is exclusive.
+	#
+	def bound val
+		a = first
+		return a if val < a
+
+		b = last
+		if val >= b
+			if exclude_end?
+				raise ArgumentError, 'more than or equal to the exclusive range'
+			end
+			return b
+		end
+
+		val
+	end
+
+end
+
+=begin
+Copyright (c) 2014, 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/test/test-clamp.rb

@@ -0,0 +1,51 @@
+require 'test/unit'
+$VERBOSE = true
+
+require_relative '../lib/mug/clamp'
+class Test_clamp < Test::Unit::TestCase
+
+	def test_clamp
+		[
+			[2,3],
+			[3,3],
+			[4,4],
+			[5,5],
+			[6,5],
+		].each do |num, ex|
+			assert_equal( ex, num.clamp(3,5) )
+		end
+		assert_raise(ArgumentError) { 0.clamp(5,3) }
+	end
+
+	def test_clamp__range
+		rng = 3..5
+		assert_equal( 3, 2.clamp(rng) )
+		assert_equal( 4, 4.clamp(rng) )
+		assert_equal( 5, 6.clamp(rng) )
+
+		rng = 3...5
+		assert_equal( 3, 2.clamp(rng) )
+		assert_equal( 4, 4.clamp(rng) )
+		assert_raise(ArgumentError) { 6.clamp(rng) }
+	end
+
+	def test_bound__inclusive
+		rng = 3..5
+		assert_equal( 3, rng.bound(2) )
+		assert_equal( 3, rng.bound(3) )
+		assert_equal( 4, rng.bound(4) )
+		assert_equal( 5, rng.bound(5) )
+		assert_equal( 5, rng.bound(6) )
+	end
+
+	def test_bound__exclusive
+		rng = 3...5
+		assert_equal( 3, rng.bound(2) )
+		assert_equal( 3, rng.bound(3) )
+		assert_equal( 4, rng.bound(4) )
+		assert_raise(ArgumentError) { rng.bound(5) }
+		assert_raise(ArgumentError) { rng.bound(6) }
+	end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mug
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-01 00:00:00.000000000 Z
+date: 2014-12-15 00:00:00.000000000 Z
 dependencies: []
 description: ! '== MUG: Matty''s Ultimate Gem
 
@@ -36,6 +36,7 @@ files:
 - lib/mug/iterator/method.rb
 - lib/mug/hash.rb
 - lib/mug/maybe.rb
+- lib/mug/clamp.rb
 - lib/mug/self.rb
 - lib/mug/array.rb
 - lib/mug/apply.rb
@@ -51,6 +52,7 @@ files:
 - lib/mug.rb
 - test/test-and-or.rb
 - test/test-hashop.rb
+- test/test-clamp.rb
 - test/test-iterator-for.rb
 - test/test-hashmap.rb
 - test/test-tau.rb
@@ -93,6 +95,7 @@ summary: ! 'MUG: Matty''s Ultimate Gem'
 test_files:
 - test/test-and-or.rb
 - test/test-hashop.rb
+- test/test-clamp.rb
 - test/test-iterator-for.rb
 - test/test-hashmap.rb
 - test/test-tau.rb