Class: RailsXapi::ActivityDefinition

Inherits:
ApplicationRecord show all
Includes:
ApplicationHelper, Serializable
Defined in:
app/models/rails_xapi/activity_definition.rb

Overview

The object optional activity definition. See: github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#activity-definition

Constant Summary

Constants included from Serializable

Serializable::LATIN_LETTERS, Serializable::LATIN_LETTERS_REGEX

Instance Method Summary collapse

Methods included from ApplicationHelper

#duration_to_minutes, #json_value_for_locale, #result_success_rate

Instance Method Details

#as_json ⇒ Object 



93
94
95
96
97
98
99
 
# File 'app/models/rails_xapi/activity_definition.rb', line 93

def as_json
  { name: name, description: description, type: activity_type }.tap do |hash|
    hash[:extensions] = extensions.as_json if extensions.present?
    hash[:moreInfo] = more_info if more_info.present?
    hash.merge!(interaction_activity.as_json) if interaction_activity.present?
  end
end

#assign_from_json_definition(definition_hash) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'app/models/rails_xapi/activity_definition.rb', line 42

def assign_from_json_definition(definition_hash)
  return unless definition_hash.present?

  normalized_hash = definition_hash.deep_stringify_keys
  interaction_keys = RailsXapi::InteractionActivity::INTERACTION_KEYS

  interaction_attrs = normalized_hash.slice(*interaction_keys)
  core_attrs = normalized_hash.except(*interaction_keys)
  # Assign base definition attributes
  self.attributes = core_attrs

  if normalized_hash["interactionType"].present?
    # Assign InteractionActivity attributes
    build_interaction_activity unless interaction_activity

    interaction_activity.interaction_type =
      interaction_attrs["interactionType"]
    interaction_activity.correct_responses_pattern =
      interaction_attrs["correctResponsesPattern"]
    # Build the interaction_components association
    interaction_activity.assign_interaction_components(interaction_attrs)

    # Trigger the validation
    unless interaction_activity.valid?
      raise ActiveRecord::RecordInvalid, interaction_activity
    end

    interaction_activity.save!
  end
end

#extensions=(extensions_data) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'app/models/rails_xapi/activity_definition.rb', line 73

def extensions=(extensions_data)
  unless extensions_data.is_a?(Hash)
    raise RailsXapi::Errors::XapiError,
          I18n.t(
            "rails_xapi.errors.attribute_must_be_a_hash",
            name: "extensions"
          )
  end

  # Find any existing extension for the given activity definition.
  exts = extensions.where(extendable_type: self.class.to_s, extendable_id: id)

  # If none, build and save the extensions.
  if exts.blank?
    extensions_data.each do |iri, data|
      extensions.build(iri: iri, value: serialized_value(data))
    end
  end
end

#moreInfo=(value) ⇒ Object 



37
38
39
40
 
# File 'app/models/rails_xapi/activity_definition.rb', line 37

def moreInfo=(value)
  # Match the camel case notation from JSON data.
  self.more_info = value
end

#type ⇒ Object 



26
27
28
29
 
# File 'app/models/rails_xapi/activity_definition.rb', line 26

def type
  # Virtual attribute to bypass the Single Table Inheritance keyword.
  activity_type
end

#type=(value) ⇒ Object 



31
32
33
34
35
 
# File 'app/models/rails_xapi/activity_definition.rb', line 31

def type=(value)
  # Store the `type` attribute into `activity_type` column to avoid
  # reserved key-words issues.
  self.activity_type = value
end