Skip to content
Provides lexical scanning operations on a String.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
benchmark Accept String as a pattern Apr 4, 2019
bin
ext/strscan Accept String as a pattern Apr 4, 2019
test
.gitignore Preparation for ruby/strscan Mar 31, 2017
.travis.yml travis: use commit-email.info Jun 9, 2019
Gemfile Preparation for ruby/strscan Mar 31, 2017
LICENSE.txt Modified license to BSD-2-Clause Apr 11, 2017
README.md README: ruby code fence [ci skip] Dec 25, 2017
Rakefile Accept String as a pattern Apr 4, 2019
appveyor.yml appveyor: fix task name Jun 9, 2019
strscan.gemspec

README.md

StringScanner

Build Status

StringScanner provides for lexical scanning operations on a String.

Installation

Add this line to your application's Gemfile:

gem 'strscan'

And then execute:

$ bundle

Or install it yourself as:

$ gem install strscan

Usage

s = StringScanner.new('This is an example string')
s.eos?               # -> false

p s.scan(/\w+/)      # -> "This"
p s.scan(/\w+/)      # -> nil
p s.scan(/\s+/)      # -> " "
p s.scan(/\s+/)      # -> nil
p s.scan(/\w+/)      # -> "is"
s.eos?               # -> false

p s.scan(/\s+/)      # -> " "
p s.scan(/\w+/)      # -> "an"
p s.scan(/\s+/)      # -> " "
p s.scan(/\w+/)      # -> "example"
p s.scan(/\s+/)      # -> " "
p s.scan(/\w+/)      # -> "string"
s.eos?               # -> true

p s.scan(/\s+/)      # -> nil
p s.scan(/\w+/)      # -> nil

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/strscan.

License

The gem is available as open source under the terms of the 2-Clause BSD License.

You can’t perform that action at this time.