musictree 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b624b50d7d91e88873fa873b3313751f8ee3ea6988a13028b1c7caf8e5303f6
-  data.tar.gz: 94eadc0bc92fd9d041d7470660c7268bbd8041c351b841766eae48beca160313
+  metadata.gz: 1c4ae2d14cb182c1f34a62b95ec57a76a38f4552248b8a44a8c30137de124d7f
+  data.tar.gz: 26dfaca9216f36d4b5bad2d8caa030f8b2a016432f5d53cf33121d43b13fb499
 SHA512:
-  metadata.gz: f56d53d4367ae4ca448129b55db642c183ff9b090ad120437e7dd2241b9b47a28d54395694a55f9a44b4c91314ae9d7cd898e84c1205190991d8b080eff0a38b
-  data.tar.gz: d7e288624ac011b23b00b02c22d7ea641c0dacec91f554665533efc8971b6cf3329f399d97247e72aadacc2efcef9346db5984d5d5320151b1dc433be9946159
+  metadata.gz: c7086c0e64e9b511bb2c607cd36e2baa41bd4af65cf71ab2eda933a09cabf98e00d978e261c1d8af75d226d236d066b96c744846b020ffa8a3999d778bd70513
+  data.tar.gz: 7f6402fb7aa26e5521d3d77fb49d6777e0842592c83f260b968e15c030aa6ecc33792a0736e6f33d2e9e341a4f32920e1bfdc3379acb6e4dc8a587df644f12e7

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.2.1] - 2025-07-21
+
+- Expose path in all objects (silly me)
+
+## [0.2.0] - 2025-07-21
+
+- Big Refactoring, Trees in trees, uniform interface
+- First version to be actually somewhat usable
+- Use wahwah gem for now for metadata extraction
+
 ## [0.1.0] - 2025-07-11
 
 - Initial release

data/Rakefile

@@ -2,9 +2,16 @@
 
 require "bundler/gem_tasks"
 require "minitest/test_task"
+require "yard"
+
+CLEAN.include "doc"
 
 Minitest::TestTask.create
 
 require "standard/rake"
 
 task default: %i[test standard]
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ["lib/**/*.rb", "-", "README.md", "LICENSE.txt", "CHANGELOG.md"]
+end

data/checksums/musictree-0.2.0.gem.sha512

@@ -0,0 +1 @@
+cf193a621cd919014ffa52ae2457f09daf90c5b408a1e4da88d7d207aa1c3d7f6c2ce2602de22e4c2d1890a8ed308b888043636b575cb6de025fcc2e0016e289

data/checksums/musictree-0.2.1.gem.sha512

@@ -0,0 +1 @@
+f1701fbd7ac3641f637b5685ce118d09dec9beed2af6ef739c8793ac6a366d103c83aef737cea8e30302547eb38942785d054525ef5b70910cf17daf07af6898

data/lib/musictree/album.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# @author Jan "half/byte" Krutisch
+module Musictree
+  # Album contains the tracks of an album. It is an Enumerable for the tracks
+  # An Album has a title.
+  class Album
+    include Enumerable
+
+    attr_reader :title, :path
+
+    # Scans in the music files that sit in the album path. (No subdirs)
+    # @param path [String] The path to the album
+    # @return [Album] an album that exposes the tracks as an enumerable
+    def self.scan(path)
+      preliminary_name = File.basename(File.dirname(path))
+      moi = new(path, preliminary_name)
+      moi.scan_album
+    end
+
+    def initialize(path, preliminary_name)
+      @title = preliminary_name
+      @path = path
+      @tracks = []
+    end
+
+    def each(&block)
+      @tracks.each(&block)
+    end
+
+    def empty?
+      @tracks.empty?
+    end
+
+    def [](idx)
+      @tracks[idx]
+    end
+
+    def to_s
+      @tracks.map(&:to_s)
+    end
+
+    def inspect
+      @tracks.map(&:inspect)
+    end
+
+    # An album is an album
+    def album?
+      true
+    end
+
+    def scan_album
+      files = Dir[File.join(@path, "*.{m3u,wav,flac,mp3,opus,aiff}")]
+      if files.empty?
+        # is it a collection?
+        return Tree.scan(@path)
+      end
+      @tracks = files.map do |path|
+        Track.new(path)
+      end
+      if @tracks.all?(&:track)
+        @tracks = @tracks.sort_by(&:track)
+      end
+      titles = @tracks.map(&:album).uniq
+      @title = titles.first
+      self
+    end
+  end
+end

