spinna 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ade338315b39f54cf3ba9a615c6dfa12cc361cbe
+  data.tar.gz: a0b6a23bd1b0716c67bed3445561d7686c5c86f0
+SHA512:
+  metadata.gz: 039b7c87100b437bc5fd2d02aa769a9315637a5b6d4beb15aa1e6e2f339c66791cf9ec5f4f0b3d1f6655b4b87fce3ea58fa8e725a023b16a1b9915b3e9de025d
+  data.tar.gz: 843f620f9984395abb340b6e63074bb380abf5f478a4d15ea7c8037f54688efcd03496d6ab558327227e50dd7c32410bc1f33be9fcc766742e1f4cf3b028fad3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - "2.1.1"
+  - jruby-19mode # JRuby in 1.9 mode
+
+script: bundle exec rake test

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Patrick Paul-Hus
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Spinna
+
+I have a *lot* of music. This little application helps me make sure that I don’t
+always listen to the same stuff because I seem to be really bad at randomizing
+my album selection.
+
+Spinna will simply select some random albums from a given location and copy them
+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.
+
+## Requirements
+
+Spinna requires Ruby 1.9+.
+
+## Installation
+
+`gem install spinna`
+
+## Configuration
+
+First, spinna needs to be configured. Create a folder named `.spinna` in
+your home directory and create a file named `config.yml`. If you run spinna
+before creating the folder in your home directory, it will be created but
+you will have to create the config file yourself.
+
+The configuration file should look like this:
+
+```yaml
+source_dir: '/foo'
+history_size: 50
+number_of_picks: 10
+```
+
+The `source_dir` represents the location of your music library on your filesystem.
+It is assumed that this directory contains a flat hierarchy of folders, your albums.
+It is required.
+
+The `history_size` is how many picks do we keep in the history log before we start
+removing the older picks. If you do not supply it, the default value is 50.
+
+The `number_of_picks` represents the default number of album picks you want Spinna
+to make when you run it. If you do not supply it, the default value is 10.
+
+## Usage
+
+To run, simply do:
+
+`spinna get`
+
+and it will download picks in the current working directory.
+
+You can also request a given number of picks if you want:
+
+`spinna get -n 10`
+
+and it will pick 10 albums from your music library and download them
+in the current working directory.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/hydrozen/spinna/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+task :console do
+  require 'pry'
+  require 'spinna'
+  ARGV.clear
+  Pry.start
+end

data/bin/spinna

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require 'spinna/cli'
+
+Spinna::CLI.start(ARGV)

data/lib/spinna.rb

@@ -0,0 +1,12 @@
+require "spinna/version"
+
+module Spinna
+  # Base class for all errors.
+  class Error < StandardError; end
+
+  # Raised when the configuration file was not found.
+  class ConfigFileNotFoundError < Error; end
+
+  # Raised when the configuration file is not valid.
+  class InvalidConfigFileError < Error; end
+end

data/lib/spinna/cli.rb

@@ -0,0 +1,23 @@
+require 'thor'
+require 'yaml'
+require 'spinna'
+require 'spinna/client'
+
+module Spinna
+  class CLI < Thor
+    desc 'get', 'Downloads some fresh music'
+    method_option :number_of_picks, :aliases => '-n', :type => :numeric
+    method_option :pattern, :aliases => '-p', :type => :string
+
+    def get
+      begin
+        client = Client.new
+        client.get(options)
+        exit 0
+      rescue StandardError => e
+        puts e.message
+        exit 1
+      end
+    end
+  end
+end

data/lib/spinna/client.rb

