subcl 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eafcc67f7917cd55aa322705366dc3361e7e6545
-  data.tar.gz: deb40883dc7d4f41a3f3ce57880a25bf2c11b1be
+  metadata.gz: fb19261a8a56302438bd138708e9e12384b91da6
+  data.tar.gz: 0d2078fd2198df4d12232547d4eadb524e2ff925
 SHA512:
-  metadata.gz: 476ac05a7de41e4079078e7a2a6e4d1d5c20d5fa5c29766176a0eabd3eda3b58faa2c6bf60a666dcc7bfaa19dff892d19e8a9b3849ed578eee8f21516b44b3ab
-  data.tar.gz: 7ac85d384fd3da414123433db4bb59a64995e375fa287d73faf7a7797ad0aaf317af8cebf71493f3d9318ccae12a7a685ec00d9cd31237110c09b180510b5bd0
+  metadata.gz: 14ecdf1251f53bd8f92155064d7a3c5cefa6a29a07e54eebcbd6007b5a96a65d72e13607936eab27ad4004e140308588b83f42d4afc565ab03274991430b58ab
+  data.tar.gz: 88c24c10b931983f6750b267c0ae0250719d81668ab65f4f827f9f0aafe78da1c048eb3385c81544173ee50cccaec911adbca0e99cc3caccbc3299fbf6b31138

data/lib/subcl.rb

@@ -1,3 +1,5 @@
+require 'subcl/version'
+
 require 'subcl/configs'
 require 'subcl/player'
 require 'subcl/notify'
@@ -5,9 +7,10 @@ require 'subcl/picker'
 require 'subcl/runner'
 require 'subcl/song'
 require 'subcl/subcl'
-require 'subcl/subcl_error'
 require 'subcl/subsonic_api'
 
+require 'subcl/subcl_error'
+
 require 'logger'
 
 LOGGER = Logger.new(STDERR)

data/lib/subcl/configs.rb

@@ -1,18 +1,29 @@
+require 'fileutils'
+
 class Configs
 
   attr_accessor :configs
 
   REQUIRED_SETTINGS = %i{ server username password }
-  OPTIONAL_SETTINGS = %i{ max_search_results notify_method random_song_count }
+  OPTIONAL_SETTINGS = %i{ max_search_results notify_method random_song_count wildcard_order play_any_on_unknown_command}
+  DEFAULT_PATH = File.expand_path('~/.subcl')
+  DEFAULT_CONFIG = File.dirname(__FILE__) + "/../../share/subcl.default"
+
+  WILDCARD_ORDER_ITEMS = %i{ song album artist playlist }
 
-  def initialize(file = '~/.subcl')
+  def initialize(file = DEFAULT_PATH)
     @configs = {
       :notifyMethod => "auto",
+      :play_any_on_unknown_command => false
     }
 
-    @filename = File.expand_path(file)
-    unless File.file?(@filename)
-      raise "Config file not found"
+    @file = File.expand_path(file)
+    unless File.file?(@file)
+      if @file == DEFAULT_PATH and Configs.tty?
+        ask_create_config
+      else
+        raise "Config file '#{@file}' not found"
+      end
     end
 
     read_configs
@@ -20,10 +31,13 @@ class Configs
 
   def read_configs
     settings = REQUIRED_SETTINGS + OPTIONAL_SETTINGS
-    open(@filename).each_line do |line|
+    open(@file).each_line do |line|
       next if line.start_with? '#'
+      next if line.chomp.empty?
+
+      key, value = line.split(' ', 2)
+      value.chomp!
 
-      key, value = line.split(' ')
       key = key.to_sym
       if settings.include? key
         @configs[key] = value
@@ -32,6 +46,8 @@ class Configs
       end
     end
 
+    validate_wildcard_order
+
     REQUIRED_SETTINGS.each do |setting|
       if @configs[setting].nil?
         raise "Missing setting '#{setting}'"
@@ -39,6 +55,30 @@ class Configs
     end
   end
 
+  def validate_wildcard_order
+    if @configs[:wildcard_order]
+      raw_order = @configs[:wildcard_order]
+      final_order = []
+      raw_order.split(',').each do |item|
+        item = item.to_sym
+        if WILDCARD_ORDER_ITEMS.include? item
+          final_order << item
+        else
+          LOGGER.warn("Invalid wildcard_order item #{item}")
+        end
+      end
+
+      WILDCARD_ORDER_ITEMS.each do |item|
+        unless final_order.include? item
+          LOGGER.warn("wildcard_order is missing #{item}")
+          final_order << item
+        end
+      end
+
+      @configs[:wildcard_order] = final_order
+    end
+  end
+
   def [](key)
     raise "Undefined setting #{key}" unless @configs.has_key? key
     @configs[key]
