class PlaceOS::Model::Asset

Included Modules

Defined in:

placeos-models/asset.cr

Constant Summary

CALLBACKS = {before_save: [] of Nil, after_save: [] of Nil, before_create: [do self.created_at = self.updated_at = Time.utc end] of Nil, after_create: [] of Nil, before_update: [do self.updated_at = Time.utc end] of Nil, after_update: [] of Nil, before_destroy: [:cleanup_bookings] of Nil, after_destroy: [] of Nil}
Log = ::Log.for(self)

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class PlaceOS::Model::ModelBase

after_create after_create, after_destroy after_destroy, after_save after_save, after_update after_update, apply_defaults apply_defaults, assign_attributes(params : HTTP::Params | Hash(String, String) | Tuple(String, String))
assign_attributes(model : PlaceOS::Model::ModelBase)
assign_attributes assign_attributes, attributes attributes, attributes_tuple attributes_tuple, before_create before_create, before_destroy before_destroy, before_save before_save, before_update before_update, invoke_props invoke_props, persistent_attributes persistent_attributes, run_create_callbacks(&) run_create_callbacks, run_destroy_callbacks(&) run_destroy_callbacks, run_save_callbacks(&) run_save_callbacks, run_update_callbacks(&) run_update_callbacks

Constructor methods inherited from class PlaceOS::Model::ModelBase

new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
new(pull : JSON::PullParser)
new(rs : DB::ResultSet) new

Class methods inherited from class PlaceOS::Model::ModelBase

attributes : Array(Symbol) attributes, auto_generate_id : Bool auto_generate_id, from_rs(rs : DB::ResultSet) from_rs, primary_key : Symbol primary_key

Instance methods inherited from module PlaceOS::Model::Associations

format_list_for_postgres(list : Enumerable(String)) : String format_list_for_postgres, reset_associations reset_associations

Class methods inherited from module PlaceOS::Model::Associations

format_list_for_postgres(list : Enumerable(String)) : String format_list_for_postgres

Macros inherited from module PlaceOS::Model::Associations

belongs_to(parent_class, dependent = :none, association_name = nil, foreign_key = nil, presence = false, pk_type = nil, serialize = true) belongs_to, has_many(child_class, collection_name = nil, dependent = :none, foreign_key = nil, serialize = false) has_many, has_one(child_class, dependent = :none, association_name = nil, presence = false) has_one

Constructor Detail

def self.from_json(string_or_io : String | IO, trusted : Bool = false) : self #

def self.from_json(string_or_io : String | IO, root : String, trusted : Bool = false) : self #

Deserializes the given JSON in string_or_io into an instance of self, assuming the JSON consists of an JSON object with key root, and whose value is the value to deserialize. Will not deserialise from fields with mass_assign: false

class User < ActiveModel::Model
  attribute name : String
  attribute google_id : UUID, mass_assign: false
end

User.from_json(%({"main": {"name": "Jason", "google_id": "f6f70bfb-c882-446d-8758-7ce47db39620"}}), root: "main") # => #<User:0x103131b20 @name="Jason">

def self.from_trusted_json(string_or_io : String | IO, root : String) : self #

def self.from_trusted_json(string_or_io : String | IO) : self #

Serialize from a trusted JSON source


def self.from_trusted_yaml(string_or_io : String | IO) : self #

Serialize from a trusted YAML source


def self.from_yaml(string_or_io : String | IO, trusted : Bool = false) : self #

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(rs : DB::ResultSet) #

def self.new(created_at : Time | ActiveModel::Model::None = ::ActiveModel::Model::None.new, updated_at : Time | ActiveModel::Model::None = ::ActiveModel::Model::None.new, identifier : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, serial_number : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, other_data : JSON::Any | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, barcode : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, asset_type_id : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, purchase_order_id : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, zone_id : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, id : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new) #

def self.new(params : HTTP::Params | Hash(String, String) | Tuple(String, String)) #

Initialize PlaceOS::Model::Asset from HTTP::Params.


Class Method Detail

def self.attributes : Array(Symbol) #

Returns all attribute keys.


def self.auto_generate_id : Bool #

def self.by_asset_type_id(id) #

Look up instances of this model dependent on the foreign key


[View source]
def self.by_purchase_order_id(id) #

Look up instances of this model dependent on the foreign key


[View source]
def self.by_zone_id(id) #

Look up instances of this model dependent on the foreign key


[View source]
def self.changes(id : PrimaryKeyType = nil) : ChangeFeed #

