xxx_rename 0.0.1

data/lib/xxx_rename/contract/file_rename_op_contract.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module XxxRename
+  module Contract
+    class FileRenameOpValidationFailure < StandardError
+      # @param [Hash] errors
+      def initialize(errors)
+        @errors = errors
+        super(message)
+      end
+
+      def message
+        ers = []
+        @errors.each_pair { |code, value| ers << "#{code}: #{value.join(" ")}" }
+        ers.join(", ")
+      end
+    end
+
+    class FileRenameOpContract < Dry::Validation::Contract
+      include FileUtilities
+
+      schema do
+        required(:key).value(:string)
+        required(:directory).value(:string)
+        required(:source_filename).filled(:string)
+        required(:output_filename).filled(:string)
+        required(:mtime).maybe(Types::Time)
+      end
+
+      rule(:directory) do
+        key(:directory_not_exists).failure(value) unless valid_dir?(value)
+        key(:non_absolute_path).failure(value) unless Pathname.new(value).absolute?
+      end
+
+      rule(:directory, :source_filename) do
+        unless rule_error?(:directory_not_exists)
+          path = File.join(values[:directory], values[:source_filename])
+          key(:file_not_found).failure(path) unless valid_file?(path)
+        end
+      end
+
+      rule(:output_filename) do
+        key(:output_filename_too_long).failure(value) if value.length > MAX_FILENAME_LEN
+      end
+
+      rule(:directory, :output_filename) do
+        unless rule_error?(:directory_not_exists)
+          path = File.join(values[:directory], values[:output_filename])
+          key(:output_file_already_exists).failure(path) if valid_file?(path)
+        end
+      end
+    end
+  end
+end

data/lib/xxx_rename/contract/types.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module XxxRename
+  module Contract
+    module Types
+      include Dry.Types()
+      SanitizedString = Types::String.constructor(&:strip)
+    end
+  end
+end

