showfeature 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+#ignore les fichier temporaire généré par linux
+*.*~
+*~
+#ignore ceux généré par emacs
+\#*

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org/'
+
+gem "mime-types"

data/Gemfile.lock

@@ -0,0 +1,10 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    mime-types (1.19)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mime-types

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Allan Seymour
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,20 @@
+## ShowFeature ##
+
+A library to find distinguishable features in a tv show filename as it
+was downloaded   
+(e.g. [name].S[season]E[episode].hdtv-[team].avi)
+
+# Usage
+
+```ruby
+require 'showfeature'
+sf = ShowFeature::Processor.new('foo.125.x264-bar.mkv')
+sf.parse
+puts sf.to_hsh
+```
+
+**Author :** Allan Seymour  
+**Version :** 0.1.0         
+**Release Date :** December 04, 2012             
+**Copyright :** MIT License        
+

data/lib/showfeature/exception.rb

@@ -0,0 +1,7 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+module ShowFeature
+  TypeError = Class.new (TypeError)
+  NotParsedError = Class.new (StandardError)
+  ArgumentError = Class.new(ArgumentError)
+end

data/lib/showfeature/processor.rb

@@ -0,0 +1,90 @@
+$:.unshift File.join(File.dirname(__FILE__), '..')
+require 'showfeature'
+require 'mime/types'
+
+module ShowFeature
+  
+  # The main processor class is in charge of the parsing of tv show filename
+  class Processor
+    
+    attr_reader :id, :name, :team, :episode, :season, :raw_name, :parsed
+    
+    # Pattern used for the parsing process
+    PATTERN = /(^[\w\.\(\)]+)\.(\d{3}|s?\d{1,2}[ex]?\d{2})\..*-(.*)\.[\d\w]{3}$/i
+    
+    ## 
+    # Creates a new Processor instance for +raw_name+ parsing
+    # 
+    # 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
+      @raw_name = raw_name
+      @parsed = false
+    end
+    
+    ##
+    # Parses the tv show filename looking for relevant element
+    def parse
+      proc = Proc.new do |position, proc|
+        tmp = @raw_name[PATTERN,position]
+        tmp.nil? ? nil : proc.call(tmp)
+      end
+      @name = proc.call(1, lambda{|x| x.downcase.tr_s('.',' ')})
+      @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})
+      @parsed = true
+    end
+
+    ##
+    # Checks if the tv show filename has already been parsed
+    def parsed?
+      @parsed
+    end
+
+    ##
+    # Returns hash filled with all parsed element
+    def to_hsh
+      hash = Hash.new
+      hash.merge!( { :name =>@name, 
+                    :season => @season,
+                    :episode => @episode,
+                    :team => @team } ) unless [@name,@season,@episode, @team].all? {|x| x.eql?nil}
+      hash
+    end
+    
+    ##
+    # Checks if +str+'s mime type matches a video file type
+    def self.video_file_type?(str)
+      MIME::Types.of(str).any? do |x| x.to_s =~/^video/ end
+    end
+
+    ##
+    # Checks if the mime type of the current processed show matches a video file type
+    def video_file_type?
+      MIME::Types.of(@raw_name).any? do |x| x.to_s =~/^video/ end
+    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)
+      else
+        hash = {
+          :name =>@name, 
+          :season => @season, 
+          :episode => @episode, 
+          :team => @team }.merge(arg) {|k,v1,v2| k.eql?(:episode) ? "%02d"%v2 : v2}
+        hash.each do |key, value|
+          @raw_name.sub! self.send("#{key}").gsub(' ','.'), value
+          instance_variable_set("@#{key}", value)
+        end
+      end
+    end
+  end
+end

data/lib/showfeature/version.rb

@@ -0,0 +1,3 @@
+module ShowFeature
+  VERSION = "0.1.0"
+end

data/lib/showfeature.rb

@@ -0,0 +1,7 @@
+module ShowFeature
+  ROOT = File.expand_path(File.dirname(__FILE__))
+  Dir.glob(File.join(ROOT, "showfeature",'*.rb')).
+    each  do |file|
+    require file
+  end
+end

data/showfeature.gemspec

