Soft-wrap some previously hard-wrapped comments (#356)

Author: mokagio

lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_download_action.rb

@@ -17,8 +17,7 @@ def self.run(params = {})
       end
 
       # Ensure the git repository at `~/.mobile-secrets` is up to date.
-      # If the secrets repo is in a detached HEAD state, skip the pull,
-      # since it will fail.
+      # If the secrets repo is in a detached HEAD state, skip the pull, since it will fail.
       def self.update_repository
         secrets_repo_branch = Fastlane::Helper::ConfigureHelper.repo_branch_name
 

lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_validate_action.rb

@@ -15,8 +15,8 @@ def self.run(params = {})
         # otherwise, the error messaging isn't as helpful.
         validate_that_secrets_repo_is_clean
 
-        # Update the repository to get the latest version of the configuration secrets – that's
-        # how we'll know if we're behind in subsequent validations
+        # Update the repository to get the latest version of the configuration secrets
+        # – that's how we'll know if we're behind in subsequent validations
         ConfigureDownloadAction.run
 
         validate_that_branches_match

lib/fastlane/plugin/wpmreleasetoolkit/helper/git_helper.rb

@@ -8,38 +8,31 @@ module GitHelper
       # Fallback default branch of the client repository.
       DEFAULT_GIT_BRANCH = 'trunk'.freeze
 
-      # Checks if the given path, or current directory if no path is given, is
-      # inside a Git repository
+      # Checks if the given path, or current directory if no path is given, is inside a Git repository
       #
-      # @param [String] path An optional path where to check if a Git repo
-      #        exists.
+      # @param [String] path An optional path where to check if a Git repo exists.
       #
-      # @return [Bool] True if the current directory is the root of a git repo
-      #         (i.e. a local working copy) or a subdirectory of one.
+      # @return [Bool] True if the current directory is the root of a git repo (i.e. a local working copy) or a subdirectory of one.
       #
       def self.is_git_repo?(path: Dir.pwd)
         # If the path doesn't exist, find its first ancestor.
         path = first_existing_ancestor_of(path: path)
         # Get the path's directory, so we can look in it for the Git folder
         dir = path.directory? ? path : path.dirname
 
-        # Recursively look for the Git folder until it's found or we read the
-        # the file system root
+        # Recursively look for the Git folder until it's found or we read the the file system root
         dir = dir.parent until Dir.entries(dir).include?('.git') || dir.root?
 
-        # If we reached the root, we haven't found a repo. (Technically, there
-        # could be a repo in the root of the system, but that's a usecase that
-        # we don't need to support at this time)
+        # If we reached the root, we haven't found a repo.
+        # (Technically, there could be a repo in the root of the system, but that's a usecase that we don't need to support at this time)
         return dir.root? == false
       end
 
-      # Travels back the hierarchy of the given path until it finds an existing
-      # ancestor, or it reaches the root of the file system.
+      # Travels back the hierarchy of the given path until it finds an existing ancestor, or it reaches the root of the file system.
       #
       # @param [String] path The path to inspect
       #
-      # @return [Pathname] The first existing ancestor, or `path` itself if it
-      #         exists
+      # @return [Pathname] The first existing ancestor, or `path` itself if it exists
       #
       def self.first_existing_ancestor_of(path:)
         p = Pathname(path).expand_path
@@ -106,7 +99,7 @@ def self.create_branch(branch_name, from: nil, push: true)
       #
       # @param [String] message The commit message to use
       # @param [String|Array<String>] files A file or array of files to git-add before creating the commit.
-      #        use `nil` or `[]` if you already added the files in a separate step and don't wan't this method to add any new file before commit.
+      #        Use `nil` or `[]` if you already added the files in a separate step and don't wan't this method to add any new file before commit.
       #        Also accepts the special symbol `:all` to add all the files (`git commit -a -m …`).
       # @param [Bool] push If true, will `git push` to `origin` after the commit has been created. Defaults to `false`.
       #
@@ -209,8 +202,7 @@ def self.ensure_on_branch!(branch_name)
         UI.user_error!("This command works only on #{branch_name} branch") unless current_branch_name.include?(branch_name)
       end
 
-      # Checks whether a given path is ignored by Git, relying on Git's
-      # `check-ignore` under the hood.
+      # Checks whether a given path is ignored by Git, relying on Git's `check-ignore` under the hood.
       #
       # @param [String] path The path to check against `.gitignore`
       #

lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_strings_file_validation_helper.rb

@@ -60,8 +60,7 @@ class StringsFileValidationHelper
           }
         }.freeze
 
