playlist 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 30be0088143707327ec29c8888bd04f94ee2ff22
-  data.tar.gz: 1c462de277427d226a81ce130c060910ac74c525
+SHA256:
+  metadata.gz: 81dea6b42315190f6066d99551de62d84752aacf44fb39721fbea24e6713c4e3
+  data.tar.gz: b7e528d0db40b684efab812c09a7dcf566b44d468f058035037094c84f99bb1f
 SHA512:
-  metadata.gz: 53b751fa9ad238e6acb13c0287e84ec4387a86d406d3a6ade773eb2bad5d1571b656328ac336a6cd5f24932ed4e609be4dd283cac437b57200293d290ebd54cc
-  data.tar.gz: 21563296d9604407988d425bc9002b830bee0be57c118982ffa32408fefc0e04e87de29d506be7a7e85b560cdefc4cdc66143a6969173bbc74b036ced80c841a
+  metadata.gz: f6b9a2047b4bd0093b2f22053a2a8ac247a711fa5abffbfc838aed9b884e2011eb156ba88f65d28da7f4f1e9446807d8f2b422b75cbb4a42c846a530e1fcaf43
+  data.tar.gz: '019d2491fdac856319d36ceb3941d83eac7139a5679970b8fd8de51da384ddff8eb3941655f1b0d5c1eb3dd90489290ce601b3047b8dfcd4de1b07852abad7d0'

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.0
+  TargetRubyVersion: 2.3
   Exclude:
   - 'vendor/**/*'
 
@@ -12,17 +12,28 @@ Style/HashSyntax:
 Style/MutableConstant:
   Enabled: false
 
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
 Style/SymbolArray:
   EnforcedStyle: brackets
 
 Style/ClassAndModuleChildren:
   EnforcedStyle: compact
 
-MethodLength:
+# Not available in older rubies
+Style/SafeNavigation:
+  Enabled: false
+
+# Disabled because it makes the code longer, more repetitive
+Style/FormatStringToken:
+  Enabled: false
+
+Metrics/MethodLength:
   Max: 20
 
 Metrics/AbcSize:
-  Max: 20
+  Max: 25
 
 # Allow long blocks in rspec
 Metrics/BlockLength:

data/.travis.yml

@@ -2,4 +2,4 @@ sudo: false
 language: ruby
 rvm:
   - 2.2.2
-before_install: gem install bundler -v 1.13.7
+  - 2.5.2

data/README.md

@@ -7,8 +7,10 @@ This ruby gem allows you to create and manipulate playlists of musical tracks.
 It supports parsing and generating playlists in the following formats:
 
 * M3U
+* PLS
 * XSPF
 * A simple human readable format
+* Cue Sheet
 
 ## Installation
 

data/lib/playlist.rb

@@ -27,6 +27,10 @@ class Playlist
   # @return [String]
   attr_accessor :license
 
+  # URI of an image associated with this playlist
+  # @return [String]
+  attr_accessor :image
+
   # Get a hash of identifier for this playlist
   # Identifiers can either be Strings or URIs
   # @return [Hash] an hash of identifiers
@@ -68,6 +72,7 @@ class Playlist
     time = tracks.first.start_time || 0
     tracks.each do |track|
       break if track.duration.nil?
+
       time = (track.start_time ||= time)
       time += track.duration
     end

data/lib/playlist/format.rb

@@ -2,6 +2,7 @@
 module Playlist::Format
   autoload :Cue, 'playlist/format/cue'
   autoload :M3U, 'playlist/format/m3u'
+  autoload :PLS, 'playlist/format/pls'
   autoload :SimpleText, 'playlist/format/simple_text'
   autoload :XSPF, 'playlist/format/xspf'
 end

data/lib/playlist/format/pls.rb

@@ -0,0 +1,91 @@
+# Module to parse and generate PLS playlists
+module Playlist::Format::PLS
+  class << self
+    # Parse a PLS file into a [Playlist]
+    # @param input any object that responds to #each_line
+    #        (either a String or a IO object)
+    # @return [Playlist] a new Playlist object
+    def parse(input)
+      tracks = parse_lines_to_array(input)
+
+      # Now convert to objects
+      array_to_object(tracks)
+    end
+
+    # Generate a PLS file from a [Playlist]
+    # @param playlist [Playlist] the playlist to be converted to PLS
+    # @return [String] PLS as a string
+    def generate(playlist)
+      text = "[playlist]\n\n"
+      playlist.tracks.each_with_index do |t, index|
+        index += 1
+        duration = (t.duration / 1000).round
+        text += "File#{index}=#{t.location}\n"
+        if t.creator && t.title
+          text += "Title#{index}=#{t.creator} - #{t.title}\n"
+        elsif t.title
+          text += "Title#{index}=#{t.title}\n"
+        end
+        text += "Length#{index}=#{duration}\n"
+        text += "\n"
+      end
+      text += "NumberOfEntries=#{playlist.tracks.count}\n"
+      text += "Version=2\n"
+      text
+    end
+
+    protected
+
+    def parse_line(tracks, line)
+      if (matches = line.match(/^([a-z]+)(\d+)=(.+)$/i))
+        key = matches[1].downcase.to_sym
+        num = matches[2].to_i - 1
+        tracks[num] ||= {}
+        tracks[num][key] = matches[3]
+      elsif (matches = line.match(/^NumberOfEntries=(\d+)$/))
+        if matches[1].to_i != tracks.count
+          raise 'PLS parse error: NumberOfEntries is incorrect'
+        end
+      elsif (matches = line.match(/^Version=(\d+)$/))
+        if matches[1] != '2'
+          raise "PLS file version #{version} is not supported"
+        end
+      else
+        warn "Unable to parse line: #{line}"
+      end
+    end
+
+    def parse_lines_to_array(input)
+      tracks = []
+      input.each_line.with_index do |line, index|
+        line.strip!
+        if index.zero?
+          if line == '[playlist]'
+            next
+          else
+            raise 'PLS parse error: first line is not [playlist]'
+          end
+        end
+        parse_line(tracks, line) unless line.empty?
+      end
+      tracks
+    end
+
+    def array_to_object(tracks)
+      Playlist.new do |playlist|
+        tracks.each do |track|
+          obj = Playlist::Track.new
+          obj.location = track[:file] unless track[:file].nil?
+          obj.duration = track[:length].to_i * 1000 unless track[:length].nil?
+          if (matches = track[:title].match(/^(.+) - (.+)$/))
+            obj.creator = matches[1]
+            obj.title = matches[2]
+          else
+            obj.title = track[:title]
+          end
+          playlist.add_track(obj)
+        end
+      end
+    end
+  end
+end

