class SeedFu::Seeder

Creates or updates seed records with data.

It is not recommended to use this class directly. Instead, use `Model.seed`, and `Model.seed_once`, where `Model` is your Active Record model.

@see ActiveRecordExtension

Public Class Methods

new(model_class, constraints, data, options = {}) click to toggle source

@param [ActiveRecord::Base] model_class The model to be seeded @param [Array<Symbol>] constraints A list of attributes which identify a particular seed. If

a record with these attributes already exists then it will be updated rather than created.

@param [Array<Hash>] data Each item in this array is a hash containing attributes for a

particular record.

@param [Hash] options @option options [Boolean] :quiet (SeedFu.quiet) If true, output will be silenced @option options [Boolean] :insert_only (false) If true then existing records which match the

constraints will not be updated, even if the seed data has changed
# File lib/seed-fu/seeder.rb, line 20
def initialize(model_class, constraints, data, options = {})
  @model_class = model_class
  @constraints = constraints.to_a.empty? ? [:id] : constraints
  @data        = data.to_a || []
  @options     = options.symbolize_keys

  @options[:quiet] ||= SeedFu.quiet

  validate_constraints!
  validate_data!
end

Public Instance Methods

seed() click to toggle source

Insert/update the records as appropriate. Validation is skipped while saving. @return [Array<ActiveRecord::Base>] The records which have been seeded

# File lib/seed-fu/seeder.rb, line 34
def seed
  records = @model_class.transaction do
    @data.map { |record_data| seed_record(record_data.symbolize_keys) }
  end
  update_id_sequence
  records
end

Private Instance Methods

column_list(columns) click to toggle source
# File lib/seed-fu/seeder.rb, line 57
def column_list(columns)
  '`' + columns.join("`, `") + '`'
end
constraint_conditions(data) click to toggle source
# File lib/seed-fu/seeder.rb, line 77
def constraint_conditions(data)
  Hash[@constraints.map { |c| [c, data[c.to_sym]] }]
end
find_or_initialize_record(data) click to toggle source
# File lib/seed-fu/seeder.rb, line 72
def find_or_initialize_record(data)
  @model_class.where(constraint_conditions(data)).first ||
  @model_class.new
end
seed_record(data) click to toggle source
# File lib/seed-fu/seeder.rb, line 61
def seed_record(data)
  record = find_or_initialize_record(data)
  return if @options[:insert_only] && !record.new_record?

  puts " - #{@model_class} #{data.inspect}" unless @options[:quiet]

  record.assign_attributes(data,  :without_protection => true)
  record.save(:validate => false) || raise(ActiveRecord::RecordNotSaved)
  record
end
update_id_sequence() click to toggle source
# File lib/seed-fu/seeder.rb, line 81
def update_id_sequence
  if @model_class.connection.adapter_name == "PostgreSQL"
    quoted_id       = @model_class.connection.quote_column_name(@model_class.primary_key)
    quoted_sequence = "'" + @model_class.sequence_name + "'"
    @model_class.connection.execute(
      "SELECT pg_catalog.setval(" +
        "#{quoted_sequence}," +
        "(SELECT MAX(#{quoted_id}) FROM #{@model_class.quoted_table_name}) + 1" +
      ");"
    )
  end
end
validate_constraints!() click to toggle source
# File lib/seed-fu/seeder.rb, line 44
def validate_constraints!
  unknown_columns = @constraints.map(&:to_s) - @model_class.column_names
  unless unknown_columns.empty?
    raise(ArgumentError,
      "Your seed constraints contained unknown columns: #{column_list(unknown_columns)}. " +
      "Valid columns are: #{column_list(@model_class.column_names)}.")
  end
end
validate_data!() click to toggle source
# File lib/seed-fu/seeder.rb, line 53
def validate_data!
  raise ArgumentError, "Seed data missing" if @data.empty?
end