torganiser 0.0.5 → 0.1.0

data/spec/torganiser/matcher_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+# Main module
+module Torganiser
+  describe Matcher do
+
+    let(:result) { Matcher.match(file) }
+
+    context 'matching an informative filename' do
+
+      let(:file) { 'Hello.S02E01.mp4' }
+
+      it 'matches season number' do
+        expect(result[:season]).to eq '02'
+      end
+
+      it 'matches episode number' do
+        expect(result[:episode]).to eq '01'
+      end
+
+      it 'matches series name' do
+        expect(result[:name]).to eq 'Hello'
+      end
+
+      context 'that does not contain year information' do
+
+        it 'matches a nil year' do
+          expect(result[:year]).to be_nil
+        end
+
+      end
+
+      context 'that contains year information' do
+
+        let(:file) { 'Hello.2008.S02E01.mp4' }
+
+        it 'matches year' do
+          expect(result[:year]).to eq '2008'
+        end
+
+      end
+
+      context 'that is a double episode' do
+
+        let(:file) { 'file/path/Hello.2008.S02E01E02.mp4' }
+
+        it 'matches season number' do
+          expect(result[:season]).to eq '02'
+        end
+
+        it 'matches first episode number' do
+          expect(result[:episode]).to eq '01'
+        end
+
+      end
+
+      context 'in short format' do
+        let(:file) { 'Hello.2014.302.hdtv-lol.mp4' }
+
+        it 'matches season number' do
+          expect(result[:season]).to eq '3'
+        end
+
+        it 'matches episode number' do
+          expect(result[:episode]).to eq '02'
+        end
+
+        context 'with an "x"' do
+          let(:file) { 'Hello.2014.4x07.hdtv-lol.mp4' }
+
+          it 'matches season number' do
+            expect(result[:season]).to eq '4'
+          end
+
+          it 'matches episode number' do
+            expect(result[:episode]).to eq '07'
+          end
+
+        end
+
+        context 'surrounded in square brackets' do
+          let(:file) { 'file/path/Wootle [3x08] Some title here.avi' }
+
+          it 'matches season number' do
+            expect(result[:season]).to eq '3'
+          end
+
+          it 'matches episode number' do
+            expect(result[:episode]).to eq '08'
+          end
+
+        end
+
+      end
+
+      context 'that is dash-separated' do
+        let(:file) { "Wiffle's Berry - S01E12-the title.avi" }
+
+        it 'matches series name' do
+          expect(result[:name]).to eq "Wiffle's Berry -"
+        end
+
+        it 'matches season number' do
+          expect(result[:season]).to eq '01'
+        end
+
+        it 'matches episode number' do
+          expect(result[:episode]).to eq '12'
+        end
+      end
+
+      context 'that is a special' do
+
+        context 'that is has no season' do
+          let(:file) { 'Hello.2014.s00.hdtv-lol.mp4' }
+          it 'matches season number as zero' do
+            expect(result[:season]).to eq '0'
+          end
+
+          it 'matches episode number as nil' do
+            expect(result[:episode]).to be_nil
+          end
+        end
+
+        context 'with a season specified' do
+          let(:file) { 'file/path/Hello.2014.s01.special.hdtv-lol.mp4' }
+
+          it 'matches season number' do
+            expect(result[:season]).to eq '01'
+          end
+
+          it 'matches episode number as nil' do
+            expect(result[:episode]).to be_nil
+          end
+
+        end
+      end
+
+    end
+
+  end
+end

data/spec/torganiser/runner_spec.rb

@@ -1,81 +1,45 @@
 require 'spec_helper'
 
+# Main module
 module Torganiser
-
   describe Runner do
 
-    context "when initialised with a collection, files and extensions" do
-
-      let(:collection) { double("collection") }
-      let(:files) { double("files") }
-      let(:extensions) { double("extensions") }
-      let(:ignored) { [] }
+    context 'when initialised with a scanner and arranger' do
 
       subject do
         Runner.new(
-          collection,
-          files: files, extensions: extensions,
-          ignored: ignored, dry_run: true
+          scanner: scanner, arranger: arranger
         )
       end
 
-      let(:scanner) do
-        instance_double("Torganiser::Scanner", each: nil)
+      let(:arranger) do
+        instance_double('Torganiser::Arranger', arrange: nil)
       end
 