Changefeed at row (if #id passed) or whole table level. Returns a ChangeFeed instance which can be used to invoke async callbacks via on or use blocking Iterator via each method.


def self.elastic #

def self.from_rs(__temp_565 : DB::ResultSet) #

def self.on_error(err : Exception | IO::Error) #

def self.primary_key : Symbol #

def self.table_name #

Instance Method Detail

def __asset_type : AssetType | Nil #

def __asset_type=(__asset_type : AssetType | Nil) #

def __purchase_order : AssetPurchaseOrder | Nil #

def __purchase_order=(__purchase_order : AssetPurchaseOrder | Nil) #

def __zone : Zone | Nil #

def __zone=(__zone : Zone | Nil) #

def after_create #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


[View source]
def after_destroy #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


[View source]
def after_initialize(trusted : Bool) #

def after_save #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


[View source]
def after_update #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


[View source]
def apply_defaults #

Generate code to apply default values


def asset_type : AssetType | Nil #

Retrieves the parent relationship


[View source]
def asset_type! : AssetType #

[View source]
def asset_type=(parent : AssetType) #

Sets the parent relationship


[View source]
def asset_type_id : String | Nil #

#asset_type_id getter


def asset_type_id=(value : String | Nil) #

#asset_type_id setter


def asset_type_id_assigned? : Bool #

def asset_type_id_change : Tuple(String | Nil | Nil, String | Nil | Nil) | Nil #

Returns a Tuple of the previous and the current value of an instance variable if it has changed


def asset_type_id_changed? : Bool #

def asset_type_id_default : String | Nil #

#asset_type_id's default value


def asset_type_id_present? : Bool #

def asset_type_id_was : String | Nil | Nil #

def asset_type_id_will_change! : Nil #

Include #asset_type_id in the set of changed attributes, whether it has changed or not.


def assign_attributes(created_at : Time | Missing = Missing, updated_at : Time | Missing = Missing, identifier : String | Nil | Missing = Missing, serial_number : String | Nil | Missing = Missing, other_data : JSON::Any | Nil | Missing = Missing, barcode : String | Nil | Missing = Missing, asset_type_id : String | Nil | Missing = Missing, purchase_order_id : String | Nil | Missing = Missing, zone_id : String | Nil | Missing = Missing, id : String | Nil | Missing = Missing) #

Assign to multiple attributes.


def assign_attributes(params : HTTP::Params | Hash(String, String) | Tuple(String, String)) #

Assign to mulitple attributes via HTTP::Params.


def assign_attributes(model : PlaceOS::Model::Asset) #

Assign to multiple attributes from a model object


def assign_attributes_from_json(json, root : String) #

def assign_attributes_from_json(json) #

def assign_attributes_from_trusted_json(json, root : String) #

def assign_attributes_from_trusted_json(json) #

Assign each field from JSON if field exists in JSON and has changed in model


def assign_attributes_from_trusted_yaml(yaml) #

def assign_attributes_from_yaml(yaml) #

Uses the YAML parser as JSON is valid YAML


def attributes #

Returns a Hash of all attribute values


def attributes_tuple #

Returns a NamedTuple of all attribute values.


def barcode : String | Nil #

#barcode getter


def barcode=(value : String | Nil) #

#barcode setter


def barcode_assigned? : Bool #

def barcode_change : Tuple(String | Nil | Nil, String | Nil | Nil) | Nil #

Returns a Tuple of the previous and the current value of an instance variable if it has changed


def barcode_changed? : Bool #

def barcode_default : String | Nil #

#barcode's default value


[View source]
def barcode_present? : Bool #

def barcode_was : String | Nil | Nil #

def barcode_will_change! : Nil #

Include #barcode in the set of changed attributes, whether it has changed or not.


def before_create #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


[View source]
def before_destroy #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


[View source]
def before_save #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


[View source]
def before_update #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


[View source]
def changed? #

Check if any attributes have changed.


def changed_attributes #

Returns a Hash with all changed attributes.


def changed_json(io : IO) : Nil #

Serialize the set of changed attributes to JSON.


def changed_json : String #

Serialize the set of changed attributes to JSON.


def changed_persist_attributes #

def changed_yaml(io : IO) : Nil #

Serialize the set of changed attributes to YAML.


def changed_yaml : String #

Serialize the set of changed attributes to YAML.


def clear_changes_information #

Reset changes for all attributes.


def created_at : Time #

#created_at getter


def created_at=(value : Time) #

Setters #created_at setter


def created_at? : Time | Nil #

def created_at_assigned? : Bool #

def created_at_change : Tuple(Time | Nil, Time | Nil) | Nil #

Returns a Tuple of the previous and the current value of an instance variable if it has changed


def created_at_changed? : Bool #

def created_at_default : Time #

#created_at's default value


def created_at_present? : Bool #

def created_at_was : Time | Nil #

def created_at_will_change! : Nil #

Include #created_at in the set of changed attributes, whether it has changed or not.


def id : String | Nil #

#id getter


def id=(value : String | Nil) #

#id setter


def id? : String | Nil | Nil #
Description copied from class PgORM::Base

Same as #id but may return nil when the record hasn't been saved instead of raising.


def id_assigned? : Bool #

def id_change : Tuple(String | Nil | Nil, String | Nil | Nil) | Nil #

Returns a Tuple of the previous and the current value of an instance variable if it has changed


def id_changed? : Bool #

def id_default : String | Nil #

#id's default value


def id_present? : Bool #

def id_was : String | Nil | Nil #

def id_will_change! : Nil #

Include #id in the set of changed attributes, whether it has changed or not.


def identifier : String | Nil #

#identifier getter


def identifier=(value : String | Nil) #

#identifier setter


def identifier_assigned? : Bool #

def identifier_change : Tuple(String | Nil | Nil, String | Nil | Nil) | Nil #

Returns a Tuple of the previous and the current value of an instance variable if it has changed


def identifier_changed? : Bool #

def identifier_default : String | Nil #

#identifier's default value


[View source]
def identifier_present? : Bool #

def identifier_was : String | Nil | Nil #

def identifier_will_change! : Nil #

Include #identifier in the set of changed attributes, whether it has changed or not.


def invoke_props #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


def other_data : JSON::Any | Nil #

#other_data getter


def other_data=(value : JSON::Any | Nil) #

#other_data setter


def other_data_assigned? : Bool #

def other_data_change : Tuple(JSON::Any | Nil | Nil, JSON::Any | Nil | Nil) | Nil #

Returns a Tuple of the previous and the current value of an instance variable if it has changed


def other_data_changed? : Bool #

def other_data_default : JSON::Any | Nil #

#other_data's default value


[View source]
def other_data_present? : Bool #

def other_data_was : JSON::Any | Nil | Nil #

def other_data_will_change! : Nil #

Include #other_data in the set of changed attributes, whether it has changed or not.


def persistent_attributes #

Returns a Hash of all attributes that can be persisted.


def purchase_order : AssetPurchaseOrder | Nil #

Retrieves the parent relationship


[View source]
def purchase_order! : AssetPurchaseOrder #

[View source]
def purchase_order=(parent : AssetPurchaseOrder) #

Sets the parent relationship


[View source]
def purchase_order_id : String | Nil #

#purchase_order_id getter


def purchase_order_id=(value : String | Nil) #

#purchase_order_id setter


def purchase_order_id_assigned? : Bool #

def purchase_order_id_change : Tuple(String | Nil | Nil, String | Nil | Nil) | Nil #

Returns a Tuple of the previous and the current value of an instance variable if it has changed


def purchase_order_id_changed? : Bool #

def purchase_order_id_default : String | Nil #

#purchase_order_id's default value


def purchase_order_id_present? : Bool #

def purchase_order_id_was : String | Nil | Nil #

def purchase_order_id_will_change! : Nil #

Include #purchase_order_id in the set of changed attributes, whether it has changed or not.


def reset_associations #

[View source]
def restore_attributes #

Reset each attribute to their previous values and clears all changes.


def run_create_callbacks(&) #

Wrap a block with callbacks for the appropriate crud operation


[View source]
def run_destroy_callbacks(&) #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


[View source]
def run_save_callbacks(&) #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


[View source]
def run_update_callbacks(&) #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


[View source]
def serial_number : String | Nil #

#serial_number getter


def serial_number=(value : String | Nil) #

#serial_number setter


def serial_number_assigned? : Bool #

def serial_number_change : Tuple(String | Nil | Nil, String | Nil | Nil) | Nil #

Returns a Tuple of the previous and the current value of an instance variable if it has changed


def serial_number_changed? : Bool #

def serial_number_default : String | Nil #

#serial_number's default value


[View source]
def serial_number_present? : Bool #

def serial_number_was : String | Nil | Nil #

def serial_number_will_change! : Nil #

Include #serial_number in the set of changed attributes, whether it has changed or not.


def table_name #

def updated_at : Time #

#updated_at getter


def updated_at=(value : Time) #

#updated_at setter


def updated_at? : Time | Nil #

def updated_at_assigned? : Bool #

def updated_at_change : Tuple(Time | Nil, Time | Nil) | Nil #

Returns a Tuple of the previous and the current value of an instance variable if it has changed


def updated_at_changed? : Bool #

def updated_at_default : Time #

#updated_at's default value


def updated_at_present? : Bool #

def updated_at_was : Time | Nil #

def updated_at_will_change! : Nil #

Include #updated_at in the set of changed attributes, whether it has changed or not.


def validate_nilability #

Validate that all non-nillable fields have values.


def zone : Zone | Nil #

Retrieves the parent relationship


[View source]
def zone! : Zone #

[View source]
def zone=(parent : Zone) #

Sets the parent relationship


[View source]
def zone_id : String | Nil #

#zone_id getter


def zone_id=(value : String | Nil) #

#zone_id setter


def zone_id_assigned? : Bool #

def zone_id_change : Tuple(String | Nil | Nil, String | Nil | Nil) | Nil #

Returns a Tuple of the previous and the current value of an instance variable if it has changed


def zone_id_changed? : Bool #

def zone_id_default : String | Nil #

#zone_id's default value


def zone_id_present? : Bool #

def zone_id_was : String | Nil | Nil #

def zone_id_will_change! : Nil #

Include #zone_id in the set of changed attributes, whether it has changed or not.