class Post

Included Modules

Extended Modules

Defined in:

models/post.cr

Constant Summary

COLUMNS = {"id" => {type: Int64, primary: true, converter: "Int64", db_column_name: "id", crystal_variable_name: id, presence: false, mass_assign: true}, "title" => {type: String, primary: false, converter: "String", db_column_name: "title", crystal_variable_name: title, presence: true, mass_assign: true}, "content" => {type: String, primary: false, converter: "String", db_column_name: "content", crystal_variable_name: content, presence: true, mass_assign: true}, "kind" => {type: String, primary: false, converter: "String", db_column_name: "kind", crystal_variable_name: kind, presence: true, mass_assign: true}, "updated_at" => {type: Time, primary: false, converter: "Time", db_column_name: "updated_at", crystal_variable_name: updated_at, presence: true, mass_assign: true}, "created_at" => {type: Time, primary: false, converter: "Time", db_column_name: "created_at", crystal_variable_name: created_at, presence: true, mass_assign: true}, "tsv" => {type: Lustra::TSVector, primary: false, converter: "Lustra::TSVector", db_column_name: "tsv", crystal_variable_name: tsv, presence: false, mass_assign: true}, "author_id" => {type: Int64, primary: false, converter: "Int64", db_column_name: "author_id", crystal_variable_name: author_id, presence: false, mass_assign: true}} of Nil => Nil
POLYMORPHISM_SETTINGS = {} of Nil => Nil

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

def self.build(x : NamedTuple) : self #

Build a new empty model and fill the columns using the NamedTuple in argument.

Returns the new model


[View source]
def self.build(x : NamedTuple, &block : self -> Nil) : self #

Build a new empty model and fill the columns using the NamedTuple in argument.

Returns the new model


[View source]
def self.create(x : NamedTuple, &block : self -> Nil) : self #

Build and new model and save it. Returns the model.

The model may not be saved due to validation failure; check the returned model errors? and persisted? flags.


[View source]
def self.create(**tuple, &block : self -> Nil) : self #

Build and new model and save it. Returns the model.

The model may not be saved due to validation failure; check the returned model errors? and persisted? flags.


[View source]
def self.create(x : NamedTuple) : self #

Build and new model and save it. Returns the model.

The model may not be saved due to validation failure; check the returned model errors? and persisted? flags.


[View source]
def self.create(**tuple) : self #

Build and new model and save it. Returns the model.

The model may not be saved due to validation failure; check the returned model errors? and persisted? flags.


[View source]
def self.create!(x : NamedTuple, &block : self -> Nil) : self #

Build and new model and save it. Returns the model.

Returns the newly inserted model Raises an exception if validation failed during the saving process.


[View source]
def self.create!(**tuple, &block : self -> Nil) : self #

Build and new model and save it. Returns the model.

Returns the newly inserted model Raises an exception if validation failed during the saving process.


[View source]
def self.create!(x : NamedTuple) : self #

Build and new model and save it. Returns the model.

Returns the newly inserted model Raises an exception if validation failed during the saving process.


[View source]
def self.create!(**tuple) : self #

Build and new model and save it. Returns the model.

Returns the newly inserted model Raises an exception if validation failed during the saving process.


[View source]
def self.new(h : Hash(String, _), cache : Lustra::Model::QueryCache | Nil = nil, persisted = false, fetch_columns = false) #

[View source]
def self.new(json : JSON::Any, cache : Lustra::Model::QueryCache | Nil = nil, persisted = false) #

[View source]
def self.new(t : NamedTuple, persisted = false) #

[View source]
def self.new #

[View source]

Class Method Detail

def self.build(**tuple : **T) forall T #

Build a new empty model and fill the columns using the NamedTuple in argument.

Returns the new model


[View source]
def self.build(**tuple) #

Build a new empty model and fill the columns using the NamedTuple in argument.

Returns the new model


[View source]
def self.build(**tuple, &) #

Build a new empty model and fill the columns using the NamedTuple in argument.

Returns the new model


[View source]
def self.columns #

[View source]
def self.connection : String #

Define on which connection the model is living. Useful in case of models living in different databases.

Is set to "default" by default.

See Lustra::SQL#init(URI, *opts) for more information about multi-connections.

Example:

Lustra::SQL.init("postgres://postgres@localhost/database_1")
Lustra::SQL.init("secondary", "postgres://postgres@localhost/database_2")

class ModelA
  include Lustra::Model

  # Performs all the queries on `database_1`
  # self.connection = "default"
  column id : Int32, primary: true, presence: false
  column title : String
end

class ModelB
  include Lustra::Model

  # Performs all the queries on `database_2`
  self.connection = "secondary"

  column id : Int32, primary: true, presence: false
end

def self.connection=(connection : String) #

Define on which connection the model is living. Useful in case of models living in different databases.

Is set to "default" by default.

See Lustra::SQL#init(URI, *opts) for more information about multi-connections.

Example:

