organisir 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b5a8a59f69fe29c8aad7552739f29e6ad21605ea00a0eee59978a489cf4b46f
-  data.tar.gz: 55ad2e84a64eb396d6b2838528da475822c36f0fc7b4f01372d48394cffd6e51
+  metadata.gz: abf576cbeedcd8e6deb19d7f17a6685ae24d77f9931619aa3d17724d7e507f68
+  data.tar.gz: 4d1aa92d804d682b84232a31b820e4c8ac6fda9e094b0cd42f4509457166eacc
 SHA512:
-  metadata.gz: 9f266331405326ed542974a62fb3ac7a6d6a4b2397351f55a265df52bff5ddb5a2675ce0e16d36266ac10bb71d8fafcad1c5e75a516f3d84761e0830e44a534b
-  data.tar.gz: f1c19c78a5d7ff7ca4d54f17a6ddbab0aa9b619109937203564ddd7abfaf120ae2b301f78ce8f37d40f89fd56f837ce5e6915d520d9726dea9cbc9db7620a449
+  metadata.gz: e96291f37be80c0d0415e77e5feccd74f4b08b2524ba23f9043db4206523e039f908c0cbb48d029d2321e2ecf86e368674df11751fa1ee1402558bacd9de6473
+  data.tar.gz: 3868b591ed62f2b312abbbddc1a857e03fee292477f2ae921c88b0ebb0a11d5cb8797151a7ad960539725f92d83d71e72c5ff89c18985e0de7f8a8ef19bc43fc

data/.gitignore

@@ -7,4 +7,4 @@
 /spec/reports/
 /tmp/
 /.idea
-organisir-*.gem
+note

data/Gemfile

@@ -12,3 +12,5 @@ gem "rubocop", "~> 0.80"
 gem "thor", "~> 1.0"
 
 gem "colorize", "~> 0.8.1"
+
+gem "pry", "~> 0.13.1"

data/Gemfile.lock

@@ -1,16 +1,21 @@
 PATH
   remote: .
   specs:
-    organisir (0.1.2)
+    organisir (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.1)
+    coderay (1.1.3)
     colorize (0.8.1)
+    method_source (1.0.0)
     parallel (1.20.1)
     parser (2.7.2.0)
       ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.1)
     regexp_parser (2.0.0)
@@ -36,6 +41,7 @@ PLATFORMS
 DEPENDENCIES
   colorize (~> 0.8.1)
   organisir!
+  pry (~> 0.13.1)
   rake (~> 13.0)
   rubocop (~> 0.80)
   thor (~> 1.0)

data/lib/organisir.rb

@@ -3,16 +3,19 @@
 require "fileutils"
 require "thor"
 require "colorize"
-
+require "pathname"
+require "pry"
 
 module Organisir
 end
 
-# require "organisir/"
 require "organisir/cli"
-require "organisir/client"
-require "organisir/file_op"
+require "organisir/commands/clean_symlinks"
+require "organisir/commands/move_files"
+require "organisir/commands/multi_symlink_files"
+require "organisir/commands/symlink_files"
 require "organisir/rule"
 require "organisir/symlink_rule"
+require "organisir/util"
 require "organisir/validator"
 require "organisir/version"

data/lib/organisir/cli.rb

@@ -8,36 +8,71 @@ module Organisir
       true
     end
 
-    desc "start source destination", "Move files from source to destination directory"
+    desc "move source destination", "Move files from source to destination directory"
     option :source, aliases: :s, required: true, type: :string
     option :destination, aliases: :d, required: true, type: :string
     option :commit, type: :boolean, default: false
 
-    def start
+    def move
       if options[:commit]
         say "Preparing to move files in 5 seconds. Cancel the command by pressing Ctrl-C"
         sleep(5)
       else
-        say "Start command always runs in non-commit mode. Use --commit true to permanently move files.", :red
+        say "move command always runs in non-commit mode. Use --commit true to permanently move files.", :red
       end
