Fix Naming/VariableName violations

Author: spencertransier

.rubocop_todo.yml

@@ -48,17 +48,6 @@ Naming/MethodParameterName:
 Naming/PredicateName:
   Enabled: false
 
-# Offense count: 54
-# Configuration parameters: EnforcedStyle, AllowedIdentifiers, AllowedPatterns.
-# SupportedStyles: snake_case, camelCase
-Naming/VariableName:
-  Exclude:
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/common/promo_screenshots_action.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_add_files_to_copy_action.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_validate_action.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_version_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/promo_screenshots_helper.rb'
-
 # Offense count: 2
 # Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
 # SupportedStyles: snake_case, normalcase, non_integer

lib/fastlane/plugin/wpmreleasetoolkit/actions/common/promo_screenshots_action.rb

@@ -15,8 +15,8 @@ def self.run(params)
 
         helper.check_fonts_installed!(config: config) unless params[:skip_font_check]
 
-        translationDirectories = subdirectories_for_path(params[:metadata_folder])
-        imageDirectories = subdirectories_for_path(params[:orig_folder])
+        translation_directories = subdirectories_for_path(params[:metadata_folder])
+        image_directories = subdirectories_for_path(params[:orig_folder])
 
         if helper.can_resolve_path(params[:output_folder])
           UI.message "#{self.check_path(params[:output_folder])} Output Folder: #{params[:output_folder]}"
@@ -25,18 +25,18 @@ def self.run(params)
           FileUtils.mkdir_p(params[:output_folder])
         end
 
-        outputDirectory = helper.resolve_path(params[:output_folder])
+        output_directory = helper.resolve_path(params[:output_folder])
 
         ## If there are no translated screenshot images (whether it's because they haven't been generated yet,
         ##   or because we aren't using them), just use the translated directories.
-        languages = if imageDirectories == []
-                      translationDirectories
+        languages = if image_directories == []
+                      translation_directories
                     ## And vice-versa.
-                    elsif translationDirectories == []
-                      imageDirectories
+                    elsif translation_directories == []
+                      image_directories
                     ## If there are original screenshots and translations available, use only locales that exist in both.
                     else
-                      imageDirectories & translationDirectories
+                      image_directories & translation_directories
                     end
 
         UI.message("💙 Creating Promo Screenshots for: #{languages.join(', ')}")
@@ -49,7 +49,7 @@ def self.run(params)
 
         stylesheet_path = config['stylesheet']
 
-        entries = build_entries(config['entries'], languages, outputDirectory, params)
+        entries = build_entries(config['entries'], languages, output_directory, params)
 
         bar = ProgressBar.new(entries.count, :bar, :counter, :eta, :rate)
 
@@ -183,32 +183,32 @@ def self.build_entries(config_entries, languages, output_directory, params)
         config_entries
           .flat_map do |entry|
           languages.map do |language|
-            newEntry = entry.deep_dup
+            new_entry = entry.deep_dup
 
             # Not every output file will have a screenshot, so handle cases where no
             # screenshot file is defined
             if !entry['screenshot'].nil? && !entry['filename'].nil?
-              newEntry['screenshot'] = helper.resolve_path(params[:orig_folder]) + language + entry['screenshot']
-              newEntry['filename'] = output_directory + language + entry['filename']
+              new_entry['screenshot'] = helper.resolve_path(params[:orig_folder]) + language + entry['screenshot']
+              new_entry['filename'] = output_directory + language + entry['filename']
             elsif !entry['screenshot'].nil? && entry['filename'].nil?
-              newEntry['screenshot'] = helper.resolve_path(params[:orig_folder]) + language + entry['screenshot']
-              newEntry['filename'] = output_directory + language + entry['screenshot']
+              new_entry['screenshot'] = helper.resolve_path(params[:orig_folder]) + language + entry['screenshot']
+              new_entry['filename'] = output_directory + language + entry['screenshot']
             elsif entry['screenshot'].nil? && !entry['filename'].nil?