-        # Inspects the given `.strings` file for duplicated keys, returning them
-        # if any.
+        # Inspects the given `.strings` file for duplicated keys, returning them if any.
         #
         # @param [String] file The path to the file to inspect.
         # @return [Hash<String, Array<Int>] Hash with the dublipcated keys.
@@ -73,12 +72,10 @@ def self.find_duplicated_keys(file:)
 
           File.readlines(file).each_with_index do |line, line_no|
             line.chars.each_with_index do |c, col_no|
-              # Handle escaped characters at a global level. This is more
-              # straightforward than having a `TRANSITIONS` table that account
-              # for it.
+              # Handle escaped characters at a global level.
+              # This is more straightforward than having to account for it in the `TRANSITIONS` table.
               if state.in_escaped_ctx || c == '\\'
-                # Just because we check for escaped characters at the global
-                # level, it doesn't mean we allow them in every context.
+                # Just because we check for escaped characters at the global level, it doesn't mean we allow them in every context.
                 allowed_contexts_for_escaped_characters = %i[in_quoted_key in_quoted_value in_block_comment in_line_comment]
                 raise "Found escaped character outside of allowed contexts on line #{line_no + 1} (current context: #{state.context})" unless allowed_contexts_for_escaped_characters.include?(state.context)
 
@@ -87,16 +84,14 @@ def self.find_duplicated_keys(file:)
                 next
               end
 
-              # Look at the transitions table for the current context, and find
-              # the first transition matching the current character
+              # Look at the transitions table for the current context, and find the first transition matching the current character
               (_, next_context) = TRANSITIONS[state.context].find { |regex, _| c.match?(regex) } || [nil, nil]
               raise "Invalid character `#{c}` found on line #{line_no + 1}, col #{col_no + 1}" if next_context.nil?
 
               state.context = next_context.is_a?(Proc) ? next_context.call(state, c) : next_context
               next unless state.found_key
 
-              # If we just exited the :in_quoted_key context and thus have found
-              # a new key, process it
+              # If we just exited the :in_quoted_key context and thus have found a new key, process it
               key = state.found_key.dup
               state.found_key = nil
 

lib/fastlane/plugin/wpmreleasetoolkit/helper/metadata_download_helper.rb

@@ -12,8 +12,7 @@ def initialize(target_folder, target_files)
         @alternates = {}
       end
 
-      # Downloads data from GlotPress,
-      # in JSON format
+      # Downloads data from GlotPress, in JSON format
       def download(target_locale, glotpress_url, is_source)
         uri = URI(glotpress_url)
         response = Net::HTTP.get_response(uri)
@@ -80,8 +79,7 @@ def update_key(target_locale, key, file, data, msg)
         end
       end
 
-      # Writes the downloaded content
-      # to the target file
+      # Writes the downloaded content to the target file
       def save_metadata(locale, file_name, content)
         file_path = get_target_file_path(locale, file_name)
 

lib/fastlane/plugin/wpmreleasetoolkit/helper/promo_screenshots_helper.rb

@@ -117,8 +117,7 @@ def draw_device_frame_to_canvas(device, canvas)
       end
 
       def draw_screenshot_to_canvas(entry, canvas, device)
-        # Don't require a screenshot to be present – we can just skip
-        # this function if one doesn't exist.
+        # Don't require a screenshot to be present – we can just skip this function if one doesn't exist.
         return canvas if entry['screenshot'].nil?
 
         device_mask = device['screenshot_mask']

lib/fastlane/plugin/wpmreleasetoolkit/helper/release_notes_helper.rb

@@ -9,9 +9,11 @@ module ReleaseNotesHelper
       def self.add_new_section(path:, section_title:)
         lines = File.readlines(path)
 
