where_to 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12bf21fc687263650e4128a20f20d66f58ff71a6
+  data.tar.gz: b6db02bb8a8946a39f91bee3372af3af4cc9c074
+SHA512:
+  metadata.gz: b6a190544c2af1b93c48274e739cce60b7187f873f6546468919960b965208577e9baa713273959d6c238d6d9234eaa80ee1a966782d51781510847d8a89367c
+  data.tar.gz: 8cc37a1067116060f6fff99faa84ea807c0021c77870ceb5a58ea8e5bf1ef8f0920754948aa581f9d8f3706b99677ee3745b753bed621515cdd74202c7d4f16a

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/coverage/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install:
+  gem install bundler

data/Gemfile

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

data/README.md

@@ -0,0 +1,89 @@
+# WhereTo 
+[![Build Status](https://travis-ci.org/jutonz/where_to.svg)](https://travis-ci.org/jutonz/where_to)
+[![Coverage Status](https://coveralls.io/repos/jutonz/where_to/badge.svg?branch=master)](https://coveralls.io/r/jutonz/where_to?branch=master)
+
+This gem helps you maintain a directory sturucture for your mediafiles. For example, if you specify the following about a set of video files:  
+* Series title: Game of Thrones
+* Season: 5
+* Season airdate: 2015  
+
+This program tells you that they should be located in a folder called `Game of Thrones/Season 5 (2015)/`. Of course you can customize this to match whatever file structure you prefer.
+
+If you specify some more data:
+* Episode title: What a great episode
+* Episode number: 3
+
+The program will also tell you that the episode should be called `game.of.thrones.S05E03.what.a.great.episode.mkv`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem where_to, git: 'https://github.com/jutonz/where_to'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+require 'where_to'
+
+# Specify data one at a time
+locator = WhereTo::Locator.new 
+locator.series_title = 'Game of Thrones'
+locator.season = 5
+locator.season_airdate = 2015
+locator.locate # WhereTo::Location object with 'Game of Thrones/Season 5 (2015)/'
+
+# Specify data in a batch
+data = {}
+data[:series_title] = 'Game of Thrones'
+data[:season] = 5
+data[:season_airdate] = 2015
+locator = WhereTo::Locator.new data
+locator.locate
+
+# Specify episode info
+data = {}
+data[:series_title] = 'Game of Thrones'
+data[:season] = 5
+data[:season_airdate] = 2015
+data[:episode_title] = 'best episode ever'
+data[:episode_number] = 3
+locator = WhereTo::Locator.new data
+location = locator.locate
+location.folder # => Game of Thrones/Season 5 (2015)
+location.filename # => game.of.thrones.S05E02.best.episode.ever.mkv
+
+# You can specify custom file extensions
+locator.episode_extension = '.mp4'
+locator.locate.filename # => game.of.thrones.S05E02.best.episode.ever.mp4
+
+# And if you like you can specify a video quality
+locator.episode_quality = '720p'
+locator.locate.filename # => game.of.thrones.S05E02.best.episode.ever.720p.mkv
+```
+
+## Custom Formats
+Specify custom formats by modifying `format.yml`.  
+The default is `"%series_title/Season %season_number (%season_airdate)/"`, but in theory any combination works.
+
+Right now you can't change the episode filename format, but we're working on it!
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/jutonz/where_to/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,18 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :watch do
+  folders_to_watch = 'bin lib spec'
+  action_on_change = 'bundle exec rake'
+  begin 
+    gem 'filewatcher'
+    sh "filewatcher '#{folders_to_watch}' '#{action_on_change}'"
+  rescue Gem::LoadError
+    puts 'You need to have the filewatcher gem installed to perform this task.'
+    puts 'Install with \'gem install filewatcher\''
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "where_to"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/where_to/episode_formatter.rb

@@ -0,0 +1,46 @@
+module WhereTo
+  class EpisodeFormatter
+    attr_accessor :series_title, :season_number, :episode_title, :episode_number
+    attr_accessor :quality, :extension
+    DEFAULT_EXTENSION = '.mkv'
+
+    def initialize(hash = {}, series_title: hash[:series_title], season_number: hash[:season_number], episode_title: hash[:episode_title], episode_number: hash[:episode_number], extension: hash[:extension], quality: hash[:quality])
+      set_unless_nil :series_title, series_title
+      set_unless_nil :season_number, season_number
+      set_unless_nil :episode_title, episode_title
+      set_unless_nil :episode_number, episode_number
+      set_unless_nil :quality, quality
+      set_unless_nil :extension, extension, default: DEFAULT_EXTENSION
+    end
+
+    def format!
+      validate!
+      formatted = []
+      formatted << series_title.downcase.gsub(' ', '.')
+      formatted << "SxxEyy".gsub('xx', season_number.to_s.rjust(2, '0')).gsub('yy', episode_number.to_s.rjust(2, '0'))
+      formatted << episode_title.downcase.gsub(' ', '.')
+      formatted << quality.downcase if quality
+      formatted << extension.gsub('.', '') # remove . so the join is easier
+      formatted.join('.')
+    end
+
+    def validate!
+      raise 'A series title is required to format an episode title.' unless series_title
+      raise 'A season number is required to format an episode title.' unless season_number
+      raise 'An episode title is required to format an episode title.' unless episode_title
+      raise 'An episode number is required to format an episode title.' unless episode_number
+      true
+    end
+
+    private
+
+    def set_unless_nil(key, value, default: nil)
+      if value
+        send("#{key}=".to_sym, value)
+      elsif default
+        send("#{key}=".to_sym, default)
+      end
+    end
+
+  end
+end

data/lib/where_to/format.yml

@@ -0,0 +1 @@
+folder_format: "%series_title/Season %season_number (%season_airdate)/"

data/lib/where_to/location.rb

@@ -0,0 +1,30 @@
+module WhereTo
+  class Location
+    include Comparable
+    attr_accessor :folder, :filename, :location
+
+    def initialize(from_location)
+      @location = from_location
+      set_filename_folder_from_location
+    end
+
+    def <=>(other)
+      location <=> other
+    end
+
+    private
+
+    def set_filename_folder_from_location
+      split = location.split '/'
+      last  = split[-1]
+      if File.extname(last) == '' # No extension; is a directory
+        @folder   = location + '/'
+        @filename = ''
+      else
+        @filename = split.pop
+        @folder   = split.join('/') + '/'
+      end
+    end 
+
+  end
+end

data/lib/where_to/locator.rb

@@ -0,0 +1,66 @@
+require 'where_to/location'
+require 'yaml'
+
+module WhereTo
+  class Locator
+    attr_accessor :series_title, :airdate, :season, :season_airdate
+    attr_accessor :episode_title, :episode_number, :episode_quality, :episode_extension
+    FORMAT_FILE = 'lib/where_to/format.yml'
+
+    def initialize(hash = {})
+      load_values_from hash
+      @format_file = YAML.load_file FORMAT_FILE
+    end
+  
+    def locate(hash = {})
+      load_values_from hash
+      validate!
+
+      output = @format_file['folder_format']
+      output.gsub! '%series_title',   series_title
+      output.gsub! '%season_number',  season.to_s
+      output.gsub! '%season_airdate', season_airdate.to_s
+
+      if episode_title and episode_number
+        formatter = WhereTo::EpisodeFormatter.new params
+        output << formatter.format!
+      end
+
+      WhereTo::Location.new output
+    end
+
+    def validate!
+      raise 'A season airdate is required to locate an episode' if season_airdate == nil
+      raise 'A season number is required to locate an episode' if season.nil?
+      true
+    end
+
+    def params
+      _params = {}
+      _params[:series_title]   = series_title
+      _params[:season_number]  = season
+      _params[:episode_title]  = episode_title
+      _params[:episode_number] = episode_number
+      _params[:quality]        = episode_quality
+      _params[:extension]      = episode_extension
+      _params
+    end
+
+    private
+
+    def set_unless_nil(key, value)
+      send("#{key}=".to_sym, value) unless value.nil?
+    end
+
+    def load_values_from(hash = {})
+      set_unless_nil :series_title,   hash[:series_title]
+      set_unless_nil :airdate,        hash[:airdate]
+      set_unless_nil :season,         hash[:season]
+      set_unless_nil :season_airdate, hash[:season_airdate]
+      set_unless_nil :episode_title,  hash[:episode_title]
+      set_unless_nil :episode_number, hash[:episode_number]
+      set_unless_nil :episode_quality, hash[:episode_quality]
+      set_unless_nil :episode_extension, hash[:episode_extension]
+    end
+  end
+end

data/lib/where_to/version.rb

@@ -0,0 +1,3 @@
+module WhereTo
+  VERSION = "0.8.0"
+end

data/lib/where_to.rb

@@ -0,0 +1,6 @@
+require 'where_to/version'
+require 'where_to/location'
+
+module WhereTo
+
+end

data/where_to.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'where_to/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "where_to"
+  spec.version       = WhereTo::VERSION
+  spec.authors       = ["Justin Toniazzo"]
+  spec.email         = ["jutonz42@gmail.com"]
+
+  spec.license       = 'MIT'
+
+  spec.summary       = "Helps preserve a folder structure for mediafiles"
+  spec.homepage      = "https://github.com/jutonz/where_to"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "simplecov", "~> 0.10.0"
+  spec.add_development_dependency "coveralls", "~> 0.8.1"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: where_to
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Justin Toniazzo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: 
+email:
+- jutonz42@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/where_to.rb
+- lib/where_to/episode_formatter.rb
+- lib/where_to/format.yml
+- lib/where_to/location.rb
+- lib/where_to/locator.rb
+- lib/where_to/version.rb
+- where_to.gemspec
+homepage: https://github.com/jutonz/where_to
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Helps preserve a folder structure for mediafiles
+test_files: []