ruby-mpd-client 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8418f0f9f6feb888fefb0c1bba3dc1d8992ac221b6e9381278d27091b945a1e6
-  data.tar.gz: 65b8aa6e6f008f339de0766f4f06def5b0f6255db86c60997b0ace019557d240
+  metadata.gz: 887c1fa7271770fbfda6447e9366691137365f1d2e7464a7f6d84ad1c3192126
+  data.tar.gz: fb5d196d90b8cb64650dffe92f03063aa7a5e095d03a58adba4c13c12d22e23c
 SHA512:
-  metadata.gz: a954040ae3a4828b5b456d4d006ba02d2017b798a03249426db0661ff5e3c16fd439f581f59f03a543ef3db0eed0871183012352d155189b0b337f931163dc8a
-  data.tar.gz: ada812509e41842636a482d76821e2d75f2d72424410ff8572c29d399f9efc8b8cfdc4bdf9d7d1a36240f73472d1aa4fb86c9d0f3dc25d9b7d0aa813294ef490
+  metadata.gz: 28be28e2ad32e1f3d5d8d5dcbee86f3330ee9e8c68c67ffa7552236d6dddd6eab85797caf46c6ef4cbf9eb5daaa75f4a0bf69c3f21ea34ea92fc05eca40e50f0
+  data.tar.gz: 75e8a8efb06e740a309c541ef02b134b24f805b8d72fd2dc0bd3834b406db25bd248ca5a29e4a473733cd64a5fa87890b1e3e398d013fc57f8535c1551800498

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Metrics/LineLength:
+  Exclude:
+    - spec/server_dummy.rb
+
+Naming/FileName:
+  Exclude:
+    - 'lib/ruby-mpd-client.rb'

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
 - 2.3.0
-script: rake spec
+script: rake travis
 deploy:
   provider: rubygems
   api_key:

data/README.md

@@ -1,14 +1,21 @@
 # Ruby MPD client
 
