Module: StaticPaths::Methods

Defined in:
lib/static_paths/methods.rb

Instance Method Summary

Instance Method Details

- (String) register_static_dir(path)

Registers a path as a static directory.

Examples:

  register_static_dir File.join(File.dirname(__FILE__),'..','..','..','static')

Parameters:

Returns:

  • (String) — The fully qualified form of the specified path.

Raises:

  • (RuntimeError) — The specified path is not a directory.


30
31
32
33
34
35
36
37
38
39
40
41
# File 'lib/static_paths/methods.rb', line 30

def register_static_dir(path)
  path = File.expand_path(path)

  unless File.directory?(path)
    raise(RuntimeError,"#{path.dump} must be a directory")
  end

  self.static_paths << path

  StaticPaths.paths << path
  return path
end

- (Set) static_paths

The registered static directories.

Returns:

  • (Set) — The directories registered so far.


11
12
13
# File 'lib/static_paths/methods.rb', line 11

def static_paths
  @static_paths ||= Set[]
end

- (true) unregister_static_dir!(path)

Unregisters any matching static directories.

Parameters:

  • (String) path — The path to unregistere.

Returns:

  • (true)


51
52
53
54
55
56
57
# File 'lib/static_paths/methods.rb', line 51

def unregister_static_dir!(path)
  path = File.expand_path(path)

  self.static_paths.reject! { |dir| dir == path }
  StaticPaths.paths.reject! { |dir| dir == path }
  return true
end

- (true) unregister_static_dirs!

Unregisters all previously registered static directories.

Returns:

  • (true)


64
65
66
67
68
# File 'lib/static_paths/methods.rb', line 64

def unregister_static_dirs!
  StaticPaths.paths.reject! { |dir| self.static_paths.include?(dir) }
  self.static_paths.clear
  return true
end