xxx_rename 0.0.1

data/lib/xxx_rename/client.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "xxx_rename/contract/file_rename_op_contract"
+require "xxx_rename/data/file_rename_op_datastore"
+require "xxx_rename/site_client_matcher"
+require "xxx_rename/actions/resolver"
+
+module XxxRename
+  class Client
+    #
+    # Rename file(s) in the current directory
+    #
+    # @param [Data::Config] config
+    # @param [Boolean] verbose
+    # @param [Symbol] override_site
+    # @param [Boolean] nested
+    # @param [String, Nil] checkpoint
+    def initialize(config, verbose:, override_site: nil, nested: false, checkpoint: nil)
+      @config = config
+      @override_site = override_site
+      @nested = nested
+      @checkpoint = checkpoint
+      @checkpoint_reached = false
+      XxxRename.logger(verbose: verbose)
+    end
+
+    def generate(object, &block)
+      @object = object
+      @custom_action = block
+      if File.directory?(object)
+        process_directory
+        return
+      end
+
+      if File.file?(object)
+        process_file(object)
+        return
+      end
+
+      raise Errors::FatalError, "[UNKNOWN OBJECT #{object}] pass a valid file or directory"
+    end
+
+    def matcher
+      @matcher ||=
+        begin
+          m = SiteClientMatcher.new(config, override_site: override_site)
+          ActorsHelper.instance.matcher(m)
+          m
+        end
+    end
+
+    def resolver
+      @resolver ||= Actions::Resolver.new(config)
+    end
+
+    private
+
+    attr_reader :config, :override_site, :nested, :object
+
+    def process_directory
+      scanner.each do |file|
+        if @checkpoint
+          if @checkpoint != file && !@checkpoint_reached
+            XxxRename.logger.debug "[SKIP CHECKPOINT] #{file}"
+            next
+          elsif @checkpoint == file
+            XxxRename.logger.info "[REACHED CHECKPOINT] #{file}"
+            @checkpoint_reached = true
+          end
+        end
+        process_file(file)
+      end
+    end
+
+    def process_file(file)
+      path = relative_path(file)
+      file = File.basename(file)
+
+      Dir.chdir(path) do
+        XxxRename.logger.info "#{"[FILE SCAN]".colorize(:blue)} #{file}"
+        search_engine.search(file) do |search_result|
+          next if search_result&.empty?
+
+          config.actions.each do |action_str|
+            action = resolver.resolve!(action_str)
+            action.perform(Dir.pwd, file, search_result)
+          end
+
+          next unless @custom_action
+
+          @custom_action.call(Dir.pwd, file, search_result)
+        end
+      end
+    end
+
+    def search_engine
+      @search_engine ||= Search.new(matcher, config.scene_datastore, config.force_refresh)
+    end
+
+    def scanner
+      @scanner ||= FileScanner.new(@object, nested: @nested)
+    end
+
+    def relative_path(file)
+      return Dir.pwd if File.basename(file) == file
+
+      file.gsub(File.basename(file), "")
+    end
+  end
+end