-master: [![Build Status](https://travis-ci.org/Nondv/ruby-mpd-client.svg?branch=master)](https://travis-ci.org/Nondv/ruby-mpd-client)
-develop: [![Build Status](https://travis-ci.org/Nondv/ruby-mpd-client.svg?branch=develop)](https://travis-ci.org/Nondv/ruby-mpd-client)
+[![Gem Version](https://badge.fury.io/rb/ruby-mpd-client.svg)](https://badge.fury.io/rb/ruby-mpd-client)
+<br />
+[![Build Status](https://travis-ci.org/Nondv/ruby-mpd-client.svg?branch=master)](https://travis-ci.org/Nondv/ruby-mpd-client) **master**
+<br />
+[![Build Status](https://travis-ci.org/Nondv/ruby-mpd-client.svg?branch=develop)](https://travis-ci.org/Nondv/ruby-mpd-client) **develop**
 
 Yet another ruby mpd client.
 
-This gem is for my own usage (practicing my programming skills). But
-I would be glad to know if you found it useful.
+It does not really provide you some object model for interacting with MPD.
+Mostly it's just collection of MPD commands with different names.
 
-See on [rubydoc](http://www.rubydoc.info/gems/ruby-mpd-client)
+There's `MPD::Connection` wrapper over `Socket`, `MPD::ServerResponse` - string
+with some useful methods, `MPD::Playlist` - verypoor abstraction over song list
+and `MPD::Commands` module that contains all implemented commands.
+
+See on [rubydoc](http://www.rubydoc.info/gems/ruby-mpd-client).
 
 ## Installation
 
@@ -18,8 +25,6 @@ gem 'ruby-mpd-client'
 
 ## Usage
 
-It does not do much
-
 ```ruby
 require 'ruby-mpd-client'
 
@@ -37,14 +42,19 @@ MPD::Commands::Next.new(connection: conn).execute
 MPD::Commands::Pause.new(connection: conn).execute
 ```
 
-For available commands see [lib/mpd/commands](lib/mpd/commands).
+For available commands see `MPD::Comands` subclasses on
+[rubydoc.info](http://www.rubydoc.info/github/Nondv/ruby-mpd-client/MPD/Commands).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Nondv/ruby-mpd-client.
+I guess your contribution would be a some command implementation or some models
+better than `MPD::Playlist` and `MPD::Song`. Feel free to create pull requests,
+issues or contact me.
 
+[Link to github repo](https://github.com/Nondv/ruby-mpd-client)
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
 

data/Rakefile

@@ -1,6 +1,9 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
 
-task :default => :spec
+task travis: %i[spec rubocop]
+task default: :travis

data/bin/console

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
+require 'bundler/setup'
 require 'ruby-mpd-client'
 
 # You can add fixtures and/or initialization code here to make experimenting
@@ -10,5 +10,5 @@ require 'ruby-mpd-client'
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/mpd/commands.rb

@@ -8,6 +8,10 @@ module MPD
     #
     # To decrease code amount
     #
+    # @!macro [attach] define_trivial_command
+    #   @!parse
+    #     # Sends "$2" to MPD.
+    #     class Commands::$1 < Commands::Abstract; end
     def self.define_trivial_command(class_name, command)
       klass = Class.new(::MPD::Commands::Abstract) do
         define_method :execute do
@@ -21,6 +25,10 @@ module MPD
     #
     # To define commands like 'save "whatever this is"'
     #
+    # @!macro [attach] define_text_argument_command
+    #   @!parse
+    #     # Sends '$2 "<ARGUMENT>"' to MPD
+    #     class Commands::$1 < Commands::Abstract; end
     def self.define_text_argument_command(class_name, command)
       klass = Class.new(::MPD::Commands::Abstract) do
         define_method :execute do |arg|
@@ -34,6 +42,13 @@ module MPD
     #
     # To define commands like "random <1/0>"
     #
+    # @!macro [attach] define_option_command
+    #   @!parse
+    #     # Sends '$2 <1/0>' to MPD
+    #     class Commands::$1 < Commands::Abstract
+    #       # @param state [Boolean]
+    #       def execute(state); end
+    #     end
     def self.define_option_command(class_name, command)
       klass = Class.new(::MPD::Commands::Abstract) do
         define_method :execute do |state|
@@ -44,32 +59,18 @@ module MPD
       const_set(class_name, klass)
     end
 
-    # @!macro [attach] define_trivial_command
-    #   @!parse
-    #     # Sends "$2" to MPD.
-    #     class Commands::$1; end
     define_trivial_command('Pause', 'pause 1')
     define_trivial_command('Stop', 'stop')
     define_trivial_command('Previous', 'previous')
     define_trivial_command('Next', 'next')
     define_trivial_command('CurrentPlaylistClear', 'clear')
+    define_trivial_command('Update', 'update')
 
-    # @!macro [attach] define_text_argument_command
-    #   @!parse
-    #     # Sends '$2 "<ARGUMENT>"' to MPD
-    #     class Commands::$1; end
     define_text_argument_command 'PlaylistDelete', :rm
     define_text_argument_command 'PlaylistSave', :save
     define_text_argument_command 'PlaylistLoad', :load
     define_text_argument_command 'PlaylistClear', :playlistclear
 
-    # @!macro [attach] define_option_command
-    #   @!parse
-    #     # Sends '$2 <1/0>' to MPD
-    #     class Commands::$1
-    #       # @param state [Boolean]
-    #       def execute(state); end
-    #     end
     define_option_command 'Consume', 'consume'
     define_option_command 'Crossfade', 'crossfade'
     define_option_command 'Random', 'random'

data/lib/mpd/commands/abstract.rb

@@ -14,7 +14,13 @@ module MPD
       # You can provide you own connection. It should have same
       #
       def initialize(connection: nil, host: 'localhost', port: 6600)
-        @connection = connection || Connection.new(host: host, port: port).tap(&:connect).tap(&:gets)
+        @connection = if connection
+                        connection
+                      else
+                        Connection.new(host: host, port: port)
+                                  .tap(&:connect)
+                                  .tap(&:gets)
+                      end
       end
 
       #

data/lib/mpd/commands/current_playlist_remove.rb

@@ -13,7 +13,8 @@ module MPD
       #
       def execute(position: nil, id: nil)
         raise(ArgumentError) if position && id || !position && !id
-        exec_command(id ? "deleteid #{id}" : "delete #{resolve_range(position)}")
+        command = id ? "deleteid #{id}" : "delete #{resolve_range(position)}"
+        exec_command(command)
       end
     end
   end

data/lib/mpd/commands/ping.rb

@@ -9,11 +9,10 @@ module MPD
     # `false` otherwise
     #
     class Ping < Abstract
-      # rubocop:disable Lint/RescueWithoutErrorClass
       def execute
         super('ping')
         true
-      rescue => e
+      rescue StandardError => e
         raise e if e.is_a?(MpdError)
         false
       end

data/lib/mpd/commands/playlist_add.rb

@@ -3,17 +3,20 @@ require 'mpd/commands/abstract'
 module MPD
   module Commands
     #
-    # Adds song(s) to specific playlist
-    # `songs` is an array of URIs.
+    # Adds song(s) to specific playlist.
     #
     class PlaylistAdd < Abstract
       #
-      # `name` is playlist name.
-      # `songs` is position (as int) or range.
+      # @param name [String] playlist name.
+      # @param songs [Array<String>, String] file URIs.
       #
       def execute(name, songs)
-        return exec_command("playlistadd \"#{name}\" \"#{songs}\"") unless songs.is_a?(Array)
-        exec_command_list(songs.map { |s| "playlistadd \"#{name}\" \"#{s}\"" })
+        if songs.is_a?(Array)
+          commands = songs.map { |s| "playlistadd \"#{name}\" \"#{s}\"" }
+          exec_command_list(commands)
+        else
+          exec_command("playlistadd \"#{name}\" \"#{songs}\"")
+        end
       end
     end
   end

data/lib/mpd/commands/playlist_list.rb

@@ -9,7 +9,7 @@ module MPD
       def execute
         exec_command('listplaylists')
           .key_value_pairs
-          .select { |k, v| k == 'playlist' }
+          .select { |k, _v| k == 'playlist' }
           .map(&:last)
       end
     end

data/lib/mpd/commands/playlist_remove.rb

@@ -0,0 +1,19 @@
+require 'mpd/commands/abstract'
+
+module MPD
+  module Commands
+    #
+    # Removes **one** song from playlist by position.
+    # Uses MPD command "playlistdelete"
+    #
+    class PlaylistRemove < Abstract
+      #
+      # @param name [String] playlist name.
+      # @param position [Integer] song position.
+      #
+      def execute(name, position)
+        exec_command("playlistdelete \"#{name}\" #{position}")
+      end
+    end
+  end
+end

data/lib/mpd/connection.rb

@@ -5,7 +5,7 @@ module MPD
   # Simple wrapper over Socket
   #
   class Connection
-    def initialize(host:, port:)
+    def initialize(host: 'localhost', port: 6600)
       @host = host
       @port = port
     end

data/lib/mpd/playlist.rb

@@ -4,18 +4,11 @@ module MPD
   # Array<SongInfo> with some useful methods
   class Playlist < Array
     def self.from_response(response)
-      data = []
-      info = {}
-      response.key_value_pairs.each do |key, value|
-        if info.key?(key) # next song info
-          data << info
-          info = {}
-        end
-
-        info[key] = value
+      data = [{}]
+      response.key_value_pairs.each do |k, v|
+        data.push({}) if data.last.key?(k) # next song reached
+        data.last[k] = v
       end
-
-      data << info
       new(data)
     end
 

data/lib/mpd/version.rb

@@ -1,3 +1,3 @@
 module MPD
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/ruby-mpd-client.gemspec

@@ -1,27 +1,28 @@
-# coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mpd/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ruby-mpd-client"
+  spec.name          = 'ruby-mpd-client'
   spec.version       = MPD::VERSION
-  spec.authors       = ["Dmitriy Non"]
-  spec.email         = ["non.dmitriy@gmail.com"]
+  spec.authors       = ['Dmitriy Non']
+  spec.email         = ['non.dmitriy@gmail.com']
 
   spec.summary       = 'yet another MPD client on Ruby'
   spec.homepage      = 'https://github.com/Nondv/ruby-mpd-client'
-  spec.license       = "MIT"
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
 
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'rubocop', '0.52.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-mpd-client
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Dmitriy Non
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-16 00:00:00.000000000 Z
+date: 2017-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.52.0
 description: 
 email:
 - non.dmitriy@gmail.com
@@ -60,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -80,6 +95,7 @@ files:
 - lib/mpd/commands/playlist_add.rb
 - lib/mpd/commands/playlist_info.rb
 - lib/mpd/commands/playlist_list.rb
+- lib/mpd/commands/playlist_remove.rb
 - lib/mpd/commands/set_volume.rb
 - lib/mpd/commands/status.rb
 - lib/mpd/connection.rb