-      pwd = Dir.pwd
-      Organisir::Client.new.start(options[:source], options[:destination], pwd, options[:commit])
+      Organisir::Commands::MoveFiles.new(options[:source], options[:destination], Dir.pwd, options[:commit]).move
+      say "Process completed"
     rescue Interrupt
       say "Exiting organisir...", :green
     end
 
-    desc "symlink", "Symlink files in nested directories to matching sub-directories within the given directory"
+    desc "symlink source destination[optional]", "Symlink files in nested directories to matching sub-directories within the given directory"
     option :source, aliases: :s, required: true, type: :string
     option :commit, type: :boolean, default: false
     def symlink
       if options[:commit]
         say "Preparing to symlink files in 5 seconds. Cancel the command by pressing Ctrl-C"
-        # sleep(5)
+        sleep(5)
+      else
+        say "symlink command always runs in non-commit mode. Use --commit true to symlink files.", :red
+      end
+      Organisir::Commands::SymlinkFiles.new(options[:source], Dir.pwd, options[:commit]).link
+      say "Process completed"
+    rescue Interrupt
+      say "Exiting organisir...", :green
+    end
+
+    desc "multi_symlink source destination",
+         "Symlink files present in a source directory to matching sub-directories within the given destination directory"
+    option :source, aliases: :s, required: true, type: :string
+    option :destination, aliases: :d, required: true, type: :string
+    option :commit, type: :boolean, default: false
+    def multi_symlink
+      if options[:commit]
+        say "Preparing to symlink files in 5 seconds. Cancel the command by pressing Ctrl-C"
+        sleep(5)
+      else
+        say "multi_symlink command always runs in non-commit mode. Use --commit true to symlink files.", :red
+      end
+      Organisir::Commands::MultiSymlinkFiles.new(options[:source], options[:destination], Dir.pwd, options[:commit]).link
+      say "Process completed"
+    rescue Interrupt
+      say "Exiting organisir...", :green
+    end
+
+    desc "clean_symlinks source", "Removes all symlinks inside directory and its subdirectories"
+    option :source, aliases: :s, required: true, type: :string
+    option :commit, type: :boolean, default: false
+    option :all, type: :boolean, default: false
+    def clean_symlinks
+      if options[:commit]
+        say "Preparing to remove all symlinks in 5 seconds. Cancel the command by pressing Ctrl-C"
+        sleep(5)
       else
-        say "Symlink command always runs in non-commit mode. Use --commit true to symlink files.", :red
+        say "clean_symlinks command always runs in non-commit mode. Use --commit true to remove symlinks.", :red
       end
-      pwd = Dir.pwd
-      Organisir::Client.new.symlink(options[:source], pwd, options[:commit])
+      Organisir::Commands::CleanSymlinks.new(options[:source], Dir.pwd, options[:commit], options[:all]).clean
+      say "Process completed"
     rescue Interrupt
       say "Exiting organisir...", :green
     end

data/lib/organisir/commands/clean_symlinks.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Organisir
+  module Commands
+    class CleanSymlinks
+      def initialize(source_dir, pwd, commit, all)
+        @abs_source_dir = File.join(pwd, source_dir)
+        @verbose = !commit
+        @all = all
+      end
+
+      def clean
+        fetch_all_symlinks.each do |sym|
+          print "Delete symlink #{sym.to_s.colorize(:red)}.\n"
+          File.delete(sym) unless @verbose
+        end
+      end
+
+      private
+
+      def fetch_all_symlinks
+        Dir.glob(File.join(@abs_source_dir, "**", "*")).filter do |f|
+          @all ? File.symlink?(f) : File.symlink?(f) && File.exist?(f)
+        end
+      end
+
+    end
+  end
+end

