xxx_rename 0.0.1

data/bin/console

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require_relative "../lib/xxx_rename"
+
+def reload!(print: true)
+  puts "Reloading ..." if print
+  # Main project directory.
+  root_dir = File.expand_path("..", __dir__)
+  # Directories within the project that should be reloaded.
+  reload_dirs = %w[lib]
+  # Loop through and reload every file in all relevant project directories.
+  reload_dirs.each do |dir|
+    Dir.glob("#{root_dir}/#{dir}/**/*.rb").each { |f| load(f) }
+  end
+  # Return true when complete.
+  true
+end
+
+require "irb"
+
+IRB.start(__FILE__)

data/bin/install

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# check if ruby is installed and version is above 2.7
+if [ -x "$(command -v ruby)" ]; then
+  ruby_version=$(ruby -v | awk '{print $2}')
+  if [ "$(echo $ruby_version | cut -d '.' -f 1)" -ge 2 ] && [ "$(echo $ruby_version | cut -d '.' -f 2)" -ge 7 ]; then
+    echo "Uninstalling any previously installed versions"
+    gem uninstall -a -x xxx_rename
+    echo "Building gem"
+    rake build
+    gem_path=$(ls -t ./pkg/*.gem | head -1)
+    echo "Installing xxx_rename"
+    gem install --local $gem_path
+    echo "Done"
+  else
+    echo "Ruby version is $ruby_version, please upgrade to 2.7 or higher"
+    exit 1
+  fi
+else
+  echo "Ruby is not installed, please install ruby 2.7 or higher"
+  exit 1
+fi

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+  set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/codecov.yml

@@ -0,0 +1,2 @@
+ignore:
+  - "spec/**/*"

data/docs/DEVELOPMENT.md

@@ -0,0 +1,42 @@
+# Building from Source
+
+## Pre-requisites
+
+The CLI is written entirely in [Ruby](https://www.ruby-lang.org/en/). The
+supported version is 2.7.
+
+You can also choose to use any env managers like
+[rbenv](https://github.com/rbenv/rbenv), [rvm](https://rvm.io/),
+[asdf](https://asdf-vm.com/), [chruby](https://github.com/postmodern/chruby),
+etc.
+
+To clone the repository, follow the steps below:
+
+```bash
+brew install ruby@2.7 # Install ruby (This only works for MacOS/Linux)
+git clone https://github.com/c477y/xxx_rename.git
+cd xxx_rename
+```
+
+## Environment
+
+I cannot vouch for Windows, as this CLI is tested to work on Linux and MacOS,
+but the test coverage should allow you to test for any errors.
+
+## Build
+
+Run the setup script to build the gem and its dependencies.
+
+```bash
+./bin/setup
+```
+
+To install the gem to your local machine.
+
+```bash
+./bin/install
+```
+
+## Run tests
+
+Run the `rake` command to run the tests and lint the project using Rubocop.

data/exe/xxx_rename

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+$pwd = Dir.pwd  # rubocop:disable Style/GlobalVars
+
+require "thor"
+require "xxx_rename"
+
+XxxRename::Cli.start ARGV

data/lib/xxx_rename/actions/base_action.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module XxxRename
+  module Actions
+    class BaseAction
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      # @param [String] _dir
+      # @param [String] _file
+      # @param [XxxRename::Search::SearchResult] _search_result
+      def perform(_dir, _file, _search_result)
+        raise "Not Implemented"
+      end
+    end
+  end
+end

data/lib/xxx_rename/actions/log_new_filename.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "xxx_rename/actions/base_action"
+
+module XxxRename
+  module Actions
+    class LogNewFilename < BaseAction
+      def perform(_dir, file, search_result)
+        new_filename = FilenameGenerator.generate_with_multi_formats!(
+          search_result.scene_data,
+          File.extname(file),
+          config.prefix_hash,
+          *output_patterns(search_result.site_client)
+        )
+
+        XxxRename.logger.info "[RENAME OPERATION]".colorize(:blue)
+        XxxRename.logger.info "\t#{"ORIGINAL:".colorize(:light_magenta)} #{file}"
+        XxxRename.logger.info "\t#{"NEW:     ".colorize(:green)} #{new_filename}"
+
+        config.output_recorder.create!(search_result.scene_data, file, new_filename, Dir.pwd)
+      rescue FilenameGenerationError => e
+        XxxRename.logger.error "#{"[RENAME OPERATION ERROR]".colorize(:red)} #{e.message}"
+        nil
+      rescue Contract::FileRenameOpValidationFailure => e
+        XxxRename.logger.error "[RENAME OPERATION VALIDATION ERROR] #{e.message}"
+        nil
+      end
+
+      #
+      # Return a list of patterns that will be used to generate the new filename
+      # Individual site client formats take precedence over global formats
+      #
+      # @param [XxxRename::SiteClients::Base] site_client
+      # @return [Array[String]]
+      def output_patterns(site_client)
+        site_client.site_config.output_format.push(*config.global.output_format)
+      end
+    end
+  end
+end

data/lib/xxx_rename/actions/resolver.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "xxx_rename/actions/log_new_filename"
+require "xxx_rename/actions/stash_app_post_movie"
+
+module XxxRename
+  module Actions
+    class Resolver
+      def initialize(config)
+        @config = config
+      end
+
+      def resolve!(action)
+        action = action.to_sym
+        case action
+        when :sync_to_stash
+          actions_klass_hash.fetch(action, StashAppPostMovie.new(@config))
+        when :log_rename_op
+          actions_klass_hash.fetch(action, LogNewFilename.new(@config))
+        else
+          raise Errors::FatalError, "Unknown action #{action}"
+        end
+      end
+
+      private
+
+      def actions_klass_hash
+        @actions_klass_hash ||= {}
+      end
+    end
+  end
+end

data/lib/xxx_rename/actions/stash_app_post_movie.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "xxx_rename/actions/base_action"
+require "xxx_rename/integrations/stash_app"
+
+module XxxRename
+  module Actions
+    class StashAppPostMovie < BaseAction
+      attr_reader :stash, :config
+
+      def initialize(config)
+        super(config)
+        @stash = Integrations::StashApp.new(config)
+        @stash.setup_credentials!
+      end
+
+      def perform(dir, file, search_result)
+        scene_data = search_result.scene_data
+        return if scene_data.movie.nil?
+
+        post_movie!(dir, file, scene_data)
+      rescue XxxRename::Integrations::StashAPIError => e
+        XxxRename.logger.error e.message
+      end
+
+      private
+
+      def post_movie!(_dir, file, scene_data)
+        scene = stash.fetch_scene(file)
+        if scene.nil?
+          XxxRename.logger.warn "[FILE MISSING ON STASH] #{file}"
+          return
+        end
+
+        if scene["movies"].find { |x| x.dig("movie", "name") == scene_data.movie.name }
+          XxxRename.logger.info "#{"[STASH APP MOVIE NOT UPDATED]".colorize(:yellow)} #{file}"
+          return
+        end
+
+        studio_id = studio_id(scene_data.movie.studio)
+        XxxRename.logger.warn "#{"[NO STUDIO ON STASH]".colorize(:light_red)} #{scene_data.movie.studio}" if studio_id.nil?
+
+        existing_movie = stash.fetch_movie(scene_data.movie.name)
+        if existing_movie.nil?
+          XxxRename.logger.info "#{"[STASH MOVIE CREATE]".colorize(:green)} #{scene_data.movie.name}"
+          movie = stash.create_movie(scene_data, studio_id)
+          stash.update_scene(scene["id"], movie["id"])
+        else
+          XxxRename.logger.info "#{"[STASH MOVIE ASSIGN]".colorize(:green)} #{scene_data.movie.name}"
+          stash.update_scene(scene["id"], existing_movie["id"])
+        end
+      rescue SocketError => e
+        XxxRename.logger.error "#{"[SOCKET ERROR #post_movie!]".colorize(:red)} #{e.message}"
+        nil
+      end
+
+      def studio_id(name)
+        stash.fetch_studio(name)&.[]("id")
+      end
+    end
+  end
+end

data/lib/xxx_rename/actors_helper.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module XxxRename
+  class ActorsHelper
+    include Singleton
+
+    def matcher(matcher = nil)
+      raise Errors::FatalError, "#{self.class.name} initialised without matcher" if @matcher.nil? && matcher.nil?
+
+      @matcher ||= matcher
+    end
+
+    def female_actors
+      @female_actors ||= {}
+    end
+
+    def male_actors
+      @male_actors ||= {}
+    end
+
+    def append_female(actor_hash)
+      female_actors[actor_hash["compressed_name"]] = actor_hash["name"] if female_actors[actor_hash["compressed_name"]].nil?
+    end
+
+    def append_male(actor_hash)
+      male_actors[actor_hash["compressed_name"]] = actor_hash["name"] if male_actors[actor_hash["compressed_name"]].nil?
+    end
+
+    def male?(actor)
+      processed!(actor)
+      male_actors.key? actor.normalize
+    rescue Errors::UnprocessedEntity
+      false
+    end
+
+    def female?(actor)
+      processed!(actor)
+      female_actors.key? actor.normalize
+    rescue Errors::UnprocessedEntity
+      false
+    end
+
+    def processed?(actor)
+      processed!(actor)
+    rescue Errors::UnprocessedEntity
+      false
+    end
+
+    def processed!(actor)
+      return true if female_actors.key?(actor.normalize) || male_actors.key?(actor.normalize)
+
+      raise Errors::UnprocessedEntity, actor
+    end
+
+    def auto_fetch!(actor)
+      details = fetch_actor_details.details(actor)
+
+      raise Errors::UnprocessedEntity, actor if details.nil?
+
+      details["gender"].downcase == "female" ? append_female(details) : append_male(details)
+      nil
+    end
+
+    def auto_fetch(actor)
+      auto_fetch!(actor)
+    rescue Errors::UnprocessedEntity => e
+      XxxRename.logger.warn "Unable to fetch details for #{e.message}"
+      nil
+    end
+
+    private
+
+    def fetch_actor_details
+      @fetch_actor_details ||= FetchActorDetails.new(matcher)
+    end
+  end
+
+  class FetchActorDetails
+    # @param [XxxRename::SiteClientMatcher] matcher
+    def initialize(matcher)
+      @matcher = matcher
+    end
+
+    # @param [String] actor Search string for actor
+    # @return [nil, Hash] Hash of details or nil if not found
+    def details(actor)
+      clients.each do |client|
+        details = client.actor_details(actor)
+        next if details.nil?
+
+        XxxRename.logger.debug "#{client.class.name.split("::").last} matched actor #{actor} as #{details["gender"]}"
+        details.tap do |h|
+          h["compressed_name"] = details["name"].normalize
+          h["gender"]          = details["gender"].normalize
+        end
+        return details
+      end
+      nil
+    end
+
+    private
+
+    attr_reader :matcher
+
+    def clients
+      [
+        matcher.initialise_site_client(:stash),
+        matcher.initialise_site_client(:brazzers),
+        matcher.initialise_site_client(:wicked),
+        matcher.initialise_site_client(:reality_kings),
+        matcher.initialise_site_client(:evil_angel)
+      ].compact
+    end
+  end
+end

data/lib/xxx_rename/cli.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module XxxRename
+  class Cli < Thor
+    SUPPORTED_SITES = %w[
+      adult_time
+      babes
+      blacked
+      blacked_raw
+      brazzers
+      digital_playground
+      elegant_angel
+      evil_angel
+      goodporn
+      jules_jordan
+      manuel_ferrara
+      mofos
+      naughty_america
+      nf_busty
+      reality_kings
+      stash
+      tushy
+      tushy_raw
+      twistys
+      vixen
+      whale_media
+      wicked
+      x_empire
+      zero_tolerance
+    ].freeze
+
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "version", "Print the CLI version"
+    def version
+      require_relative "version"
+      puts "v#{XxxRename::VERSION}"
+    end
+    map %w[--version -v] => :version
+
+    long_desc <<-LONGDESC
+    Scan files and generate metadata
+
+    For first time users, run the command without any flags to generate a config
+    file in $HOME/.config/xxx_rename
+
+    $ xxx_rename generate
+
+    The cli will look for a config file in these three places in order:
+
+    * --config (This takes precedence over everything)
+
+    * $HOME/.config/xxx_rename
+
+    * HOME/xxx_rename
+
+    Examples
+
+    # Scan all files in a given directory and its sub-directories
+
+    $ xxx_rename generate . --nested
+
+    # Force the cli to use `brazzers` to match a file
+
+    $ xxx_rename generate . --verbose --override_site=brazzers
+
+    # Generate a migrations file to rename the matched files
+
+    $ xxx_rename generate . --actions=log_rename_op
+    LONGDESC
+    desc "generate FILE|FOLDER", "Rename a file or all file(s) inside a given directory"
+    option :config,        alias: :c, type: :string,  required: false, desc: "path to config file"
+    option :verbose,       alias: :v, type: :boolean, default:  false, desc: "enable verbose logging"
+    option :override_site, alias: :s, type: :string,  required: false, desc: "force use an override site",
+                           enum: SUPPORTED_SITES
+    option :nested,                   type: :boolean, default:  false, desc: "recursively search for all files in the given directory"
+    option :force_refresh_datastore,  type: :boolean, default:  false, desc: "force site client to fetch all scenes, if implemented"
+    option :actions,       alias: :a, type: :string,  default:  [],    desc: "action to perform on a successful match",
+                           enum: %w[sync_to_stash log_rename_op], repeatable: true
+    option :force_refresh,            type: :boolean, default:  false, desc: "force match scenes from original sites"
+    option :checkpoint,               type: :string,  required: false, desc: "skip all iterations until check-pointed file is matched"
+    def generate(object)
+      XxxRename.logger(verbose: options["verbose"])
+      config = Contract::ConfigGenerator.new(options).generate!
+      client = Client.new(config,
+                          verbose: options["verbose"],
+                          override_site: options["override_site"]&.to_sym,
+                          nested: options["nested"],
+                          checkpoint: options["checkpoint"])
+      client.generate(object)
+    rescue Interrupt
+      print "Exiting...\n".colorize(:green)
+    rescue Errors::FatalError => e
+      XxxRename.logger.fatal "#{e.class} #{e.message}".colorize(:red)
+      e.backtrace&.each { |x| XxxRename.logger.debug x }
+      exit 1
+    rescue StandardError => e
+      XxxRename.logger.fatal "CLI ran into an unexpected error. Report this on https://github.com/c477y/xxx_rename/issues/new"
+      XxxRename.logger.fatal "#{e.class} #{e.message}".colorize(:red)
+      e.backtrace&.each { |x| XxxRename.logger.fatal x }
+      exit 1
+    end
+
+    long_desc <<~LONGDESC
+      WARNING: This is a destructive operation as it will rename files
+      Run this on a small subset to be sure and run it at your own risk
+
+      Rename files based on operations listed in a migration file.
+
+      All rename files are located in your `generated_files_dir` directory.
+      Migration files are plain YAML files of format 'output_YYYYMMDDHHMM.yml'
+
+      Pass a migration file using option --version YYYYMMDDHHMM
+      If you want to apply a migration file that you have just created,
+        pass the --version as "latest". Or don't pass the --version
+        flag and the CLI will use the latest version by default.
+
+      Migration files have the following format:
+
+      ---
+      # 0 means the migration is not applied
+
+      # 1 means the migration is applied
+
+      # This flag prevents applying a migration that has already been applied
+
+      ___MIGRATION_STATUS___: 0
+
+      # All operations are stored as an array
+
+      ___RENAME_ACTIONS___:
+
+      # DO NOT MANIPULATE AN ARRAY ITEM! Doing so can result in unexpected
+
+      # behaviour. You can remove an operation from the list entirely, but
+
+      # the recommended way is to discard this migration completely,
+
+      # modify the `output_format` for your file in the config and run the
+
+      # generate command again
+
+      - !ruby/object:XxxRename::Data::FileRenameOp
+
+        attributes:
+
+          :key: eab204175567d39202c1df5895e443be # DO NOT MODIFY THIS#{" "}
+
+          :directory: "/ABSOLUTE/DIRECTORY/TOFILE"
+
+          :source_filename: ORIGINAL_FILENAME.MP4
+
+          :output_filename: NEW_FILENAME.MP4
+
+          :mtime: 2000-01-01 00:00:00.000000000 +00:00
+
+      Example Usage:
+
+      $ xxx_rename migrate --version=202301131252
+
+      $ xxx_rename migrate
+    LONGDESC
+    desc "migrate --version=VERSION", "Apply a rename migration file"
+    option :config, alias: :c, type: :string, required: false, desc: "path to config file"
+    option :version, type: :string, default: "latest", desc: "Name of migration file to apply"
+    def migrate
+      config = Contract::ConfigGenerator.new(options.slice("config")).generate!
+      MigrationClient.new(config, options["version"]).apply
+    rescue Interrupt
+      print "Exiting...\n".colorize(:green)
+    rescue Errors::FatalError => e
+      XxxRename.logger.fatal "#{e.class} #{e.message}".colorize(:red)
+      e.backtrace&.each { |x| XxxRename.logger.debug x }
+      exit 1
+    rescue StandardError => e
+      XxxRename.logger.fatal "CLI ran into an unexpected error. Report this on https://github.com/c477y/xxx_rename/issues/new"
+      XxxRename.logger.fatal "#{e.class} #{e.message}".colorize(:red)
+      e.backtrace&.each { |x| XxxRename.logger.fatal x }
+      exit 1
+    end
+
+    long_desc <<-LONGDESC
+    Reverse the actions taken by the `migrate` command
+
+    Read the help command for more information
+    $ xxx_rename help migrate
+    LONGDESC
+    desc "rollback --version=VERSION", "Rollback a migration"
+    option :config, alias: :c, type: :string, required: false, desc: "path to config file"
+    option :version, type: :string, default: "latest", desc: "Name of migration file to apply"
+    def rollback
+      config = Contract::ConfigGenerator.new(options.slice("config")).generate!
+      MigrationClient.new(config, options["version"]).rollback
+    rescue Interrupt
+      print "Exiting...\n".colorize(:green)
+    rescue Errors::FatalError => e
+      XxxRename.logger.fatal "#{e.class} #{e.message}".colorize(:red)
+      e.backtrace&.each { |x| XxxRename.logger.debug x }
+      exit 1
+    rescue StandardError => e
+      XxxRename.logger.fatal "CLI ran into an unexpected error. Report this on https://github.com/c477y/xxx_rename/issues/new"
+      XxxRename.logger.fatal "#{e.class} #{e.message}".colorize(:red)
+      e.backtrace&.each { |x| XxxRename.logger.fatal x }
+      exit 1
+    end
+  end
+end