-              newEntry['filename'] = output_directory + language + entry['filename']
+              new_entry['filename'] = output_directory + language + entry['filename']
             else
-              puts newEntry
+              puts new_entry
               abort 'Unable to find output file names'
             end
 
-            newEntry['locale'] = language
+            new_entry['locale'] = language
 
             # Localize file paths for text
-            newEntry['text'].sub!('{locale}', language.dup) unless entry['text'].nil?
+            new_entry['text'].sub!('{locale}', language.dup) unless entry['text'].nil?
 
             # Map attachments paths to their localized versions
-            newEntry['attachments'] = [] if newEntry['attachments'].nil?
+            new_entry['attachments'] = [] if new_entry['attachments'].nil?
 
-            newEntry['attachments'].each do |attachment|
+            new_entry['attachments'].each do |attachment|
               ## If there are no translated screenshot images (whether it's because they haven't been generated yet,
               ##   or because we aren't using them), just use the translated directories.
               ## And vice-versa.
@@ -240,7 +240,7 @@ def self.build_entries(config_entries, languages, output_directory, params)
               attachment['text']&.sub!('{locale}', language.dup)
             end
 
-            newEntry
+            new_entry
           end
         end
           .sort do |x, y|

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

@@ -40,13 +40,13 @@ def self.add_file
           UI.message 'Example: google-services.json'
 
           source = UI.input('Source File Path:')
-          sourcePath = absolute_secret_store_path(source) # Transform the relative path into an absolute path.
+          source_path = absolute_secret_store_path(source) # Transform the relative path into an absolute path.
 
           # Don't allow the developer to accidentally specify an invalid file, otherwise validation will never succeed.
-          if File.file?(sourcePath)
+          if File.file?(source_path)
             invalid_file = false
           else
-            UI.error "There is no file at #{sourcePath}."
+            UI.error "There is no file at #{source_path}."
           end
         end
 

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

@@ -91,10 +91,10 @@ def self.validate_that_all_copied_files_match
           source = absolute_secret_store_path(x.file)
           destination = absolute_project_path(x.destination)
 
-          sourceHash = file_hash(source)
-          destinationHash = file_hash(destination)
+          source_hash = file_hash(source)
+          destination_hash = file_hash(destination)
 
-          UI.user_error!("`#{x.destination} doesn't match the file in the secrets repository (#{x.file}) – unable to continue") unless sourceHash == destinationHash
+          UI.user_error!("`#{x.destination} doesn't match the file in the secrets repository (#{x.file}) – unable to continue") unless source_hash == destination_hash
         end
       end
 

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

@@ -139,8 +139,8 @@ def self.calc_prev_hotfix_version(version)
         def self.create_internal_version(version)
           vp = get_version_parts(version)
           d = DateTime.now
-          todayDate = d.strftime('%Y%m%d')
-          "#{vp[MAJOR_NUMBER]}.#{vp[MINOR_NUMBER]}.#{vp[HOTFIX_NUMBER]}.#{todayDate}"
+          today_date = d.strftime('%Y%m%d')
+          "#{vp[MAJOR_NUMBER]}.#{vp[MINOR_NUMBER]}.#{vp[HOTFIX_NUMBER]}.#{today_date}"
         end
 
         # Return the build number value incremented by one.
@@ -266,31 +266,31 @@ def self.get_version_parts(version)
 
         # Extract the VERSION_LONG entry from an `xcconfig` file
         #
-        # @param [String] filePath The path to the `.xcconfig` file to read the value from
+        # @param [String] file_path The path to the `.xcconfig` file to read the value from
         # @return [String] The long version found in said xcconfig file, or nil if not found
         #
-        def self.read_long_version_from_config_file(filePath)
-          read_from_config_file('VERSION_LONG', filePath)
+        def self.read_long_version_from_config_file(file_path)
+          read_from_config_file('VERSION_LONG', file_path)
         end
 
         # Extract the BUILD_NUMBER entry from an `xcconfig` file
         #