@@ -0,0 +1,15 @@
+require File.expand_path('../lib/showfeature/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name = "showfeature"
+  spec.version= ShowFeature::VERSION
+  spec.summary = 'This library allows to find the relevant features in a tv show filename (e.g. [name].S[season]E[episode].hdtv-[team].avi)'
+  spec.description = "This library allows to find the relevant features in a tv show filename (e.g. [name].S[season]E[episode].hdtv-[team].avi)"
+  spec.homepage = "https://github.com/stonebanks/showfeature/"
+  spec.author = "Allan Seymour"
+  spec.email = "banks.the.megalithic.stone@gmail.com"
+  spec.require_paths = ['lib']
+  spec.files = `git ls-files`.split("\n")
+  spec.required_ruby_version = '>= 1.9.1'
+  spec.test_files = `git ls-files -- spec `.split("\n")
+end

data/spec/showfeature_spec.rb

@@ -0,0 +1,136 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'showfeature'
+require 'erb'
+
+Output = Struct.new(:name, :episode, :season, :team, :raw_name)
+
+def create_a_show
+  t = ([('a'..'z'),(0..9)].map{|i| i.to_a}).flatten
+  r = (Array.new(t)<<['(',')','.']).flatten
+  output = Output.new
+  output.name = (0..30).map{r.sample}.join
+  output.team = (0..4).map {t.sample}.join
+  nb = ERB.new (['s<%="%02d"%output.season %>e<%="%02d"%output.episode%>',
+        '<%="%01d"%output.season %><%="%02d"%output.episode%>',
+        '<%="%02d"%output.season %>x<%="%02d"%output.episode%>',
+        '<%="%01d"%output.season %>X<%="%02d"%output.episode%>'].sample)
+  output.season  = (1..99).map{|s| s}.sample.to_s
+  output.episode = (1..99).map{|s| s}.sample.to_s
+  output.raw_name = output.name+"."+ nb.result(binding) + ".hdtv-"+output.team+[".avi",".mp4",".mkv"].sample
+  output
+end
+
+describe ShowFeature::Processor do
+  before do
+    @output = create_a_show
+    @show = @output.raw_name
+   end
+ 
+  it "can be created with a string argument" do 
+    ShowFeature::Processor.new(@show).raw_name.must_equal @show
+  end
+
+  it "must raised an ArgumentError if mime type does not match a video file type" 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'   
+  end
+
+
+  describe "when asked to be hashed" do 
+    before do 
+      @sf = ShowFeature::Processor.new(@show)
+    end
+    it "must return an hash" do 
+      @sf.parse
+      @sf.to_hsh.must_be_instance_of Hash
+    end
+    it "must filled the hash correctly " do
+      @sf.parse
+      @sf.to_hsh.must_equal({ :name => @output.name.gsub('.', ' '),
+        :season => @output.season,
+        :episode => @output.episode,
+        :team => @output.team })
+    end
+    it "must return an empty hash if showfeature is not parsed yet" do
+      @sf.to_hsh.must_be_empty
+    end
+  end
+ 
+  describe "when asked to parse the show name" do 
+    before do 
+      @sf = ShowFeature::Processor.new(@show)
+      @sf.parse
+    end
+    it "must retrieve the element" do 
+      assert_block do 
+        [:name, :episode, :team, :raw_name].
+          all? {|stuff| 
+          @output.send(stuff).eql? @sf.send(stuff).gsub(' ','.')
+        }
+        @output.season.to_i.must_equal @sf.season.to_i
+      end
+    end
+  end
+
+  describe "when asked if parsed" do
+    before do
+      @sf = ShowFeature::Processor.new(@show)
+    end
+    it "must return true if parsed" do
+      @sf.parsed?.wont_equal true
+      @sf.parse
+      @sf.parsed?.must_equal true
+    end
+  end
+
+  describe "when asked to replace an element" do 
+    before do 
+      @sf = ShowFeature::Processor.new(@show)
+    end
+    it "must replace raw_name by default when a string is passed" do 
+      @sf.parse
+      @sf.replace("foo.s01e01.hdtv-bar.mp4")
+      @sf.raw_name.must_equal "foo.s01e01.hdtv-bar.mp4"
+    end
+    it "must replace the wanted attributes" do 
+      @sf.parse
+      @sf.replace(name: "foo", season: '01', episode: 1, team: "bar")
+      @sf.raw_name.must_match /foo.*01.?01.*bar/
+    end
+    it "must raised if not parsed yet" do 
+      result = lambda{ @sf.replace(:name => "foo")}
+      result.must_raise ShowFeature::NotParsedError
+      error = result.call rescue $!
+      error.message.must_equal 'showfeature cannot complete replace if show is not parsed'
+    end
+    it "must raised if the given argument is not of type String or Hash" do
+      result = lambda{ @sf.replace([])}
+      result.must_raise ShowFeature::TypeError
+      error = result.call rescue $!
+      error.message.must_equal 'argument must be of type String or Hash'
+    end
+
+    it "wont do anything if argument has not a video filename when a String is passed" do 
+      @sf.parse
+      @sf.replace 'foo'
+      @sf.raw_name.must_equal @output.raw_name
+    end
+  end
+ 
+  describe "when asked if it is a video file" do
+    before do 
+      @sf = ShowFeature::Processor.new(@show)
+    end
+    it "must be true or false" do 
+      assert_block do 
+        [TrueClass,FalseClass].any? {|elt| @sf.video_file_type?.instance_of? elt}
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: showfeature
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Allan Seymour
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-04 00:00:00.000000000 Z
+dependencies: []
+description: This library allows to find the relevant features in a tv show filename
+  (e.g. [name].S[season]E[episode].hdtv-[team].avi)
+email: banks.the.megalithic.stone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/showfeature.rb
+- lib/showfeature/exception.rb
+- lib/showfeature/processor.rb
+- lib/showfeature/version.rb
+- showfeature.gemspec
+- spec/showfeature_spec.rb
+homepage: https://github.com/stonebanks/showfeature/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: This library allows to find the relevant features in a tv show filename (e.g.
+  [name].S[season]E[episode].hdtv-[team].avi)
+test_files:
+- spec/showfeature_spec.rb