Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/berlinmagic/magic_addresses
adds translated addresses to any rails app.
https://github.com/berlinmagic/magic_addresses
Last synced: about 2 months ago
JSON representation
adds translated addresses to any rails app.
- Host: GitHub
- URL: https://github.com/berlinmagic/magic_addresses
- Owner: berlinmagic
- License: mit
- Created: 2015-02-11T20:37:50.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-11-29T16:42:51.000Z (about 8 years ago)
- Last Synced: 2024-08-08T15:29:18.867Z (5 months ago)
- Language: Ruby
- Homepage: https://github.com/berlinmagic/magic_addresses
- Size: 613 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# MagicAddresses
An address gem for rails .. fetches *country*, *state*, *city*, *district* and *subdistrict* in seperated and translated models.
This gives the great advantage, that each address can be displayed in each language. And not matter how you write an address it fetches the right one.
For example the german city *munich* in german *München* .. both save a city-model with a name translated all app-locales.
```ruby
rails g magic_addresses:install
```
- 1. **check the initialers** (*its important to first check the settings of the gem*)
- 2. **check the migration file**
- 3. **run `rake db:migrate`**
- 4. **add to your models**
## Features
- full tranlated addresses
- allways correct addresses (query to google/verbatim service)
- addresses, cities, countries, and so one, are uniq (i.e. only one "New-York" with lots of addresses, districts, ..)
- perfect order ( city has X addresses )
- postgresql earthdistance included (for distance checks)
- tested
## News
##### since version `0.0.44` there are named addresses, so one model can have multiple-times one-address
run:
```ruby
rails g magic_addresses:add_named_addresses
.. or ..
rails g magic_addresses:update
```
and migrate your Database
Model-Example
```ruby
class Customer < ActiveRecord::Base
has_one_address()
has_one_named_address( "invoice_address" )
has_one_named_address( "delivery_address" )
end
```
##### since version `0.0.13` addresses are uniq, so the same address never will be saved twice, instead owners share one address
run:
```ruby
rails g magic_addresses:update
```
to update old addresses and add the new structure
##### You can add Earthdistance plugin later!
run:
```ruby
rails g magic_addresses:add_earthdistance
```
be sure to activate it in initializer before migrate!
### Model methods
```ruby
has_one_address # => This model has one address associated with it. (ie: User)
has_addresses # => This model has many addresses. (ie: Company)
# You can use `has_one_address` and `has_addresses` on the same model
# `has_one_address` sets the default flag so could be major address.
## NEW:
has_one_named_address( "name_me" )
# works together with the other both .. so models can have multiple single addresses
# ie:
has_one_address()
has_one_named_address( "invoice_address" )
has_one_named_address( "delivery_address" )
## UNSTABLE:
has_nested_address # => Has one directly nested addresses. (ie: User.street, User.city)
```
### View Mehtods
```ruby
<%= country_flag( :de, "small" ) %>
# flag helper for all default countries ( "small" | "medium" | "large")
<%= render "magic_addresses/addresses/fields/address", f: f %>
# form helper for 'has_one_address'
```
**NEW** since *v. 0.0.25*:
rewrite the template of admin views, just place [admin_template](https://github.com/berlinmagic/magic_addresses/tree/master/app/views/magic_addresses/_admin_template.html.erb) in *YOUR_PROJECT/app/views/magic_addresses/_admin_template.html.erb* and rewrite it for your needs ...
### in your Controllers:
```ruby
private
# Never trust parameters from the scary internet! ... has_one_address
def instance_params
params.require(:instance).permit( .. :address_attributes => [:id, :street, :number, :postalcode, :city, :country, :_destroy] .. )
end
# Never trust parameters from the scary internet! ... has_addresses
def instance_params
params.require(:instance).permit( .. :addresses_attributes => [:id, :street, :number, :postalcode, :city, :country, :_destroy] .. )
end
- or -
:address_attributes => MagicAddresses::Address::PARAMS # has_one_address
:addresses_attributes => MagicAddresses::Address::PARAMS # has_addresses
```
## Configuration
```ruby
MagicAddresses.configure do |config|
# in which locales addresses should be saved
config.active_locales = [:en, :de]
# what is the default language (should be :en, except you don't need english at all)
config.default_locale = :en
# what is the default country for query
config.default_country = "Germany"
# add default country in each query ?
config.query_defaults = true
# only save tranlations when differs from default-locale?
config.uniq_translations = true
# use a background-process for the lookups ( :none | :sidekiq )
config.job_backend = :none
# use a postgres earthdistance for distance calculation
config.earthdistance = false
end
```
#### Structure
Address:
- street *(globalized)*
- street_additional
- number
- postalcode
- **country**
- - name *(globalized)*
- - iso_code
- - dial_code *(phone)*
- **state**
- - name *(globalized)*
- - short_name
- **city**
- - name *(globalized)*
- - short_name
- **district**
- - name *(globalized)*
- - short_name
- **subdistrict**
- - name *(globalized)*
- - short_name
#### Getter & Setter
```ruby
:street
:number
:postalcode
:city
:district
:subdistrict
:state
:country
```
#### TESTs
since version 0.0.24 you can only run rspec from the project folder:
```ruby
~/Sites/magic_addresses:$ rspec spec
```
the symlink in the dummy folder is removed for compatibility with ruby 2.2
.. will add more info, sometimes ...
This project rocks and uses MIT-LICENSE.