listlace 0.0.3 → 0.0.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    listlace (0.0.2)
+    listlace (0.0.3)
       activerecord
       activesupport
       open4

data/README

@@ -39,7 +39,7 @@ The only way to populate the database right
 now is to import your iTunes library.
 That goes a little something like this:
 
-  >> import_from_itunes "/Users/jeremy/Music/iTunes/iTunes Music Library.xml"
+  >> import :itunes, "/Users/jeremy/Music/iTunes/iTunes Music Library.xml"
 
 Now you can play your music.
 
@@ -75,3 +75,12 @@ itself will start playing the queue.
 * queue
   - q: append some tracks to the queue, or get the queue
   - clear: clear the queue
+  - shuffle: shuffle the songs in the queue
+  - sort: sort the songs in the queue however you want
+* library
+  - import: import another program's music library
+  - wipe_library: remove all tracks and playlists from the library
+
+-- selectors
+
+...

data/bin/listlace

@@ -2,7 +2,6 @@
 
 require "bundler/setup"
 require "pry"
-require "fileutils"
 require "listlace"
 
 unless File.exists? Listlace::DIR

data/lib/listlace/commands/library.rb

@@ -2,41 +2,84 @@ require "plist"
 require "active_support/core_ext/string"
 
 module Listlace
-  def import_from_itunes(path_to_xml)
-    data = Plist::parse_xml(path_to_xml)
-
-    whitelist = Track.new.attributes.keys
-    data["Tracks"].each do |track_id, row|
-      # row already contains a hash of attributes almost ready to be passed to
-      # ActiveRecord. We just need to modify the keys, e.g. change "Play Count"
-      # to "play_count".
-      attributes = row.inject({}) do |acc, (key, value)|
-        attribute = key.gsub(" ", "").underscore
-        attribute = "original_id" if attribute == "track_id"
-        acc[attribute] = value if whitelist.include? attribute
-        acc
-      end
+  # Imports the music library from another program. Currently only iTunes is
+  # supported.
+  def import(from, path)
+    if not File.exists?(path)
+      puts "File '%s' doesn't exist." % [path]
+    elsif from == :itunes
+      puts "Parsing XML..."
+      data = Plist::parse_xml(path)
 
-      # change iTunes' URL-style locations into simple paths
-      if attributes["location"] && attributes["location"] =~ /^file:\/\//
-        attributes["location"] = CGI::unescape(attributes["location"].sub(/^file:\/\/localhost/, ""))
-      end
+      puts "Importing #{data['Tracks'].length} tracks..."
+      num_tracks = 0
+      whitelist = Track.new.attributes.keys
+      data["Tracks"].each do |track_id, row|
+        # row already contains a hash of attributes almost ready to be passed to
+        # ActiveRecord. We just need to modify the keys, e.g. change "Play Count"
+        # to "play_count".
+        attributes = row.inject({}) do |acc, (key, value)|
+          attribute = key.gsub(" ", "").underscore
+          attribute = "original_id" if attribute == "track_id"
+          acc[attribute] = value if whitelist.include? attribute
+          acc
+        end
 
-      track = Track.new(attributes)
-      track.save!
-    end
+        # change iTunes' URL-style locations into simple paths
+        if attributes["location"] && attributes["location"] =~ /^file:\/\//
+          attributes["location"].sub! /^file:\/\/localhost/, ""
+
+          # CGI::unescape changes plus signs to spaces. This is a work around to
+          # keep the plus signs.
+          attributes["location"].gsub! "+", "%2B"
+
+          attributes["location"] = CGI::unescape(attributes["location"])
+        end
 
-    data["Playlists"].each do |playlist_data|
-      playlist = Playlist.new(name: playlist_data["Name"])
-      playlist.save!
+        track = Track.new(attributes)
 
-      playlist_data["Playlist Items"].map(&:values).flatten.each.with_index do |track_id, i|
-        playlist_item = PlaylistItem.new(position: i)
-        playlist_item.playlist = playlist
-        if playlist_item.track = Track.where(original_id: track_id).first
-          playlist_item.save!
+        if track.kind =~ /audio/
+          if track.save
+            num_tracks += 1
+          end
+        else
+          puts "[skipping non-audio file]"
         end
       end