-        # Find the index of the first non-empty line that is also NOT a comment. That way we keep commment headers as the very top of the file
+        # Find the index of the first non-empty line that is also NOT a comment.
+        # That way we keep commment headers as the very top of the file
         line_idx = lines.find_index { |l| !l.start_with?('***') && !l.start_with?('//') && !l.chomp.empty? }
-        # Put back the header, then the new entry, then the rest (note: '...' excludes the higher bound of the range, unlike '..')
+        # Put back the header, then the new entry, then the rest
+        # (note: '...' excludes the higher bound of the range, unlike '..')
         new_lines = lines[0...line_idx] + ["#{section_title}\n", "-----\n", "\n", "\n"] + lines[line_idx..]
 
         File.write(path, new_lines.join)

lib/fastlane/plugin/wpmreleasetoolkit/models/file_reference.rb

@@ -40,11 +40,9 @@ def update
       end
 
       # "Applies" the instruction described in the instance to the file system.
-      # That is, copies the content of the source `file` to the `destination`
-      # path.
+      # That is, copies the content of the source `file` to the `destination` path.
       #
-      # @raise [StandardError] For security reasons, it will raise if
-      # `destination` is not ignored under Git.
+      # @raise [StandardError] For security reasons, it will raise if `destination` is not ignored under Git.
       def apply
         # Only decrypt the file if the destination is ignored in Git
         unless Fastlane::Helper::GitHelper.is_ignored?(path: destination_file_path)

spec/an_localize_libs_action_spec.rb

@@ -1,12 +1,9 @@
 require 'spec_helper'
 
 describe Fastlane::Actions::AnLocalizeLibsAction do
-  # This test is more of a way of ensuring `run_described_fastlane_action` handles array
-  # of hashes properly than a comprehensive test for the
-  # `an_localize_libs_action` action.
+  # This test is more of a way of ensuring `run_described_fastlane_action` handles array of hashes properly than a comprehensive test for the `an_localize_libs_action` action.
   #
-  # Please consider expanding this test if you'll find yourself working on its
-  # action.
+  # Please consider expanding this test if you'll find yourself working on its action.
   it 'merges the strings from the given array into the given main strings file' do
     in_tmp_dir do |tmp_dir|
       app_strings_path = File.join(tmp_dir, 'app.xml')
@@ -37,12 +34,9 @@
 end
 
 def android_xml_with_content(content)
-  # I couldn't find a way to interpolate a multiline string preserving its
-  # indentation in the heredoc below, so I hacked the following transformation
-  # of the input that adds the desired indentation to all lines.
+  # I couldn't find a way to interpolate a multiline string preserving its indentation in the heredoc below, so I hacked the following transformation of the input that adds the desired indentation to all lines.
   #
-  # The desired indentation is 4 spaces to stay aligned with the production
-  # code applies when merging the XMLs.
+  # The desired indentation is 4 spaces to stay aligned with the production code applies when merging the XMLs.
   indented_content = content.chomp.lines.map { |l| "    #{l}" }.join
 
   return <<~XML

spec/an_metadata_update_helper_spec.rb

@@ -17,11 +17,9 @@
       output_io = StringIO.new
       described_class.new('any-key', input_path).generate_block(output_io)
 
-      # Ensure the output matches the expectation: the trailing new line has
-      # been stripped.
+      # Ensure the output matches the expectation: the trailing new line has been stripped.
       #
-      # Note that the final new line is intentional. It's part of the
-      # formatting at the time of writing.
+      # Note that the final new line is intentional. It's part of the formatting at the time of writing.
       expect(output_io.string).to eq <<~EXP
         msgctxt "any-key"
         msgid "Single line message with new line"
@@ -39,13 +37,11 @@
       input_path = File.join(dir, 'input')
       File.write(input_path, input)
 
-      # Write the .pot block in a StringIO to bypass the filesystem and have
-      # faster tests
+      # Write the .pot block in a StringIO to bypass the filesystem and have faster tests
       output_io = StringIO.new
       described_class.new('any-key', input_path).generate_block(output_io)
 
-      # Note that the new line after `msgstr` is intentional. It's part of the
-      # formatting at the time of writing.
+      # Note that the new line after `msgstr` is intentional. It's part of the formatting at the time of writing.
       expect(output_io.string).to eq <<~'EXP'
         msgctxt "any-key"
         msgid ""