data/lib/musictree/ff_prober.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Musictree
+  class FFProbeError < Error; end
+
+  # Let's leave this in here for now if we need this for exotic cases.
+  class FFProber
+    def initialize(path)
+      @path = path
+      probe
+    end
+
+    def [](key)
+      @metadata[key]
+    end
+
+    def probe
+      @metadata = {}
+      stdout, stderr, status = Open3.capture3("ffprobe #{@path} -hide_banner -show_entries 'format_tags'")
+      matches = stdout.match(/\[FORMAT\]\n(.*)\n\[\/FORMAT\]/m)
+      unless status.success?
+        raise FFProbeError.new("Error running ffprobe: #{stderr}")
+      end
+      if matches.nil?
+        raise FFProbeError.new("No FORMAT block in result: #{[stdout, stderr].join}")
+      end
+      matches[1].lines.each do |line|
+        line_matches = line.match(/^TAG:(?<tag>\w+)=(?<value>.*?)\n/)
+        if line_matches
+          @metadata[line_matches[:tag].downcase] = line_matches[:value]
+        end
+      end
+    end
+  end
+end

data/lib/musictree/track.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "wahwah"
+
+# @author Jan "half/byte" Krutisch
+module Musictree
+  # A track holds the meta information for one music file
+  class Track
+    attr_reader :title, :artist, :track, :album, :path
+    # Scan a music file for metadata
+    # (The method name is consistent to the other classes but a bit shit)
+    # @param path [String] path to the source music file
+    def self.scan(path)
+      moi = new(path)
+      moi.parse_file
+      moi
+    end
+
+    def initialize(path)
+      @path = path
+      @title = File.basename(@path) # Let's set a preliminary name
+      parse_file
+    end
+
+    def inspect
+      {
+        path: @path,
+        title: @title,
+        artist: @artist,
+        track: @track_no,
+        album: @album
+      }.inspect
+    end
+
+    def parse_file
+      tag = WahWah.open(@path)
+      @title = tag.title
+      @artist = tag.artist
+      @track = tag.track
+      @album = tag.album
+    end
+  end
+end

data/lib/musictree/tree.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# @author Jan "half/byte" Krutisch
+module Musictree
+  # Tree is the base entry class for Musictree.
+  # Use Tree.scan(path) to scan in a full tree for a given file path
+  # Tree is enumerable and contains either other trees (subdirectories) or albums.
+  class Tree
+    attr_reader :title, :path
+    include Enumerable
+
+    # Scan in a file tree
+    # The Tree exposes Albums or subtrees as an Enumerable
+    # @param path [String] the absolute path to the file tree you want to scan
+    # @return [Musictree::Tree]
+    def self.scan(path)
+      moi = new(path)
+      moi.scan_path
+      moi
+    end
+
+    def initialize(path)
+      @path = path
+      @children = []
+    end
+
+    def each(&block)
+      @children.each(&block)
+    end
+
+    def empty?
+      @children.empty?
+    end
+
+    def [](idx)
+      @children[idx]
+    end
+
+    # A tree is not an album
+    def album?
+      false
+    end
+
+    def scan_path
+      @title = File.basename(@path)
+      Dir[File.join(@path, "/*")].each do |file_or_dir|
+        if File.directory?(file_or_dir)
+          @children << Album.scan(file_or_dir)
+        else
+          raise Error.new("Only Directories expected here")
+        end
+      end
+    end
+  end
+end

data/lib/musictree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Musictree
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/musictree.rb