@@ -0,0 +1,44 @@
+require 'fileutils'
+require 'spinna/history'
+require 'spinna/config'
+require 'spinna/picker'
+require 'spinna/music_library'
+
+module Spinna
+  # The client takes care of initializing the application by reading
+  # the configuration and the history. It exposes the various commands
+  # that spinna can do.
+  class Client
+    attr_accessor :library
+    attr_accessor :config
+    attr_accessor :history
+
+    # Boots the application.
+    def initialize
+      init_configuration
+      init_history
+      init_library
+    end
+
+    # Get a certain number of random albums from the music collection.
+    def get(opts = {})
+      number_of_picks = opts[:number_of_picks] || config.number_of_picks
+      pattern = opts[:pattern] || nil
+      Picker.new(config, history, library).pick(number_of_picks, pattern)
+    end
+
+    private
+
+    def init_configuration
+      @config = Config.new
+    end
+
+    def init_history
+      @history = Spinna::History.new(config)
+    end
+
+    def init_library
+      @library = Spinna::MusicLibrary.new(config, history)
+    end
+  end
+end

data/lib/spinna/config.rb

@@ -0,0 +1,86 @@
+require 'yaml'
+require 'spinna'
+
+module Spinna
+  # Takes care of reading the configuration file and exposing
+  # the settings.
+  class Config
+    # Default number of albums to keep in the history.
+    DEFAULT_HISTORY_SIZE = 50
+
+    # Default number of albums to pick when spinna is run.
+    DEFAULT_NUMBER_OF_PICKS = 10
+
+    # The directory where spinna stores its data.
+    attr_accessor :data_dir
+
+    # The directory where all the albums are stored.
+    attr_accessor :source_dir
+
+    # The number previously picked albums to keep in the
+    # history. Defaults to DEFAULT_NUMBER_OF_PICKS.
+    attr_accessor :history_size
+
+    # The number of picks to fetch if not explicitly given.
+    attr_accessor :number_of_picks
+
+    # The name of the config file to load. (ex: config.yml)
+    attr_accessor :config_file
+
+    def initialize(opts = {})
+      @data_dir = opts[:data_dir] || ENV['SPINNA_DATA_DIR'] || File.join(Dir.home, '.spinna')
+      @config_file = opts[:config_file] || 'config.yml'
+      ensure_data_dir_exists
+      ensure_configuration_exists
+      parse_configuration
+    end
+
+    private
+
+    def parse_configuration
+      config = read_configuration_file
+      @source_dir = config['source_dir']
+      @history_size = config['history_size'] || DEFAULT_HISTORY_SIZE
+      @number_of_picks = config['number_of_picks'] || DEFAULT_NUMBER_OF_PICKS
+      validate_config
+    end
+
+    def validate_config
+      unless source_dir
+        raise Spinna::InvalidConfigFileError, "You must set a source_dir in your configuration file."
+      end
+    end
+
+    def ensure_data_dir_exists
+      if !File.exists?(data_dir)
+        Dir.mkdir(data_dir, 0700)
+        raise Spinna::ConfigFileNotFoundError, "Could not find the configuration file. Please create it at #{config_path}."
+      end
+    end
+
+    def ensure_configuration_exists
+      unless config_file_exists?
+        raise Spinna::ConfigFileNotFoundError, "Could not find the configuration file. Please create it at #{config_path}."
+      end
+    end
+
+    def read_configuration_file
+      begin
+        config = YAML.load_file(File.join(data_dir, config_file))
+        raise StandardError unless config.is_a?(Hash)
+      rescue StandardError
+        raise Spinna::InvalidConfigFileError, "Could not parse the configuration file. Please make sure it is valid YAML."
+      end
+      config
+    end
+
+    def config_path
+      File.join(data_dir, config_file)
+    end
+
+    def config_file_exists?
+      File.exists?(config_path)
+    end
+  end
+end
+

data/lib/spinna/history.rb

