mug 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d07407afa937cc922025564e10c1dfd2a16535f2
-  data.tar.gz: 0391bcb1f0b93e59e852cf3bc1ba8eee0bc95e9d
+  metadata.gz: 17f7a48a6bfa945c6760d07cca504c9d368414b6
+  data.tar.gz: 3e6f798ad9030e7d8de51d805ea22092bed9af96
 SHA512:
-  metadata.gz: 0f8cea3e467019cdb61879a1d8bb87770e88f1796f2db4a93b692e092b3352a58438d81044ee59d9f8730512a8a85a4120c6f48141ee54713067f38e7f57fcd2
-  data.tar.gz: d7b36788bd623f2528a59b50929a940327ee656dbb8ad8f57c3a500f3b20738c5c1e7529a257121d388b7ae1735bd91b1b27a6e1adff2a8963ecd18a5511f1a4
+  metadata.gz: b35026ab417cc017594e49fdbcb042ec9319cf5918026ba57ffb5b5f208b4e8a7222f9e99cdb8ffd09951d4985df7a913420d0ce64e0a6b441a7c6add7b2f55a
+  data.tar.gz: 210d8afdc5f5ac618eb25fe5a0e79a92dc09e124c761448d4e224f0ae4068038782ef9528b8d4372799211f7513adc949e21fdb1c7a06bec03aa9dc548fe34a1

data/lib/mug.rb

@@ -12,6 +12,8 @@ require_relative 'mug/hash/operations'
 require_relative 'mug/iterator/for'
 require_relative 'mug/iterator/method'
 require_relative 'mug/loop-with'
+require_relative 'mug/matchdata/each'
+require_relative 'mug/matchdata/hash'
 require_relative 'mug/maybe'
 require_relative 'mug/negativity'
 require_relative 'mug/rexproc'

data/lib/mug/matchdata.rb

@@ -0,0 +1,2 @@
+require_relative 'matchdata/each'
+require_relative 'matchdata/hash'

data/lib/mug/matchdata/each.rb

@@ -0,0 +1,65 @@
+
+class MatchData
+
+	# Iterates over each capture group in the MatchData object,
+	# including +$&+ (the entire matched string), yielding the
+	# captured string.
+	def each &b
+		return enum_for(:each) unless block_given?
+		to_a.each{|v| yield v }
+	end
+
+	# Iterates over each capture group in the MatchData object,
+	# yielding the capture position and captured string.
+	#
+	# The capture positions are either all Strings or all Integers,
+	# depending on whether the original Regexp had named capture
+	# groups or not.
+	def each_capture &b
+		return enum_for(:each_capture) unless block_given?
+		if names.empty?
+			captures.each_with_index{|v,i| yield i+1, v }
+		else
+			names.each{|n| yield n, self[n] }
+		end
+	end
+
+	# Iterates over each named capture group in the MatchData object,
+	# yielding the capture name and string.
+	def each_named_capture &b
+		return enum_for(:each_named_capture) unless block_given?
+		names.each{|n| yield n, self[n] }
+	end
+
+	# Iterates over each positional capture group in the MatchData object,
+	# yielding the capture position and string.
+	#
+	# If +include_names+ is given and true, treats named captures
+	# as positional captures.
+	#
+	# WARNING: if mixing named and positional captures, no positional
+	# captures will be available using this method!
+	def each_positional_capture include_names: false, &b
+		return enum_for(:each_positional_capture, include_names: include_names) unless block_given?
+		return unless names.empty? || include_names
+		captures.each_with_index{|v,i| yield i+1, v }
+	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/lib/mug/matchdata/hash.rb

@@ -0,0 +1,51 @@
+
+class MatchData
+
+	# Returns a Hash object of capture position => captured string.
+	#
+	# The capture positions are either all Strings or all Integers,
+	# depending on whether the original Regexp had named capture
+	# groups or not.
+	def to_h
+		if names.empty?
+			Hash[ captures.each_with_index.map{|v,i| [i+1, v] } ]
+		else
+			Hash[ names.map{|n| [n, self[n]] } ]
+		end
+	end
+
+	# Returns a Hash object of capture name => captured string.
+	def named_captures
+		Hash[ names.map{|n| [n, self[n]] } ]
+	end
+
+	# Returns a Hash object of capture position => captured string.
+	#
+	# If +include_names+ is given and true, treats named captures
+	# as positional captures.
+	#
+	# WARNING: if mixing named and positional captures, no positional
+	# captures will be available using this method!
+	def positional_captures include_names: false
+		return {} unless names.empty? || include_names
+		Hash[ captures.each_with_index.map{|v,i| [i+1, v] } ]
+	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-matchdata_each.rb

