torganiser 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95da8d1d2cb1e354a078274b45135d20fabf096c
-  data.tar.gz: 4e131a6537e63b4443f5c882ab70ef83ec7eaf22
+  metadata.gz: 350a58c7d89211f5d455326acb3dba3eafb3793a
+  data.tar.gz: 0c5fc030042cc4dd48cd109fd4e6d1e6d2e1dd3f
 SHA512:
-  metadata.gz: 079a6dcc32b5176016b5b302038c79c33ad9f80c0870472786b5982429cbcdb4fb5c0c847146c50bbe8e38627980e802fdce1ea747bb5ce6602dbb1397158547
-  data.tar.gz: 32eabd36aaaad7201a196149ddedfd99f4173dc76b8020edebfdc17a907edd617f80f6db2f38af4e383820c5c4d34d096fb638ad0e7ec5c9b04134df5ec97177
+  metadata.gz: 7f96dc70c919e05ff2bba01ad66e7ea35c74dd81fcfe23643c2d1623da9d403a9bc358a6cb2334fe3a7a98874b259d7142b6c2f068420ea33a59f16249acb3a4
+  data.tar.gz: b0017d3903fcaa9bb07cd81189d29ec16ce16648b8a8091b89a5af4b27688a2e2b954667c3021284137e9ff4d19caf6b64bc9662a0e2004b8401c794bbecf3fc

data/README.md

@@ -6,6 +6,7 @@ Simple utility that organises media files according to filename
 [![Build Status](https://travis-ci.org/sergei-matheson/torganiser.svg?branch=master)](https://travis-ci.org/sergei-matheson/torganiser)
 [![Code Climate](https://codeclimate.com/github/sergei-matheson/torganiser/badges/gpa.svg)](https://codeclimate.com/github/sergei-matheson/torganiser)
 [![Test Coverage](https://codeclimate.com/github/sergei-matheson/torganiser/badges/coverage.svg)](https://codeclimate.com/github/sergei-matheson/torganiser)
+[![Gem Version](https://badge.fury.io/rb/torganiser.svg)](http://badge.fury.io/rb/torganiser)
 
 ## Installation
 

data/bin/torganiser

@@ -14,14 +14,24 @@ Clamp do
     environment_variable: "TORGANISER_COLLECTION",
     required: true
 
-  option ["--extension", "-e"], "EXTENSION", "Extension to include eg. mp4. May be specifed multiple times", multivalued: true, attribute_name: :extensions
+  option ["--extension", "-e"], "EXTENSION",
+    "Extension to include eg. mp4. May be specifed multiple times",
+    multivalued: true, attribute_name: :extensions
+
+  option ["--ignore", "-i"], "PATTERN",
+    "Ignore files whose path matches pattern eg. May be specifed multiple times.",
+    multivalued: true, attribute_name: :ignore
 
   option "--dry-run", :flag, "If specified, no files will be moved"
 
-  parameter "FILES ...", "Files or directories to organise", attribute_name: :files
+  parameter "FILES ...", "Files or directories to organise",
+    attribute_name: :files
 
   def execute
-    Torganiser::Runner.new(collection, files: files, extensions: extensions, dry_run: dry_run?).run
+    Torganiser::Runner.new(collection,
+                           files: files, extensions: extensions,
+                           ignored: ignore, dry_run: dry_run?
+                          ).run
   end
 
 end

data/lib/torganiser/runner.rb

@@ -1,10 +1,15 @@
 module Torganiser
   # Runs the organisation process for a given array of
-  # files and extensions
+  # files, extensions, and ignored files
   class Runner
 
-    def initialize(collection, files: [], extensions: [], dry_run: false)
-      @scanner = Scanner.new(files, extensions)
+    def initialize(
+      collection, files: [], extensions: [], ignored: [], dry_run: false
+    )
+      @scanner = Scanner.new(
+        files, extensions,
+        ignored.map { |string| Regexp.new(string) }
+      )
       @arranger = Arranger.new(collection, dry_run: dry_run)
     end
 

data/lib/torganiser/scanner.rb

@@ -5,12 +5,19 @@ module Torganiser
 
     include Enumerable
 
-    def initialize(files, extensions)
+    def initialize(files, extensions, ignored)
       file_query.add_extension extensions
+      ignore ignored
       add_files files
     end
 
     def each
+      all_files { |file| yield file unless ignored? file }
+    end
+
+    private
+
+    def all_files
       ordinary_files.each do |file|
         yield file
       end
@@ -19,7 +26,18 @@ module Torganiser
       end
     end
 
-    private
+    def ignored? file
+      file = file.strip
+      @ignored_patterns.any? { |pattern| pattern.match file }
+    end
+
+    def ignore ignored
+      ignored_patterns.concat([*ignored])
+    end
+
+    def ignored_patterns
+      @ignored_patterns ||= []
+    end
 
     def directory_files
       if file_query.empty?

data/lib/torganiser/version.rb

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

data/spec/torganiser/runner_spec.rb

@@ -9,11 +9,13 @@ module Torganiser
       let(:collection) { double("collection") }
       let(:files) { double("files") }
       let(:extensions) { double("extensions") }
+      let(:ignored) { [] }
 
       subject do
         Runner.new(
           collection,
-          files: files, extensions: extensions, dry_run: true
+          files: files, extensions: extensions,
+          ignored: ignored, dry_run: true
         )
       end
 
@@ -27,8 +29,19 @@ module Torganiser
 
       describe "a scanner" do
 
-        it "is created for the files and extensions" do
-          expect(Scanner).to receive(:new).with(files, extensions)
+        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
 

data/spec/torganiser/scanner_spec.rb

@@ -10,7 +10,9 @@ module Torganiser
 
       let(:extensions) { double("extensions") }
 
-      subject { Scanner.new(files, extensions) }
+      let(:ignored_patterns) { [] }
+
+      subject { Scanner.new(files, extensions, ignored_patterns) }
 
       let(:query_pattern) { double("query pattern") }
 
@@ -77,7 +79,7 @@ module Torganiser
       end
 
       it "enumerates the ordinary files, and files found in the directories" do
-        expect { |b| subject.each(&b) }.to yield_successive_args(
+        expect { |block| subject.each(&block) }.to yield_successive_args(
           "/tmp/file1",
           "/tmp/file2",
           "/tmp/dir1/file3",
@@ -85,6 +87,28 @@ module Torganiser
         )
       end
 
+      context "if any files match any of the ignore patterns" do
+        let(:ignored_patterns) { [/ignoreme/, /alsoignorethis$/] }
+
+        let(:query_results) do
+          [
+            "/tmp/dir2/file5.alsoignorethis\r\n",
+            "/tmp/dir1", "/tmp/dir2/file5.ignoreme",
+            "/tmp/dir1/file3", "/tmp/dir2",
+            "/tmp/dir2/file4"
+          ]
+        end
+
+        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"
+          )
+        end
+      end
+
 
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: torganiser
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-24 00:00:00.000000000 Z
+date: 2014-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp