rack-locale_memorable 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5d66845b0ecc18ec3afd2e985bad0d29533f031cad50f4a214b3273ccf21634
-  data.tar.gz: f4c1190527981fc0a17899539ceaf0cb954a68276b18cef39990e3f881a7eba9
+  metadata.gz: fd5bd6d13a8a85a10053362a85a1d5c3530348fadadb5f871f9990e40e36d59b
+  data.tar.gz: 6f9c459b2527f17fc153c43bd3d71b9ecfb5c6ae60402e142ecc0da8bde1afa2
 SHA512:
-  metadata.gz: 2bfa002397c86cd7c82a92b01d0ae56102869e65a4c20f7bc92b50128c12badf4692e6a42ded5008b60dac58f8290c2e77280a55d1674edc7daf71a3d374f16c
-  data.tar.gz: 0ca6c6d961aa210f709545e0610c5e6f3d29abb983e262484e9f133d4ac2b93ee40df9e5d6dad724d6e36ef6b4b8ce6e9a07d982ea68e7bb503bfa93d6f55488
+  metadata.gz: 9ed6cc8acbfbe09b475fc80c90f155102f25916a28f279e7efadc28e2660a5fce8cd7896727c4b819906097009886112d10df9e7e807eefb1ffa10e798d2c1d2
+  data.tar.gz: f8304fa8aa3ed7b6f0fa102935828f5eeec3d0cae20bbd0bc8e5d10bc8fba3f37edbdd7879bfdc7f416f39ba8f43c08f2f242fa088661edf52e0b1c2afd6f595

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-09-28
+## [0.3.0] - 2022-09-28
 
-- Initial release
+- First stable release.
+- Older versions are buggy, DO NOT USE THEM.

data/README.md

@@ -1,8 +1,6 @@
 # Rack::LocaleMemorable
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rack/locale_memorable`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Handle query params, cookie and HTTP_ACCEPT_LANGUAGE header to detect user-preffered locale, and remember it when necessary.
 
 ## Installation
 
@@ -16,7 +14,27 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# in initializers/middlewares.rb etc.
+Rails.application.configure do |config|
+  config.middleware.use(
+    Rack::LocaleMemorable,
+    secure_cookie: Rails.env.production?
+  )
+end
+```
+
+NOTE: If you're using devise, set `Rack::LocaleMemorable` before `Warden::Manager`, otherwise you see warden error messages in wrong locale.
+
+```ruby
+Rails.application.configure do |config|
+  config.middleware.insert_before(
+    Warden::Manager,
+    Rack::LocaleMemorable,
+    secure_cookie: Rails.env.production?
+  )
+end
+```
 
 ## Development
 

data/lib/rack/locale_memorable/request.rb

@@ -3,7 +3,13 @@
 module Rack
   class LocaleMemorable
     class Request < Rack::Request
-      attr_reader :explicit_locale
+      attr_reader :explicit_locale, :params_key, :cookie_key
+
+      def initialize(env, params_key:, cookie_key:)
+        super env
+        @params_key = params_key
+        @cookie_key = cookie_key
+      end
 
       def detect_locale
         (
@@ -16,11 +22,11 @@ module Rack
       private
 
       def from_params
-        @explicit_locale = primary_locale_from params['locale']
+        @explicit_locale = primary_locale_from params[params_key]
       end
 
       def from_cookies
-        primary_locale_from cookies['locale']
+        primary_locale_from cookies[cookie_key]
       end
 
       def from_headers

data/lib/rack/locale_memorable/response.rb

@@ -3,8 +3,8 @@
 module Rack
   class LocaleMemorable
     class Response < Rack::Response
-      def remember_locale(explicit_locale, secure_cookie:, cookie_expiry:)
-        set_cookie 'locale', {
+      def remember_locale(explicit_locale, secure_cookie:, cookie_expiry:, cookie_key:)
+        set_cookie cookie_key, {
           value: explicit_locale,
           expires: cookie_expiry,
           http_only: true,

data/lib/rack/locale_memorable/version.rb

@@ -2,6 +2,6 @@
 
 module Rack
   class LocaleMemorable
-    VERSION = '0.2.2'
+    VERSION = '0.3.1'
   end
 end

data/lib/rack/locale_memorable.rb

@@ -7,14 +7,16 @@ require 'rack'
 
 module Rack
   class LocaleMemorable
-    def initialize(app, secure_cookie: true, cookie_expiry: 1.year.from_now)
+    def initialize(app, params_key: 'locale', cookie_key: 'locale', secure_cookie: true, cookie_expiry: 1.year.from_now)
       @app = app
+      @params_key = params_key
+      @cookie_key = cookie_key
       @secure_cookie = secure_cookie
       @cookie_expiry = cookie_expiry
     end
 
     def call(env)
-      request = Request.new(env)
+      request = Request.new(env, params_key: @params_key, cookie_key: @cookie_key)
       I18n.with_locale(request.detect_locale) do
         status, headers, body = @app.call(env)
         response = Response.new body, status, headers
@@ -22,7 +24,8 @@ module Rack
           response.remember_locale(
             request.explicit_locale,
             secure_cookie: @secure_cookie,
-            cookie_expiry: @cookie_expiry
+            cookie_expiry: @cookie_expiry,
+            cookie_key: @cookie_key
           )
         end
         response.finish

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-locale_memorable
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - nov
@@ -163,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Remember locale in rack layer