rack-locale_memorable 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd5bd6d13a8a85a10053362a85a1d5c3530348fadadb5f871f9990e40e36d59b
-  data.tar.gz: 6f9c459b2527f17fc153c43bd3d71b9ecfb5c6ae60402e142ecc0da8bde1afa2
+  metadata.gz: 5ccb7d078d2dd4d582f7db663cf0436da123b94e6531f8d6de83a63c1eb03bbd
+  data.tar.gz: eb20d6db30ef828dfac9f27843ab9a249308c889835f912e61986d1f08f1edc9
 SHA512:
-  metadata.gz: 9ed6cc8acbfbe09b475fc80c90f155102f25916a28f279e7efadc28e2660a5fce8cd7896727c4b819906097009886112d10df9e7e807eefb1ffa10e798d2c1d2
-  data.tar.gz: f8304fa8aa3ed7b6f0fa102935828f5eeec3d0cae20bbd0bc8e5d10bc8fba3f37edbdd7879bfdc7f416f39ba8f43c08f2f242fa088661edf52e0b1c2afd6f595
+  metadata.gz: 5b6212b7c2a58b6f110a22856ac52c8197600ccc9929f229147f8324d6342a15e5472ef45917fe11dfbdd2bf196877fd8b5e26f962cfa9668b95d7622b77cd8d
+  data.tar.gz: 6fdd32c5bad90120d759514971c20b2de1330fbc9774bbf218cd91a7781cfffb89f2a29f3da5547452b4ae1cede23d757d6b25ca345429cb7b5f81b6f98f0eae

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [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/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.2'
   end
 end

data/lib/rack/locale_memorable.rb

@@ -7,12 +7,12 @@ 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)
@@ -24,7 +24,7 @@ module Rack
           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.2
 platform: ruby
 authors:
 - nov