Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
@o-sam-o
o-sam-o committed Aug 8, 2010
1 parent ba6c1f3 commit 1842029
Show file tree
Hide file tree
Showing 3 changed files with 115 additions and 46 deletions.
37 changes: 37 additions & 0 deletions README.md
View file
@@ -0,0 +1,37 @@
# ToName

Overview
--------
ToName is a Ruby library which parses media filenames and extracts metadata (e.g. name and year)

e.g.

* Primer.2004.DVDRip.x264.AC3.avi become Name => 'Primer', year => 2004
* ManMen.S01E01.720p.HDTV.x264-CTU.mkv becomes Name => 'ManMen', series => 1, episode => 1

Most media file names sourced from P2P sites are not immediately machine readable, however, they generally have a fairly consistent naming schema. ToName applies some simple parsing rules to extract enough information so that the movie/tv show can be looked up in a metadata database (e.g. [IMDB](http://www.imdb.com)). ToName does not claim a 100% success rate, however, it's generally good enough to find a match on IMDB.

Features
--------
* Extract movie name and year
* Extract TV show series and episode
* Will look at the parent folder name if media name looks like it has been abbreviated
* Works with both media and torrent filenames

Installation
------------

gem install toname

Examples
--------

TODO

Licence
-------
MIT

Contact
-------
Sam Cavenagh [(cavenaghweb@hotmail.com)](mailto:cavenaghweb@hotmail.com)
92 changes: 46 additions & 46 deletions spec/to_name_spec.rb
View file
Expand Up @@ -3,152 +3,152 @@
describe ToName do

it 'should handle simple movie names' do
content_test_helper('My Movie.avi', 'My Movie', 'My Movie')
content_test_helper('/test/My Movie.avi', 'My Movie', 'My Movie')
content_test_helper('/test/Ajami.avi', 'Ajami', 'Ajami')
check_to_name('My Movie.avi', 'My Movie', 'My Movie')
check_to_name('/test/My Movie.avi', 'My Movie', 'My Movie')
check_to_name('/test/Ajami.avi', 'Ajami', 'Ajami')
end

it 'should extract the year from movie names' do
content_test_helper('/test/My Movie.2010.avi', 'My Movie 2010', 'My Movie', 2010)
content_test_helper('/test/My-Movie.2010.avi', 'My Movie 2010', 'My Movie', 2010)
content_test_helper('My-Movie.2010.torrent', 'My Movie 2010', 'My Movie', 2010)
check_to_name('/test/My Movie.2010.avi', 'My Movie 2010', 'My Movie', 2010)
check_to_name('/test/My-Movie.2010.avi', 'My Movie 2010', 'My Movie', 2010)
check_to_name('My-Movie.2010.torrent', 'My Movie 2010', 'My Movie', 2010)
end

context 'tv show episodes' do
it 'should handle SnnEnn format' do
content_test_helper('/test/My-Tvshow.S12E01.avi', 'My Tvshow S12E01', 'My Tvshow', nil, 12, 1)
content_test_helper('/test/My-Tvshow.S12 E01.avi', 'My Tvshow S12 E01', 'My Tvshow', nil, 12, 1)
check_to_name('/test/My-Tvshow.S12E01.avi', 'My Tvshow S12E01', 'My Tvshow', nil, 12, 1)
check_to_name('/test/My-Tvshow.S12 E01.avi', 'My Tvshow S12 E01', 'My Tvshow', nil, 12, 1)
end

it 'should handle SnnEnn with varying case and format' do
content_test_helper('/test/FlashForward.S01E01.720p.HDTV.x264-CTU.mkv',
check_to_name('/test/FlashForward.S01E01.720p.HDTV.x264-CTU.mkv',
'FlashForward S01E01 720p HDTV x264 CTU',
'FlashForward', nil, 1, 1)
content_test_helper('/test/FlashForward.S02e14.720p.HDTV.x264-CTU.mkv',
check_to_name('/test/FlashForward.S02e14.720p.HDTV.x264-CTU.mkv',
'FlashForward S02e14 720p HDTV x264 CTU',
'FlashForward', nil, 2, 14)
end

it 'should handle x format' do
content_test_helper('/test/My-Tvshow.1x3.avi', 'My Tvshow 1x3', 'My Tvshow', nil, 1, 3)
content_test_helper('/test/My-Tvshow.01x03.avi', 'My Tvshow 01x03', 'My Tvshow', nil, 1, 3)
content_test_helper('/test/My-Tvshow.01x03.extra.avi', 'My Tvshow 01x03 extra', 'My Tvshow', nil, 1, 3)
check_to_name('/test/My-Tvshow.1x3.avi', 'My Tvshow 1x3', 'My Tvshow', nil, 1, 3)
check_to_name('/test/My-Tvshow.01x03.avi', 'My Tvshow 01x03', 'My Tvshow', nil, 1, 3)
check_to_name('/test/My-Tvshow.01x03.extra.avi', 'My Tvshow 01x03 extra', 'My Tvshow', nil, 1, 3)
end

it 'should handle x of y format' do
content_test_helper('/test/A History of Britain - 02 of 15 - Beginnings.avi',
check_to_name('/test/A History of Britain - 02 of 15 - Beginnings.avi',
'A History of Britain 02 of 15 Beginnings',
'A History of Britain', nil, 1, 2)
content_test_helper('/test/A History of Britain - 02of15 - Beginnings.avi',
check_to_name('/test/A History of Britain - 02of15 - Beginnings.avi',
'A History of Britain 02of15 Beginnings',
'A History of Britain', nil, 1, 2)
end

it 'should handle complete words format' do
content_test_helper('/test/1/The Universe - Season 1 Episode 12.avi',
check_to_name('/test/1/The Universe - Season 1 Episode 12.avi',
'The Universe Season 1 Episode 12', 'The Universe',
nil, 1, 12)
end
end

it 'should remove movie format info' do
content_test_helper('/test/My-Movie.DivX.avi', 'My Movie DivX', 'My Movie')
check_to_name('/test/My-Movie.DivX.avi', 'My Movie DivX', 'My Movie')
end

it 'should handle year in brackets' do
content_test_helper('/test/Fanboys (2008) LIMITED DVDRip XviD-SAPHiRE-NoRARs.avi',
check_to_name('/test/Fanboys (2008) LIMITED DVDRip XviD-SAPHiRE-NoRARs.avi',
'Fanboys (2008) LIMITED DVDRip XviD SAPHiRE NoRARs',
'Fanboys', 2008)
content_test_helper('/test/Fanboys [2008] LIMITED DVDRip XviD-SAPHiRE-NoRARs.avi',
check_to_name('/test/Fanboys [2008] LIMITED DVDRip XviD-SAPHiRE-NoRARs.avi',
'Fanboys [2008] LIMITED DVDRip XviD SAPHiRE NoRARs',
'Fanboys', 2008)
content_test_helper('/test/Rendition[2007]DvDrip[Eng]-FXG.mkv',
check_to_name('/test/Rendition[2007]DvDrip[Eng]-FXG.mkv',
'Rendition[2007]DvDrip[Eng] FXG',
'Rendition', 2007)
end

it 'should handle format in brackets' do
content_test_helper('/test/High Fidelity(Xvid)(Darkside_RG).mp4',
check_to_name('/test/High Fidelity(Xvid)(Darkside_RG).mp4',
'High Fidelity(Xvid)(Darkside RG)',
'High Fidelity')
content_test_helper('/test/High Fidelity[Xvid](Darkside_RG).mp4',
check_to_name('/test/High Fidelity[Xvid](Darkside_RG).mp4',
'High Fidelity[Xvid](Darkside RG)',
'High Fidelity')
end

it 'should handle additional information within the year brackets' do
content_test_helper('/test/Bee Movie [2007-DVDRip-H.264]-NewArtRiot.m4v',
check_to_name('/test/Bee Movie [2007-DVDRip-H.264]-NewArtRiot.m4v',
'Bee Movie [2007 DVDRip H 264] NewArtRiot',
'Bee Movie', 2007)
content_test_helper('/test/Cypher [2002, Jeremy Northam, Lucy Liu, David Hewlett, Vincenzo Natali].avi ',
check_to_name('/test/Cypher [2002, Jeremy Northam, Lucy Liu, David Hewlett, Vincenzo Natali].avi ',
'Cypher [2002, Jeremy Northam, Lucy Liu, David Hewlett, Vincenzo Natali]',
'Cypher', 2002)
end

it 'should handle movie names containing just numbers' do
content_test_helper('/test/2012.(cam).avi',
check_to_name('/test/2012.(cam).avi',
'2012 (cam)',
'2012')
content_test_helper('/test/2012.(CAM).avi',
check_to_name('/test/2012.(CAM).avi',
'2012 (CAM)',
'2012')
end

it 'should handle the pay per view format' do
content_test_helper('/test/Inglourious Basterds PPV XViD-IMAGiNE.nfo',
check_to_name('/test/Inglourious Basterds PPV XViD-IMAGiNE.nfo',
'Inglourious Basterds PPV XViD IMAGiNE',
'Inglourious Basterds')
end

it 'should handle movies with & in their names' do
content_test_helper('/test/Angels & Demons (2009) DVDRip XviD-MAXSPEED/Angels & Demons (2009) DVDRip XviD-MAXSPEED www.torentz.3xforum.ro.avi',
check_to_name('/test/Angels & Demons (2009) DVDRip XviD-MAXSPEED/Angels & Demons (2009) DVDRip XviD-MAXSPEED www.torentz.3xforum.ro.avi',
'Angels & Demons (2009) DVDRip XviD MAXSPEED www torentz 3xforum ro',
'Angels & Demons', 2009)
end

it 'should handle movies with dashes in their names' do
content_test_helper('/test/My-Movie.2010.wmv', 'My Movie 2010', 'My Movie', 2010)
check_to_name('/test/My-Movie.2010.wmv', 'My Movie 2010', 'My Movie', 2010)
end

it 'should remove number from movie name if there is more than one file for the same movie' do
#Valid case for number at end of name
content_test_helper('/test/District 9.avi', 'District 9', 'District 9')
check_to_name('/test/District 9.avi', 'District 9', 'District 9')

content_test_helper('/test/xscr-invictus_part1[dupedb.com].avi', 'xscr invictus part1[dupedb com]', 'xscr invictus part1[dupedb com]')
content_test_helper('/test/CD1/xscr-invictus_part1[dupedb.com].avi', 'xscr invictus part1[dupedb com]', 'xscr invictus')
content_test_helper('/test/CD1/xscr-invictus_Part1[dupedb.com].avi', 'xscr invictus Part1[dupedb com]', 'xscr invictus')
content_test_helper('/test/CD1/xscr-invictus_part 1[dupedb.com].avi', 'xscr invictus part 1[dupedb com]', 'xscr invictus')
check_to_name('/test/xscr-invictus_part1[dupedb.com].avi', 'xscr invictus part1[dupedb com]', 'xscr invictus part1[dupedb com]')
check_to_name('/test/CD1/xscr-invictus_part1[dupedb.com].avi', 'xscr invictus part1[dupedb com]', 'xscr invictus')
check_to_name('/test/CD1/xscr-invictus_Part1[dupedb.com].avi', 'xscr invictus Part1[dupedb com]', 'xscr invictus')
check_to_name('/test/CD1/xscr-invictus_part 1[dupedb.com].avi', 'xscr invictus part 1[dupedb com]', 'xscr invictus')

content_test_helper('/test/CD1/District 9-1.avi', 'District 9 1', 'District 9')
content_test_helper('/test/CD2/District 9-2.avi', 'District 9 2', 'District 9')
check_to_name('/test/CD1/District 9-1.avi', 'District 9 1', 'District 9')
check_to_name('/test/CD2/District 9-2.avi', 'District 9 2', 'District 9')

content_test_helper('/test/Crazy.Heart.DVDSCREENER.XviD-MENTiON/CD1/m-crheart-a.avi', 'Crazy Heart DVDSCREENER XviD MENTiON', 'Crazy Heart')
check_to_name('/test/Crazy.Heart.DVDSCREENER.XviD-MENTiON/CD1/m-crheart-a.avi', 'Crazy Heart DVDSCREENER XviD MENTiON', 'Crazy Heart')


content_test_helper('/test/CD1/dmt-intheloop1.avi', 'dmt intheloop1', 'dmt intheloop')
check_to_name('/test/CD1/dmt-intheloop1.avi', 'dmt intheloop1', 'dmt intheloop')

end

it 'should use folder name if media name is shortened' do
content_test_helper('/test/Fifty.Dead.Men.Walking.2008.DVDRIP.XviD-ZEKTORM/FDMW-ZEKTORM.avi',
check_to_name('/test/Fifty.Dead.Men.Walking.2008.DVDRIP.XviD-ZEKTORM/FDMW-ZEKTORM.avi',
'Fifty Dead Men Walking 2008 DVDRIP XviD ZEKTORM', 'Fifty Dead Men Walking', 2008)
content_test_helper('/test/In.The.Loop.DVDRip.XviD-DMT/CD1/dmt-intheloop1.avi', 'In The Loop DVDRip XviD DMT', 'In The Loop')
check_to_name('/test/In.The.Loop.DVDRip.XviD-DMT/CD1/dmt-intheloop1.avi', 'In The Loop DVDRip XviD DMT', 'In The Loop')

content_test_helper('/test/Assassination.Of.A.High.School.President.2008.DVDRip.XviD-ViSiON/aoahsp-xvid-vision.avi',
check_to_name('/test/Assassination.Of.A.High.School.President.2008.DVDRip.XviD-ViSiON/aoahsp-xvid-vision.avi',
'Assassination Of A High School President 2008 DVDRip XviD ViSiON', 'Assassination Of A High School President', 2008)
end

it 'should strip LIMITED from movie name' do
content_test_helper('/test/Bunny.And.The.Bull.LIMITED.DVDRip.XviD-DMT/dmt-bunnybull.avi',
check_to_name('/test/Bunny.And.The.Bull.LIMITED.DVDRip.XviD-DMT/dmt-bunnybull.avi',
'Bunny And The Bull LIMITED DVDRip XviD DMT', 'Bunny And The Bull')
content_test_helper('/test/The.Darjeeling.Limited.2007.DVDRip.AC3.iNT-DEViSE.avi', 'The Darjeeling Limited 2007 DVDRip AC3 iNT DEViSE',
check_to_name('/test/The.Darjeeling.Limited.2007.DVDRip.AC3.iNT-DEViSE.avi', 'The Darjeeling Limited 2007 DVDRip AC3 iNT DEViSE',
'The Darjeeling Limited', 2007)
content_test_helper('/test/The.Lost.Boys[1987]DVDRip-tots/The.Lost.Boys[1987]DVDRip-tots.avi',
check_to_name('/test/The.Lost.Boys[1987]DVDRip-tots/The.Lost.Boys[1987]DVDRip-tots.avi',
'The Lost Boys[1987]DVDRip tots',
'The Lost Boys', 1987)
end

it 'should find parent folder of a media file' do
it 'should find parent folder of a media file' do
ToName.parent_folder_name('test.mpg').should be_nil
ToName.parent_folder_name('/test.mpg').should be_nil
ToName.parent_folder_name('/tmp/test.mpg').should == 'tmp'
Expand All @@ -160,7 +160,7 @@
ToName.parent_folder_name('/tmp/cd2/test.mpg').should == 'tmp'
end

def content_test_helper(location, raw_name, name, year=nil, series=nil, episode=nil)
def check_to_name(location, raw_name, name, year=nil, series=nil, episode=nil)
c = ToName.to_name(location)
c.should_not be_nil
c.location.should == location
Expand Down
32 changes: 32 additions & 0 deletions toname.gemspec
View file
@@ -0,0 +1,32 @@
# -*- encoding: utf-8 -*-

Gem::Specification.new do |s|
s.name = %q{toname}
s.version = "0.1.0"

s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["Sam Cavenagh"]
s.date = %q{2010-08-07}
s.description = %q{Convert video/torrent filename into movie/tv series name and year}
s.email = %q{cavenaghweb@hotmail.com}
s.extra_rdoc_files = ["README.md"]
s.files = ["README.md", "spec", "lib/file_name_info.rb", "lib/to_name.rb"]
s.homepage = %q{http://github.com/o-sam-o/toname}
s.rdoc_options = ["--main", "README.md"]
s.require_paths = ["lib"]
s.rubygems_version = %q{1.3.7}
s.summary = %q{To Name}

if s.respond_to? :specification_version then
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
s.specification_version = 3

if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
s.add_development_dependency(%q<rspec>, [">= 2.5.8"])
else
s.add_dependency(%q<rspec>, [">= 2.5.8"])
end
else
s.add_dependency(%q<rspec>, [">= 2.5.8"])
end
end

0 comments on commit 1842029

Please sign in to comment.