Module: Sequel::Model::InstanceMethods

Defined in:
lib/sequel/model/base.rb

Overview

Sequel::Model instance methods that implement basic model functionality.

  • All of the methods in HOOKS create instance methods that are called by Sequel when the appropriate action occurs. For example, when destroying a model object, Sequel will call before_destroy, do the destroy, and then call after_destroy.

  • The following instance_methods all call the class method of the same name: columns, dataset, db, primary_key, db_schema.

  • The following instance methods allow boolean flags to be set on a per-object basis: raise_on_save_failure, raise_on_typecast_failure, strict_param_setting, typecast_empty_string_to_nil, typecast_on_assignment, use_transactions. If they are not used, the object will default to whatever the model setting is.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#values ⇒ Object (readonly)

The hash of attribute values. Keys are symbols with the names of the underlying database columns.



513
514
515
 
# File 'lib/sequel/model/base.rb', line 513

def values
  @values
end

Instance Method Details

#==(obj) ⇒ Object Also known as: eql?

Compares model instances by values.



562
563
564
 
# File 'lib/sequel/model/base.rb', line 562

def ==(obj)
  (obj.class == model) && (obj.values == @values)
end

#===(obj) ⇒ Object

If pk is not nil, true only if the objects have the same class and pk. If pk is nil, false.



569
570
571
 
# File 'lib/sequel/model/base.rb', line 569

def ===(obj)
  pk.nil? ? false : (obj.class == model) && (obj.pk == pk)
end

#[](column) ⇒ Object

Returns value of the column’s attribute.



541
542
543
 
# File 'lib/sequel/model/base.rb', line 541

def [](column)
  @values[column]
end

#[]=(column, value) ⇒ Object

Sets the value for the given column. If typecasting is enabled for this object, typecast the value based on the column’s type. If this a a new record or the typecasted value isn’t the same as the current value for the column, mark the column as changed.



549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/sequel/model/base.rb', line 549

def []=(column, value)
  # If it is new, it doesn't have a value yet, so we should
  # definitely set the new value.
  # If the column isn't in @values, we can't assume it is
  # NULL in the database, so assume it has changed.
  v = typecast_value(column, value)
  if new? || !@values.include?(column) || v != @values[column]
    changed_columns << column unless changed_columns.include?(column)
    @values[column] = v
  end
end

#associations ⇒ Object

The current cached associations. A hash with the keys being the association name symbols and the values being the associated object or nil (many_to_one), or the array of associated objects (*_to_many).



582
583
584
 
# File 'lib/sequel/model/base.rb', line 582

def associations
  @associations ||= {}
end

#autoincrementing_primary_key ⇒ Object

The autoincrementing primary key for this model object. Should be overridden if you have a composite primary key with one part of it being autoincrementing.



589
590
591
 
# File 'lib/sequel/model/base.rb', line 589

def autoincrementing_primary_key
  primary_key
end

#changed_columns ⇒ Object

The columns that have been updated. This isn’t completely accurate, see Model#[]=.



595
596
597
 
# File 'lib/sequel/model/base.rb', line 595

def changed_columns
  @changed_columns ||= []
end

#delete ⇒ Object

Deletes and returns self. Does not run destroy hooks. Look into using destroy instead.



601
602
603
604
 
# File 'lib/sequel/model/base.rb', line 601

def delete
  this.delete
  self
end

#destroy(opts = {}) ⇒ Object

Like delete but runs hooks before and after delete. If before_destroy returns false, returns false without deleting the object the the database. Otherwise, deletes the item from the database and returns self. Uses a transaction if use_transactions is true or if the :transaction option is given and true.



612
613
614
 
# File 'lib/sequel/model/base.rb', line 612

def destroy(opts = {})
  checked_save_failure{checked_transaction(opts){_destroy(opts)}}
end

#each(&block) ⇒ Object

Iterates through all of the current values using each.

Example:

Ticket.find(7).each { |k, v| puts "#{k} => #{v}" }



620
621
622
 
# File 'lib/sequel/model/base.rb', line 620

def each(&block)
  @values.each(&block)
end

#errors ⇒ Object

Returns the validation errors associated with this object.



625
626
627
 
# File 'lib/sequel/model/base.rb', line 625

