pboling/letter_group

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# LetterGroup

Organize data results from raw sql queries (as with PGresult, or Dossier) intelligently.

| Project                 |  LetterGroup    |
|------------------------ | ----------------- |
| gem name                |  letter_group   |
| license                 |  MIT              |
| expert support          |  [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github) |
| download rank               |  [![Total Downloads](https://img.shields.io/gem/rt/letter_group.svg)](https://rubygems.org/gems/letter_group) |
| version                 |  [![Gem Version](https://badge.fury.io/rb/letter_group.png)](http://badge.fury.io/rb/letter_group) |
| dependencies            |  [![Dependency Status](https://gemnasium.com/pboling/letter_group.png)](https://gemnasium.com/pboling/letter_group) |
| code quality            |  [![Code Climate](https://codeclimate.com/github/pboling/letter_group.png)](https://codeclimate.com/github/pboling/letter_group) |
| inline documenation     |  [![Inline docs](http://inch-ci.org/github/pboling/letter_group.png)](http://inch-ci.org/github/pboling/letter_group) |
| continuous integration  |  [![Build Status](https://secure.travis-ci.org/pboling/letter_group.png?branch=master)](https://travis-ci.org/pboling/letter_group) |
| test coverage           |  [![Coverage Status](https://coveralls.io/repos/pboling/letter_group/badge.png)](https://coveralls.io/r/pboling/letter_group) |
| homepage                |  [on Github.com][homepage] |
| documentation           |  [on Rdoc.info][documentation] |
| live chat               |  [![Join the chat at https://gitter.im/pboling/letter_group](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pboling/letter_group?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
| Spread ~♡ⓛⓞⓥⓔ♡~      |  [on Coderbits][coderbits], [on Coderwall][coderwall] |

[semver]: http://semver.org/
[pvc]: http://docs.rubygems.org/read/chapter/16#page74
[railsbling]: http://www.railsbling.com
[peterboling]: http://www.peterboling.com
[coderbits]: https://coderbits.com/pboling
[coderwall]: http://coderwall.com/pboling
[documentation]: http://rdoc.info/github/pboling/letter_group/frames
[homepage]: https://github.com/pboling/letter_group

See specs for examples.

No view code yet, for now just the logic.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'letter_group'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install letter_group

## Usage

See specs for usage examples.

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, 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`.

## Maintenance

To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Versioning

This library aims to adhere to [Semantic Versioning 2.0.0](http://semver.org/).
Violations of this scheme should be reported as bugs. Specifically,
if a minor or patch version is released that breaks backward
compatibility, a new version should be immediately released that
restores compatibility. Breaking changes to the public API will
only be introduced with new major versions.

As a result of this policy, you can (and should) specify a
dependency on this gem using the [Pessimistic Version Constraint](http://docs.rubygems.org/read/chapter/16#page74) with two digits of precision.

For example:

    spec.add_dependency 'letter_group', '~> 0.1'

## Contributing

1. Fork it ( https://github.com/[my-github-username]/letter_group/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request