Sha256: d2bb4077018c7812e23b789a74ac8cd7956c55d8f42ed5cef44b9f17917a1e76

Contents?: true

Size: 1.23 KB

Versions: 1

Compression:

Stored size: 1.23 KB

Contents

# Cabal::Util

This is just a collection of utility methods and classes for the Cabal suite.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'cabal-util'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install cabal-util

## Usage

```ruby
require 'cabal-util'

# Via the Cabal::Util module

Cabal::Util.normalize('This is an unnormalized string.')
# => "thisisanunnormalizedstring."

# Via mixin
class Foo
  include Cabal::Util
end

Foo.normalize('This is WeIrD')
# => "thisisweird"

Foo.new.normalize('This is WeIrD')
# => "thisisweird"
```

## Development

Branches and releases for this project are managed by [git-flow](https://github.com/nvie/gitflow).

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.

## Contributing

**Note: Please base all feature branches on the `develop` branch.**

1. Fork it ( https://github.com/engineyard/cabal-util/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 against the `develop` branch

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
cabal-util-0.1.0 README.md