def errors
  @errors ||= Errors.new
end

#exists? ⇒ Boolean

Returns true when current instance exists, false otherwise. Generally an object that isn’t new will exist unless it has been deleted.

Returns:

  • (Boolean) 


632
633
634
 
# File 'lib/sequel/model/base.rb', line 632

def exists?
  this.count > 0
end

#hash ⇒ Object

Value that should be unique for objects with the same class and pk (if pk is not nil), or the same class and values (if pk is nil).



638
639
640
 
# File 'lib/sequel/model/base.rb', line 638

def hash
  [model, pk.nil? ? @values.sort_by{|k,v| k.to_s} : pk].hash
end

#id ⇒ Object

Returns value for the :id attribute, even if the primary key is not id. To get the primary key value, use #pk.



644
645
646
 
# File 'lib/sequel/model/base.rb', line 644

def id
  @values[:id]
end

#initialize(values = {}, from_db = false) ⇒ Object

Creates new instance and passes the given values to set. If a block is given, yield the instance to the block unless from_db is true. This method runs the after_initialize hook after it has optionally yielded itself to the block.

Arguments:

  • values - should be a hash to pass to set.

  • from_db - should only be set by Model.load, forget it exists.



525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/sequel/model/base.rb', line 525

def initialize(values = {}, from_db = false)
  if from_db
    @new = false
    set_values(values)
  else
    @values = {}
    @new = true
    @modified = true
    set(values)
    changed_columns.clear 
    yield self if block_given?
  end
  after_initialize
end

#inspect ⇒ Object

Returns a string representation of the model instance including the class name and values.



650
651
652
 
# File 'lib/sequel/model/base.rb', line 650

def inspect
  "#<#{model.name} @values=#{inspect_values}>"
end

#keys ⇒ Object

Returns the keys in values. May not include all column names.



655
656
657
 
# File 'lib/sequel/model/base.rb', line 655

def keys
  @values.keys
end

#marshallable! ⇒ Object

Remove elements of the model object that make marshalling fail. Returns self.



660
661
662
663
 
# File 'lib/sequel/model/base.rb', line 660

def marshallable!
  @this = nil
  self
end

#modified! ⇒ Object

Explicitly mark the object as modified, so save_changes/update will run callbacks even if no columns have changed.



667
668
669
 
# File 'lib/sequel/model/base.rb', line 667

def modified!
  @modified = true
end

#modified? ⇒ Boolean

Whether this object has been modified since last saved, used by save_changes to determine whether changes should be saved. New values are always considered modified.

Returns:

  • (Boolean) 


674
675
676
 
# File 'lib/sequel/model/base.rb', line 674

def modified?
  @modified || !changed_columns.empty?
end

#new? ⇒ Boolean

Returns true if the current instance represents a new record.

Returns:

  • (Boolean) 


679
680
681
 
# File 'lib/sequel/model/base.rb', line 679

def new?
  @new
end

#pk ⇒ Object

Returns the primary key value identifying the model instance. Raises an error if this model does not have a primary key. If the model has a composite primary key, returns an array of values.

Raises:



686
687
688
689
 
# File 'lib/sequel/model/base.rb', line 686

def pk
  raise(Error, "No primary key is associated with this model") unless key = primary_key
  key.is_a?(Array) ? key.map{|k| @values[k]} : @values[key]
end

#pk_hash ⇒ Object

Returns a hash identifying the model instance. It should be true that:

Model[model_instance.pk_hash] === model_instance



694
695
696
 
# File 'lib/sequel/model/base.rb', line 694

def pk_hash
  model.primary_key_hash(pk)
end

#refresh ⇒ Object

Reloads attributes from database and returns self. Also clears all cached association and changed_columns information. Raises an Error if the record no longer exists in the database.



701
702
703
 
# File 'lib/sequel/model/base.rb', line 701

def refresh
  _refresh(this)
end

#reload ⇒ Object

Alias of refresh, but not aliased directly to make overriding in a plugin easier.



706
707
708
 
# File 'lib/sequel/model/base.rb', line 706

def reload
  refresh
end

#save(*columns) ⇒ Object

