torganiser 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa62b57bdb8c2d67d0068a7c999f21bbd0d5cd13
-  data.tar.gz: 876710a0c443c89d88ecc420133d1687c44b2ab1
+  metadata.gz: 4a6e95d03cf82ff1426755d92efe2f603e7a504d
+  data.tar.gz: cfa305bdc2b3fb04ecba975f6a921e0e7c87fa1f
 SHA512:
-  metadata.gz: 6488c31821632f93787d9e1e2a25e3aa0bc0e2f8b0531b55677991a29577a2e215e8acdf2accb1561ffc1e9ee1e2ad76372ef2725ad6d98c8aa072d21ff3d4a7
-  data.tar.gz: 4d89ba9e9a1a12944a8f21c775880273e5315028bd6702cd36d34d930802fdee939961af758d399aa900be0b43a087da1da4a0bcc4f7734ef195b53a1cf9f911
+  metadata.gz: 545ffd98cbdf6fd662f542a6350c45ecd7797cfb2857c36aaa6d1d5f113502a1dd82c52efa863ac8ba3d782a76274cd0c0c09c431f03e7cc97bdec953a524938
+  data.tar.gz: 1bc8e5eb7a7ac3d0fd475c2302482514c4da7d0725ed688b777aec05789a165dce2585cc1dd101479126407f34dc4e3cd6ba6b668deec073d7293f87e6f948df

data/Rakefile

@@ -1,22 +1,27 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 require 'reek/rake/task'
+require 'rubocop/rake_task'
 
 Reek::Rake::Task.new
 
 begin
   require 'cane/rake_task'
 
-  desc "Run cane to check quality metrics"
+  desc 'Run cane to check quality metrics'
   Cane::RakeTask.new(:quality) do |cane|
     cane.abc_max = 10
     cane.add_threshold 'coverage/.last_run.json', :>=, 100
   end
 
 rescue LoadError
-  warn "cane not available, quality task not provided."
+  warn 'cane not available, quality task not provided.'
 end
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => [ :spec, :quality, :reek ]
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+end
+
+task default: [:spec, :quality, :reek, :rubocop]

data/bin/torganiser

@@ -4,34 +4,44 @@ require 'torganiser'
 
 Clamp do
 
-  option ["--version", "-v"], :flag, "Show version" do
+  option ['--version', '-v'], :flag, 'Show version' do
     puts Torganiser::VERSION
     exit(0)
   end
 
-  option ["--collection", "-c"], "DIRECTORY",
-    "Root of the collection into which to organise the files",
-    environment_variable: "TORGANISER_COLLECTION",
-    required: true
+  option ['--collection', '-c'], 'DIRECTORY',
+         'Root of the collection into which to organise the files',
+         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 specified 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 ['--ignore', '-i'], 'PATTERN',
+         'Ignore files whose path matches pattern eg. May be specified multiple times.',
+         multivalued: true, attribute_name: :ignore
 
-  option "--dry-run", :flag, "If specified, no files will be moved"
+  option '--dry-run', :flag, 'If specified, no files will be moved'
 
-  parameter "FILES ...", "Files or directories to organise",
-    attribute_name: :files
+  option '--copy', :flag, 'If specified, files will be copied instead of moved'
+
+  parameter 'FILES ...', 'Files or directories to organise',
+            attribute_name: :files
+
+  def scanner
+    Torganiser::Scanner.new(
+      files, extensions,
+      ignore.map { |string| Regexp.new(string) }
+    )
+  end
+
+  def arranger
+    Torganiser::Arranger.new(collection, dry_run: dry_run?, copy: copy?)
+  end
 
   def execute
-    Torganiser::Runner.new(collection,
-                           files: files, extensions: extensions,
-                           ignored: ignore, dry_run: dry_run?
-                          ).run
+    Torganiser::Runner.new(scanner: scanner, arranger: arranger).run
   end
 
 end

data/lib/torganiser.rb

