rack-locale_memorable 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55bce36ab6b80c79c3057df44cbb98797093e1a10fba2d7f4614391a1472d0f2
-  data.tar.gz: feec52c485b6fe3056cc15c2137193d04a1430b058d84b53e42e91d25b173e0a
+  metadata.gz: 0ffe06754e47f1f4e78b11466c82b3e6eec83328a39ced2f7643531cf13663d5
+  data.tar.gz: feeb7868eb676e2b53e2e8cb6d6f72344c54ce0f1552a0bac81ade90afbf1d63
 SHA512:
-  metadata.gz: 5810a02bef7643ccd1c59fb4668813085ad223f7127985d7fb779b13c71438099fdf7f902b43aa0d784d9607d40e05ff402182bf20ae072c12b4244633368fa1
-  data.tar.gz: d9f6b533cace763569959f1431bf34f68988b91717e9c85b87ef56fa46bd84b3d853ec4d78222d438d507ce72220dfcda77924bf91d3cc920cf7145cb0e82394
+  metadata.gz: 110f31d182de015b71c26bf2b9d952537c4444966efabe116c2a67d8eee59196d24515cb37a34df66f0d3d1fb308e74626ec11aac1d43f38feb932b79726f3f9
+  data.tar.gz: 16359f3551313019d6b346e071b520fd2dae13e44d6715149f95e2bc15ad77bfe7688aca30e3349b373ef40d9808a0c5bb657056192ab9def3ccc9a02971e920

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.5.0] - 2022-10-01
+
+### Changed
+
+- set env['rack.locale'] and Content-Language response header following rack-locale https://github.com/nov/rack-locale_memorable/commit/02e34752327141f2dcd9f3ccfce3838c7e742abd
+
+## [0.4.1] - 2022-09-29
+
+### Fixed
+
+- make default path "/" https://github.com/nov/rack-locale_memorable/commit/439868e4d2f6a917be1234fa2d9bdbfab41fce69
+
 ## [0.4.0] - 2022-09-28
 
 ### Changed

data/README.md

@@ -2,6 +2,10 @@
 
 Handle query params, cookie and HTTP_ACCEPT_LANGUAGE header to detect user-preffered locale, and remember it when necessary.
 
+Since some libraries (e.g., Devise & Warden) handles i18n strings in rack-middleware layer, setting `I18n.locale` is not enough for some cases.
+
+This gem sets `I18n.locale` in rack-middleware layer, so that you can let other rack-middlewares use proper `I18n.locale`.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -33,7 +37,7 @@ There are several customizable options listed below.
 * `cookie_key` (`'locale'` by default)
 * `cookie_options[:lifetime]` (`1.year` by default)
 * `cookie_options[:domain]` (`nil` by default)
-* `cookie_options[:path]` (`nil` by default)
+* `cookie_options[:path]` (`/` by default)
 * `cookie_options[:http_only]` (`true` by default)
 * `cookie_options[:secure]` (`true` by default)
 
@@ -64,6 +68,51 @@ Rails.application.configure do |config|
 end
 ```
 
+ref.) related issue in devise & warden
+* https://github.com/heartcombo/devise/issues/5247
+* https://github.com/wardencommunity/warden/issues/180
+
+
+## Detailed locale handling
+
+See rspec results.
+
+```console
+% bundle exec rspec --format=documentation
+
+Rack::LocaleMemorable
+  with no locales
+    behaves like handled_with_default_locale
+      should use default locale
+  channel priority
+    when locale is specified
+      via query
+        when different locale is included
+          in cookie
+            behaves like handled_with_expected_locale
+              should use expected locale
+            behaves like remember_expected_locale
+              should remember expected locale
+          in header
+            behaves like handled_with_expected_locale
+              should use expected locale
+            behaves like remember_expected_locale
+              should remember expected locale
+          in cookie & header
+            behaves like handled_with_expected_locale
+              should use expected locale
+            behaves like remember_expected_locale
+              should remember expected locale
+      via cookie
+        when different locale is included
+          in header
+            behaves like handled_with_expected_locale
+              should use expected locale
+            behaves like remember_no_locale
+              should not remember any locale
+              :
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/rack/locale_memorable/response.rb

@@ -3,7 +3,7 @@
 module Rack
   class LocaleMemorable
     class Response < Rack::Response
-      def remember_locale(explicit_locale, key:, lifetime: 1.year, domain: nil, path: nil, http_only: true, secure: true)
+      def remember_locale(explicit_locale, key:, lifetime: 1.year, domain: nil, path: '/', http_only: true, secure: true)
         set_cookie key, {
           value:     explicit_locale,
           expires:   lifetime.from_now,
@@ -13,6 +13,11 @@ module Rack
           secure:    secure
         }.compact
       end
+
+      def finish
+        headers['Content-Language'] ||= I18n.locale.to_s
+        super
+      end
     end
   end
 end

data/lib/rack/locale_memorable/version.rb

@@ -2,6 +2,6 @@
 
 module Rack
   class LocaleMemorable
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

data/lib/rack/locale_memorable.rb

@@ -17,13 +17,11 @@ module Rack
     def call(env)
       request = Request.new env
       I18n.with_locale(request.detect_locale params_key: @params_key, cookie_key: @cookie_key) do
+        env['rack.locale'] = I18n.locale.to_s
         status, headers, body = @app.call(env)
         response = Response.new body, status, headers
         if request.explicit_locale.present?
-          response.remember_locale(
-            request.explicit_locale,
-            **@cookie_options.merge(key: @cookie_key)
-          )
+          response.remember_locale request.explicit_locale, key: @cookie_key, **@cookie_options
         end
         response.finish
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-locale_memorable
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - nov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-28 00:00:00.000000000 Z
+date: 2022-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack