spinna 0.0.1

data/lib/spinna/version.rb

@@ -0,0 +1,3 @@
+module Spinna
+  VERSION = "0.0.1"
+end

data/spec/fixtures/data_dir/config.yml

@@ -0,0 +1,3 @@
+source_dir: '/foo'
+history_size: 10
+number_of_picks: 5

data/spec/fixtures/data_dir/config1.yml

@@ -0,0 +1,2 @@
+This is not a valid configuration file
+so it will blow up.

data/spec/fixtures/data_dir/config2.yml

@@ -0,0 +1,3 @@
+# This configuration does not have a source_dir set.
+foo: 'meh'
+bar: 'blah'

data/spec/fixtures/data_dir/config3.yml

@@ -0,0 +1,4 @@
+# This configuration does not set the history_size
+
+source_dir: '/foo'
+number_of_picks: 5

data/spec/fixtures/data_dir/config4.yml

@@ -0,0 +1,4 @@
+# This configuration does not set the number of picks.
+
+source_dir: '/foo'
+history_size: 10

data/spec/fixtures/data_dir/history.log

@@ -0,0 +1,3 @@
+album 1
+album 2
+album 3

data/spec/functional/get_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+require 'open3'
+
+describe 'spinna get' do
+  before do
+    create_fake_source_dir
+    create_fake_data_dir
+    @download_dir = create_tmp_download_dir
+    ENV['SPINNA_DATA_DIR'] = File.join(Dir.tmpdir, 'spinna')
+    @wd = Dir.getwd
+    Dir.chdir(@download_dir)
+  end
+
+  after do
+    ENV.delete('SPINNA_DATA_DIR')
+    Dir.chdir(@wd)
+  end
+
+  context 'when used without any options' do
+    before do
+      Open3.popen3("#{@wd}/bin/spinna get") do |stdin, stdout, stderr, wait_thr|
+        @stdout = stdout.read
+        @stderr = stderr.read
+        @exit_status = wait_thr.value
+      end
+    end
+
+    it 'gets the number of albums set in the config from source_dir' do
+      # It must not have output any errors.
+      @stderr.must_be_empty
+
+      # Gets the correct number of picks
+      picks = @stdout.split("\n")
+      picks.size.must_equal 2
+
+      # Exits with a successful exit code
+      @exit_status.success?.must_equal true
+
+      # It added the picks to the history log
+      history = File.read("#{ENV['SPINNA_DATA_DIR']}/history.log")
+      history.split("\n").size.must_equal 2
+    end
+  end
+
+  context 'when given a -n (--number_of_picks) option' do
+    before do
+      Open3.popen3("#{@wd}/bin/spinna get -n 3") do |stdin, stdout, stderr, wait_thr|
+        @stdout = stdout.read
+        @stderr = stderr.read
+        @exit_status = wait_thr.value
+      end
+    end
+
+    it 'gets that number of albums from source_dir' do
+      # It must not output any errors
+      @stderr.must_be_empty
+
+      # Gets the correct number of picks
+      # picks = @stdout.split("\n")
+      # picks.size.must_equal 3
+
+      # Exits with a successful exit code
+      @exit_status.success?.must_equal true
+
+      # It updates the history log
+      history = File.read("#{ENV['SPINNA_DATA_DIR']}/history.log")
+      history.split("\n").size.must_equal 3
+    end
+  end
+
+  context 'when given a -p (--pattern) option' do
+    before do
+      Open3.popen3("#{@wd}/bin/spinna get -p \"album 1\" -n 1") do |stdin, stdout, stderr, wait_thr|
+        @stdout = stdout.read
+        @stderr = stderr.read
+        @exit_status = wait_thr.value
+      end
+    end
+
+    it 'picks only albums that match the given pattern' do
+      # It must not output any errors
+      @stderr.must_be_empty
+
+      # Gets the correct number of picks
+      picks = @stdout.split("\n")
+      picks.size.must_equal 1
+
+      # The pick should match the given pattern
+      picks.first.must_equal "Copying album 1..."
+
+      # Exits with a successful exit code
+      @exit_status.success?.must_equal true
+
+      # It updates the history log
+      history = File.read("#{ENV['SPINNA_DATA_DIR']}/history.log")
+      history.split("\n").size.must_equal 1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/pride'
+require 'minitest-spec-context'
+require 'mocha/mini_test'
+require 'minitest/reporters'
+require 'tmpdir'
+require 'fileutils'
+
+Minitest::Reporters.use! Minitest::Reporters::DefaultReporter.new(:color => true)
+
+def create_fake_source_dir
+  path = File.join(Dir.tmpdir, 'spinna_source_dir')
+  FileUtils.rm_rf(path)
+  FileUtils.mkdir(path)
+  5.times do |i|
+    FileUtils.mkdir(File.join(path, "album #{i+1}"))
+  end
+end
+
+def create_fake_data_dir
+  path = File.join(Dir.tmpdir, 'spinna')
+  FileUtils.rm_rf(path)
+  FileUtils.mkdir(path)
+  config = {
+    'source_dir' => File.join(Dir.tmpdir, 'spinna_source_dir'),
+    'history_size' => 4,
+    'number_of_picks' => 2
+  }
+  config_path = File.join(path, 'config.yml')
+  File.open(config_path, 'w+') do |f|
+    f.write config.to_yaml
+  end
+end
+
+def create_tmp_download_dir
+  path = File.join(Dir.tmpdir, 'spinna_download_dir')
+  FileUtils.rm_rf(path)
+  FileUtils.mkdir(path)
+  path
+end