+      puts "Imported #{num_tracks} tracks successfully."
+
+      puts "Importing #{data['Playlists'].length} playlists..."
+      num_playlists = 0
+      data["Playlists"].each do |playlist_data|
+        playlist = Playlist.new(name: playlist_data["Name"])
+
+        if ["Library", "Music", "Movies", "TV Shows", "iTunes DJ"].include? playlist.name
+          puts "[skipping \"#{playlist.name}\" playlist]"
+        else
+          if playlist.save
+            playlist_data["Playlist Items"].map(&:values).flatten.each.with_index do |track_id, i|
+              playlist_item = PlaylistItem.new(position: i)
+              playlist_item.playlist = playlist
+              if playlist_item.track = Track.where(original_id: track_id).first
+                playlist_item.save!
+              end
+            end
+            num_playlists += 1
+          end
+        end
+      end
+      puts "Imported #{num_playlists} playlists successfully."
+    end
+  end
+
+  # Wipes the database. With no arguments, it just asks "Are you sure?" without
+  # doing anything. To actually wipe the database, pass :yes_im_sure.
+  def wipe_library(are_you_sure = :nope)
+    if are_you_sure == :yes_im_sure
+      Database.wipe
+      puts "Library wiped."
+    else
+      puts "Are you sure? If you are, then type: wipe_library :yes_im_sure"
     end
   end
 end

data/lib/listlace/commands/playback.rb

@@ -48,8 +48,8 @@ module Listlace
   end
 
   # Go back one song in the queue.
-  def back
-    if $player.back
+  def back(n = 1)
+    if $player.back(n)
       status
     else
       puts "End of queue."
@@ -57,8 +57,8 @@ module Listlace
   end
 
   # Go directly to the next song in the queue.
-  def skip
-    if $player.skip
+  def skip(n = 1)
+    if $player.skip(n)
       status
     else
       puts "End of queue."
@@ -114,9 +114,9 @@ module Listlace
           num_tracks = q.length
           repeat_one = $player.repeat_mode == :one ? REPEAT_SYMBOL : ""
           repeat_all = $player.repeat_mode == :all ? REPEAT_SYMBOL : ""
-          puts "Playlist: queue (%d%s / %d%s)" % [track_number, repeat_one, num_tracks, repeat_all]
+          puts "Playlist: %s (%d%s / %d%s)" % [q.name, track_number, repeat_one, num_tracks, repeat_all]
         else
-          puts "Playlist: queue (%d songs)" % [q.length]
+          puts "Playlist: %s" % [q]
         end
       when :playing
         if $player.started?

data/lib/listlace/commands/queue.rb

@@ -1,21 +1,10 @@
 module Listlace
-  # The queue command. Simply appends tracks to the queue. Tracks can be
-  # specified by a single Track, a Playlist, an ActiveRecord::Relation, or an
-  # Array containing any of the above. With or without arguments, it returns the
-  # queue as an Array of Tracks, so this can be used as an accessor method.
-  def q(*tracks)
-    tracks.each do |playlist_or_track|
-      case playlist_or_track
-      when Track
-        $player.queue playlist_or_track
-      when Playlist
-        q *playlist_or_track.tracks
-      when Array
-        q *playlist_or_track
-      when ActiveRecord::Relation
-        q *playlist_or_track.all
-      end
-    end
+  # The queue command. Simply appends tracks to the queue. It creates a playlist
+  # with the arguments you give it, so anything you can pass to the playlist()
+  # method you can pass to this. It returns the queue, so you can use this
+  # method as an accessor by not passing any arguments.
+  def q(*args)
+    $player.queue playlist(*args)
     $player.queue
   end
 
@@ -25,11 +14,38 @@ module Listlace
     puts "Queue cleared."
   end
 
+  # Shuffles the queue, keeping the current track at the top.
   def shuffle
-
+    $player.shuffle
+    puts "Shuffled."
   end
 
-  def sort(by = :artist_asc_album_asc_track_number_asc)
-
+  # Sorts the queue by a list of fields and directions in the form of a symbol,
+  # or uses the proc given to it, which should take two Tracks and return -1, 0,
+  # or 1.
+  def sort(by = :artist_asc_album_asc_track_number_asc, &proc)
+    if proc
+      $player.sort(&proc)
+    else
+      $player.sort do |a, b|
+        result = 0
+        by.to_s.scan(/([a-z_]+?)_(asc|desc)(?:_|$)/).each do |column, direction|
+          a_value = a.send(column)
+          b_value = b.send(column)
+          a_value = a_value.downcase if a_value.respond_to? :downcase
+          b_value = b_value.downcase if b_value.respond_to? :downcase
+          dir = (direction == "desc") ? -1 : 1
+          if a_value != b_value
+            if a_value.nil? || b_value.nil?
+              result = dir
+            else
+              result = (a_value <=> b_value) * dir
+            end
+            break
+          end
+        end
+        result
+      end
+    end
   end
 end

