plex_symlinker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2451ea81acfe07abdde34f95d0d4f8170254d2caf711b7de8c6350ee42e331ea
+  data.tar.gz: a36385ba8fb204f8d1f1ee742318e9fa1b9eeb8485833b389c6adffe676a03d3
+SHA512:
+  metadata.gz: 314f13fbd52f6923991d91e5637484ab771a5ad9abc4a5bb2a5ceb802c8132ab76dd25414c5ea34927ac6d0ba718520077199032ad801d31e9fb0087411fee01
+  data.tar.gz: 49b3fb4632f59cbef70171e512f589312933bce9ab822b33d12a850ba44673274598addbd86786721633f3f97d57fadbfcf1fa6f78c50a07d0a03ee12a617087

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+ruby_version: 2.6.1
+ignore:
+  - plex_symlinker.gemspec

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+services:
+  - docker
+
+install: bin/ci-build-dev
+script: bin/ci-test
+deploy:
+  provider: script
+  script: bin/ci-build-production
+  on:
+    branch: master

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at stex@sterex.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,18 @@
+FROM ruby:slim
+
+RUN apt-get update && \
+        apt-get install -y libtag1-dev libtag-extras-dev g++ make && \
+        apt-get clean
+
+WORKDIR /app
+
+COPY ./lib/plex_symlinker/version.rb ./lib/plex_symlinker/version.rb
+COPY ./Gemfile* ./
+COPY ./plex_symlinker.gemspec ./
+
+RUN bundle config set deployment 'true'
+RUN bundle install --without=development
+
+COPY ./ ./
+
+CMD bundle exec exe/plex_symlinker /app/source /app/target --symlink-target-dir=${SYMLINK_TARGET_DIR}

data/Dockerfile.dev