data/spec/unit/client_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+require 'spinna/client'
+
+describe Spinna::Client do
+  describe '.new' do
+    let(:config) { stub() }
+    let(:history) { stub() }
+    let(:picker) { stub() }
+    let(:music_library) { stub() }
+
+    before do
+      Spinna::Config.expects(:new).returns(config)
+      Spinna::History.expects(:new).returns(history)
+      Spinna::MusicLibrary.expects(:new).returns(music_library)
+    end
+
+    subject { Spinna::Client.new }
+
+    it 'assigns a config object to an instance variable' do
+      subject.config.must_equal config
+    end
+
+    it 'assigns a history object to an instance variable' do
+      subject.history.must_equal history
+    end
+
+    it 'assigns a music_library object to an instance variable' do
+      subject.library.must_equal music_library
+    end
+  end
+
+  describe '#get' do
+    let(:default_number_of_picks) { 2 }
+    let(:picker) { stub }
+    let(:music_library) { stub }
+    let(:picks) { ['album 1', 'album 2'] }
+
+    before do
+      Spinna::Config.stubs(:new).returns(config)
+      Spinna::History.stubs(:new).returns(history)
+      Spinna::Picker.stubs(:new).returns(picker)
+      Spinna::MusicLibrary.stubs(:new).returns(music_library)
+    end
+
+    context 'when called without arguments' do
+      let(:config) do
+        stub(
+          :number_of_picks => default_number_of_picks,
+          :source_dir => File.expand_path("../../fixtures/source_dir", __FILE__)
+        )
+      end
+      let(:history) { stub }
+      let(:picker) do
+        picker = stub
+        picker.stubs(:pick).returns(picks)
+        picker
+      end
+
+      subject { Spinna::Client.new }
+
+      it 'requests the default number of picks from the picker' do
+        picker.expects(:pick).with(default_number_of_picks, nil)
+        subject.get
+      end
+
+      it 'returns the picks from the picker' do
+        subject.get.must_equal picks
+      end
+    end
+
+    context 'when given a number_of_picks option' do
+      let(:config) do
+        stub(
+          :number_of_picks => default_number_of_picks,
+          :source_dir => File.expand_path("../../fixtures/source_dir", __FILE__)
+        )
+      end
+      let(:history) { stub }
+      let(:picker) { stub(:pick => [picks.first]) }
+
+      subject { Spinna::Client.new }
+
+      it 'requests the given number of picks from the picker' do
+        picker.expects(:pick).with(1, nil).returns([picks.first])
+        subject.get(:number_of_picks => 1)
+      end
+
+      it 'returns the picks from the picker' do
+        subject.get(:number_of_picks => 1).must_equal [picks.first]
+      end
+    end
+
+    context 'when given a pattern' do
+      let(:config) do
+        stub(
+          :number_of_picks => default_number_of_picks,
+          :source_dir => File.expand_path("../../fixtures/source_dir", __FILE__)
+        )
+      end
+      let(:history) { stub }
+      let(:picker) { stub(:pick => [picks.first]) }
+
+      subject { Spinna::Client.new }
+
+      it 'requests the picks from the picker with the correct options' do
+        picker.expects(:pick).with(1, 'foo').returns([picks.first])
+        subject.get(:number_of_picks => 1, :pattern => 'foo')
+      end
+
+      it 'returns the picks from the picker' do
+        subject.get(:number_of_picks => 1, :pattern => 'foo').must_equal [picks.first]
+      end
+    end
+  end
+end

data/spec/unit/config_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+require 'spinna/config'
+
+describe Spinna::Config do
+  describe 'DEFAULT_HISTORY_SIZE' do
+    it 'is set to 50' do
+      Spinna::Config::DEFAULT_HISTORY_SIZE.must_equal 50
+    end
+  end
+
+  describe 'DEFAULT_NUMBER_OF_PICKS' do
+    it 'is set to 10' do
+      Spinna::Config::DEFAULT_NUMBER_OF_PICKS.must_equal 10
+    end
+  end
+
+  describe '#new' do
+    let(:data_dir) { File.expand_path("../../fixtures/data_dir", __FILE__) }
+    let(:non_existing_data_dir) { File.join(Dir.home, '.nonexisting') }
+
+    context 'when the data_dir does not exist' do
+      let(:opts) { {:data_dir => non_existing_data_dir} }
+
+      subject {
+        Hash.new(:foo => 'bar')
+      }
+
+      it 'creates it and raises error because the configuration file is missing' do
+        Dir.expects(:mkdir).with(opts[:data_dir], 0700)
+        proc { Spinna::Config.new(opts) }.must_raise Spinna::ConfigFileNotFoundError
+      end
+    end
+
+    context 'when the configuration file does not exist' do
+      let(:opts) { {:data_dir => non_existing_data_dir} }
+
+      subject do
+        Spinna::Config.new(opts)
+      end
+
+      before do
+        Dir.stubs(:mkdir)
+      end
+
+      it 'throws an exception' do
+        opts = {:data_dir => non_existing_data_dir}
+        err = proc { subject }.must_raise Spinna::ConfigFileNotFoundError
+        err.message.must_match %r{Could not find the configuration file.}
+      end
+    end
+
+    context 'when the configuration file is not valid json' do
+      it 'throws an exception' do
+        opts = {
+          :data_dir => data_dir,
+          :config_file => 'config1.yml'
+        }
+        err = proc { Spinna::Config.new(opts) }.must_raise Spinna::InvalidConfigFileError
+        err.message.must_match %r{Could not parse the configuration file.}
+      end
+    end
+
+    context 'when the source_dir config parameter is missing' do
+      it 'throws an exception' do
+        opts = {
+          :data_dir => data_dir,
+          :config_file => 'config2.yml'
+        }
+        err = proc { Spinna::Config.new(opts) }.must_raise Spinna::InvalidConfigFileError
+        err.message.must_match %r{You must set a source_dir in your configuration file.}
+      end
+    end
+
+    context 'when the configuration is valid and all parameters were provided' do
+      it 'sets the source_dir' do
+        opts = {
+          :data_dir => data_dir,
+          :config_file => 'config.yml'
+        }
+        config = Spinna::Config.new(opts)
+        config.source_dir.must_equal '/foo'
+      end
+
+      it 'sets the history_size' do
+        opts = {
+          :data_dir => data_dir,
+          :config_file => 'config.yml'
+        }
+        config = Spinna::Config.new(opts)
+        config.history_size.must_equal 10
+      end
+
+      it 'sets the number_of_picks' do
+        opts = {
+          :data_dir => data_dir,
+          :config_file => 'config.yml'
+        }
+        config = Spinna::Config.new(opts)
+        config.number_of_picks.must_equal 5
+      end
+    end
+
+    context 'when the configuration is valid but the history_size was not provided' do
+      it 'uses the default value' do
+        opts = {
+          :data_dir => data_dir,
+          :config_file => 'config3.yml'
+        }
+        config = Spinna::Config.new(opts)
+        config.history_size.must_equal Spinna::Config::DEFAULT_HISTORY_SIZE
+      end
+    end
+
+    context 'when the configuration is valid but the number_of_picks was not provided' do
+      it 'uses the default value' do
+        opts = {
+          :data_dir => data_dir,
+          :config_file => 'config4.yml'
+        }
+        config = Spinna::Config.new(opts)
+        config.number_of_picks.must_equal Spinna::Config::DEFAULT_NUMBER_OF_PICKS
+      end
+    end
+  end
+end

