Merge pull request #19036 from opf/code-maintenance/text-formatting-rubocop

Freeze string literals, other Rubocop fixes for `OpenProject::TextFormatting` module

Author: oliverguenther

lib/open_project/text_formatting/filters/attachment_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/filters/autolink_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/filters/bem_css_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH
@@ -82,7 +84,7 @@ def add_css_class(element, css_class)
         if element["class"].present?
           # Avoid using element['class'].include?(css_class) as css_class can be a substring
           # of an existing class
-          element["class"] += " #{css_class}" unless element["class"].split.any? { |existing_class| existing_class == css_class }
+          element["class"] += " #{css_class}" unless element["class"].split.any?(css_class)
         else
           element["class"] = css_class
         end

lib/open_project/text_formatting/filters/figure_wrapped_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/filters/link_attribute_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/filters/macro_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH
@@ -37,7 +39,7 @@ def self.register(*macros)
         macros.each { |macro| registered << macro }
       end
 
-      def call
+      def call # rubocop:disable Metrics/AbcSize
         doc.search("macro").each do |macro|
           registered.each do |macro_class|
             next unless macro_applies?(macro_class, macro)
@@ -81,7 +83,7 @@ def macro_placeholder(macro_class)
       end
 
       def macro_applies?(macro_class, element)
-        ((element["class"] || "").split & Array(macro_class.identifier)).any?
+        (element["class"] || "").split.intersect?(Array(macro_class.identifier))
       end
     end
   end

lib/open_project/text_formatting/filters/macros/child_pages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH
@@ -28,7 +30,7 @@
 
 module OpenProject::TextFormatting::Filters::Macros
   module ChildPages
-    HTML_CLASS = "child_pages".freeze
+    HTML_CLASS = "child_pages"
 
     module_function
 

lib/open_project/text_formatting/filters/macros/child_pages/child_pages_context.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/filters/macros/create_work_package_link.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH
@@ -32,7 +34,7 @@ class << self
       include OpenProject::StaticRouting::UrlHelpers
     end
 
-    HTML_CLASS = "create_work_package_link".freeze
+    HTML_CLASS = "create_work_package_link"
 
     module_function
 
@@ -44,7 +46,7 @@ def apply(macro, result:, context:)
       macro.replace work_package_link(macro, context)
     end
 
-    def work_package_link(macro, context)
+    def work_package_link(macro, context) # rubocop:disable Metrics/AbcSize
       project = context[:project]
       raise I18n.t("macros.create_work_package_link.errors.no_project_context") if project.nil?
 

lib/open_project/text_formatting/filters/macros/embedded_table.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH
@@ -28,8 +30,8 @@
 
 module OpenProject::TextFormatting::Filters::Macros
   module EmbeddedTable
-    CUSTOM_ELEMENT = "opce-macro-embedded-table".freeze
-    HTML_CLASS = "embedded-table".freeze
+    CUSTOM_ELEMENT = "opce-macro-embedded-table"
+    HTML_CLASS = "embedded-table"
 
     module_function
 

lib/open_project/text_formatting/filters/macros/github_pull_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH
@@ -28,8 +30,8 @@
 
 module OpenProject::TextFormatting::Filters::Macros
   module GithubPullRequest
-    CUSTOM_ELEMENT = "opce-github-pull-request".freeze
-    HTML_CLASS = "github_pull_request".freeze
+    CUSTOM_ELEMENT = "opce-github-pull-request"
+    HTML_CLASS = "github_pull_request"
 
     module_function
 

lib/open_project/text_formatting/filters/macros/include_wiki_page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH
@@ -28,7 +30,7 @@
 
 module OpenProject::TextFormatting::Filters::Macros
   module IncludeWikiPage
-    HTML_CLASS = "include_wiki_page".freeze
+    HTML_CLASS = "include_wiki_page"
 
     module_function
 