@@ -1,12 +1,15 @@
-require "torganiser/version"
-require "torganiser/file_query"
-require "torganiser/series"
-require "torganiser/episode_file"
-require "torganiser/scanner"
-require "torganiser/arranger"
-require "torganiser/runner"
+require 'torganiser/version'
+require 'torganiser/file_query'
+require 'torganiser/series'
+require 'torganiser/match_one'
+require 'torganiser/matcher'
+require 'torganiser/episode_file'
+require 'torganiser/scanner'
+require 'torganiser/arranger'
+require 'torganiser/runner'
 
-require "clamp"
+require 'clamp'
 
+# Main module and entry point.
 module Torganiser
 end

data/lib/torganiser/arranger.rb

@@ -3,26 +3,33 @@ require 'fileutils'
 module Torganiser
   # Handles arranging episode files into a collection
   class Arranger
+    attr_reader :collection, :dry_run, :copy
 
-    attr_reader :collection, :dry_run
-
-    def initialize collection, dry_run: false
+    def initialize(collection, dry_run: false, copy: false)
       @collection = collection
       @dry_run = dry_run
+      @copy = copy
     end
 
-    def arrange file
+    def arrange(file)
       episode = EpisodeFile.new(file)
-      move(episode, Destination.new(collection, episode))
+      arrange_episode(episode)
     end
 
     private
 
-    def move episode, destination
-      directory = destination.directory
+    def arrange_episode(episode)
+      arrange_method.call episode.file, ensure_directory_for(episode)
+    end
+
+    def ensure_directory_for(episode)
+      Destination.new(collection, episode).directory.tap do |dir|
+        file_utils.mkdir_p dir unless File.exist? dir
+      end
+    end
 
-      file_utils.mkdir_p directory unless File.exists? directory
-      file_utils.mv episode.file, directory
+    def arrange_method
+      @arrange_method ||= file_utils.method(@copy ? :cp : :mv)
     end
 
     def file_utils
@@ -31,10 +38,9 @@ module Torganiser
 
     # Models a destination for an episode file in a collection
     class Destination
-
       attr_reader :collection, :episode_file
 
-      def initialize collection, episode_file
+      def initialize(collection, episode_file)
         @collection = collection
         @episode_file = episode_file
       end
@@ -44,6 +50,7 @@ module Torganiser
       end
 
       private
+
       def season_dir
         "Season #{episode_file.season}"
       end
@@ -55,7 +62,6 @@ module Torganiser
       def series
         episode_file.series
       end
-
     end
   end
 end

data/lib/torganiser/episode_file.rb

@@ -2,7 +2,6 @@ module Torganiser
   # Models a file that contains a single episode of a TV series.
   # Attempts to extract episode data, based on the filename.
   class EpisodeFile
-
     attr_reader :file
 
     def initialize(file)
@@ -23,7 +22,8 @@ module Torganiser
 
     def series
       @series ||= begin
-        year = year.to_i if year = episode_info[:year]
+        year = episode_info[:year]
+        year = year.to_i if year
         Series.new(series_name, year: year)
       end
     end
@@ -35,48 +35,9 @@ module Torganiser
     end
 
     def episode_info
