Sha256: 14a38423cce743ea3ab210647b9987975d5c723d4b327349d03f40aadfc040d5

Contents?: true

Size: 1.85 KB

Versions: 1

Compression:

Stored size: 1.85 KB

Contents

# UnambiguousString

Generate random unambiguous strings (no `ilo06b2z` chars).

## Installation

Add this line to your application's Gemfile:

```ruby
gem "unambiguous_string"
```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install unambiguous_string

## Usage

```ruby
require "unambiguous_string"

# Default size is 10
UnambiguousString.call
#=> ptwkyvshue

# Using custom size
UnambiguousString.call(size: 6)
#=> 5m75wt

# Break string in buckets
UnambiguousString.call(groups: 2)
#=> cahvg-mwuh7

# Use a custom joiner string
UnambiguousString.call(groups: 2, joiner: ".")
#=> ymesr.ukpd3
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/fnando/unambiguous_string. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/fnando/unambiguous_string/blob/master/CODE_OF_CONDUCT.md).


## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the UnambiguousString project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fnando/unambiguous_string/blob/master/CODE_OF_CONDUCT.md).

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
unambiguous_string-0.1.0 README.md