https://github.com/ConnorAtherton/rb-readline
Pure-Ruby Readline Implementation
https://github.com/ConnorAtherton/rb-readline
Keywords from Contributors
mvc activerecord activejob ruby-gem libxslt libxml2 nokogiri sax oauth xerces
Last synced: about 18 hours ago
JSON representation
Repository metadata
Pure-Ruby Readline Implementation
- Host: GitHub
- URL: https://github.com/ConnorAtherton/rb-readline
- Owner: ConnorAtherton
- License: bsd-3-clause
- Created: 2009-04-10T22:47:05.000Z (almost 17 years ago)
- Default Branch: master
- Last Pushed: 2024-05-03T19:40:02.000Z (almost 2 years ago)
- Last Synced: 2026-02-17T19:49:44.920Z (14 days ago)
- Language: Ruby
- Homepage:
- Size: 819 KB
- Stars: 250
- Watchers: 14
- Forks: 53
- Open Issues: 50
- Releases: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES
- License: LICENSE
README.md
Description
The readline library provides a pure Ruby implementation of the GNU
readline C library, as well as the Readline extension that ships as part
of the standard library.
Installation
gem install rb-readline
Or in a Gemfile:
gem 'rb-readline'
Synopsis
require 'readline'
loop do
line = Readline::readline('> ')
break if line.nil? || line == 'quit'
Readline::HISTORY.push(line)
puts "You typed: #{line}"
end
Compatibility
rb-readline should work on all Unix-like systems and Windows. It is regularly
used with MRI 1.8/1.9 and Rubinius. JRuby is not supported and there are no
plans to support it in the future - it comes bundled with a Java implementation
of Readline.
Motivation
First, building the GNU readline library on MS Windows with Visual C++ is
almost impossible. However, certain libraries depend on readline. By providing
a pure Ruby version we eliminate the entire compiler compatibility issue.
Second, even on distributions of Windows built with MinGW (that include
the readline library for Windows), the behavior was sometimes erratic and
would break.
Third, even on certain Unix distributions the GNU readline library is not
guaranteed to be installed. Providing a pure Ruby readline eliminates the
need to install a C library first. It's also one less link in the dependency
chain, meaning we don't need to worry about possible changes in the underlying
C library affecting our interface.
Fourth, by making the interface pure Ruby, we increase the likelihood of
receiving patches, feature requests, documentation updates, etc from the
community at large, since not everyone knows C.
Lastly, the Readline interface that ships as part of the standard library is
weak, and only provides a very limited subset of the actual GNU readline
library. By providing a pure Ruby implementation we allow 3rd party library
authors to write their own interface as they see fit.
Tutorial
For an excellent tutorial on how to use Readline in practice, please see
Joseph Pecoraro's examples at http://bogojoker.com/readline/.
You can also take a look at Ruby 1.9 stdlib Readline documentation located
at http://rubydoc.info/stdlib/readline/1.9.2/frames
Alternatives
See Rawline for a library that began life in pure Ruby and provides an
interface that's probably more comfortable to Ruby programmer. It has certain
features that Readline does not. In addition, it provides a Readline
compatibility mode.
Authors
- Park Heesob (C translation, code donated as part of bounty)
- Daniel Berger (Documentation and testing)
- Luis Lavena
- Mark Somerville (Maintainer)
- Connor Atherton (Maintainer)
Owner metadata
- Name: Connor Atherton
- Login: ConnorAtherton
- Email:
- Kind: user
- Description:
- Website: https://www.connoratherton.com
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/3777511?u=141a8c455c5104e873a5b28a228c56e5dfbbfa65&v=4
- Repositories: 119
- Last ynced at: 2025-04-21T11:07:33.369Z
- Profile URL: https://github.com/ConnorAtherton
GitHub Events
Total
- Fork event: 1
- Issues event: 2
- Watch event: 1
- Issue comment event: 1
Last Year
- Issue comment event: 1
Committers metadata
Last synced: 2 days ago
Total Commits: 182
Total Committers: 32
Avg Commits per committer: 5.688
Development Distribution Score (DDS): 0.687
Commits in past year: 0
Committers in past year: 0
Avg Commits per committer in past year: 0.0
Development Distribution Score (DDS) in past year: 0.0
| Name | Commits | |
|---|---|---|
| Luis Lavena | l****a@g****m | 57 |
| Mark Somerville | m****k@s****m | 56 |
| Park Heesob | p****s@g****m | 11 |
| Joshua J. Drake | j****e@f****g | 7 |
| Tay Ray Chuan | r****9@g****m | 4 |
| rogerdpack | r****5@g****m | 4 |
| Connor Atherton | c****n@g****m | 4 |
| Cameron Desautels | c****z@g****m | 3 |
| Hiroshi Shirosaki | h****i@g****m | 3 |
| rocky | r****b@r****g | 3 |
| yui-knk | s****a@g****m | 3 |
| Connor Atherton | c****r@b****m | 2 |
| Oliver | o****r@z****m | 2 |
| jugyo | j****g@g****m | 2 |
| Johnny Shields | j****s@g****m | 2 |
| Marek L | n****m@g****m | 2 |
| Nate Vack | n****k@f****t | 2 |
| zhigang.du | d****5@g****m | 1 |
| willdeed | w****d@g****m | 1 |
| Wolf | w****f@w****z | 1 |
| Wesley Boynton | w****n@g****m | 1 |
| Dorian | d****n@d****o | 1 |
| HD Moore | h****e@r****m | 1 |
| Rodrigo Rosenfeld Rosas | r****s@y****r | 1 |
| Lars Kanis | l****s@g****e | 1 |
| Joel Low | j****l@j****g | 1 |
| Jeff Williams | j****s@g****m | 1 |
| Jarrod Wageman | j****d@n****m | 1 |
| Dave Newton | d****n@g****m | 1 |
| Chris | c****s@w****m | 1 |
| and 2 more... | ||
Committer domains:
- leff.co: 1
- ahmadsherif.com: 1
- wideeyelabs.com: 1
- noige.com: 1
- joelsplace.sg: 1
- greiz-reinsdorf.de: 1
- yahoo.com.br: 1
- rapid7.com: 1
- doma.io: 1
- wolfsden.cz: 1
- freshforever.net: 1
- zerolag.com: 1
- bitnami.com: 1
- rubyforge.org: 1
- fear.qoop.org: 1
- scottishclimbs.com: 1
Issue and Pull Request metadata
Last synced: about 1 month ago
Total issues: 57
Total pull requests: 48
Average time to close issues: 10 months
Average time to close pull requests: 6 months
Total issue authors: 43
Total pull request authors: 37
Average comments per issue: 2.51
Average comments per pull request: 2.85
Merged pull request: 19
Bot issues: 0
Bot pull requests: 0
Past year issues: 0
Past year pull requests: 1
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 0
Past year pull request authors: 1
Past year average comments per issue: 0
Past year average comments per pull request: 1.0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- Spakman (5)
- camdez (3)
- ConnorAtherton (3)
- luislavena (3)
- DHB (2)
- jonforums (2)
- szymonj99 (2)
- abinoam (2)
- alphabt (1)
- firefart (1)
- wwboynton (1)
- neongrau (1)
- dmilith (1)
- graywolf (1)
- kplimack (1)
Top Pull Request Authors
- camdez (3)
- zeroSteiner (2)
- jduck (2)
- mattn (2)
- VorontsovIE (2)
- Spakman (2)
- shirosaki (2)
- yui-knk (2)
- deivid-rodriguez (2)
- rocky (2)
- johnnyshields (1)
- jeffwilliams (1)
- Olipro (1)
- lowjoel (1)
- willdeed (1)
Top Issue Labels
- bug (8)
- feature (6)
- feedback (4)
- windows (4)
- good first issue (2)
- 1.9 (2)
- refactoring (2)
- good first issue (probably!) (1)
- stale (1)
- unix (1)
- documentation (1)
Top Pull Request Labels
- patch (4)
- bug (3)
Dependencies
- minitest ~> 5.2 development
- rake >= 0 development
Score: 9.169518377455928