class

PlaceOS::Model::GroupUser

Inherits PlaceOS::Model::GroupHistory::Mixin < PgORM::Timestamps < PgORM::Base < PgORM::Validators < PgORM::Table < PgORM::Persistence < PgORM::Associations < ActiveModel::Callbacks < ActiveModel::Validation < ActiveModel::Model < DB::Mappable < DB::Serializable < YAML::Serializable < JSON::Serializable < Reference < Object

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

Constants

CALLBACKS = { before_save: [do if (__temp_1352 = @user) && __temp_1352.new_record? __temp_1352.save self.user_id = __temp_1352.id.not_nil! end end, do if (__temp_1354 = @group) && __temp_1354.new_record? __temp_1354.save self.group_id = __temp_1354.id.not_nil! end end, :capture_history_state] of Nil, after_save: [:record_history_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: [] of Nil, after_destroy: [do end, do end, :record_history_destroy] of Nil, }

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

PRIMARY_KEY_TYPES = {:user_id => String, :group_id => UUID} of Nil => Nil

macro level key => type

PRIMARY_KEYS = [{:user_id, :group_id}]

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

Constructors

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

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

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">
from_trusted_json(string_or_io : String | IO, root : String) : self

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

from_trusted_json(string_or_io : String | IO) : self

Serialize from a trusted JSON source

from_trusted_yaml(string_or_io : String | IO) : self

Serialize from a trusted YAML source

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

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

Source
new(pull : JSON::PullParser)

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

Source
new(rs : DB::ResultSet)

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

new(created_at : Time | ActiveModel::Model::None = ::ActiveModel::Model::None.new, updated_at : Time | ActiveModel::Model::None = ::ActiveModel::Model::None.new, user_id : String | ActiveModel::Model::None = ::ActiveModel::Model::None.new, group_id : UUID | ActiveModel::Model::None = ::ActiveModel::Model::None.new, permissions : Int32 | ActiveModel::Model::None = ::ActiveModel::Model::None.new)

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

new(params : HTTP::Params | Hash(String, String) | Tuple(String, String))

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

Class methods

attributes

Returns all attribute keys.

by_group_id(id)
Source
by_user_id(id)
Source
changes(id : Tuple(String, UUID) | Nil = 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.

from_rs(__temp_2442 : DB::ResultSet)

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

on_error(err : Exception | IO::Error)

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

primary_key

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

Source
table_name

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

Instance methods

acting_user
acting_user=(acting_user : PlaceOS::Model::User | Nil)
after_create

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

after_destroy

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

after_initialize(trusted : Bool)

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

after_save

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

after_update

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

apply_defaults

Generate code to apply default values

assign_attributes(created_at : Time | Missing = Missing, updated_at : Time | Missing = Missing, user_id : String | Missing = Missing, group_id : UUID | Missing = Missing, permissions : Int32 | Missing = Missing)

Assign to multiple attributes.

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

Assign to multiple attributes via HTTP::Params.

assign_attributes(model : PlaceOS::Model::GroupUser)

Assign to multiple attributes from a model object

assign_attributes_from_json(json, root : String)

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

assign_attributes_from_json(json)

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

assign_attributes_from_trusted_json(json, root : String)

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

assign_attributes_from_trusted_json(json)

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

assign_attributes_from_trusted_yaml(yaml)

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

assign_attributes_from_yaml(yaml)

Uses the YAML parser as JSON is valid YAML

attributes

Returns a Hash of all attribute values

attributes_tuple

Returns a NamedTuple of all attribute values.

before_create

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

before_destroy

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

before_save

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

before_update

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

build_group
Source
build_user
Source
captured_changed_fields
captured_changed_fields=(captured_changed_fields : Array(String))
changed?

Check if any attributes have changed.

changed_attributes

Returns a Hash with all changed attributes.

changed_json(io : IO) : Nil

Serialize the set of changed attributes to JSON.

changed_json

Serialize the set of changed attributes to JSON.

changed_persist_attributes

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

changed_yaml(io : IO) : Nil

Serialize the set of changed attributes to YAML.

changed_yaml

Serialize the set of changed attributes to YAML.

clear_changes_information

Reset changes for all attributes.

create_group
Source
create_group!
Source
create_user
Source
create_user!
Source
created_at

created_at getter

created_at=(value : Time)

Setters created_at setter

created_at?

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

created_at_assigned?

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

created_at_change

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

created_at_changed?

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

created_at_default

created_at's default value

created_at_present?
created_at_removed?

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

created_at_was

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

created_at_will_change!

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

group
Source
group!
Source
group=(record : Group) : Group
Source
group?
Source
group_history_resource_type
Source
group_id

group_id getter

group_id=(value : UUID)

group_id setter

group_id?

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

group_id_assigned?

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

group_id_change

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

group_id_changed?

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

group_id_default

group_id's default value

Source
group_id_present?
group_id_removed?

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

group_id_was

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

group_id_will_change!

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

id

Always returns this record's primary key value, even when the primary key isn't named id

id?

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

invoke_props

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

permission_flags
Source
permission_flags=(flags : Permissions)
Source
permissions

permissions getter

permissions=(value : Int32)

permissions setter

permissions?

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

permissions_assigned?

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

permissions_change

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

permissions_changed?

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

permissions_default

permissions's default value

Source
permissions_present?

Stored as an Int32 bitmask. Use permission_flags / permission_flags= when working with the Permissions flags enum directly.

permissions_removed?

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

permissions_was

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

permissions_will_change!

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

persistent_attributes

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

primary_key

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

Source
primary_key_hash

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

reload_group
Source
reload_group?
Source
reload_user
Source
reload_user?
Source
restore_attributes

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

table_name

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

updated_at

updated_at getter

updated_at=(value : Time)

updated_at setter

updated_at?

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

updated_at_assigned?

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

updated_at_change

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

updated_at_changed?

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

updated_at_default

updated_at's default value

updated_at_present?
updated_at_removed?

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

updated_at_was

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

updated_at_will_change!

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

user
Source
user!
Source
user=(record : User) : User
Source
user?
Source
user_id

user_id getter

user_id=(value : String)

user_id setter

user_id?

NOTE: use getter / getter! (not property / property!) so that the setter defined later in __create_initializer__ is the only setter on the field. Crystal's overload resolution silently fails to replace a property-defined setter with one of identical signature for generic types (e.g. Set(String)?, Array(String)?, String | Array(String)), although it does work for non-generic ones like String?. Defining the setter only once via __create_initializer__ ensures change tracking, sanitization, and custom setter blocks run uniformly across all types.

user_id_assigned?

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

user_id_change

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

user_id_changed?

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

user_id_default

user_id's default value

Source
user_id_present?
user_id_removed?

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

user_id_was

Junction table: a user's membership in a group, with a permission bitmask. Composite primary key (user_id, group_id).

user_id_will_change!

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

validate_nilability

Validate that all non-nillable fields have values.

was_new_record=(was_new_record : Bool)
was_new_record?

Nested types