@@ -0,0 +1,16 @@
+FROM ruby:slim
+
+RUN apt-get update && \
+        apt-get install -y libtag1-dev libtag-extras-dev g++ make
+
+WORKDIR /app
+
+COPY ./lib/plex_symlinker/version.rb ./lib/plex_symlinker/version.rb
+COPY ./Gemfile* ./
+COPY ./plex_symlinker.gemspec ./
+
+RUN bundle install
+
+COPY ./ ./
+
+CMD bundle exec rake

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in plex_symlinker.gemspec
+gemspec
+
+group :development do
+  gem "rake", "~> 12.0"
+  gem "rspec", "~> 3.0"
+  gem "rspec-its", "~> 1.3"
+  gem "pry", "~> 0.13.1"
+  gem "standard", "~> 0.4"
+end

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    plex_symlinker (0.1.0)
+      activesupport (~> 6.0)
+      ruby-progressbar (~> 1.10)
+      slop (~> 4.8)
+      taglib-ruby (~> 1.0)
+      zeitwerk (~> 2.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.4.4)
+    i18n (1.8.4)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.85.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.6.1)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    slop (4.8.2)
+    standard (0.4.7)
+      rubocop (~> 0.85.0)
+      rubocop-performance (~> 1.6.0)
+    taglib-ruby (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  plex_symlinker!
+  pry (~> 0.13.1)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec-its (~> 1.3)
+  standard (~> 0.4)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Stefan Exner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# PlexSymlinker
+
+This gem allows creating a Plex-friendly folder structure with symlinks for your audio books.  
+All you need are audio files with correct tagging, the gem takes care of making Plex understand them without you having to change the way you're organising your files.
+
+**The Problem**
+
+Most of my audio files are in apple's `m4b` format, leaving me with one file per book most of the times:
+
+    📁 audiobooks
+     ∟ 📁 author name
+        ∟ book1.m4b
+        ∟ book2.m4b
+
+The problem with this structure is that Plex' music agent doesn't quite understand it.  
+Even though the files are properly tagged with author, album, etc., Plex tends to create a giant
+album out of all the files inside - often with the first audio book as album name.
+
+What the Plex music agent expects is a structure like this:
+
+    📁 audiobooks
+     ∟ 📁 author name
+        ∟ 📁 Book 1
+           ∟ book1.m4b
+        ∟ 📁 Book 2
+           ∟ book2.m4b
+
+This would mean that I'd have to introduce single-file-directories into my structure which didn't really make
+sense for me - especially as I have a lot of "Hörspiele" (mostly german format of short audio books with multiple
+actors + music).
+
+**This gem's solution**
+
+`plex_symlinker` creates symlinks pointing to your actual audio files in exactly the structure Plex' music agent
+expects to find. It uses the embedded tags in your files to build it, so even one big directory with
+all your audio files in it would work as expected.
+
+Just point plex to the symlink directory instead of your actual files and you're good to go.
+
+## Installation
+
+There are 2 ways to install/use this gem:
+
+**Option 1: Install the gem on your local machine and run it directly**
+
+```bash
+gem install plex_symlinker
+```
+
+As this gem makes use of `taglib-ruby`, you have to make sure that the necessary packages are installed on your machine.  
+Please refer to [robinst/taglib-ruby](https://github.com/robinst/taglib-ruby#installation) for more information.
+
+**Option 2: Use the docker image**
+
+A [docker image](https://hub.docker.com/r/sterexx/plex_symlinker) is available which includes
+all necessary dependencies and can be used out-of-the-box by mounting the necessary directories.  
+
+## Usage
+
+### Using the gem executable
+
+### Using the Docker image
+
+Please refer to [Docker Hub](https://hub.docker.com/r/sterexx/plex_symlinker) for instructions
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/stex/plex_symlinker. 
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/stex/plex_symlinker/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PlexSymlinker project's codebases, issue trackers, 
+chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/stex/plex_symlinker/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/ci-build-dev

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+docker build -t "$DOCKER_HUB_REPOSITORY"-dev -f Dockerfile.dev .

data/bin/ci-build-production

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -e
+
+echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
+docker build -t "$DOCKER_HUB_REPOSITORY" .
+docker push "$DOCKER_HUB_REPOSITORY":latest

data/bin/ci-test

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+set -e
+
+docker run -t "$DOCKER_HUB_REPOSITORY"-dev bundle exec standardrb
+docker run -t "$DOCKER_HUB_REPOSITORY"-dev bundle exec rake

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "plex_symlinker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/docker-plex_symlinker

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+echo "Creating target directory with current user permissions..."
+mkdir -p $2
+
+echo "Running plex_symlinker in Docker..."
+docker run -it --user "$(id -u):$(id -g)" --rm -v "$1":/app/source:ro -v "$2":/app/target --env SYMLINK_TARGET_DIR="$1" sterexx/plex_symlinker

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/exe/plex_symlinker

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "plex_symlinker"
+require "slop"
+
+opts = Slop.parse { |o|
+  o.string "--symlink-target-dir", "Overrides the base dir in symlink targets"
+  o.string "--log", "Log output path"
+  o.on "--help" do
+    puts o
+    exit
+  end
+}
+
+fail ArgumentError, "Please provide at least source and target directory." if opts.arguments.size != 2
+if opts[:log]
+  PlexSymlinker.output = File.new(opts[:log], "w")
+end
+
+PlexSymlinker::Operation.new(*opts.arguments, symlink_target_dir: opts[:symlink_target_dir]).perform

data/lib/plex_symlinker.rb

@@ -0,0 +1,27 @@
+require "rubygems"
+require "bundler/setup"
+require "active_support/all"
+require "pathname"
+require "ruby-progressbar"
+require "taglib"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+loader.eager_load
+
+module PlexSymlinker
+  class Error < StandardError; end
+
+  def self.output
+    @output ||= STDOUT
+  end
+
+  def self.output=(val)
+    @output = val
+  end
+
+  def self.logger
+    @logger ||= Logger.new(output)
+  end
+end

data/lib/plex_symlinker/file_types/audio_file.rb

@@ -0,0 +1,76 @@
+module PlexSymlinker
+  module FileTypes
+    class AudioFile
+      class << self
+        def registered_types
+          @registered_types ||= {}
+        end
+
+        def register_type(extension, klass)
+          registered_types[extension.to_s] = klass
+        end
+
+        def tag_reader(method_name, tag)
+          define_method(method_name) do
+            tags[tag.to_s]
+          end
+        end
+
+        def from_path(path)
+          extension = File.extname(path)[1..-1]
+          registered_types[extension.to_s]&.new(path) || fail(ArgumentError, "No type handler registered for extension '#{extension}'")
+        end
+      end
+
+      attr_reader :path
+
+      def initialize(path)
+        @path = path
+      end
+
+      def tags
+        fail NotImplementedError
+      end
+
+      def album
+        fail NotImplementedError
+      end
+
+      def genre
+        fail NotImplementedError
+      end
+
+      def title
+        fail NotImplementedError
+      end
+
+      def year
+        fail NotImplementedError
+      end
+
+      def artist
+        fail NotImplementedError
+      end
+
+      def album_artist
+        fail NotImplementedError
+      end
+
+      def track_number
+        fail NotImplementedError
+      end
+
+      def symlink_file_name
+        File.basename(path)
+      end
+
+      def relative_symlink_dir
+        "#{album_artist}/#{album}"
+      end
+
+      def relative_symlink_path
+        "#{relative_symlink_dir}/#{symlink_file_name}"
+      end
+    end
+  end
+end

data/lib/plex_symlinker/file_types/mp3.rb

@@ -0,0 +1,37 @@
+module PlexSymlinker
+  module FileTypes
+    # {
+    #   "TDRC": "1968",
+    #   "TIT2": "Seite B",
+    #   "TKEY": "C",
+    #   "TBPM": "120",
+    #   "TPE1": "Winnetou",
+    #   "TALB": "Winnetou 3 - 3. Folge",
+    #   "TPE2": "alb-artist: Winnetou",
+    #   "TCON": "Hörspiel",
+    #   "APIC": "[image/jpeg]",
+    #   "TRCK": "2/2",
+    #   "TXXX": "[PERFORMER_NAME] PERFORMER_NAME a performer"
+    # }
+    class Mp3 < AudioFile
+      tag_reader :album, "TALB"
+      tag_reader :genre, "TCON"
+      tag_reader :title, "TIT2"
+      tag_reader :year, "TDRC"
+      tag_reader :artist, "TPE1"
+      tag_reader :track_number, "TRCK"
+
+      def tags
+        @tags ||= TagLib::MPEG::File.open(path) { |file|
+          Hash[file.id3v2_tag.frame_list.map { |f| [f.frame_id, f.to_s] }]
+        }
+      end
+
+      def album_artist
+        tags["TPE2"] || artist
+      end
+    end
+  end
+end
+
+PlexSymlinker::FileTypes::AudioFile.register_type :mp3, PlexSymlinker::FileTypes::Mp3

data/lib/plex_symlinker/file_types/mp4.rb

@@ -0,0 +1,45 @@
+module PlexSymlinker
+  module FileTypes
+    # => {"----:com.apple.iTunes:ALBUM ARTIST"=>"Walter Moers",
+    #     "----:com.apple.iTunes:Encoding Params"=>"Nero AAC codec / Aug 6 2007",
+    #     "----:com.apple.iTunes:PERFORMER"=>"Andreas Fröhlich",
+    #     "----:com.apple.iTunes:cdec"=>"Nero AAC codec / Aug 6 2007",
+    #     "----:com.apple.iTunes:tool"=>"Nero AAC codec / Aug 6 2007",
+    #     "aART"=>"Walter Moers",
+    #     "covr"=>nil,
+    #     "soaa"=>"Moers, Walter",
+    #     "soal"=>"05 - Der Schrecksenmeister",
+    #     "soar"=>"Moers, Walter",
+    #     "trkn"=>nil,
+    #     "©ART"=>"Walter Moers",
+    #     "©alb"=>"Der Schreckensmeister",
+    #     "©day"=>"2008",
+    #     "©gen"=>"Hörbuch",
+    #     "©nam"=>"Der Schreckensmeister - Teil 1",
+    #     "©too"=>"Nero AAC codec / Aug 6 2007"}
+
+    class Mp4 < AudioFile
+      tag_reader :sort_album_artist, "soaa"
+      tag_reader :sort_artist, "soar"
+      tag_reader :sort_album, "soal"
+      tag_reader :album, "©alb"
+      tag_reader :genre, "©gen"
+      tag_reader :title, "©nam"
+      tag_reader :year, "©day"
+      tag_reader :artist, "©ART"
+      tag_reader :performer, "----:com.apple.iTunes:PERFORMER_NAME"
+
+      def tags
+        @tags ||= TagLib::MP4::File.open(path) { |file|
+          Hash[file.tag.item_map.to_a.map { |k, i| [k, i.to_string_list.first] }]
+        }
+      end
+
+      def album_artist
+        tags["aART"] || artist
+      end
+    end
+  end
+end
+
+PlexSymlinker::FileTypes::AudioFile.register_type :m4b, PlexSymlinker::FileTypes::Mp4

data/lib/plex_symlinker/operation.rb

@@ -0,0 +1,100 @@
+module PlexSymlinker
+  class Operation
+    attr_reader :files_base_dir, :symlinks_base_dir, :symlink_target_dir
+
+    #
+    # @param [String] files_base_dir
+    #   The directory the audio files are in. Sub-Directories are scanned accordingly.
+    # @param [String] symlinks_base_dir
+    #   The directory the symlinks and folder structure should be placed in.
+    # @param [String] symlink_target_dir
+    #   In some cases, the created symlinks should not target the actual files directory,
+    #   but a different one instead. An example would be the usage of this Gem through a Dockerfile
+    #   with mounted volumes.
+    #
+    # @example Usage with a custom symlink target dir
+    #   # When using a docker container to run this gem, we have to make sure it has access to
+    #   # both the files and the directory to place the symlinks in. The easiest way to do so
+    #   # is by mounting both directories as volumes.
+    #   # The docker image expects the files and symlinks directories to be mounted as  /app/source and /app/target
+    #   # respectively:
+    #
+    #   docker run plex-symlinker -v /path/to/audio/files:/app/source -v /path/to/symlinks:/app/target
+    #
+    #   # The problem here would be that the generated symlinks would all point to files inside /app/source
+    #   # instead of the actual audio file directory as this is the only directly that's known inside the
+    #   # docker container.
+    #   # To fix this, specifying the actual files directory outside the container as +symlink_target_dir+
+    #   # takes precedence when creating the symlinks. This is already done in /bin/plex-symlinker-docker.
+    #   # An example initialization for the above paths would therefore be:
+    #
+    #   Operation.new("/app/source", "/app/target", symlink_target_dir: "/path/to/audio/files")
+    #
+    def initialize(files_base_dir, symlinks_base_dir, symlink_target_dir: nil)
+      @files_base_dir = files_base_dir
+      @symlinks_base_dir = symlinks_base_dir
+      @symlink_target_dir = symlink_target_dir.presence || @files_base_dir
+    end
+
+    #
+    # Searches for files within the given directory and its subdirectories.
+    #
+    # @param [String] dir
+    #   The directory to search in
+    # @param [Array<#to_s>] extensions
+    #   File extensions to be taken into account. Only files with a matching extension
+    #   will be returned.
+    # @return [Array<String>] The paths to all files with matching extensions within the given directory
+    #
+    def files(dir, extensions = FileTypes::AudioFile.registered_types.keys)
+      Dir[File.join(dir, "**/*.{#{extensions.join(",")}}")]
+    end
+
+    def audio_files
+      files(files_base_dir).map(&FileTypes::AudioFile.method(:from_path))
+    end
+
+    def symlinks
+      files(symlinks_base_dir).map(&Symlink.method(:new))
+    end
+
+    def perform
+      cleanup
+      create_symlinks
+    end
+
+    def create_symlinks
+      PlexSymlinker.logger.info "Creating new symlinks..."
+
+      progress = ProgressBar.create(total: audio_files.size, output: PlexSymlinker.output)
+
+      audio_files.each do |file|
+        progress.log " --* #{file.album_artist}/#{file.album}..."
+
+        FileUtils.mkdir_p(File.join(symlinks_base_dir, file.relative_symlink_dir))
+
+        path = file.path.gsub(files_base_dir, symlink_target_dir)
+        symlink_path = File.join(symlinks_base_dir, file.relative_symlink_path)
+
+        # If we already have a symlink, don't try to create it again.
+        next if File.symlink?(symlink_path)
+
+        File.symlink(path, symlink_path)
+        progress.increment
+      end
+    end
+
+    #
+    # Removes all symlinks from the target folder that don't have an existing target any more
+    #
+    # TODO: Remove empty directories as well
+    #
+    def cleanup
+      PlexSymlinker.logger.info "Removing invalid existing symlinks..."
+      symlinks.each do |link|
+        current_target = link.target.gsub(symlink_target_dir, files_base_dir)
+        File.delete(link.path) unless File.exist?(current_target)
+      end
+    end
+  end
+end

data/lib/plex_symlinker/symlink.rb

@@ -0,0 +1,13 @@
+module PlexSymlinker
+  class Symlink
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def target
+      File.readlink(path)
+    end
+  end
+end

data/lib/plex_symlinker/version.rb

@@ -0,0 +1,3 @@
+module PlexSymlinker
+  VERSION = "0.1.0"
+end

data/plex_symlinker.gemspec

@@ -0,0 +1,32 @@
+require_relative "lib/plex_symlinker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "plex_symlinker"
+  spec.version       = PlexSymlinker::VERSION
+  spec.authors       = ["Stefan Exner"]
+  spec.email         = ["stex@sterex.de"]
+
+  spec.summary       = "Create a plex music agent friendly symlink structure for your audiobook files. "
+  spec.description   = "Create a plex music agent friendly symlink structure for your audiobook files. "
+  spec.homepage      = "https://github.com/stex/plex_symlinker"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/stex/plex_symlinker"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } rescue []
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", "~> 6.0"
+  spec.add_runtime_dependency "ruby-progressbar", "~> 1.10"
+  spec.add_runtime_dependency "slop", "~> 4.8"
+  spec.add_runtime_dependency "taglib-ruby", "~> 1.0"
+  spec.add_runtime_dependency "zeitwerk", "~> 2.4"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: plex_symlinker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Exner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: taglib-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: 'Create a plex music agent friendly symlink structure for your audiobook
+  files. '
+email:
+- stex@sterex.de
+executables:
+- plex_symlinker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".standard.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Dockerfile.dev
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ci-build-dev
+- bin/ci-build-production
+- bin/ci-test
+- bin/console
+- bin/docker-plex_symlinker
+- bin/setup
+- exe/plex_symlinker
+- lib/plex_symlinker.rb
+- lib/plex_symlinker/file_types/audio_file.rb
+- lib/plex_symlinker/file_types/mp3.rb
+- lib/plex_symlinker/file_types/mp4.rb
+- lib/plex_symlinker/operation.rb
+- lib/plex_symlinker/symlink.rb
+- lib/plex_symlinker/version.rb
+- plex_symlinker.gemspec
+homepage: https://github.com/stex/plex_symlinker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/stex/plex_symlinker
+  source_code_uri: https://github.com/stex/plex_symlinker
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Create a plex music agent friendly symlink structure for your audiobook files.
+test_files: []