anyplayer 1.1.2 → 1.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db0d0a016e49bc83fdef8aa9aec374fc8c5c593569b3ff5d2d9270a05b493458
+  data.tar.gz: 28b16e0ffeb7d097da4432700ebccb2ce08bf682609695b64b7125b90450a6cb
+SHA512:
+  metadata.gz: 86bc595bacbe1256a03503ece20a14ff368c82955ed8bd168d6b8d68c7c4616909086ec5549ae3c0915a4155392b6bb4223ef9c3c257aa20c421874fdb171ceb
+  data.tar.gz: f3ccc7caac60e7fec74a9bc3dcf3270ec3b6ffd89e0454130e914774c82306b5751c98dc95f1dca0fe3ec7ecb58ae1dbfb2b0f4364f858d2e093a07e9763a064

data/.gitignore

@@ -1,4 +1,4 @@
 pkg/*
 *.gem
 *.bundle
-
+Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/.travis.yml

@@ -1,4 +1,3 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.7.0

data/CHANGELOG.md

@@ -0,0 +1,82 @@
+Changelog
+---------
+
+Anyplayer tries its best to follow Semantic Versioning.
+
+## Unreleased
+
+## v1.2.1 (2020-12-19)
+
+Fixes:
+
+- Remove rake executable in gemspec.
+
+## v1.2.0 (2020-10-08)
+
+Features:
+
+- When using mpd, fallback to the file name if there is no track name.
+
+Dependencies:
+
+- Drop Ruby 1.9.3 and 2.0.0 support.
+
+## v1.1.5 (2014-07-07)
+
+Bugfixes:
+
+- Better platform detection by letting players list the platforms
+  they are intended to work on (thanks @inspire22)
+
+## v1.1.4 (2014-07-07)
+
+Bugfixes:
+
+- Fix iTunes Windows support by moving iTunes first
+- New developement task "rake console"
+- Refactorisations & tests
+
+## v1.1.3 (2014-01-27)
+
+Bugfixes:
+
+- xmms2.0.8 support (thanks @ofa-)
+
+## v1.1.2 (2013-12-18)
+
+Bugfixes:
+
+- MIT License
+
+## v1.1.1 (2013-12-18)
+
+Bugfixes:
+
+- Better MPD support (thanks @nkoehring)
+- Encoding fixes
+
+## v1.1.0 (2013-10-27)
+
+Features:
+
+- Add Rdio Mac support (thanks @irosenb)
+
+## v1.0.0 (2013-07-26)
+
+First major release.
+
+## v0.0.4
+
+Unstable version.
+
+## v0.0.3
+
+Unstable version.
+
+## v0.0.2
+
+Unstable version.
+
+## v0.0.1
+
+Unstable version.

data/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+Contributing
+============
+
+All contributions are welcome! Head to the [Github issues](https://github.com/sunny/anyplayer/issues) to report bugs, questions or code.
+
+
+Submit code
+-----------
+
+1. Fork the repository on Github
+1. Create a topic branch
+1. Implement your feature and the accompanying tests
+1. Run `rake test` to make sure the tests are passing
+1. Add documentation for your feature or bug fix
+1. Add, commit, and push your changes
+1. Submit a pull request
+
+
+Versionning
+-----------
+
+This library aims to adhere to [Semantic Versioning 2.0](http://semver.org/).

data/Gemfile

@@ -1,7 +1,5 @@
 source "http://rubygems.org"
 
-gem "rake"
-
 # Gem dependencies in anyplayer.gemspec
 gemspec
 

data/README.md

@@ -43,8 +43,17 @@ a player is running
 Or in Ruby
 ----------
 
+In your Gemfile:
+
+```rb
+# Interact with the current music player
+gem "anyplayer"
+```
+
+In your code:
+
 ```ruby
-require 'anyplayer'
+require "anyplayer"
 player = Anyplayer::Selector.new.player
 
 player.launched? # => true
@@ -62,28 +71,20 @@ With the [So Nice](https://github.com/sunny/so-nice/) Web interface:
 ![So Nice Screenshot](https://github.com/sunny/so-nice/raw/gh-pages/screenshot.png)
 
 
-Development
+Contribute!
 -----------
 
-Use the `anyplayer` binary from source:
-
-```sh
-$ ruby -Ilib bin/anyplayer
-```
-
-Launch tests:
-
-```sh
-$ bundle exec rake test
-```
+All contributions are welcome! Head to the [Github issues](https://github.com/sunny/anyplayer/issues) to report bugs, questions or code. Also, check out `CONTRIBUTING.md`.
 
-Install from source:
+Here a few useful commands while developping:
 
 ```sh
-$ bundle exec rake install
+$ ruby -Ilib bin/anyplayer  # Use the anyplayer command-line from source
+$ bin/rake test             # Launch tests
+$ bin/rake install          # Install from source
+$ bin/rake console          # Launch console
 ```
 
-All contributions are welcome! Head to the [Github issues](https://github.com/sunny/anyplayer/issues) to report bugs, questions or code.
 
 License
 -------

data/Rakefile

@@ -7,6 +7,16 @@ task :default => :test
 
 Rake::TestTask.new do |t|
   t.libs << "test"
+  t.libs << "lib"
   t.pattern = "test/**/*_test.rb"
   t.verbose = true
 end