-      before do
-        allow(Scanner).to receive(:new).and_return scanner
+      let(:scanner) do
+        instance_double('Torganiser::Scanner', each: nil)
       end
 
-      describe "a scanner" do
-
-        it "is created for the files,  extensions, and ignored as regex" do
-          expect(Scanner).to receive(:new).with(
-            files, extensions, anything
-          )
-          subject.run
-        end
-
-        let(:ignored) { ["ignored", ".*stuff.*"] }
-
-        it "is given the list of files to ignore converted to regex" do
-          expect(Scanner).to receive(:new).with(
-            anything, anything, [/ignored/, /.*stuff.*/]
-          )
-          subject.run
-        end
+      describe 'the scanner' do
 
-        it "is used to retrieve episode files" do
+        it 'is used to retrieve episode files' do
           expect(scanner).to receive(:each)
           subject.run
         end
 
       end
 
-      context "if any episode files are found" do
+      context 'if any episode files are found' do
 
-        let(:episode_file) { instance_double("Torganiser::EpisodeFile") }
+        let(:episode_file) { instance_double('Torganiser::EpisodeFile') }
 
         before do
           allow(scanner).to receive(:each).and_yield episode_file
         end
 
-        describe "an arranger" do
-
-          let(:arranger) do
-            instance_double("Torganiser::Arranger", arrange: nil)
-          end
-
-          before do
-            allow(Arranger).to receive(:new).and_return arranger
-          end
-
-          it "is created for the collection, and dry run status" do
-            expect(Arranger).to receive(:new).with(collection, dry_run: true)
-            subject.run
-          end
+        describe 'the arranger' do
 
-          it "is used to arrange episode files found by the scanner" do
+          it 'is used to arrange episode files found by the scanner' do
             expect(arranger).to receive(:arrange).with(episode_file)
             subject.run
           end

data/spec/torganiser/scanner_spec.rb

@@ -1,24 +1,24 @@
 require 'spec_helper'
 
+# Main module
 module Torganiser
-
   describe Scanner do
 
-    context "when initialised with an array of files" do
+    context 'when initialised with an array of files' do
 
-      let(:files) { ["/tmp/file1", "/tmp/dir1", "/tmp/file2", "/tmp/dir2"] }
+      let(:files) { ['/tmp/file1', '/tmp/dir1', '/tmp/file2', '/tmp/dir2'] }
 
-      let(:extensions) { double("extensions") }
+      let(:extensions) { double('extensions') }
 
       let(:ignored_patterns) { [] }
 
       subject { Scanner.new(files, extensions, ignored_patterns) }
 
