feat: rename PlugLocale.WebBrowser to PlugLocale.Browser

cozy-elixir · Dec 30, 2023 · 8b5b69f · 8b5b69f
1 parent c02d394
commit 8b5b69f
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@ Breaking changes:
 
 - rename `:sanitize_locale_by` option `:cast_locale_by`
 - rename `PlugLocale.WebBrowser.build_localized_path` to `PlugLocale.WebBrowser.build_locale_path`
+- rename `PlugLocale.WebBrowser` to `PlugLocale.Browser`
 
 New Features:
 

diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ Different from [`set_locale`](https://hex.pm/packages/set_locale), [`ex_cldr_plu
 - only does one simple thing - setting a locale-related assign (by default, it is `conn.assigns.locale`).
 - does not make any assumptions about the localization strategy, so it is not tightly bound to packages like [`gettext`](https://hex.pm/packages/gettext) or [`ex_cldr`](https://hex.pm/packages/ex_cldr).
 
-Check out `PlugLocale.WebBrowser`, `PlugLocale.Header` in [documentation](https://hexdocs.pm/plug_locale) for more details.
+Check out `PlugLocale.Browser`, `PlugLocale.Header` in [documentation](https://hexdocs.pm/plug_locale) for more details.
 
 ## Thanks
 

diff --git a/lib/plug_locale/web_browser.ex → lib/plug_locale/browser.ex b/lib/plug_locale/web_browser.ex → lib/plug_locale/browser.ex
@@ -1,4 +1,4 @@
-defmodule PlugLocale.WebBrowser do
+defmodule PlugLocale.Browser do
   @moduledoc """
   Puts locale into `assigns` storage for Web browser environment.
 
@@ -28,10 +28,10 @@ defmodule PlugLocale.WebBrowser do
   is useless. All you need is to construct a plug pipeline through
   `Plug.Builder`. For example:
 
-      defmodule DemoWeb.PlugWebBrowserLocalization do
+      defmodule DemoWeb.PlugBrowserLocalization do
         use Plug.Builder
       
-        plug PlugLocale.WebBrowser,
+        plug PlugLocale.Browser,
           default_locale: "en",
           locales: ["en", "zh"],
           route_identifier: :locale,
@@ -60,7 +60,7 @@ defmodule PlugLocale.WebBrowser do
 
           # ...
 
-          plug DemoWeb.PlugWebBrowserLocalization
+          plug DemoWeb.PlugBrowserLocalization
 
           # ...
         end
@@ -156,15 +156,15 @@ defmodule PlugLocale.WebBrowser do
   <ul>
     <li>
       <a
-        href={PlugLocale.WebBrowser.build_locale_path(@conn, "en")}
+        href={PlugLocale.Browser.build_locale_path(@conn, "en")}
         aria-label="switch to locale - en"
       >
         English
       </a>
     </li>
     <li>
       <a
-        href={PlugLocale.WebBrowser.build_locale_path(@conn, "zh")}
+        href={PlugLocale.Browser.build_locale_path(@conn, "zh")}
         aria-label="switch to locale - zh"
       >
         中文

diff --git a/...lug_locale/web_browser/accept_language.ex → lib/plug_locale/browser/accept_language.ex b/...lug_locale/web_browser/accept_language.ex → lib/plug_locale/browser/accept_language.ex
@@ -1,4 +1,4 @@
-defmodule PlugLocale.WebBrowser.AcceptLanguage do
+defmodule PlugLocale.Browser.AcceptLanguage do
   @moduledoc false
 
   def extract_locales(line) do

diff --git a/lib/plug_locale/web_browser/config.ex → lib/plug_locale/browser/config.ex b/lib/plug_locale/web_browser/config.ex → lib/plug_locale/browser/config.ex
@@ -1,4 +1,4 @@
-defmodule PlugLocale.WebBrowser.Config do
+defmodule PlugLocale.Browser.Config do
   @moduledoc false
 
   @opts_schema [

diff --git a/...cale/web_browser/accept_language_test.exs → ...g_locale/browser/accept_language_test.exs b/...cale/web_browser/accept_language_test.exs → ...g_locale/browser/accept_language_test.exs
@@ -1,6 +1,6 @@
-defmodule PlugLocale.WebBrowser.AcceptLanguageTest do
+defmodule PlugLocale.Browser.AcceptLanguageTest do
   use ExUnit.Case, async: true
-  alias PlugLocale.WebBrowser.AcceptLanguage
+  alias PlugLocale.Browser.AcceptLanguage
 
   describe "extract_locales/1" do
     test "works for normal languages" do

diff --git a/test/plug_locale/web_browser_test.exs → test/plug_locale/browser_test.exs b/test/plug_locale/web_browser_test.exs → test/plug_locale/browser_test.exs
@@ -1,4 +1,4 @@
-defmodule PlugLocale.WebBrowserTest do
+defmodule PlugLocale.BrowserTest do
   use ExUnit.Case, async: true
   use Plug.Test
   import ExUnit.CaptureLog
@@ -11,7 +11,7 @@ defmodule PlugLocale.WebBrowserTest do
     plug Plug.Parsers,
       parsers: [:urlencoded]
 
-    plug PlugLocale.WebBrowser,
+    plug PlugLocale.Browser,
       default_locale: "en",
       locales: ["en", "zh-Hans"],
       detect_locale_from: [:query, :cookie, :referrer, :accept_language]
@@ -39,7 +39,7 @@ defmodule PlugLocale.WebBrowserTest do
 
     plug :match
 
-    plug PlugLocale.WebBrowser,
+    plug PlugLocale.Browser,
       default_locale: "en",
       locales: ["en", "zh-Hans"],
       detect_locale_from: [:query, :cookie, :referrer, :accept_language]
@@ -67,7 +67,7 @@ defmodule PlugLocale.WebBrowserTest do
 
     plug :match
 
-    plug PlugLocale.WebBrowser,
+    plug PlugLocale.Browser,
       default_locale: "en",
       locales: ["en", "zh-Hans"],
       detect_locale_from: [:query, :cookie, :referrer, :accept_language]
@@ -78,7 +78,7 @@ defmodule PlugLocale.WebBrowserTest do
 
     def put_cookie(conn, _opts) do
       if locale = conn.assigns[:locale] do
-        PlugLocale.WebBrowser.put_locale_resp_cookie(conn, locale, max_age: 3600)
+        PlugLocale.Browser.put_locale_resp_cookie(conn, locale, max_age: 3600)
       else
         conn
       end
@@ -227,7 +227,7 @@ defmodule PlugLocale.WebBrowserTest do
   test "build_locale_path/2" do
     conn = conn(:get, "/en/posts/7")
     conn = DemoRouter.call(conn, @opts)
-    assert "/zh-Hans/posts/7" == PlugLocale.WebBrowser.build_locale_path(conn, "zh-Hans")
+    assert "/zh-Hans/posts/7" == PlugLocale.Browser.build_locale_path(conn, "zh-Hans")
   end
 
   test "put_locale_resp_cookie/2" do