Class: ActiveRecord::Serialization::Serializer

Attributes

NameRead/write?
options R

Public Class Methods

new (record, options = {}) 

   # File vendor/rails/activerecord/lib/active_record/serialization.rb, line 6
6:       def initialize(record, options = {})
7:         @record, @options = record, options.dup
8:       end

Public Instance Methods

add_includes () {|association, records, opts| ...}

Add associations specified via the :includes option. Expects a block that takes as arguments: 

  +association+ - name of the association
  +records+     - the association record(s) to be serialized
  +opts+        - options for the association records

    # File vendor/rails/activerecord/lib/active_record/serialization.rb, line 46
46:       def add_includes(&block)
47:         if include_associations = options.delete(:include)
48:           base_only_or_except = { :except => options[:except],
49:                                   :only => options[:only] }
50: 
51:           include_has_options = include_associations.is_a?(Hash)
52:           associations = include_has_options ? include_associations.keys : Array(include_associations)
53: 
54:           for association in associations
55:             records = case @record.class.reflect_on_association(association).macro
56:             when :has_many, :has_and_belongs_to_many
57:               @record.send(association).to_a
58:             when :has_one, :belongs_to
59:               @record.send(association)
60:             end
61: 
62:             unless records.nil?
63:               association_options = include_has_options ? include_associations[association] : base_only_or_except
64:               opts = options.merge(association_options)
65:               yield(association, records, opts)
66:             end
67:           end
68: 
69:           options[:include] = include_associations
70:         end
71:       end

serializable_attribute_names ()

To replicate the behavior in ActiveRecord#attributes, :except takes precedence over :only. If :only is not set for a N level model but is set for the N+1 level models, then because :except is set to a default value, the second level model can have both :except and :only set. So if :only is set, always delete :except. 

    # File vendor/rails/activerecord/lib/active_record/serialization.rb, line 16
16:       def serializable_attribute_names
17:         attribute_names = @record.attribute_names
18: 
19:         if options[:only]
20:           options.delete(:except)
21:           attribute_names = attribute_names & Array(options[:only]).collect { |n| n.to_s }
22:         else
23:           options[:except] = Array(options[:except]) | Array(@record.class.inheritance_column)
24:           attribute_names = attribute_names - options[:except].collect { |n| n.to_s }
25:         end
26: 
27:         attribute_names
28:       end

serializable_method_names () 

    # File vendor/rails/activerecord/lib/active_record/serialization.rb, line 30
30:       def serializable_method_names
31:         Array(options[:methods]).inject([]) do |method_attributes, name|
32:           method_attributes << name if @record.respond_to?(name.to_s)
33:           method_attributes
34:         end
35:       end

serializable_names () 

    # File vendor/rails/activerecord/lib/active_record/serialization.rb, line 37
37:       def serializable_names
38:         serializable_attribute_names + serializable_method_names
39:       end

serializable_record () 

    # File vendor/rails/activerecord/lib/active_record/serialization.rb, line 73
73:       def serializable_record
74:         returning(serializable_record = {}) do
75:           serializable_names.each { |name| serializable_record[name] = @record.send(name) }
76:           add_includes do |association, records, opts|
77:             if records.is_a?(Enumerable)
78:               serializable_record[association] = records.collect { |r| self.class.new(r, opts).serializable_record }
79:             else
80:               serializable_record[association] = self.class.new(records, opts).serializable_record
81:             end
82:           end
83:         end
84:       end

serialize () 

    # File vendor/rails/activerecord/lib/active_record/serialization.rb, line 86
86:       def serialize
87:         # overwrite to implement
88:       end

to_s (&block) 

    # File vendor/rails/activerecord/lib/active_record/serialization.rb, line 90
90:       def to_s(&block)
91:         serialize(&block)
92:       end