@@ -1,107 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "musictree/version"
-require "pathname"
-require "open3"
-
 module Musictree
   class Error < StandardError; end
-
-  class FFProbeError < Error; end
-
-  class FFProber
-    def initialize(path)
-      @path = path
-      probe
-    end
-
-    def [](key)
-      @metadata[key]
-    end
-
-    def probe
-      @metadata = {}
-      stdout, stderr, status = Open3.capture3("ffprobe #{@path} -hide_banner -show_entries 'format_tags'")
-      matches = stdout.match(/\[FORMAT\]\n(.*)\n\[\/FORMAT\]/m)
-      unless status.success?
-        raise FFProbeError.new("Error running ffprobe: #{stderr}")
-      end
-      if matches.nil?
-        raise FFProbeError.new("No FORMAT block in result: #{[stdout, stderr].join}")
-      end
-      matches[1].lines.each do |line|
-        line_matches = line.match(/^TAG:(?<tag>\w+)=(?<value>.*?)\n/)
-        if line_matches
-          @metadata[line_matches[:tag]] = line_matches[:value]
-        end
-      end
-    end
-  end
-
-  class Track
-    attr_reader :title, :artist, :track_no, :album
-    def initialize(path)
-      @path = path
-      @title = File.basename(@path) # Let's set a preliminary name
-      parse_file
-    end
-
-    def parse_file
-      prober = FFProber.new(@path)
-      @title = prober["title"]
-      @artist = prober["artist"]
-      @track_no = prober["track"].to_i
-      @album = prober["album"]
-    end
-  end
-
-  class Album
-    attr_reader :title, :year, :tracks
-    def initialize(path, preliminary_name)
-      @title = preliminary_name
-      @path = path
-      @tracks = []
-      scan_album
-    end
-
-    def scan_album
-      files = Dir[File.join(@path, "/*.{m3u,wav,flac,mp3,opus,aiff}")]
-      @tracks = files.map do |path|
-        Track.new(path)
-      end
-      if @tracks.all?(&:track_no)
-        @tracks.sort_by(&:track_no)
-      end
-      titles = @tracks.map(&:album).uniq
-      @title = titles.first
-    end
-
-    def album?
-      true
-    end
-  end
-
-  class Tree
-    def initialize(path)
-      @path = path
-      @tree = {}
-      scan_path
-    end
-
-    def [](key)
-      @tree[key]
-    end
-
-    def scan_path
-      Dir[File.join(@path, "/*")].each do |file_or_dir|
-        if File.directory?(file_or_dir)
-          rel = Pathname.new(file_or_dir).relative_path_from(@path)
-          @tree[rel.to_s] = Album.new(file_or_dir, File.basename(rel))
-
-        else
-          raise Error.new("Only Directories expected here")
-        end
-      end
-    end
-  end
 end
+
+require_relative "musictree/version"
+require_relative "musictree/album"
+require_relative "musictree/track"
+require_relative "musictree/tree"

data/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "3.4.2"

metadata

@@ -1,14 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: musictree
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jan Krutisch
 bindir: exe
 cert_chain: []
-date: 2025-07-13 00:00:00.000000000 Z
-dependencies: []
+date: 2025-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wahwah
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.37
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.37
 email:
 - jan@krutisch.de
 executables: []
@@ -21,8 +49,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- checksums/musictree-0.2.0.gem.sha512
+- checksums/musictree-0.2.1.gem.sha512
 - lib/musictree.rb
+- lib/musictree/album.rb
+- lib/musictree/ff_prober.rb
+- lib/musictree/track.rb
+- lib/musictree/tree.rb
 - lib/musictree/version.rb
+- mise.toml
 - sig/musictree.rbs
 homepage: https://codeberg.org/bandwebpage/musictree
 licenses:
@@ -45,9 +80,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements:
-- ffprobe, tested with 7.1.1 and newer
+requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
-summary: Collect metadata on a directory tree of music files with the help of ffprobe
+summary: Collect metadata on a directory tree of music files
 test_files: []