sindex 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+ - 1.9.3
+

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
 
+gem "turn"
+gem "ansi"
+gem "rake"
+
 # Specify your gem's dependencies in sindex.gemspec
 gemspec

data/README.md

@@ -1,4 +1,5 @@
-# Sindex
+# Sindex [![Build Status](https://secure.travis-ci.org/pboehm/sindex.png)](http://travis-ci.org/pboehm/sindex)
+
 
 Sindex is a tool and library that manages an index file, which contains the tv
 series and episodes you have been watched. This index can be used by other

data/Rakefile

@@ -1 +1,11 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+

data/lib/sindex/errors.rb

@@ -0,0 +1,10 @@
+module Sindex
+
+  class XmlDTDError < Exception
+  end
+
+  class XmlMalformedError < Exception
+    attr_accessor :errors
+  end
+
+end

data/lib/sindex/series.rb

@@ -0,0 +1,56 @@
+module Sindex
+
+  class Series
+
+    attr_accessor :episodes, :receive_updates
+
+    def initialize(receive_updates=true)
+      @episodes = {}
+      @receive_updates=receive_updates
+    end
+
+    # Public: determines if thos series contains episode in the
+    # supplied language
+    #
+    #   :language - language-symbol :de/:en/...
+    def has_episodes_in_language?(language)
+      ! @episodes[language].nil?
+    end
+
+    # Public: Adds an existing episode to the list of episodes
+    #
+    #   :filename - the filename to the episode
+    #   :language - language in which the episode was watched :de/:en
+    #
+    def add_episode(filename, language=:de)
+      if id = SeriesIndex.extract_episode_identifier(filename)
+
+        if @episodes[language].nil?
+          @episodes[language] = {}
+        end
+
+        @episodes[language][id] = filename
+      end
+    end
+
+    # Public: Is Episode already watched
+    #
+    #   :episode_data - data that hoölds the episode identifier
+    #   :language - the language in which the episode is available :de/:en
+    def is_episode_existing?(episode_data, language=:de)
+
+      # if we are not interested in updates this method responds
+      # always with true
+      return true unless @receive_updates
+
+      if id = SeriesIndex.extract_episode_identifier(episode_data)
+        if not @episodes[language].nil?
+          return @episodes[language].has_key? id
+        end
+      end
+
+      false
+    end
+
+  end
+end

data/lib/sindex/series_index.rb

