rack-locale_memorable 0.4.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5fa88bee1ecee1f29896cc46819466cc62ff1e673e709d727ed8a50a455ae0f
-  data.tar.gz: e19e763fe6ab18649ad21c50fbc8a0556f7b27020266114379815106c2d29ec7
+  metadata.gz: fa0c01424f46339976170cf682e5bfa2dc9d9fa7d07dd43f8a879364b0aad2b3
+  data.tar.gz: 15f3723e2480bf0383cc10f34c5fe317006ecde186f89ec25846db244e69194c
 SHA512:
-  metadata.gz: 16175263afb06a7ab63088895a78d9112f10d0b9f1e384fd1481c56c0acf1a44ea5b16f1e7f1cb3e439945020d533fb8179976b768d190a1ce431bde4a55493c
-  data.tar.gz: 9099bd43efbf47653789c4c679ff805561d9b90d4562991176dc16fa6cb5492d569acd8cf63382079a25f2d94b1b1ba8d7fa50f1e489ef3d5477aa48b8344745
+  metadata.gz: b18e7390e5a87613d9b67f4373587ea38b412396698f1f25f3f5cebb6b094d637616b13177733bb9c1e2968c534763953f7490ff1eea4915ebc9eca9fd067d8e
+  data.tar.gz: ed28ed315f1f27d1e6f6780a7ab2117a848cff1f609247baf806189d995eacc56c397890c524abf28438dbd4a9e482b4a006dcea8205268c5b0379faa417d9ad

data/CHANGELOG.md

@@ -1,12 +1,23 @@
 ## [Unreleased]
 
+## [1.0.0] - 2022-10-01
+
+### Changed
+
+- remove activesupport https://github.com/nov/rack-locale_memorable/pull/2
+
+## [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/request.rb

@@ -28,7 +28,7 @@ module Rack
       end
 
       def primary_locale_from(locales)
-        available_locales_from(locales)&.first if locales.present?
+        available_locales_from(locales)&.first if locales
       end
 
       def available_locales_from(locales)

data/lib/rack/locale_memorable/response.rb

@@ -3,16 +3,21 @@
 module Rack
   class LocaleMemorable
     class Response < Rack::Response
-      def remember_locale(explicit_locale, key:, lifetime: 1.year, domain: nil, path: '/', http_only: true, secure: true)
+      def remember_locale(explicit_locale, key:, lifetime: 31536000, domain: nil, path: '/', http_only: true, secure: true)
         set_cookie key, {
           value:     explicit_locale,
-          expires:   lifetime.from_now,
+          expires:   Time.at(Time.now.to_i + lifetime.to_i),
           domain:    domain,
           path:      path,
           http_only: http_only,
           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.1'
+    VERSION = '1.0.0'
   end
 end

data/lib/rack/locale_memorable.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require 'active_support'
-require 'active_support/core_ext'
+require 'i18n'
 require 'http/accept'
 require 'rack'
 
@@ -17,13 +16,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)
-          )
+        if request.explicit_locale
+          response.remember_locale request.explicit_locale, key: @cookie_key, **@cookie_options
         end
         response.finish
       end

data/rack-locale_memorable.gemspec

@@ -32,7 +32,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rack'
   spec.add_dependency 'i18n'
   spec.add_dependency 'http-accept'
-  spec.add_dependency 'activesupport'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'simplecov'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-locale_memorable
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 1.0.0
 platform: ruby
 authors:
 - nov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-29 00:00:00.000000000 Z
+date: 2022-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement