mr_eko 0.4.1 → 0.4.3

data/README.md

@@ -18,9 +18,11 @@ Example:
 
 Requirements:
 -------------
-* [ffmpeg](http://www.ffmpeg.org/download.htmlr) in your path.
+* [ffmpeg](http://www.ffmpeg.org/download.html) in your path.
 * an [Echonest API token](http://developer.echonest.com/) which goes here: ~/.mreko/echonest_api.key
 
 Notes:
 ------
-MrEko will make an audio fingerprint of a music file and attempt to use it to identify the song.  This is faster but not always successful (due to Echonest limitations) so some songs must be uploaded to Echonest.  This means that scanning a large and/or somewhat eclectic library **could take a good while**.
+MrEko will make an audio fingerprint of a music file and attempt to use it (along with ID3 tags) to retrieve data from Echonest.
+This can be fast but not always successful due to Echonest catalog limitations, so some songs must be uploaded to Echonest.
+This means that scanning a large and/or somewhat eclectic library **could take a good while**.

data/lib/mr_eko/song.rb

@@ -36,9 +36,12 @@ class MrEko::Song < Sequel::Model
   # @option opts [String] :md5 pre-calculated MD5 of file
   # @return [MrEko::Song, NilClass] the created Song
   def self.catalog_via_enmfp(filename, opts={})
+    md5 = opts[:md5] || MrEko.md5(filename)
+    existing = where(:md5 => md5).first
+    return existing unless existing.nil?
+
     return if file_too_big? filename
 
-    md5 = opts[:md5] || MrEko.md5(filename)
     log "Identifying with ENMFP code #{filename}"
 
     begin
@@ -55,7 +58,7 @@ class MrEko::Song < Sequel::Model
       song.code           = fingerprint_json ? fingerprint_json.code : nil
       song.tempo          = profile.audio_summary.tempo
       song.duration       = profile.audio_summary.duration
-      song.key            = profile.audio_summary.key
+      song.key            = profile.audio_summary[:key]
       song.mode           = profile.audio_summary.mode
       song.loudness       = profile.audio_summary.loudness
       song.time_signature = profile.audio_summary.time_signature

data/lib/mr_eko/timed_playlist.rb

@@ -16,12 +16,16 @@ class MrEko::TimedPlaylist < MrEko::Playlist
     super
   end
 
-  # Have to add songs after save due to the Playlist needing to have a primary
-  # key (generated at time of save). Lame.
-  def after_save
+  # Run these essential steps before saving, so that any fatal exception halt
+  # the creation of the playlist.
+  def before_save
     prepare_attributes
     find_song_groups!
+  end
 
+  # Have to add songs after save due to the Playlist needing to have a primary
+  # key (generated at time of save). Lame.
+  def after_save
     songs = @song_groups.sort_by{ |group| cost_of group }.first
 
     # Sort em
@@ -43,8 +47,8 @@ class MrEko::TimedPlaylist < MrEko::Playlist
 
     case facet
     when :danceability, :energy
-      @initial = (intial * 10).round
-      @final = (final * 10).round
+      @initial = (initial / 100.0)
+      @final = (final / 100.0)
     when :mode
       @initial = MrEko.mode_lookup(initial)
       @final = MrEko.mode_lookup(final)
@@ -55,30 +59,34 @@ class MrEko::TimedPlaylist < MrEko::Playlist
   end
 
   def find_song_groups!(iterations=50)
-
     sorted = [initial, final].sort
     # Get every song in the required range
     all_songs = MrEko::Song.where({facet => Range.new(*sorted)} & ~{:duration => nil}).all
-    raise MrEko::NoSongsError, "no songs with those '#{facet}' parameters" if all_songs.blank?
+
+    if all_songs.blank?
+      raise MrEko::NoSongsError, "no songs with those '#{facet}' parameters"
+    elsif all_songs.length == 1 # Might want to warn/raise here?
+      @song_groups = [ all_songs ]
+      return
+    end
 
     # Populate a number of potential playlists
     @song_groups = Array.new(iterations) do
       seconds_used = 0
       group = []
-      until seconds_used >= @length do
-        random_index = rand(all_songs.length - 1)
-        song = all_songs.delete_at(random_index)
+      available_songs = all_songs.dup
+
+      until seconds_used >= @length or available_songs.empty? do
+        random_index = rand(available_songs.length - 1)
+        song = available_songs.delete_at(random_index)
         seconds_used += song.duration
         group << song
       end
 
       group
     end
-
   end
 
-  private
-
   # How bad is the passed group of songs with respect to the TimedPlaylist's
   # facet and length contraints?
   #

data/lib/mr_eko.rb

@@ -19,7 +19,7 @@ EKO_ENV = ENV['EKO_ENV'] || 'development'
 Sequel.default_timezone = :utc
 
 module MrEko
-  VERSION = '0.4.1'
+  VERSION = '0.4.3'
   USER_DIR = File.join(ENV['HOME'], ".mreko")
   FINGERPRINTS_DIR = File.join(USER_DIR, 'fingerprints')
   LOG_DIR = File.join(USER_DIR, 'logs')

data/mr_eko.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'mr_eko'
-  s.version           = '0.4.1'
-  s.date              = '2012-01-01'
+  s.version           = '0.4.3'
+  s.date              = '2012-02-12'
   s.rubyforge_project = 'mr_eko'
 
   ## Make sure your summary is short. The description may be as long

data/test/timed_playlist_test.rb

@@ -10,30 +10,9 @@ class TimedPlaylistTest < Test::Unit::TestCase
 
   end
 
-  context 'initial' do
-
-    should 'add the attribute to the list of initial attributes' do
-      MrEko::TimedPlaylist.new(:length => 600, :name => 'sad shit', :facet => :mode) do |pl|
-        assert pl.initial = :minor
-        assert_equal :minor, pl.initial
-      end
-    end
-  end
-
-  context 'final' do
-
-    should 'add the attribute to the list of final attributes' do
-      MrEko::TimedPlaylist.new(:length => 200, :name => 'Rock', :facet => :tempo) do |pl|
-        assert pl.final = 120
-        assert_equal 120, pl.final
-      end
-    end
-  end
-
   context 'save' do
 
     should 'raise an exception when there are no songs for the parameters' do
-
       # No moar songs!
       MrEko::Song.delete
 
@@ -45,14 +24,84 @@ class TimedPlaylistTest < Test::Unit::TestCase
       assert_raises(MrEko::NoSongsError){ list.save }
     end
 
-    context 'validation' do
-      should "raise an exception when initial and final attribute keys don't match" do
-        pl = MrEko::TimedPlaylist.new(:length => 1000, :facet => :tempo) do |pl|
-          assert pl.initial = 66
+    context 'facet range' do
+
+      should 'add the attribute to the list of initial attributes' do
+        list = MrEko::TimedPlaylist.new(:length => 600, :name => 'sad shit', :facet => :mode)
+        list.initial = :minor
+
+        assert_equal :minor, list.initial
+      end
+
+      should 'add the attribute to the list of final attributes' do
+        list = MrEko::TimedPlaylist.new(:length => 200, :name => 'Rock', :facet => :tempo)
+        list.final = 120
+
+        assert_equal 120, list.final
+      end
+
+      should 'raise an error if only one facet boundary is set' do
+        list = MrEko::TimedPlaylist.new(:length => 3600, :facet => :mode)
+        list.initial = :minor
+
+        assert_raise(MrEko::InvalidAttributes){ list.save }
+      end
+
+      context 'value translation' do
+        [:energy, :danceability].each do |attr|
+          should "turn #{attr} into a percentage" do
+            song = create_song(attr => 0.76)
+            list = MrEko::TimedPlaylist.new(:length => 3600, :facet => attr)
+            list.initial = 60
+            list.final = 100
+            assert list.save
+
+            assert_equal 0.60, list.initial
+            assert_equal 1.0, list.final
+          end
         end
 
-        assert_raise(MrEko::InvalidAttributes){ pl.save }
+        should "translate mode into a number" do
+          song = create_song(:mode => 0)
+          list = MrEko::TimedPlaylist.new(:length => 3600, :facet => :mode)
+          list.initial = 'minor'
+          list.final = 'major'
+          assert list.save
+
+          assert_equal 0, list.initial
+          assert_equal 1, list.final
+        end
+
+        should "translate key into a number" do
+          song = create_song(:key => 5)
+          list = MrEko::TimedPlaylist.new(:length => 3600, :facet => :key)
+          list.initial = 'F'
+          list.final = 'A'
+          assert list.save
+
+          assert_equal 5, list.initial
+          assert_equal 9, list.final
+        end
       end
     end
+
+    # pending, until next time...
+    #context 'the songs' do
+    #  setup do
+    #    MrEko::Song.delete
+    #  end
+
+    #  should "populate the list of songs" do
+    #    60.times do |i|
+    #      create_song(:tempo => 50 + i , :duration => 1.minutes, :title => "Song #{i}")
+    #    end
+
+    #    list = MrEko::TimedPlaylist.new(:length => 30.minutes, :facet => :tempo)
+    #    list.initial = 50
+    #    list.final = 100
+    #    list.save
+    #  end
+    #end
   end
+
 end

metadata

@@ -1,236 +1,178 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mr_eko
-version: !ruby/object:Gem::Version 
-  hash: 13
+version: !ruby/object:Gem::Version
+  version: 0.4.3
   prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 1
-  version: 0.4.1
 platform: ruby
-authors: 
+authors:
 - Ed Hickey
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-01 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: sequel
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2160313480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 3
-        - 15
-        version: "3.15"
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: '3.15'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: sqlite3-ruby
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2160313480
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &2160312580 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: hashie
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2160312580
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &2160327920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: httpclient
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2160327920
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: &2160327060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 2
-        - 1
-        version: "2.1"
+      - !ruby/object:Gem::Version
+        version: '2.1'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: bassnode-ruby-echonest
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2160327060
+- !ruby/object:Gem::Dependency
+  name: bassnode-ruby-echonest
+  requirement: &2160326540 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2160326540
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2160325800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 4
-        - 6
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
         version: 1.4.6
   type: :runtime
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: id3lib-ruby
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *2160325800
+- !ruby/object:Gem::Dependency
+  name: id3lib-ruby
+  requirement: &2160325140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *2160325140
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2160324320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 0
-        - 9
-        - 8
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
         version: 0.9.8
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: shoulda
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: *2160324320
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2160323560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 2
-        - 11
-        version: "2.11"
+      - !ruby/object:Gem::Version
+        version: '2.11'
   type: :development
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: test-unit
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: *2160323560
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: &2160322960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 2
-        - 1
-        version: "2.1"
+      - !ruby/object:Gem::Version
+        version: '2.1'
   type: :development
-  version_requirements: *id010
-- !ruby/object:Gem::Dependency 
-  name: ruby-debug
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  version_requirements: *2160322960
+- !ruby/object:Gem::Dependency
+  name: ruby-debug
+  requirement: &2160322580 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id011
-- !ruby/object:Gem::Dependency 
-  name: autotest
   prerelease: false
-  requirement: &id012 !ruby/object:Gem::Requirement 
+  version_requirements: *2160322580
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: &2160322120 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id012
-- !ruby/object:Gem::Dependency 
-  name: pry
   prerelease: false
-  requirement: &id013 !ruby/object:Gem::Requirement 
+  version_requirements: *2160322120
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &2160321660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id013
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id014 !ruby/object:Gem::Requirement 
+  version_requirements: *2160321660
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2160321240 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id014
+  prerelease: false
+  version_requirements: *2160321240
 description: Catalogs music file data and exposes a playlist interface
 email: bassnode@gmail.com
-executables: 
+executables:
 - mreko
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
-files: 
+files:
 - Gemfile
 - README.md
 - Rakefile
@@ -272,37 +214,28 @@ files:
 - test/timed_playlist_test.rb
 homepage: http://github.com/bassnode/mreko
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: mr_eko
-rubygems_version: 1.8.11
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 2
 summary: Catalogs music file data and exposes a playlist interface
 test_files: []
-
 has_rdoc: