~ubuntu-branches/ubuntu/vivid/ruby-stringex/vivid-proposed

which will populate the <tt>url</tt> attribute on the object with the converted contents of the <tt>title</tt> attribute. This behavior can be customized by adding the following options to the arguments of the <tt>acts_as_url</tt> method:

which will populate the <tt>url</tt> attribute on the object with the converted contents of the <tt>title</tt> attribute.

<tt>acts_as_url</tt> takes the following options:

<tt>:url_attribute</tt>:: The name of the attribute to use for storing the generated url string.

Default is <tt>:url</tt>

<tt>:limit</tt>:: If set, will limit length of url generated. Default is nil.

<tt>:truncate_words</tt>:: Used with :limit. If set to false, the url will be truncated to the last

whole word before the limit was reached. Default is true.

<tt>:blacklist</tt>:: List of urls that should not be allowed. Default is <tt>%w{new}</tt> [which avoids confusion

on urls like <tt>/documents/new</tt>].

<tt>:blacklist_policy</tt>:: Proc or lambda defining new naming behavior when blacklisted urls are encountered.

Default converts <tt>/documents/new</tt> to </tt>/documents/new-document</tt>.

In order to use the generated url attribute, you will probably want to override <tt>to_param</tt> like so, in your Model:

"$12 worth of Ruby power".to_url => "12-dollars-worth-of-ruby-power"

"10% off if you act now".to_url => "10-percent-off-if-you-act-now"

# You don't even wanna trust Iconv for this next part

# You dont EVEN wanna rely on Iconv for this next part

"kick it en Français".to_url => "kick-it-en-francais"

"rock it Español style".to_url => "rock-it-espanol-style"

"tell your readers 你好".to_url => "tell-your-readers-ni-hao"

You probably won't ever need to run Unidecoder by itself. StringExtensions adds String#to_ascii which wraps all of Unidecoder's functionality. For anyone interested, details of the implementation can be read about in the original implementation of Text::Unidecode[http://interglacial.com/~sburke/tpj/as_html/tpj22.html]. Extensive examples can be found in the tests.

Unidecoder module also provides localization options for Stringex. You can use this functionality by loading either a YAML file or Hash like the following code snippets:

# Using a Hash

Stringex.localize_from :en => {"é" => "ee"}

# Loading from a file. NOTE: The path to file should be absolute.

Stringex.localize_from "/path/to/yaml_file"

In both the YAML and pure Hash implementation, the end result should be a Hash with keys representing the locale and values being another Hash with those keys being the UTF character and the values the transliterated ASCII values. (I hope that made sense.) You can check the documentation for the Unidecoder module for more information about setting locales.

== StringExtensions

A small collection of extensions on Ruby's String class. Please see the documentation for StringExtensions module for more information. There's not much to explain about them really.

107

103

108

104

* English (en)

109

105

* Danish (da)

106

* Swedish (sv)

110

107

* Dutch (nl)

111

108

* German (de)

109

* Polish (pl)

112

110

* Portuguese Brazilian (pt-BR)

113

111

* Russian (ru)

114

112

115

116

113

You can easily add your own or customize the built-in translations - read here[https://github.com/rsl/stringex/wiki/Localization-of-Stringex-conversions]. If you add a new language, please submit a pull request so we can make it available to other users also.

117

114

118

115

If you don't want to use the Stringex built-in translations, you can force Stringex to use English (or another language), regardless what is in your +I18n.locale+. In an initializer, e.g. +config/initializers/stringex.rb+:

131

128

132

129

GIANT thanks to the many contributors who have helped make Stringex better and better: http://github.com/rsl/stringex/contributors

133

130

134

131

Older »