@@ -0,0 +1,76 @@
+require 'spinna/config'
+
+module Spinna
+  # Takes care of tracking the picks that have been recently made
+  # so that they are not picked again too soon. The log is persisted
+  # in ~/.spinna/history.log by default.
+  class History
+    # The configuration of the application.
+    attr_reader :config
+
+    # An array that represents the log entries.
+    # The oldest entries are first.
+    attr_reader :log
+
+    def initialize(config)
+      @config = config
+      read_history_log
+    end
+
+    # Add album at the end of the history log unless it’s
+    # already in there.
+    def append(album)
+      @log << album unless @log.include?(album)
+      trim if full?
+    end
+
+    # Is the given album in the history already?
+    def include?(album)
+      @log.include?(album)
+    end
+
+    # Saves the history to file after removing old picks
+    # from the log if needed.
+    def save
+      write_history_to_disk
+    end
+
+    # Returns the path to the history log file on the filesystem.
+    def history_path
+      File.join(config.data_dir, 'history.log')
+    end
+
+    private
+
+    # Are there more albums in the log than there should be?
+    def full?
+      @log.size > config.history_size
+    end
+
+    # Deletes the old albums that are now outdated depending
+    # on the history_size.
+    def trim
+      @log = @log.last(config.history_size)
+    end
+
+    def write_history_to_disk
+      File.open(history_path, 'w+') do |f|
+        @log.each { |album| f.puts album }
+      end
+    end
+
+    # Reads the history.log file and stores all the lines
+    # in an array.
+    def read_history_log
+      if !history_file_exists?
+        @log = [] and return
+      end
+
+      @log = File.read(history_path).split("\n")
+    end
+
+    def history_file_exists?
+      File.exists?(history_path)
+    end
+  end
+end

data/lib/spinna/music_library.rb

@@ -0,0 +1,36 @@
+module Spinna
+  # This class encapsulates the access to the music library.
+  class MusicLibrary
+    def initialize(config, history)
+      @config = config
+      @history = history
+    end
+
+    # Returns the albums that are pickable. An album is pickable
+    # if it isn’t present in the history log. If a pattern is given,
+    # then only the albums that match the pattern will be returned.
+    def pickable_albums(pattern = nil)
+      return available_albums unless pattern
+      available_albums.select! { |a| a =~ Regexp.new(pattern)}
+    end
+
+    private
+
+    attr_reader :config
+    attr_reader :history
+
+    def albums
+      Dir.entries(config.source_dir).reject! { |i| i =~ /\A\./ }
+    end
+
+    # Returns the list of previously selected albums.
+    def previously_selected_albums
+      history.log
+    end
+
+    # Returns only the albums that are available for selection.
+    def available_albums
+      albums - previously_selected_albums
+    end
+  end
+end

data/lib/spinna/picker.rb

@@ -0,0 +1,52 @@
+module Spinna
+  # The picker is responsible for reading the media library, selecting
+  # albums from it and updating the history log. Basically, it does the
+  # grunt work.
+  class Picker
+    def initialize(config, history, library)
+      @config = config
+      @history = history
+      @library = library
+    end
+
+    # Picks the requested number of picks from the available albums.
+    def pick(number_of_picks, pattern = nil)
+      picks = pick_albums(number_of_picks, pattern)
+      copy_picks(picks)
+      update_history(picks)
+      picks
+    end
+
+    private
+
+    attr_accessor :config
+    attr_accessor :history
+    attr_accessor :library
+
+    def pick_albums(number_of_picks, pattern = nil)
+      albums = library.pickable_albums(pattern)
+      return albums if number_of_picks >= albums.size
+      choose_random_picks(number_of_picks, albums)
+    end
+
+    # Does the actual picking of random albums.
+    def choose_random_picks(number_of_picks, albums)
+      return albums if albums.size < number_of_picks
+      albums.sample(number_of_picks)
+    end
+
+    # Copies the picks to the current working directory.
+    def copy_picks(picks)
+      picks.each do |pick|
+        puts "Copying #{pick}..."
+        FileUtils.cp_r("#{config.source_dir}/#{pick}", Dir.pwd)
+      end
+    end
+
+    # Updates the history.
+    def update_history(picks)
+      picks.each { |pick| history.append(pick) }
+      history.save
+    end
+  end
+end