dexter 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+tmp/*

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.2@dexter

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    dexter (0.0.1)
+      trollop
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aruba (0.2.3)
+      background_process
+      cucumber (~> 0.9.0)
+    background_process (1.2)
+    builder (2.1.2)
+    cucumber (0.9.3)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    gemcutter (0.6.1)
+    gherkin (2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json (1.4.6)
+    json_pure (1.4.6)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    term-ansicolor (1.0.5)
+    trollop (1.16.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  cucumber
+  dexter!
+  jeweler
+  rspec
+  trollop

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+desc "Run the specs under spec"
+RSpec::Core::RakeTask.new do |t|
+end
+
+Cucumber::Rake::Task.new(:cucumber)
+
+task :default => :spec

data/Readme.md

@@ -0,0 +1,38 @@
+# dexter
+
+Dexter helps you organize your tv series with well, you know... Dexterity}
+
+It automatically detects all video files that seem like a series and moves them
+into an appropriate path.
+
+Currently in hard alpha but functional.
+
+## Usage
+
+    $ dexter
+
+It organizes all the files within the current directory and its subdirectories and places them into appropriate folders
+
+    $ dexter --input <input> --output <output>
+
+Checks all the directories and subdirectories in <input> and creates a folder structure moving the files in <output>
+
+    $ dexter --format ":name/S:season/:name S:seasonE:episode.:extension" 
+
+Moves the files using the format specified.
+
+    $ dexter --verbose false
+
+Removes all output
+
+## Running the tests - development only
+
+Dexter is tested with RSpec and cucumber.
+
+    $ bundle exec rspec spec
+
+Runs the functional tests
+
+    $ bundle exec cucumber features
+  
+Runs the integration tests

data/bin/dexter

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'trollop'
+require 'dexter'
+
+opts = Trollop::options do
+  opt :input, "Input directory", :default => "."
+  opt :output, "Output directory", :default => "."
+  opt :format, "Output directory format", :default => Dexter::Matchers::Video.output_format
+  opt :verbose, "Be verbose about what dexter is doing", :default => true
+end
+
+Dexter::Matchers::Video.output_format = opts[:format]
+Dexter.verbose = opts[:verbose]
+Dexter.organize!(opts[:input],opts[:output])

data/dexter.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dexter/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dexter"
+  s.version     = Dexter::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = "Josep Jaume Rey Peroy"
+  s.email       = "josepjaume@gmail.com" 
+  s.homepage    = "http://github.com/josepjaume/dexter"
+  s.summary     = %q{Dexter helps you organize your tv series with well, you know... Dexterity}
+  s.description = %q{Dexter helps you organize your tv series with well, you know... Dexterity}
+
+  s.rubyforge_project = "dexter"
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'jeweler'
+
+  s.add_runtime_dependency 'trollop'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.default_executable = 'dexter'
+  s.require_paths = ["lib"]
+end

data/features/dexter_organises_series.feature

@@ -0,0 +1,54 @@
+Feature: Dexter organises series
+
+  In order to order my TV series in a clean and neat manner
+  As a great series freak
+  Dexter should be able to get its name and season & episode numbers and move them to its appropiate paths
+
+  @announce
+  Scenario: Dexter organizes only one file 
+    Given a directory named "Downloads"
+    And a directory named "Downloads/mess"
+    And a directory named "Video"
+    And an empty file named "Downloads/dexter s01e09.avi"
+    When I run "dexter --input \"Downloads/dexter s01e09.avi\" --output Video"
+    Then the following directories should exist:
+      | Video/Dexter/S01                 |
+
+  @announce
+  Scenario: Dexter organises using a custom format 
+    Given a directory named "Downloads"
+    And a directory named "Downloads/mess"
+    And a directory named "Video"
+    And an empty file named "Downloads/dexter s01e09.avi"
+    When I run "dexter --input \"Downloads/dexter s01e09.avi\" --output Video --format \":name (Season :season)/:name S:seasonE:episode.:extension\""
+    Then the following directories should exist:
+      | Video/Dexter (Season 01)                 |
+
+  @announce
+  Scenario: Dexter isn't verbose
+    Given a directory named "Downloads"
+    And a directory named "Downloads/mess"
+    And a directory named "Video"
+    And an empty file named "Downloads/dexter s01e09.avi"
+    When I run "dexter --input \"Downloads/dexter s01e09.avi\" --output Video --verbose false"
+    Then the following directories should exist:
+      | Video/Dexter/S01                 |
+    And the output should contain exactly ""
+      
+  @announce
+  Scenario: Dexter organizes a whole directory 
+    Given a directory named "Downloads"
+    And a directory named "Downloads/mess"
+    And a directory named "Video"
+    And an empty file named "Downloads/dexter s01e09.avi"
+    And an empty file named "Downloads/Fringe.1x03.HDTV.avi"
+    And an empty file named "Downloads/The.big.bang.theory.s01e09.avi"
+    And an empty file named "Downloads/mess/MY NAME IS EARL - s08e04 HDTV.avi"
+    And an empty file named "Downloads/Treme.S01E04.HDTV.XviD-NoTV.avi"
+    When I run "dexter --input Downloads --output Video"
+    Then the following directories should exist:
+      | Video/Dexter/S01                 |
+      | Video/The Big Bang Theory/S01    |
+      | Video/Fringe/S01                 |
+      | Video/My Name Is Earl/S08        |
+      | Video/Treme/S01                  |

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba'

data/lib/dexter.rb

@@ -0,0 +1,140 @@
+require 'fileutils'
+
+module Dexter
+
+  def self.verbose; @verbose; end
+  def self.verbose=(level);@verbose=level;end
+
+  def self.organize!(input_path, output_path)
+
+    if File.file?(input_path)
+      files = self.load_files([input_path])
+    else
+      files = self.load_from_directory(input_path)
+    end
+
+    files.each do |file|
+      output_file = file.organize!(output_path)
+      puts "Organizing: \"#{file.filename}\" ~> \"#{output_file}\"" if Dexter.verbose
+    end
+
+  end
+
+  def self.load_from_directory(path)
+    self.load_files self.list_all_files_within_directory(path)
+  end
+
+  def self.load_files(files)
+    result = []
+    files.each do |file|
+      matchers.each do |matcher|
+         result << matcher.new(file) if matcher.allowed?(file)
+      end
+    end
+    return result.compact
+  end
+
+  def self.matchers
+    [Matchers::Video]
+  end
+
+  def self.list_all_files_within_directory(path)
+    expression = "#{path}/**/*.{#{Dexter.matchers.collect{|m| m::EXTENSIONS}.flatten.join(',')}}"
+    Dir.glob(expression)
+  end
+
+
+  module Matchers
+    class AbstractMatcher
+
+      EXTENSIONS = []
+
+      def self.allowed?(filename) 
+        self::EXTENSIONS.include? File.extname(filename).gsub(/^\./,"")
+      end
+
+      def initialize(filename)
+        raise "Not an allowed format!" unless self.class.allowed?(filename)
+        @filename = filename
+      end
+
+      def organize!
+        raise "It's up to the subclass to implement this"
+      end
+      
+      def extension
+        File.extname(@filename).gsub(/^\./,"")
+      end
+
+      def filename
+        @filename
+      end
+    end
+
+    class Video < AbstractMatcher
+
+      EXTENSIONS = ['avi', 'mkv']
+
+      def self.output_format
+        @output ||= ':name/S:season/:name S:seasonE:episode.:extension'
+      end
+      
+      def self.allowed?(filename) 
+        if !super(filename)
+          return false
+        end
+        filename.downcase =~ /([0-9A-z\s\.]+)\s?\.?-?\s?\.?(s[0-9]+e[0-9]+|[0-9]+x[0-9]+).*/
+        return !!$1
+      end
+
+      def self.output_format=(options)
+        @output = options
+      end
+
+      def name
+        filename.downcase =~ /([0-9A-z\s\.]+)\s?\.?-?\s?\.?(s[0-9]+e[0-9]+|[0-9]+x[0-9]+).*/
+        return nil if $1.nil?
+        return $1.gsub('.', ' ')   \
+          .split(' ')              \
+          .collect(&:capitalize)   \
+          .join(' ')               \
+          .strip
+      end
+
+      def season
+        filename.downcase =~ /[\s\.]?s([0-9]{2})e[0-9]{2}/
+        filename.downcase =~ /[\s\.]?([0-9]+)x[0-9]+/ if $1.nil?
+        return nil if $1.nil?
+        $1.to_i
+      end
+
+      def episode
+        filename.downcase =~ /[\s\.]?s[0-9]{2}e([0-9]{2})/
+        filename.downcase =~ /[\s\.]?[0-9]+x([0-9]+)/ if $1.nil?
+        return nil if $1.nil?
+        $1.to_i
+      end
+
+      def output(path)
+        options = {
+          :season => season.to_s.rjust(2,'0'),
+          :episode => episode.to_s.rjust(2,'0'),
+          :name => name,
+          :path => path,
+          :extension => extension
+        }
+        options.inject(':path/' + self.class.output_format){ |output, object|
+          output = (output.gsub(":#{object[0]}", object[1]) || output)
+        }
+      end
+
+      def organize!(path)
+        output_path = File.dirname(output(path))
+        FileUtils.mkdir_p(output_path)
+        FileUtils.mv(@filename, output(path))
+        return output(path)
+      end
+
+    end
+  end
+end

data/lib/dexter/version.rb

@@ -0,0 +1,3 @@
+module Dexter
+  VERSION = "0.0.2"
+end

data/spec/dexter_spec.rb

@@ -0,0 +1,131 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'dexter'
+
+describe Dexter do
+  describe 'self.load_files' do
+    it "creates several instances of Video from an array" do
+      list = [
+        "dexter s01e02 HDTV.avi",
+        "the.big.bang.theory.1x12.mkv",
+        "the.big.bang.theory.1x12.sub",
+        "the.big.bang.theory.1x12.srt"
+      ]
+      Dexter::Matchers::Video.should_receive(:new).exactly(2).times
+      subject.load_files(list)
+    end
+  end
+
+  describe 'self.organize!' do
+    it "organizes all the files within a directory and subdirectories" do
+      videos = (1..3).collect{Dexter::Matchers::Video.new('dexter s01e01.avi')}
+      videos.each { |video|
+        video.should_receive(:organize!).exactly(1).times
+      }
+      Dexter.should_receive(:load_from_directory)\
+        .and_return(videos)
+
+      File.should_receive(:file?).times.and_return(false)
+
+      Dexter.organize!('.', '.')
+    end
+  end
+
+  describe 'self.load_from_directory' do
+    it "creates an instance of the corresponding type from every file" do
+      Dexter.should_receive(:list_all_files_within_directory)\
+        .and_return(["../family guy s04e08.avi","../fringe 1x18.mkv"])
+      Dexter.load_from_directory('.').should have(2).videos
+    end
+  end
+
+  describe 'self.list_all_files_within_directory' do
+    it "gets a list of all files in a directory recursively" do
+      Dir.should_receive(:glob).and_return(["../dexter s01e02 HDTV.avi", "../modern family 1x02.mkv"])
+      Dexter.list_all_files_within_directory('/home/josepjaume').should == ["../dexter s01e02 HDTV.avi", "../modern family 1x02.mkv"]
+    end
+
+  end
+
+  describe Dexter::Matchers do
+    describe Dexter::Matchers::Video do
+      subject{Dexter::Matchers::Video}
+      describe 'self.allowed?' do
+        it "returns true if the file is allowed" do
+          subject.allowed?('dexter s01e01.avi').should be_true
+        end
+      end
+
+      describe 'extension' do
+        it "sorts the extension of a file out" do
+          video = subject.new('dexter s01e01.avi')
+          video.extension.should == 'avi'
+        end
+      end
+
+      describe 'name' do
+        it "returns the name of the tv series given a particular filename" do
+          examples = {
+            'the big bang theory - s01e09.avi' => 'The Big Bang Theory',
+            'DEXTER S01E09.avi' => 'Dexter',
+            'Family.Guy.S10E08.avi' => 'Family Guy'
+          }
+          examples.each do |key,value|
+            video = subject.new('dexter s01e01.avi')
+            video.stub(:filename).and_return(key)
+            video.name.should == value
+          end
+        end
+      end
+      describe 'season' do
+        it "returns the season when given a particular filename" do
+          examples = {
+            'the big bang theory - s01e09.avi' => 1,
+            'DEXTER S05E09.avi' => 5,
+            'Family.Guy.S10E08.avi' => 10,
+            'The Show of cleveland - 1x2 .mkv' => 1
+          }
+          examples.each do |key,value|
+            video = subject.new('dexter s01e01.avi')
+            video.stub(:filename).and_return(key)
+            video.season.should == value
+          end
+        end
+      end
+      describe 'episode' do
+        it "returns the episode when given a particular filename" do
+          examples = {
+            'the big bang theory - s01e09.avi' => 9,
+            'DEXTER S05E27.avi' => 27,
+            'Family.Guy.S10E08.avi' => 8,
+            'The Show of cleveland - 1x2 .mkv' => 2
+          }
+          examples.each do |key,value|
+            video = subject.new('dexter s01e01.avi')
+            video.stub(:filename).and_return(key)
+            video.episode.should == value
+          end
+        end
+      end
+      describe "output" do
+        it "should return the output path of the video" do
+          video = Dexter::Matchers::Video.new('dexter s01e01.avi')
+          video.should_receive(:season).and_return(1)
+          video.should_receive(:episode).and_return(2)
+          video.should_receive(:name).and_return("Modern Family")
+          video.should_receive(:extension).and_return('avi')
+          video.output(".").should == "./Modern Family/S01/Modern Family S01E02.avi"
+        end
+      end
+      describe :organize! do
+        it "should move the video to its corresponding path" do
+          video = Dexter::Matchers::Video.new('dexter s01e01.avi')
+          video.stub(:output).and_return('./Modern Family/S01/Modern Family S01E02.avi')
+          video.stub(:filename).and_return('dexter s01e01.avi')
+          FileUtils.should_receive(:mkdir_p).with('./Modern Family/S01')
+          FileUtils.should_receive(:mv).with('dexter s01e01.avi','./Modern Family/S01/Modern Family S01E02.avi')
+          video.organize!('./')
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'rspec'
+require 'rspec/autorun'

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: dexter
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Josep Jaume Rey Peroy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-29 00:00:00 +02:00
+default_executable: dexter
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: aruba
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+description: Dexter helps you organize your tv series with well, you know... Dexterity
+email: josepjaume@gmail.com
+executables: 
+- dexter
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- bin/dexter
+- dexter.gemspec
+- features/dexter_organises_series.feature
+- features/support/env.rb
+- lib/dexter.rb
+- lib/dexter/version.rb
+- spec/dexter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/josepjaume/dexter
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: dexter
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Dexter helps you organize your tv series with well, you know... Dexterity
+test_files: []
+