lib/lotus/routes.rb in lotusrb-0.2.1 vs lib/lotus/routes.rb in lotusrb-0.3.0

@@ -1,5 +1,7 @@
+require 'lotus/utils/escape'
+
 module Lotus
   # Routes factory
   #
   # A Lotus application has this factory instantiated by default and associated
   # to the `Routes` constant, under the application namespace.
@@ -21,19 +23,19 @@
     #
     # @param name [Symbol] the route name
     # @param args [Array,nil] an optional set of arguments that is passed down
     #   to the wrapped route set.
     #
-    # @return [String] the corresponding relative URL
+    # @return [Lotus::Utils::Escape::SafeString] the corresponding relative URL
     #
     # @raise Lotus::Routing::InvalidRouteException
     #
     # @since 0.1.0
     #
     # @see http://rdoc.info/gems/lotus-router/Lotus/Router#path-instance_method
     #
-    # @example
+    # @example Basic example
     #   require 'lotus'
     #
     #   module Bookshelf
     #     class Application < Lotus::Application
     #       configure do
@@ -47,29 +49,48 @@
     #   Bookshelf::Routes.path(:login)
     #     # => '/login'
     #
     #   Bookshelf::Routes.path(:login, return_to: '/dashboard')
     #     # => '/login?return_to=%2Fdashboard'
+    #
+    # @example Dynamic finders
+    #   require 'lotus'
+    #
+    #   module Bookshelf
+    #     class Application < Lotus::Application
+    #       configure do
+    #         routes do
+    #           get '/login', to: 'sessions#new', as: :login
+    #         end
+    #       end
+    #     end
+    #   end
+    #
+    #   Bookshelf::Routes.login_path
+    #     # => '/login'
+    #
+    #   Bookshelf::Routes.login_path(return_to: '/dashboard')
+    #     # => '/login?return_to=%2Fdashboard'
     def path(name, *args)
-      @routes.path(name, *args)
+      Utils::Escape::SafeString.new(@routes.path(name, *args))
     end
 
     # Return an absolute path for the given route name
     #
     # @param name [Symbol] the route name
     # @param args [Array,nil] an optional set of arguments that is passed down
     #   to the wrapped route set.
     #
-    # @return [String] the corresponding absolute URL
+    # @return [Lotus::Utils::Escape::SafeString] the corresponding absolute URL
     #
     # @raise Lotus::Routing::InvalidRouteException
     #
     # @since 0.1.0
     #
     # @see http://rdoc.info/gems/lotus-router/Lotus/Router#url-instance_method
     #
-    # @example
+    # @example Basic example
     #   require 'lotus'
     #
     #   module Bookshelf
     #     class Application < Lotus::Application
     #       configure do
@@ -86,10 +107,45 @@
     #   Bookshelf::Routes.url(:login)
     #     # => 'https://bookshelf.org/login'
     #
     #   Bookshelf::Routes.url(:login, return_to: '/dashboard')
     #     # => 'https://bookshelf.org/login?return_to=%2Fdashboard'
+    #
+    # @example Dynamic finders
+    #   require 'lotus'
+    #
+    #   module Bookshelf
+    #     class Application < Lotus::Application
+    #       configure do
+    #         routes do
+    #           scheme 'https'
+    #           host   'bookshelf.org'
+    #
+    #           get '/login', to: 'sessions#new', as: :login
+    #         end
+    #       end
+    #     end
+    #   end
+    #
+    #   Bookshelf::Routes.login_url
+    #     # => 'https://bookshelf.org/login'
+    #
+    #   Bookshelf::Routes.login_url(return_to: '/dashboard')
+    #     # => 'https://bookshelf.org/login?return_to=%2Fdashboard'
     def url(name, *args)
-      @routes.url(name, *args)
+      Utils::Escape::SafeString.new(@routes.url(name, *args))
+    end
+
+    protected
+    # @since 0.3.0
+    # @api private
+    def method_missing(m, *args)
+      named_route, type = m.to_s.split(/\_(path|url)\z/)
+
+      if type
+        public_send(type, named_route.to_sym, *args)
+      else
+        super
+      end
     end
   end
 end