rails_set_locale 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de1579113ae159463d28aa5d35c8ed7efa83da3a
-  data.tar.gz: 645650446a0815fd6514a099df5b80f3feb84fd8
+  metadata.gz: 023a690fec4f556d36ab2211169bdd2fe38cad94
+  data.tar.gz: 2ade8ac27e36e5977ec5cf6e131babac019c9aa0
 SHA512:
-  metadata.gz: 12a378588673b90dd0c67d0274ba690a30aa1dc52a40aed95a4fed60c96848d73cd9c0c720216f94811dd444a8de89500d6f768453c85ab77eb3679dee30c0a6
-  data.tar.gz: 5af97bc5d5c2ea7979f6cfb345dbc1e0ac967537dc0012d80815c179a65291a0f8f668002ff208f64951bdaed35ae9e77920bb47104b44968caf79945a2d52f2
+  metadata.gz: e79eee79e53a00a7bfb58c928623b6a0b804a76a0e003321042df07f5210ef2949a1ca2620e5959d8b48deace04bdfcf3f5fcc0c78f2c3b71eca0bb9a6921424
+  data.tar.gz: 1bf0032bb1dd9a94456ea28d0b7f3185022a4d6229097fb13dd025e19d9646ec68821f0acc798a3394f4b833dee41f057c3c437e3e5e7c9f31224a8c1fa1cb73

data/README.md

@@ -21,6 +21,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Setting the Locale By Reading Various Runtime Parameters
+
 You application controller needs to include the module:
 
 ```
@@ -39,6 +41,28 @@ Note that the gem is still in progress. Currently, it specifies the locale from
 it saves it in the session. I plan to expand the functionality of this gem to pick up the locale from the `current_user.locale`
 or from whatever the hosting application wants the locale specification to be.
 
+### Setting the Locale Using /set_locale end-point
+
+You can set the locale by letting your users visiting the URL:
+
+`/set_locale`
+
+with param `locale` specifying the new locale.
+
+For example:
+
+`/set_locale?locale=el`
+
+will set the locale to the Greek locale. 
+
+The controller implemented by the `RailsSetLocale` gem, is setting the `session[:locale]` to the locale requested.
+
+In order to implement this feature, you will have to mount the `RailsSetLocale` engine. In your routes include this:
+
+``` ruby
+mount RailsSetLocale::Engine => "/set_locale", as: :set_locale
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run `rubocop` and tests. 

data/app/controllers/rails_set_locale/application_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RailsSetLocale
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/rails_set_locale/locale_controller.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_dependency 'rails_set_locale/application_controller'
+
+module RailsSetLocale
+  class LocaleController < ApplicationController
+    # GET "/set_locale?locale=XX&current_path=XXXXX"
+    def set_locale
+      new_locale = params[:locale].to_sym
+      I18n.locale = new_locale
+      session[:locale] = new_locale
+      redirect_to params[:return_back_to] || request.referer || root_url
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/rails_set_locale/engine', __dir__)
+APP_PATH = File.expand_path('../test/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RailsSetLocale::Engine.routes.draw do
+  root to: 'locale#set_locale'
+end

data/lib/rails_set_locale.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rails_set_locale/version'
+require 'rails_set_locale/engine'
 require 'http_accept_language'
 
 # All the functionality of this gem will be exposed
@@ -9,7 +10,7 @@ require 'http_accept_language'
 module RailsSetLocale
   def self.included(base)
     base.before_action :set_locale
-    base.include HttpAcceptLanguage::EasyAccess  unless base.included_modules.include?(HttpAcceptLanguage::EasyAccess)
+    base.include HttpAcceptLanguage::EasyAccess unless base.included_modules.include?(HttpAcceptLanguage::EasyAccess)
     base.include InstanceMethods
   end
 

data/lib/rails_set_locale/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RailsSetLocale
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsSetLocale
+  end
+end

data/lib/rails_set_locale/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsSetLocale
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_set_locale
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Panos Matsinopoulos
@@ -129,6 +129,7 @@ email:
 - panagiotis@matsinopoulos.gr
 executables:
 - console
+- rails
 - setup
 extensions: []
 extra_rdoc_files: []
@@ -142,9 +143,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/rails_set_locale/application_controller.rb
+- app/controllers/rails_set_locale/locale_controller.rb
 - bin/console
+- bin/rails
 - bin/setup
+- config/routes.rb
 - lib/rails_set_locale.rb
+- lib/rails_set_locale/engine.rb
 - lib/rails_set_locale/version.rb
 - rails_set_locale.gemspec
 homepage: https://pmatsinopoulos.github.io