Allow aliases and helpers to be disabled via scope

Author: josevalim

lib/phoenix/router.ex

@@ -470,7 +470,10 @@ defmodule Phoenix.Router do
 
   ## Options
 
-    * `:as` - configures the named helper exclusively
+    * `:as` - configures the named helper exclusively. If false, does not generate
+      a helper.
+    * `:alias` - configure if the scope alias should be applied to the route.
+      Defaults to true, disables scoping if false.
     * `:log` - the level to log the route dispatching under,
       may be set to false. Defaults to `:debug`
     * `:host` - a string containing the host scope, or prefix host scope,
@@ -744,11 +747,11 @@ defmodule Phoenix.Router do
 
   The supported options are:
 
-    * `:path` - a string containing the path scope
-    * `:as` - a string or atom containing the named helper scope
-    * `:alias` - an alias (atom) containing the controller scope.
-      When set, this value may be overridden per route by passing `alias: false`
-      to route definitions, such as `get`, `post`, etc.
+    * `:path` - a string containing the path scope.
+    * `:as` - a string or atom containing the named helper scope. When set to
+      false, it resets the nested helper scopes.
+    * `:alias` - an alias (atom) containing the controller scope. When set to
+      false, it resets all nested aliases.
     * `:host` - a string containing the host scope, or prefix host scope,
       ie `"foo.bar.com"`, `"foo."`
     * `:private` - a map of private data to merge into the connection when a route matches

lib/phoenix/router/scope.ex

@@ -90,26 +90,27 @@ defmodule Phoenix.Router.Scope do
   end
 
   def push(module, opts) when is_list(opts) do
+    top = get_top(module)
+
     path =
       if path = Keyword.get(opts, :path) do
         path |> validate_path() |> String.split("/", trim: true)
       else
         []
       end
 
-    alias = Keyword.get(opts, :alias) |> List.wrap() |> Enum.map(&Atom.to_string/1)
-    as = Keyword.get(opts, :as) |> List.wrap()
+    alias = append_unless_false(top, opts, :alias, &Atom.to_string(&1))
+    as = append_unless_false(top, opts, :as, & &1)
     host = Keyword.get(opts, :host)
     private = Keyword.get(opts, :private, %{})
     assigns = Keyword.get(opts, :assigns, %{})
 
-    top = get_top(module)
     update_stack(module, fn stack -> [top | stack] end)
 
     put_top(module, %Scope{
       path: top.path ++ path,
-      alias: top.alias ++ alias,
-      as: top.as ++ as,
+      alias: alias,
+      as: as,
       host: host || top.host,
       pipes: top.pipes,
       private: Map.merge(top.private, private),
@@ -119,6 +120,14 @@ defmodule Phoenix.Router.Scope do
     })
   end
 
+  defp append_unless_false(top, opts, key, fun) do
+    case opts[key] do
+      false -> []
+      nil -> Map.fetch!(top, key)
+      other -> Map.fetch!(top, key) ++ [fun.(other)]
+    end
+  end
+
   @doc """
   Pops a scope from the module stack.
   """

test/phoenix/router/helpers_test.exs

@@ -53,6 +53,10 @@ defmodule Phoenix.Router.HelpersTest do
 
     scope "/admin/new", alias: Admin, as: "admin" do
       resources "/messages", MessageController
+
+      scope "/unscoped", as: false do
+        resources "/messages", MessageController, as: :my_admin_message
+      end
     end
 
     scope "/trails", trailing_slash: true do
@@ -385,6 +389,13 @@ defmodule Phoenix.Router.HelpersTest do
     assert Helpers.admin_message_path(__MODULE__, :show, 1) == "/admin/new/messages/1"
   end
 
+  test "scoped route helpers generated unscoped :as options" do
+    assert Helpers.my_admin_message_path(__MODULE__, :index, []) == "/admin/new/unscoped/messages"
+    assert Helpers.my_admin_message_path(__MODULE__, :index) == "/admin/new/unscoped/messages"
+    assert Helpers.my_admin_message_path(__MODULE__, :show, 1, []) == "/admin/new/unscoped/messages/1"
+    assert Helpers.my_admin_message_path(__MODULE__, :show, 1) == "/admin/new/unscoped/messages/1"
+  end
+
   test "scoped route helpers generated with trailing slashes" do
     assert Helpers.trail_path(__MODULE__, :index) == "/trails/"
     assert Helpers.trail_path(__MODULE__, :index, id: 5) == "/trails/?id=5"

test/phoenix/router/scope_test.exs

@@ -51,9 +51,15 @@ defmodule Phoenix.Router.ScopedRoutingTest do
 
       scope "/v1", alias: V1 do
         resources "/users", UserController, only: [:delete], private: %{private_token: "baz"}
+
         get "/noalias", Api.V1.UserController, :proxy,
           private: %{proxy_to: {scoped_alias(__MODULE__, UserController), :show}},
           alias: false
+
+        scope "/scoped", alias: false do
+          get "/noalias", Api.V1.UserController, :proxy,
+          private: %{proxy_to: {scoped_alias(__MODULE__, Api.V1.UserController), :show}}
+        end
       end
     end
 
@@ -205,12 +211,18 @@ defmodule Phoenix.Router.ScopedRoutingTest do
     end
   end
 
-  test "alias false with expanded scoped alias" do
+  test "alias false with expanded scoped alias via option" do
     conn = call(Router, :get, "/api/v1/noalias")
     assert conn.status == 200
     assert conn.resp_body == "api v1 users show"
   end
 
+  test "alias false with expanded scoped alias via scope" do
+    conn = call(Router, :get, "/api/v1/scoped/noalias")
+    assert conn.status == 200
+    assert conn.resp_body == "api v1 users show"
+  end
+
   test "raises for reserved prefixes" do
     assert_raise ArgumentError, ~r/`static` is a reserved route prefix/, fn ->
       defmodule ErrorRouter do