Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teeparham/loady
Simple file reader and logger
https://github.com/teeparham/loady
csv ruby
Last synced: 8 days ago
JSON representation
Simple file reader and logger
- Host: GitHub
- URL: https://github.com/teeparham/loady
- Owner: teeparham
- License: mit
- Created: 2011-01-14T04:45:24.000Z (almost 14 years ago)
- Default Branch: main
- Last Pushed: 2024-12-02T22:52:15.000Z (about 1 month ago)
- Last Synced: 2024-12-24T02:51:50.913Z (18 days ago)
- Topics: csv, ruby
- Language: Ruby
- Homepage:
- Size: 88.9 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Loady
[](http://rubygems.org/gem/loady)
[](https://github.com/teeparham/loady/actions/workflows/ruby.yml)
[](https://coveralls.io/r/teeparham/loady)
Loady is a simple file reader and logger. Use it to read any delimited file. Loady makes it easy to conveniently convert input fields to an attribute hash, continue on error rows, and do basic logging.
Loady was initially created to load hundreds of millions of rows from CSV files that had various data errors.
It works with MRI ruby 1.9.3+. It uses ruby's CSV library to parse rows.
## Install
```ruby
gem install loady
```
Or include the gem in your Gemfile:
```ruby
gem 'loady'
```
## Use
If an error occurs, Loady will continue reading the file, ignoring problem rows and logging a warning for each.
By default, messages are logged to the standard output.
### Basic usage:
```ruby
Loady.read "/your/file.csv" do |row|
# handle each row
end
```
### Skip the first row and log to a file:
```ruby
logger = Logger.new "/your/file.log"
Loady.read "/your/file.csv", logger: logger, skip_first_row: true do |row|
puts "#{row[0]}, #{row[1]}, etc."
end
```
### Name your attributes:
```ruby
Loady.read "/your/file.csv" do |row|
Monkey.create row.to_attributes [:name, :year, :mom]
# row.to_attributes [:name, :year, :mom]
# => { name: 'Bubbles', year: 2000, mom: 'Momma Bubbles' }
end
```
### Load a tab-delimited file:
```ruby
Loady.read "/your/file.tab", col_sep: "\t" do |row|
# go bananas
end
```
### Collect log messages in memory
`Loady::MemoryLoader` is a class that collects log messages in memory.
```ruby
memory_logger = Loady::MemoryLogger.new
Loady.read "/your/file.csv", logger: memory_logger do |row|
# do things
end
memory_logger.messages
=> [
'Line 123: Something bad happened.',
'Line 456: Exception of some sort.',
'Finished. Loaded 9998 rows. 2 unprocessed rows.'
]
```
## Major Change in 1.0
Up to version 1.0, `loady` worked fundamentally differently than ruby's CSV
parser in that it did not support newlines. The benefit was that lines
with errant newlines could easily be ignored.
In version 1.0+, `loady` works like the stdlib ruby CSV parser, and you
must have properly formed CSV rows.