Class: Audrey::Object::Custom

Inherits:

Hash

• Object
• Audrey::Object
• Collection
• Hash
• Audrey::Object::Custom

Extended by:

Searchable

Defined in:

lib/audrey.rb

Overview

Audrey::Object::Custom

Direct Known Subclasses

Graph

Defined Under Namespace

Classes: Field, Graph

Class Method Summary

• .descendant?(object) ⇒ Boolean

  ————————————————————————— descendant?.

• .fields ⇒ Object

  ————————————————————————— fields.

• .has_checks? ⇒ Boolean

  ————————————————————————— has_checks?.

• .new_auto_fields(object) ⇒ Object

  ————————————————————————— new_auto_fields.

• .own_fields ⇒ Object

  ————————————————————————— own_fields.

Instance Method Summary

• #audrey ⇒ Object

  ————————————————————————— audrey.

• #initialize(opts = {}) ⇒ Custom constructor

  ————————————————————————— initialize.

Methods included from Searchable

count, each, first, sample, samples

Methods inherited from Hash

bclass, node_class

Methods inherited from Audrey::Object

descendants, fclasses, fco, inherited, isolate

Constructor Details

#initialize(opts = {}) ⇒ Custom

---

initialize

# File 'lib/audrey.rb', line 1800

def initialize(opts={})
	# If a node is passed as an option, use that node and don't create a
	# new object.
	if @node = opts['node']
		if block_given?
			@node.db.transaction() do |tr|
				yield self
				tr.commit
			end
		end
	
	# If no node is passed, create a new object. If a block is given, run
	# that block within a transaction.
	else
		db = Audrey.explicit_or_current_db(opts['accessor'])
		
		# if within block
		if block_given?
			db.transaction() do |tr|
				within_initialize db, opts
				yield self
				tr.commit
			end
		else
			within_initialize db, opts
		end
	end
end

Class Method Details

.descendant?(object) ⇒ Boolean

---

descendant?

Returns:

• (Boolean)

# File 'lib/audrey.rb', line 1890

def self.descendant?(object)
	if object.is_a?(Class)
		return object < Audrey::Object::Custom
	else
		return object.class < Audrey::Object::Custom
	end
end

.fields ⇒ Object

---

fields

# File 'lib/audrey.rb', line 1866

def self.fields
	# $tm.hrm
	
	# get superclass fields
	if self.superclass.respond_to?('fields')
		rv = self.superclass.fields()
	else
		rv = {}
	end
	
	# get own fields
	rv = rv.merge(own_fields())
	
	# return
	return rv
end

.has_checks? ⇒ Boolean

---

has_checks?

Returns:

• (Boolean)

# File 'lib/audrey.rb', line 1926

def self.has_checks?
	# cache return value
	if not instance_variable_defined?(:@has_checks_cache)
		@has_checks_cache = has_checks_search()
	end
	
	# return
	return @has_checks_cache
end

.new_auto_fields(object) ⇒ Object

---

new_auto_fields

# File 'lib/audrey.rb', line 1905

def self.new_auto_fields(object)
	# $tm.hrm
	
	# loop through fields
	fields.each do |name, dfn|
		dfn.auto_add object
	end
	
	# rescurse to super class
	unless self == Audrey::Object::Custom
		self.superclass.new_auto_fields(object)
	end
end

.own_fields ⇒ Object

---

own_fields

# File 'lib/audrey.rb', line 1847

def self.own_fields
	# $tm.hrm
	
	# ensure @own_fields exists
	if not instance_variable_defined?(:@own_fields)
		@own_fields = {}
	end
	
	# return
	return @own_fields
end

Instance Method Details

#audrey ⇒ Object

---

audrey

# File 'lib/audrey.rb', line 1836

def audrey
	return @node
end