sindex 0.1.1 → 0.1.2

data/.autotest

@@ -0,0 +1,3 @@
+Autotest.add_hook :initialize do |at|
+  %w{.git test/tmp/}.each {|exception| at.add_exception(exception)}
+end

data/bin/sindex

@@ -34,12 +34,16 @@ STANDARD_CONFIG = {
 
 config = STANDARD_CONFIG.merge_with_serialized(CONFIG_FILE)
 
-options = {}
+options = {
+  :language => :de,
+}
 OptionParser.new do |opts|
-  opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [DIR]"
+  opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [OPTIONS] [DIR]"
 
   opts.separator("")
-  opts.separator("Tool that manages an index with all your watched episodes")
+  opts.separator("Tool that manages an index with all your watched episodes.")
+  opts.separator("The default action without any arguments adds new episodes")
+  opts.separator("to the index.")
   opts.separator("")
   opts.separator("  Options:")
 
@@ -48,12 +52,42 @@ OptionParser.new do |opts|
     exit
   end
 
+  opts.on( "-i", "--indexfile STRING", String,
+        "Path to the index that holds the index") do |opt|
+
+    config[:index_file] = opt
+  end
+
+  opts.on( "-b", "--buildindex STRING", String,
+    "Build an index by reading the series/episodes from the supplied directory") do |opt|
+
+    raise ArgumentError, "supplied directory does not exist" unless
+        File.directory? opt
+    options[:build_index_from_dir] = opt
+  end
+
+  opts.on( "-l", "--language STRING", String,
+    "language in which the episodes in the directory are, choices: (de,en,fr)") do |opt|
+
+    raise ArgumentError, "Supplied Language not supported, choices:(de,en,fr)" unless
+        opt.match(/^(de|en|fr)$/)
+    options[:language] = opt.to_sym
+  end
+
+  opts.separator("")
   opts.separator("  Arguments:")
   opts.separator("     DIR      The path that includes the episodes")
   opts.separator("              defaults to ~/Downloads")
   opts.separator("")
 end.parse!
 
+# change episode directory if a different directory is supplied
+if directory = ARGV.pop
+  raise ArgumentError, "supplied directory does not exist" unless
+    File.directory? directory
+  config[:episode_directory] = directory
+end
+
 
 class Cmdline
   include HighLine::SystemExtensions
@@ -62,19 +96,30 @@ class Cmdline
     @config = config
     @options = options
 
-    @series_index = Sindex::SeriesIndex.new(index_file: @config[:index_file])
     @processed_episodes = {}
+  end
+
+  def build_up_index
+    @series_index = Sindex::SeriesIndex.new
+    @series_index.build_up_index_from_directory(
+        @options[:build_index_from_dir], @options[:language])
 
+    @series_index.dump_index_to_file(@config[:index_file])
   end
 
-  # mark episodes as watched
   def mark_as_watched
+    call_pre_processing_hook
+
+    @series_index = Sindex::SeriesIndex.new(index_file: @config[:index_file])
 
     @info_store = Serienrenamer::InformationStore.new(
       @config[:information_store_path], @config[:byte_count_for_md5])
 
     # process all episodes
     Dir.chdir(@config[:episode_directory])
+
+    added_episodes=false
+
     for filename in Dir.entries('.').sort do
 
       next if filename.match(/^\./)
@@ -109,8 +154,12 @@ class Cmdline
       @series_index.add_episode_to_index(series_name, filename, language)
       @processed_episodes[filename] = series_name
       puts "Added '#{filename}' to index"
+
+      added_episodes=true
     end
 
+    exit unless added_episodes
+
     if agree("\nShould I write the new index? ", true)
       @series_index.dump_index_to_file(@config[:index_file])
       puts "New Index version has been written\n"
@@ -123,6 +172,8 @@ class Cmdline
           system(cmd) or fail("Episode-Hook failed")
         end
       end
+
+      call_post_processing_hook
     else
       puts "the index was not changed"
       exit
@@ -134,6 +185,22 @@ class Cmdline
   #############################################################################
   private
 
+  def call_pre_processing_hook
+    # calling the pre-processing hook to allow a git pull or something else
+    # in a Script
+    if @config[:pre_processing_hook] and @config[:pre_processing_hook].match(/\w+/)
+      system(@config[:pre_processing_hook]) or fail("Pre-Processing-Hook failed")
+    end
+  end
+
+  def call_post_processing_hook
+    # calling the post-processing hook to allow a git commit/push or something
+    # else in a Script
+    if @config[:post_processing_hook] and @config[:post_processing_hook].match(/\w+/)
+      system(@config[:post_processing_hook]) or fail("Post-Processing-Hook failed")
+    end
+  end
+
   def determine_episode_language(seriesname, filename)
     series = @series_index.series_data[seriesname]
 
@@ -155,10 +222,8 @@ class Cmdline
       end
       return language
     end
-
   end
 
-
   def determine_series_name_for_episode(filename)
     sum = md5sum(filename)
     if not @info_store.episode_hash[sum].nil?
@@ -194,7 +259,6 @@ class Cmdline
     end
   end
 
-
   # Private: Generates a md5sum for the number of bytes for the supplied file
   #
   # Returns filename
@@ -209,21 +273,17 @@ class Cmdline
   end
 end
 
-# calling the pre-processing hook to allow a git pull or something else 
-# in a Script
-if config[:pre_processing_hook] and config[:pre_processing_hook].match(/\w+/)
-    system(config[:pre_processing_hook]) or fail("Pre-Processing-Hook failed")
-end
+##########################
+# Do the actual processing
 
 cmd = Cmdline.new(config, options)
 begin
-  cmd.mark_as_watched()
-
-  # calling the post-processing hook to allow a git commit/push or something
-  # else in a Script
-  if config[:post_processing_hook] and config[:post_processing_hook].match(/\w+/)
-    system(config[:post_processing_hook]) or fail("Post-Processing-Hook failed")
+  if options[:build_index_from_dir]
+    cmd.build_up_index
+  else
+    cmd.mark_as_watched
   end
+
 rescue Interrupt => e
   puts
 end

data/lib/sindex/series_index.rb

@@ -65,6 +65,37 @@ module Sindex
       false
     end
 
+    # Public: Builds up an index from a directory full of series
+    #
+    #  :directory - path to the directory that holds the series
+    #  :language - the language symbol which the episodes in the directory have
+    #
+    def build_up_index_from_directory(directory, language=:de)
+      raise ArgumentError, "you have not supplied an existing directory" unless
+        File.directory? directory
+
+        Dir.chdir(directory)
+
+        Dir['*'].sort.each do |directory|
+          next unless File.directory? directory
+
+          series = Series.new
+
+          Dir["#{directory}/**/*"].sort.each do |episode|
+            next unless File.file? episode
+            basename_episode = File.basename(episode)
+
+            next unless SeriesIndex.extract_episode_identifier(basename_episode)
+            next unless basename_episode.match(/\.(mkv|mov|avi|flv|mp4|mpg|wmv)$/)
+
+            series.add_episode(basename_episode, language)
+          end
+
+          @series_data[directory] = series
+        end
+
+    end
+
     # Public: Dumps the in-memory version of the index back to a xml file
     #
     #   :filename - path to file in which the index should be dumped

data/lib/sindex/version.rb

@@ -1,3 +1,3 @@
 module Sindex
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/test/test_helper.rb

@@ -1,6 +1,7 @@
 require 'stringio'
 require 'turn/autorun'
 require File.dirname(__FILE__) + '/../lib/sindex'
+require File.join(File.dirname(__FILE__), "test_testdata.rb")
 
 Turn.config.ansi = true
 

data/test/test_series_index.rb

@@ -114,3 +114,48 @@ class TestIndex < Test::Unit::TestCase
         "Shameless.US.S01E09.German"), true
   end
 end