@@ -58,4 +98,18 @@ class Configs
   def to_hash
     @configs
   end
+
+  def ask_create_config
+    $stderr.puts "No configuration found at #{DEFAULT_PATH}. Create one? [y/n]"
+    if $stdin.gets.chomp =~ /[yY]/
+      FileUtils.cp(DEFAULT_CONFIG, DEFAULT_PATH)
+      $stderr.puts "Created #{DEFAULT_PATH}"
+      exit 0
+    end
+    exit 4
+  end
+
+  def self.tty?
+    system('tty -s')
+  end
 end

data/lib/subcl/picker.rb

@@ -9,10 +9,14 @@ class Picker
   def pick
     choices = {}
 
+    #TODO add type column when multiple types are available
+
+    counter_padding = @available.length.to_s.length
     i = 1
     @available.each do |elem|
       choices[i] = elem
-      $stderr.print "[#{i}] "
+      #TODO add padding for numbers with one digit
+      $stderr.print "[#{i.to_s.rjust(counter_padding)}] "
       yield(elem)
       i = i + 1
     end

data/lib/subcl/player.rb

@@ -42,7 +42,15 @@ class Player < SimpleDelegator
 
   # if mpd is playing, pause it. Otherwise resume playback
   def toggle
-    @mpd.pause = @mpd.playing? ? 1 : 0
+    if @mpd.playing?
+      @mpd.pause = 1
+    else
+      # experimental hack: I think this forces mpd to start downloading the stream again.
+      # this should prevent a bug that fails to resume streams after pausing
+      # TODO might make this configurable
+      @mpd.seek(@mpd.status[:elapsed].to_i)
+      @mpd.pause = 0
+    end
   end
 
   def pause

data/lib/subcl/runner.rb

@@ -63,11 +63,11 @@ class Runner
         @options[:current] = true
       end
       opts.on('-h', '--help', 'Display this screen') do
-        out_stream.puts opts
+        @options[:out_stream].puts opts
         exit
       end
       opts.on("--version", "Print version information") do
-        out_stream.puts Configs.new[:app_version]
+        @options[:out_stream].puts Subcl::VERSION
         exit
       end
 
@@ -109,6 +109,8 @@ class Runner
       subcl.queue(arg, :playlist, {:play => true, :clear => true})
     when /^play-random$|^r$/
       subcl.queue(arg, :randomSong, {:play => true, :clear => true})
+    when /^play-any$|^pn$|^p$/
+      subcl.queue(arg, :any, {:play => true, :clear => true})
     when /^queue-next-song$|^ns$/
       subcl.queue(arg, :song, {:insert => true})
     when /^queue-next-artist$|^nr$/
@@ -117,6 +119,8 @@ class Runner
       subcl.queue(arg, :album, {:insert => true})
     when /^queue-next-playlist$|^np$/
       subcl.queue(arg, :playlist, {:insert => true})
+    when /^queue-next-any$|^nn$|^n$/
+      subcl.queue(arg, :any, {:insert => true})
     when /^queue-last-song$|^ls$/
       subcl.queue(arg, :song)
     when /^queue-last-artist$|^lr$/
@@ -125,6 +129,8 @@ class Runner
       subcl.queue(arg, :album)
     when /^queue-last-playlist$|^lp$/
       subcl.queue(arg, :playlist)
+    when /^queue-last-any$|^ln$|^l$/
+      subcl.queue(arg, :any)
     when "albumart-url"
       arg = nil if arg.empty?
       @options[:out_stream].puts subcl.albumart_url(arg)
@@ -137,7 +143,11 @@ class Runner
         #pass through for player commands
         subcl.send(command, [])
       rescue NoMethodError
-        unknown(command)
+        if subcl.configs[:play_any_on_unknown_command]
+          subcl.queue(args.join(" "), :any, {:play => true, :clear => true})
+        else
+          unknown(command)
+        end
       end
     end
   end

data/lib/subcl/subcl.rb

@@ -1,6 +1,6 @@
 
 class Subcl
-  attr_accessor :player, :api, :notifier
+  attr_accessor :player, :api, :notifier, :configs
 
   def initialize(options = {})
     #TODO merge options and configs
@@ -9,7 +9,8 @@ class Subcl
       :tty => true,
       :insert => false,
       :out_stream => STDOUT,
-      :err_stream => STDERR
+      :err_stream => STDERR,
+      :wildcard_order => %i{playlist album artist song}
     }.merge! options
 
     @out = @options[:out_stream]