data/lib/xxx_rename/core_extensions/string.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module XxxRename
+  module CoreExtensions
+    module String
+      # Remove the following characters from the input string and returns
+      # it in lower case
+      #
+      # \s : whitespace characters
+      # \W : any non-word character
+      # _  : underscore
+      #
+      # @return [String]
+      def normalize
+        gsub(/[\s\W_]/, "").downcase
+      end
+
+      # @return [String]
+      def titleize_custom
+        re = /([A-Z]\d[A-Z]|[A-Z][a-zA-Z])/
+        res = []
+        scan(re) { |_| res << Regexp.last_match.offset(0)[0] }
+        res.reverse.each { |index| insert(index, " ") }
+        strip
+      end
+
+      # Remove any characters not included in the following list
+      # \w [a-zA-Z0-9_].
+      # \s Whitespace character
+      # - hyphen
+      # , comma
+      # [ brackets
+      # ] brackets
+      def remove_special_characters
+        gsub(/[^\w\s\-,\[\]']/, "").gsub(/\s{2,}/, " ")
+      end
+    end
+  end
+end

data/lib/xxx_rename/data/base.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module XxxRename
+  module Data
+    class Base < Dry::Struct
+      transform_keys(&:to_sym)
+
+      # resolve default types on nil
+      # https://dry-rb.org/gems/dry-struct/1.0/recipes/#resolving-default-values-on-code-nil-code
+      transform_types do |type|
+        if type.default?
+          type.constructor do |value|
+            value.nil? ? Dry::Types::Undefined : value
+          end
+        else
+          type
+        end
+      end
+
+      # Until there's an easier way to convert a hash keys to string
+      # without using any external library, the performance penalty
+      # that comes from using `JSON.parse(hash.to_json)` is the
+      # better alternative to adding more dependencies to this project
+      def to_h(stringify_keys: false)
+        if stringify_keys
+          hash = super()
+          JSON.parse(hash.to_json)
+        else
+          super()
+        end
+      end
+    end
+  end
+end

data/lib/xxx_rename/data/config.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "xxx_rename/data/scene_datastore"
+
+module XxxRename
+  module Data
+    class Config < Base
+      attribute :global do
+        attribute :female_actors_prefix,  Types::String
+        attribute :male_actors_prefix,    Types::String
+        attribute :actors_prefix,         Types::String
+        attribute :title_prefix,          Types::String
+        attribute :id_prefix,             Types::String
+        attribute :output_format,         Types::Array.of(Types::String)
+      end
+
+      attribute :site do
+        attribute? :adult_time,            Data::AdultTimeConfig
+        attribute? :babes,                 Data::MgPremiumConfig
+        attribute? :blacked,               Data::VixenMediaConfig
+        attribute? :blacked_raw,           Data::VixenMediaConfig
+        attribute? :brazzers,              Data::MgPremiumConfig
+        attribute? :digital_playground,    Data::MgPremiumConfig
+        attribute? :elegant_angel,         Data::ElegantAngelConfig
+        attribute? :evil_angel,            Data::EvilAngelConfig
+        attribute? :goodporn,              Data::GoodpornConfig
+        attribute? :jules_jordan,          Data::JulesJordanMediaConfig
+        attribute? :manuel_ferrara,        Data::JulesJordanMediaConfig
+        attribute? :mofos,                 Data::MgPremiumConfig
+        attribute? :naughty_america,       Data::NaughtyAmericaConfig
+        attribute? :nf_busty,              Data::NfBustyConfig
+        attribute? :reality_kings,         Data::MgPremiumConfig
+        attribute? :stash,                 Data::StashDBConfig
+        attribute? :tushy,                 Data::VixenMediaConfig
+        attribute? :tushy_raw,             Data::VixenMediaConfig
+        attribute? :twistys,               Data::MgPremiumConfig
+        attribute? :vixen,                 Data::VixenMediaConfig
+        attribute? :whale_media,           Data::WhaleMediaConfig
+        attribute? :wicked,                Data::WickedConfig
+        attribute? :x_empire,              Data::XEmpireConfig
+        attribute? :zero_tolerance,        Data::ZeroToleranceConfig
+      end
+
+      attribute :stash_app do
+        attribute :url,                   Types::String.optional
+        attribute :api_token,             Types::String.optional
+      end
+
+      attribute :generated_files_dir,     Types::String
+      # CLI Flags
+      attribute :force_refresh_datastore, Types::Bool
+      attribute :force_refresh,           Types::Bool
+      attribute :actions,                 Types::Array.of(Types::String)
+      attribute? :override_site,          Types::String
+
+      def prefix_hash
+        {
+          female_actors_prefix: global.female_actors_prefix,
+          male_actors_prefix: global.male_actors_prefix,
+          actors_prefix: global.actors_prefix,
+          title_prefix: global.title_prefix,
+          id_prefix: global.id_prefix
+        }
+      end
+
+      def collection_tag_to_site_client
+        @collection_tag_to_site_client ||= {}.tap do |h|
+          site.attributes.each_pair do |site_name, site_config|
+            h[site_config.collection_tag] = site_name
+          end
+        end
+      end
+
+      def mutex
+        @mutex ||= Mutex.new
+      end
+
+      def scene_datastore
+        @scene_datastore ||=
+          begin
+            store = Data::SceneDatastore.new(File.join(generated_files_dir, "..")).store
+            SceneDatastoreQuery.new(store, mutex)
+          end
+      end
+
+      def output_recorder
+        @output_recorder ||=
+          begin
+            store = Data::OutputDatastore.new(generated_files_dir).store
+            datastore = Data::FileRenameOpDatastore.new(store, mutex)
+            datastore.migration_status = 0
+            datastore
+          end
+      end
+    end
+  end
+end

data/lib/xxx_rename/data/file_rename_op.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "xxx_rename/file_utilities"
+
+module XxxRename
+  module Data
+    class FileRenameOp < Base
+      include FileUtilities
+
+      attribute :key, Types::String
+      attribute :directory, Types::String
+      attribute :source_filename, Types::String
+      attribute :output_filename, Types::String
+      attribute :mtime, Types::Time.optional
+
+      def rename
+        Dir.chdir(directory) do
+          File.rename(source_filename, output_filename)
+
+          # This has been deprecated in favour of storing timestamps in filename
+          # File.utime(File.atime(output_filename), mtime, output_filename) if mtime
+
+          XxxRename.logger.info "[RENAME COMPLETE]".colorize(:blue)
+          XxxRename.logger.info "\t#{"WAS:".colorize(:light_magenta)} #{source_filename}"
+          XxxRename.logger.info "\t#{"NOW:".colorize(:green)} #{output_filename}"
+          true
+        end
+      end
+
+      def reverse_rename
+        Dir.chdir(directory) do
+          File.rename(output_filename, source_filename)
+
+          XxxRename.logger.info "[RENAME ROLLBACK COMPLETE]".colorize(:blue)
+          XxxRename.logger.info "\t#{"WAS:".colorize(:light_magenta)} #{output_filename}"
+          XxxRename.logger.info "\t#{"NOW:".colorize(:green)} #{source_filename}"
+          true
+        end
+      end
+    end
+  end
+end

data/lib/xxx_rename/data/file_rename_op_datastore.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "yaml/store"
+
+require "xxx_rename/data/query_interface"
+require "xxx_rename/contract/file_rename_op_contract"
+require "xxx_rename/data/file_rename_op"
+
+module XxxRename
+  module Data
+    OUTPUT_KEY = "___RENAME_ACTIONS___"
+    STATUS_KEY = "___MIGRATION_STATUS___"
+    FAILURES_KEY = "___FAILURES___"
+
+    class OutputDatastore
+      attr_reader :store
+
+      OUTPUT = "output"
+
+      def initialize(dir)
+        file = "#{OUTPUT}_#{Time.now.strftime("%Y%m%d%H%M")}.yml"
+
+        Dir.chdir(dir) { FileUtils.mkdir OUTPUT unless Dir.exist?(OUTPUT) }
+
+        path = File.join(dir, OUTPUT, file)
+        @store = YAML::Store.new path
+        XxxRename.logger.info "Output will be recorded in #{file}"
+      end
+    end
+
+    class FileRenameOpDatastore < QueryInterface
+      def create!(scene_data, source_file, output_file, dir = Dir.pwd)
+        hash = {
+          key: scene_data.key,
+          directory: dir,
+          source_filename: source_file,
+          output_filename: output_file,
+          mtime: scene_data.date_released
+        }
+        data = make_file_rename_op!(hash)
+        semaphore.synchronize do
+          store.transaction do
+            store[OUTPUT_KEY] ||= []
+            store[OUTPUT_KEY] << data
+          end
+        end
+      end
+
+      def length
+        semaphore.synchronize do
+          store.transaction(true) do
+            store.fetch(OUTPUT_KEY, []).length
+          end
+        end
+      end
+
+      def all
+        semaphore.synchronize do
+          store.transaction(true) do
+            store.fetch(OUTPUT_KEY, [])
+          end
+        end
+      end
+
+      def failures
+        semaphore.synchronize do
+          store.transaction(true) do
+            store.fetch(FAILURES_KEY, {})
+          end
+        end
+      end
+
+      def add_failure(key, error)
+        semaphore.synchronize do
+          store.transaction do
+            store[FAILURES_KEY] ||= {}
+            store[FAILURES_KEY][key] = error
+          end
+        end
+      end
+
+      def migration_status
+        semaphore.synchronize do
+          store.transaction(true) do
+            val = store.fetch(STATUS_KEY, 0)
+            val == 1
+          end
+        end
+      end
+
+      def migration_status=(status)
+        semaphore.synchronize do
+          store.transaction do
+            store[STATUS_KEY] = status
+          end
+        end
+      end
+
+      private
+
+      def make_file_rename_op!(hash)
+        contract = Contract::FileRenameOpContract.new.call(hash)
+
+        raise Contract::FileRenameOpValidationFailure, contract.errors.to_h unless contract.errors.empty?
+
+        valid_hash = contract.to_h.transform_keys(&:to_s)
+        FileRenameOp.new(valid_hash)
+      end
+    end
+  end
+end

data/lib/xxx_rename/data/naughty_america_database.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "pstore"
+
+module XxxRename
+  module Data
+    class NaughtyAmericaDatabase
+      attr_reader :store
+
+      DEFAULT_STORE_FILE = "naughtyamerica.store"
+
+      def initialize(store_file)
+        store_file = DEFAULT_STORE_FILE if store_file.nil?
+
+        path = File.join(Dir.pwd, store_file)
+        XxxRename.logger.info "Initialising database in #{path}"
+
+        @store = PStore.new path
+      end
+    end
+  end
+end

data/lib/xxx_rename/data/query_interface.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module XxxRename
+  module Data
+    class QueryError < StandardError
+      def initialize(scene_data)
+        @scene_data = scene_data
+        super(message)
+      end
+    end
+
+    class UniqueRecordViolation < QueryError
+      def message
+        "Scene already present in database: #{@scene_data.inspect}"
+      end
+    end
+
+    class RecordNotFound < QueryError
+      def message
+        "Scene not saved in database #{@scene_data.inspect}"
+      end
+    end
+
+    class QueryInterface
+      # @param [PStore] store
+      # @param [Mutex] semaphore
+      def initialize(store, semaphore)
+        @store = store
+        @semaphore = semaphore
+      end
+
+      def find(*)
+        raise "Not Implemented"
+      end
+
+      def create!(*)
+        raise "Not Implemented"
+      end
+
+      def upsert(*)
+        raise "Not Implemented"
+      end
+
+      def destroy!(*)
+        raise "Not Implemented"
+      end
+
+      def count(*)
+        raise "Not Implemented"
+      end
+
+      def metadata(*)
+        raise "Not Implemented"
+      end
+
+      def update_metadata(*)
+        raise "Not Implemented"
+      end
+
+      # @param [Array[String|Integer]] strs
+      def generate_lookup_key(*strs)
+        strs.map(&:to_s).map { |x| sanitize(x) }.join("$")
+      end
+
+      attr_reader :store
+
+      private
+
+      attr_reader :semaphore
+
+      # @param [String] str
+      # @return [String]
+      def sanitize(str)
+        str.to_s.normalize
+      end
+    end
+  end
+end

data/lib/xxx_rename/data/scene_data.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "digest/md5"
+
+module XxxRename
+  module Data
+    class SceneData < Base
+      attribute :female_actors, Types::Array.of(Types::String).default([].freeze)
+      attribute :male_actors, Types::Array.of(Types::String).default([].freeze)
+      attribute :actors, Types::Array.of(Types::String)
+      attribute :collection, Types::String.default("")
+      attribute :collection_tag, Types::String.default("")
+      attribute :title, Types::String
+      attribute? :id, Types::Coercible::String.optional
+      attribute? :date_released, Types::Time.optional
+      attribute :scene_link, Types::String.default("")
+      attribute :original_filenames, Types::Set.default(Set.new.freeze)
+      attribute? :movie do
+        attribute :name, Types::String
+        attribute? :date, Types::Time
+        attribute? :url, Types::String
+        attribute :front_image, Types::String
+        attribute? :back_image, Types::String
+        attribute? :studio, Types::String
+        attribute? :synopsis, Types::String
+      end
+
+      def yyyy_mm_dd
+        date_released&.strftime("%Y_%m_%d")
+      end
+
+      def day
+        d = date_released&.day.to_s
+        return if d.empty?
+
+        d.length == 1 ? "0#{d}" : d
+      end
+      alias dd day
+
+      def month
+        m = date_released&.month.to_s
+        return if m.empty?
+
+        m.length == 1 ? "0#{m}" : m
+      end
+      alias mm month
+
+      def year
+        date_released&.year&.to_s
+      end
+      alias yyyy year
+
+      #
+      # Takes a scene information and uses as much information
+      # as possible to generate a unique key to minimize the
+      # chances of key collision
+      #
+      # @return [String]
+      def key
+        @key ||=
+          begin
+            str = "<#{title.normalize}" \
+              "$#{collection.to_s.normalize}" \
+              "$#{actors.join("-").normalize}" \
+              ">"
+            Digest::MD5.hexdigest(str)
+          end
+      end
+    end
+  end
+end