https://github.com/shioyama/i18n_accessors

Define locale-specific accessors for translated attributes.
https://github.com/shioyama/i18n_accessors

i18n ruby translation

Last synced: about 1 month ago
JSON representation

Define locale-specific accessors for translated attributes.

• Host: GitHub
• URL: https://github.com/shioyama/i18n_accessors
• Owner: shioyama
• License: mit
• Created: 2017-04-09T08:34:34.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-10-09T07:05:58.000Z (about 3 years ago)
• Last Synced: 2024-04-26T13:04:57.050Z (7 months ago)
• Topics: i18n, ruby, translation
• Language: Ruby
• Homepage:
• Size: 18.6 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# I18nAccessors

[![Gem Version](https://badge.fury.io/rb/i18n_accessors.svg)][gem]

[![Build Status](https://travis-ci.org/shioyama/i18n_accessors.svg?branch=master)][travis]

[gem]: https://rubygems.org/gems/i18n_accessors

[travis]: https://travis-ci.org/shioyama/i18n_accessors

Define locale accessors for your translated attributes. Extracted from

[Mobility](https://github.com/shioyama/mobility); works with

[Globalize](https://github.com/globalize/globalize) and other translation gems.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'i18n_accessors', '~> 1.0.0'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install i18n_accessors

## Usage

### Accessor Methods

To define a set of accessors for a translated attribute of the form

`_`, include an instance of the `I18nAccessors::Methods`

class in your model with translated attribute names as arguments:

```ruby

class Post

  def title

    # ...

  end

  def title?

    # ...

  end

  def title=(title)

    # ...

  end

  include I18nAccessors::Methods.new(:title)

end

```

By default, `I18n.available_locales` will be used to determine which locales to

define accessors for. So if `I18n.available_locales` is `[:en, :fr]`, then this

will define methods: `title_en`, `title_en?`, `title_en=`, `title_fr`,

`title_fr?` and `title_fr=`. Each of these methods is an alias to `title` (or

`title?`, or `title=`) with `I18n.locale` changed to the locale in the suffix.

If you want to specify explicitly which locales to define accessors for, pass

the locales as an option with the `locales` key to `new` when creating the

module:

```ruby

def Post

  # ...

  include I18nAccessors::Methods.new(:title, :content, locales: [:en, :fr])

end

```

This will define accessor methods for both `title` and `content`, in both

English (`en`) and French (`fr`).

### Method Missing

`I18nAccessors::Missing` does a similar thing, but using `method_missing` to

respond to messages of the form `_`. This is generally

slower (due to how `method_missing` works), but can be used to handle *any* locale:

```ruby

class Post

  # ...

  include I18nAccessors::Missing.new(:title, :content)

end

```

You can include both a `I18nAccessors::Methods` module and a

`I18nAccessors::Missing` module in the same class without conflict (the

accessor methods will take precedence).

### Configuration

If you are using I18nAccessors with Globalize, you can change the default i18n

class to `Globalize`:

```ruby

I18nAccessors.configure do |config|

  config.i18n_class = Globalize

end

```

With this configuration, `Globalize.with_locale` will be used to set the locale

around the accessor methods, rather than `I18n.with_locale`.

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/shioyama/i18n_accessors. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).