mirror of
https://github.com/opf/openproject.git
synced 2026-06-14 03:30:14 +00:00
Jan Sandbrink
a6540269ba
The copyright task was so far only built to update existing (and properly marked) copyright headers. We are now adding the capability to add a missing header for Ruby files. This allows us to properly indicate copyright where it was previously forgotten to be done.
281 lines
9.3 KiB
Ruby
281 lines
9.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.
|
|
#++
|
|
|
|
# rubocop:disable Rails/RakeEnvironment
|
|
namespace :copyright do
|
|
def short_copyright(format, options = {})
|
|
case format
|
|
when :ruby, :rb
|
|
short_copyright_line("#", options)
|
|
when :js, :sass, :ts
|
|
short_copyright_line("//", options)
|
|
when :css
|
|
short_copyright_surrounding("/*", "*/", options)
|
|
when :sql
|
|
short_copyright_line("-- ", options)
|
|
when :erb
|
|
short_copyright_surrounding("<%#", "#%>", options)
|
|
when :rdoc
|
|
"----------\n#{short_copyright_line(' ', options)}\n----------\n".gsub(" -- copyright", "==== copyright\n")
|
|
when :md
|
|
short_copyright_surrounding("<!--", "-->", options)
|
|
else
|
|
raise "Undefined format #{format}"
|
|
end
|
|
end
|
|
|
|
def copyright_file(options = {})
|
|
path = "COPYRIGHT_short"
|
|
if options[:path]
|
|
path = File.join(options[:path], "COPYRIGHT_short") if File.exist?(File.join(options[:path],
|
|
"COPYRIGHT_short"))
|
|
path = File.join(options[:path], "COPYRIGHT_short.md") if File.exist?(File.join(options[:path],
|
|
"COPYRIGHT_short.md"))
|
|
end
|
|
path
|
|
end
|
|
|
|
def short_copyright_surrounding(open, close, options = {})
|
|
short_copyright = File.read copyright_file(options)
|
|
|
|
"#{open}-- copyright\n#{short_copyright}\n++#{close}"
|
|
end
|
|
|
|
def short_copyright_line(sign, options = {})
|
|
short_copyright = File.readlines(copyright_file(options)).collect do |line|
|
|
"#{sign} #{line}".rstrip
|
|
end.join("\n")
|
|
|
|
"#{sign}-- copyright\n#{short_copyright}\n#{sign}++"
|
|
end
|
|
|
|
def global_excluded_globs
|
|
%w[
|
|
frontend/node_modules/**/*
|
|
tmp/**/*
|
|
modules/gitlab_integration/**/*
|
|
]
|
|
end
|
|
|
|
def copyright_regexp(format)
|
|
case format
|
|
when :ruby, :rb
|
|
/\A(?<shebang>#![^\n]+\n)?(?<additional>.*)?#--\s*copyright.*?\+\+/m
|
|
when :js, :css, :sass, :ts
|
|
/\A(?<shebang>#![^\n]+\n)?(?<additional>.*)?\/\/\s*--\s*copyright.*?\/\/\s*\+\+/m
|
|
when :erb
|
|
/\A(?<shebang>#![^\n]+\n)?(?<additional>.*)?<%#--\s*copyright.*?\+\+#%>/m
|
|
when :rdoc
|
|
/(?<shebang>)?(?<additional>.*)?-{10}\n={4} copyright\n\n[\s\S]*?\+\+\n-{10}\n\z/
|
|
when :md, :html
|
|
/\A(?<shebang>#![^\n]+\n)?(?<additional>.*)?<!----\s*copyright.*?\+\+-->/m
|
|
when :sql
|
|
/\A(?<shebang>#![^\n]+\n)?(?<additional>.*)?-- --\s*copyright.*?\+\+/m
|
|
else
|
|
raise "Undefined format #{format}"
|
|
end
|
|
end
|
|
|
|
def missing_copyright_regexp(format)
|
|
case format
|
|
when :ruby, :rb
|
|
/\A(?<shebang>#![^\n]+\n\n?)?(?<additional># frozen_string_literal: (?:true|false)\n\n?)?\n*/m
|
|
else
|
|
raise "Format #{format} is not yet supported for copyright creation"
|
|
end
|
|
end
|
|
|
|
def rewrite_copyright(ending, additional_excluded_globs, format, path, options = {}) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
|
|
regexp = options[:regex] || copyright_regexp(format)
|
|
path = "." if path.nil?
|
|
copyright = options[:copyright] || short_copyright(format, path:)
|
|
file_list = options[:file_list] || Dir[path + "/**/*.#{ending}"]
|
|
excluded_globs = global_excluded_globs.concat(additional_excluded_globs)
|
|
|
|
raise "Path not found" unless Dir.exist?(path)
|
|
|
|
file_list.each do |file_name|
|
|
file_name = file_name.delete_prefix("./")
|
|
|
|
next if excluded_globs
|
|
.any? { |glob| File.fnmatch(glob, file_name, File::FNM_PATHNAME | File::FNM_EXTGLOB | File::FNM_CASEFOLD) }
|
|
|
|
file_content = File.read(file_name)
|
|
if file_content.match(regexp)
|
|
file_content.gsub!(regexp, "\\k<shebang>\\k<additional>#{copyright}")
|
|
elsif options[:create]
|
|
if file_content.include?("OpenProject is a fork of ChiliProject")
|
|
puts "#{file_name} does not match regexp, but seems to have a copyright header!"
|
|
next
|
|
end
|
|
|
|
file_content.gsub!(missing_copyright_regexp(format), "\\k<shebang>\\k<additional>#{copyright}\n\n")
|
|
else
|
|
puts "#{file_name} does not match regexp. Missing copyright notice?"
|
|
end
|
|
|
|
File.write(file_name, file_content)
|
|
end
|
|
end
|
|
|
|
desc "Update special files, which do not have an ending"
|
|
task :update_special_files, :path do |_task, args|
|
|
# ruby-like files
|
|
file_list = %w[
|
|
Gemfile
|
|
Rakefile
|
|
config.ru
|
|
.gitignore
|
|
]
|
|
|
|
rewrite_copyright("rb", [], :rb, args[:path], file_list:, create: true)
|
|
end
|
|
|
|
desc "Update the copyright on .rb source files"
|
|
task :update_rb, :path do |_task, args|
|
|
excluded = %w[
|
|
lib_static/plugins/{acts_as_tree,rfpdf,verification}/**/*
|
|
lib/chronic_duration.rb
|
|
]
|
|
|
|
rewrite_copyright("rb", excluded, :rb, args[:path], create: true)
|
|
end
|
|
|
|
desc "Update the copyright on .rake source files"
|
|
task :update_rake, :path do |_task, args|
|
|
rewrite_copyright("rake", [], :rb, args[:path], create: true)
|
|
end
|
|
|
|
desc "Update the copyright on .yml source files"
|
|
task :update_yml, :path do |_task, args|
|
|
excluded = %w[
|
|
config/locales/{crowdin,generated}/*.yml
|
|
modules/*/config/locales/crowdin/*.yml
|
|
]
|
|
|
|
rewrite_copyright("yml", excluded, :rb, args[:path], create: true)
|
|
end
|
|
|
|
desc "Update the copyright on .yml.example source files"
|
|
task :update_yml_example, :path do |_task, args|
|
|
rewrite_copyright("yml.example", [], :rb, args[:path], create: true)
|
|
end
|
|
|
|
desc "Update the copyright on .rb.example source files"
|
|
task :update_rb_example, :path do |_task, args|
|
|
rewrite_copyright("rb.example", [], :rb, args[:path], create: true)
|
|
end
|
|
|
|
desc "Update the copyright on .rjs source files"
|
|
task :update_rjs, :path do |_task, args|
|
|
rewrite_copyright("rjs", [], :rb, args[:path], create: true)
|
|
end
|
|
|
|
desc "Update the copyright on .feature source files"
|
|
task :update_feature, :path do |_task, args|
|
|
rewrite_copyright("feature", [], :rb, args[:path], create: true)
|
|
end
|
|
|
|
desc "Update the copyright on .css source files"
|
|
task :update_css, :path do |_task, args|
|
|
rewrite_copyright("css", [], :css, args[:path])
|
|
end
|
|
|
|
desc "Update the copyright on .css.erb source files"
|
|
task :update_css_erb, :path do |_task, args|
|
|
rewrite_copyright("css.erb", [], :css, args[:path])
|
|
end
|
|
|
|
desc "Update the copyright on .sass source files"
|
|
task :update_sass, :path do |_task, args|
|
|
rewrite_copyright("sass", [], :sass, args[:path])
|
|
end
|
|
|
|
desc "Update the copyright on .sql source files"
|
|
task :update_sql, :path do |_task, args|
|
|
rewrite_copyright("sql", [], :sql, args[:path])
|
|
end
|
|
|
|
desc "Update the copyright on .js source files"
|
|
task :update_js, :path do |_task, args|
|
|
rewrite_copyright("js", [], :js, args[:path])
|
|
end
|
|
|
|
desc "Update the copyright on .js.erb source files"
|
|
task :update_js_erb, :path do |_task, args|
|
|
rewrite_copyright("js.erb", [], :erb, args[:path])
|
|
end
|
|
|
|
desc "Update the copyright on .rdoc source files"
|
|
task :update_rdoc, :path do |_task, args|
|
|
excluded = %w[
|
|
README.rdoc
|
|
LICENSE
|
|
COPYRIGHT
|
|
COPYRIGHT_short
|
|
]
|
|
|
|
rewrite_copyright("rdoc", excluded, :rdoc, args[:path], position: :bottom)
|
|
end
|
|
|
|
desc "Update the copyright on .html.erb source files"
|
|
task :update_html_erb, :path do |_task, args|
|
|
rewrite_copyright("html.erb", [], :erb, args[:path])
|
|
end
|
|
|
|
desc "Update the copyright on .json.erb source files"
|
|
task :update_json_erb, :path do |_task, args|
|
|
rewrite_copyright("json.erb", [], :erb, args[:path])
|
|
end
|
|
|
|
desc "Update the copyright on .atom.builder source files"
|
|
task :update_atom_builder, :path do |_task, args|
|
|
rewrite_copyright("atom.builder", [], :rb, args[:path])
|
|
end
|
|
|
|
desc "Update the copyright on .text.erb source files"
|
|
task :update_text_erb, :path do |_task, args|
|
|
rewrite_copyright("text.erb", [], :erb, args[:path])
|
|
end
|
|
|
|
desc "Update the copyright on .ts source files"
|
|
task :update_typescript, :path do |_task, args|
|
|
rewrite_copyright("ts", [], :ts, args[:path])
|
|
end
|
|
|
|
desc "Update the copyright on all source files"
|
|
task :update, :path do |_task, args|
|
|
Rake::Task.tasks
|
|
.select { |task| task.name.start_with?("copyright:update_") }
|
|
.each { |task| task.invoke(args[:path]) }
|
|
end
|
|
end
|
|
# rubocop:enable Rails/RakeEnvironment
|