Class: Grape::Path

Inherits:
Object
  • Object
show all
Defined in:
lib/grape/path.rb

Overview

Represents a path to an endpoint.

Defined Under Namespace

Classes: PartsCache

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(raw_path, namespace, settings) ⇒ Path

Returns a new instance of Path.



14
15
16
17
18
 
# File 'lib/grape/path.rb', line 14

def initialize(raw_path, namespace, settings)
  @raw_path = raw_path
  @namespace = namespace
  @settings = settings
end

Instance Attribute Details

#namespace ⇒ Object (readonly)

Returns the value of attribute namespace.



12
13
14
 
# File 'lib/grape/path.rb', line 12

def namespace
  @namespace
end

#raw_path ⇒ Object (readonly)

Returns the value of attribute raw_path.



12
13
14
 
# File 'lib/grape/path.rb', line 12

def raw_path
  @raw_path
end

#settings ⇒ Object (readonly)

Returns the value of attribute settings.



12
13
14
 
# File 'lib/grape/path.rb', line 12

def settings
  @settings
end

Class Method Details

.prepare(raw_path, namespace, settings) ⇒ Object 



8
9
10
 
# File 'lib/grape/path.rb', line 8

def self.prepare(raw_path, namespace, settings)
  Path.new(raw_path, namespace, settings)
end

Instance Method Details

#mount_path ⇒ Object 



20
21
22
 
# File 'lib/grape/path.rb', line 20

def mount_path
  settings[:mount_path]
end

#namespace? ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/grape/path.rb', line 44

def namespace?
  namespace&.match?(/^\S/) && namespace != '/'
end

#path ⇒ Object 



62
63
64
 
# File 'lib/grape/path.rb', line 62

def path
  Grape::Router.normalize_path(PartsCache[parts])
end

#path? ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/grape/path.rb', line 48

def path?
  raw_path&.match?(/^\S/) && raw_path != '/'
end

#path_with_suffix ⇒ Object 



66
67
68
 
# File 'lib/grape/path.rb', line 66

def path_with_suffix
  "#{path}#{suffix}"
end

#root_prefix ⇒ Object 



24
25
26
 
# File 'lib/grape/path.rb', line 24

def root_prefix
  split_setting(:root_prefix)
end

#suffix ⇒ Object 



52
53
54
55
56
57
58
59
60
 
# File 'lib/grape/path.rb', line 52

def suffix
  if uses_specific_format?
    "(.#{settings[:format]})"
  elsif !uses_path_versioning? || (namespace? || path?)
    '(.:format)'
  else
    '(/.:format)'
  end
end

#to_s ⇒ Object 



70
71
72
 
# File 'lib/grape/path.rb', line 70

def to_s
  path_with_suffix
end

#uses_path_versioning? ⇒ Boolean

Returns:

  • (Boolean) 


36
37
38
39
40
41
42
 
# File 'lib/grape/path.rb', line 36

def uses_path_versioning?
  if settings.key?(:version) && settings[:version_options] && settings[:version_options].key?(:using)
    (settings[:version] && settings[:version_options][:using] == :path)
  else
    false
  end
end

#uses_specific_format? ⇒ Boolean

Returns:

  • (Boolean) 


28
29
30
31
32
33
34
 
# File 'lib/grape/path.rb', line 28

def uses_specific_format?
  if settings.key?(:format) && settings.key?(:content_types)
    (settings[:format] && Array(settings[:content_types]).size == 1)
  else
    false
  end
end