data/lib/listlace/commands/selectors.rb

@@ -0,0 +1,186 @@
+module Listlace
+  STRING_SELECTORS = %w(name artist composer album album_artist genre comments location)
+  INTEGER_SELECTORS = %w(disc_number disc_count track_number track_count year bit_rate sample_rate play_count skip_count rating)
+
+  STRING_SELECTORS.each do |column|
+    define_method(column) do |*args|
+      options = args.last.is_a?(Hash) ? args.pop : {}
+
+      playlists = args.map { |query| string_selector(column, query, options) }
+      playlist *playlists
+    end
+  end
+
+  INTEGER_SELECTORS.each do |column|
+    define_method(column) do |*args|
+      playlists = args.map { |arg| integer_selector(column, arg) }
+      playlist *playlists
+    end
+  end
+
+  # rename the "name" selector to "song"
+  alias_method :song, :name
+  remove_method :name
+
+  # The length selector is an integer selector for the length of a track. A
+  # plain integer given to it represents the number of seconds. It can also take
+  # a String in the format "1:23", to represent 83 seconds, for example. These
+  # can be part of a Range, as usual: "1:23".."2:05", for example.
+  def length(*args)
+    normalize = lambda do |value|
+      case value
+      when String
+        Track.parse_time(value)
+      when Integer
+        value * 1000
+      when Range
+        (normalize.(value.begin))..(normalize.(value.end))
+      end
+    end
+
+    playlists = args.map do |arg|
+      if arg.is_a? Hash
+        key = arg.keys.first
+        arg[key] = normalize.(arg[key])
+      else
+        arg = normalize.(arg)
+      end
+
+      # If they want tracks of length "0:05", for example, we need to look for
+      # tracks that are from 5000 to 5999 milliseconds long.
+      if arg.is_a? Integer
+        arg = (arg)..(arg + 999)
+      end
+
+      integer_selector(:total_time, arg)
+    end
+
+    playlist *playlists
+  end
+
+  # Makes a playlist out of tracks that match the string query on the given
+  # column. It's SQL underneath, so you can use % and _ as wildcards in the
+  # query. By default, % wildcards are inserted on the left and right of your
+  # query. Use the :match option to change this:
+  #
+  #   :match => :middle   "%query%"   (default)
+  #   :match => :left     "query%"
+  #   :match => :right    "%query"
+  #   :match => :exact    "query"
+  #
+  # This method shouldn't have to be used directly. Many convenient methods are
+  # generated for you, one for each string field you may want to select on.
+  # These are: artist, composer, album, album_artist, genre, comments, location.
+  # For example:
+  #
+  #   artist :muse, match: :exact #=> playlist (108 tracks)
+  #   composer :rachmanino #=> playlist (33 tracks)
+  #
+  # To match the name of a track, use song:
+  #
+  #   song "frontier psychiatrist" #=> playlist (1 track)
+  #
+  def string_selector(column, query, options = {})
+    options[:match] ||= :middle
+
+    query = {
+      exact: "#{query}",
+      left: "#{query}%",
+      right: "%#{query}",
+      middle: "%#{query}%"
+    }[options[:match]]
+
+    tracks = Track.arel_table
+    PlaylistArray.new(Track.where(tracks[column].matches(query)).all)
+  end
+
+  # Makes a playlist out of tracks that satisfy certain conditions on the given
+  # integer column. You can pass an exact value to check for equality, a range,
+  # or a hash that specifies greater-than and less-than options like this:
+  #
+  #   integer_selector :year, greater_than: 2000 #=> playlist (3555 tracks)
+  #
+  # The possible operators, with their shortcuts, are:
+  #
+  #   :greater_than / :gt
+  #   :less_than / :lt
+  #   :greater_than_or_equal / :gte
+  #   :less_than_or_equal / :lte
+  #   :not_equal / :ne
+  #
+  # Note: You can only use one of these operators at a time. If you want a
+  # range, use a Range.
+  #
+  # This method shouldn't have to be used directly. Many convenient methods are
+  # generated for you, one for each integer field you may want to select on.
+  # These are: disc_number, disc_count, track_number, track_count, year,
+  # bit_rate, sample_rate, play_count, skip_count, rating, length. Length is
+  # special, it can take any of the time formats that the seek command can. For
+  # example:
+  #
+  #   year 2010..2012 #=> playlist (1060 tracks)
+  #   length gt: "4:00" #=> playlist (2543 tracks)
+  #
+  def integer_selector(column, value_or_options)
+    if value_or_options.is_a? Hash
+      operator = {
+        greater_than: ">",
+        gt: ">",
+        less_than: "<",
+        lt: "<",
+        greater_than_or_equal: ">=",
+        gte: ">=",
+        less_than_or_equal: "<=",
+        lte: "<=",
+        not_equal: "<>",
+        ne: "<>"
+      }[value_or_options.keys.first]
+      tracks = Track.where("tracks.#{column} #{operator} ?", value_or_options.values.first)
+      PlaylistArray.new(tracks.all)
+    else
+      tracks = Track.arel_table
+      PlaylistArray.new(Track.where(column => value_or_options).all)
+    end
+  end
+
+  # Creates or looks up a playlist. You can pass any number of multiple types of
+  # objects to make a playlist:
+  #
+  #   Track: Makes a playlist with one track
+  #   ActiveRecord::Relation: Makes a playlist out of the resulting Track or Playlist records
+  #   Symbol or String: Tries to retrieve a saved playlist with the given name.
+  #     If it can't find one, it creates a new one.
+  #
+  # You can also pass in the results of a selector. In this way you can create a
+  # playlist out of many smaller pieces.
+  #
+  # If given no arguments, it returns a blank playlist.
+  #
+  def playlist(*args)
+    args.map do |object|
+      case object
+      when Track
+        PlaylistArray.new([object])
+      when Playlist
+        PlaylistArray.new([object.tracks.all], object.name)
+      when PlaylistArray
+        object
+      when Array
+        playlist *object
+      when ActiveRecord::Relation
+        if object.table.name == "tracks"
+          PlaylistArray.new([object.all])
+        elsif object.table.name == "playlists"
+          playlist *object.all
+        end
+      when Symbol, String
+        playlists = Playlist.arel_table
+        if playlist = Playlist.where(playlists[:name].matches(object.to_s)).first
+          PlaylistArray.new(playlist)
+        else
+          PlaylistArray.new([], object)
+        end
+      end
+    end.inject(:+)
+  end
+end