data/lib/playlist/format/xspf.rb

@@ -14,9 +14,12 @@ module Playlist::Format::XSPF
       Playlist.new do |playlist|
         doc = Nokogiri::XML(input)
         playlist.title = doc.content_at('/xmlns:playlist/xmlns:title')
+        playlist.creator = doc.content_at('/xmlns:playlist/xmlns:creator')
         playlist.description = doc.content_at(
           '/xmlns:playlist/xmlns:annotation'
         )
+        playlist.image = doc.content_at('/xmlns:playlist/xmlns:image')
+        playlist.info_url = doc.content_at('/xmlns:playlist/xmlns:info')
         doc.xpath('/xmlns:playlist/xmlns:trackList/xmlns:track').each do |track|
           playlist.tracks << parse_track(track)
         end
@@ -29,8 +32,14 @@ module Playlist::Format::XSPF
     def generate(playlist)
       builder = Nokogiri::XML::Builder.new do |xml|
         xml.playlist(:version => 1, :xmlns => 'http://xspf.org/ns/0/') do
-          xml.title(playlist.title) unless playlist.title.nil?
-          xml.annotation(playlist.description) unless playlist.description.nil?
+          build_xml_unless_nil(
+            xml,
+            :title => playlist.title,
+            :creator => playlist.creator,
+            :annotation => playlist.description,
+            :image => playlist.image,
+            :info => playlist.info_url
+          )
           xml.trackList do
             playlist.tracks.each { |track| generate_track(xml, track) }
           end
@@ -43,21 +52,36 @@ module Playlist::Format::XSPF
 
     def parse_track(doc)
       Playlist::Track.new do |track|
-        track.creator = doc.content_at('./xmlns:creator')
-        track.title = doc.content_at('./xmlns:title')
         track.location = doc.content_at('./xmlns:location')
+        track.title = doc.content_at('./xmlns:title')
+        track.creator = doc.content_at('./xmlns:creator')
         if (duration = doc.content_at('./xmlns:duration'))
           track.duration = duration.to_i
         end
+        track.album = doc.content_at('./xmlns:album')
+        track.description = doc.content_at('./xmlns:annotation')
+        track.image = doc.content_at('./xmlns:image')
       end
     end
 
     def generate_track(xml, track)
       xml.track do
-        xml.location(track.location) unless track.location.nil?
-        xml.title(track.title) unless track.title.nil?
-        xml.creator(track.creator) unless track.creator.nil?
-        xml.duration(track.duration) unless track.duration.nil?
+        build_xml_unless_nil(
+          xml,
+          :location => track.location,
+          :title => track.title,
+          :creator => track.creator,
+          :duration => track.duration,
+          :album => track.album,
+          :annotation => track.description,
+          :image => track.image
+        )
+      end
+    end
+
+    def build_xml_unless_nil(xml, hash)
+      hash.each_pair do |key, value|
+        xml.send(key, value) unless value.nil?
       end
     end
   end

data/lib/playlist/track.rb

@@ -11,6 +11,10 @@ class Playlist::Track
   # @return [String]
   attr_accessor :album
 
+  # A description/annotation/synopsis of the track
+  # @return [String]
+  attr_accessor :description
+
   # The catalogue number of the album that the track came from
   # Also known as the UPC/EAN code
   # @return [String]
@@ -51,6 +55,10 @@ class Playlist::Track
   # @return [Array<Contributor>] an array of tracks in the playlist
   attr_reader :contributors
 
+  # URI of an image associated with this Track
+  # @return [String]
+  attr_accessor :image
+
   # Create a new Track
   # @param attr [Hash] a hash of attibute values to set
   def initialize(attr = {})

data/lib/playlist/version.rb

@@ -1,4 +1,4 @@
 class Playlist
   # The version number of the Playlist Ruby gem
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playlist
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Nicholas Humfrey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-03 00:00:00.000000000 Z
+date: 2020-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -142,6 +142,7 @@ files:
 - lib/playlist/format.rb
 - lib/playlist/format/cue.rb
 - lib/playlist/format/m3u.rb
+- lib/playlist/format/pls.rb
 - lib/playlist/format/simple_text.rb
 - lib/playlist/format/xspf.rb
 - lib/playlist/track.rb
@@ -167,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Convert playlists between different formats