mr_eko 0.4.3 → 0.5.1

data/Gemfile

@@ -1,4 +1,3 @@
 source "http://rubygems.org"
 
-# gem "bassnode-ruby-echonest", :path => "../ruby-echonest"
 gemspec

data/README.md

@@ -16,11 +16,25 @@ Example:
     # Output a playlist of shorter,  up-tempo, danceable, major-keyed songs
     mreko playlist --preset gym --format pls > sweaty_playlist.pls
 
+    # Output a 30 minute playlist which builds from tempo 120 to 185 BPM. See notes on TimedPlaylists below.
+    mreko playlist --timed 1800 --tempo 120 --final 185 > morning_commute.pls
+
+    # Output an hour-long playlist which gradually decreases in energy.
+    mreko playlist --timed 3600 --energy 100 --final 30 > evening_wind_down.pls
+
 Requirements:
 -------------
 * [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
 
+TimedPlaylists:
+---------------
+TimedPlaylists are different than standard Playlists in that they are both limited by time (surprise!) and are built around one "facet".
+A facet is one of the Playlist options such as tempo, key, energy, mode, etc.  You specify the length of the playlist (in seconds), the facet
+upon which the playlist is filtered and sorted, and then the initial and final values for the facet. E.g. a 45 minute playlist which starts in
+Minor key and ends Major:
+    mreko playlist --timed 2700 --mode minor --final major
+
 Notes:
 ------
 MrEko will make an audio fingerprint of a music file and attempt to use it (along with ID3 tags) to retrieve data from Echonest.

data/bin/mreko

@@ -10,15 +10,16 @@ Sequel::Migrator.apply(MrEko.connection, File.join(File.dirname(__FILE__), "..",
 
 def parse_options
 
-  options = { :format => :text }
+  options = { :format => :pls }
 
   OptionParser.new do |opts|
-    opts.banner = "Usage: #{$0} scan|playlist [options]"
+    opts.banner = "MrEko version #{MrEko::VERSION}\n"
+    opts.banner += "Usage: mreko scan|playlist [options]"
 
     opts.separator ""
     opts.separator "Playlist options:"
 
-    opts.on("-p", "--preset NAME", String, "Select a preset.  Options are (#{MrEko::Presets::FACTORY.keys.join(', ')})") do |preset|
+    opts.on("-p", "--preset NAME", String, "Select a preset.  Options are: #{MrEko::Presets::FACTORY.keys.join(', ')}") do |preset|
       options[:preset] = preset
     end
 
@@ -46,6 +47,10 @@ def parse_options
       options[:loudness] = num
     end
 
+    opts.on("-k", "--key KEY", "Specify chromatic key (from C to B)") do |key|
+      options[:key] = key
+    end
+
     opts.on("-o", "--mode MODE", String, "Specify mode (minor or major)") do |mode|
       unless MrEko::MODES.include?(mode)
         raise ArgumentError.new("Mode must be #{MrEko::MODES.join(' or ')}")
@@ -53,6 +58,14 @@ def parse_options
       options[:mode] = mode
     end
 
+    opts.on("-x", "--timed SEC", "Limit this playlist to a certain length (in seconds).") do |length|
+      options[:timed] = length
+    end
+
+    opts.on("-z", "--final VAL", "Sets the ending value of a Timed Playlist") do |val|
+      options[:final] = val
+    end
+
     opts.on("-f", "--format FORMAT", MrEko::Playlist::FORMATS,
             "Select output type (#{MrEko::Playlist::FORMATS.join(', ')})") do |format|
       unless MrEko::Playlist::FORMATS.include?(format)
@@ -65,7 +78,13 @@ def parse_options
       options[:tags_only] = true
     end
 
-    opts.separator ""
+    opts.on("-v", "--version", "Output version") do
+      puts MrEko::VERSION
+      exit
+    end
+
+    opts.separator "\nNote that if --timed is passed, you may only specify one facet, e.g --tempo. This value will be used as the starting point.
+You must also pass --final to set the final value. So for a 10 min. playlist which starts at 120 BPM and ends at 200 BPM: mr_eko playlist --timed 600 --tempo 120 --final 200\n\n"
 
     # No argument, shows at tail.  This will print an options summary.
     opts.on_tail("-h", "--help", "Show this message") do
@@ -97,10 +116,23 @@ when 'scan'
   files.each do |file|
     MrEko::Song.create_from_file!(file, options)
   end
+
 when 'playlist'
   format = options.delete(:format)
-  playlist = MrEko::Playlist.create_from_options(options)
+
+  if length = options.delete(:timed)
+    final = options.delete(:final)
+    raise ArgumentError.new("You may only provide one facet when creating a Timed Playlist!!") if options.keys.size > 1
+
+    facet    = options.keys.first
+    initial  = options[facet]
+    playlist = MrEko::TimedPlaylist.create(:length => length, :facet => facet, :initial => initial, :final => final)
+  else
+    playlist = MrEko::Playlist.create_from_options(options)
+  end
+
   puts playlist.output(format)
+
 else
   puts "nothing for #{ARGV[0]}"
 end

data/lib/mr_eko/timed_playlist.rb

@@ -11,7 +11,7 @@ class MrEko::TimedPlaylist < MrEko::Playlist
 
   def initialize(opts={})
     @facet = opts.delete(:facet)
-    @length = opts.delete(:length)
+    @length = opts.delete(:length).to_i
 
     super
   end
@@ -47,15 +47,19 @@ class MrEko::TimedPlaylist < MrEko::Playlist
 
     case facet
     when :danceability, :energy
-      @initial = (initial / 100.0)
-      @final = (final / 100.0)
+      @initial = (initial.to_i / 100.0)
+      @final = (final.to_i / 100.0)
     when :mode
       @initial = MrEko.mode_lookup(initial)
       @final = MrEko.mode_lookup(final)
     when :key
       @initial = MrEko.key_lookup(initial)
       @final = MrEko.key_lookup(final)
+    else
+      @initial = initial.to_i
+      @final = final.to_i
     end
+
   end
 
   def find_song_groups!(iterations=50)

data/lib/mr_eko.rb

@@ -19,7 +19,7 @@ EKO_ENV = ENV['EKO_ENV'] || 'development'
 Sequel.default_timezone = :utc
 
 module MrEko
-  VERSION = '0.4.3'
+  VERSION = '0.5.1'
   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.3'
-  s.date              = '2012-02-12'
+  s.version           = '0.5.1'
+  s.date              = '2012-06-03'
   s.rubyforge_project = 'mr_eko'
 
   ## Make sure your summary is short. The description may be as long

data/test/timed_playlist_test.rb

@@ -85,23 +85,31 @@ class TimedPlaylistTest < Test::Unit::TestCase
       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
+    context 'the songs' do
+      setup do
+        MrEko::Song.delete
+        @song_count = 40
+
+        @song_count.times do |i|
+          create_song(:tempo => 50 + i , :duration => 1.minutes, :title => "Song #{i}")
+        end
+
+        @list = MrEko::TimedPlaylist.create(:length => 30.minutes, :facet => :tempo, :initial => 50, :final => 100)
+      end
+
+      should "fill the requested duration" do
+        assert_equal 30, @list.songs.size
+      end
+
+      should "fit the required constraints" do
+        assert @list.songs.all?{ |song| song.tempo >= @list.initial && song.tempo <= @list.final }
+      end
+
+      should "be sorted ascending, by default" do
+        sorted = @list.songs.sort_by &:tempo
+        assert_equal sorted, @list.songs
+      end
+    end
   end
 
 end

metadata

@@ -1,178 +1,236 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: mr_eko
-version: !ruby/object:Gem::Version
-  version: 0.4.3
+version: !ruby/object:Gem::Version 
+  hash: 9
   prerelease: 
+  segments: 
+  - 0
+  - 5
+  - 1
+  version: 0.5.1
 platform: ruby
-authors:
+authors: 
 - Ed Hickey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-06-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: sequel
-  requirement: &2160313480 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - =
-      - !ruby/object:Gem::Version
-        version: '3.15'
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 3
+        - 15
+        version: "3.15"
   type: :runtime
-  prerelease: false
-  version_requirements: *2160313480
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: sqlite3-ruby
-  requirement: &2160312580 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
   type: :runtime
-  prerelease: false
-  version_requirements: *2160312580
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: hashie
-  requirement: &2160327920 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2160327920
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: httpclient
-  requirement: &2160327060 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.1'
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
   type: :runtime
-  prerelease: false
-  version_requirements: *2160327060
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: bassnode-ruby-echonest
-  requirement: &2160326540 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2160326540
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: &2160325800 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - =
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
         version: 1.4.6
   type: :runtime
-  prerelease: false
-  version_requirements: *2160325800
-- !ruby/object:Gem::Dependency
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
   name: id3lib-ruby
-  requirement: &2160325140 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2160325140
-- !ruby/object:Gem::Dependency
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
   name: mocha
-  requirement: &2160324320 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - =
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
         version: 0.9.8
   type: :development
-  prerelease: false
-  version_requirements: *2160324320
-- !ruby/object:Gem::Dependency
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
   name: shoulda
-  requirement: &2160323560 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.11'
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 11
+        version: "2.11"
   type: :development
-  prerelease: false
-  version_requirements: *2160323560
-- !ruby/object:Gem::Dependency
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
   name: test-unit
-  requirement: &2160322960 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.1'
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
   type: :development
-  prerelease: false
-  version_requirements: *2160322960
-- !ruby/object:Gem::Dependency
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
   name: ruby-debug
-  requirement: &2160322580 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2160322580
-- !ruby/object:Gem::Dependency
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
   name: autotest
-  requirement: &2160322120 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2160322120
-- !ruby/object:Gem::Dependency
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
   name: pry
-  requirement: &2160321660 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2160321660
-- !ruby/object:Gem::Dependency
+  version_requirements: *id013
+- !ruby/object:Gem::Dependency 
   name: yard
-  requirement: &2160321240 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id014 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2160321240
+  version_requirements: *id014
 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
@@ -214,28 +272,37 @@ 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
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: mr_eko
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 2
 summary: Catalogs music file data and exposes a playlist interface
 test_files: []
+
 has_rdoc: