Skip to content
/ strscan Public

Provides lexical scanning operations on a String.

License

BSD-2-Clause, Unknown licenses found

Licenses found

BSD-2-Clause
LICENSE.txt
Unknown
COPYING
Notifications You must be signed in to change notification settings

ruby/strscan

Repository files navigation

StringScanner

CI

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

require 'strscan'

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 to compile this and 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.