Project

file_char_licker

0.0
No commit activity in last 3 years
No release in over 3 years
file_char_lickerindeep-xyz/ruby-file-char-lickerHomepageDocumentationSource CodeBug TrackerWiki
it has the following functions. - move the position of file pointer in character-based. - get string that is around the file pointer. - support for multi-byte character.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Popularity
Downloads
11,533
Stars
0
Forks
0
Watchers
1
 Releases
Current version
0.5.3
Total releases
4
First release
2014-10-08
Latest release
2014-10-16
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2014-10-10
Reverse Dependencies
1

 Dependencies

Development

bundler
~> 1.7
rake
~> 10.0
rspec
>= 0
 Project Readme

FileCharLicker

library for Ruby.

it has the following functions.

  • move the position of file pointer in character-based.
  • get string that is around the file pointer.
  • support for multi-byte character.

Installation

gem install file_char_picker

Usage

attach (setup)

at first, you must set up incetance of File object before use features of FileCharLicker .

file = open(path)
FileLineSeeker.attach(file, encoding)

the argument of file is instance of File object that you want to use features of FileCharLicker .

you can pass String object that is 'utf8', 'eucjp', 'jis', 'sjis' or each prefix. if you pass nil or does not pass, the instance set up for ascii character.

you can use the following instance methods after setup.

around_lines

file.around_lines(needle)

get string around the position of file pointer that matched needle argument. you can pass to needle argument as String object or Regexp object.

if does not exist the matched string around the position of file pointer, return empty string.

I assume that the position of file pointer is start of line in run.

backward_char

file.backward_char

get a character that a character before the position of file pointer. mainly, may use to multi-byte character.

if does not exist before a character, return nil .

backward_lines

file.backward_lines(size)

get string for lines before the position of file pointer. the size argument is number of lines. if reach to beginning of file (BOF) in advance of size number, return string until BOF.

I assume that the position of file pointer is start of line in run.

current_line

file.current_line

get string that is a line of the position of file pointer.

forward_lines

file.forward_lines(size)

get string for lines after the position of file pointer. the size argument is number of lines. if reach to end of file (EOF) in advance of size number, return string until EOF.

I assume that the position of file pointer is start of line in run.

seek_contiguous_min

file.scan_contiguous_min(needle)

move the position of file pointer to the start of line that matched the needle argument. the line is contiguous and backward line from the file pointer at run. you can pass to needle argument as String object or Regexp object.

return Integer object for the position of file pointer if succeed to move. else return nil.

seek_contiguous_max

file.scan_contiguous_min(needle)

move the position of file pointer to the end of line that matched the needle argument. the line is contiguous and forward line from the file pointer at run. you can pass to needle argument as String object or Regexp object.

return Integer object for the position of file pointer if succeed to move. else return nil.

seek_line_head

file.seek_line_head

move the position of file pointer to the head of line.

Author

indeep-xyz (Japanese language)