https://github.com/pedrofurtado/rails-countries

Integration between Rails and countries gem.
https://github.com/pedrofurtado/rails-countries

activerecord countries gem iso3166 rails

Last synced: 11 days ago
JSON representation

Integration between Rails and countries gem.

• Host: GitHub
• URL: https://github.com/pedrofurtado/rails-countries
• Owner: pedrofurtado
• License: mit
• Created: 2019-07-18T14:03:51.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-06-23T14:45:34.000Z (over 2 years ago)
• Last Synced: 2024-04-25T02:41:15.876Z (7 months ago)
• Topics: activerecord, countries, gem, iso3166, rails
• Language: Ruby
• Homepage: https://rubygems.org/gems/rails-countries
• Size: 54.7 KB
• Stars: 18
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rails-countries

Integration between Rails and [countries](https://github.com/hexorx/countries) gem.

[![Gem Version](https://badge.fury.io/rb/rails-countries.svg)](https://badge.fury.io/rb/rails-countries)

[![Gem](https://img.shields.io/gem/dt/rails-countries.svg)]()

[![license](https://img.shields.io/github/license/pedrofurtado/rails-countries.svg)]()

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'rails-countries'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install rails-countries

## Usage

### ActiveRecord models

```ruby

class Person < ActiveRecord::Base

  validates :my_attribute, countries_alpha2: true

  # or

  validates_countries_alpha2_of :my_attribute

  validates :another_attribute, countries_alpha3: true

  # or

  validates_countries_alpha3_of :another_attribute

end

```

### Plain Old Ruby Objects

```ruby

class Person

  include ActiveModel::Model

  validates :my_attribute, countries_alpha2: true

  # or

  validates_countries_alpha2_of :my_attribute

  validates :another_attribute, countries_alpha3: true

  # or

  validates_countries_alpha3_of :another_attribute

end

```

### Views

#### Helpers

```erb

<%= i18n_country_name_by_alpha2('US') %>

<%= i18n_country_name_by_alpha2('US', 'pt-BR') %>

<%= i18n_country_name_by_alpha3('USA') %>

<%= i18n_country_name_by_alpha3('USA', 'pt-BR') %>

```

#### Rails Form helpers

```erb

<%= select_tag(:my_attribute, countries_alpha2_options) %>

<%= select_tag(:my_attribute, countries_alpha2_options('pt-BR')) %>

<%= select_tag(:another_attribute, countries_alpha3_options) %>

<%= select_tag(:another_attribute, countries_alpha3_options('pt-BR')) %>

```

#### SimpleForm

```erb

<%= f.input :my_attribute, collection: countries_alpha2_options %>

<%= f.input :my_attribute, collection: countries_alpha2_options('pt-BR') %>

<%= f.input :my_attribute, collection: countries_alpha3_options %>

<%= f.input :my_attribute, collection: countries_alpha3_options('pt-BR') %>

```

## I18n

To customize your error messages you can create a locale file like this:

```yaml

en:

  errors:

    messages:

      countries_alpha2_invalid: '%{alpha2} is not valid'

      countries_alpha3_invalid: '%{alpha3} is not valid'

```

## Contribute it!

Help us to improve the features and translations of this gem! Your contribution will be welcome :tada: