cultome_player 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 520affa57eb4cbb5aee209993047772c18379b0d
-  data.tar.gz: 2fe8bbee2da06c8515a710edb4666a825e7dd19e
+  metadata.gz: 46321051c193edf556318683db732a1d96e3580b
+  data.tar.gz: 41926b365494b457983fd4bda0e2766c44834967
 SHA512:
-  metadata.gz: c286b696f6881b843c7577bb8451d21a6c8312c61d47e1e6986845b132637c0933311fe9d5ad17c3a3dd39709e7559ce8b36f46a565feaa9c04acf83278fa192
-  data.tar.gz: 9ac39288b1acea2127f0e7f6d8f19e85f4bf37e5c54912bdb648de9039ab4498fb819628e7703c6b6f97e3d8dd7f4b4a08cae6a3ac73fdae2ef6770ca85c147c
+  metadata.gz: 1f324e968d798f079c04a87100774c498558a5f897baeb81a3b754f0f2f881f2ecdc8ec33760c58464748637350e767dcff5b432bf49d51b6aeaec600e49f8d9
+  data.tar.gz: 2e8bb3f88b0d007aca2e74435ffd729e48e3794fd46451519eba0cf27655b5b03f59444f7ffb383a7b0146014ff775afa5b75dc8a34ef0fd10d59052027705fb

data/README.md

