torganiser 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 350a58c7d89211f5d455326acb3dba3eafb3793a
-  data.tar.gz: 0c5fc030042cc4dd48cd109fd4e6d1e6d2e1dd3f
+  metadata.gz: fa62b57bdb8c2d67d0068a7c999f21bbd0d5cd13
+  data.tar.gz: 876710a0c443c89d88ecc420133d1687c44b2ab1
 SHA512:
-  metadata.gz: 7f96dc70c919e05ff2bba01ad66e7ea35c74dd81fcfe23643c2d1623da9d403a9bc358a6cb2334fe3a7a98874b259d7142b6c2f068420ea33a59f16249acb3a4
-  data.tar.gz: b0017d3903fcaa9bb07cd81189d29ec16ce16648b8a8091b89a5af4b27688a2e2b954667c3021284137e9ff4d19caf6b64bc9662a0e2004b8401c794bbecf3fc
+  metadata.gz: 6488c31821632f93787d9e1e2a25e3aa0bc0e2f8b0531b55677991a29577a2e215e8acdf2accb1561ffc1e9ee1e2ad76372ef2725ad6d98c8aa072d21ff3d4a7
+  data.tar.gz: 4d89ba9e9a1a12944a8f21c775880273e5315028bd6702cd36d34d930802fdee939961af758d399aa900be0b43a087da1da4a0bcc4f7734ef195b53a1cf9f911

data/README.md

@@ -24,7 +24,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+`torganiser --help`
 
 ## Contributing
 

data/lib/torganiser/episode_file.rb

@@ -5,15 +5,6 @@ module Torganiser
 
     attr_reader :file
 
-    EPISODE_INFO_MATCHER = %r{^
-      (?<series>.+)    # Series name, and possibly year
-      .s(?<season>\d+) # season number
-      e(?<episode>\d+) # episode number
-      \..*$            # everything else
-    }ix
-
-    YEAR_MATCHER = /^\d{4}$/
-
     def initialize(file)
       @file = file
     end
@@ -32,16 +23,59 @@ module Torganiser
 
     def series
       @series ||= begin
-        parts = episode_info[:series].split('.')
-        year = YEAR_MATCHER.match(parts.last) ? parts.pop.to_i : nil
-        Series.new(parts.join(' '), year:year)
+        year = year.to_i if year = episode_info[:year]
+        Series.new(series_name, year: year)
       end
     end
 
     private
 
+    def series_name
+      episode_info[:name].split('.').join(' ').gsub(/[^a-z]+$/i, '')
+    end
+
     def episode_info
-      @episode_info ||= EPISODE_INFO_MATCHER.match(basename)
+      @episode_info ||= Matcher.match(basename) or raise(
+        "Unable to parse #{file}"
+      )
+    end
+
+    # A matcher that can extract semantic information from a
+    # properly named file.
+    module Matcher
+      separator = '(\.|\s|\s?\-\s?)'
+
+      long_format = [
+        's(?<season>\d+)', # season number
+        'e(?<episode>\d+)', # episode number
+        '(e\d+)?' # optional second episode number, ignored
+      ].join('\s?') # optionally space separated
+
+      # season number and episode number together, optionally with an 'x'
+      short_format = '\[?(?<season>\d+)x?(?<episode>\d{2})\]?'
+
+      # specials don't fit nicely into the season/episode model.
+      special = "s(?<season>0)(?<episode>0)|s(?<season>\\d+)#{separator}special"
+
+      season_info = "(#{long_format}|#{short_format}|#{special})"
+
+      # Series name, and possibly year
+      series_with_year = '(?<name>.*)\.(?<year>\d{4})'
+      series_without_year = '(?<name>.*)'
+
+      # Series without year takes precedence
+      series = "(#{series_with_year}|#{series_without_year})"
+
+      PATTERN  = %r{^
+        #{series}                  # Series name, and possibly year
+        #{separator}#{season_info} # season info
+        #{separator}.*$            # stuff we don't care about
+      }ix
+
+      def self.match basename
+        PATTERN.match basename
+      end
+
     end
 
   end

data/lib/torganiser/scanner.rb

@@ -27,7 +27,6 @@ module Torganiser
     end
 
     def ignored? file
-      file = file.strip
       @ignored_patterns.any? { |pattern| pattern.match file }
     end
 

data/lib/torganiser/version.rb

@@ -1,3 +1,3 @@
 module Torganiser
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/spec/torganiser/episode_file_spec.rb

