plex_symlinker 0.1.0 → 0.1.1

checksums.yaml

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

data/.gitignore

@@ -8,5 +8,7 @@
 /tmp/
 /spec/tmp/
 
+*.gem
+
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## [0.1.1] - 2020-07-28
+
+### Changed
+
+* Removed zeitwerk (there weren't really enough files to even consider it necessary)
+* Fixed gem executable
+
+## [0.1.0] - 2020-07-28
+
+Initial Release

data/Gemfile.lock

@@ -1,12 +1,11 @@
 PATH
   remote: .
   specs:
-    plex_symlinker (0.1.0)
+    plex_symlinker (0.1.1)
       activesupport (~> 6.0)
       ruby-progressbar (~> 1.10)
       slop (~> 4.8)
       taglib-ruby (~> 1.0)
-      zeitwerk (~> 2.4)
 
 GEM
   remote: https://rubygems.org/

data/README.dockerhub.md

@@ -0,0 +1,80 @@
+# 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**
+
+PlexSymlinker 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.
+
+## Usage
+
+Since the whole purpose of PlexSymlinker is to read a directory full of audio files and 
+fill another directory with symlinks, we have to make sure the docker container has access to both of them.
+
+When using the docker image, the audio files directory is expected to be mounted
+as `/app/source` and the directory the symlinks should be placed in as `/app/target`.
+
+💡 You also have to pass in the `SYMLINK_TARGET_DIR` environment variable. 
+Since the gem only sees `/app/source` inside the docker container, 
+it would point all symlinks there instead of the actual directory on your host machine. 
+Just set it to the same directory that you mounted as `/app/source`.
+
+### 0. Make sure your files are properly tagged!
+
+At least the album and album artist fields have to set accordingly.
+
+But since you are planning to import those files into Plex which needs a lot more information, 
+it would make sense to fill out all details you can provide.
+
+### 1. Create the directory the symlinks should be placed in (if it doesn't exist yet)
+
+It's important that the directory exists (owned by your current user) before you mount it.
+
+    mkdir -p /path/to/symlink/dir
+
+If you ran PlexSymlinker before, you can just re-run it on the same directory again. 
+It will automatically sync the symlinks against the actual files.
+
+### 2. Run the docker image
+
+#### MacOS
+
+    docker run -it --rm -v /path/to/audiobooks:/app/source:ro -v /path/to/symlink/dir:/app/target --env SYMLINK_TARGET_DIR=/path/to/audiobooks sterexx/plex_symlinker
+
+#### Linux
+
+💡 Under Linux, you have to make sure to set your current user/group id 
+with `--user "$(id -u):$(id -g)"` - otherwise, all the generated symlinks/directories 
+will be owned by the root user. Docker for mac/windows takes care of that for you automatically.
+
+    docker run -it --user "$(id -u):$(id -g)" --rm -v /path/to/audiobooks:/app/source:ro -v /path/to/symlink/dir:/app/target --env SYMLINK_TARGET_DIR=/path/to/audiobooks sterexx/plex_symlinker
+
+### 3. Create a Plex library pointing to the symlink directory

data/README.md

@@ -59,6 +59,24 @@ all necessary dependencies and can be used out-of-the-box by mounting the necess
 
 ### Using the gem executable
 
+#### 0. Make sure your files are properly tagged!
+
+At least the `album` and `album artist` fields have to set accordingly.
+
+But since you are planning to import those files into Plex which needs a lot more information,
+it would make sense to fill out all details you can provide.
+
+#### 1. Run the gem executable with source and target directory
+
+```bash
+plex_symlinker /path/to/audiobooks /path/to/symlinks
+```
+
+💡 If you ran PlexSymlinker before, you can just re-run it on the same directory again.
+It will automatically sync the symlinks against the actual files and even delete no longer existing files.
+
+#### 2. Create a Plex library pointing to the symlink directory
+
 ### Using the Docker image
 
 Please refer to [Docker Hub](https://hub.docker.com/r/sterexx/plex_symlinker) for instructions

data/lib/plex_symlinker.rb

@@ -4,11 +4,13 @@ require "active_support/all"
 require "pathname"
 require "ruby-progressbar"
 require "taglib"
-require "zeitwerk"
 
-loader = Zeitwerk::Loader.for_gem
-loader.setup
-loader.eager_load
+require "plex_symlinker/file_types/audio_file"
+require "plex_symlinker/file_types/mp3"
+require "plex_symlinker/file_types/mp4"
+require "plex_symlinker/operation"
+require "plex_symlinker/symlink"
+require "plex_symlinker/version"
 
 module PlexSymlinker
   class Error < StandardError; end

data/lib/plex_symlinker/version.rb

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

data/plex_symlinker.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   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"
+  spec.metadata["source_code_uri"] = spec.homepage
 
   # 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.
@@ -28,5 +28,4 @@ Gem::Specification.new do |spec|
   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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plex_symlinker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Stefan Exner
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !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:
@@ -93,12 +79,14 @@ files:
 - ".rspec"
 - ".standard.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Dockerfile
 - Dockerfile.dev
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- README.dockerhub.md
 - README.md
 - Rakefile
 - bin/ci-build-dev