OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
openproject/lib/open_project/plugins/frontend_linking/generator.rb

147 lines
5.3 KiB

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2021 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 docs/COPYRIGHT.rdoc for more details.
#++
require 'bundler'
require 'fileutils'
module ::OpenProject::Plugins
module FrontendLinking
class Generator
attr_reader :openproject_plugins
def initialize
op_dep = load_known_opf_plugins
@openproject_plugins = Bundler.load.specs.each_with_object({}) do |spec, h|
if op_dep.include?(spec.name)
h[spec.name] = spec.full_gem_path
end
end
end
##
# Register plugins with an Angular frontend to the CLI build.
# For that, search all gems with the group :opf_plugins
def regenerate!
# Create links from plugins angular mdoules to frontend/src
regenerate_angular_links
end
private
##
# Register plugins with an Angular frontend to the CLI build.
# For that, search all gems with the group :opf_plugins
def regenerate_angular_links
all_frontend_plugins.tap do |plugins|
Feature/36390 code structure (#9319) * core/shared/features in progress * shared/components in progress * Fix rebase errors * core: added admin + apiv3 * shared: attachments + attirbute-help-text * core: OpenprojectAugmentingModule * shared: OpenprojectAutocompleterModule * shared: Autocompleter * feature: backlog * feature: bim * feature: boards * shared: calendar * core: userModule * feature: dashboards * shared: editor * shared: fields * shared: focus * core: globalsearch * shared: grid * shared: grid fix * core: hal * shared: icon * feature: invite user modal * feature: job status * shared: members autocomplete * shared: modal * feature: my page * feature: overview * shared: principal * feature: projects * feature: repoting * core: routing * shared: time entries * shared: OpenprojectWorkPackageGraphsModule * feature: workpackages * core: active window * shared: autofocus * features: wp: back-button * core: browser * shared: collapseible section * core: config * shared: copy-to-clipboard * shared: date-time * shared: helpers: drag-and-drop * shared: draggable autocompleter * shared: dynamic bootstrapper * shared: dynamic forms * features: wp: edit actions bar * shared: EditableToolbarTitleComponent * core: BannersService * shared: OpFormFieldComponent * shared: hide section * shared: highlight col * core: I18 + Sanitizer * shared: isClickedWithModifier * core: LoadingIndicator * core: Modal Heading * core: Model auth * shared: no results * shared: notifications * shared: datepicker * shared: option-list * core: path helper * shared: persistent toggle * shared: remote field * shared: set click position * shared: slide toggle * shared: tabs * shared: drag-scroll * shared: keyCodes * shared: OPSharedModule * global styles: common * core: * import fixes * shared: Enterprise banner * features: wps: filters * features: home screen * import fixes * core: html * import fixes * core: main-menu * features: home screen * shared: modals * shared: op-context-menu * core + shared: current project * core: schema-cache * shared: table-pagination * features: wps: time-entries * shared: user-link * features: wps * features: wps * features: wps: all wp-* components * core: states * Rename: angular4-modules to app.module * core: expression service * Modules just with plugins * Test fixes * added missing content-tabs.component.sass * Replaced with .op-ckeditor--wrapper * Replaced by .op-ckeditor-source-element * Replaced by the entire wysiwyg_editor.rb with dev version * Replacements by ckeditor-augmented-textarea * Fixes ./spec/support/components/work_packages/table_configuration_modal.rb:106 * Fixes ./modules/reporting/spec/features/update_entries_spec.rb:69 * work_packages renamed to work-packages * TimeEntryChangeset moved to helpers * 'filters' moved to wps/components * 'admin' moved to features * HAL moved to shared * plugins moved to features * plugins moved to features * Test fixes * Unit test fixes * plugin generator into /features/plugins * fix sass rule indentation * Revert "plugins moved to features" This reverts commit f65ccbfd4b9a76110af2a4d56c57c03f3a95eae9. * Import fixes * Avoid commiting in linked plugins Co-authored-by: ulferts <jens.ulferts@googlemail.com> Co-authored-by: Oliver Günther <mail@oliverguenther.de>
3 years ago
target_dir = Rails.root.join('frontend', 'src', 'app', 'features', 'plugins', 'linked')
puts "Cleaning linked target directory #{target_dir}"
# Removing the current linked directory and recreate
FileUtils.remove_dir(target_dir, force: true)
FileUtils.mkdir_p(target_dir)
plugins.each do |name, path|
source = File.join(path, 'frontend', 'module')
target = File.join(target_dir, name)
puts "Linking frontend of OpenProject plugin #{name} to #{target}."
FileUtils.ln_sf(source, target)
end
generate_plugin_module(all_angular_frontend_plugins)
generate_plugin_sass(all_plugins_with_global_styles)
end
end
def all_frontend_plugins
openproject_plugins.select do |_, path|
frontend_entry = File.join(path, 'frontend', 'module')
File.directory? frontend_entry
end
end
def all_angular_frontend_plugins
openproject_plugins.select do |_, path|
frontend_entry = File.join(path, 'frontend', 'module', 'main.ts')
File.readable? frontend_entry
end
end
def all_plugins_with_global_styles
openproject_plugins.select do |_, path|
style_file = File.join(path, 'frontend', 'module', 'global_styles.*')
!Dir.glob(style_file).empty?
end
end
##
# Regenerate the frontend plugin module orchestrating the linked frontends
def generate_plugin_module(plugins)
Feature/36390 code structure (#9319) * core/shared/features in progress * shared/components in progress * Fix rebase errors * core: added admin + apiv3 * shared: attachments + attirbute-help-text * core: OpenprojectAugmentingModule * shared: OpenprojectAutocompleterModule * shared: Autocompleter * feature: backlog * feature: bim * feature: boards * shared: calendar * core: userModule * feature: dashboards * shared: editor * shared: fields * shared: focus * core: globalsearch * shared: grid * shared: grid fix * core: hal * shared: icon * feature: invite user modal * feature: job status * shared: members autocomplete * shared: modal * feature: my page * feature: overview * shared: principal * feature: projects * feature: repoting * core: routing * shared: time entries * shared: OpenprojectWorkPackageGraphsModule * feature: workpackages * core: active window * shared: autofocus * features: wp: back-button * core: browser * shared: collapseible section * core: config * shared: copy-to-clipboard * shared: date-time * shared: helpers: drag-and-drop * shared: draggable autocompleter * shared: dynamic bootstrapper * shared: dynamic forms * features: wp: edit actions bar * shared: EditableToolbarTitleComponent * core: BannersService * shared: OpFormFieldComponent * shared: hide section * shared: highlight col * core: I18 + Sanitizer * shared: isClickedWithModifier * core: LoadingIndicator * core: Modal Heading * core: Model auth * shared: no results * shared: notifications * shared: datepicker * shared: option-list * core: path helper * shared: persistent toggle * shared: remote field * shared: set click position * shared: slide toggle * shared: tabs * shared: drag-scroll * shared: keyCodes * shared: OPSharedModule * global styles: common * core: * import fixes * shared: Enterprise banner * features: wps: filters * features: home screen * import fixes * core: html * import fixes * core: main-menu * features: home screen * shared: modals * shared: op-context-menu * core + shared: current project * core: schema-cache * shared: table-pagination * features: wps: time-entries * shared: user-link * features: wps * features: wps * features: wps: all wp-* components * core: states * Rename: angular4-modules to app.module * core: expression service * Modules just with plugins * Test fixes * added missing content-tabs.component.sass * Replaced with .op-ckeditor--wrapper * Replaced by .op-ckeditor-source-element * Replaced by the entire wysiwyg_editor.rb with dev version * Replacements by ckeditor-augmented-textarea * Fixes ./spec/support/components/work_packages/table_configuration_modal.rb:106 * Fixes ./modules/reporting/spec/features/update_entries_spec.rb:69 * work_packages renamed to work-packages * TimeEntryChangeset moved to helpers * 'filters' moved to wps/components * 'admin' moved to features * HAL moved to shared * plugins moved to features * plugins moved to features * Test fixes * Unit test fixes * plugin generator into /features/plugins * fix sass rule indentation * Revert "plugins moved to features" This reverts commit f65ccbfd4b9a76110af2a4d56c57c03f3a95eae9. * Import fixes * Avoid commiting in linked plugins Co-authored-by: ulferts <jens.ulferts@googlemail.com> Co-authored-by: Oliver Günther <mail@oliverguenther.de>
3 years ago
file_register = Rails.root.join('frontend', 'src', 'app', 'features', 'plugins', 'linked-plugins.module.ts')
template_file = File.read(File.expand_path('linked-plugins.module.ts.erb', __dir__))
template = ::ERB.new template_file, trim_mode: '-'
puts "Regenerating frontend plugin registry #{file_register}."
context = ::OpenProject::Plugins::FrontendLinking::ErbContext.new plugins
result = template.result(context.get_binding)
File.open(file_register, 'w') { |file| file.write(result) }
end
##
# Regenerate the frontend plugin sass files
def generate_plugin_sass(plugins)
Feature/36390 code structure (#9319) * core/shared/features in progress * shared/components in progress * Fix rebase errors * core: added admin + apiv3 * shared: attachments + attirbute-help-text * core: OpenprojectAugmentingModule * shared: OpenprojectAutocompleterModule * shared: Autocompleter * feature: backlog * feature: bim * feature: boards * shared: calendar * core: userModule * feature: dashboards * shared: editor * shared: fields * shared: focus * core: globalsearch * shared: grid * shared: grid fix * core: hal * shared: icon * feature: invite user modal * feature: job status * shared: members autocomplete * shared: modal * feature: my page * feature: overview * shared: principal * feature: projects * feature: repoting * core: routing * shared: time entries * shared: OpenprojectWorkPackageGraphsModule * feature: workpackages * core: active window * shared: autofocus * features: wp: back-button * core: browser * shared: collapseible section * core: config * shared: copy-to-clipboard * shared: date-time * shared: helpers: drag-and-drop * shared: draggable autocompleter * shared: dynamic bootstrapper * shared: dynamic forms * features: wp: edit actions bar * shared: EditableToolbarTitleComponent * core: BannersService * shared: OpFormFieldComponent * shared: hide section * shared: highlight col * core: I18 + Sanitizer * shared: isClickedWithModifier * core: LoadingIndicator * core: Modal Heading * core: Model auth * shared: no results * shared: notifications * shared: datepicker * shared: option-list * core: path helper * shared: persistent toggle * shared: remote field * shared: set click position * shared: slide toggle * shared: tabs * shared: drag-scroll * shared: keyCodes * shared: OPSharedModule * global styles: common * core: * import fixes * shared: Enterprise banner * features: wps: filters * features: home screen * import fixes * core: html * import fixes * core: main-menu * features: home screen * shared: modals * shared: op-context-menu * core + shared: current project * core: schema-cache * shared: table-pagination * features: wps: time-entries * shared: user-link * features: wps * features: wps * features: wps: all wp-* components * core: states * Rename: angular4-modules to app.module * core: expression service * Modules just with plugins * Test fixes * added missing content-tabs.component.sass * Replaced with .op-ckeditor--wrapper * Replaced by .op-ckeditor-source-element * Replaced by the entire wysiwyg_editor.rb with dev version * Replacements by ckeditor-augmented-textarea * Fixes ./spec/support/components/work_packages/table_configuration_modal.rb:106 * Fixes ./modules/reporting/spec/features/update_entries_spec.rb:69 * work_packages renamed to work-packages * TimeEntryChangeset moved to helpers * 'filters' moved to wps/components * 'admin' moved to features * HAL moved to shared * plugins moved to features * plugins moved to features * Test fixes * Unit test fixes * plugin generator into /features/plugins * fix sass rule indentation * Revert "plugins moved to features" This reverts commit f65ccbfd4b9a76110af2a4d56c57c03f3a95eae9. * Import fixes * Avoid commiting in linked plugins Co-authored-by: ulferts <jens.ulferts@googlemail.com> Co-authored-by: Oliver Günther <mail@oliverguenther.de>
3 years ago
file_register = Rails.root.join('frontend', 'src', 'app', 'features', 'plugins', 'linked-plugins.styles.sass')
template_file = File.read(File.expand_path('linked-plugins.styles.sass.erb', __dir__))
template = ::ERB.new template_file, trim_mode: '-'
puts "Regenerating frontend plugin sass #{file_register}."
context = ::OpenProject::Plugins::FrontendLinking::ErbContext.new plugins
result = template.result(context.get_binding)
File.open(file_register, 'w') { |file| file.write(result) }
end
##
# Print all gemspecs of registered OP plugins
# from the :opf_plugins group.
def load_known_opf_plugins
bundler_groups = %i[opf_plugins]
gemfile_path = Rails.root.join('Gemfile')
gems = Bundler::Dsl.evaluate(gemfile_path, '_temp_lockfile', true)
gems.dependencies
.each_with_object({}) do |dep, l|
l[dep.name] = dep if (bundler_groups & dep.groups).any?
end
.compact
end
end
end
end