Class: DeepPluck::Model

Inherits:
Object
  • Object
show all
Defined in:
lib/deep_pluck/model.rb

Defined Under Namespace

Modules: Helper

Instance Method Summary collapse

Constructor Details

#initialize(relation, parent_association_key = nil, parent_model = nil, preloaded_model: nil, user: nil) ⇒ Model

● Initialize



8
9
10
11
12
13
14
15
16
 
# File 'lib/deep_pluck/model.rb', line 8

def initialize(relation, parent_association_key = nil, parent_model = nil, preloaded_model: nil, user: nil)
  @relation = relation
  @preloaded_model = preloaded_model
  @parent_association_key = parent_association_key
  @parent_model = parent_model
  @need_columns = (preloaded_model ? preloaded_model.need_columns : [])
  @associations = {}
  @user = user
end

Instance Method Details

#add(args) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/deep_pluck/model.rb', line 76

def add(args)
  return self if args == nil
  args = [args] if not args.is_a?(Array)
  args.each do |arg|
    case arg
    when Hash ; add_association(arg)
    else      ; add_need_column(arg)
    end
  end
  return self
end

#delete_extra_column_data! ⇒ Object 



157
158
159
160
161
 
# File 'lib/deep_pluck/model.rb', line 157

def delete_extra_column_data!
  return if @data.blank?
  @data.each{|s| s.except!(*@extra_columns) }
  @associations.each{|_, model| model.delete_extra_column_data! }
end

#get_foreign_key(reflect, reverse: false, with_table_name: false) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/deep_pluck/model.rb', line 46

def get_foreign_key(reflect, reverse: false, with_table_name: false)
  if reverse and (table_name = get_join_table(reflect)) # reverse = parent
    key = reflect.chain.last.foreign_key
  else
    key = (reflect.belongs_to? == reverse ? get_primary_key(reflect) : reflect.foreign_key)
    table_name = (reverse ? reflect.klass : reflect.active_record).table_name
  end
  return "#{table_name}.#{key}" if with_table_name
  return key.to_s # key may be symbol if specify foreign_key in association options
end

#get_join_table(reflect) ⇒ Object 



35
36
37
38
39
40
 
# File 'lib/deep_pluck/model.rb', line 35

def get_join_table(reflect)
  options = reflect.options
  return options[:through] if options[:through]
  return (options[:join_table] || reflect.send(:derive_join_table)) if reflect.macro == :has_and_belongs_to_many
  return nil
end

#get_primary_key(reflect) ⇒ Object 



42
43
44
 
# File 'lib/deep_pluck/model.rb', line 42

def get_primary_key(reflect)
  return (reflect.belongs_to? ? reflect.klass : reflect.active_record).primary_key
end

#get_reflect(association_key) ⇒ Object

● Reader



21
22
23
24
25
26
 
# File 'lib/deep_pluck/model.rb', line 21

def get_reflect(association_key)
  @relation.klass.reflect_on_association(association_key.to_sym) || # add to_sym since rails 3 only support symbol
    fail(ActiveRecord::ConfigurationError, "ActiveRecord::ConfigurationError: Association named \
      '#{association_key}' was not found on #{@relation.klass.name}; perhaps you misspelled it?"
  )
end

#load_all ⇒ Object 



151
152
153
154
155
 
# File 'lib/deep_pluck/model.rb', line 151

def load_all
  load_data
  delete_extra_column_data!
  return @data
end

#load_data ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/deep_pluck/model.rb', line 136

def load_data
  columns = get_query_columns
  key_columns = columns.map(&Helper::TO_KEY_PROC)
  @relation = yield(@relation) if block_given?
  @data = @preloaded_model ? [@preloaded_model.get_hash_data(key_columns)] : @relation.pluck_all(*columns)
  if @data.size != 0
    # for delete_extra_column_data!
    @extra_columns = key_columns - @need_columns.map(&Helper::TO_KEY_PROC)
    @associations.each do |key, model|
      set_includes_data(@data, key, model)
    end
  end
  return @data
end

#with_conditions(reflect, relation) ⇒ Object 



28
29
30
31
32
33
 
# File 'lib/deep_pluck/model.rb', line 28

def with_conditions(reflect, relation)
  options = reflect.options
  relation = relation.instance_exec(&reflect.scope) if reflect.respond_to?(:scope) and reflect.scope
  relation = relation.where(options[:conditions]) if options[:conditions]
  return relation
end