@@ -4,12 +4,12 @@ module Torganiser
 
   describe EpisodeFile do
 
+    subject { EpisodeFile.new(file) }
+
     context "when initialized with an informative filename" do
 
       let(:file) { "file/path/Hello.S02E01.mp4"}
 
-      subject { EpisodeFile.new(file) }
-
       it 'extracts the base file name' do
         expect(subject.basename).to eq 'Hello.S02E01.mp4'
       end
@@ -42,6 +42,21 @@ module Torganiser
 
       end
 
+      context "that is a double episode" do
+
+        let(:file) { "file/path/Hello.2008.S02E01E02.mp4"}
+
+        it 'extracts season number' do
+          expect(subject.season).to eq 2
+        end
+
+        it 'extracts first episode number' do
+          expect(subject.episode).to eq 1
+        end
+
+
+      end
+
       context "that has a series name in dot-format" do
 
         let(:file) { "file/path/Goodbye.Hello.Hamburger.2008.S02E01.mp4"}
@@ -56,6 +71,94 @@ module Torganiser
 
       end
 
+      context "in short format" do
+        let(:file) { "file/path/Hello.2014.302.hdtv-lol.mp4" }
+
+        it 'extracts season number' do
+          expect(subject.season).to eq 3
+        end
+
+        it 'extracts episode number' do
+          expect(subject.episode).to eq 2
+        end
+
+        context "with an 'x'" do
+          let(:file) { "file/path/Hello.2014.4x07.hdtv-lol.mp4" }
+
+          it 'extracts season number' do
+            expect(subject.season).to eq 4
+          end
+
+          it 'extracts episode number' do
+            expect(subject.episode).to eq 7
+          end
+
+        end
+
+        context "surrounded in square brackets" do
+          let(:file) { "file/path/Wootle [3x08] Some title here.avi" }
+
+          it 'extracts season number' do
+            expect(subject.season).to eq 3
+          end
+
+          it 'extracts episode number' do
+            expect(subject.episode).to eq 8
+          end
+
+        end
+
+      end
+
+      context "that is dash-separated" do
+        let(:file) { "Wiffle's Berry - S01E12-the title.avi" }
+
+        it 'extracts series correctly' do
+          expect(Series).to receive(:new).with(
+            "Wiffle's Berry", year: nil
+          )
+          subject.series
+        end
+
+        it 'extracts season number' do
+          expect(subject.season).to eq 1
+        end
+
+        it 'extracts episode number' do
+          expect(subject.episode).to eq 12
+        end
+      end
+
+      context "that is a special" do
+        let(:file) { "file/path/Hello.2014.s00.hdtv-lol.mp4" }
+
+        it 'extracts season number as zero' do
+          expect(subject.season).to eq 0
+        end
+
+        it 'extracts episode number as zero' do
+          expect(subject.episode).to eq 0
+        end
+
+        context "with a season specified" do
+          let(:file) { "file/path/Hello.2014.s01.special.hdtv-lol.mp4" }
+
+          it 'extracts season number' do
+            expect(subject.season).to eq 1
+          end
+
+        end
+      end
+
+    end
+
+    context "when initialised with a file whose name cannot be parsed" do
+
+      let(:file) { "file/path/Hello.this-contains-no-information.mp4"}
+
+      it 'blows up in a more helpful manner' do
+        expect{ subject.series }.to raise_error(/Unable to parse #{file}/) end
+
     end
 
   end

data/spec/torganiser/scanner_spec.rb

@@ -92,7 +92,7 @@ module Torganiser
 
         let(:query_results) do
           [
-            "/tmp/dir2/file5.alsoignorethis\r\n",
+            "/tmp/dir2/file5.alsoignorethis",
             "/tmp/dir1", "/tmp/dir2/file5.ignoreme",
             "/tmp/dir1/file3", "/tmp/dir2",
             "/tmp/dir2/file4"

data/torganiser.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = [""]
   spec.summary       = %q{Organises episode files according to filename.}
   spec.description   = %q{Organises episode files according to filename.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/sergei-matheson/torganiser"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: torganiser
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - ''
@@ -170,7 +170,7 @@ files:
 - spec/torganiser/series_spec.rb
 - spec/torganiser_spec.rb
 - torganiser.gemspec
-homepage: ''
+homepage: https://github.com/sergei-matheson/torganiser
 licenses:
 - MIT
 metadata: {}