data/lib/listlace/database.rb

@@ -13,6 +13,16 @@ module Listlace
       File.exists? PATH
     end
 
+    def delete
+      FileUtils.rm PATH
+    end
+
+    def wipe
+      delete
+      connect
+      generate_schema
+    end
+
     def generate_schema
       ActiveRecord::Schema.define do
         create_table :tracks do |t|

data/lib/listlace/models/track.rb

@@ -7,11 +7,6 @@ module Listlace
       Track.format_time(total_time)
     end
 
-    def play
-      $player.queue = [self]
-      Listlace.play
-    end
-
     def self.format_time(milliseconds)
       total_seconds = milliseconds / 1000
 
@@ -25,5 +20,13 @@ module Listlace
         "%d:%02d" % [minutes, seconds]
       end
     end
+
+    def self.parse_time(string)
+      parts = string.split(":").map(&:to_i)
+      parts = [0] + parts if parts.length == 2
+      hours, minutes, seconds = parts
+      seconds = hours * 3600 + minutes * 60 + seconds
+      seconds * 1000
+    end
   end
 end

data/lib/listlace/player.rb

@@ -7,7 +7,7 @@ module Listlace
 
     def initialize
       @mplayer = nil
-      @queue = []
+      @queue = PlaylistArray.new([], :queue)
       @current_track = nil
       @current_track_index = nil
       @paused = false
@@ -15,14 +15,14 @@ module Listlace
       @repeat_mode = false
     end
 
-    def queue(track = nil)
-      @queue << track if track.is_a? Track
+    def queue(playlist = nil)
+      @queue << playlist if playlist
       @queue.dup
     end
 
     def clear
       stop
-      @queue = []
+      @queue.clear
     end
 
     def empty?
@@ -88,12 +88,12 @@ module Listlace
       change_track(0)
     end
 
-    def back
-      change_track(-1)
+    def back(n = 1)
+      change_track(-n)
     end
 
-    def skip
-      change_track(1)
+    def skip(n = 1)
+      change_track(n)
     end
 
     def seek(where)
