module Rosetta

Defined in:

Constant Summary

VERSION = {{ (`shards version \"/srv/crystaldoc.info/github-wout-rosetta-v0.11.3/src/rosetta\"`).chomp.stringify }}

Class Method Summary

• .distance_of_time_in_words(from : Time, to : Time) : String

  Returns a String with approximate distance in time between from and to.

• .interpolate(translation : String, values : Hash | NamedTuple)

  Interpolates a given string with the values from the given hash or named tuple.

• .locale : String

  Gets the current locale at runtime using the config instance stored in the current fiber.

• .locale=(locale : String | Symbol)

  Sets the current locale at runtime using the config instance stored in the current fiber.

• .localize_time(time : Time, format : String)

  Uses a given format to localize a given Time object, for example:

• .localize_time(time : Tuple(Int32, Int32, Int32), format : String)
• .pluralize(count : Rosetta::CountArg, translation : NamedTuple, rule : Pluralization::Rule = Pluralization::RULES[Rosetta.locale].new)

  Pluralizes a given pluralizable translation.

• .time_ago_in_words(from : Time) : String

  Returns a String with approximate distance in time between from and current moment.

• .time_from_now_in_words(to : Time) : String

  Returns a String with approximate distance in time between current moment and future date.

• .with_locale(locale : String | Symbol, &)

  Temporarily use a different locale.

Macro Summary

• available_locales

  Fetches the available locales from the corresponding annotation.

• date(format = :default)

  Localizes a date, for example:

• default_locale

  Fetches the default locale from the corresponding annotation.

• find(key)

  Finds the translations for the given key as a dedicated class instance for the translation, which inherits from Rosetta::Translation.

• number(format = :default)

  Localizes a numeric value, for example:

• time(format = :default)

  Localizes time, for example:

Class Method Detail

Rosetta.distance_of_time_in_words(
  Time.utc(2021, 10, 15, 8, 0, 0),
  Time.utc(2021, 10, 15, 8, 0, 5))
)
# => "5 seconds"

Rosetta.localize_time(Time.local, "%d %b %Y %H:%M:%S")

time_ago_in_words(Time.utc(2019, 8, 30))
# => "about a month"
# gives the same result as:
distance_of_time_in_words(Time.utc(2019, 8, 30), Time.utc)
# => "about a month"

time_from_now_in_words(Time.utc(2022, 8, 30))
# => "about a year"
# gives the same result as:
distance_of_time_in_words(Time.utc, Time.utc(2022, 8, 30))
# => "about a year"

Macro Detail

Rosetta.date.t(Time.local)
Rosetta.date.t({2021, 8, 20})
Rosetta.date(:long).l(Time.local)
Rosetta.date("%a, %d %b %Y").l(Time.local.date)

Rosetta.number.t(123_456.789)
Rosetta.number(:custom).l(123_456.789)

Rosetta.time.t(Time.local)
Rosetta.time(:short).l(Time.local)
Rosetta.time("%d %b %Y %H:%M:%S").l(Time.local)