Creates or updates the record, after making sure the record is valid. If the record is not valid, or before_save, before_create (if new?), or before_update (if !new?) return false, returns nil unless raise_on_save_failure is true (if it is true, it raises an error). Otherwise, returns self. You can provide an optional list of columns to update, in which case it only updates those columns.

Takes the following options:

  • :changed - save all changed columns, instead of all columns or the columns given

  • :transaction - set to false not to use a transaction

  • :validate - set to false not to validate the model before saving



723
724
725
726
727
728
729
730
 
# File 'lib/sequel/model/base.rb', line 723

def save(*columns)
  opts = columns.last.is_a?(Hash) ? columns.pop : {}
  if opts[:validate] != false and !valid?
    raise(ValidationFailed, errors.full_messages.join(', ')) if raise_on_save_failure 
    return
  end
  checked_save_failure{checked_transaction(opts){_save(columns, opts)}}
end

#save_changes(opts = {}) ⇒ Object

Saves only changed columns if the object has been modified. If the object has not been modified, returns nil. If unable to save, returns false unless raise_on_save_failure is true.



735
736
737
 
# File 'lib/sequel/model/base.rb', line 735

def save_changes(opts={})
  save(opts.merge(:changed=>true)) || false if modified? 
end

#set(hash) ⇒ Object

Updates the instance with the supplied values with support for virtual attributes, raising an exception if a value is used that doesn’t have a setter method (or ignoring it if strict_param_setting = false). Does not save the record.



743
744
745
 
# File 'lib/sequel/model/base.rb', line 743

def set(hash)
  set_restricted(hash, nil, nil)
end

#set_all(hash) ⇒ Object

Set all values using the entries in the hash, ignoring any setting of allowed_columns or restricted columns in the model.



749
750
751
 
# File 'lib/sequel/model/base.rb', line 749

def set_all(hash)
  set_restricted(hash, false, false)
end

#set_except(hash, *except) ⇒ Object

Set all values using the entries in the hash, except for the keys given in except.



755
756
757
 
# File 'lib/sequel/model/base.rb', line 755

def set_except(hash, *except)
  set_restricted(hash, false, except.flatten)
end

#set_only(hash, *only) ⇒ Object

Set the values using the entries in the hash, only if the key is included in only.



761
762
763
 
# File 'lib/sequel/model/base.rb', line 761

def set_only(hash, *only)
  set_restricted(hash, only.flatten, false)
end

#this ⇒ Object

Returns (naked) dataset that should return only this instance.



766
767
768
 
# File 'lib/sequel/model/base.rb', line 766

def this
  @this ||= model.dataset.filter(pk_hash).limit(1).naked
end

#update(hash) ⇒ Object

Runs set with the passed hash and then runs save_changes.



771
772
773
 
# File 'lib/sequel/model/base.rb', line 771

def update(hash)
  update_restricted(hash, nil, nil)
end

#update_all(hash) ⇒ Object

Update all values using the entries in the hash, ignoring any setting of allowed_columns or restricted columns in the model.



777
778
779
 
# File 'lib/sequel/model/base.rb', line 777

def update_all(hash)
  update_restricted(hash, false, false)
end

#update_except(hash, *except) ⇒ Object

Update all values using the entries in the hash, except for the keys given in except.



783
784
785
 
# File 'lib/sequel/model/base.rb', line 783

def update_except(hash, *except)
  update_restricted(hash, false, except.flatten)
end

#update_only(hash, *only) ⇒ Object

Update the values using the entries in the hash, only if the key is included in only.



789
790
791
 
# File 'lib/sequel/model/base.rb', line 789

def update_only(hash, *only)
  update_restricted(hash, only.flatten, false)
end

#valid? ⇒ Boolean

Validates the object and returns true if no errors are reported.

Returns:

  • (Boolean) 


800
801
802
803
804
805
806
807
808
809
 
# File 'lib/sequel/model/base.rb', line 800

def valid?
  errors.clear
  if before_validation == false
    save_failure(:validation) if raise_on_save_failure
    return false
  end
  validate
  after_validation
  errors.empty?
end

#validate ⇒ Object

Validates the object. If the object is invalid, errors should be added to the errors attribute. By default, does nothing, as all models are valid by default.



796
797
 
# File 'lib/sequel/model/base.rb', line 796

def validate
end