+
+class TestIndexParsedFromDir < Test::Unit::TestCase
+  def setup
+    TestData.create
+  end
+
+  def teardown
+    TestData.clean
+  end
+
+  def test_that_an_error_is_raised_if_the_directory_does_not_exist
+    index = Sindex::SeriesIndex.new()
+    assert_raise ArgumentError do
+      index.build_up_index_from_directory('/this/should/not/exist')
+    end
+  end
+
+  def test_that_the_index_holds_the_right_number_of_series
+    index = Sindex::SeriesIndex.new()
+    index.build_up_index_from_directory(TestData::SERIES_STORAGE_DIR)
+    assert_equal index.empty?, false
+    assert_equal 7, index.series_data.length
+    assert_equal true, index.is_series_in_index?("The Big Bang Theory")
+    assert_equal true, index.is_series_in_index?("Criminal Minds")
+  end
+
+  def test_that_episodes_from_directory_are_in_index
+    index = Sindex::SeriesIndex.new()
+    index.build_up_index_from_directory(TestData::SERIES_STORAGE_DIR)
+
+    assert_equal true, index.episode_existing?("Criminal Minds", "S01E01")
+    assert_equal false, index.episode_existing?("Criminal Minds", "S01E04")
+
+    assert_equal true, index.episode_existing?("Chuck", "S01E01")
+    assert_equal false, index.episode_existing?("Chuck", "S01E31")
+  end
+
+  def test_that_episodes_are_in_index_in_the_supplied_language
+    index = Sindex::SeriesIndex.new()
+    index.build_up_index_from_directory(TestData::SERIES_STORAGE_DIR, :en)
+
+    assert_equal true, index.episode_existing?("Criminal Minds", "S01E01", :en)
+    assert_equal false, index.episode_existing?("Criminal Minds", "S01E04", :en)
+  end
+end