data/lib/organisir/commands/move_files.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Organisir
+  module Commands
+    class MoveFiles
+      def initialize(source_dir, dest_dir, pwd, commit)
+        @abs_source_dir = File.join(pwd, source_dir)
+        @abs_dest_dir = File.join(pwd, dest_dir)
+        Validator.validate_start(@abs_source_dir, @abs_dest_dir)
+
+        @verbose = !commit
+        @pwd = pwd
+      end
+
+      def move
+        sub_dirs = Util.get_sub_dirs(@abs_dest_dir)
+
+        print("Scanned #{sub_dirs.length} directories in #{@abs_dest_dir}\n")
+        src_files = get_src_files(@abs_source_dir)
+        print("Scanned #{src_files.length} files in #{@abs_source_dir}\n")
+
+        rule = Rule.new(sub_dirs)
+        src_files.each do |f|
+          match_dir = rule.match(f).try(:min)
+          next if match_dir.nil? || match_dir.empty?
+
+          process(f, match_dir)
+        end
+      end
+
+      private
+
+      def get_src_files(dir)
+        Dir.entries(dir).reject { |f| File.directory? f }
+      end
+
+      def process(filename, dirname)
+        print "Rule matched file #{filename.to_s.colorize(:red)} moved to directory #{dirname.to_s.colorize(:red)}\n"
+        return if @verbose
+
+        src = File.join(@abs_source_dir, filename)
+        dest = File.join(File.join(@abs_dest_dir, dirname), filename)
+        FileUtils.move(src, dest, force: false, verbose: false)
+      end
+
+    end
+  end
+end

data/lib/organisir/commands/multi_symlink_files.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Organisir
+  module Commands
+    class MultiSymlinkFiles
+
+      def initialize(source_dir, destination_dir, pwd, commit)
+        @abs_source_dir = File.join(pwd, source_dir)
+        @abs_destination_dir = File.join(pwd, destination_dir)
+        @verbose = !commit
+      end
+
+      def link
+        sub_dirs = Util.get_sub_dirs(@abs_destination_dir)
+        print("Scanned #{files.length} files inside #{sub_dirs.length} directories in #{@abs_dest_dir}\n")
+        rule = Rule.new(sub_dirs)
+        files.each do |f|
+          match_dirs = rule.match(f)
+          next if match_dirs.nil? || match_dirs.empty?
+
+          process(f, match_dirs)
+        end
+      end
+
+      private
+
+      def files
+        Dir.glob(File.join(@abs_source_dir, "**", "*"))
+           .reject { |f| File.directory?(f) || File.symlink?(f) || File.zero?(f) }
+      end
+
+      def process(file, dirs)
+        print "Rule matched file #{file.to_s.colorize(:red)} symlinked to directory(s) #{dirs.join(", ").to_s.colorize(:red)}\n"
+        return if @verbose
+
+        dirs.each do |d|
+          begin
+            dest = File.join(@abs_destination_dir, d)
+            relative_path = Pathname.new(file).relative_path_from(dest)
+            FileUtils.ln_s(relative_path, dest, force: false, verbose: false)
+          rescue Errno::EEXIST
+            nil
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/organisir/commands/symlink_files.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Organisir
+  module Commands
+    class SymlinkFiles
+      def initialize(source_dir, pwd, commit)
+        @abs_source_dir = File.join(pwd, source_dir)
+        @verbose = !commit
+      end
+
+      def link
+        sub_dirs = Util.get_sub_dirs(@abs_source_dir)
+        files = Dir.glob(File.join(@abs_source_dir, "*", "*.*"))
+                   .reject { |f| File.directory?(f) || File.symlink?(f) || File.zero?(f) }
+        print("Scanned #{files.length} files inside #{sub_dirs.length} directories in #{@abs_dest_dir}\n")
+
+        rule = SymlinkRule.new(sub_dirs)
+        files.each do |f|
+          match_dirs = rule.match(f)
+          next if match_dirs.nil? || match_dirs.empty?
+
+          process(f, match_dirs)
+        end
+      end
+
+      private
+
+      def process(src_file, destination_dirs)
+        print "Rule matched file #{src_file.to_s.colorize(:red)} symlinked to directory(s) #{destination_dirs.join(", ").to_s.colorize(:red)}\n"
+        return if @verbose
+
+        destination_dirs.each do |d|
+          begin
+            dest = File.join(@abs_source_dir, d)
+            relative_path = Pathname.new(src_file).relative_path_from(dest)
+            FileUtils.ln_s(relative_path, dest, force: false, verbose: false)
+          rescue Errno::EEXIST
+            nil
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/organisir/rule.rb