@@ -0,0 +1,268 @@
+require 'nokogiri'
+
+module Sindex
+
+  class SeriesIndex
+
+    attr_reader :options, :series_data, :index_file
+
+    # Public: instantiate a new series_index
+    #
+    # options  - Options (default: {})
+    #     :index_file - Path to the index file, should be supplied
+    #
+    def initialize(options = {})
+      @options = {index_file: nil, }.merge(options)
+
+      @index_file = @options[:index_file]
+      @series_data = {}
+      @series_aliases = {}
+
+      if @index_file and File.file? @index_file
+        parse_file(@index_file)
+      end
+
+    end
+
+    # Public: checks if there are entries in the index
+    #
+    # Returns true if there no entries loaded
+    def empty?
+      @series_data.length == 0
+    end
+
+    # Public: Check if a supplied episode is in the index
+    #
+    # series_name - Name of the series in the index
+    # episode_text - episode data
+    #
+    # Returns true if the episode is existing, false otherwise
+    def episode_existing?(series_name, episode_text, language=:de)
+
+      series_name = series_name_in_index(series_name)
+
+      if series_name and series = @series_data[series_name]
+        return series.is_episode_existing?(episode_text, language)
+      end
+
+      false
+    end
+
+    # Public: Check if the series is watched in this specified language
+    #
+    # series_name - Name of the series in the index
+    # language - either :de or :en
+    #
+    # Returns true if the series is watched in the supplied language
+    def is_series_in_this_language?(series_name, language=:de)
+
+      series_name = series_name_in_index(series_name)
+
+      if series_name and series = @series_data[series_name]
+        return series.has_episodes_in_language?(language)
+      end
+
+      false
+    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
+    def dump_index_to_file(filename)
+
+      tree = build_up_xml_tree_from_index
+
+      File.open(filename, "w") do |f|
+        f.write(tree);
+      end
+    end
+
+    # Public: checks if the seriesname in the supplied data is in the
+    # index or an alias to a series
+    #
+    # episode_text  - data that contains the episode information
+    # clean         - does the episode_data contains already the series name
+    #
+    # Returns true if the series is in the index, false otherwise
+    def is_series_in_index?(episode_text, clean=false)
+
+      if not clean and series_name = SeriesIndex.extract_seriesname(episode_text)
+        episode_text = series_name
+      end
+
+      ! series_name_in_index(episode_text).nil?
+    end
+
+    # Public: Adds episode to index
+    #
+    #   :series_name
+    #   :episode
+    #   :language
+    def add_episode_to_index(series_name, episode, language=:de)
+
+      series_name = series_name_in_index(series_name)
+
+      if series_name and series = @series_data[series_name]
+        series.add_episode(episode, language)
+      end
+    end
+
+    class << self
+
+      # Public: tries to extract the seriesname from supplied data
+      #
+      # data - data that holds the episode information
+      #
+      # Returns the seriesname or nil if there is no seriesname
+      def extract_seriesname(data)
+        if md = data.match(/(.+?)S\d+E\d+/)
+          return md[1].gsub(/\./, " ").strip
+        end
+        nil
+      end
+
+      # Public: tries to extract the episode identifier from the episode data
+      #
+      # data - data that holds the episode information
+      #
+      # Returns the identifier xx_xx or nil if there is no identifier
+      def extract_episode_identifier(data)
+        if md = data.match(/S(\d+)E(\d+)/i)
+          return "%s_%s" % [md[1].to_i, md[2].to_i]
+        end
+        nil
+      end
+
+    end
+
+    private
+
+    # Private: this methode places the information from index into a
+    # new XML tree
+    #
+    # Returns XML tree
+    def build_up_xml_tree_from_index
+
+      dtd_path = File.expand_path(
+        File.join(File.dirname(__FILE__), '../../res/seriesindex.dtd'))
+
+      builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        xml.doc.create_internal_subset("seriesindex", nil, dtd_path)
+
+        xml.seriesindex {
+          @series_data.sort.map do |seriesname, data|
+            attrs = {:name => seriesname}
+            attrs[:receive_updates] = false unless data.receive_updates
+
+            xml.series(attrs) {
+
+              # write alias definition if there are any
+              @series_aliases.select { |al,re| re == seriesname }.each do |_alias,real|
+                xml.alias(:to => _alias)
+              end
+
+              # write the different episodes
+              data.episodes.each do |language, episodes|
+                xml.episodes(:lang => language) {
+                  episodes.each do |episode_id, filename|
+                    xml.episode(:name => filename)
+                  end
+                }
+              end
+            }
+          end
+        }
+      end
+
+      builder.to_xml
+    end
+
+    # Internal: finds the seriesname for the supplied name in index
+    #
+    # It is used to apply an alias for series and finds the real series name
+    #
+    # Returns the seriesname in index or nil if it does not exist
+    def series_name_in_index(name)
+
+      @series_data.each do |key, val|
+        if key.match(/#{name}/i)
+          return key
+        end
+      end
+
+      @series_aliases.each do |key, val|
+        if key.match(/#{name}/i)
+          return val
+        end
+      end
+
+      nil
+    end
+
+    # Internal: parse this file to a hash indexed by seriesname
+    #
+    #  file - path to the xml file
+    #
+    def parse_file(file)
+
+      doc = open_xml_file(file)
+
+      doc.css("seriesindex > series").each do |series|
+
+        series_name = series[:name]
+        next unless series_name and series_name.match(/\w+/)
+
+        s = Series.new()
+
+        s.receive_updates = false if series[:receive_updates].match(/false/i)
+
+        series.css('episodes').each do |episodes|
+          language = episodes['lang'].match(/de/) ? :de : :en
+
+          episodes.css('episode').each do |episode|
+            episode['name'] || next
+
+            s.add_episode(episode['name'], language)
+          end
+        end
+
+        @series_data[series_name] = s
+
+        # apply aliases
+        series.css("alias").each do |series_alias|
+          if series_alias['to'] and series_alias['to'].match(/\w+/)
+            alias_name = series_alias['to']
+            @series_aliases[alias_name] = series_name
+          end
+        end
+      end
+
+    end
+
+    # Internal: wrapper around opening a xml file in Nokogiri with
+    # external DTD definition
+    #
+    #   file - path to xml file
+    #
+    # returns Nokogiri XML Document
+    def open_xml_file(file)
+      options = Nokogiri::XML::ParseOptions::DEFAULT_XML |
+                  Nokogiri::XML::ParseOptions::DTDLOAD
+
+      doc = Nokogiri::XML::Document.parse(File.read(file), nil, nil, options)
+      doc.external_subset || raise(XmlDTDError, "DTD could not be processed")
+
+      errors = doc.external_subset.validate(doc)
+
+      if not errors.empty?
+        error = XmlMalformedError.new
+        error.errors = errors
+        raise error
+      end
+
+      doc
+    end
+
+  end
+
+end

data/lib/sindex/version.rb

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

data/lib/sindex.rb

@@ -1,4 +1,7 @@
 require "sindex/version"
+require "sindex/errors"
+require "sindex/series"
+require "sindex/series_index"
 
 module Sindex
   # Your code goes here...

data/res/seriesindex.dtd

@@ -0,0 +1,14 @@
+<!ELEMENT seriesindex (series+)>
+
+<!ELEMENT series(episodes|alias)*>
+<!ATTLIST series name CDATA #REQUIRED>
+<!ATTLIST series receive_updates (true|false) "true">
+
+<!ELEMENT episodes(episode*)>
+<!ATTLIST episodes lang (de|en|fr) "de">
+
+<!ELEMENT episode EMPTY>
+<!ATTLIST episode name CDATA #REQUIRED>
+
+<!ELEMENT alias EMPTY>
+<!ATTLIST alias to CDATA #REQUIRED>

data/sindex.gemspec

@@ -16,4 +16,7 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency(%q<nokogiri>, [">= 1.5"])
+  gem.add_runtime_dependency(%q<hashconfig>, [">= 0.0.1"])
 end

data/test/seriesindex_example.xml

@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE seriesindex SYSTEM "res/seriesindex.dtd">
+
+<seriesindex>
+    <series name="Community">
+        <alias to="Comm" />
+        <alias to="unity" />
+        <episodes>
+            <episode name="S01E01 - Zurück aufs College.avi" />
+            <episode name="S01E02 - Grundkurs Spanisch.avi" />
+            <episode name="S01E03 - Carpe Diem.avi" />
+            <episode name="S01E04 - Bitte warten.avi" />
+            <episode name="S01E05 - Prozess im Schwimmbad.avi" />
+            <episode name="S01E06 - Toiletten Talk.avi" />
+            <episode name="S01E07 - Mexanisches Halloween.avi" />
+            <episode name="S01E08 - Picknick unter Sternen.avi" />
+            <episode name="S01E09 - Der Mensch ist gut.avi" />
+            <episode name="S01E10 - Green Day für Arme.avi" />
+            <episode name="S01E11 - Das P Wort.avi" />
+            <episode name="S01E12 - Die Weihnachtsschlacht.avi" />
+            <episode name="S01E13 - Zweite Wahl.avi" />
+            <episode name="S01E14 - Echte Männer tanzen nicht.avi" />
+            <episode name="S01E15 - Jeder mit jedem.avi" />
+            <episode name="S01E16 - Trunken am Telefon.avi" />
+            <episode name="S01E17 - Billard ohne.mkv" />
+            <episode name="S01E18 - Familientag.mkv" />
+            <episode name="S01E19 - Die Parkplatzsegler.mkv" />
+            <episode name="S01E20 - Die Spassbremse.mkv" />
+        </episodes>
+    </series>
+    <series name="Shameless US">
+        <episodes lang="de">
+            <episode name="S01E01 - Pilot.avi" />
+            <episode name="S01E02 - Frank The Plank.avi" />
+            <episode name="S01E03 - Der Scheck heiligt die Mittel.avi" />
+            <episode name="S01E04 - Nur mal Spielen.avi" />
+            <episode name="S01E05 - Drei Freunde.avi" />
+            <episode name="S01E06 - Killer Carl.avi" />
+            <episode name="S01E07 - Frank Gallagher Loving Husband Devoted Father.avi" />
+            <episode name="S01E08 - Katerstimmung.avi" />
+        </episodes>
+        <episodes lang="en">
+            <episode name="S01E01 - Pilot.avi" />
+            <episode name="S01E02 - Frank The Plank.avi" />
+            <episode name="S01E03 - Der Scheck heiligt die Mittel.avi" />
+            <episode name="S01E04 - Nur mal Spielen.avi" />
+            <episode name="S01E05 - Drei Freunde.avi" />
+            <episode name="S01E06 - Killer Carl.avi" />
+            <episode name="S01E07 - Frank Gallagher Loving Husband Devoted Father.avi" />
+            <episode name="S01E08 - Katerstimmung.avi" />
+            <episode name="S01E09 - But At Last Came A Knock.avi" />
+            <episode name="S01E10 - Auf Oma ist verlass.avi" />
+            <episode name="S01E11 - Daddys Girl.avi" />
+            <episode name="S01E12 - Vater Frank voller Gnade.avi" />
+            <episode name="S02E01 - Summertime.avi" />
+            <episode name="S02E02 - Summer Loving.avi" />
+            <episode name="S02E03 - Ill Light A Candle For You Every Day.avi" />
+            <episode name="S02E04 - A Beautiful Mess.avi" />
+            <episode name="S02E05 - Fathers Day.avi" />
+            <episode name="S02E06 - Can I Have A Mother.avi" />
+            <episode name="S02E07 - A Bottle of Jean Nate.avi" />
+            <episode name="S02E08 - Parenthood.avi" />
+            <episode name="S02E09 - Hurricane Monica.avi" />
+            <episode name="S02E10 - A Great Cause.mkv" />
+            <episode name="S02E11 - Just Like The Pilgrims Intended.mkv" />
+        </episodes>
+    </series>
+    <series name="Prison Break" receive_updates="false">
+        <episodes>
+            <episode name="S01E01 - Zurück aufs College.avi" />
+            <episode name="S01E02 - Grundkurs Spanisch.avi" />
+            <episode name="S01E03 - Carpe Diem.avi" />
+            <episode name="S01E04 - Bitte warten.avi" />
+        </episodes>
+    </series>
+</seriesindex>

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'stringio'
+require 'turn/autorun'
+require File.dirname(__FILE__) + '/../lib/sindex'
+
+Turn.config.ansi = true
+
+class TestHelper
+end

data/test/test_series_index.rb

@@ -0,0 +1,101 @@
+# encoding: UTF-8
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'fileutils'
+
+class TestIndex < Test::Unit::TestCase
+
+  def setup
+    index_file = File.dirname(__FILE__) + '/seriesindex_example.xml'
+
+    @tmp_directory = '/tmp/'
+
+    @series_index = Sindex::SeriesIndex.new(index_file: index_file)
+  end
+
+  def test_instantiating
+    index = Sindex::SeriesIndex.new()
+
+    assert_instance_of Sindex::SeriesIndex, index
+    assert_instance_of Hash, index.series_data
+    assert_equal index.empty?, true
+  end
+
+  def test_parsing_a_valid_series_index
+    assert_not_nil @series_index.series_data['Community']
+
+    series = @series_index.series_data['Community']
+    assert_equal series.has_episodes_in_language?(:de), true
+    assert_not_nil series.episodes[:de]['1_1']
+    assert_nil series.episodes[:de]['11_11']
+
+    series = @series_index.series_data['Shameless US']
+    assert_equal series.has_episodes_in_language?(:de), true
+    assert_equal series.has_episodes_in_language?(:en), true
+  end
+
+  def test_that_series_aliases_take_place
+    assert_equal @series_index.is_series_in_index?("Comm", true), true
+    assert_equal @series_index.is_series_in_index?("unity", true), true
+    assert_equal @series_index.is_series_in_index?("NoCommunity", true), false
+
+    assert_equal @series_index.is_series_in_index?("shameless uS", true), true
+  end
+
+  def test_series_is_watched_in_a_specific_language
+    assert_equal @series_index.is_series_in_this_language?("Community", :de), true
+    assert_equal @series_index.is_series_in_this_language?("Community", :en), false
+
+    assert_equal @series_index.is_series_in_this_language?("Shameless US", :de), true
+    assert_equal @series_index.is_series_in_this_language?("Shameless US", :en), true
+  end
+
+  def test_check_for_episode_existance
+    assert_equal true, @series_index.episode_existing?("Shameless US",
+      "Shameless.US.S01E01.Just.Like.The.Pilgrims.Intended.German")
+
+    assert_equal false, @series_index.episode_existing?("Shameless US",
+      "Shameless.US.S01E09.Just.Like.The.Pilgrims.Intended.German")
+
+    assert_equal true, @series_index.episode_existing?("Shameless US",
+      "Shameless.US.S01E09.Just.Like.The.Pilgrims.Intended.German", :en)
+
+    assert_equal true, @series_index.episode_existing?("Community",
+        "Community.S01E01.Bankgeheimnis.DL.German.HDTV.XviD-GDR")
+
+    assert_equal false, @series_index.episode_existing?("Community",
+        "Community.S01E31.Bankgeheimnis.DL.German.HDTV.XviD-GDR")
+  end
+
+  def test_that_an_index_can_be_dumped_right
+    filename = @tmp_directory + 'dumped_index.xml'
+    @series_index.dump_index_to_file(filename)
+
+    index = Sindex::SeriesIndex.new(index_file: filename)
+    assert_equal index.is_series_in_index?("Community", true), true
+
+    assert_equal false, index.episode_existing?("Shameless US",
+      "Shameless.US.S01E09.Just.Like.The.Pilgrims.Intended.German")
+
+    assert_equal true, index.episode_existing?("Shameless US",
+      "Shameless.US.S01E09.Just.Like.The.Pilgrims.Intended.German", :en)
+  end
+
+  def test_that_the_receive_updates_flag_is_used
+    assert_equal @series_index.series_data["Prison Break"].receive_updates, false
+
+    # when the receive_updates flag  is set to false
+    # :episode_existing? returns always true
+    assert_equal true, @series_index.episode_existing?("Prison Break",
+        "Prison.Break.S01E31.Bankgeheimnis.DL.German.HDTV.XviD-GDR")
+  end
+
+  def test_that_you_can_add_new_episodes_to_the_index
+    assert_equal @series_index.episode_existing?("Shameless US",
+        "Shameless.US.S01E09.German"), false
+
+    @series_index.add_episode_to_index("Shameless US", "S01E09 - Episode.mkv")
+
+    assert_equal @series_index.episode_existing?("Shameless US",
+        "Shameless.US.S01E09.German"), true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sindex
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-26 00:00:00.000000000 Z
-dependencies: []
+date: 2012-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: hashconfig
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
 description: Tool and library that manages the episodes you have seen in different
   tv series
 email:
@@ -20,13 +52,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/sindex.rb
+- lib/sindex/errors.rb
+- lib/sindex/series.rb
+- lib/sindex/series_index.rb
 - lib/sindex/version.rb
+- res/seriesindex.dtd
 - sindex.gemspec
+- test/seriesindex_example.xml
+- test/test_helper.rb
+- test/test_series_index.rb
 homepage: https://github.com/pboehm/sindex
 licenses: []
 post_install_message: 
@@ -39,17 +79,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2420045716595700599
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2420045716595700599
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Series-Index that manages your watched episodes
-test_files: []
-has_rdoc: 
+test_files:
+- test/seriesindex_example.xml
+- test/test_helper.rb
+- test/test_series_index.rb