spinna 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ade338315b39f54cf3ba9a615c6dfa12cc361cbe
-  data.tar.gz: a0b6a23bd1b0716c67bed3445561d7686c5c86f0
+  metadata.gz: 00e1136dcfb00747d5be9846956575382fb00892
+  data.tar.gz: c2a0680d7623897bbde5ee57dcfcd8639d87df1b
 SHA512:
-  metadata.gz: 039b7c87100b437bc5fd2d02aa769a9315637a5b6d4beb15aa1e6e2f339c66791cf9ec5f4f0b3d1f6655b4b87fce3ea58fa8e725a023b16a1b9915b3e9de025d
-  data.tar.gz: 843f620f9984395abb340b6e63074bb380abf5f478a4d15ea7c8037f54688efcd03496d6ab558327227e50dd7c32410bc1f33be9fcc766742e1f4cf3b028fad3
+  metadata.gz: d9d735075b974c50d9a5d9fdfedac6786d0caf2361ef812b6ee838c404e250f680efc96a28e8e791eba30441915a9fcdf481f01f93b4ea0903934c8cfb012498
+  data.tar.gz: 65b7489e861410157bb422cb84a06725bace93eb85939b37b89f5a899304b0100425b311d893ffa8f368f882a1866e4c89a52c754d4f6ada11a5b6ac176628d0

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## 0.0.2 - 2014-08-02
+
+### Added
+- Nothing.
+
+### Deprecated
+- Nothing.
+
+### Removed
+- Nothing.
+
+### Fixed
+- Cleaned up the specs.
+- Now displays a proper error if the source_dir does not exist.
+
+## 0.0.1 - 2014-07-31
+
+### Added
+- Initial release!
+- Spinna::Client
+- Spinna::Config
+- Spinna::History
+- Spinna::MusicLibrary
+- Spinna::Picker
+- Basic command-line interface using Thor.
+
+### Deprecated
+- Nothing.
+
+### Removed
+- Nothing.
+
+### Fixed
+- Nothing.

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in spinna.gemspec
 gemspec
+

data/README.md

@@ -9,6 +9,12 @@ to my current working directory. It will also keep track of the selections made
 in order to improve the rotation by not allowing a recently selected album to be
 selected again.
 
+Spinna works great if your music collection is organized as a music directory
+containing a flat structure of directories where each directory is an album.
+It’s also helpful if the album folder names follow a proper naming scheme. I
+use `<ARTIST NAME> - <YEAR> - <ALBUM TITLE>` which allows me to filter albums
+on artist name or album year.
+
 ## Requirements
 
 Spinna requires Ruby 1.9+.
@@ -48,7 +54,7 @@ To run, simply do:
 
 `spinna get`
 
-and it will download picks in the current working directory.
+and it will download the default number of picks in the current working directory.
 
 You can also request a given number of picks if you want:
 
@@ -57,6 +63,15 @@ You can also request a given number of picks if you want:
 and it will pick 10 albums from your music library and download them
 in the current working directory.
 
+You can also pass in a pattern to only pick from matching albums. The
+following would pick 10 albums from the albums that contain the string
+"2014".
+
+`spinna get -n 10 -p 2014`
+
+## Tests
+
+To run the test, run `bundle exec rake`.
 
 ## Contributing
 

data/lib/spinna.rb

@@ -9,4 +9,8 @@ module Spinna
 
   # Raised when the configuration file is not valid.
   class InvalidConfigFileError < Error; end
+
+  # Raised when the source_dir does not exist.
+  class InvalidSourceDirError < Error; end
 end
+

data/lib/spinna/cli.rb

@@ -21,3 +21,4 @@ module Spinna
     end
   end
 end
+

data/lib/spinna/client.rb

@@ -42,3 +42,4 @@ module Spinna
     end
   end
 end
+

data/lib/spinna/config.rb

@@ -49,6 +49,10 @@ module Spinna
       unless source_dir
         raise Spinna::InvalidConfigFileError, "You must set a source_dir in your configuration file."
       end
+
+      unless Dir.exists?(source_dir)
+        raise Spinna::InvalidSourceDirError, "The source_dir #{source_dir} does not exist."
+      end
     end
 
     def ensure_data_dir_exists

data/lib/spinna/history.rb

@@ -74,3 +74,4 @@ module Spinna
     end
   end
 end
+

data/lib/spinna/music_library.rb

@@ -34,3 +34,4 @@ module Spinna
     end
   end
 end
+

data/lib/spinna/picker.rb

@@ -50,3 +50,4 @@ module Spinna
     end
   end
 end
+

