https://github.com/ruby/strscan
Provides lexical scanning operations on a String.
https://github.com/ruby/strscan
ruby strscan
Last synced: about 1 month ago
JSON representation
Provides lexical scanning operations on a String.
- Host: GitHub
- URL: https://github.com/ruby/strscan
- Owner: ruby
- License: bsd-2-clause
- Created: 2017-03-31T01:24:40.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-05-03T04:32:47.000Z (about 2 months ago)
- Last Synced: 2025-05-05T08:40:48.127Z (about 2 months ago)
- Topics: ruby, strscan
- Language: C
- Homepage:
- Size: 427 KB
- Stars: 82
- Watchers: 37
- Forks: 38
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- License: COPYING
Awesome Lists containing this project
README
# StringScanner
[](https://github.com/ruby/strscan/actions/workflows/ci.yml)
StringScanner provides for lexical scanning operations on a String.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'strscan'
```
And then execute:
```console
$ bundle
```
Or install it yourself as:
```console
$ gem install strscan
```
## Usage
```ruby
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](https://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](https://opensource.org/licenses/BSD-2-Clause).