Class: Spikard::StaticFilesConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/spikard/config.rb

Overview

Static file serving configuration.

Serves files from a directory at a given route prefix. Multiple static file configurations can be registered.

Examples:

static = StaticFilesConfig.new(
  directory: './public',
  route_prefix: '/static',
  index_file: true,
  cache_control: 'public, max-age=3600'
)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(directory:, route_prefix:, index_file: true, cache_control: nil) ⇒ StaticFilesConfig

Returns a new instance of StaticFilesConfig.

Parameters:

  • directory (String) —

    Directory path containing static files

  • route_prefix (String) —

    URL prefix for serving static files (e.g., “/static”)

  • index_file (Boolean) (defaults to: true) —

    Serve index.html for directory requests (default: true)

  • cache_control (String, nil) (defaults to: nil) —

    Optional Cache-Control header value (e.g., “public, max-age=3600”)



153
154
155
156
157
158
 
# File 'lib/spikard/config.rb', line 153

def initialize(directory:, route_prefix:, index_file: true, cache_control: nil)
  @directory = directory
  @route_prefix = route_prefix
  @index_file = index_file
  @cache_control = cache_control
end

Instance Attribute Details

#cache_control ⇒ Object

Returns the value of attribute cache_control.



147
148
149
 
# File 'lib/spikard/config.rb', line 147

def cache_control
  @cache_control
end

#directory ⇒ Object

Returns the value of attribute directory.



147
148
149
 
# File 'lib/spikard/config.rb', line 147

def directory
  @directory
end

#index_file ⇒ Object

Returns the value of attribute index_file.



147
148
149
 
# File 'lib/spikard/config.rb', line 147

def index_file
  @index_file
end

#route_prefix ⇒ Object

Returns the value of attribute route_prefix.



147
148
149
 
# File 'lib/spikard/config.rb', line 147

def route_prefix
  @route_prefix
end