+
+# Via http://erniemiller.org/2014/02/05/7-lines-every-gems-rakefile-should-have/
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'anyplayer'
+  ARGV.clear
+  IRB.start
+end

data/anyplayer.gemspec

@@ -15,10 +15,12 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = ["anyplayer"]
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency 'ruby-mpd', '~> 0.3.0'
+
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'flexmock'
+  s.add_development_dependency 'rake'
 end

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/lib/anyplayer.rb

@@ -1,13 +1,20 @@
 require "timeout"
 
 module Anyplayer
+  # Ordering of the players should put the most-used players and the fastest to
+  # test at the top.
+  #
+  # iTunes Windows has been placed at the top because of some linux false
+  # positives.
+  # https://github.com/sunny/anyplayer/issues/8
+
   PLAYERS = %w(
+    itunes_windows
     rhythmbox
     mpd
     xmms2
     amarok
     itunes_mac
-    itunes_windows
     spotify_mac
     rdio_mac
   )
@@ -20,4 +27,3 @@ end
 require "anyplayer/player"
 require "anyplayer/selector"
 require "anyplayer/version"
-

data/lib/anyplayer/command_line.rb

@@ -4,12 +4,31 @@ require "anyplayer"
 module Anyplayer::CommandLine
   extend self
 
+  COMMANDS = %w(
+    playpause
+    play
+    pause
+    next
+    prev
+    voldown
+    volup
+    volume
+    track
+    artist
+    album
+    vote
+    name
+    launched
+    paused
+    playing
+  )
+
   def parse(argv)
     # Create a selector
     selector = Anyplayer::Selector.new
     if argv.first == "-v"
       selector.verbose = true
-      argv.pop
+      argv.shift
 
       $stderr.puts "anyplayer v#{Anyplayer::VERSION}"
     end
@@ -18,36 +37,47 @@ module Anyplayer::CommandLine
     player = selector.player
     abort "Error: no player connected.\n" + selector.errors.join("\n") if !player
 
-    # Call it
-    case argv.first
-    when "playpause" then player.playpause
-    when "play"      then player.play
-    when "pause"     then player.pause
-    when "next"      then player.next
-    when "prev"      then player.next
-    when "voldown"   then player.voldown
-    when "volup"     then player.volup
-    when "volume"    then puts player.volume
-    when "track"     then puts player.track
-    when "artist"    then puts player.artist
-    when "album"     then puts player.album
-    when "vote"      then player.vote
-    when "name"      then puts player.name
-    when "launched"  then exit(player.launched? ? 0 : 1)
-    when "playing"   then exit(player.playing? ? 0 : 1)
-    when "paused"    then exit(player.playing? ? 0 : 1)
+    # Call a command
+    if argv.empty?
+      usage(player)
     else
-      puts <<USAGE
-Usage: anyplayer [-v] [command]
+      command(player, argv.first)
+    end
+  end
 
-Where command is one of: playpause, play, pause, next, prev, voldown, volup,
-volume, track, artist, album, vote, name, launched.
+  private
 
-Player connected: #{player.name}.
-USAGE
-      exit(1)
+  # Call
+  def command(player, command)
+    response = call(player, command)
+
+    case response
+    when :undefined_command then usage(player)
+    when true then exit(0)
+    when false then exit(1)
+    when String, Numeric then puts response
+    end
+  end
+
+  # Call the method on the player
+  # Tries the boolean method as well
+  def call(player, command)
+    [command, "#{command}?"].each do |method|
+      method = method.to_sym
+      return player.send(method) if player.respond_to?(method)
     end
 
+    :undefined_command
   end
 
+  def usage(player)
+    $stderr.puts <<USAGE
+Usage: anyplayer [-v] [command]
+
+Where command is one of: #{COMMANDS.join(', ')}.
+
+Player connected: #{player.name}.
+USAGE
+    exit(1)
+  end
 end

data/lib/anyplayer/player.rb

@@ -1,4 +1,4 @@
-# Default Player class that is inherrited by all players.
+# Default Player class that is inherited by all players.
 #
 # All players should override these methods:
 #   launched? (return bool)
@@ -31,7 +31,12 @@ class Anyplayer::Player
   # Example:
   #     player.name # => iTunes
   def name
-    self.class.to_s.gsub(/^.*::/, '')
+    self.class.to_s.gsub(/^.*::/, "")
+  end
+
+  # Default paused is not playing
+  def paused?
+    !playing?
   end
 
   # Tells the player to toggle the pause state
@@ -65,11 +70,14 @@ class Anyplayer::Player
     reset_votes
   end
 
-  private
+  # Operating systems where this player should work
+  def platforms
+    [:mac, :windows, :linux, :unix]
+  end
 
-    def reset_votes
-      @votes = 0
-    end
+  private
 
+  def reset_votes
+    @votes = 0
+  end
 end
-

data/lib/anyplayer/players/amarok.rb

@@ -1,61 +1,67 @@
 class Anyplayer::Amarok < Anyplayer::Player
   def playpause
-    amarok 'PlayPause'
+    amarok "PlayPause"
   end
 
   def play
-    amarok 'Play'
+    amarok "Play"
   end
 
   def pause
-    amarok 'Pause'
+    amarok "Pause"
   end
 
   def prev
-    amarok 'Prev'
+    amarok "Prev"
     super
   end
 
   def next
-    amarok 'Next'
+    amarok "Next"
     super
   end
 
   def voldown
-    amarok 'VolumeDown 5'
+    amarok "VolumeDown 5"
   end
 
   def volup
-    amarok 'VolumeUp 5'
+    amarok "VolumeUp 5"
   end
 
   def volume
-    amarok 'VolumeGet'
+    amarok "VolumeGet"
   end
 
   def track
-    amarok_get_meta 'title'
+    amarok_get_meta "title"
   end
 
   def artist
-    amarok_get_meta 'artist'
+    amarok_get_meta "artist"
   end
 
   def album
-    amarok_get_meta 'album'
+    amarok_get_meta "album"
   end
 
   def launched?
-    not %x(qdbus org.kde.amarok 2>&1).match(/does not exist|command not found/)
+    not %x(qdbus org.kde.amarok 2>&1).match(
+      /does not exist|not found|cannot find the path specified/
+    )
+  end
+
+  def platforms
+    [:unix, :linux]
   end
 
   private
-    def amarok(command)
-      %x(qdbus org.kde.amarok /Player org.freedesktop.MediaPlayer.#{command}).rstrip
-    end
 
-    def amarok_get_meta(name)
-      amarok('GetMetadata').match(/#{name}: (\S.*)/)[1] rescue nil
-    end
-end
+  def amarok(command)
+    %x(qdbus org.kde.amarok /Player org.freedesktop.MediaPlayer.#{command}).rstrip
+  end
 
+  def amarok_get_meta(name)
+    amarok("GetMetadata").match(/#{name}: (\S.*)/)[1] rescue nil
+  end
+end