subdomain_locale 1.0.beta6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 451e8afface6f75567cd9c4057f06dece6963bb5
-  data.tar.gz: a3f9bb42af3d2e191da53ab0b0c938d6361135ca
+  metadata.gz: 5da9fa1546e807d5b21bf511496257ef32741596
+  data.tar.gz: e15c64020a71c4dee2f4a001a1c90b5f25735f51
 SHA512:
-  metadata.gz: e51dfa3412c056bb4f037440758b8be1cfaa45ebccd02cbd178ce770b76ebccee944569e0b54bab7a8adf12e2ad541d6ad60327c6be5ede32dd5cbf47938b3e8
-  data.tar.gz: 1d36125d9dc0a122e0dbb90efa24ef61f7395f569464b770f291d84f4ada319b7ab4f63a709ccfc4a5b54aa01700eb56df755d93d7830870b9eeafdfdbc431ea
+  metadata.gz: 22ae781fa5583463102c0b25f942a65f9c5ebcae46409e8ed281efef0640394ca972bb8eadb76926df0f29e08825f3c380233d575e17c6122f46516cdea13528
+  data.tar.gz: 42a64ecad75d68ba195b611c82e74493f1b96e9622dcb40e9ccf270a26a3be23bd3a42f35af769ec589c36b271bcb4cc1f21b3bc27df39f96adbc01cc6d024d6

data/Readme.md

@@ -1,57 +1,96 @@
 # Subdomain Locale (for Rails)
 
-Moves current locale into subdomain. Installation is quick and simple:
+A multi-language website requires some way to detect a user's locale.
+Subdomain is one option.
 
-```ruby
-# Gemfile
-gem 'subdomain_locale', '~> 0.1.0'
+## Setup
+
+Add the gem to your Gemfile. Set a default subdomain.
 
+```ruby
 # config/application.rb
-config.i18n.available_locales = [:ru, :az, :en, "en-US"] # Put your own available locales
-config.i18n.default_locale = :az                         # and make one default
+
+# I18n library now recommends you to enforce available locales.
+config.i18n.enforce_available_locales = true
+config.i18n.available_locales = :en, :ru
+
+# See "Configuration" for difference between these:
+config.default_locale = :ru
+config.i18n.default_locale = :en
 ```
 
-Now, start your web server at localhost:3000 and navigate:
+Subdomains will now determine the current locale:
 
-    http://lvh.me:3000/ - the default locale (:az)
-    http://ru.lvh.me:3000/ - I18n.locale is set to :ru
-    http://en-us.lvh.me:3000/ - I18n.locale is set to :en-US
-    http://www.lvh.me:3000/ - again, default
+* Selected locale (:en) http://en.example.com/
+* Default locale (:ru) http://example.com/
 
-You can also put links to all locales in your view:
+Add links to the new subdomains using :locale URL parameter:
 
 ```erb
-<% I18n.available_locales.each do |locale| %>
+<% [:ru, :en].each do |locale| %>
   <%= link_to locale, params.merge(locale: locale) %>
 <% end %>
 ```
 
-## Configuring own subdomain-to-locale mapping
+## Configuration
+
+You can hook a special subdomain name with a locale:
 
 ```ruby
-# config/application.rb
+config.subdomain_locale["us"] = :"en-US" # us.lvh.me
+config.subdomain_locale["ca"] = :"en-CA" # ca.lvh.me
+config.subdomain_locale["ua"] = :uk      # ua.lvh.me
+```
+
+Default locale will link to the default subdomain (main domain by default: lvh.me).
+If you prefer "www" use this config option:
 
-config.subdomain_locales["us"] = "en-US"
-# or even
-# config.subdomain_locales = {"us" => "en-US", "ca" => "en-CA"}
+```ruby
+config.default_subdomain = "www"
 ```
 
-Having that configured `http://us.lvh.me:3000` will be rendered with :en-US locale.
+English developers prefer to see English in console and other places.
+This is why we have a separate default locale for the website:
 
-## Development setup
+```ruby
+config.default_locale = :ru
+config.i18n.default_locale = :en
+```
+
+For example, with this config example.com will be in Russian,
+while validation errors in console are still in English.
+
+
+You can also override our controller method to completely ignore subdomain locale.
+For example, if you want admin panel to always be in English:
+
+```ruby
+class AdminController
+  # This is alrady an around_filter
+  def set_locale(&block)
+    I18n.with_locale(:en, &block)
+  end
+end
+```
+
+## Testing
+
+This gem is tested against Rails 3.2 and 4.0.
 
 ```
 gem install isolate
 rake test:all
 ```
 
-
 ## Changelog
 
-master
+1.0.0
 
-* Support IETF language tag subdomains, e.g. pt-br.
-* Allow to create custom mappings, e.g. "us" instead of "en-us".
+* Now compatible with the new I18n.enforce\_available\_locales.
+* No subdomain is now deafult instead of "www". Can be reverted by setting config.default\_domain.
+* Separate website's default locale (config.default\_locale) from the global default locale (config.i18n.default\_locale).
+* Test gem in the whole Rails stack (3.2, 4.0).
+* Add config.subdomain_locale for indirect mapping ("us" => :"en-US").
 
 0.1.1
 

data/subdomain_locale.gemspec

@@ -2,10 +2,10 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "subdomain_locale"
-  spec.version       = "1.0.beta6"
+  spec.version       = "1.0.0"
   spec.authors       = ["Semyon Perepelitsa"]
   spec.email         = ["sema@sema.in"]
-  spec.summary       = "Set I18n locale based on subdomain"
+  spec.summary       = "Set I18n locale based on subdomain (Rails plugin)."
   spec.homepage      = "https://github.com/semaperepelitsa/subdomain_locale"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: subdomain_locale
 version: !ruby/object:Gem::Version
-  version: 1.0.beta6
+  version: 1.0.0
 platform: ruby
 authors:
 - Semyon Perepelitsa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-23 00:00:00.000000000 Z
+date: 2014-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -73,15 +73,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Set I18n locale based on subdomain
+summary: Set I18n locale based on subdomain (Rails plugin).
 test_files:
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/controllers/hello_controller.rb