data/lib/spinna/version.rb

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

data/spec/fixtures/data_dir/config.yml

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

data/spec/unit/config_spec.rb

@@ -21,10 +21,6 @@ describe Spinna::Config do
     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
@@ -43,17 +39,19 @@ describe Spinna::Config do
       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
+      before do
+        YAML.stubs(:load_file).returns("&&&foo")
+      end
+
       it 'throws an exception' do
         opts = {
-          :data_dir => data_dir,
-          :config_file => 'config1.yml'
+          :data_dir => data_dir
         }
         err = proc { Spinna::Config.new(opts) }.must_raise Spinna::InvalidConfigFileError
         err.message.must_match %r{Could not parse the configuration file.}
@@ -61,16 +59,32 @@ describe Spinna::Config do
     end
 
     context 'when the source_dir config parameter is missing' do
+      before do
+        YAML.stubs(:load_file).returns({'foo' => 'bar'})
+      end
+
       it 'throws an exception' do
-        opts = {
-          :data_dir => data_dir,
-          :config_file => 'config2.yml'
-        }
+        opts = {:data_dir => data_dir}
         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 source_dir does not actually exist on the filesystem' do
+      before do
+        YAML.stubs(:load_file).returns({
+          'source_dir' => '/this/dir/does/not/exist'
+        })
+      end
+
+      it 'throws an exception' do
+        opts = {
+          :data_dir => data_dir
+        }
+        proc { Spinna::Config.new(opts) }.must_raise Spinna::InvalidSourceDirError
+      end
+    end
+
     context 'when the configuration is valid and all parameters were provided' do
       it 'sets the source_dir' do
         opts = {
@@ -78,7 +92,7 @@ describe Spinna::Config do
           :config_file => 'config.yml'
         }
         config = Spinna::Config.new(opts)
-        config.source_dir.must_equal '/foo'
+        config.source_dir.must_equal '/tmp'
       end
 
       it 'sets the history_size' do
@@ -101,25 +115,32 @@ describe Spinna::Config do
     end
 
     context 'when the configuration is valid but the history_size was not provided' do
+      let(:opts) { {:data_dir => data_dir} }
+
+      subject { Spinna::Config.new(opts) }
+
+      before do
+        YAML.stubs(:load_file).returns({'source_dir' => '/tmp'})
+      end
+
       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
+        subject.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
+      let(:opts) { {:data_dir => data_dir} }
+
+      subject { Spinna::Config.new(opts) }
+
+      before do
+        YAML.stubs(:load_file).returns({'source_dir' => '/tmp'})
+      end
+
       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
+        subject.number_of_picks.must_equal Spinna::Config::DEFAULT_NUMBER_OF_PICKS
       end
     end
   end
 end
+

data/spec/unit/history_spec.rb

@@ -5,7 +5,7 @@ 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(:config) { stub(:data_dir => data_dir, :history_size => 10 ) }
   let(:history_size) { 3 }
 
   describe '#new' do
@@ -41,8 +41,8 @@ describe Spinna::History do
     end
 
     context 'when the history log is full' do
+      let(:config) { stub(:data_dir => data_dir, :history_size => 3) }
       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'
@@ -69,14 +69,14 @@ describe Spinna::History do
 
   describe '#save' do
     # This is used to fake writing the history.log file.
-    let(:fake_history_log) { StringIO.new('', 'w+') }
+    let(:history_log) { StringIO.new('', 'w+') }
 
+    subject { Spinna::History.new(config) }
     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)
+      File.expects(:open).with(subject.history_path, 'w+').yields(history_log)
       subject.save
-      fake_history_log.string.must_equal "album 1\nalbum 2\nalbum 3\n"
+      history_log.string.must_equal "album 1\nalbum 2\nalbum 3\n"
     end
   end
 end
+

data/spinna.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Spinna::VERSION
   spec.authors       = ["Patrick Paul-Hus"]
   spec.email         = ["hydrozen@gmail.com"]
-  spec.summary       = %q{Randomly picks albums from your music library to keep things fresh.}
+  spec.summary       = %q{Randomly picks albums from your music library so you don’t have to.}
   spec.description   = ""
   spec.homepage      = "https://github.com/hydrozen/spinna"
   spec.license       = "MIT"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spinna
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Patrick Paul-Hus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-31 00:00:00.000000000 Z
+date: 2014-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,6 +132,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -185,7 +186,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Randomly picks albums from your music library to keep things fresh.
+summary: Randomly picks albums from your music library so you don’t have to.
 test_files:
 - spec/fixtures/data_dir/config.yml
 - spec/fixtures/data_dir/config1.yml