-      @episode_info ||= Matcher.match(basename) or raise(
+      @episode_info ||= Matcher.match(basename) || fail(
         "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
 end

data/lib/torganiser/file_query.rb

@@ -4,7 +4,6 @@ module Torganiser
   # The 'pattern' method returns a Dir.glob style pattern
   # that can be used to match a set of files.
   class FileQuery
-
     attr_reader :directories, :extensions
 
     def initialize(directories: nil, extensions: nil)
@@ -18,16 +17,16 @@ module Torganiser
       @directories.empty?
     end
 
-    def add_extension extensions
+    def add_extension(extensions)
       @extensions.concat([*extensions])
     end
 
-    def add_directory directories
+    def add_directory(directories)
       @directories.concat([*directories])
     end
 
     def pattern
-      directory_pattern + "/**/" + extension_pattern
+      directory_pattern + '/**/' + extension_pattern
     end
 
     private
@@ -37,23 +36,20 @@ module Torganiser
     end
 
     def extension_pattern
-      "*" + (extensions.count > 0 ? ItemsPattern.new(extensions).to_s : '')
+      '*' + (extensions.count > 0 ? ItemsPattern.new(extensions).to_s : '')
     end
 
     # Models a pattern that matchers a series of one or more string items.
     class ItemsPattern
-
       attr_reader :items
 
-      def initialize items
+      def initialize(items)
         @items = items
       end
 
       def to_s
         items.count > 1 ?  "{#{items.join(',')}}" : items.first
       end
-
     end
-
   end
 end

data/lib/torganiser/match_one.rb

@@ -0,0 +1,12 @@
+module Torganiser
+  # Creates a regex-ready string for matching one of a set of alternatives
+  class MatchOne
+    def initialize(alternatives)
+      @alternatives = alternatives
+    end
+
+    def to_s
+      "(#{@alternatives.join('|')})"
+    end
+  end
+end

data/lib/torganiser/matcher.rb

@@ -0,0 +1,63 @@
+module Torganiser
+  # A matcher that can extract semantic information from a
+  # properly named file.
+  class Matcher
+    class << self
+      def match(basename)
+        pattern.match basename
+      end
+
+      private
+
+      def pattern
+        @pattern ||= /^
+          #{series}                  # Series name, and possibly year
+          #{separator}#{season_info} # season info
+          #{separator}.*$            # stuff we don't care about
+        /ix
+      end
+
+      def separator
+        @separator ||= one_of '\.', '\s', '\s?\-\s?'
+      end
+
+      def series
+        # Series with year takes precedence
+        one_of series_with_year, series_without_year
+      end
+
+      def series_without_year
+        '(?<name>.*)'
+      end
+
+      def series_with_year
+        '(?<name>.*)\.(?<year>\d{4})'
+      end
+
+      def season_info
+        one_of long_format, short_format, special
+      end
+
+      def long_format
+        [
+          's(?<season>\d+)',  # season number
+          'e(?<episode>\d+)', # episode number
+          '(e\d+)?'           # optional second episode number, ignored
+        ].join('\s?')         # optionally space separated
+      end
+
+      def short_format
+        '\[?(?<season>\d+)x?(?<episode>\d{2})\]?'
+      end
+
+      def special
+        # specials don't fit nicely into the season/episode model.
+        "s(?<season>0)0|s(?<season>\\d+)#{separator}special"
+      end
+
+      def one_of(*args)
+        MatchOne.new(args)
+      end
+    end
+  end
+end

data/lib/torganiser/runner.rb

@@ -2,15 +2,9 @@ module Torganiser
   # Runs the organisation process for a given array of
   # files, extensions, and ignored files
   class Runner
-
-    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)
+    def initialize(scanner: scanner, arranger: arranger)
+      @scanner = scanner
+      @arranger = arranger
     end
 
     def run
@@ -20,10 +14,9 @@ module Torganiser
     end
 
     private
-    def arrange episode_file
+
+    def arrange(episode_file)
       @arranger.arrange episode_file
     end
-
   end
-
 end

data/lib/torganiser/scanner.rb

@@ -2,7 +2,6 @@ module Torganiser
   # Handles scanning a set of directories and files
   # and returning any found episode files.
   class Scanner
-
     include Enumerable
 
     def initialize(files, extensions, ignored)
@@ -26,11 +25,11 @@ module Torganiser
       end
     end
 
-    def ignored? file
+    def ignored?(file)
       @ignored_patterns.any? { |pattern| pattern.match file }
     end
 
-    def ignore ignored
+    def ignore(ignored)
       ignored_patterns.concat([*ignored])
     end
 
@@ -46,13 +45,13 @@ module Torganiser
       end
     end
 
-    def add_files files
+    def add_files(files)
       files.each do |file|
         add_file file
       end
     end
 
-    def add_file file
+    def add_file(file)
       if File.file?(file)
         ordinary_files << file
       else
@@ -67,6 +66,5 @@ module Torganiser
     def file_query
       @file_query ||= FileQuery.new
     end
-
   end
 end