Module: Her::Model::Parse::ClassMethods

Defined in:
lib/her/model/parse.rb

Instance Method Summary (collapse)

Instance Method Details

- (Object) include_root_in_json(value, options = {})

Return or change the value of `include_root_in_json`

Examples:

class User
  include Her::Model
  include_root_in_json true
end


79
80
81
82
# File 'lib/her/model/parse.rb', line 79

def include_root_in_json(value, options = {})
  @_her_include_root_in_json = value
  @_her_include_root_in_json_format = options[:format]
end

- (Object) parse_root_in_json(value, options = {})

Return or change the value of `parse_root_in_json`

Examples:

class User
  include Her::Model
  parse_root_in_json true
end

class User
  include Her::Model
  parse_root_in_json true, format: :active_model_serializers
end

class User
  include Her::Model
  parse_root_in_json true, format: :json_api
end


101
102
103
104
# File 'lib/her/model/parse.rb', line 101

def parse_root_in_json(value, options = {})
  @_her_parse_root_in_json = value
  @_her_parse_root_in_json_format = options[:format]
end

- (Object) request_new_object_on_build(value = nil)

Return or change the value of `request_new_object_on_build`

Examples:

class User
  include Her::Model
  request_new_object_on_build true
end


113
114
115
# File 'lib/her/model/parse.rb', line 113

def request_new_object_on_build(value = nil)
  @_her_request_new_object_on_build = value
end

- (Object) root_element(value = nil)

Return or change the value of `root_element`. Always defaults to the base name of the class.

Examples:

class User
  include Her::Model
  parse_root_in_json true
  root_element :huh
end

user = User.find(1) # { :huh => { :id => 1, :name => "Tobias" } }
user.name # => "Tobias"


128
129
130
131
132
133
134
135
136
137
138
# File 'lib/her/model/parse.rb', line 128

def root_element(value = nil)
  if value.nil?
    if json_api_format?
      @_her_root_element ||= self.name.split("::").last.pluralize.underscore.to_sym
    else
      @_her_root_element ||= self.name.split("::").last.underscore.to_sym
    end
  else
    @_her_root_element = value.to_sym
  end
end