mirror of
https://github.com/opf/openproject.git
synced 2026-06-14 03:30:14 +00:00
Jan Sandbrink
f9d8bc6614
This error is intended for cases when a method is intentionally not implemented, because the module/class defining it expects a subclass (or class including the module) to implement the method. This is intended to distinguish it from other cases, such as: * feature not implemented yet * edge case of a method call not yet supported Notably it avoids the misuse of the Ruby-defined NotImplementedError, which is only intended for much more specific scenarios: > Raised when a feature is not implemented on the current platform. For example, methods depending on the fsync or fork system calls may raise this exception [...] Also see https://docs.ruby-lang.org/en/master/NotImplementedError.html
121 lines
3.3 KiB
Ruby
121 lines
3.3 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
#-- copyright
|
|
# OpenProject is an open source project management software.
|
|
# Copyright (C) the OpenProject GmbH
|
|
#
|
|
# This program is free software; you can redistribute it and/or
|
|
# modify it under the terms of the GNU General Public License version 3.
|
|
#
|
|
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
|
|
# Copyright (C) 2006-2013 Jean-Philippe Lang
|
|
# Copyright (C) 2010-2013 the ChiliProject Team
|
|
#
|
|
# This program is free software; you can redistribute it and/or
|
|
# modify it under the terms of the GNU General Public License
|
|
# as published by the Free Software Foundation; either version 2
|
|
# of the License, or (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program; if not, write to the Free Software
|
|
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
#
|
|
# See COPYRIGHT and LICENSE files for more details.
|
|
#++
|
|
|
|
class Seeder
|
|
class << self
|
|
attr_writer :logger
|
|
|
|
def logger
|
|
@logger ||= Rails.logger
|
|
end
|
|
|
|
def log_to_stdout!
|
|
@logger = Logger.new($stdout)
|
|
@logger.level = Logger::DEBUG
|
|
@logger.formatter = proc do |_severity, _datetime, _prog_name, msg|
|
|
"#{msg}\n"
|
|
end
|
|
end
|
|
end
|
|
|
|
class_attribute :needs, default: []
|
|
# The attributes referencing other objects created or looked up during
|
|
# seeding. The seeder should not run if one of them does not exist.
|
|
class_attribute :attribute_names_for_required_references, default: []
|
|
|
|
attr_reader :seed_data
|
|
|
|
def initialize(seed_data = nil)
|
|
@seed_data = seed_data
|
|
end
|
|
|
|
def seed!
|
|
if applicable?
|
|
without_notifications do
|
|
seed_data!
|
|
end
|
|
else
|
|
Seeder.logger.debug { " *** #{not_applicable_message}" }
|
|
lookup_existing_references
|
|
end
|
|
end
|
|
|
|
def seed_data!
|
|
raise SubclassResponsibilityError
|
|
end
|
|
|
|
def applicable?
|
|
seed_data.all_references_exist?(all_required_references)
|
|
end
|
|
|
|
# Returns the references that are required to be present in the seed data.
|
|
# Should be overridden by subclasses to gather the references from their model
|
|
# data.
|
|
def all_required_references
|
|
[]
|
|
end
|
|
|
|
# Called if the seeding is not applicable to have a chance to lookup
|
|
# existing records and set some references to them.
|
|
def lookup_existing_references; end
|
|
|
|
def not_applicable_message
|
|
"Skipping #{self.class.name}"
|
|
end
|
|
|
|
# The user being the author of all data created during seeding.
|
|
def admin_user
|
|
@admin_user ||= User.not_builtin.admin.first
|
|
end
|
|
|
|
protected
|
|
|
|
def print_status(message)
|
|
Seeder.logger.info message
|
|
|
|
yield if block_given?
|
|
end
|
|
|
|
def print_error(message)
|
|
Seeder.logger.error message
|
|
end
|
|
|
|
def without_notifications(&)
|
|
Journal::NotificationConfiguration.with(false, &)
|
|
end
|
|
|
|
def get_required_references(models_data)
|
|
refs = Array.wrap(models_data).map do |model_data|
|
|
model_data.values_at(*attribute_names_for_required_references)
|
|
end
|
|
refs.flatten.compact.uniq
|
|
end
|
|
end
|