playlist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbc27126439999045463cfa6de6ba50f75eb1864
+  data.tar.gz: 03110b81cb035d0b4b2685a64bc1fd41c8d4f414
+SHA512:
+  metadata.gz: 56fe2477c106da8550f666694fc90185c496ad74eb42ff2ab03f695e4f8063b150ae31c8019fc1f11bdee0b192fbbbcbadd555137037df74c47c38399260c09a
+  data.tar.gz: 77d78fb8dd7f5d802407ed1058f54de4264c18549278d7c91b426981319b6f6b63a06ea2f83dff37f34b13bde2d51c8f4ea123b3ca754797e23a56b76b1fef61

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/.ruby-version
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  TargetRubyVersion: 2.0
+  Exclude:
+  - 'vendor/**/*'
+
+Style/GuardClause:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 20
+
+# Allow long blocks in rspec
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.13.7

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in playlist.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nicholas J Humfrey
+
+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,90 @@
+[![Build Status](https://travis-ci.org/njh/ruby-playlist.svg)](https://travis-ci.org/njh/ruby-playlist)
+
+# Playlist
+
+This ruby gem allows you to create and manipulate playlists of musical tracks.
+
+It supports parsing and generating playlists in the following formats:
+
+* M3U
+* XSPF
+* A simple human readable format
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'playlist'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install playlist
+
+## Usage
+
+For full details, please see the [API Documentation](https://www.rubydoc.info/gems/playlist/).
+
+### Creating a Playlist
+
+The `playlist` gem provides data model classes for creating and manipulating 
+playlists and music metadata in ruby.
+
+Playlists can be constructed by passing a list of attributes to the constructor or by setting the attributes directly:
+
+```ruby
+playlist = Playlist.new(:title => "My awesome playlist")
+playlist.annotation = "Each week I add best tracks I can think of."
+playlist.add_track(
+  :performer => "Jon Hopkins",
+  :title => "Everything Connected"
+)
+
+track = Playlist::Track.new(:title => "Get Your Shirt")
+track.add_contributor(:name => "Underworld", :role => :performer)
+track.add_contributor(:name => "Iggy Pop", :role => :performer)
+playlist.add_track(track)
+```
+
+### Parsing a playlist file
+
+The `playlist` gem supports a number of different playlist file formats.
+Here is an example of parsing a M3U file:
+
+```ruby
+File.open("playlist.m3u") do |file|
+  playlist = Playlist::Format::M3U.parse(file)
+  puts "The playlist contains #{playlist.tracks.count} tracks"
+end
+```
+
+### Generating a playlist file
+
+Having created a `Playlist` object, it can be converted to a playlist file using:
+
+```ruby
+File.open("playlist.m3u", "wb") do |file|
+  file.write Playlist::Format::M3U.generate(playlist)
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/njh/ruby-playlist.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+YARD::Rake::YardocTask.new
+
+task :default => [:spec, :rubocop, :yard]

data/lib/playlist/contributor.rb

@@ -0,0 +1,31 @@
+# Data model class that represents a contributor to a track.
+# A Contrutor can be a person, or a organisation
+# (such an band, choir or orchestra).
+class Playlist::Contributor
+  # The name of the contributor
+  # @return [String]
+  attr_accessor :name
+
+  # The role of the contribrition to the track
+  #
+  # Recommended values for role:
+  #   :performer
+  #   :composer
+  #   :arranger
+  #   :lyricist
+  # @return [Symbol]
+  attr_accessor :role
+
+  # Create a new Contributor
+  def initialize(attr = nil)
+    if attr.is_a?(Hash)
+      attr.each_pair do |key, value|
+        send("#{key}=", value)
+      end
+    elsif attr.is_a?(String)
+      self.name = attr
+    end
+
+    yield(self) if block_given?
+  end
+end

data/lib/playlist/format/m3u.rb

@@ -0,0 +1,39 @@
+# Module to parse and generate M3U playlists
+module Playlist::Format::M3U
+  class << self
+    # Parse a M3U 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)
+      Playlist.new do |playlist|
+        track = Playlist::Track.new
+        input.each_line do |line|
+          if line =~ /^#EXTINF:(-?\d+),\s*(.+?)\s*-\s*(.+?)\s*$/
+            track.duration = Regexp.last_match(1)
+            track.creator = Regexp.last_match(2)
+            track.title = Regexp.last_match(3)
+          else
+            if line =~ /^[^#]\S+.+\s*$/
+              track.location = line.strip
+              playlist.add_track(track)
+            end
+            track = Playlist::Track.new
+          end
+        end
+      end
+    end
+
+    # Generate a M3U file from a [Playlist]
+    # @param playlist [Playlist] the playlist to be converted to M3U
+    # @return [String] M3U as a string
+    def generate(playlist)
+      text = "#EXTM3U\n"
+      playlist.tracks.each do |t|
+        text += "#EXTINF:#{t.duration.to_i},#{t.artist} - #{t.title}\n"
+        text += "#{t.location}\n"
+      end
+      text
+    end
+  end
+end

data/lib/playlist/format/simple_text.rb

@@ -0,0 +1,39 @@
+# Module to parse and generate playlists with one line per track
+module Playlist::Format::SimpleText
+  class << self
+    # Parse a human readable list of tracks 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)
+      Playlist.new do |playlist|
+        input.each_line do |line|
+          next if line =~ /^#/
+
+          track = parse_line(line.strip)
+          playlist.tracks << track unless track.nil?
+        end
+      end
+    end
+
+    # Parse a single line from a playlist into a Track obect
+    # @param line [String] any object that responds to #each_line
+    # @return [Track] a new Track object
+    def parse_line(line)
+      if line =~ /^(\d{1,2}[:.]\d{1,2}([:.]\d{1,2})?)?\s*(.+?) - (.+?)$/
+        Playlist::Track.new(
+          :start_time => Regexp.last_match(1),
+          :creator => Regexp.last_match(3).strip,
+          :title => Regexp.last_match(4).strip
+        )
+      end
+    end
+
+    # Generate a human readable list of tracks from a Playlist
+    # @param playlist [Playlist] the playlist
+    # @return [String] the playlist with one line per track
+    def generate(playlist)
+      playlist.tracks.map { |t| "#{t.artist} - #{t.title}" }.join("\n") + "\n"
+    end
+  end
+end

data/lib/playlist/format/xspf.rb

@@ -0,0 +1,62 @@
+require 'nokogiri'
+
+# Module to parse and generate XSPF playlists
+module Playlist::Format::XSPF
+  class << self
+    # Parse a XSPF file into a new Playlist object
+    # @param input [String, IO] the source of the XSPF file
+    # @return [Playlist] a new Playlist object
+    def parse(input)
+      Playlist.new do |playlist|
+        doc = Nokogiri::XML(input)
+        playlist.title = inner_text_or_nil(doc, '/xmlns:playlist/xmlns:title')
+        doc.xpath('/xmlns:playlist/xmlns:trackList/xmlns:track').each do |track|
+          playlist.tracks << parse_track(track)
+        end
+      end
+    end
+
+    # Generate a XSPF file from a Playlist object
+    # @param playlist [Playlist] the playlist
+    # @return [String] the XSPF playlist as a String
+    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.trackList do
+            playlist.tracks.each { |track| generate_track(xml, track) }
+          end
+        end
+      end
+      builder.to_xml
+    end
+
+    protected
+
+    def parse_track(doc)
+      Playlist::Track.new do |track|
+        track.creator = inner_text_or_nil(doc, 'xmlns:creator')
+        track.title = inner_text_or_nil(doc, 'xmlns:title')
+        track.location = inner_text_or_nil(doc, 'xmlns:location')
+        if (duration = inner_text_or_nil(doc, 'xmlns:duration'))
+          track.duration = duration.to_f / 1000
+        end
+      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 * 1000).to_i) unless track.duration.nil?
+      end
+    end
+
+    ## FIXME: how to do this better?
+    def inner_text_or_nil(doc, path)
+      element = doc.at_xpath(path)
+      element.inner_text unless element.nil?
+    end
+  end
+end

data/lib/playlist/format.rb

@@ -0,0 +1,6 @@
+# Base module for the various playlist formats
+module Playlist::Format
+  autoload :M3U, 'playlist/format/m3u'
+  autoload :SimpleText, 'playlist/format/simple_text'
+  autoload :XSPF, 'playlist/format/xspf'
+end

data/lib/playlist/track.rb

@@ -0,0 +1,147 @@
+# Data model class that represents a single track.
+class Playlist::Track
+  # A URI (or filename) to the location of the file
+  attr_accessor :location
+
+  # The title of the track
+  # @return [String]
+  attr_accessor :title
+
+  # The name of the album that the track came from
+  # @return [String]
+  attr_accessor :album
+
+  # The number of the track on the album it came from
+  # @return [Integer]
+  attr_accessor :track_number
+
+  # The side of disc if the track came from a vinyl album (eg A/B)
+  # @return [String]
+  attr_accessor :side
+
+  # The name of the record label that published the track/album
+  # @return [String]
+  attr_accessor :record_label
+
+  # The name of the publisher that published the score/lyrics of the song
+  # @return [String]
+  attr_accessor :publisher
+
+  # The time a track starts playing at, in seconds.
+  # May be a Float to include fractions of a second.
+  # @return [Integer, Float]
+  attr_accessor :start_time
+
+  # The duration of the track in seconds.
+  # May be a Float to include fractions of a second.
+  # @return [Integer, Float]
+  attr_reader :duration
+
+  # Get the array of the contributors to this Track
+  # @return [Array<Contributor>] an array of tracks in the playlist
+  attr_reader :contributors
+
+  # Create a new Track
+  # @param attr [Hash] a hash of attibute values to set
+  def initialize(attr = {})
+    @contributors = []
+    attr.each_pair do |key, value|
+      send("#{key}=", value)
+    end
+
+    yield(self) if block_given?
+  end
+
+  # Get a concatinated list of contributors names with no role
+  # @return [String]
+  def creator
+    contributor_names(nil)
+  end
+
+  # Set the name of the contributor with no role
+  # Removes any existing contributors with no role
+  # @param name [String] the name the contributor
+  def creator=(name)
+    replace_contributor(nil, name)
+  end
+
+  # Get a conactinated list of performers for this track
+  # If there are no performers, return contributors with no role
+  # @return [String]
+  def performer
+    contributor_names(:performer) || contributor_names(nil)
+  end
+  alias artist performer
+
+  # Set the name of the track performer
+  # Removes any existing performers
+  # @param name [String] the name the performer
+  def performer=(name)
+    replace_contributor(:performer, name)
+  end
+  alias artist= performer=
+
+  # Set the duration of the track
+  # If the duration is 0 or -1, then the duration is set to nil
+  # @param seconds [Numeric] the duration of the track in seconds
+  def duration=(seconds)
+    if seconds.is_a?(Numeric)
+      @duration = seconds
+    else
+      seconds = seconds.to_s
+      @duration = if seconds =~ /\./
+                    seconds.to_f
+                  else
+                    seconds.to_i
+                  end
+    end
+    @duration = nil if [0, -1].include?(@duration)
+  end
+
+  # Add a contributor to the Track
+  # @param args [Contributor, Hash] either a Contributor object or
+  #        a Hash of attributes to creatre a new contributor
+  def add_contributor(args)
+    @contributors << if args.is_a?(Playlist::Contributor)
+                       args
+                     else
+                       Playlist::Contributor.new(args)
+                     end
+  end
+
+  # First deletes any contribitors with same role, then adds a new contributor
+  # @param role [Symbol] the role of the new contributor
+  # @param name [String] the name of the new contributor
+  def replace_contributor(role, name)
+    @contributors.delete_if { |c| c.role == role }
+    add_contributor(:role => role, :name => name)
+  end
+
+  # Get a concatinated list of contributor names for a specific role
+  # @param role [Symbol] the role of the new contributor
+  #             Use :any to concatinate all contributor names
+  # @return [String]
+  def contributor_names(role = :any)
+    filtered = if role == :any
+                 @contributors
+               else
+                 @contributors.find_all { |c| c.role == role }
+               end
+    if filtered.count == 1
+      filtered.first.name
+    elsif filtered.count >= 2
+      filtered[0..-2].map(&:name).join(', ') +
+        ' & ' + filtered.last.name
+    end
+  end
+
+  # Get all the attributes of the track object as a Hash
+  # @return [Hash]
+  def to_h
+    Hash[
+      instance_variables.map do |v|
+        [v.to_s[1..-1].to_sym, instance_variable_get(v)]
+      end
+    ]
+  end
+end

data/lib/playlist/version.rb

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

data/lib/playlist.rb

@@ -0,0 +1,57 @@
+require 'playlist/version'
+
+# Data model class that for a single playlist.
+class Playlist
+  # The title of the playlist
+  # @return [String]
+  attr_accessor :title
+
+  # The name of the creator of this playlist
+  # @return [String]
+  attr_accessor :creator
+
+  # A description/synopsis of the playlist
+  # @return [String]
+  attr_accessor :annotation
+
+  # A URL to get more inforamtion about this playlist
+  # @return [String]
+  attr_accessor :info_url
+
+  # A link to the license / terms of use for this playlist
+  # @return [String]
+  attr_accessor :license
+
+  # Get the array that contains the list of track for this playlist
+  # @return [Array<Track>] an array of tracks in the playlist
+  attr_reader :tracks
+
+  # Create a new Playlist
+  # @param attr [Hash] a hash of attibute values to set
+  def initialize(attr = {})
+    @tracks = []
+    attr.each_pair do |key, value|
+      send("#{key}=", value)
+    end
+
+    yield(self) if block_given?
+  end
+
+  # Add a track to the playlist
+  # @param args [Track, Hash] either a Track object or
+  #        a Hash of attributes to creatre a new Track
+  def add_track(args)
+    @tracks << (args.is_a?(Track) ? args : Track.new(args))
+  end
+
+  # Get the total duration of this playlist
+  # If any tracks on the playlist don't have a duation, then they are ignored
+  # @return [Integer, Float]
+  def duration
+    @tracks.map(&:duration).compact.inject(:+)
+  end
+
+  autoload :Contributor, 'playlist/contributor'
+  autoload :Track, 'playlist/track'
+  autoload :Format, 'playlist/format'
+end

data/playlist.gemspec

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
+require 'playlist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'playlist'
+  spec.version       = Playlist::VERSION
+  spec.authors       = ['Nicholas Humfrey']
+  spec.email         = ['njh@aelius.com']
+
+  spec.summary       = 'Convert playlists between different formats'
+  spec.homepage      = 'https://github.com/njh/ruby-playlist'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',        '> 1.13'
+  spec.add_development_dependency 'equivalent-xml', '~> 0.6.0'
+  spec.add_development_dependency 'rake',           '~> 10.2.2'
+  spec.add_development_dependency 'rspec',          '~> 3.7.0'
+  spec.add_development_dependency 'rubocop',        '~> 0.50.0'
+  spec.add_development_dependency 'simplecov',      '~> 0.9.2'
+  spec.add_development_dependency 'yard',           '~> 0.9.14'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: playlist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicholas Humfrey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: equivalent-xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.14
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.14
+description: 
+email:
+- njh@aelius.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/playlist.rb
+- lib/playlist/contributor.rb
+- lib/playlist/format.rb
+- lib/playlist/format/m3u.rb
+- lib/playlist/format/simple_text.rb
+- lib/playlist/format/xspf.rb
+- lib/playlist/track.rb
+- lib/playlist/version.rb
+- playlist.gemspec
+homepage: https://github.com/njh/ruby-playlist
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Convert playlists between different formats
+test_files: []