data/test/test_testdata.rb

@@ -0,0 +1,115 @@
+require File.join(File.dirname(__FILE__), "test_helper.rb")
+
+class TestData
+
+  TESTFILE_DIRECTORY = File.join(File.dirname(__FILE__), 'tmp')
+  SERIES_STORAGE_DIR = File.join(TESTFILE_DIRECTORY, 'series')
+
+  EPISODES = {
+    :chuck => { :filename => "S04E11 - Pilot.avi",
+                :series => "Chuck",
+                :data => { :from => '1_1', :to => '4_10' }
+    },
+    :tbbt  => { :filename => "S05E06 - Pilot.avi",
+                :series => "The Big Bang Theory",
+                :data => { :from => '1_1', :to => '5_9',
+                           :exclude => ['5_5', '5_6', '5_7', '5_8', ] }
+    },
+    :crmi  => { :filename => "S01E04 - Pilot.avi",
+                :series => "Criminal Minds",
+                :data => { :from => '1_1', :to => '1_3' }
+    },
+    :seap  => { :filename => "S01E04 - Pilot.avi",
+                :series => "Sea Patrol",
+                :data => { :from => '1_1', :to => '1_3' }
+    },
+    :drhou => { :filename => "S05E01 - First Episode.avi",
+                :series => "Dr House",
+                :data => { :from => '1_1', :to => '4_20' }
+    },
+    :spook => { :filename => "S10E01 - First Episode.avi",
+                :series => "Spooks",
+                :data => { :from => '1_1', :to => '9_20' }
+    },
+    :numbe => { :filename => "S04E31 - High Episode.avi",
+                :series => "Numb3rs",
+                :data => { :from => '1_1', :to => '4_30' }
+    },
+  }
+
+  # create test data
+  def self.create
+    _create_directories
+    EPISODES.each do |key,value|
+      create_series(value[:series], value[:data])
+    end
+  end
+
+  # remove files
+  def self.clean
+    remove_series_dir
+  end
+
+  class << self
+
+    # this method creates a directory structure for a given
+    # series with the opportunity to exclude some episodes
+    def create_series(seriesname, options={})
+      default = { :from => '1_0', :to => '1_0',
+                  :max => 30, :exclude => [] }
+      options = default.merge(options)
+
+      series_dir = File.join(SERIES_STORAGE_DIR, seriesname)
+      _create_dir(series_dir)
+
+      from = _split_entry(options[:from])
+      to   = _split_entry(options[:to])
+
+      for season in from[0]..to[0]
+
+        season_dir = File.join(series_dir, "Staffel %02d" % season)
+        _create_dir(season_dir)
+
+        episodes = (season == to[0]) ? to[1] : options[:max]
+
+        for episode in 1..episodes.to_i
+
+          # check for excludes
+          definition = "%d_%d" % [ season, episode ]
+          next if options[:exclude].include? definition
+
+          # build and create file
+          file = "S%02dE%02d - Episode %02d.mkv" % [ season, episode,episode ]
+          episode_file = File.join(season_dir, file)
+          _create_file(episode_file)
+        end
+      end
+
+    end
+
+    # remove testfile directory
+    def remove_series_dir
+      if File.directory?(SERIES_STORAGE_DIR)
+        FileUtils.remove_dir(SERIES_STORAGE_DIR)
+      end
+    end
+
+    def _split_entry(definition)
+      definition.split(/_/)
+    end
+
+    def _create_directories
+      _create_dir TESTFILE_DIRECTORY
+      _create_dir SERIES_STORAGE_DIR
+    end
+
+    def _create_dir(dir)
+      FileUtils.mkdir(dir) unless File.directory?(dir)
+    end
+
+    def _create_file(file)
+      FileUtils.touch(file) unless File.file?(file)
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sindex
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-02 00:00:00.000000000 Z
+date: 2012-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -100,6 +100,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .autotest
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -117,6 +118,7 @@ files:
 - test/seriesindex_example.xml
 - test/test_helper.rb
 - test/test_series_index.rb
+- test/test_testdata.rb
 homepage: https://github.com/pboehm/sindex
 licenses: []
 post_install_message: 
@@ -131,7 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -599233288800797893
+      hash: -4573183238350985480
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -140,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -599233288800797893
+      hash: -4573183238350985480
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -151,3 +153,4 @@ test_files:
 - test/seriesindex_example.xml
 - test/test_helper.rb
 - test/test_series_index.rb
+- test/test_testdata.rb