rack-locale_memorable 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd5bd6d13a8a85a10053362a85a1d5c3530348fadadb5f871f9990e40e36d59b
-  data.tar.gz: 6f9c459b2527f17fc153c43bd3d71b9ecfb5c6ae60402e142ecc0da8bde1afa2
+  metadata.gz: 51ae9ed5a060ebb4263d0faeded7a6bdd94d40abb9835c670ce500e278ae5ac1
+  data.tar.gz: 758bc0cf5ac3498be41d78b79382024752d8a7ebb5995c0097b16031dacf4d86
 SHA512:
-  metadata.gz: 9ed6cc8acbfbe09b475fc80c90f155102f25916a28f279e7efadc28e2660a5fce8cd7896727c4b819906097009886112d10df9e7e807eefb1ffa10e798d2c1d2
-  data.tar.gz: f8304fa8aa3ed7b6f0fa102935828f5eeec3d0cae20bbd0bc8e5d10bc8fba3f37edbdd7879bfdc7f416f39ba8f43c08f2f242fa088661edf52e0b1c2afd6f595
+  metadata.gz: a6f73bce4a3940de8115d561cb2a3785f143e48496ba0822a186257122a3b8e4a0e2de1bc84ef5466da5cb0862fdcf5e410520d0d949100f7cfecfefad9e1a15
+  data.tar.gz: e38a7bd143e65235b55af8b05897135d04ca897ba0fdac1892e66b992005f7e81517a3265924bbba210860451abd8c39e9d5c756f029a5299bd9c98831599027

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 ## [Unreleased]
 
+## [0.3.3] - 2022-09-28
+
+### Refactored
+
+- requre active_support/core_ext only https://github.com/nov/rack-locale_memorable/commit/bf56b49f064a30d9688d65d2dd2901763bf31cee
+- stop using request class's instance variables following response class's design https://github.com/nov/rack-locale_memorable/commit/056807010fcb5c01d4d1745f06f8a9f87aad2ec6
+
+## [0.3.2] - 2022-09-28
+
+### Fixed
+
+- handle cookie expiry correctly https://github.com/nov/rack-locale_memorable/commit/886fed66da5513a4c0b6408a9ac7685932b0a034
+
+## [0.3.1] - 2022-09-28
+
+### Fixed
+
+- fixed cookie key handling when remembering https://github.com/nov/rack-locale_memorable/commit/ab8c87bff449e762daf00dea5cef44d001176141
+
 ## [0.3.0] - 2022-09-28
 
 - First stable release.

data/README.md

@@ -17,10 +17,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ```ruby
 # in initializers/middlewares.rb etc.
 Rails.application.configure do |config|
-  config.middleware.use(
-    Rack::LocaleMemorable,
-    secure_cookie: Rails.env.production?
-  )
+  config.middleware.use Rack::LocaleMemorable
 end
 ```
 
@@ -28,10 +25,34 @@ NOTE: If you're using devise, set `Rack::LocaleMemorable` before `Warden::Manage
 
 ```ruby
 Rails.application.configure do |config|
-  config.middleware.insert_before(
-    Warden::Manager,
+  config.middleware.insert_before Warden::Manager, Rack::LocaleMemorable
+end
+```
+
+By default, this gem handles
+
+* `params['locale']` as explicit locale
+* `cookies['locale']` as remembered locale
+* `headers['HTTP_ACCEPT_LANGUAGE']` as implicit locale
+
+and when explicit locale is specified in the request, remember it in cookie.
+
+You can customize those values
+* params_key (`'locale'` by default)
+* cookie_key (`'locale'` by default)
+* secure_cookie (`true` by default)
+* cookie_lifetime (`1.year` by default)
+
+like below
+
+```ruby
+Rails.application.configure do |config|
+  config.middleware.use(
     Rack::LocaleMemorable,
-    secure_cookie: Rails.env.production?
+    params_key: 'ui_locale',
+    cookie_key: 'ui_locale',
+    secure_cookie: Rails.env.production?,
+    cookie_lifetime: 3.months
   )
 end
 ```

data/lib/rack/locale_memorable/request.rb

@@ -3,30 +3,24 @@
 module Rack
   class LocaleMemorable
     class Request < Rack::Request
-      attr_reader :explicit_locale, :params_key, :cookie_key
+      attr_reader :explicit_locale
 
-      def initialize(env, params_key:, cookie_key:)
-        super env
-        @params_key = params_key
-        @cookie_key = cookie_key
-      end
-
-      def detect_locale
+      def detect_locale(params_key:, cookie_key:)
         (
-          from_params ||
-          from_cookies ||
+          from_params(params_key) ||
+          from_cookies(cookie_key) ||
           from_headers
         )
       end
 
       private
 
-      def from_params
-        @explicit_locale = primary_locale_from params[params_key]
+      def from_params(key)
+        @explicit_locale = primary_locale_from params[key]
       end
 
-      def from_cookies
-        primary_locale_from cookies[cookie_key]
+      def from_cookies(key)
+        primary_locale_from cookies[key]
       end
 
       def from_headers

data/lib/rack/locale_memorable/response.rb

@@ -3,10 +3,10 @@
 module Rack
   class LocaleMemorable
     class Response < Rack::Response
-      def remember_locale(explicit_locale, secure_cookie:, cookie_expiry:, cookie_key:)
+      def remember_locale(explicit_locale, secure_cookie:, cookie_lifetime:, cookie_key:)
         set_cookie cookie_key, {
           value: explicit_locale,
-          expires: cookie_expiry,
+          expires: cookie_lifetime.from_now,
           http_only: true,
           secure: secure_cookie
         }

data/lib/rack/locale_memorable/version.rb

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

data/lib/rack/locale_memorable.rb

@@ -1,30 +1,30 @@
 # frozen_string_literal: true
 
 require 'active_support'
-require 'active_support/all'
+require 'active_support/core_ext'
 require 'http/accept'
 require 'rack'
 
 module Rack
   class LocaleMemorable
-    def initialize(app, params_key: 'locale', cookie_key: 'locale', secure_cookie: true, cookie_expiry: 1.year.from_now)
+    def initialize(app, params_key: 'locale', cookie_key: 'locale', secure_cookie: true, cookie_lifetime: 1.year)
       @app = app
       @params_key = params_key
       @cookie_key = cookie_key
       @secure_cookie = secure_cookie
-      @cookie_expiry = cookie_expiry
+      @cookie_lifetime = cookie_lifetime
     end
 
     def call(env)
-      request = Request.new(env, params_key: @params_key, cookie_key: @cookie_key)
-      I18n.with_locale(request.detect_locale) do
+      request = Request.new env
+      I18n.with_locale(request.detect_locale params_key: @params_key, cookie_key: @cookie_key) do
         status, headers, body = @app.call(env)
         response = Response.new body, status, headers
         if request.explicit_locale.present?
           response.remember_locale(
             request.explicit_locale,
             secure_cookie: @secure_cookie,
-            cookie_expiry: @cookie_expiry,
+            cookie_lifetime: @cookie_lifetime,
             cookie_key: @cookie_key
           )
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-locale_memorable
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 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.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Remember locale in rack layer