sindex 0.1.2 → 0.1.3

data/README.md

@@ -1,23 +1,20 @@
 # 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
 tools like `sjunkieex` to determine new episodes that you are interested in.
+[Here](https://github.com/pboehm/sindex/blob/master/test/seriesindex_example.xml)
+is an example, how an index looks like and what features are supported.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem 'sindex'
-
-And then execute:
+`sindex` requires Ruby 1.9 to work, then you can install it through:
 
-    $ bundle
+    $ [sudo] gem install sindex
 
-Or install it yourself as:
-
-    $ gem install sindex
+You can configure `sindex` in `~/.sindex/config.yml` after initial
+execution. The standard path for the episode index is
+`~/.sindex/seriesindex.xml`.
 
 ## Dependencies
 
@@ -27,7 +24,71 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Initial creation of an index
+
+`sindex` allows you to build an index from a directory, that contains your
+watched series and episodes. The directory from which the index is built,
+should have the following structure:
+
+    /path/to/your/series_directory/
+    ├── Chuck
+    │   └── .......
+    ├── Community
+    │   └── .......
+    └── The Big Bang Theory
+        └── .......
+
+`sindex` treats all directories in your supplied directory as series, so you
+should name they correct. In these directories, all Video-files (recursively)
+containing `S0xE0x` are added for the series to the index. It is recommended to
+rename your episode with a tool like
+[serienrenamer](https://github.com/pboehm/serienrenamer), which renames your
+episodes into this format.
+
+The following command creates an index from the directory `/home/user/Serien`
+and writes it to `/home/user/Desktop/index.xml`:
+
+    $ sindex --buildindex ~/Serien --indexfile ~/Desktop/index.xml
+
+If your episodes are not in German, you have to add `--language [en|fr]`. Now
+you should make changes to the index if required and move this to the path
+specified by `index_file`.
+
+### Adding new episodes to the index
+
+`sindex` wouldn't be useful without the option to add new episodes to the
+index. If you have downloaded and renamed your new episodes, you can type only
+`sindex` and a similar output can be viewed.
+
+    [user@host ~]% ls ~/Downloads
+    S04E21 - Kopfjäger.mkv
+    [user@host ~]% sindex
+
+    >>> S04E21 - Kopfjäger.mkv
+    << from infostore: Castle
+    << selected series name: Castle
+    << language: de
+    Added 'S04E21 - Kopfjäger.mkv' to index
+
+    Should I write the new index? y
+    New Index version has been written
+
+After that, an updated version of the index is written to disk, which contains
+the new episode.
+
+## Hooks
+
+`sindex` allows you to define three kinds of Hooks, that are executed at special places. You can supply Scripts or command lines to be executed as Hooks.
+
+ * `pre_processing_hook` is called before the index is parsed on adding new
+   episodes. This allows you to do a `git pull` on your version controlled
+   series index or something else.
+ * `post_processing_hook` is called when a new index is written. I use this
+   to do a `git commit` and `git push` to save the index on Github.
+ * `episode_hook` is called for every episode after a new index is written.
+   The parameters are the filename (relative to `episode_directory`) and second
+   the series name. I use this to move the episodes out of my Download folder
+   into a special directory structure.
 
 ## Contributing
 

data/lib/sindex/series_index.rb

@@ -231,11 +231,8 @@ module Sindex
     # 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
+      matching_series = @series_data.keys.grep(/#{name}/i).first
+      return matching_series if matching_series
 
       @series_aliases.each do |key, val|
         if key.match(/#{name}/i)

data/lib/sindex/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sindex
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-16 00:00:00.000000000 Z
+date: 2012-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -133,7 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4573183238350985480
+      hash: -1112075699874427594
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4573183238350985480
+      hash: -1112075699874427594
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24