mug 0.15.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ab045986d1359b99ba98c469e9c4411bd33a069f97ea5dc3115c51ad2aa5d5e
-  data.tar.gz: b799f0beab81b16671f1db4bc02bc24220faf12b00937ea3080ea7bb17a1f340
+  metadata.gz: be11c66cdcdc22f4149f088221fd1072fc075fe6b83ea3001a4c1c7d7a7398ce
+  data.tar.gz: 9df03bc1da33bbaed659ed753a83dbce4e72670f894038e3290d7732c9f38062
 SHA512:
-  metadata.gz: ec0dc68c7d86aeb4f6c648dd6756220c08054af4a2a3fd4770271d16268af0fb252a08c1b5214f2e5535d3af12b0fa4b178ebe8b0a833ec102bc0e767060dbb1
-  data.tar.gz: 61f278ae9b172c11f9eb6e405427f9f6186af5609ae8f42367a625a3488707194321d411b46a1f44b28a3e2b2f3b499d8aa9176d7676c3eeb1fab4ee65e65128
+  metadata.gz: 0f5598b332bf113018a53b725e9811c7335b3bebd3cbd92368c25556ee2cfbf4236c101e4b9b186a9b74a41d38af27f08e12c3fafe7c4393cbd5fab087150091
+  data.tar.gz: ea4760031f9dae9856b1e627e76525e1ef87666ec7cca298589bd264e4c2ab87e100883b2c87f9b2345885a752a036088992f7a1ed598ac8a6f6a78ab81bf027

data/lib/mug.rb

@@ -17,6 +17,7 @@ require_relative 'mug/hash/map'
 require_relative 'mug/hash/merge'
 require_relative 'mug/hash/operations'
 require_relative 'mug/hash/when'
+require_relative 'mug/iterator'
 require_relative 'mug/iterator/for'
 require_relative 'mug/iterator/method'
 require_relative 'mug/loop-with'

data/lib/mug/iterator.rb

@@ -1,2 +1,65 @@
-require_relative 'iterator/for'
-require_relative 'iterator/method'
+
+#
+# A special class of Enumerator that repeatedly yields values
+# to a block.
+#
+# The initial yielded value is given in the constructor, but in
+# subsequent iterations the result of the previous iteration is
+# yielded.
+#
+# Example:
+#
+#     0.iter_for(:next).take(5) #=> [1,2,3,4,5]
+#
+class Iterator < Enumerator
+  #
+  # Creates a new Iterator object, which can be used as an
+  # Enumerable.
+  #
+  # In the first form, iteration is defined by the given block,
+  # to which the current object and any other +args+ are yielded.
+  #
+  # In the second, deprecated, form, a generated Iterator sends the
+  # given method with any +args+ to the iterand.
+  #
+  # Use of this form is discourages.  Use Object#iter_for or
+  # Object#to_iter instead.
+  #
+  # @call-seq new(initial, *args) { |obj, *args| ... }
+  # @call-seq new(initial, method=:each, *args)
+  #
+  def initialize obj, *args
+    if block_given?
+      super() do |y|
+        loop do
+          y << (obj = yield obj, *args)
+        end
+      end
+    else
+      warn 'Iterator.new without a block is deprecated; use Object#to_iter'
+      args = [:each] if args.empty?
+      super() do |y|
+        loop do
+          y << (obj = obj.send(*args))
+        end
+      end
+    end
+  end
+end
+
+=begin
+Copyright (c) 2013-2018, 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

@@ -1,18 +1,20 @@
 
-require_relative '../iterator_c'
+require_relative '../iterator'
 
 class Object
   #
   # Creates a new Iterator for the method named +meth+
   #
   def iter_for meth, *args
-    Iterator.new self, meth, *args
+    Iterator.new(self) do |o|
+      o.send(meth, *args)
+    end
   end
   alias to_iter iter_for
 end
 
 =begin
-Copyright (c) 2013-2017, Matthew Kerwin <matthew@kerwin.net.au>
+Copyright (c) 2013-2018, 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

data/lib/mug/iterator/method.rb

@@ -1,5 +1,5 @@
 
-require_relative '../iterator_c'
+require_relative '../iterator'
 
 class Method
   #
@@ -7,12 +7,14 @@ class Method
   # on this method's receiver.
   #
   def to_iter *args
-    Iterator.new receiver, name, *args
+    Iterator.new(receiver) do |o|
+      o.send(name, *args)
+    end
   end
 end
 
 =begin
-Copyright (c) 2013, Matthew Kerwin <matthew@kerwin.net.au>
+Copyright (c) 2013-2018, 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

data/test/test-iterator-for.rb

@@ -5,14 +5,14 @@ require_relative '../lib/mug/iterator/for'
 class IterForTest < Test::Unit::TestCase
   def test_iter_for
     # Test on Integer#next => Integer
-    assert_equal([0, 1, 2, 3, 4], 0.iter_for(:next).take(5))
+    assert_equal([1, 2, 3, 4, 5], 0.iter_for(:next).take(5))
     # Test on String#succ => String
-    assert_equal(%w[a b c d e f g h i j], 'a'.iter_for(:succ).take(10))
+    assert_equal(%w[b c d e f g h i j k], 'a'.iter_for(:succ).take(10))
     # Test on Integer#inspect => String#inspect => String
-    assert_equal([1, "1", "\"1\""], 1.iter_for(:inspect).take(3))
+    assert_equal(["1", "\"1\""], 1.iter_for(:inspect).take(2))
   end
   def test_iter_for_args
     # Test with a parameter