Lustra::SQL.init("postgres://postgres@localhost/database_1")
Lustra::SQL.init("secondary", "postgres://postgres@localhost/database_2")

class ModelA
  include Lustra::Model

  # Performs all the queries on `database_1`
  # self.connection = "default"
  column id : Int32, primary: true, presence: false
  column title : String
end

class ModelB
  include Lustra::Model

  # Performs all the queries on `database_2`
  self.connection = "secondary"

  column id : Int32, primary: true, presence: false
end

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

Create a new model from json and save it. Returns the model.

The model may not be saved due to validation failure; check the returned model errors? and persisted? flags. Trusted flag set to true will allow mass assignment without protection, FALSE by default


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

Create a new model from json and save it. Returns the model.

Returns the newly inserted model Raises an exception if validation failed during the saving process. Trusted flag set to true will allow mass assignment without protection, FALSE by default


def self.find(x) #

Returns a model using primary key equality Returns nil if not found.


[View source]
def self.find!(x) #

Returns a model using primary key equality. Raises error if the model is not found.


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

Create a new empty model and fill the columns from json. Returns the new model

Trusted flag set to true will allow mass assignment without protection, FALSE by default


def self.full_table_name #

returns the fully qualified and escaped name for this table. add schema if schema is different from 'public' (default schema)

ex: "schema"."table"


[View source]
def self.import(array : Enumerable(self), on_conflict : Lustra::SQL::InsertQuery -> | Nil = nil) #

Import a bulk of models in one SQL insert query. Each model must be non-persisted.

on_conflict callback can be optionnaly turned on to manage constraints of the database.

Note: Old models are not modified. This method return a copy of the models as saved in the database.

Example:

users = [User.new(id: 1), User.new(id: 2), User.new(id: 3)]
users = User.import(users)

[View source]
def self.polymorphic? : Bool #

def self.query #

Return a new empty query SELECT * FROM [my_model_table]. Can be refined after that.


[View source]
def self.read_only=(read_only : Bool) #

def self.read_only? : Bool #

def self.register_counter_cache(association_model : Class, counter_column : String, foreign_key : String) #

Register a counter cache for this model using model class


[View source]
def self.reset_counters(id, *counter_models) #

Reset counter cache columns to their correct values. This is useful when counter caches become out of sync due to direct SQL operations.

Example:

User.reset_counters(user.id, Post)
User.reset_counters(user.id, Post, Comment)

[View source]
def self.schema : Lustra::SQL::Symbolic | Nil #

Define the current schema used in PostgreSQL. The value is nil by default, which lead to non-specified schema during the querying, and usage of "public" by PostgreSQL.

This property can be redefined on initialization. Example:

class MyModel
  include Lustra::Model

  self.schema = "my_schema"
end
MyModel.query.to_sql # SELECT * FROM "my_schema"."my_models"

def self.schema=(schema : Lustra::SQL::Symbolic | Nil) #

Define the current schema used in PostgreSQL. The value is nil by default, which lead to non-specified schema during the querying, and usage of "public" by PostgreSQL.

This property can be redefined on initialization. Example:

class MyModel
  include Lustra::Model

  self.schema = "my_schema"
end
MyModel.query.to_sql # SELECT * FROM "my_schema"."my_models"

def self.search(str) #

def self.table : Lustra::SQL::Symbolic #

Return the table name setup for this model. By convention, the class name is by default equals to the pluralized underscored string form of the model name. Example:

MyModel => "my_models"
Person => "people"
Project::Info => "project_infos"

The property can be updated at initialization to a custom table name:

class MyModel
  include Lustra::Model

  self.table = "another_table_name"
end
MyModel.query.to_sql # SELECT * FROM "another_table_name"

def self.table=(table : Lustra::SQL::Symbolic) #

Return the table name setup for this model. By convention, the class name is by default equals to the pluralized underscored string form of the model name. Example:

MyModel => "my_models"
Person => "people"
Project::Info => "project_infos"

The property can be updated at initialization to a custom table name:

class MyModel
  include Lustra::Model

  self.table = "another_table_name"
end
MyModel.query.to_sql # SELECT * FROM "another_table_name"

Instance Method Detail

def __trigger_append_operation_for_association__(association_name : String, models : Array(Lustra::Model)) #

Handle append operation for through associations (called by autosave system)


def _cached_author : Author | Nil #

def add_built_association(association_name : String, model : Lustra::Model) #

Add a built association to track for autosave


[View source]
def attributes : Hash(String, Lustra::SQL::Any) #

Attributes, used when fetch_columns is true


def author : Author #

The method author is a belongs_to relation to Author


def author=(model : Author) #

def author_id : Int64 #

Returns the value of #author_id column or throw an exception if the column is not defined.


def author_id=(x : Int64) #

Setter for #author_id column.


def author_id_column : Lustra::Model::Column(Int64, Lustra::Model::Converter::Int64Converter) #

Returns the column object used to manage #author_id field

See Lustra::Model::Column