-      let(:query_pattern) { double("query pattern") }
+      let(:query_pattern) { double('query pattern') }
 
       let(:file_query) do
         instance_double(
-          "Torganiser::FileQuery",
+          'Torganiser::FileQuery',
           pattern: query_pattern,
           add_directory: nil,
           add_extension: nil,
@@ -27,7 +27,7 @@ module Torganiser
       end
 
       let(:query_results) do
-        ["/tmp/dir1", "/tmp/dir1/file3", "/tmp/dir2", "/tmp/dir2/file4"]
+        ['/tmp/dir1', '/tmp/dir1/file3', '/tmp/dir2', '/tmp/dir2/file4']
       end
 
       before do
@@ -36,40 +36,40 @@ module Torganiser
         allow(Dir).to receive(:[]).and_return query_results
       end
 
-      describe "a file query" do
-        it "is created for any non-ordinary files" do
-          expect(file_query).to receive(:add_directory).with("/tmp/dir1")
-          expect(file_query).to receive(:add_directory).with("/tmp/dir2")
+      describe 'a file query' do
+        it 'is created for any non-ordinary files' do
+          expect(file_query).to receive(:add_directory).with('/tmp/dir1')
+          expect(file_query).to receive(:add_directory).with('/tmp/dir2')
           subject
         end
 
-        it "is given any extensions" do
+        it 'is given any extensions' do
           expect(file_query).to receive(:add_extension).with extensions
           subject
         end
 
-        context "when enumerating" do
+        context 'when enumerating' do
 
-          context "when given some directories" do
-            it "is used do a directory search" do
+          context 'when given some directories' do
+            it 'is used do a directory search' do
               expect(Dir).to receive(:[]).with query_pattern
               subject.each { |_| }
             end
           end
 
-          context "when empty" do
+          context 'when empty' do
 
-            let(:files) { ["/tmp/file1""/tmp/file2"] }
+            let(:files) { ['/tmp/file1''/tmp/file2'] }
 
             let(:file_query) do
               instance_double(
-                "Torganiser::FileQuery",
+                'Torganiser::FileQuery',
                 add_extension: nil,
                 empty?: true
               )
             end
 
-            it "is not used" do
+            it 'is not used' do
               expect(Dir).not_to receive(:[]).with query_pattern
               subject.each { |_| }
             end
@@ -78,38 +78,37 @@ module Torganiser
         end
       end
 
-      it "enumerates the ordinary files, and files found in the directories" do
+      it 'enumerates the ordinary files, and files found in the directories' do
         expect { |block| subject.each(&block) }.to yield_successive_args(
-          "/tmp/file1",
-          "/tmp/file2",
-          "/tmp/dir1/file3",
-          "/tmp/dir2/file4"
+          '/tmp/file1',
+          '/tmp/file2',
+          '/tmp/dir1/file3',
+          '/tmp/dir2/file4'
         )
       end
 
-      context "if any files match any of the ignore patterns" do
+      context 'if any files match any of the ignore patterns' do
         let(:ignored_patterns) { [/ignoreme/, /alsoignorethis$/] }
 
         let(:query_results) do
           [
-            "/tmp/dir2/file5.alsoignorethis",
-            "/tmp/dir1", "/tmp/dir2/file5.ignoreme",
-            "/tmp/dir1/file3", "/tmp/dir2",
-            "/tmp/dir2/file4"
+            '/tmp/dir2/file5.alsoignorethis',
+            '/tmp/dir1', '/tmp/dir2/file5.ignoreme',
+            '/tmp/dir1/file3', '/tmp/dir2',
+            '/tmp/dir2/file4'
           ]
         end
 
-        it "does not include the ignored files" do
+        it 'does not include the ignored files' do
           expect { |block| subject.each(&block) }.to yield_successive_args(
-            "/tmp/file1",
-            "/tmp/file2",
-            "/tmp/dir1/file3",
-            "/tmp/dir2/file4"
+            '/tmp/file1',
+            '/tmp/file2',
+            '/tmp/dir1/file3',
+            '/tmp/dir2/file4'
           )
         end
       end
 
-
     end
   end
 end

data/spec/torganiser/series_spec.rb

@@ -1,20 +1,20 @@
 require 'spec_helper'
 
+# Main module
 module Torganiser
-
   describe Series do
 
-    context "when initialized with a name" do
+    context 'when initialized with a name' do
 
-      subject { Series.new("Pear Tree") }
+      subject { Series.new('Pear Tree') }
 
       it 'has a display name' do
         expect(subject.display_name).to eq 'Pear Tree'
       end
 
-      context "and year" do
+      context 'and year' do
 
-        subject { Series.new("Pear Tree", year: 2009) }
+        subject { Series.new('Pear Tree', year: 2009) }
 
         it 'has a display name that includes year' do
           expect(subject.display_name).to eq 'Pear Tree (2009)'
@@ -25,5 +25,4 @@ module Torganiser
     end
 
   end
-
 end

data/torganiser.gemspec

@@ -4,29 +4,30 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'torganiser/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "torganiser"
+  spec.name          = 'torganiser'
   spec.version       = Torganiser::VERSION
-  spec.authors       = [""]
-  spec.email         = [""]
-  spec.summary       = %q{Organises episode files according to filename.}
-  spec.description   = %q{Organises episode files according to filename.}
-  spec.homepage      = "https://github.com/sergei-matheson/torganiser"
-  spec.license       = "MIT"
+  spec.authors       = ['']
+  spec.email         = ['']
+  spec.summary       = 'Organises episode files according to filename.'
+  spec.description   = 'Organises episode files according to filename.'
+  spec.homepage      = 'https://github.com/sergei-matheson/torganiser'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "clamp"
+  spec.add_dependency 'clamp'
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "reek"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "cane"
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'cane'
 
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 end