rack-locale_memorable 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51ae9ed5a060ebb4263d0faeded7a6bdd94d40abb9835c670ce500e278ae5ac1
-  data.tar.gz: 758bc0cf5ac3498be41d78b79382024752d8a7ebb5995c0097b16031dacf4d86
+  metadata.gz: 55bce36ab6b80c79c3057df44cbb98797093e1a10fba2d7f4614391a1472d0f2
+  data.tar.gz: feec52c485b6fe3056cc15c2137193d04a1430b058d84b53e42e91d25b173e0a
 SHA512:
-  metadata.gz: a6f73bce4a3940de8115d561cb2a3785f143e48496ba0822a186257122a3b8e4a0e2de1bc84ef5466da5cb0862fdcf5e410520d0d949100f7cfecfefad9e1a15
-  data.tar.gz: e38a7bd143e65235b55af8b05897135d04ca897ba0fdac1892e66b992005f7e81517a3265924bbba210860451abd8c39e9d5c756f029a5299bd9c98831599027
+  metadata.gz: 5810a02bef7643ccd1c59fb4668813085ad223f7127985d7fb779b13c71438099fdf7f902b43aa0d784d9607d40e05ff402182bf20ae072c12b4244633368fa1
+  data.tar.gz: d9f6b533cace763569959f1431bf34f68988b91717e9c85b87ef56fa46bd84b3d853ec4d78222d438d507ce72220dfcda77924bf91d3cc920cf7145cb0e82394

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.4.0] - 2022-09-28
+
+### Changed
+
+- change cookie option interface and add spec for customizable options https://github.com/nov/rack-locale_memorable/commit/e25350bd045db2369233ec293fece73b571d652b
+
+## [0.3.4] - 2022-09-28
+
+### Fixed
+
+- fix changelog url https://github.com/nov/rack-locale_memorable/commit/fc744c6fe1489cee12225b8cc5991a9f4d797278
+
 ## [0.3.3] - 2022-09-28
 
 ### Refactored

data/README.md

@@ -21,29 +21,23 @@ Rails.application.configure do |config|
 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
+By default, this gem handles locale variables in 3 places in the order below, and when explicit locale is specified (= when locale is specified via query params) in the request, remember it in cookie too.
 
-* `params['locale']` as explicit locale
-* `cookies['locale']` as remembered locale
-* `headers['HTTP_ACCEPT_LANGUAGE']` as implicit locale
+1. `params['locale']` as explicit locale
+2. `cookies['locale']` as remembered locale
+3. `headers['HTTP_ACCEPT_LANGUAGE']` as implicit locale
 
-and when explicit locale is specified in the request, remember it in cookie.
+There are several customizable options listed below.
 
-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)
+* `params_key` (`'locale'` by default)
+* `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[:http_only]` (`true` by default)
+* `cookie_options[:secure]` (`true` by default)
 
-like below
+You can customize them like below
 
 ```ruby
 Rails.application.configure do |config|
@@ -51,12 +45,25 @@ Rails.application.configure do |config|
     Rack::LocaleMemorable,
     params_key: 'ui_locale',
     cookie_key: 'ui_locale',
-    secure_cookie: Rails.env.production?,
-    cookie_lifetime: 3.months
+    cookie_options: {
+      lifetime:  3.months,
+      domain:    'example.com',
+      path:      '/localized',
+      http_only: false,
+      secure:    Rails.env.production?
+    }
   )
 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
+```
+
 ## 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,13 +3,15 @@
 module Rack
   class LocaleMemorable
     class Response < Rack::Response
-      def remember_locale(explicit_locale, secure_cookie:, cookie_lifetime:, cookie_key:)
-        set_cookie cookie_key, {
-          value: explicit_locale,
-          expires: cookie_lifetime.from_now,
-          http_only: true,
-          secure: secure_cookie
-        }
+      def remember_locale(explicit_locale, key:, lifetime: 1.year, domain: nil, path: nil, http_only: true, secure: true)
+        set_cookie key, {
+          value:     explicit_locale,
+          expires:   lifetime.from_now,
+          domain:    domain,
+          path:      path,
+          http_only: http_only,
+          secure:    secure
+        }.compact
       end
     end
   end

data/lib/rack/locale_memorable/version.rb

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

data/lib/rack/locale_memorable.rb

@@ -7,12 +7,11 @@ require 'rack'
 
 module Rack
   class LocaleMemorable
-    def initialize(app, params_key: 'locale', cookie_key: 'locale', secure_cookie: true, cookie_lifetime: 1.year)
+    def initialize(app, params_key: 'locale', cookie_key: 'locale', cookie_options: {})
       @app = app
       @params_key = params_key
       @cookie_key = cookie_key
-      @secure_cookie = secure_cookie
-      @cookie_lifetime = cookie_lifetime
+      @cookie_options = cookie_options
     end
 
     def call(env)
@@ -23,9 +22,7 @@ module Rack
         if request.explicit_locale.present?
           response.remember_locale(
             request.explicit_locale,
-            secure_cookie: @secure_cookie,
-            cookie_lifetime: @cookie_lifetime,
-            cookie_key: @cookie_key
+            **@cookie_options.merge(key: @cookie_key)
           )
         end
         response.finish

data/rack-locale_memorable.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/nov/rack-locale_memorable'
-  spec.metadata['changelog_uri'] = 'https://github.com/nov/rack-locale_memorable/CHANGELOG.md'
+  spec.metadata['changelog_uri'] = 'https://github.com/nov/rack-locale_memorable/blob/main/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -37,4 +37,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'timecop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-locale_memorable
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - nov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-27 00:00:00.000000000 Z
+date: 2022-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Remember locale in rack layer
 email:
 - nov@matake.jp
@@ -147,7 +161,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/nov/rack-locale_memorable
   source_code_uri: https://github.com/nov/rack-locale_memorable
-  changelog_uri: https://github.com/nov/rack-locale_memorable/CHANGELOG.md
+  changelog_uri: https://github.com/nov/rack-locale_memorable/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: