match_all 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a13c0e6b3b6d777b25dced8a0972842db698c5f7f7f98287b6b3f81a5d5528f1
+  data.tar.gz: 9786191dffe30e03530459dc7189b9b419b976d5956c3c9146741d5eb82903ce
+SHA512:
+  metadata.gz: 26ceab3cb39ff712f917d924a605cfb5e202fb9cb30d5cc7316c8561235e080488d618af6a3de89d6b6d0d957d2f70fa0d418a80abed116988adb1096a91e76a
+  data.tar.gz: 6162f0cd7fa74742f237a54578f895abfef7fe829de7a7910dfa33d197482cab01e2594a575ddee47e207446f84c0ca162f8e832a30c885bb4e3bf32f17ac483

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-11-10
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in match_all.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+group :development, :test do
+  gem "standard", "~> 1.3"
+  gem "rspec", "~> 3.2"
+  gem "pry", "~> 0.13.1"
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    match_all (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    json (2.6.2)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.38.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.17.0)
+      rubocop (= 1.38.0)
+      rubocop-performance (= 1.15.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  match_all!
+  pry (~> 0.13.1)
+  rake (~> 13.0)
+  rspec (~> 3.2)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.14

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Jeff Lange
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# MatchAll
+
+The String class's native `#match` method will only return the first instance of a
+pattern match. This gem provides the `#match_all` method, which returns all instances
+of a pattern match within a String as an array.
+
+## Installation
+
+Rails:
+```
+# in your Gemfile
+gem "match_all"
+```
+
+Otherwise:
+```
+$ gem install match_all
+```
+
+## Usage
+
+#### Given the test string:
+```
+string = "My cat is asleep on the couch. Now the cat is playing."
+```
+
+`#match` only returns the first match:
+
+```
+string.match(/cat/)
+=> #<MatchData "cat">
+```
+
+But `#match_all` finds _all_ of them:
+
+```
+string.match_all(/cat/)
+=> [
+      [0] #<MatchData "cat">,
+      [1] #<MatchData "cat">
+    ]
+```
+
+If the string contains "cat" 50 times, then `#match_all` will return an array with
+all 50 of those matches.
+
+Each match is an instance of `MatchData`. This is especially useful if, e.g. you want
+to interrogate the matches to find out their starting/ending indexes within the
+string, etc.
+
+## Development
+
+This is a very simple gem, with 0 production dependencies (just `rspec` and `pry` as
+development/test dependencies for convenience).
+
+## Contributing
+
+The method already does what it's supposed to do, and I don't expect any more
+development to be necessary. That being said, issues and PR's are welcome if
+anyone notices anything that can be improved or added.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/match_all/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MatchAll
+  VERSION = "0.1.0"
+end

data/lib/match_all.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "match_all/version"
+require_relative "ruby_core_extensions/string/match_all"
+
+module MatchAll
+  class Error < StandardError; end
+
+  include RubyCoreExtensions::String::MatchAll
+end

data/lib/ruby_core_extensions/string/match_all.rb

@@ -0,0 +1,26 @@
+module RubyCoreExtensions
+  module String
+    module MatchAll
+      def match_all(pattern)
+        raise ArgumentError, "must pass a Regexp pattern" unless pattern.is_a?(Regexp)
+
+        recursive_match(pattern)
+      end
+
+      private
+
+      def recursive_match(pattern, matches = [], prev_match = nil)
+        index = prev_match.nil? ? 0 : prev_match.offset(0)[1]
+
+        matching_item = match(pattern, index)
+        return matches unless matching_item
+
+        # prevent infinite matches
+        return matches if matching_item == prev_match
+
+        matches << matching_item
+        recursive_match(pattern, matches, matching_item)
+      end
+    end
+  end
+end

data/sig/match_all.rbs

@@ -0,0 +1,4 @@
+module MatchAll
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: match_all
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Lange
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+description: |
+  Ruby String's native #match method will only return the first instance of a
+  pattern match. This gem provides the #match_all method, returns all instances
+  of a pattern match in a String as an array.
+
+  EXAMPLES:
+  # Given the test string:
+  string = "My cat is asleep on the couch. Now the cat is playing."
+
+  # #match only returns the first match:
+
+  string.match(/cat/)
+  => #<MatchData "cat">
+
+  # However, I've found I often want to match _all_ instances of the pattern, and
+  # then e.g. iterate through them and do something with them. #match_all does that:
+
+  string.match_all(/cat/)
+  => [
+       [0] #<MatchData "cat">,
+       [1] #<MatchData "cat">
+     ]
+
+  This is especially useful if, e.g. you want to interrogate the matches to find
+  out their starting/ending indexes within the string, etc
+email:
+- jeffersonian.lange@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/match_all.rb
+- lib/match_all/version.rb
+- lib/ruby_core_extensions/string/match_all.rb
+- sig/match_all.rbs
+homepage: https://github.com/jeffdlange/match_all
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/jeffdlange/match_all
+  source_code_uri: https://github.com/jeffdlange/match_all
+  changelog_uri: https://github.com/jeffdlange/match_all/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.25
+signing_key:
+specification_version: 4
+summary: 'Provides #match_all method to String class'
+test_files: []