Class: Gitlab::Json::PrecompiledJson

Inherits:

Object

• Object
• Gitlab::Json::PrecompiledJson

Defined in:

lib/gitlab/json.rb

Overview

Wrapper class used to skip JSON dumping on Grape endpoints.

Constant Summary

UnsupportedFormatError =

Class.new(StandardError)

Instance Method Summary

• #format ⇒ Object
• #initialize(value) ⇒ PrecompiledJson constructor

  A new instance of PrecompiledJson.

• #render_in(_view_context) ⇒ Object
• #to_s ⇒ String

  Convert the value to a String.

Constructor Details

#PrecompiledJson.new("foo") ⇒ PrecompiledJson #PrecompiledJson.new(["foo", "bar"]) ⇒ PrecompiledJson

Returns a new instance of PrecompiledJson.

Overloads:

• #PrecompiledJson.new("foo") ⇒ PrecompiledJson

  Parameters:

  • value (String)
• #PrecompiledJson.new(["foo", "bar"]) ⇒ PrecompiledJson

  Parameters:

  • value (Array<String>)

# File 'lib/gitlab/json.rb', line 208

def initialize(value)
  @value = value
end

Instance Method Details

#format ⇒ Object

# File 'lib/gitlab/json.rb', line 229

def format
  :json
end

#render_in(_view_context) ⇒ Object

# File 'lib/gitlab/json.rb', line 225

def render_in(_view_context)
  to_s
end

#to_s ⇒ String

Convert the value to a String. This will invoke ‘#to_s` on the members of the value if it’s an array.

Returns:

• (String)

Raises:

• (NoMethodError) —

  if the objects in an array doesn’t support to_s

• (PrecompiledJson::UnsupportedFormatError) —

  if the value is neither a String or Array

# File 'lib/gitlab/json.rb', line 218

def to_s
  return @value if @value.is_a?(String)
  return "[#{@value.join(',')}]" if @value.is_a?(Array)

  raise UnsupportedFormatError
end