lib/open_project/text_formatting/filters/macros/toc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH
@@ -28,7 +30,7 @@
 
 module OpenProject::TextFormatting::Filters::Macros
   module Toc
-    HTML_CLASS = "toc".freeze
+    HTML_CLASS = "toc"
 
     module_function
 

lib/open_project/text_formatting/filters/markdown_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/filters/mention_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/filters/pattern_matcher_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/filters/plain_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/filters/relative_link_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/filters/syntax_highlight_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/filters/table_of_contents_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH
@@ -66,7 +68,7 @@ def get_unique_id(text)
       # that prefix is used if it matches the calculated number.
       def process_item(node, number)
         text = node.text
-        return "".html_safe unless text.present?
+        return "".html_safe if text.blank?
 
         id = get_unique_id(text)
         add_header_link_class_and_id(node, id)
@@ -80,13 +82,13 @@ def get_heading_number(parent_number, num_in_level)
         parent_number == "" ? num_in_level.to_s : "#{parent_number}.#{num_in_level}"
       end
 
-      def render_nested(level = 0, parent_number = "")
+      def render_nested(level = 0, parent_number = "") # rubocop:disable Metrics/AbcSize
         result = "".html_safe
         num_in_level = 0
 
-        while headings.length > 0
+        while !headings.empty?
           node = headings.first
-          node_level = node.name[1,].to_i
+          node_level = node.name[1].to_i
 
           if level == node_level
             # We will render this node

lib/open_project/text_formatting/filters/task_list_filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH
@@ -56,7 +58,7 @@ def render_item_checkbox(item)
       # Modifications apply to the parsed document directly.
       #
       # Returns nothing.
-      def filter!
+      def filter! # rubocop:disable Metrics/AbcSize
         list_items(doc).reverse_each do |li|
           next if list_items(li.parent).empty?
 

lib/open_project/text_formatting/formats.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/formats/base_format.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/formats/base_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/formats/markdown/format.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/formats/markdown/formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/formats/markdown/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/formats/plain/format.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/formats/plain/formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/formats/plain/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/helpers/link_rewriter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/matchers/attribute_macros.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH

lib/open_project/text_formatting/matchers/link_handlers/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH
@@ -55,9 +57,7 @@ def self.allowed_prefixes
         []
       end
 
-      def allowed_prefixes
-        self.class.allowed_prefixes
-      end
+      delegate :allowed_prefixes, to: :class
 
       ##
       # Test whether we should try to resolve the given link
@@ -74,9 +74,7 @@ def call
       end
 
       def oid
-        unless identifier.nil?
-          identifier.to_i
-        end
+        identifier&.to_i
       end
 
       delegate :identifier, to: :matcher

lib/open_project/text_formatting/matchers/link_handlers/colon_separator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #-- copyright
 # OpenProject is an open source project management software.
 # Copyright (C) the OpenProject GmbH
@@ -87,7 +89,7 @@ def render_version
         end
       end
 
-      def render_commit
+      def render_commit # rubocop:disable Metrics/AbcSize
         if project&.repository &&
            (changeset = Changeset.where(["repository_id = ? AND scmid LIKE ?", project.repository.id, "#{oid}%"]).first)
           link_to h("#{matcher.project_prefix}#{matcher.identifier}"),
@@ -98,7 +100,7 @@ def render_commit
         end
       end
 
-      def render_source
+      def render_source # rubocop:disable Metrics/AbcSize
         if project&.repository
           matcher.identifier =~ %r{\A[/\\]*(.*?)(@([0-9a-f]+))?(#(L\d+))?\z}
           path = $1
@@ -164,7 +166,7 @@ def render_meeting
           .where(["LOWER(title) = :s", { s: oid.downcase }])
           .first
 
-        if meeting && meeting.visible?(User.current)
+        if meeting&.visible?(User.current)
           link_to meeting.title,
                   { only_path: context[:only_path], controller: "/meetings", action: "show", id: meeting.id },
                   class: "meeting"