@@ -6,7 +6,7 @@ module Organisir
       @dirs = dirs
       @dir_map = {}
       @dirs.map do |dir|
-        @dir_map[dir] = gen_regex_for_dir_name(dir)
+        @dir_map[dir] = Util.gen_regex_for_dir_name(dir)
       end
     end
 
@@ -16,15 +16,8 @@ module Organisir
         resp << k if file.downcase.match(@dir_map[k])
       end
 
-      resp.min unless resp.empty?
+      resp
     end
 
-    private
-
-    def gen_regex_for_dir_name(dir)
-      tokens = dir.downcase.split
-      name_token = tokens.join('\\b.*\\b')
-      Regexp.new("\\b#{name_token}\\b", Regexp::EXTENDED | Regexp::IGNORECASE)
-    end
   end
 end

data/lib/organisir/symlink_rule.rb

@@ -6,29 +6,21 @@ module Organisir
       @dirs = dirs
       @dir_map = {}
       @dirs.map do |dir|
-        @dir_map[dir] = gen_regex_for_dir_name(dir)
+        @dir_map[dir] = Util.gen_regex_for_dir_name(dir)
       end
     end
 
     def match(file)
       resp = []
-      filename = file.split("/").last.downcase
-      file_dir = file.split("/").fetch(-2)
+      filename = File.basename(file).downcase
+      file_dir = File.basename(File.dirname(file))
       @dirs.each do |d|
         next if file_dir.include? d
 
-        resp << d if filename.downcase.match? @dir_map[d]
+        resp << d if filename.downcase.match?(@dir_map[d])
       end
       resp
     end
 
-    private
-
-    def gen_regex_for_dir_name(dir)
-      tokens = dir.downcase.split
-      name_token = tokens.join('\\b.*\\b')
-      Regexp.new("\\b#{name_token}\\b", Regexp::EXTENDED | Regexp::IGNORECASE)
-    end
-
   end
 end

data/lib/organisir/util.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Organisir
+  class Util
+
+    class << self
+      def get_sub_dirs(dir)
+        Dir.chdir(dir) do
+          Dir["*"].select { |o| File.directory?(o) }
+        end
+      end
+
+      def gen_regex_for_dir_name(dir)
+        tokens = dir.downcase.split
+        # TODO: Verify if this regex rule can be deprecated
+        # name_token = tokens.join('\\b.*\\b')
+        # Regexp.new("\\b#{name_token}\\b", Regexp::EXTENDED | Regexp::IGNORECASE)
+        name_token = tokens.join(".*")
+        Regexp.new(".*#{name_token}.*", Regexp::EXTENDED | Regexp::IGNORECASE)
+      end
+    end
+
+  end
+end

data/lib/organisir/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Organisir
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: organisir
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - anujchandra
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies: []
 description: Gem to organise files based on their filename
 email:
@@ -29,10 +29,13 @@ files:
 - exe/organisir
 - lib/organisir.rb
 - lib/organisir/cli.rb
-- lib/organisir/client.rb
-- lib/organisir/file_op.rb
+- lib/organisir/commands/clean_symlinks.rb
+- lib/organisir/commands/move_files.rb
+- lib/organisir/commands/multi_symlink_files.rb
+- lib/organisir/commands/symlink_files.rb
 - lib/organisir/rule.rb
 - lib/organisir/symlink_rule.rb
+- lib/organisir/util.rb
 - lib/organisir/validator.rb
 - lib/organisir/version.rb
 - organisir.gemspec

