https://github.com/fnando/unambiguous_string

Generate random unambiguous strings (no `ilo06b2z` chars).
https://github.com/fnando/unambiguous_string

random random-string ruby string unambigous-string

Last synced: 28 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/fnando/unambiguous_string
• Owner: fnando
• License: mit
• Created: 2020-02-18T18:19:53.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2020-09-24T06:09:38.000Z (about 4 years ago)
• Last Synced: 2024-10-06T04:27:31.299Z (about 1 month ago)
• Topics: random, random-string, ruby, string, unambigous-string
• Language: Ruby
• Homepage:
• Size: 8.79 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# 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).