@@ -103,10 +103,7 @@ module Listlace
       when Range
         @mplayer.command("seek %d 2" % [where.begin * 60 + where.end], expect_answer: true)
       when String
-        parts = where.split(":").map(&:to_i)
-        parts = [0] + parts if parts.length == 2
-        hours, minutes, seconds = parts
-        @mplayer.command("seek %d 2" % [hours * 3600 + minutes * 60 + seconds], expect_answer: true)
+        @mplayer.command("seek %d 2" % [Track.parse_time(where) / 1000], expect_answer: true)
       when Hash
         if where[:abs]
           if where[:abs].is_a? Integer
@@ -131,6 +128,23 @@ module Listlace
       @mplayer.command("speed_set %f" % [speed], expect_answer: true)
     end
 
+    def shuffle
+      if started?
+        @queue.shuffle_except! @current_track
+        @current_track_index = 0
+      else
+        @queue.shuffle!
+      end
+    end
+
+    def sort(&by)
+      @queue.sort! &by
+
+      if started?
+        @current_track_index = @queue.index(@current_track)
+      end
+    end
+
     def current_time
       answer = @mplayer.command "get_time_pos", expect_answer: true
       if answer =~ /^ANS_TIME_POSITION=([0-9.]+)$/

data/lib/listlace/playlist_array.rb

@@ -0,0 +1,82 @@
+module Listlace
+  class PlaylistArray < Array
+    attr_accessor :name, :model
+
+    def initialize(tracks_or_playlist = [], name = :playlist)
+      if tracks_or_playlist.is_a? Playlist
+        replace tracks_or_playlist.tracks.to_a
+        @name = tracks_or_playlist.name
+        @model = tracks_or_playlist
+      else
+        replace tracks_or_playlist.to_a
+        @name = name.to_s
+        @model = nil
+      end
+    end
+
+    def save(name = nil)
+      if @model
+        @model.playlist_items.destroy_all
+        @model.name = @name = name if name
+      else
+        @name = name if name
+        @model = Playlist.new(name: @name)
+      end
+
+      if @model.save
+        each.with_index do |track, i|
+          item = PlaylistItem.new(position: i)
+          item.playlist = @model
+          item.track = track
+          item.save!
+        end
+        @model
+      else
+        false
+      end
+    end
+
+    def <<(other)
+      if other.is_a? Track
+        super
+      else
+        other.each do |track|
+          self << track
+        end
+      end
+    end
+
+    def +(other)
+      result = self.dup
+      result << Listlace.playlist(other)
+      result
+    end
+
+    def &(other)
+      replace super
+    end
+
+    def shuffle_except(track)
+      ary = dup
+      dup.shuffle_except! track
+      dup
+    end
+
+    def shuffle_except!(track)
+      replace([track] + (self - [track]).shuffle)
+    end
+
+    def to_s
+      "%s (%d track%s)" % [@name || "playlist", length, ("s" if length != 1)]
+    end
+
+    def inspect
+      to_s
+    end
+
+    # override pry
+    def pretty_inspect
+      inspect
+    end
+  end
+end

data/lib/listlace.rb

@@ -8,10 +8,12 @@ end
 require "open4"
 require "shellwords"
 require "active_record"
+require "fileutils"
 
 require "listlace/database"
 require "listlace/player"
 require "listlace/mplayer"
+require "listlace/playlist_array"
 
 require "listlace/models/track"
 require "listlace/models/playlist"
@@ -23,7 +25,6 @@ require "listlace/commands/selectors"
 require "listlace/commands/volume"
 require "listlace/commands/queue"
 
-# gotta ged rid of this global sometime
 $player = Listlace::Player.new
 
 at_exit do

data/listlace.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = "listlace"
-  s.version = "0.0.3"
-  s.date = "2012-08-24"
+  s.version = "0.0.4"
+  s.date = "2012-08-25"
   s.summary = "A music player in a REPL."
   s.description = "Listlace is a music player which is interacted with through a Ruby REPL."
   s.author = "Jeremy Ruten"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: listlace
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-24 00:00:00.000000000 Z
+date: 2012-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -147,6 +147,7 @@ files:
 - lib/listlace/models/track.rb
 - lib/listlace/mplayer.rb
 - lib/listlace/player.rb
+- lib/listlace/playlist_array.rb
 - lib/listlace.rb
 homepage: http://github.com/yjerem/listlace
 licenses: