cmus 2.0.4 → 2.0.4.1

data/README.md

@@ -0,0 +1,3 @@
+cmus - Ruby controller
+======================
+This is just a simple library to control [cmus](http://cmus.sourceforge.net/).

data/lib/cmus/controller.rb

@@ -16,6 +16,9 @@ require 'cmus/controller/status'
 
 module Cmus
 
+# This is the main class to manage cmus.
+#
+# The class also acts as a UNIXSocket if needed.
 class Controller
 	attr_reader :path
 
@@ -32,24 +35,29 @@ class Controller
 		@socket.__send__ id, *args, &block
 	end
 
+	# clear the context
 	def clear (context = :playlist)
 		puts "clear -#{context.to_s[0]}"
 	end
 
+	# add a file to the context
 	def add (context = :playlist, *paths)
 		paths.flatten.compact.uniq.each {|path|
 			puts "clear -#{context.to_s[0]} #{path}"
 		}
 	end
 
+	# returns the toggle facilities
 	def toggle
 		Toggle.new(self)
 	end
 
+	# returns the player facilities
 	def player
 		Player.new(self)
 	end
 
+	# returns the status
 	def status
 		Status.new(self)
 	end

data/lib/cmus/controller/player.rb

@@ -17,6 +17,7 @@ class Player
 		@controller = controller
 	end
 
+	# play the current selection or the passed file
 	def play (file = nil)
 		if file
 			controller.puts "player-play #{File.real_path(File.expand_path(file))}"
@@ -25,28 +26,41 @@ class Player
 		end
 	end
 
+	# pause the current song
 	def pause
 		return if controller.status == :paused
 
 		controller.puts 'player-pause'
 	end
 
+	# unpause the current song
+	def unpause
+		return unless controller.status == :paused
+
+		controller.puts 'player-pause'
+	end
+
+	# stop the current song
 	def stop
 		controller.puts 'player-stop'
 	end
 
+	# go to the next song in the playlist
 	def next
 		controller.puts 'player-next'
 	end
 
+	# go to the previous song in the playlist
 	def prev
 		controller.puts 'player-prev'
 	end
 
+	# change the volume
 	def volume (volume)
 		controller.puts "vol #{volume}"
 	end
 
+	# seek to the passed second
 	def seek (second)
 		controller.puts "seek #{second}"
 	end

data/lib/cmus/controller/toggle.rb

@@ -17,14 +17,17 @@ class Toggle
 		@controller = controller
 	end
 
+	# toggle the repeat status
 	def repeat
 		controller.puts 'toggle repeat'
 	end
 
+	# toggle the shuffle status
 	def shuffle
 		controller.puts 'toggle shuffle'
 	end
 
+	# toggle the pause status
 	def pause
 		controller.puts 'player-pause'
 	end

data/lib/cmus/version.rb

@@ -10,6 +10,6 @@
 
 module Cmus
 	def self.version
-		'2.0.4'
+		'2.0.4.1'
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cmus
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -18,6 +18,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/cmus-remote.rb
 - cmus.gemspec
 - lib/cmus.rb