@@ -36,7 +37,7 @@ class Subcl
         @out.puts sprintf "%-20.20s %-20.20s %-20.20s %-4.4s", song[:title], song[:artist], song[:album], song[:year]
       },
       :album => proc { |album|
-        @out.puts sprintf "%-30.30s %-30.30s %-4.4s", album[:name], album[:artist], album[:year]
+        @out.puts sprintf "%-30.30s %-30.30s  %-4.4s", album[:name], album[:artist], album[:year]
       },
       :artist => proc { |artist|
         @out.puts "#{artist[:name]}"
@@ -44,8 +45,11 @@ class Subcl
       :playlist => proc { |playlist|
         @out.puts "#{playlist[:name]} by #{playlist[:owner]}"
       },
+      :any => proc { |thing|
+        #TODO this works, but looks confusing when multiple types are displayed
+        @display[thing[:type]].call(thing)
+      }
     }
-
   end
 
   def albumart_url(size = nil)
@@ -80,8 +84,9 @@ class Subcl
               rescue ArgumentError
                 raise ArgumentError, "random-songs takes an integer as argument"
               end
-            else #song, album, artist, playlist
+            else #song, album, artist, playlist, any
               entities = @api.search(query, type)
+              entities.sort!(&any_sorter(query)) if type == :any
               entities = invoke_picker(entities, &@display[type])
               @api.get_songs(entities)
             end
@@ -99,6 +104,34 @@ class Subcl
     @player.play if args[:play]
   end
 
+  #returns a sorter proc for two hashes with the attribute :type and :name
+  #
+  #it will use split(" ") on query and then count how many words of query each
+  #:name contains. If two hashes have the same amount of query words,
+  #@options[:wildcard_order] is used
+  #
+  #the closest matches will be at the beginning
+  #
+  def any_sorter(query)
+    #TODO do things with query! find the things that match the query the most
+    order = @options[:wildcard_order]
+    lambda do |e1, e2|
+      cmp = match_score(e1, query) <=> match_score(e2, query)
+      if cmp == 0
+        out = order.index(e1[:type]) <=> order.index(e2[:type])
+        out
+      else
+        -cmp
+      end
+    end
+  end
+
+  def match_score(entity, query)
+    query.split(' ').inject(0) do |memo, word|
+      memo + (entity[:name].downcase.include?(word.downcase) ? 1 : 0)
+    end
+  end
+
   def print(name, type)
     entities = @api.search(name, type)
     no_matches(type) if entities.empty?
@@ -141,6 +174,7 @@ class Subcl
     return Picker.new(array).pick(&display_proc)
   end
 
+  #these methods will be passed through to the underlying player
   PLAYER_METHODS = %i{play pause toggle stop next previous rewind}
   def method_missing(name, args)
     raise NoMethodError unless PLAYER_METHODS.include? name

data/lib/subcl/subsonic_api.rb

@@ -151,22 +151,29 @@ class SubsonicAPI
       params[:songCount] = max
       params[:albumCount] = max
       params[:artistCount] = max
+      #TODO need to search for playlists too!
     else
       raise "Cannot search for type '#{type}'"
     end
 
     doc = query('search3.view', params)
 
-    %i{artist album song}.collect_concat do |entity_type|
+    results = %i{artist album song}.collect_concat do |entity_type|
       doc.elements.collect("subsonic-response/searchResult3/#{entity_type}") do |entity|
         entity = Hash[entity.attributes.collect{ |key, val| [key.to_sym, val]}]
         entity[:type] = entity_type
         if entity_type == :song
           entity[:stream_url] = stream_url(entity[:id])
+          entity[:name] = entity[:title]
         end
         entity
       end
     end
+
+    if type == :any
+      results += get_playlists(query)
+    end
+    return results
   end
 
   def query(method, params = {})

data/lib/subcl/version.rb

@@ -0,0 +1,3 @@
+class Subcl
+  VERSION = '1.1.2'
+end

data/share/subcl.default

@@ -0,0 +1,13 @@
+## Subcl Configuration
+## Lines started with # are ignored
+
+## Mandatory settings
+server http://demo.subsonic.org
+username guest5
+password guest
+
+## Optional settings
+#notify_method awesome-client
+#random_song_count 100
+#max_search_results
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: subcl
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Daniel Latzer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -61,7 +61,9 @@ files:
 - lib/subcl/subcl.rb
 - lib/subcl/subcl_error.rb
 - lib/subcl/subsonic_api.rb
+- lib/subcl/version.rb
 - share/icon.png
+- share/subcl.default
 homepage: https://github.com/Tourniquet/subcl
 licenses:
 - MIT