abstract class Jennifer::Model::Resource

• Jennifer::Model::Resource
• Reference
• Object

Overview

Base abstract class for a database entity.

Included Modules

• Jennifer::Macros
• Jennifer::Model::RelationDefinition
• Jennifer::Model::Scoping
• Jennifer::Model::Translation

Extended Modules

• Jennifer::Model::Resource::AbstractClassMethods
• Jennifer::Model::Translation::ClassMethods

Direct Known Subclasses

• Jennifer::Model::Base
• Jennifer::View::Base

Defined in:

Class Method Summary

• .adapter

  Returns adapter instance.

• .all

  Implementation of AbstractClassMethods.all.

• .build(values : Hash(Symbol, Jennifer::DBAny) | NamedTuple)

  Alias for .new.

• .build(values : Hash(String, Jennifer::DBAny))

  Alias for .new.

• .build(**values)

  Alias for .new.

• .c(name : String | Symbol, relation)
• .c(name : String | Symbol)

  Returns criterion for column name of resource's table.

• .context

  Returns QueryBuilder::ExpressionBuilder object of this resource's table.

• .read_adapter

  Returns adapter used to read resource from the database.

• .relation(name)
• .star

  Returns star field statement for current resource's table.

• .table_name(value : String | Symbol)

  Sets custom table name.

• .table_name : String

  Returns resource's table name.

• .transaction(&)

  Starts database transaction.

• .where(&)

  Is a shortcut for .all.where call.

• .where(conditions : Hash(Symbol, _))

  Is a shortcut for .all.where call.

• .write_adapter

  Returns adapter used to write resource to the database.

Instance Method Summary

• #append_relation(name : String, hash)
• #attribute(name : String | Symbol, raise_exception : Bool = true)

  Returns value of attribute name.

• #get_relation(name : String)
• #inspect(io) : Nil

  Returns a string containing a human-readable representation of object.

• #primary

  Returns value of primary field

• #set_inverse_of(name : String, object)
• #to_h

  Returns hash with model attributes; keys are symbols.

• #to_json(only : Array(String)? = nil, except : Array(String)? = nil)

  Returns a JSON string representing the resource.

• #to_json(only : Array(String)? = nil, except : Array(String)? = nil, &)
• #to_json(json : JSON::Builder)
• #to_json(json : JSON::Builder, only : Array(String)? = nil, except : Array(String)? = nil, &)
• #to_str_h

  Returns hash with model attributes; keys are strings.

Class Method Detail

User.all.where { _name == "John" }

User.c(:email) # => users.email

User.context.sql("ABS(1.2)")

User.star # => users.*

User.table_name        # "users"
Admin::User.table_name # "admin_users"

class Admin::Post < Jennifer::Model::Base
  # ...

  def self.table_prefix; end
end

Admin::Post.table_name # "posts"

User.transaction do
  Post.create
end

User.where { _name == "John" }

User.where { _name == "John" }

Instance Method Detail

contact.attribute(:name)          # => Jennifer::DBAny
contact.attribute("age")          # => Jennifer::DBAny
contact.attribute(:salary)        # => Jennifer::BaseException is raised
contact.attribute(:salary, false) # => nil

Address.new.inspect
# => "#<Address:0x7f532bdd5340 id: nil, street: "Ant st. 69", contact_id: nil, created_at: nil, updated_at: nil>"

contact.to_h # => { name: "Jennifer", age: 2 }

user.to_json
# => {"id": 1,"name": "John Smith", "age": 42,"admin":false}

user.to_json(only: %w[id name])
# => {"id": 1,"name": "John Smith"}

user.to_json(except: %w[id name])
# => {"age": 42,"admin":false}

user.to_json do |json|
  json.field "first_name", user.name.split(" ")[0]
end
# => {"id": 1,"name": "John Smith", "age": 42,"admin":false, "first_name": "John"}

contact.to_h # => { "name" => "Jennifer", "age" => 2 }