Crystal String Inflection

Yet another library for string inflection written in Crystal.

Build Status

Installation

Add this to your application's shard.yml:

dependencies:
  string_inflection:
    github: mosop/string_inflection

Usage

require "string_inflection"

StringInflection.camel("foo bar")  # => "fooBar"
StringInflection.pascal("foo bar") # => "FooBar"
StringInflection.snake("foo bar")  # => "foo_bar"
StringInflection.kebab("foo bar")  # => "foo-bar"
StringInflection.plural("child")   # => "children"

Or do you like shorthand? So you can use the Case module.

require "string_inflection/case"

Case.camel("foo bar")  # => "fooBar"
Case.pascal("foo bar") # => "FooBar"
Case.snake("foo bar")  # => "foo_bar"
Case.kebab("foo bar")  # => "foo-bar"
Case.plural("child")   # => "children"

String#to

The special extension String#to makes things object-oriented.

require "string_inflection/string/to"

Then you can:

"foo bar".to.camel # => "fooBar"

If you don't intend pollute the String's namespace with the method #to, the StringInflection.define_inflector macro helps you.

class String
  StringInflection.define_inflector name: "inflectTo"
end

And you can:

"foo bar".inflectTo.camel

Mixins

You can mix the inflector methods into your own namespace.

module Case
  extend StringInflection::StaticMethods
end

This code defines all the inflector methods into the Case module. So you can:

Case.camel("foo bar")

You can also define the inflector methods as instance methods.

class String
  StringInflection.define_instance_methods self
end

And you can:

"foo bar".camel

Calling the StringInflection.define_instance_methods(object) macro, the inflector methods will be defined like:

class String
  def camel
    StringInflection.camel(self)
  end
end

Special Thanks

Automatically Generated Inflection Database (AGID)

The handy database by Kevin Atkinson and other authors is significantly useful to generate irregular singular/plural forms. You can see the license in README.

Releases

Development

[WIP]

Contributing

  1. Fork it ( https://github.com/mosop/string_inflection/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

Contributors