showfeature 0.1.1 → 0.1.2

data/README.md

@@ -1,11 +1,12 @@
-## ShowFeature ##
+# ShowFeature
 
-A library to find distinguishable features in a tv show filename as it
-was downloaded   
+A library to find the relevant features in a tv show filename   
 (e.g. [name].S[season]E[episode].hdtv-[team].avi)
 
 # Usage
 
+### Example 1
+
 ```ruby
 require 'showfeature'
 sf = ShowFeature::Processor.new('foo.125.x264-bar.mkv')
@@ -13,8 +14,62 @@ sf.parse
 puts sf.to_hsh # prints {:name=>"foo", :season=>"01", :episode=>"05", :team=>"bar"}
 ```
 
+### Example 2
+
+```ruby
+require 'showfeature'
+require 'fileutils'
+include ShowFeature
+def file_elements in_directory, to_directory = File.expand_path(".")
+  FileUtils.chdir in_directory do 
+    Dir.glob('*').each do |file|
+      # if file is a video or a subtitles file
+      if [:video_file_type?,:subtitles_file_type?].any?{|mth| Processor.send(mth,file)}
+        sf = Processor.new (file)
+        sf.parse
+        unless sf.to_hsh.empty?
+          # create a directory whose name is built with the name of the tv show
+          show_dir = File.join to_directory, sf.name.gsub(' ','_'), sf.season
+          FileUtils.mkdir_p show_dir unless Dir.exists? show_dir
+          # mv 
+          FileUtils.mv sf.raw_name, File.join(show_dir,sf.raw_name), :verbose => true
+        end
+      end
+    end
+  end
+end
+
+system "tree"
+
+# Produces:
+# .
+# |-- foobar.101.x264-raboof.avi
+# |-- foo.s01e01.hdtv-bar.mp4
+# |-- foo.s01e02.hdtv-bar.mp4
+# `-- foo.s01e02.hdtv-bar.srt
+#
+# 0 directories, 4 files
+
+file_elements File.expand_path('~/Vidéos'), File.expand_path('~/Vidéos')
+
+system "tree"
+
+# Produces:
+# .
+# |-- foo
+# |   `-- 01
+# |       |-- foo.s01e01.hdtv-bar.mp4
+# |       |-- foo.s01e02.hdtv-bar.mp4
+# |       `-- foo.s01e02.hdtv-bar.srt
+# `-- foobar
+#     `-- 01
+#         `-- foobar.101.x264-raboof.avi
+
+# 4 directories, 4 files
+```
+
 **Author :** Allan Seymour  
-**Version :** 0.1.1         
-**Release Date :** December 04, 2012             
+**Version :** 0.1.2         
+**Release Date :** December 06, 2012             
 **Copyright :** MIT License        
 

data/lib/showfeature/processor.rb

@@ -18,8 +18,8 @@ module ShowFeature
     # An ArgumentError is raised if +raw_name+'s mime type does not
     # match the type of a video file
     def initialize(raw_name)
-      raise ShowFeature::ArgumentError, 'argument does not match a video file type' unless
-        ShowFeature::Processor.video_file_type? raw_name
+      raise ShowFeature::ArgumentError, "#{raw_name} does not match a video or subtitle file type" unless
+        [:video_file_type?, :subtitles_file_type?].any? {|f| ShowFeature::Processor.send f,raw_name }
       @raw_name = raw_name
       @parsed = false
     end
@@ -31,7 +31,7 @@ module ShowFeature
         tmp = @raw_name[PATTERN,position]
         tmp.nil? ? nil : proc.call(tmp)
       end
-      @name = proc.call(1, lambda{|x| x.downcase.tr_s('.',' ')})
+      @name = proc.call(1, lambda{|x| x.downcase.gsub('.',' ')})
       @season = proc.call(2, lambda{|x| "%02d" % x[/(\d+).?(\d{2}$)/,1].to_i})
       @episode = proc.call(2, lambda{|x| "%02d" % x[/(\d+).?(\d{2}$)/,2].to_i})
       @team = proc.call(3, lambda{|x| x.downcase})
@@ -67,13 +67,28 @@ module ShowFeature
       MIME::Types.of(@raw_name).any? do |x| x.to_s =~/^video/ end
     end
     
+    ##
+    # Checks if +str+'s mime type matches a subtitles file type
+    def self.subtitles_file_type?(str)
+      (str =~ /\.(srt|sub)$/) ? true : false
+    end
+
+    ##
+    # Checks if the mime type of the current processed show matches a subtitles file type
+    def subtitles_file_type?
+      (@raw_name =~ /\.(srt|sub)$/) ? true : false
+    end
     
     def replace(arg)
       raise ShowFeature::TypeError, 'argument must be of type String or Hash' unless 
         [String, Hash].any?{|type| arg.kind_of? type}
       raise ShowFeature::NotParsedError, 'showfeature cannot complete replace if show is not parsed' unless parsed?
       if arg.kind_of? String
-        @raw_name = arg if ShowFeature::Processor.video_file_type?(arg)
+        if video_file_type?
+          @raw_name = arg if ShowFeature::Processor.video_file_type?(arg)
+        elsif subtitle_file_type?
+          @raw_name = arg if ShowFeature::Processor.subtitles_file_type?(arg)
+        end
       else
         hash = {
           :name =>@name, 

data/lib/showfeature/version.rb

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

data/showfeature.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.test_files = `git ls-files -- spec `.split("\n")
   spec.license = 'MIT'
   spec.has_rdoc = true
+  spec.extra_rdoc_files = ['README.md']
   spec.add_dependency('mime-types', '>=1.19')
   spec.add_development_dependency('bundler')
 end

data/spec/showfeature_spec.rb

@@ -37,7 +37,7 @@ describe ShowFeature::Processor do
     result = lambda{ ShowFeature::Processor.new('show')}
     result.must_raise ShowFeature::ArgumentError
     error = result.call rescue $!
-    error.message.must_equal 'argument does not match a video file type'   
+    error.message.must_equal 'show does not match a video or subtitle file type'   
   end
 
 
@@ -52,8 +52,8 @@ describe ShowFeature::Processor do
     it "must filled the hash correctly " do
       @sf.parse
       @sf.to_hsh.must_equal({ :name => @output.name.gsub('.', ' '),
-        :season => @output.season,
-        :episode => @output.episode,
+        :season => "%02d" % @output.season,
+        :episode => "%02d" % @output.episode,
         :team => @output.team })
     end
     it "must return an empty hash if showfeature is not parsed yet" do
@@ -131,6 +131,18 @@ describe ShowFeature::Processor do
         [TrueClass,FalseClass].any? {|elt| @sf.video_file_type?.instance_of? elt}
       end
     end
+    it "must be true" do 
+       @sf.video_file_type?.must_equal true
+    end
+  end
+
+  describe "when asked if it is a subtitles file" do
+    before do 
+      @sf = ShowFeature::Processor.new("foo.s01e05.x264-bar.srt")
+    end
+    it "must be true" do 
+      @sf.subtitles_file_type?.must_equal true
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: showfeature
 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-12-04 00:00:00.000000000 Z
+date: 2012-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -48,7 +48,8 @@ description: This library allows to find the relevant features in a tv show file
 email: banks.the.megalithic.stone@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - .gitignore
 - Gemfile