-        # @param [String] filePath The path to the `.xcconfig` file to read the value from
+        # @param [String] file_path The path to the `.xcconfig` file to read the value from
         # @return [String] The build number found in said xcconfig file, or nil if not found
         #
-        def self.read_build_number_from_config_file(filePath)
-          read_from_config_file('BUILD_NUMBER', filePath)
+        def self.read_build_number_from_config_file(file_path)
+          read_from_config_file('BUILD_NUMBER', file_path)
         end
 
         # Read the value of a given key from an `.xcconfig` file.
         #
         # @param [String] key The xcconfig key to get the value for
-        # @param [String] filePath The path to the `.xcconfig` file to read the value from
+        # @param [String] file_path The path to the `.xcconfig` file to read the value from
         #
         # @return [String] The value for the given key, or `nil` if the key was not found.
         #
-        def self.read_from_config_file(key, filePath)
-          File.open(filePath, 'r') do |f|
+        def self.read_from_config_file(key, file_path)
+          File.open(file_path, 'r') do |f|
             f.each_line do |line|
               line = line.strip
               return line.split('=')[1] if line.start_with?("#{key}=")

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

@@ -32,14 +32,14 @@ def initialize
         UI.user_error!('`drawText` not found – install it using `brew install automattic/build-tools/drawText`.') unless system('command -v drawText')
       end
 
-      def read_config(configFilePath)
-        configFilePath = resolve_path(configFilePath)
+      def read_config(config_file_path)
+        config_file_path = resolve_path(config_file_path)
 
         begin
           # NOTE: While JSON is a subset of YAML and thus YAML.load_file would technically cover both cases at once, in practice
           # `JSON.parse` is more lenient with JSON files than `YAML.load_file` is — especially, it accepts `// comments` in the
           # JSON file, despite this not being allowed in the spec — hence why we still try with `JSON.parse` for `.json` files.
-          return File.extname(configFilePath) == '.json' ? JSON.parse(File.read(configFilePath)) : YAML.load_file(configFilePath)
+          return File.extname(config_file_path) == '.json' ? JSON.parse(File.read(config_file_path)) : YAML.load_file(config_file_path)
         rescue StandardError => e
           UI.error(e)
           UI.user_error!('Invalid JSON/YAML configuration. Please lint your config file to check for syntax errors.')
@@ -280,7 +280,7 @@ def apply_operation(image, operation, canvas)
 
       def draw_text_to_canvas(canvas, text, width, height, x_position, y_position, font_size, stylesheet_path, position = 'center')
         begin
-          tempTextFile = Tempfile.new
+          temp_text_file = Tempfile.new
 
           Action.sh('drawText', "html=#{text}", "maxWidth=#{width}", "maxHeight=#{height}", "output=#{tempTextFile.path}", "fontSize=#{font_size}", "stylesheet=#{stylesheet_path}", "alignment=#{position}")
 
@@ -292,8 +292,8 @@ def draw_text_to_canvas(canvas, text, width, height, x_position, y_position, fon
                        when 'top' then composite_image_top(text_frame, text_content, 0, 0)
                        end
         ensure
-          tempTextFile.close
-          tempTextFile.unlink
+          temp_text_file.close
+          temp_text_file.unlink
         end
 
         composite_image(canvas, text_frame, x_position, y_position)
@@ -431,12 +431,12 @@ def resolve_path(path)
       end
 
       def resolve_text_into_path(text, locale)
-        localizedFile = format(text, locale)
+        localized_file = format(text, locale)
 
-        text = if File.exist?(localizedFile)
-                 localizedFile
-               elsif can_resolve_path(localizedFile)
-                 resolve_path(localizedFile).realpath.to_s
+        text = if File.exist?(localized_file)
+                 localized_file
+               elsif can_resolve_path(localized_file)
+                 resolve_path(localized_file).realpath.to_s
                else
                  format(text, 'source')
                end