https://github.com/comma-csv/comma

Comma is a small CSV (ie. comma separated values) generation extension for Ruby objects, that lets you seamlessly define a CSV output format via a small DSL
https://github.com/comma-csv/comma

csv ruby

Last synced: 16 days ago
JSON representation

Comma is a small CSV (ie. comma separated values) generation extension for Ruby objects, that lets you seamlessly define a CSV output format via a small DSL

• Host: GitHub
• URL: https://github.com/comma-csv/comma
• Owner: comma-csv
• License: mit
• Created: 2009-02-22T10:53:16.000Z (over 15 years ago)
• Default Branch: master
• Last Pushed: 2024-08-22T20:41:32.000Z (3 months ago)
• Last Synced: 2024-10-09T16:21:19.836Z (28 days ago)
• Topics: csv, ruby
• Language: Ruby
• Homepage: https://github.com/comma-csv/comma
• Size: 478 KB
• Stars: 513
• Watchers: 6
• Forks: 79
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        
# Comma

A library to generate comma seperated value (CSV) for Ruby objects like ActiveRecord and Array

[![Gem Version](https://badge.fury.io/rb/comma.svg)](http://badge.fury.io/rb/comma) [![Build Status](https://github.com/comma-csv/comma/actions/workflows/build.yml/badge.svg)](https://github.com/comma-csv/comma/actions/workflows/build.yml) [![Code Climate](https://codeclimate.com/github/comma-csv/comma.svg)](https://codeclimate.com/github/comma-csv/comma)

## Getting Started

### Prerequisites

You need to use ruby 3.0 or later. If you generate CSV from ActiveRecord models, you need to have ActiveRecord 6.0 or later.

### Installing

Comma is distributed as a gem, best installed via Bundler.

Include the gem in your Gemfile:

```ruby

gem 'comma', '~> 4.8.0'

```

Or, if you want to live life on the edge, you can get master from the main comma repository:

```ruby

gem 'comma',  git: 'git://github.com/comma-csv/comma.git'

```

Then, run `bundle install`.

### Usage

See [this page](https://github.com/comma-csv/comma/wiki) for usages.

## Running the tests

To run the test suite across multiple gem file sets, we're using [Appraisal](https://github.com/thoughtbot/appraisal), use the following commands:

```sh

$ bundle exec appraisal install

$ bundle exec appraisal rake spec

```

## Contributing

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/comma-csv/comma/tags).

## Authors

* Marcus Crafter - Initial work

* Tom Meier - Initial work

* Eito Katagiri

## License

This project is licensed under the MIT License - see the [MIT-LICENSE](https://github.com/comma-csv/comma/blob/master/MIT-LICENSE) file fore details.