This README is the one indexed from the repository at its latest ref, not from the tag for this version.

Rex

Rex is a simple i18n adapter interface for Crystal. It allows a shard to define translatable text, enabling apps that require the shard to use any i18n shard of choice as backend.

Installation

1. Add the dependency to your shard.yml:

   dependencies:
     rex:
       github: GrottoPress/rex

2. Run shards update

3. Require Rex:

   # ...
   require "rex"
   # ...

Usage

1. Call the i18n helpers in your shard as required:

   # Translation
   Rex.t(:some_key, name: "Ama")
   Rex.t("some_key", {name: "John"})
   Rex.t("some.key", 45, "Judith")
   Rex.t(:another_key)
   
   # Localization
   Rex.l(Time.utc)
   Rex.l(123_456, :arg)

2. The consumer application defines their adapter:

   # ->>> src/config/i18n.cr
   
   require "some_i18n_shard"
   
   struct SomeAppI18nAdapter
     include Rex::Adapter
   
     def translate(key : String | Symbol, *args) : String
       # You may use any i18n shard as backend
       Somei18nShard.translate(key, *args)
     end
   
     def localize(value, *args) : String
       # You may use any i18n shard as backend
       Somei18nShard.localize(value, *args)
     end
   
     # You may add more `#translate` and `#localize` overloads
     # as needed
   end

3. The consumer application configures Rex to use this adapter:

   # ->>> src/config/i18n.cr
   
   Rex.configure do |settings|
     settings.adapter = SomeAppI18nAdapter.new
   end

   If the i18n backend evaluates translations at compile time (eg: Rosetta), the application should define a Rex.t macro instead:

   # ->>> src/config/i18n.cr
   
   module Rex
     macro t(text, **named_args)
       Rosetta.find({{ text.id.stringify }})
         .t({{ named_args unless named_args.empty? }})
     end
   end

4. The consumer application sets up translations according to whatever backend they are using.

Testing

Rex comes with Rex::DevAdapter which may be used for tests:

# ->>> spec/my_app/spec_helper.cr

Rex.configure do |settings|
  settings.adapter = Rex::DevAdapter.new
end

# ->>> spec/my_app/some_spec.cr

# `Rex::DevAdapter` returns the key passed to `Rex.t` unchanged
Rex.t(:some_key, {name: "Kwame"}).should(eq "some_key")

Development

Run tests with crystal spec.

Contributing

1. Fork it
2. Switch to the master branch: git checkout master
3. Create your feature branch: git checkout -b my-new-feature
4. Make your changes, updating changelog and documentation as appropriate.
5. Commit your changes: git commit
6. Push to the branch: git push origin my-new-feature
7. Submit a new Pull Request against the GrottoPress:master branch.