@@ -0,0 +1,57 @@
+require 'test/unit'
+$VERBOSE = true
+
+require_relative '../lib/mug/matchdata/each'
+class Test_matchdata_each < Test::Unit::TestCase
+	def test__matchdata__each
+		str = 'a12b'
+		[
+			[/(    \d)(    \d)/x.match(str), %w[ 12 1 2 ]],
+			[/(?<x>\d)(?<y>\d)/x.match(str), %w[ 12 1 2 ]],
+			[/(    \d)(?<y>\d)/x.match(str), %w[ 12   2 ]], # ):
+		].each do |m, x|
+			assert_equal( x, m.each.to_a )
+		end
+	end
+	def test__matchdata__each_capture
+		str = 'a12b'
+		[
+			[/(    \d)(    \d)/x.match(str), [[ 1 ,'1'],[ 2 ,'2']]],
+			[/(?<x>\d)(?<y>\d)/x.match(str), [['x','1'],['y','2']]],
+			[/(    \d)(?<y>\d)/x.match(str), [          ['y','2']]], # ):
+		].each do |m, x|
+			assert_equal( x, m.each_capture.to_a )
+		end
+	end
+	def test__matchdata__each_named_capture
+		str = 'a12b'
+		[
+			[/(    \d)(    \d)/x.match(str), [                   ]],
+			[/(?<x>\d)(?<y>\d)/x.match(str), [['x','1'],['y','2']]],
+			[/(    \d)(?<y>\d)/x.match(str), [          ['y','2']]],
+		].each do |m, x|
+			assert_equal( x, m.each_named_capture.to_a )
+		end
+	end
+	def test__matchdata__each_positional_capture
+		str = 'a12b'
+		[
+			[/(    \d)(    \d)/x.match(str), [[ 1, '1'],[ 2 ,'2']]],
+			[/(?<x>\d)(?<y>\d)/x.match(str), [                   ]],
+			[/(    \d)(?<y>\d)/x.match(str), [                   ]], # D:
+		].each do |m, x|
+			assert_equal( x, m.each_positional_capture.to_a )
+		end
+	end
+	def test__matchdata__each_positional_capture2
+		str = 'a12b'
+		[
+			[/(    \d)(    \d)/x.match(str), [[ 1, '1'],[ 2 ,'2']]],
+			[/(?<x>\d)(?<y>\d)/x.match(str), [[ 1, '1'],[ 2 ,'2']]],
+			[/(    \d)(?<y>\d)/x.match(str), [[ 1, '2']]],           # ):
+		].each do |m, x|
+			assert_equal( x, m.each_positional_capture(include_names: true).to_a )
+		end
+	end
+end
+

data/test/test-matchdata_hash.rb

@@ -0,0 +1,47 @@
+require 'test/unit'
+$VERBOSE = true
+
+require_relative '../lib/mug/matchdata/hash'
+class Test_matchdata_hash < Test::Unit::TestCase
+	def test__matchdata__to_h
+		str = 'a12b'
+		[
+			[/(    \d)(    \d)/x.match(str), { 1 =>'1',  2 =>'2'}],
+			[/(?<x>\d)(?<y>\d)/x.match(str), {'x'=>'1', 'y'=>'2'}],
+			[/(    \d)(?<y>\d)/x.match(str), {          'y'=>'2'}], # ):
+		].each do |m, x|
+			assert_equal( x, m.to_h )
+		end
+	end
+	def test__matchdata__named_captures
+		str = 'a12b'
+		[
+			[/(    \d)(    \d)/x.match(str), {                  }],
+			[/(?<x>\d)(?<y>\d)/x.match(str), {'x'=>'1', 'y'=>'2'}],
+			[/(    \d)(?<y>\d)/x.match(str), {          'y'=>'2'}],
+		].each do |m, x|
+			assert_equal( x, m.named_captures )
+		end
+	end
+	def test__matchdata__positional_captures
+		str = 'a12b'
+		[
+			[/(    \d)(    \d)/x.match(str), { 1 =>'1',  2 =>'2'}],
+			[/(?<x>\d)(?<y>\d)/x.match(str), {                  }],
+			[/(    \d)(?<y>\d)/x.match(str), {                  }], # D:
+		].each do |m, x|
+			assert_equal( x, m.positional_captures )
+		end
+	end
+	def test__matchdata__positional_captures2
+		str = 'a12b'
+		[
+			[/(    \d)(    \d)/x.match(str), { 1 =>'1',  2 =>'2'}],
+			[/(?<x>\d)(?<y>\d)/x.match(str), { 1 =>'1',  2 =>'2'}],
+			[/(    \d)(?<y>\d)/x.match(str), { 1 =>'2'}],           # ):
+		].each do |m, x|
+			assert_equal( x, m.positional_captures(include_names: true) )
+		end
+	end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mug
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Matthew Kerwin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-16 00:00:00.000000000 Z
+date: 2016-01-19 00:00:00.000000000 Z
 dependencies: []
 description: |
   == MUG: Matty's Ultimate Gem
@@ -42,6 +42,9 @@ files:
 - lib/mug/iterator/method.rb
 - lib/mug/iterator_c.rb
 - lib/mug/loop-with.rb
+- lib/mug/matchdata.rb
+- lib/mug/matchdata/each.rb
+- lib/mug/matchdata/hash.rb
 - lib/mug/maybe.rb
 - lib/mug/negativity.rb
 - lib/mug/rexproc.rb
@@ -62,6 +65,8 @@ files:
 - test/test-iterator-for.rb
 - test/test-iterator-method.rb
 - test/test-loop-with.rb
+- test/test-matchdata_each.rb
+- test/test-matchdata_hash.rb
 - test/test-maybe.rb
 - test/test-negativity.rb
 - test/test-rexproc.rb
@@ -88,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: 'MUG: Matty''s Ultimate Gem'
@@ -96,6 +101,8 @@ test_files:
 - test/test-clamp.rb
 - test/test-rexproc.rb
 - test/test-tau.rb
+- test/test-matchdata_each.rb
+- test/test-matchdata_hash.rb
 - test/test-array-extend.rb
 - test/test-iterator-for.rb
 - test/test-top.rb