data/lib/xxx_rename/constants.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module XxxRename
+  module Constants
+    VIDEO_EXTENSIONS = %w[m4v mp4 mov wmv avi mpg mpeg rmvb rm flv asf mkv webm].to_set.freeze
+
+    DEFAULT_HEADERS = {
+      "User-Agent" => "Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion"
+    }.freeze
+
+    EVIL_ANGEL_ORIGINAL_FILE_PATTERN = /
+          ^                          # Start of filename
+          (?<title>[a-zA-z0-9-]+)   # Name of movie
+          _s(?<index>\d{1,2})        # Scene index e.g. s01
+          _                          # Underscore
+          (?<actors>[a-zA-Z_]+)      # Actors in format ActorName,ActorName
+          _\d{3,4}p                  # Scene Resolution
+          \.\w+                      # File extension
+          $                          # End of filename
+          /x.freeze
+
+    GOODPORN_ORIGINAL_FILE_FORMAT =
+      /
+      ^                          # Start of filename
+      [a-z0-9-]+                 # Collection + Title
+      -                          # Hyphen
+      \d{2}-\d{2}-\d{4}          # Release Date
+      (_(480|720|1080)p)?        # Scene Resolution
+      \.\w+                      # File extension
+      $                          # End of filename
+      /x.freeze
+
+    MG_PREMIUM_ORIGINAL_FILE_FORMAT =
+      /
+      ^                                             # Start of filename
+      (?<title>[a-z\-\d]+).*(?<!\d{2}-\d{2}-\d{4})  # Scene Title (should not contain a date format \d{2}-\d{2}-\d{4})
+      _                                             # Underscore
+      \d{3,4}p                                      # Resolution
+      \.\w{3,4}                                     # File extension
+      $                                             # End of filename
+      /x.freeze
+
+    NAUGHTY_AMERICA_ORIGINAL_FILE_REGEX =
+      /
+      ^                            # Start of filename
+      (?<compressed_scene>[a-z1]+) # Scene Title
+      _                            # Underscore
+      \d+\w+?                      # Resolution
+      \.\w{0,4}                    # File extension
+      $                            # End of filename
+      /x.freeze
+
+    NF_BUSTY_ORIGINAL_FILE_REGEX =
+      /
+      ^                            # Start of filename
+      nfbusty_                     # Prefix
+      (?<title>[a-z0-9_]+)         # Scene Title
+      _                            # Underscore
+      \d{3,4}                      # Resolution
+      \.\w{0,4}                    # File extension
+      $                            # End of filename
+      /x.freeze
+
+    # These regexes match the files downloaded originally from Vixen Media sites
+    VIXEN_MEDIA_SITES = %w[DEEPER VIXEN BLACKEDRAW BLACKED TUSHYRAW TUSHY CHANNELS SLAYED].join("|")
+    VIXEN_MEDIA_ORIGINAL_FILE_REGEX_1 = /(?<collection>(#{VIXEN_MEDIA_SITES}))_(?<id>\d*)_\d{3,4}P/x.freeze
+    VIXEN_MEDIA_ORIGINAL_FILE_REGEX_2 = /(?<collection>(#{VIXEN_MEDIA_SITES}))_(?<id>\d{6})-.*_\d{3,4}P/x.freeze
+
+    # rubocop:disable Lint/MixedRegexpCaptureTypes
+    WHALE_ORIGINAL_FILE_PATTERN =
+      /
+      ^                            # Start of filename
+      (?<site>(nannyspy|spyfam|holed|lubed|myveryfirsttime|tiny4k|povd|fantasyhd|castingcouchx|puremature|passionhd|exotic4k)) # Sitename
+      -                            # Hyphen
+      (?<title>[a-z0-9-]+)        # Scene Title (might contain random id strings)
+      -                            # Hyphen separator for resolution
+      \d{3,4}                      # Resolution
+      \.\w+                        # File extension
+      $                            # End of filename
+      /x.freeze
+    # rubocop:enable Lint/MixedRegexpCaptureTypes
+  end
+
+  module SystemConstants
+    def home_dir
+      ENV["HOME"]
+    end
+
+    def config_file_lookup_dirs
+      [
+        File.join(home_dir, ".config", "xxx_rename"),
+        File.join(home_dir, "xxx_rename")
+      ]
+    end
+  end
+end

data/lib/xxx_rename/contract/config_contract.rb

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+module XxxRename
+  module Contract
+    class ConfigContract < Dry::Validation::Contract
+      include FileUtilities
+      option :filename_generator
+
+      SITE_CONFIG = Dry::Schema.JSON do
+        required(:collection_tag).value(Types::SanitizedString)
+        required(:output_format).value(array[Types::SanitizedString])
+        required(:file_source_format).value(array[Types::SanitizedString])
+      end
+
+      JULES_JORDAN_MEDIA_CONFIG = Dry::Schema.JSON do
+        required(:collection_tag).value(Types::SanitizedString)
+        required(:output_format).value(array[Types::SanitizedString])
+        required(:file_source_format).value(array[Types::SanitizedString])
+        optional(:cookie_file).maybe(Types::SanitizedString)
+      end
+
+      STASH_CONFIG = Dry::Schema.JSON do
+        required(:collection_tag).value(Types::SanitizedString)
+        optional(:username).maybe(Types::SanitizedString)
+        optional(:password).maybe(Types::SanitizedString)
+        optional(:api_token).maybe(Types::SanitizedString)
+        required(:output_format).value(array[Types::SanitizedString])
+        required(:file_source_format).value(array[Types::SanitizedString])
+      end
+
+      NAUGHTY_AMERICA_CONFIG = Dry::Schema.JSON do
+        # if database is not provided, it will be created automatically
+        optional(:database).filled(Types::SanitizedString)
+        required(:collection_tag).value(Types::SanitizedString)
+        required(:output_format).value(array[Types::SanitizedString])
+        required(:file_source_format).value(array[Types::SanitizedString])
+      end
+
+      NF_BUSTY_CONFIG = Dry::Schema.JSON do
+        # if database is not provided, it will be created automatically
+        optional(:database).filled(Types::SanitizedString)
+        required(:collection_tag).value(Types::SanitizedString)
+        required(:output_format).value(array[Types::SanitizedString])
+        required(:file_source_format).value(array[Types::SanitizedString])
+      end
+
+      # rubocop:disable Metrics/BlockLength
+      json do
+        required(:generated_files_dir).filled(:string)
+        optional(:force_refresh_datastore).filled(Types::Bool)
+        optional(:force_refresh).filled(Types::Bool)
+        optional(:actions).value(Types::Array.of(Types::String))
+        optional(:override_site).value(Types::String)
+
+        optional(:stash_app).hash do
+          optional(:url).value(Types::SanitizedString)
+          optional(:api_token).maybe(Types::SanitizedString)
+        end
+
+        required(:global).hash do
+          optional(:female_actors_prefix).filled(Types::SanitizedString)
+          optional(:male_actors_prefix).filled(Types::SanitizedString)
+          optional(:actors_prefix).filled(Types::SanitizedString)
+          optional(:title_prefix).filled(Types::SanitizedString)
+          optional(:id_prefix).filled(Types::SanitizedString)
+          optional(:output_format).value(array[Types::SanitizedString])
+        end
+
+        required(:site).hash do
+          optional(:adult_time).hash(SITE_CONFIG)
+          optional(:babes).hash(SITE_CONFIG)
+          optional(:blacked).hash(SITE_CONFIG)
+          optional(:blacked_raw).hash(SITE_CONFIG)
+          optional(:brazzers).hash(SITE_CONFIG)
+          optional(:digital_playground).hash(SITE_CONFIG)
+          optional(:elegant_angel).hash(SITE_CONFIG)
+          optional(:evil_angel).hash(SITE_CONFIG)
+          optional(:goodporn).hash(SITE_CONFIG)
+          optional(:jules_jordan).hash(JULES_JORDAN_MEDIA_CONFIG)
+          optional(:manuel_ferrara).hash(JULES_JORDAN_MEDIA_CONFIG)
+          optional(:mofos).hash(SITE_CONFIG)
+          optional(:naughty_america).hash(NAUGHTY_AMERICA_CONFIG)
+          optional(:nf_busty).hash(NF_BUSTY_CONFIG)
+          optional(:reality_kings).hash(SITE_CONFIG)
+          optional(:stash).hash(STASH_CONFIG)
+          optional(:tushy).hash(SITE_CONFIG)
+          optional(:tushy_raw).hash(SITE_CONFIG)
+          optional(:twistys).hash(SITE_CONFIG)
+          optional(:vixen).hash(SITE_CONFIG)
+          optional(:whale_media).hash(SITE_CONFIG)
+          optional(:wicked).hash(SITE_CONFIG)
+          optional(:x_empire).hash(SITE_CONFIG)
+          optional(:zero_tolerance).hash(SITE_CONFIG)
+        end
+      end
+      # rubocop:enable Metrics/BlockLength
+
+      rule(:generated_files_dir) do
+        key.failure("does not exist or is not readable") unless valid_dir?(value)
+      end
+
+      rule("global.female_actors_prefix") { key.failure(INVALID_PREFIX_MSG) unless prefix_valid?(value) }
+      rule("global.male_actors_prefix") { key.failure(INVALID_PREFIX_MSG) unless prefix_valid?(value) }
+      rule("global.actors_prefix") { key.failure(INVALID_PREFIX_MSG) unless prefix_valid?(value) }
+      rule("global.title_prefix") { key.failure(INVALID_PREFIX_MSG) unless prefix_valid?(value) }
+      rule("global.id_prefix") { key.failure(INVALID_PREFIX_MSG) unless prefix_valid?(value) }
+
+      # Validate output format
+      rule("global.output_format") { validate_format!(key, value) }
+      rule("site.adult_time.output_format") { validate_format!(key, value) }
+      rule("site.babes.output_format") { validate_format!(key, value) }
+      rule("site.blacked.output_format") { validate_format!(key, value) }
+      rule("site.blacked_raw.output_format") { validate_format!(key, value) }
+      rule("site.brazzers.output_format") { validate_format!(key, value) }
+      rule("site.digital_playground.output_format") { validate_format!(key, value) }
+      rule("site.elegant_angel.output_format") { validate_format!(key, value) }
+      rule("site.evil_angel.output_format") { validate_format!(key, value) }
+      rule("site.jules_jordan.output_format") { validate_format!(key, value) }
+      rule("site.manuel_ferrara.output_format") { validate_format!(key, value) }
+      rule("site.mofos.output_format") { validate_format!(key, value) }
+      rule("site.naughty_america.output_format") { validate_format!(key, value) }
+      rule("site.nf_busty.output_format") { validate_format!(key, value) }
+      rule("site.reality_kings.output_format") { validate_format!(key, value) }
+      rule("site.stash.output_format") { validate_format!(key, value) }
+      rule("site.tushy.output_format") { validate_format!(key, value) }
+      rule("site.tushy_raw.output_format") { validate_format!(key, value) }
+      rule("site.twistys.output_format") { validate_format!(key, value) }
+      rule("site.vixen.output_format") { validate_format!(key, value) }
+      rule("site.whale_media.output_format") { validate_format!(key, value) }
+      rule("site.wicked.output_format") { validate_format!(key, value) }
+      rule("site.x_empire.output_format") { validate_format!(key, value) }
+      rule("site.zero_tolerance.output_format") { validate_format!(key, value) }
+
+      rule("site.adult_time.file_source_format") { validate_source_format!(key, value) }
+      rule("site.babes.file_source_format") { validate_source_format!(key, value) }
+      rule("site.blacked.file_source_format") { validate_source_format!(key, value) }
+      rule("site.blacked_raw.file_source_format") { validate_source_format!(key, value) }
+      rule("site.brazzers.file_source_format") { validate_source_format!(key, value) }
+      rule("site.digital_playground.file_source_format") { validate_source_format!(key, value) }
+      rule("site.elegant_angel.file_source_format") { validate_source_format!(key, value) }
+      rule("site.evil_angel.file_source_format") { validate_source_format!(key, value) }
+      rule("site.mofos.file_source_format") { validate_source_format!(key, value) }
+      rule("site.jules_jordan.file_source_format") { validate_source_format!(key, value) }
+      rule("site.manuel_ferrara.file_source_format") { validate_source_format!(key, value) }
+      rule("site.naughty_america.file_source_format") { validate_source_format!(key, value) }
+      rule("site.nf_busty.file_source_format") { validate_source_format!(key, value) }
+      rule("site.reality_kings.file_source_format") { validate_source_format!(key, value) }
+      rule("site.stash.file_source_format") { validate_source_format!(key, value) }
+      rule("site.tushy.file_source_format") { validate_source_format!(key, value) }
+      rule("site.tushy_raw.file_source_format") { validate_source_format!(key, value) }
+      rule("site.twistys.file_source_format") { validate_source_format!(key, value) }
+      rule("site.vixen.file_source_format") { validate_source_format!(key, value) }
+      rule("site.whale_media.file_source_format") { validate_source_format!(key, value) }
+      rule("site.wicked.file_source_format") { validate_source_format!(key, value) }
+      rule("site.x_empire.file_source_format") { validate_source_format!(key, value) }
+      rule("site.zero_tolerance.file_source_format") { validate_source_format!(key, value) }
+      rule("site.adult_time.file_source_format",
+           "site.babes.file_source_format",
+           "site.blacked.file_source_format",
+           "site.blacked_raw.file_source_format",
+           "site.brazzers.file_source_format",
+           "site.digital_playground.file_source_format",
+           "site.elegant_angel.file_source_format",
+           "site.evil_angel.file_source_format",
+           "site.jules_jordan.file_source_format",
+           "site.manuel_ferrara.file_source_format",
+           "site.mofos.file_source_format",
+           "site.naughty_america.file_source_format",
+           "site.nf_busty.file_source_format",
+           "site.reality_kings.file_source_format",
+           "site.stash.file_source_format",
+           "site.tushy.file_source_format",
+           "site.tushy_raw.file_source_format",
+           "site.twistys.file_source_format",
+           "site.vixen.file_source_format",
+           "site.whale_media.file_source_format",
+           "site.wicked.file_source_format",
+           "site.x_empire.file_source_format",
+           "site.zero_tolerance.file_source_format") { validate_uniqueness!(key(:duplicate_source_file_format), values) }
+
+      rule("site.stash.username", "site.stash.password") do
+        next unless key?("site.stash.username") && key?("site.stash.password")
+
+        presence_arr = [values["site.stash.username"], values["site.stash.password"]].map(&:to_s).map(&:presence)
+        if presence_arr.all?(NIL)
+          true
+        elsif presence_arr.none?(NIL)
+          true
+        else
+          key(:stash_credentials).failure("provide both username and password if you want to use login credentials")
+        end
+      end
+
+      private
+
+      INVALID_PREFIX_MSG = "should only contain A-Z a-z 0-9 [ ] _ -"
+      INVALID_PREFIX_CHARACTERS = /[^\w\[\]-]/.freeze
+
+      def prefix_valid?(prefix)
+        !INVALID_PREFIX_CHARACTERS.match?(prefix)
+      end
+
+      def validate_format!(key, value)
+        value.each { |format| filename_generator.validate_format!(format) }
+        true
+      rescue InvalidFormatError => e
+        key.failure(e.message)
+      end
+
+      def validate_source_format!(key, value)
+        value.each { |format| filename_generator.validate_input_format!(format) }
+        true
+      rescue InvalidFormatError => e
+        key.failure(e.message)
+      end
+
+      def validate_uniqueness!(key, values)
+        source_file_formats = []
+        values[:site].each_value { |x| source_file_formats.push(*x[:file_source_format]) }
+        duplicates = find_duplicates(source_file_formats)
+        return true if duplicates.empty?
+
+        key.failure(duplicates.map { |x| "'#{x}'" }.join(", "))
+      end
+
+      def find_duplicates(ary)
+        frequency = {}
+        ary.map do |x|
+          frequency[x] = if frequency.key?(x)
+                           frequency[x] + 1
+                         else
+                           1
+                         end
+        end
+        resp = []
+        frequency.each_pair { |key, value| resp << key if value > 1 }
+        resp
+      end
+    end
+  end
+end

data/lib/xxx_rename/contract/config_generator.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+require "xxx_rename/constants"
+require "fileutils"
+
+module XxxRename
+  module Contract
+    class ConfigGenerator
+      include XxxRename::FileUtilities
+      include SystemConstants
+
+      DEFAULT_CONFIG_FILE = "config.yml"
+
+      def initialize(options)
+        @options = options
+        generated_files_dir
+      end
+
+      # @return [Data::Config]
+      def generate!
+        config_hash = make_config_hash
+        valid_config = validate_download_filters!(config_hash)
+        Data::Config.new(valid_config)
+      end
+
+      # Step 1: Get the base configuration hash with default values
+      def default_config
+        {
+          "generated_files_dir" => generated_files_dir,
+          "stash_app" => {
+            "url" => "",
+            "api_token" => nil
+          },
+          "global" => {
+            "female_actors_prefix" => "[F]",
+            "male_actors_prefix" => "[M]",
+            "actors_prefix" => "[A]",
+            "title_prefix" => "[T]",
+            "id_prefix" => "[ID]",
+            "output_format" => [
+              # disable line length check for readability
+              # rubocop:disable Layout/LineLength
+              "%yyyy_mm_dd %id_prefix %id %title_prefix %title %collection_tag %collection %female_actors_prefix %female_actors %male_actors_prefix %male_actors",
+              "%yyyy_mm_dd %id_prefix %id %title_prefix %collection_tag %collection %actors_prefix %actors",
+              "%yyyy_mm_dd %title_prefix %title %collection_tag %collection %female_actors_prefix %female_actors %male_actors_prefix %male_actors",
+              "%yyyy_mm_dd %title_prefix %collection_tag %collection %actors_prefix %actors"
+              # rubocop:enable Layout/LineLength
+            ]
+          },
+          "site" =>
+            { "adult_time" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "AT" },
+              "babes" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "BA" },
+              "blacked" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "BL" },
+              "blacked_raw" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "BLR" },
+              "brazzers" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "BZ" },
+              "digital_playground" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "DP" },
+              "elegant_angel" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "EL" },
+              "evil_angel" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "EA" },
+              "goodporn" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "GP" },
+              "jules_jordan" =>
+                { "output_format" => [],
+                  "file_source_format" => [],
+                  "collection_tag" => "JJ",
+                  "cookie_file" => nil },
+              "manuel_ferrara" =>
+                { "output_format" => [],
+                  "file_source_format" => [],
+                  "collection_tag" => "MNF",
+                  "cookie_file" => nil },
+              "mofos" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "MF" },
+              "naughty_america" =>
+                { "output_format" => [],
+                  "file_source_format" => [],
+                  "collection_tag" => "NA",
+                  "database" => File.join(generated_files_dir, "naughtyamerica.store") },
+              "nf_busty" =>
+                { "output_format" => [],
+                  "file_source_format" => [],
+                  "collection_tag" => "NF",
+                  "database" => File.join(generated_files_dir, "nf_busty.store") },
+              "reality_kings" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "RK" },
+              "stash" =>
+                { "output_format" => [],
+                  "file_source_format" => [],
+                  "username" => nil,
+                  "password" => nil,
+                  "api_token" => nil,
+                  "collection_tag" => "ST" },
+              "tushy" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "TU" },
+              "tushy_raw" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "TUR" },
+              "twistys" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "TW" },
+              "vixen" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "VX" },
+              "whale_media" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "WH" },
+              "wicked" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "WI" },
+              "x_empire" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "XM" },
+              "zero_tolerance" =>
+                { "output_format" => [], "file_source_format" => [], "collection_tag" => "WI" } }
+        }
+      end
+
+      private
+
+      attr_reader :options, :yaml
+
+      def make_config_hash
+        config_file = read_config_file_or_abort!
+        override_from_file = config_file.deeper_merge(default_config)
+        override_from_options = override_flags_from_options(override_from_file)
+        override_from_options.deeper_merge(override_from_file)
+      end
+
+      def generated_files_dir
+        @generated_files_dir ||=
+          begin
+            dir = File.join(home_dir, ".config", "xxx_rename", "generated")
+            FileUtils.mkpath(dir)
+            File.expand_path(dir)
+          end
+      end
+
+      def save_default_config
+        file = File.join(config_file_lookup_dirs[0], DEFAULT_CONFIG_FILE)
+
+        XxxRename.logger.info "-" * 100
+        XxxRename.logger.info "Config option not passed to app and no config file detected in the current directory."
+        XxxRename.logger.info "Generating a blank configuration file to #{file} This app will now exit."
+        XxxRename.logger.info "Check the contents of the file and run the app again to start downloading."
+        XxxRename.logger.info "-" * 100
+
+        raise Errors::FatalError, "config file already exists" if valid_file?(file)
+
+        File.open(file, "w") do |f|
+          f.write default_config.to_yaml
+        end
+      end
+
+      # Step 2: Get the configuration hash from the config file, if present
+      # This method will raise an error if no config file is present,
+      # which is intentional, to allow users to create a config file automatically
+      def read_config_file_or_abort!
+        return read_yaml!(options["config"], nil) if options["config"]
+
+        config_file_lookup_dirs.each do |dir|
+          file = File.join(dir, DEFAULT_CONFIG_FILE)
+          next unless valid_file?(file)
+
+          contents = read_yaml!(file, nil) || {}
+          return contents
+        end
+
+        save_default_config
+        raise XxxRename::Errors::SafeExit, "DEFAULT_FILE_GENERATION"
+      end
+
+      # Step 3: Override any configuration with the options passed to the CLI
+      def override_flags_from_options(config)
+        {}.tap do |h|
+          h["override_site"] = options["override_site"] if options["override_site"]
+          h["global"] = config["global"].merge(**overridden_globals(config["global"]))
+          h["force_refresh_datastore"] = options["force_refresh_datastore"] || false
+          h["actions"] = options["actions"] || []
+          h["force_refresh"] = options["force_refresh"] || false
+        end
+      end
+
+      def overridden_globals(hash)
+        {
+          "female_actors_prefix" => override_value(hash["female_actors_prefix"], options["female_actors_prefix"]),
+          "male_actors_prefix" => override_value(hash["male_actors_prefix"], options["male_actors_prefix"]),
+          "actors_prefix" => override_value(hash["actors_prefix"], options["actors_prefix"]),
+          "title_prefix" => override_value(hash["title_prefix"], options["title_prefix"]),
+          "id_prefix" => override_value(hash["id_prefix"], options["id_prefix"]),
+          "collection_prefix" => override_value(hash["collection_prefix"], options["collection_prefix"])
+        }.compact
+      end
+
+      def validate_download_filters!(hash)
+        contract = Contract::ConfigContract.new(filename_generator: FilenameGenerator).call(hash)
+        raise XxxRename::Errors::ConfigValidationError, contract.errors unless contract.errors.empty?
+
+        contract.to_h.transform_keys(&:to_s)
+      end
+
+      def override_value(original, override)
+        override.nil? ? original : override
+      end
+    end
+  end
+end