mug 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62f380b7208bcca73fc03c01f9e768635cd86db6
-  data.tar.gz: 5c6fda3e95d3b1cf91a433e598bcccbe435647a2
+  metadata.gz: c0edc2446a16fda4757caa14b0fda411f56cd579
+  data.tar.gz: 7282d21792083c5b6702933c248be85b188bdf4e
 SHA512:
-  metadata.gz: ecb3583f89035c101ef30645cd188c2d1927901dbb4e0ab6f3e3db8d924e053b28de09ffc82834fa3300b18ff158958515c0c45a6240d039294006abf53c01b5
-  data.tar.gz: 55c48683d37e24b974982e5bd4f039e63df00b04fe7427b172932385f1df94001e829407f87446d29c8272b682fb4dc3946aa253761d85ab0265f1201df647bc
+  metadata.gz: 6287a2a374fffb41434813eaeeebf7f5e8336e2d9f099fda1d81842ff94fbe0f0b0bae9816dfeb2cedb72e3982a0058237964e8743b6841c1710a43fc75f94f7
+  data.tar.gz: eaa5258cba1132392718fcfaa5982396d8ef0a646c537c8f383643cd3720fbaa69ecca97adc8e7fa3b53b21152ce86c6d9161169b3ad41090d135d89bb211293

data/lib/mug.rb

@@ -4,6 +4,7 @@ require_relative 'mug/any-and-all'
 require_relative 'mug/apply'
 require_relative 'mug/array/extend'
 require_relative 'mug/array/minus'
+require_relative 'mug/array/samples'
 require_relative 'mug/bool'
 require_relative 'mug/clamp'
 require_relative 'mug/counts'

data/lib/mug/array.rb

@@ -1,2 +1,3 @@
 require_relative 'array/extend'
 require_relative 'array/minus'
+require_relative 'array/samples'

data/lib/mug/array/samples.rb

@@ -0,0 +1,56 @@
+
+class Array
+
+  #
+  # Choose a random subset of elements from the array.
+  #
+  # The elements are chosen by using random and unique indices into the
+  # array in order to ensure that an element doesn't repeat itself
+  # unless the array already contained duplicate elements.
+  #
+  # If the array is empty, always returns an empty array.
+  #
+  # The optional +min+ and +max+ arguments restrict the size of the
+  # returned array.  +min+ must be >= 0, and +max+ must be >= +min+.
+  # (Both values are clamped to the size of the array.)
+  #
+  # The optional +random+ argument will be used as the random number
+  # generator.
+  #
+  def samples min: nil, max: nil, random: nil
+    min = 1 if min.nil?
+    min = length if min > length
+
+    max = length if max.nil?
+    max = length if max > length
+
+    raise ArgumentError, "min must be >= 0 (#{min})" if min < 0
+    raise ArgumentError, "min (#{min}) must be <= max (#{max})" if min > max
+
+    if random
+      n = random.rand(min..max)
+      sample n, random: random
+    else
+      n = rand(min..max)
+      sample n
+    end
+  end
+
+end
+
+=begin
+Copyright (c) 2016, 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-array-samples.rb

@@ -0,0 +1,92 @@
+require 'test/unit'
+$VERBOSE = true
+
+$ARRAY = proc { 8.times.to_a }
+$TRIES = 40320 # 8 factorial
+$MIN = 4
+$MAX = 6
+
+class MyPRNG
+  def rand n
+    case n
+    when Integer
+      n - 1
+    when Range
+      n.max
+    end
+  end
+end
+
+require_relative '../lib/mug/array/samples'
+class Test_array_extend < Test::Unit::TestCase
+  def test_samples
+    a = $ARRAY.call
+    $TRIES.times do
+      s = a.samples
+      assert( s.length >= 1 )
+      assert( s.length <= a.length )
+      assert( s.uniq == s )
+      assert( s.all? {|n| a.include? n } )
+    end
+  end
+  def test_samples_min
+    a = $ARRAY.call
+    # successes
+    $TRIES.times do
+      s = a.samples( :min => $MIN )
+      assert( s.length >= $MIN )
+      assert( s.length <= a.length )
+      assert( s.uniq == s )
+      assert( s.all? {|n| a.include? n } )
+    end
+    # failures
+    assert_raise( ArgumentError ) { a.samples( :min => -1 ) }
+  end
+  def test_samples_max
+    a = $ARRAY.call
+    # successes
+    $TRIES.times do
+      s = a.samples( :max => $MAX )
+      assert( s.length >= 1 )
+      assert( s.length <= $MAX )
+      assert( s.uniq == s )
+      assert( s.all? {|n| a.include? n } )
+    end
+    # failures
+    assert_raise( ArgumentError ) { a.samples( :max => -1 ) }
+  end
+  def test_samples_minmax
+    a = $ARRAY.call
+    # successes
+    $TRIES.times do
+      s = a.samples( :min => $MIN, :max => $MAX )
+      assert( s.length >= $MIN )
+      assert( s.length <= $MAX )
+      assert( s.uniq == s )
+      assert( s.all? {|n| a.include? n } )
+    end
+    # failures
+    assert_raise( ArgumentError ) { a.samples( :min => $MAX, :max => $MIN ) }
+  end
+  def test_samples_random
+    a = $ARRAY.call
+    $TRIES.times do
+      s = a.samples( :random => Random.new )
+      assert( s.length >= 1 )
+      assert( s.length <= a.length )
+      assert( s.uniq == s )
+      assert( s.all? {|n| a.include? n } )
+    end
+  end
+  def test_samples_random2
+    a = $ARRAY.call
+    $TRIES.times do
+      s = a.samples( :random => MyPRNG.new )
+      assert( s.length >= 1 )
+      assert( s.length <= a.length )
+      assert( s.uniq == s )
+      assert( s.all? {|n| a.include? n } )
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mug
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Matthew Kerwin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2016-09-21 00:00:00.000000000 Z
 dependencies: []
 description: |
   == MUG: Matty's Ultimate Gem
@@ -29,6 +29,7 @@ files:
 - lib/mug/array.rb
 - lib/mug/array/extend.rb
 - lib/mug/array/minus.rb
+- lib/mug/array/samples.rb
 - lib/mug/bool.rb
 - lib/mug/clamp.rb
 - lib/mug/counts.rb
@@ -61,6 +62,7 @@ files:
 - test/test-apply.rb
 - test/test-array-extend.rb
 - test/test-array-minus.rb
+- test/test-array-samples.rb
 - test/test-bool.rb
 - test/test-clamp.rb
 - test/test-counts.rb
@@ -126,6 +128,7 @@ test_files:
 - test/test-hashmap.rb
 - test/test-loop-with.rb
 - test/test-maybe.rb
+- test/test-array-samples.rb
 - test/test-hashop.rb
 - test/test-iterator-method.rb
 - test/test-apply.rb