-    assert_equal([0, 2, 4, 6, 8], 0.iter_for(:+, 2).take(5))
+    assert_equal([2, 4, 6, 8, 10], 0.iter_for(:+, 2).take(5))
   end
 end

data/test/test-iterator-method.rb

@@ -5,14 +5,14 @@ require_relative '../lib/mug/iterator/method'
 class MethodToIterTest < Test::Unit::TestCase
   def test_to_iter
     # Test on Integer#next => Integer
-    assert_equal([0, 1, 2, 3, 4], 0.method(:next).to_iter.take(5))
+    assert_equal([1, 2, 3, 4, 5], 0.method(:next).to_iter.take(5))
     # Test on String#succ => String
-    assert_equal(%w[a b c d e f g h i j], 'a'.method(:succ).to_iter.take(10))
+    assert_equal(%w[b c d e f g h i j k], 'a'.method(:succ).to_iter.take(10))
     # Test on Integer#inspect => String#inspect => String
-    assert_equal([1, "1", "\"1\""], 1.method(:inspect).to_iter.take(3))
+    assert_equal(["1", "\"1\""], 1.method(:inspect).to_iter.take(2))
   end
   def test_iter_for_args
     # Test with a parameter
-    assert_equal([0, 2, 4, 6, 8], 0.method(:+).to_iter(2).take(5))
+    assert_equal([2, 4, 6, 8, 10], 0.method(:+).to_iter(2).take(5))
   end
 end

data/test/test-iterator.rb

@@ -0,0 +1,17 @@
+require 'test/unit'
+$VERBOSE = true
+
+require_relative '../lib/mug/iterator'
+class IteratorTest < Test::Unit::TestCase
+  def test_iterator
+    iter = Iterator.new(0, 1) do |o, x|
+      o + x
+    end
+    assert_equal([1,2,3,4,5], iter.take(5))
+  end
+  def test_iterator2
+    # TODO: assert that this calls 'warn'?
+    iter = Iterator.new(0, :+, 1)
+    assert_equal([1,2,3,4,5], iter.take(5))
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mug
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Kerwin
@@ -53,7 +53,6 @@ files:
 - lib/mug/iterator.rb
 - lib/mug/iterator/for.rb
 - lib/mug/iterator/method.rb
-- lib/mug/iterator_c.rb
 - lib/mug/loop-with.rb
 - lib/mug/main.rb
 - lib/mug/matchdata.rb
@@ -91,6 +90,7 @@ files:
 - test/test-hashwhen.rb
 - test/test-iterator-for.rb
 - test/test-iterator-method.rb
+- test/test-iterator.rb
 - test/test-loop-with.rb
 - test/test-matchdata_each.rb
 - test/test-matchdata_hash.rb
@@ -127,36 +127,37 @@ signing_key:
 specification_version: 4
 summary: 'MUG: Matty''s Ultimate Gem'
 test_files:
-- test/test-enumerable-hash-like.rb
-- test/test-clamp.rb
-- test/test-array-delete_all.rb
+- test/test-fragile-method-chain.rb
+- test/test-maybe.rb
+- test/test-hashop.rb
+- test/test-not.rb
+- test/test-loop-with.rb
+- test/test-counts.rb
+- test/test-array-minus.rb
+- test/test-affix.rb
+- test/test-bool.rb
+- test/test-alias.rb
 - test/test-rexproc.rb
+- test/test-hashmerge.rb
+- test/test-array-samples.rb
 - test/test-tau.rb
-- test/test-matchdata_each.rb
-- test/test-alias.rb
+- test/test-apply.rb
+- test/test-any-and-all.rb
+- test/test-clamp.rb
+- test/test-iterator-for.rb
 - test/test-bittest.rb
 - test/test-hashwhen.rb
+- test/test-negativity.rb
+- test/test-array-delete_all.rb
+- test/test-iterator.rb
 - test/test-matchdata_hash.rb
-- test/test-not.rb
-- test/test-array-extend.rb
-- test/test-iterator-for.rb
-- test/test-top.rb
-- test/test-and-or.rb
-- test/test-array-to_proc.rb
-- test/test-affix.rb
-- test/test-hashmerge.rb
-- test/test-any-and-all.rb
 - test/test-self.rb
-- test/test-time.rb
-- test/test-counts.rb
-- test/test-negativity.rb
-- test/test-bool.rb
+- test/test-and-or.rb
 - test/test-hashmap.rb
-- test/test-loop-with.rb
-- test/test-maybe.rb
-- test/test-array-samples.rb
-- test/test-hashop.rb
+- test/test-enumerable-hash-like.rb
+- test/test-time.rb
+- test/test-matchdata_each.rb
 - test/test-iterator-method.rb
-- test/test-apply.rb
-- test/test-array-minus.rb
-- test/test-fragile-method-chain.rb
+- test/test-array-extend.rb
+- test/test-top.rb
+- test/test-array-to_proc.rb

data/lib/mug/iterator_c.rb

@@ -1,44 +0,0 @@
-
-#
-# A special class of Enumerator that repeatedly invokes a method.
-#
-# Initially the method is send to the given +obj+, but subsequent
-# invocations are sent to the result of the previous invocation.
-#
-# Example:
-#
-#     0.iter_for(:next).take(5) #=> [0,1,2,3,4]
-#
-class Iterator < Enumerator
-  #
-  # Creates a new Iterator for method +meth+, to be
-  # called initially on object +obj+.
-  #
-  # All method calls will have +args+ as parameters.
-  #
-  def initialize obj, meth, *args
-    super() do |y|
-      loop do
-        y << obj
-        obj = obj.send(meth, *args)
-      end
-    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
-