graphtunes 0.0.1

data/spec/graphtunes_spec.rb

@@ -0,0 +1,518 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Graphtunes do
+  it 'should process' do
+    Graphtunes.should respond_to(:process)
+  end
+  
+  describe 'processing' do
+    before :each do
+      @filename = 'blah'
+      @data = stub('imported data')
+      Graphtunes.stubs(:import).returns(@data)
+      Graphtunes.stubs(:graph)
+    end
+    
+    it 'should require a filename' do
+      lambda { Graphtunes.process }.should raise_error(ArgumentError)
+    end
+    
+    it 'should accept a filename' do
+      lambda { Graphtunes.process(@filename) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should import data from the file' do
+      Graphtunes.expects(:import).with(@filename)
+      Graphtunes.process(@filename)
+    end
+    
+    it 'should graph the imported data' do
+      Graphtunes.expects(:graph).with(@data, anything)
+      Graphtunes.process(@filename)
+    end
+    
+    it "should create an output filename that replaces the input filename's .xml extension with .png" do
+      @filename = 'testing.xml'
+      Graphtunes.expects(:graph).with(@data, 'testing.png')
+      Graphtunes.process(@filename)
+    end
+    
+    it "should create an output filename that appends .png to the input filename if it has no .xml extension" do
+      @filename = 'testblah'
+      Graphtunes.expects(:graph).with(@data, 'testblah.png')
+      Graphtunes.process(@filename)
+    end
+  end
+  
+  it 'should import data' do
+    Graphtunes.should respond_to(:import)
+  end
+  
+  describe 'importing data' do
+    before :each do
+      @filename = 'blah'
+      File.stubs(:file?).returns(true)
+      @data = stub('file data')
+      File.stubs(:read).with(@filename).returns(@data)
+      Graphtunes.stubs(:get_track_list)
+    end
+    
+    it 'should require a filename' do
+      lambda { Graphtunes.import }.should raise_error(ArgumentError)
+    end
+    
+    it 'should accept a filename' do
+      lambda { Graphtunes.import(@filename) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require the argument to be a real file' do
+      File.stubs(:file?).with(@filename).returns(false)
+      lambda { Graphtunes.import(@filename) }.should raise_error(TypeError)
+    end
+    
+    it 'should require the argument to be a real file' do
+      File.stubs(:file?).with(@filename).returns(true)
+      lambda { Graphtunes.import(@filename) }.should_not raise_error(TypeError)
+    end
+    
+    it 'should read the contents of the file' do
+      File.expects(:read).with(@filename)
+      Graphtunes.import(@filename)
+    end
+    
+    it 'should get the track list from the file' do
+      Graphtunes.expects(:get_track_list).with(@data)
+      Graphtunes.import(@filename)
+    end
+  end
+  
+  it 'should get the track list' do
+    Graphtunes.should respond_to(:get_track_list)
+  end
+  
+  describe 'getting the track list' do
+    before :each do
+      @data = %q[
+        <?xml version="1.0" encoding="UTF-8"?>
+        <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+        <plist version="1.0">
+        <dict>
+          <key>Major Version</key><integer>1</integer>
+          <key>Tracks</key>
+      	  <dict>
+          </dict>
+        </dict>
+        </plist>
+      ]
+      @tracks = stub('tracks')
+      Graphtunes.stubs(:get_tracks).returns(@tracks)
+      @order = stub('order')
+      Graphtunes.stubs(:get_track_order).returns(@order)
+      Graphtunes.stubs(:order_tracks)
+    end
+    
+    it 'should require data' do
+      lambda { Graphtunes.get_track_list }.should raise_error(ArgumentError)
+    end
+    
+    it 'should accept data' do
+      lambda { Graphtunes.get_track_list(@data) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should require there to be a notifier of track data' do
+      @data = %q[
+        <?xml version="1.0" encoding="UTF-8"?>
+        <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+        <plist version="1.0">
+        <dict>
+          <key>Major Version</key><integer>1</integer>
+        </dict>
+        </plist>
+      ]
+      lambda { Graphtunes.get_track_list(@data) }.should raise_error
+    end
+    
+    it 'should require there to be track data' do
+      @data = %q[
+        <?xml version="1.0" encoding="UTF-8"?>
+        <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+        <plist version="1.0">
+        <dict>
+          <key>Major Version</key><integer>1</integer>
+          <key>Tracks</key>
+        </dict>
+        </plist>
+      ]
+      lambda { Graphtunes.get_track_list(@data) }.should raise_error
+    end
+    
+    
+    it 'should accept data that includes track data' do
+      @data = %q[
+        <?xml version="1.0" encoding="UTF-8"?>
+        <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+        <plist version="1.0">
+        <dict>
+          <key>Major Version</key><integer>1</integer>
+          <key>Tracks</key>
+      	  <dict>
+          </dict>
+        </dict>
+        </plist>
+      ]
+      lambda { Graphtunes.get_track_list(@data) }.should_not raise_error
+    end
+    
+    it 'should get the tracks' do
+      Graphtunes.expects(:get_tracks)  # NOTE: should make sure the right data is being passed
+      Graphtunes.get_track_list(@data)
+    end
+    
+    it 'should get the track ordering' do
+      Graphtunes.expects(:get_track_order)  # NOTE: should make sure the right data is being passed
+      Graphtunes.get_track_list(@data)
+    end
+    
+    it 'should order the tracks' do
+      Graphtunes.expects(:order_tracks).with(@tracks, @order)
+      Graphtunes.get_track_list(@data)
+    end
+    
+    it 'should return the ordered tracks' do
+      ordered = stub('ordered tracks')
+      Graphtunes.stubs(:order_tracks).returns(ordered)
+      Graphtunes.get_track_list(@data).should == ordered
+    end
+  end
+  
+  it 'should get tracks' do
+    Graphtunes.should respond_to(:get_tracks)
+  end
+  
+  describe 'getting tracks' do
+    before :each do
+      @key = '1234'
+      input = %Q[
+        <dict>
+          <key>#{@key}</key>
+          <dict>
+            <key>Track ID</key><integer>#{@key}</integer>
+          </dict>
+        </dict>
+      ]
+      @data = get_track_list(input)
+      Graphtunes.stubs(:extract_track_data)
+    end
+    
+    def get_track_list(data)
+      REXML::Document.new(data).root
+    end
+    
+    it 'should require data' do
+      lambda { Graphtunes.get_tracks }.should raise_error(ArgumentError)
+    end
+    
+    it 'should accept data' do
+      lambda { Graphtunes.get_tracks(@data) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should extract track data' do
+      Graphtunes.expects(:extract_track_data) # NOTE: should make sure the right data is being passed
+      Graphtunes.get_tracks(@data)
+    end
+    
+    it 'should return the extracted track data' do
+      val = stub('extracted track data')
+      Graphtunes.expects(:extract_track_data).returns(val)
+      Graphtunes.get_tracks(@data)[@key].should == val
+    end
+    
+    it 'should extract track data for each track' do
+      input = %q[
+        <dict>
+          <key>1234</key>
+          <dict>
+            <key>Track ID</key><integer>1234</integer>
+          </dict>
+          <key>12345</key>
+          <dict>
+            <key>Track ID</key><integer>12345</integer>
+          </dict>
+        </dict>
+      ]
+      @data = get_track_list(input)
+      Graphtunes.expects(:extract_track_data).times(2)  # NOTE: should make sure the right data is being passed
+      Graphtunes.get_tracks(@data)
+    end
+    
+    it 'should not extract track data if there are no tracks' do
+      input = %q[
+        <dict>
+        </dict>
+      ]
+      @data = get_track_list(input)
+      Graphtunes.expects(:extract_track_data).never
+      Graphtunes.get_tracks(@data)
+    end
+  end
+  
+  it 'should extract track data' do
+    Graphtunes.should respond_to(:extract_track_data)
+  end
+  
+  describe 'extracting track data' do
+    before :each do
+      @id     = '1234'
+      @name   = 'track name'
+      @artist = 'track artist'
+      @album  = 'track album'
+      @bpm    = 50
+      
+      input = %Q[
+        <dict>
+          <key>Track ID</key><integer>#{@id}</integer>
+          <key>Name</key><string>#{@name}</string>
+          <key>Artist</key><string>#{@artist}</string>
+          <key>Album</key><string>#{@album}</string>
+          <key>BPM</key><integer>#{@bpm}</integer>
+        </dict>
+      ]
+      @data = get_track_data(input)
+    end
+    
+    def get_track_data(data)
+      REXML::Document.new(data).root
+    end
+    
+    it 'should require data' do
+      lambda { Graphtunes.extract_track_data }.should raise_error(ArgumentError)
+    end
+    
+    it 'should accept data' do
+      lambda { Graphtunes.extract_track_data(@data) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should extract the track ID if present' do
+      Graphtunes.extract_track_data(@data)['Track ID'].should == @id
+    end
+    
+    it 'should not bother with the track ID if absent' do
+      input = %Q[
+        <dict>
+          <key>Name</key><string>#{@name}</string>
+          <key>Artist</key><string>#{@artist}</string>
+          <key>Album</key><string>#{@album}</string>
+          <key>BPM</key><integer>#{@bpm}</integer>
+        </dict>
+      ]
+      @data = get_track_data(input)
+      Graphtunes.extract_track_data(@data).should_not include('Track ID')
+    end
+    
+    it 'should extract the track name if present' do
+      Graphtunes.extract_track_data(@data)['Name'].should == @name
+    end
+    
+    it 'should not bother with the track name if absent' do
+      input = %Q[
+        <dict>
+          <key>Track ID</key><integer>#{@id}</integer>
+          <key>Artist</key><string>#{@artist}</string>
+          <key>Album</key><string>#{@album}</string>
+          <key>BPM</key><integer>#{@bpm}</integer>
+        </dict>
+      ]
+      @data = get_track_data(input)
+      Graphtunes.extract_track_data(@data).should_not include('Name')
+    end
+    
+    it 'should extract the track artist if present' do
+      Graphtunes.extract_track_data(@data)['Artist'].should == @artist
+    end
+    
+    it 'should not bother with the track artist if absent' do
+      input = %Q[
+        <dict>
+          <key>Track ID</key><integer>#{@id}</integer>
+          <key>Name</key><string>#{@name}</string>
+          <key>Album</key><string>#{@album}</string>
+          <key>BPM</key><integer>#{@bpm}</integer>
+        </dict>
+      ]
+      @data = get_track_data(input)
+      Graphtunes.extract_track_data(@data).should_not include('Artist')
+    end
+    
+    it 'should extract the track album if present' do
+      Graphtunes.extract_track_data(@data)['Album'].should == @album
+    end
+    
+    it 'should not bother with the track album if absent' do
+      input = %Q[
+        <dict>
+          <key>Track ID</key><integer>#{@id}</integer>
+          <key>Name</key><string>#{@name}</string>
+          <key>Artist</key><string>#{@artist}</string>
+          <key>BPM</key><integer>#{@bpm}</integer>
+        </dict>
+      ]
+      @data = get_track_data(input)
+      Graphtunes.extract_track_data(@data).should_not include('Album')
+    end
+    
+    it 'should extract the track BPM if present' do
+      Graphtunes.extract_track_data(@data)['BPM'].should == @bpm
+    end
+    
+    it 'should not bother with the track BPM if absent' do
+      input = %Q[
+        <dict>
+          <key>Track ID</key><integer>#{@id}</integer>
+          <key>Name</key><string>#{@name}</string>
+          <key>Artist</key><string>#{@artist}</string>
+          <key>Album</key><string>#{@album}</string>
+        </dict>
+      ]
+      @data = get_track_data(input)
+      Graphtunes.extract_track_data(@data).should_not include('BPM')
+    end
+  end
+  
+  it 'should get the track ordering' do
+    Graphtunes.should respond_to(:get_track_order)
+  end
+  
+  describe 'getting the track order' do
+    before :each do
+      input = %q[
+        <?xml version="1.0" encoding="UTF-8"?>
+        <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+        <plist version="1.0">
+        <dict>
+          <key>Tracks</key>
+          <dict>
+          </dict>
+          <key>Playlists</key>
+          <array>
+            <dict>
+              <key>Name</key><string>Some Playlist</string>
+              <key>Playlist Items</key>
+              <array>
+                <dict>
+                  <key>Track ID</key><integer>1234</integer>
+                </dict>
+                <dict>
+                  <key>Track ID</key><integer>12345</integer>
+                </dict>
+                <dict>
+                  <key>Track ID</key><integer>123</integer>
+                </dict>
+              </array>
+            </dict>
+          </array>
+        </dict>
+        </plist>
+      ]
+      @data = REXML::Document.new(input)
+    end
+    
+    it 'should require data' do
+      lambda { Graphtunes.get_track_order }.should raise_error(ArgumentError)
+    end
+    
+    it 'should accept data' do
+      lambda { Graphtunes.get_track_order(@data) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should return the order' do
+      Graphtunes.get_track_order(@data).should == ['1234', '12345', '123']
+    end
+  end
+  
+  it 'should order the tracks' do
+    Graphtunes.should respond_to(:order_tracks)
+  end
+  
+  describe 'ordering tracks' do
+    before :each do
+      @vals = Array.new(6) { |i|  stub("track #{i}") }
+      @tracks = {}
+      1.upto(5) do |i|
+        @tracks[i.to_s] = @vals[i]
+      end
+      @order  = ['5', '3', '2', '4', '1']
+    end
+    
+    it 'should require tracks' do
+      lambda { Graphtunes.order_tracks }.should raise_error(ArgumentError)
+    end
+    
+    it 'should require order' do
+      lambda { Graphtunes.order_tracks(@tracks) }.should raise_error(ArgumentError)
+    end
+    
+    it 'should accept tracks and order' do
+      lambda { Graphtunes.order_tracks(@tracks, @order) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should return the tracks in the specified order' do
+      Graphtunes.order_tracks(@tracks, @order).should == @vals.values_at(5,3,2,4,1)
+    end
+  end
+  
+  it 'should graph the data' do
+    Graphtunes.should respond_to(:graph)
+  end
+  
+  describe 'graphing the data' do
+    before :each do
+      @data = [
+        { 'BPM' => 5 },
+        { 'BPM' => 4 },
+        { 'BPM' => 6 },
+        { 'BPM' => 1 },
+        { 'BPM' => 2 }
+      ]
+      @filename = 'outfile.png'
+      @graph = stub('graph', :data => nil, :hide_dots= => nil, :write => nil)
+      Gruff::Line.stubs(:new).returns(@graph)
+    end
+    
+    it 'should require data' do
+      lambda { Graphtunes.graph }.should raise_error(ArgumentError)
+    end
+    
+    it 'should require a filename' do
+      lambda { Graphtunes.graph(@data) }.should raise_error(ArgumentError)
+    end
+    
+    it 'should accept data and a filename' do
+      lambda { Graphtunes.graph(@data, @filename) }.should_not raise_error(ArgumentError)
+    end
+    
+    it 'should create a line graph' do
+      Gruff::Line.expects(:new).returns(@graph)
+      Graphtunes.graph(@data, @filename)
+    end
+    
+    it 'should create a line for the BPMs' do
+      @graph.expects(:data).with('BPM', [5, 4, 6, 1, 2])
+      Graphtunes.graph(@data, @filename)
+    end
+    
+    it 'should hide dots' do
+      @graph.expects(:hide_dots=).with(true)
+      Graphtunes.graph(@data, @filename)
+    end
+    
+    it 'should output the graph' do
+      @graph.expects(:write)
+      Graphtunes.graph(@data, @filename)
+    end
+    
+    it 'should use the supplied filename for graph output' do
+      @graph.expects(:write).with(@filename)
+      Graphtunes.graph(@data, @filename)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+# this is my favorite way to require ever
+begin
+  require 'mocha'
+rescue LoadError
+  require 'rubygems'
+  gem 'mocha'
+  require 'mocha'
+end
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'graphtunes'

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/tasks/website.rake

@@ -0,0 +1,9 @@
+# stubs for the website generation
+# To install the website framework:
+#   script/generate website
+
+task :website_generate
+
+task :website_upload
+
+task :website => :publish_docs

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: graphtunes
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Yossef Mendelssohn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-03 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: for visualization of music playlist data
+email: 
+- ymendel@pobox.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- config/hoe.rb
+- config/requirements.rb
+- lib/graphtunes.rb
+- lib/graphtunes/version.rb
+- script/console
+- script/destroy
+- script/generate
+- setup.rb
+- spec/graphtunes_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/deployment.rake
+- tasks/environment.rake
+- tasks/rspec.rake
+- tasks/website.rake
+has_rdoc: true
+homepage: http://yomendel.rubyforge.org
+post_install_message: ""
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: yomendel
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: for visualization of music playlist data
+test_files: []
+