Contents

# frozen_string_literal: true

module Hanami
  class Application
    # Application routes
    #
    # Users are expected to inherit from this class to define their application
    # routes.
    #
    # @example
    #   # config/routes.rb
    #   # frozen_string_literal: true
    #
    #   require "hanami/application/routes"
    #
    #   module MyApp
    #     class Routes < Hanami::Application::Routes
    #       define do
    #         slice :main, at: "/" do
    #           root to: "home.show"
    #         end
    #       end
    #     end
    #   end
    #
    #   See {Hanami::Application::Router} for the syntax allowed within the
    #   `define` block.
    #
    # @see Hanami::Application::Router
    # @since 2.0.0
    class Routes
      # Defines application routes
      #
      # @yield DSL syntax to define application routes executed in the context
      # of {Hanami::Application::Router}
      # @returns [Proc]
      def self.define(&block)
        @_routes = block
      end

      # @api private
      def self.routes
        @_routes || raise(<<~MSG)
          Routes need to be defined before being able to fetch them. E.g.,
            define do
              slice :main, at: "/" do
                root to: "home.show"
              end
            end
        MSG
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
hanami-2.0.0.alpha3	lib/hanami/application/routes.rb