rack-locale_memorable 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b56451d07060a802f688db0f338178fa1c8d2ed9f1ea5bafd1ec120e0e241fae
-  data.tar.gz: 6d98f588efe1eb3d14a13ff989600fc67f1e3ae84ccc99e641206398b27c5589
+  metadata.gz: 5ccb7d078d2dd4d582f7db663cf0436da123b94e6531f8d6de83a63c1eb03bbd
+  data.tar.gz: eb20d6db30ef828dfac9f27843ab9a249308c889835f912e61986d1f08f1edc9
 SHA512:
-  metadata.gz: 4a2cdb7a55ff2d53fbf951fa11c31e2e8fd056c762f9dda3c22799e90b3fe3e32dd667534e6f069bf471a3185eb16a873bd054848f65d7aba626dbdc6c94dfdc
-  data.tar.gz: b945b0c1f8398a9bb3ac3c9e97ff9e303af47e35fe5a5d271a1af7bef304e8e15730c961b9c30c9dd83d4b1af2c0aa0e8e52f876ec59fba8e12548b1b20604ff
+  metadata.gz: 5b6212b7c2a58b6f110a22856ac52c8197600ccc9929f229147f8324d6342a15e5472ef45917fe11dfbdd2bf196877fd8b5e26f962cfa9668b95d7622b77cd8d
+  data.tar.gz: 6fdd32c5bad90120d759514971c20b2de1330fbc9774bbf218cd91a7781cfffb89f2a29f3da5547452b4ae1cede23d757d6b25ca345429cb7b5f81b6f98f0eae

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-09-28
+## [0.3.2] - 2022-09-28
 
-- Initial release
+### 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.
+- 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,48 @@ 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
+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
+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,
+    params_key: 'ui_locale',
+    cookie_key: 'ui_locale',
+    secure_cookie: Rails.env.production?,
+    cookie_lifetime: 3.months
+  )
+end
+```
 
 ## Development
 

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:)
-        set_cookie 'locale', {
+      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.0'
+    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,8 @@ 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
         response.finish

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-locale_memorable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - nov