data/lib/organisir/client.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-module Organisir
-  class Client
-    def start(source_dir, dest_dir, pwd, commit)
-      @abs_source_dir = File.join(pwd, source_dir)
-      @abs_dest_dir = File.join(pwd, dest_dir)
-      Validator.validate_start(@abs_source_dir, @abs_dest_dir)
-
-      @verbose = !commit
-      @pwd = pwd
-      @file_op = FileOp.new(pwd, source_dir)
-      execute_start
-    end
-
-    def symlink(source_dir, pwd, commit)
-      @abs_source_dir = File.join(pwd, source_dir)
-      @verbose = !commit
-      @pwd = pwd
-      @file_op = FileOp.new(pwd, source_dir)
-
-      execute_symlink
-    end
-
-    private
-
-    def execute_start
-      sub_dirs = get_sub_dirs(@abs_dest_dir)
-      # print sub_dirs
-      print("Scanned #{sub_dirs.length} directories in #{@abs_dest_dir}\n")
-      src_files = get_src_files(@abs_source_dir)
-      print("Scanned #{src_files.length} files in #{@abs_source_dir}\n")
-
-      rule = Rule.new(sub_dirs)
-      src_files.each do |f|
-        match_dir = rule.match(f)
-        next if match_dir.nil?
-
-        move_file(f, match_dir)
-      end
-      print "Process completed\n"
-    end
-
-    def execute_symlink
-      sub_dirs = get_sub_dirs(@abs_source_dir)
-      files = Dir.glob(File.join(@abs_source_dir, "*", "*.*"))
-                 .reject { |f| File.directory?(f) || File.symlink?(f) || File.zero?(f) }
-      print("Scanned #{files.length} files inside #{sub_dirs.length} directories in #{@abs_dest_dir}\n")
-
-      rule = SymlinkRule.new(sub_dirs)
-      files.each do |f|
-        match_dirs = rule.match(f)
-        next if match_dirs.nil? || match_dirs.empty?
-
-        symlink_file(f, match_dirs)
-      end
-      print "Process completed\n"
-    end
-
-    def move_file(filename, dirname)
-      print "Rule matched file #{filename.to_s.colorize(:red)} moved to directory #{dirname.to_s.colorize(:red)}\n"
-      return if @verbose
-
-      @file_op.move(filename, @abs_source_dir, File.join(@abs_dest_dir, dirname))
-    end
-
-    def symlink_file(file, match_dirs)
-      print "Rule matched file #{file.to_s.colorize(:red)} symlinked to directories #{match_dirs.join(", ").to_s.colorize(:red)}\n"
-      return if @verbose
-
-      @file_op.symlink(file, match_dirs)
-    end
-
-    def get_sub_dirs(dir)
-      Dir.chdir(dir)
-      sub_dirs = Dir["*"].select { |o| File.directory?(o) }
-      Dir.chdir(@pwd)
-      sub_dirs
-    end
-
-    def get_src_files(dir)
-      Dir.entries(dir).reject { |f| File.directory? f }
-    end
-  end
-end

data/lib/organisir/file_op.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require "fileutils"
-
-module Organisir
-  class FileOp
-    def initialize(root_dir, source_dir)
-      @root_dir = root_dir
-      @source_dir = source_dir
-    end
-
-    def move(filename, source_path, destination_path)
-      src = File.join(source_path, filename)
-      dest = File.join(destination_path, filename)
-      FileUtils.move(src, dest, force: false, verbose: false)
-    end
-
-    def symlink(src_file, destination_dirs)
-      filename = File.basename(src_file)
-      destns = destination_dirs.map do |p|
-        File.join(@root_dir, @source_dir, p, filename)
-      end
-      destns.each do |d|
-        begin
-          FileUtils.ln_s(src_file,d , force: false, verbose: false)
-        rescue Errno::EEXIST
-          nil
-        end
-      end
-    end
-
-    def clean(link, path)
-      src = File.join(@root_dir, path, link)
-      # Last explicit check to see if the file indeed is a symlink
-      return unless File.symlink?(src)
-
-      FileUtils.remove(src)
-    end
-  end
-end