BSC Plugin

Este plugin é úil para desenvolvedores do Brasil. Ele gera os models Country, State e City e carrega o banco de dados com todas os estados e cidades do Brasil.

Instalação

Basta dá um checkout do código na pasta "vendor/plugins"

  svn co https://svn.colivre.coop.br/svn/rails/plugins/bsc_plugin

OBS: Caso a pasta vendor/plugins não exista basta criá-la

Preparando o seu sistema

Rode o comando:

  ./script/generate bsc_migration

Para criar a arquivo da migration contendo a definição dos objetos Country, State e City.

Depois atualize o seu banco de dados (rake db:migrate)

Agora o plugin está ponto para ser usado.

Usando o Plugin

Você pode popular o seu banco de dados utilizando os scripts rake disponibilizados pelo plugin.

Comandos rake

Para popular seu banco de dados com todos os países, estados e cidades rode o comando:

  rake bsc_plugin:all

Se você deseja popular o banco de dados com cidades de um estado específico, rode o comando.

  rake bsc_plugin:"state"

Todos os estados brasileiros estão disponíveis no plugin:

"Santa Catarina", "Maranhao", "Distrito Federal", "Amazonas", "Sergipe", 
"Goias", "Rondonia",  "Rio Grande Do Sul", "Espirito Santo", "Acre", "Para", 
"Mato Grosso Do Sul", "Rio De Janeiro", "Mato Grosso", "Bahia", "Alagoas", 
"Roraima", "Minas Gerais", "Ceara", "Parana", "Paraiba", "Tocantis", 
"Sao Paulo", "Piaui", "Pernambuco", "Amapa"

Os comandos:

rake bsc_plugin:countries and  rake bsc_plugin:states

carrega todos os países e estados respectivamente.

Models

Este plugin provê as classes:

• BSC::Country
• BSC::State
• BSC::City

Exemplos:

  country = BSC::Country.new
  country.name = 'A Country'
  country.save

  state = BSC::State.new(:name => 'A State')
  state.country = c
  state.save

  city = BSC::city.new(:name => 'A city',  
                                      :state => state, 
                                     :zip_code => '40.000-000')
  city.country = c
  city.save

Helpers

O método select_country gera um elemento html select com todos os países como opções de escolha. Se uma coleção de países é passado como argumento as opções a serem escolhidas serão aquelas da coleção passada.

  select_country(object, method, collection, options, html_options)

Exemplos:

  select_country('organization', 
   'country', 
  ['Brazil', 'France'], 
  {:include_blank =>true}, 
  :class => 'my_country')

  select_country('organization', 'country')

O método select_state gera um elemento html select com todos os estados do país passado como parâmetro como opções do select.

  select_state(country, object, method, collection, options, html_options)

Exemplos:

  select_state(BSC::Country.find(:first), 'organization', 'state')

  select_state('Brazil', 'organization', 'state')

O método select_city gera um elemento html select com todas as cidades de um determinado estado passado como parâmetro, como opções do select.

select_city(state, object, method, collection, options, html_options)

Exemplos:

  select_city(BSC::State.find(:first), 'organization', 'city')

  select_city('Bahia', 'organization', 'city')