def built_associations : Hash(String, Array(Lustra::Model)) #

Track built associations for autosave functionality


def built_associations=(built_associations : Hash(String, Array(Lustra::Model))) #

Track built associations for autosave functionality


def cache : Lustra::Model::QueryCache | Nil #

def changed? #

Return true if the model is dirty (e.g. one or more fields have been changed.). Return false otherwise.


def clear_built_associations #

Clear all built associations (called after successful save)


[View source]
def clear_change_flags #

Reset the #changed? flag on all columns

The model behave like its not dirty anymore and call to save would apply no changes.

Returns self


def content : String #

Returns the value of #content column or throw an exception if the column is not defined.


def content=(x : String) #

Setter for #content column.


def content_column : Lustra::Model::Column(String, Lustra::Model::Converter::StringConverter) #

Returns the column object used to manage #content field

See Lustra::Model::Column


def created_at : Time #

Returns the value of #created_at column or throw an exception if the column is not defined.


def created_at=(x : Time) #

Setter for #created_at column.


def created_at_column : Lustra::Model::Column(Time, Lustra::Model::Converter::TimeConverter) #

Returns the column object used to manage #created_at field

See Lustra::Model::Column


def dependencies : Post::Collection #

def dependents : Post::Collection #

def has_built_associations? : Bool #

Check if there are any pending built associations


[View source]
def id : Int64 #

Returns the value of #id column or throw an exception if the column is not defined.


def id=(x : Int64) #

Setter for #id column.


def id_column : Lustra::Model::Column(Int64, Lustra::Model::Converter::Int64Converter) #

Returns the column object used to manage #id field

See Lustra::Model::Column


def kind : String #

Returns the value of #kind column or throw an exception if the column is not defined.


def kind=(x : String) #

Setter for #kind column.


def kind_column : Lustra::Model::Column(String, Lustra::Model::Converter::StringConverter) #

Returns the column object used to manage #kind field

See Lustra::Model::Column


def reset(h : Hash(Symbol, _)) #

Set the columns from hash


def reset(h : Hash(String, _)) #

Set the model fields from hash


def reset(t : NamedTuple) #

def reset(from_json : JSON::Any) #

def reset(**t : **T) forall T #

reset flavors


def reset_counters(*counter_models) #

Reset counter cache columns

Example:

user = User.find(1)
user.reset_counters(Post)
user.reset_counters(Post, Comment)

[View source]
def set(h : Hash(Symbol, _)) #

Set the columns from hash


def set(h : Hash(String, _)) #

Set the model fields from hash


def set(t : NamedTuple) #

def set(from_json : JSON::Any) #

def set(**t : **T) forall T #
Description copied from module Lustra::Model::HasColumns

Set one or multiple columns to a specific value This two are equivalents:

model.set(a: 1)
model.a = 1

def set_from_json(string_or_io : String | IO, trusted : Bool = false) #

Set the fields from json passed as argument Trusted flag set to true will allow mass assignment without protection, FALSE by default


def tag_names #

[View source]
def tags : Tag::Collection #

def tags=(names : Array(String)) #

[View source]
def title : String #

Returns the value of #title column or throw an exception if the column is not defined.


def title=(x : String) #

Setter for #title column.


def title_column : Lustra::Model::Column(String, Lustra::Model::Converter::StringConverter) #

Returns the column object used to manage #title field

See Lustra::Model::Column


def to_h(full = false) : Hash(String, Lustra::SQL::Any) #

Return a hash version of the columns of this model.


def to_json(emit_nulls : Bool = false) #

def to_json(json, emit_nulls = false) #

def touch(now = Time.local) : Lustra::Model #

Saves the record with the updated_at set to the current time.


[View source]
def tsv : Lustra::TSVector #

Returns the value of #tsv column or throw an exception if the column is not defined.


def tsv=(x : Lustra::TSVector) #

Setter for #tsv column.


def tsv_column : Lustra::Model::Column(Lustra::TSVector, Lustra::TSVector::Converter) #

Returns the column object used to manage #tsv field

See Lustra::Model::Column


def update_from_json(string_or_io : String | IO, trusted : Bool = false) #

Set the fields from json passed as argument and call save on the object Trusted flag set to true will allow mass assignment without protection, FALSE by default


def update_from_json!(string_or_io : String | IO, trusted : Bool = false) #

Set the fields from json passed as argument and call save! on the object Trusted flag set to true will allow mass assignment without protection, FALSE by default


def update_h : Hash(String, Lustra::SQL::Any) #

Generate the hash for update request (like during save)


def updated_at : Time #

Returns the value of #updated_at column or throw an exception if the column is not defined.


def updated_at=(x : Time) #

Setter for #updated_at column.


def updated_at_column : Lustra::Model::Column(Time, Lustra::Model::Converter::TimeConverter) #

Returns the column object used to manage #updated_at field

See Lustra::Model::Column


def validate_fields_presence #

For each column, ensure than when needed the column has present information into it.

This method is called on validation.