data/spec/unit/history_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+require 'spinna/history'
+require 'spinna/config'
+
+describe Spinna::History do
+  let(:data_dir) { File.expand_path("../../fixtures/data_dir", __FILE__) }
+  let(:opts) { {:data_dir => data_dir} }
+  let(:config) { Spinna::Config.new(opts) }
+  let(:history_size) { 3 }
+
+  describe '#new' do
+    subject { Spinna::History.new(config) }
+
+    it 'saves the passed in config in an instance variable' do
+      subject.config.must_equal config
+    end
+
+    it 'reads the history log from the filesystem' do
+      subject.log.size.must_equal history_size
+    end
+  end
+
+  describe '#append' do
+    subject { Spinna::History.new(config) }
+
+    context 'when the album is not in the history' do
+      it 'appends the album at the end of the history log' do
+        size_before_append = subject.log.size
+        subject.append('album 11')
+        subject.log.size.must_equal size_before_append + 1
+        subject.log.last.must_equal 'album 11'
+      end
+    end
+
+    context 'when the album is already in the history' do
+      it 'does nothing' do
+        size_before_append = subject.log.size
+        subject.append('album 1')
+        subject.log.size.must_equal size_before_append
+      end
+    end
+
+    context 'when the history log is full' do
+      it 'removes the old albums from the log to make room for the new albums' do
+        subject.config.history_size = 3
+        subject.append('album 4')
+        subject.log.size.must_equal 3
+        subject.log.first.must_equal 'album 2'
+        subject.log.last.must_equal 'album 4'
+      end
+    end
+  end
+
+  describe '#include?' do
+    subject { Spinna::History.new(config) }
+
+    context 'when the album is in the log' do
+      it 'returns true' do
+        subject.include?('album 1').must_equal true
+      end
+    end
+
+    context 'when the album is not in the log' do
+      it 'returns false' do
+        subject.include?('album 99').must_equal false
+      end
+    end
+  end
+
+  describe '#save' do
+    # This is used to fake writing the history.log file.
+    let(:fake_history_log) { StringIO.new('', 'w+') }
+
+    it 'saves the log to the filesystem' do
+      subject = Spinna::History.new(config)
+      # Use of mocking here so that we don’t actually write to the filesystem.
+      File.expects(:open).with(subject.history_path, 'w+').yields(fake_history_log)
+      subject.save
+      fake_history_log.string.must_equal "album 1\nalbum 2\nalbum 3\n"
+    end
+  end
+end