Source attributes in output template (#45)

* Updated download options to take a media item; allowed for specifying custom output path template options

* Fixed bug where indexing job wouldn't run for the first time

* Renamed friendly_name to custom_name

* Added new options to default template and UI

* Improved explainer UI

lib/pinchflat/profiles/media_profile.ex

@@ -29,7 +29,8 @@ defmodule Pinchflat.Profiles.MediaProfile do
   schema "media_profiles" do
     field :name, :string
 
-    field :output_path_template, :string, default: "/{{ channel }}/{{ title }}/{{ title }} [{{ id }}].{{ ext }}"
+    field :output_path_template, :string,
+      default: "/{{ source_custom_name }}/{{ title }}/{{ title }} [{{ id }}].{{ ext }}"
 
     field :download_subs, :boolean, default: true
     field :download_auto_subs, :boolean, default: true

lib/pinchflat/profiles/options/yt_dlp/download_option_builder.ex

@@ -5,21 +5,17 @@ defmodule Pinchflat.Profiles.Options.YtDlp.DownloadOptionBuilder do
   IDEA: consider making this a behaviour so I can add other backends later
   """
 
-  alias Pinchflat.Profiles.MediaProfile
+  alias Pinchflat.Media.MediaItem
   alias Pinchflat.Profiles.Options.YtDlp.OutputPathBuilder
 
   @doc """
-  Builds the options for yt-dlp to download media based on the given media profile.
+  Builds the options for yt-dlp to download media based on the given media's profile.
 
   IDEA: consider adding the ability to pass in a second argument to override
         these options
   """
-  def build(%MediaProfile{} = media_profile) do
-    # NOTE: I'll be hardcoding most things for now (esp. options to help me test) -
-    # add more configuration later as I build out the models. Walk before you can run!
-
-    # NOTE: Looks like you can put different media types in different directories.
-    # see: https://github.com/yt-dlp/yt-dlp#output-template
+  def build(%MediaItem{} = media_item_with_preloads) do
+    media_profile = media_item_with_preloads.source.media_profile
 
     built_options =
       default_options() ++
@@ -27,12 +23,11 @@ defmodule Pinchflat.Profiles.Options.YtDlp.DownloadOptionBuilder do
         thumbnail_options(media_profile) ++
         metadata_options(media_profile) ++
         quality_options(media_profile) ++
-        output_options(media_profile)
+        output_options(media_item_with_preloads)
 
     {:ok, built_options}
   end
 
-  # This will be updated a lot as I add new options to profiles
   defp default_options do
     [:no_progress, :windows_filenames]
   end
@@ -101,14 +96,25 @@ defmodule Pinchflat.Profiles.Options.YtDlp.DownloadOptionBuilder do
     end
   end
 
-  defp output_options(media_profile) do
-    {:ok, output_path} = OutputPathBuilder.build(media_profile.output_path_template)
+  defp output_options(media_item_with_preloads) do
+    media_profile = media_item_with_preloads.source.media_profile
+    additional_options_map = output_options_map(media_item_with_preloads)
+    {:ok, output_path} = OutputPathBuilder.build(media_profile.output_path_template, additional_options_map)
 
     [
       output: Path.join(base_directory(), output_path)
     ]
   end
 
+  defp output_options_map(media_item_with_preloads) do
+    source = media_item_with_preloads.source
+
+    %{
+      "source_custom_name" => source.custom_name,
+      "source_collection_type" => source.collection_type
+    }
+  end
+
   defp base_directory do
     Application.get_env(:pinchflat, :media_directory)
   end

lib/pinchflat/profiles/options/yt_dlp/output_path_builder.ex

@@ -8,13 +8,16 @@ defmodule Pinchflat.Profiles.Options.YtDlp.OutputPathBuilder do
   alias Pinchflat.RenderedString.Parser, as: TemplateParser
 
   @doc """
-  Builds the actual final filepath from a given template.
+  Builds the actual final filepath from a given template. Optionally, you can pass in
+  a map of additional options to be used in the template.
 
   Translates liquid-style templates into yt-dlp-style templates,
   leaving yt-dlp syntax intact.
   """
-  def build(template_string) do
-    TemplateParser.parse(template_string, custom_yt_dlp_option_map(), &identifier_fn/2)
+  def build(template_string, additional_template_options \\ %{}) do
+    combined_options = Map.merge(custom_yt_dlp_option_map(), additional_template_options)
+
+    TemplateParser.parse(template_string, combined_options, &identifier_fn/2)
   end
 
   # The `nil` case simply wraps the identifier in yt-dlp-style syntax. This assumes that
@@ -30,6 +33,9 @@ defmodule Pinchflat.Profiles.Options.YtDlp.OutputPathBuilder do
     end
   end
 
+  # This isn't the only source for custom options, since they can be passed in my the caller.
+  # `download_option_builder` is the most likely place for other custom options to be added,
+  # but if in doubt just search the codebase for `OutputPathBuilder.build`.
   defp custom_yt_dlp_option_map do
     %{
       # Individual parts of the upload date