@@ -1,11 +1,11 @@
 [![Gem Version](https://badge.fury.io/rb/cultome_player.png)](http://badge.fury.io/rb/cultome_player)
-[![Build Status](https://travis-ci.org/cultome/cultome_player.svg)](https://travis-ci.org/cultome/cultome_player)
-[![Coverage Status](https://coveralls.io/repos/cultome/cultome_player/badge.png)](https://coveralls.io/r/cultome/cultome_player)
+[![Build Status](https://travis-ci.org/cultome/cultome_player.svg?branch=master)](https://travis-ci.org/cultome/cultome_player)
+[![Coverage Status](https://coveralls.io/repos/github/cultome/cultome_player/badge.svg?branch=master)](https://coveralls.io/github/cultome/cultome_player?branch=master)
 
 # Cultome Player
 A handy music library explorer. Is designed to facilitate you to play the music you like in the moment you want.
 
-**"I want to play exactly this music"**
+**"I want to play exactly that song"**
 
 The player is designed around this concept, so it has commands to help you find music in your library and play it.
 
@@ -110,7 +110,7 @@ Some others are not player's objects but act as special functions placeholders.
 * @genres          Referes to the complete list of genres in you *connected* collection.
 * @recently_added  Referes to the list of recently added to the collection's songs.
 * @recently_played Referes to the list of recently played songs.
-* @more_played     Referes to the list of songs with more playbacks.
+* @most_played     Referes to the list of songs with more playbacks.
 * @less_played     Referes to the list of songs with less playbacks.
 * @populars        Referes to the list of songs with highest puntuations from playback preferences.
 ```
@@ -169,11 +169,15 @@ Is an absolute path inside the filesystem. As with literals if the path has any
 ```
 
 #### Boolean
-Basicly anything that match the next regex is considered a boolean value, so watch out if you try to insert a literal value instead of a boolean.
+Basically anything that match the next regex is considered a boolean value, so watch out if you try to insert a literal value instead of a boolean.
 ```
 /^(on|off|yes|false|true|si|no|y|n|s|ok)$/
 ```
 
+Note: When the command parser digest your input it try to guess the type of the tokens the best it can. It will match from specific to general, and boolean are more specificthan literals. If you try to write a literal, but yor literal is one of the recognized boolean types, it will detect it as such. This can cause some commands behave in unexpected ways in the worst case, in others may simpy fail.
+
+So pay attention if something goes weird when you type "search yes".
+
 #### IP
 A valid IP4 address.
 
@@ -183,7 +187,7 @@ A valid IP4 address.
 
 
 ## Commands
-The commands are very rustic. Basicly consist in a command name and a list of parameters.
+The commands are very simples, they consist in a command name and a list of parameters.
 
 ```ruby
 <command> [<param>...]
@@ -230,11 +234,20 @@ help <command_name>
 ```
 
 ## Installation
-Due I'm not a genius, I rely in an excelent media player as a multimedia backbone. So, unless you're trying to write yor own adapter for other music player, you need to have Mpg123 installed. With linux, is a piece of cake:
+I rely in an excellent media player as a multimedia backbone, so, unless you're trying to write yor own adapter for other music player, you need to have **Mpg123** installed. With linux, is a piece of cake:
 
-For Ubuntu
 ```
+# Ubuntu
 sudo apt-get install mpg123
+
+# Archlinux (yaourt)
+sudo yaourt mpg123
+```
+
+And to use the ID3 tags I use **taglib** library
+```
+# Ubuntu
+sudo apt-get install libtag1-dev
 ```
 
 When you finish install this gem:
@@ -248,78 +261,10 @@ connect /home/user/music => main
 play
 ```
 
-## What's new
-
-**Version 2.0.0**
-
-You know! I cant remember how many times I have rewrited this player. Mainly I do it because is fun to work in it, but the ugly truth is that I never finish it. However I will try to delivery at least a stable and prolonged api for this version. I'm taking my time and hopefully some day near I can delivery a fully funcional version with the plugins and all the flashing lights. If you wanna try the player while Im building it, try this version, if not stick it to the 1.0.0 (Im using version 1.0.0 while writing this) until I reach the functional point of that version, when that happens I'll post it here.
-
-UPDATE:
-
-I'm working again! Some changes ocurred since last update. First I change mi github account for dumb reasons, anyway this is the new old gem and I have this first stable new version. You know, some rought edges but at least is useful. I'll release the gem with another name because the cultome_player namespace is reserved. I let you know which one I pick. Wait the new gem in a couple days.
-
-**Version 1.0.0**
-
-I took so long I know, but it was for a good cause. When I realized thanks to [Travis CI](https://travis-ci.org/csoriav/cultome_player) that my code was a little more than difficult to test in more than one environment, considering the weird hybrid that result the JRuby thing, I decided to rewrite all the player, and that was what i been doing since then.
-
-With the hope to deliver zero-defect, multiple-environment-friendly, less error prone code, a better developer experience and a truly code that could be called gem, I invest a lot of effort writing with a test-first methodology with new version. As you can see my coverage incremented radically.
-
-As you can imagine, I test a lot, but even with my greattest efforts is possible that some scenarios have gone under the radar. I'm also conscient that this version still has some jagged edges, mostly of then I have identified but, by the nature of this change and the time it took, i decide to release this stable version and polish all the other things in the next release.
-
-So, whats new with this release? Well at first sight you will feel the speed in the starting, also will note the memory consumption is now less than half than before. I also remove dependencies but over all now the player is **PURE RUBY**... well! you still need to have java installed because the music player is the same, but now run in a separate process and the communication between ruby and java is with sockets. This allows to use the gem even without a music player or connect a nother player, lets say mplayer, with just overwriting a couple methods =D
-
-I remove the share funcitonality in this version, but it will come back in esteroids in future releases.
-
-Whats next? Musicbrainz integration, I need to tags correctly all the songs if I want to go further. So, see you next version!
-
-**Version 0.4.0**
-
-* Now you database and your config file are inside you user directory (~/.cultome), that mean every new version dont require re-connect you music or make your aliases again.
-* Scrobbler? of course! why not? but please run **'configure_lastfm begin'** before use it.
-* Better environment startup check.
-
-**Version 0.3.0**
-
-* Colors!!! Yeah! a color schema that you can customize if you dont like mine.
-* Some ASCII progress bars to let you know the player is not stuck!
-* Improvement in the 'help <command>' command, to, hopefully help you you surf in the player.
-* Add but not yet fully tested the *share* command to share music between two machines.
-* Some minor bugs fixed.
-* Specs up to date! YEAH!
-
-**Version 0.2.0**
-
-* The code were reorganized to be more API-oriented, even when this was not the mainly intention of this project, but can be uselful for others to use it this way.
-* The some commands were extracted from the core, like help and kill.
-* The command 'copy <object> <destiny_path>' were added to copy all the songs in the objet to a directory in the filesystem.
-* The option 'search @\<artist|album\>' was implemented to facilitate the __'that album rocks! lets hear it!'__.
-* The player now emit exception-thrown events, a general exception and a player's exception.
-* The aliases/shortcuts/macros plugin is in place. With this you can translate user input into commands, for example type 'sa' and the players tranform it to 'search @artist'.
-* Changes in plugin structure. Not the final version but a step ahead for building a better plugin model.
-* Some minor bugs fixes, like the db hanging or the lost in focus when search is empty.
-
-## TODO
-
-* Connect with musicbrainz to tag correctly and beatifuly my music, this also surge as Last.fm is very picky with the information you submit with your scrobbles.
-* Add tags to the songs, for example 'party' or 'sadness'.
-* A friend of mine give me an idea, when you are in a place where many people hear the same music, you should be able to decide what to play, as everyone else. So I will try an implementation of this idea, maybe a slave-masters model.
-* Support for Windows. Not my priority but would be nice my wife to use it.
-* Add gestures to the detector and start making appropiated suggestions for them.
-* Refine the taste analizer, which is the component that give preference points to songs.
-* Change the underlying in-file database for a real one, thinking on mongo or mysql.
-
 ## Contributing
 
-  1. Fork it
+1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-  3. Commit your changes (`git commit -am 'Add some feature'`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-  5. Create new Pull Request
-
-## Additional Information
-
-#### jlGui BasicPlayer
-  This component is what I use to play music and is included within the libraries of this project, dependencies included of course.
-
-  [jlGui](http://www.javazoom.net/jlgui/developerguide.html)
-
+5. Create new Pull Request

data/Rakefile

@@ -1,8 +1,42 @@
 require "bundler/gem_tasks"
+require 'cultome_player'
 
-$LOAD_PATH.unshift(File.join(File.dirname(File.expand_path(__FILE__)), 'lib'))
+desc "Execute the player in interactive mode in user env"
+task :run => :environment do
+  player = CultomePlayer.get_player(current_env)
+  player.begin_session
+end
+
+desc "Create database schema"
+task :reset_db => :environment do
+  include CultomePlayer::Utils
+  recreate_db_schema
+end
+
+desc "Start a interactive session in the player"
+task :console => :environment do
+  require 'irb'
+  require 'irb/completion'
+
+  p = CultomePlayer.get_player(current_env)
+
+  ActiveRecord::Base.establish_connection({
+    adapter: db_adapter,
+    database: db_file
+  })
+  ActiveRecord::Base.logger = Logger.new(File.open(db_log_file, 'a'))
+
+  include CultomePlayer
+  include CultomePlayer::Environment
+
+  ARGV.clear
+  IRB.start
+end
+
+task :environment do |t, args|
+  include CultomePlayer::Environment
 
-dirname = File.join(File.dirname(File.expand_path(__FILE__)), "tasks")
-Dir.entries(dirname).each do |task|
-  import "#{dirname}/#{task}" if task.end_with?(".rake")
+  env = ENV["ENV"] || :user
+  prepare_environment(env)
+  puts "Using #{env} environment."
 end

data/bin/cultome_player

@@ -7,19 +7,24 @@ require 'cultome_player'
 options = {
   interactive: false,
   environment: :user,
+  signal: false,
 }
 
 parser = OptionParser.new do |opts|
   opts.banner = "Usage: cultome_player [options] [file1, file2, ...]"
 
-  opts.on('-i', '--interactive', 'Starts the player in interactive mode') do
+  opts.on('-i', '--interactive', 'Starts the player in interactive mode. [false]') do
     options[:interactive] = true
   end
 
-  opts.on('-e', '--env ENV', 'Starts the player in interactive mode') do |env|
+  opts.on('-e', '--env ENV', 'Select settings from environment. [user]') do |env|
     options[:environment] = env.to_sym
   end
 
+  opts.on('-s', '--signal SIG', 'Send a command to all the command pipes.') do |sig|
+    options[:signal] = sig.gsub(/"/, "")
+  end
+
   opts.on('--version', "Shows version") do
     puts CultomePlayer::VERSION
     exit
@@ -32,8 +37,15 @@ ARGV << "--help" if ARGV.empty?
 # parseamos las opciones
 parser.parse!(ARGV)
 
-player = CultomePlayer.get_player(options[:environment])
-
 if options[:interactive]
+  player = CultomePlayer.get_player(options[:environment])
   player.begin_session
+elsif options[:signal]
+  begin
+    include CultomePlayer::Environment
+    config = load_environment_properties(options[:environment])
+    puts "[*] Writing to signal '#{options[:signal]}' to pipe '#{config["command_pipe"]}'"
+    open(config["command_pipe"], File::WRONLY | File::NONBLOCK | File::SYNC){|out| out.puts options[:signal]}
+  rescue Errno::ENXIO, Errno::ENOENT => e
+  end
 end

data/config/environment.yml

@@ -4,6 +4,7 @@ user:
   db_log_file: ~/.cultome/db.log
   file_types: mp3
   mplayer_pipe: ~/.cultome/mpctr
+  command_pipe: ~/.cultome/cmdctr
   config_file: ~/.cultome/config.yml
 memory:
   db_adapter: sqlite3
@@ -11,6 +12,7 @@ memory:
   db_log_file: /tmp/db.log
   file_types: mp3
   mplayer_pipe: /tmp/mpctr
+  command_pipe: /tmp/cmdctr
   config_file: /tmp/config.yml
 rspec:
   db_adapter: sqlite3
@@ -18,6 +20,7 @@ rspec:
   db_log_file: spec/db.log
   file_types: mp3
   mplayer_pipe: spec/mpctr
+  command_pipe: spec/cmdctr
   config_file: spec/config.yml
 test:
   db_adapter: sqlite3
@@ -25,4 +28,5 @@ test:
   db_log_file: ~/tmp/db.log
   file_types: mp3
   mplayer_pipe: ~/tmp/mpctr
+  command_pipe: ~/tmp/cmdctr
   config_file: ~/tmp/config.yml

data/cultome_player.gemspec

@@ -2,6 +2,13 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cultome_player/version'
+# select the faile that goes inside the gem
+git_index = `git ls-files`.split("\n")
+gitignored = `cat .gitignore`.split("\n")
+excluded = `cat .excluded`.split("\n")
+
+files = git_index.select{|filepath| !gitignored.include?(filepath) }
+                 .select{|filepath| excluded.none?{|excl_regex| filepath =~ /#{excl_regex}/ }}
 
 Gem::Specification.new do |gem|
   gem.name          = "cultome_player"
@@ -13,7 +20,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/cultome/cultome_player"
   gem.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
+  gem.files         = files
   gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]

data/lib/cultome_player.rb

@@ -25,21 +25,45 @@ module CultomePlayer
   # @param user_input [String] The user input.
   # @return [Response] Response object with information about command execution.
   def execute(user_input)
-    cmd = parse user_input
-    # revisamos si es un built in command o un plugin
-    action = cmd.action
-    plugin_action = "command_#{cmd.action}".to_sym
-    action = plugin_action if respond_to?(plugin_action)
-
-    raise 'invalid command:action unknown' unless respond_to?(action)
-    with_connection do
-      begin
-        send(action, cmd)
-      rescue Exception => e
-        s = e.message.split(":")
-        failure(message: s[0], details: s[1])
+    cmds = parse user_input
+
+    seq_success = true # bandera de exito, si un comando de la cadena falla, los siguientes se abortan
+    response_seq = cmds.collect do |cmd|
+      if seq_success
+        # revisamos si es un built in command o un plugin
+        action = cmd.action
+        plugin_action = "command_#{cmd.action}".to_sym
+        action = plugin_action if plugins_respond_to?(cmd.action)
+
+        raise 'invalid command:action unknown' unless respond_to?(action)
+        with_connection do
+          begin
+            emit_event(:before_command, cmd)
+            emit_event("before_command_#{action}".to_sym, cmd) if cmd.history?
+            r = send(action, cmd)
+            emit_event("after_command_#{action}".to_sym, cmd, r) if cmd.history?
+            emit_event(:after_command, cmd, r)
+
+            seq_success = false unless r.success?
+            r # return response
+          rescue Exception => e
+            emit_event(:execute_exception, cmd, e)
+
+            if current_env == :test || current_env == :rspec
+              display c3("#{e.message}")
+              e.backtrace.each{|b| display c3(b) }
+            end
+
+            seq_success = false
+            s = e.message.split(":")
+            failure(message: s[0], details: s[1])
+          end
+        end
+      else # seq_success == false
+        nil
       end
     end
+    return response_seq.compact # eliminamos los que no corrieron
   end
 
   # Creates a generic response
@@ -74,18 +98,20 @@ module CultomePlayer
 
       def initialize(env)
         prepare_environment(env)
+        ensure_db_schema
         playlists.register(:current)
         playlists.register(:history)
         playlists.register(:queue)
         playlists.register(:focus)
         playlists.register(:search)
-        
-        register_listener(:playback_finish, self)
-      end
 
-      def on_playback_finish
-        r = execute("next no_history")
-        display_over("#{r.message}\n#{PROMPT}")
+        register_listener(:playback_finish) do |song|
+          r = execute("next").first
+          display_over("#{r.message}\n#{c5(PROMPT)}")
+        end
+
+        init_plugins
+        ObjectSpace.define_finalizer(self, proc{ clean_plugins })
       end
     end
 

data/lib/cultome_player/command/language.rb

@@ -1,10 +1,10 @@
 module CultomePlayer::Command
   module Language
 
-    # Define the sintaxis of the player language.
+    # Define the sintax of the player language.
     #
     # @return [Hash] With the keys :command, :parameters, :actions, :param
-    def sintaxis
+    def sintax
       # <command>    : <action> | <action> <parameters>
       # <action>     : literal
       # <parameters> : <param> | <param> <parameters>
@@ -53,9 +53,8 @@ module CultomePlayer::Command
         {type: :criteria, identity: /^([\w]+):([\d\w\s]+)$/, captures: 2, labels: [:criteria, :value]},
         {type: :boolean, identity: /^(on|off|yes|false|true|si|no|y|n|s|ok)$/},
         {type: :ip, identity: /^([\d]{1,3}\.[\d]{1,3}\.[\d]{1,3}\.[\d]{1,3})$/},
-        {type: :literal, identity: /^([\w\d\s]+)$/},
+        {type: :literal, identity: /^['"]?([\w\d\s%]+)['"]?$/}, # add % for the alias parameters placeholders
       ]
     end
-
   end
 end

data/lib/cultome_player/command/processor.rb

@@ -6,9 +6,11 @@ module CultomePlayer::Command
     # @param user_input [String] The user input to be parsed.
     # @return [Command] The parsed command.
     def parse(user_input)
-      tokens = identify_tokens(get_tokens(user_input))
-      validate_command(:command, tokens)
-      return CultomePlayer::Objects::Command.new(tokens.shift, tokens)
+      return user_input.split("&&").collect do |usr_in|
+        tokens = identify_tokens(get_tokens(usr_in.strip))
+        validate_command(:command, tokens)
+        CultomePlayer::Objects::Command.new(tokens.shift, tokens)
+      end
     end
 
     # Split the user input into tokens.
@@ -68,7 +70,7 @@ module CultomePlayer::Command
       valid_format = semantics[cmd]
       if valid_format.nil?
         if plugins_respond_to?(cmd)
-          valid_format = plugin_command_sintaxis(cmd)
+          valid_format = plugin_command_sintax(cmd)
         else
           raise 'invalid command:invalid action'
         end
@@ -131,10 +133,10 @@ module CultomePlayer::Command
 
     def guess_command_format(type, tokens)
       # buscamos el formato que tenga mas matches con los parametros
-      format = sintaxis[type].find do |stxs_elem| # ["action", "action parameters"]
+      format = sintax[type].find do |stxs_elem| # ["action", "action parameters"]
         if stxs_elem.is_a?(String)
            # checamos si el numero de token en el comando corresponde
-           # con el numer de tokens en la sintaxis
+           # con el numer de tokens en la sintax
            stxs_elem.split.size >= tokens.size # ej. "play 1 2" === "action paramters"
         elsif stxs_elem.is_a?(Symbol)
           if tokens.is_a?(Hash)
@@ -150,7 +152,7 @@ module CultomePlayer::Command
       end
 
       if format.nil?
-        max = sintaxis[type].max{|tk| tk.class == String ? tk.split.size: 0}
+        max = sintax[type].max{|tk| tk.class == String ? tk.split.size: 0}
         if max.respond_to?(:split) && tokens.size > max.split.size
           format = max
         else