Giter VIP home page Giter VIP logo

text-scanner's Introduction

Text::Scanner

Text::Scanner is a library to make it easy to scan text.

Installation

Add this line to your application's Gemfile:

gem 'text-scanner'

And then execute:

$ bundle

Or install it yourself as:

$ gem install text-scanner

Usage

Creating a new Scanner object:

s = Text::Scanner.scan(INPUT)

Creates a new Scanner object, on INPUT, which is an IO or String object. If INPUT is a string, it is treated as the source text for the scanner object.

s = Text::Scanner.scan_file(FILE)

Creates a new Scanner object, on FILE, which is an IO object or the string path to a text file. If FILE is a string path, the file object is opened for the duration of the scan, and closed with s.close.

Using Scanner objects:

The following instance methods are available on the Text::Scanner object s:

Method Purpose
s.gets get the next line of input
s.ungets put back the most recent line of input
s.read_line an alias for gets
s.put_line an alias for ungets
s.put_text(TEXT) put TEXT back into the input stream
s.ungets(line) put back line as the next line of input
`s.each { line
`s.map{ line
s.skip_until(PAT) skip lines of input until line matches PAT
s.skip_while(PAT) skip lines of input while line matches PAT
`s.scan_while(PAT) { line, match
`s.each_while(PAT) { line
`s.map_while(PAT) { line, match
`s.each_until(PAT) { line

Development

After checking out the repo, run bin/setup to install dependencies. 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/aks/text-scanner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Author & Contributors

Author: Alan K. Stebbens <[email protected]>

License

The gem is available as open source under the terms of the MIT License.

text-scanner's People

Contributors

aks avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.