organisir 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0dadc67c7d01274914cd72e80465d626bd301156413aaab76e1a300d6c90441
-  data.tar.gz: d7f6c8029b92de538bbf3047a157f7baff018193a591ce7342a15ad89b6ecff5
+  metadata.gz: 6b5a8a59f69fe29c8aad7552739f29e6ad21605ea00a0eee59978a489cf4b46f
+  data.tar.gz: 55ad2e84a64eb396d6b2838528da475822c36f0fc7b4f01372d48394cffd6e51
 SHA512:
-  metadata.gz: dc07f03a7b247ad434d7212c295edaa9cb242288bd5cbae9951060a180618b08dbc752a2e814f88a75e38c8868be778fc9053a104cf03145a4eb90678f2f03c6
-  data.tar.gz: beb27b3f0db78af1cf7786da39d65c59f15998d0a7fda9f78e460c9e02f0d58865e00bfc0ec94e7d7758afe6ffd6405558b512a87c3ac5d9728dfeb24dc87d78
+  metadata.gz: 9f266331405326ed542974a62fb3ac7a6d6a4b2397351f55a265df52bff5ddb5a2675ce0e16d36266ac10bb71d8fafcad1c5e75a516f3d84761e0830e44a534b
+  data.tar.gz: f1c19c78a5d7ff7ca4d54f17a6ddbab0aa9b619109937203564ddd7abfaf120ae2b301f78ce8f37d40f89fd56f837ce5e6915d520d9726dea9cbc9db7620a449

data/.gitignore

@@ -6,4 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-/.idea
+/.idea
+organisir-*.gem

data/Gemfile.lock

@@ -1,23 +1,16 @@
 PATH
   remote: .
   specs:
-    organisir (0.1.0)
+    organisir (0.1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.1)
-    coderay (1.1.3)
     colorize (0.8.1)
-    method_source (1.0.0)
-    minitest (5.14.2)
-    optparse (0.1.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)
@@ -42,10 +35,7 @@ PLATFORMS
 
 DEPENDENCIES
   colorize (~> 0.8.1)
-  minitest (~> 5.0)
-  optparse (~> 0.1.0)
   organisir!
-  pry (~> 0.13.1)
   rake (~> 13.0)
   rubocop (~> 0.80)
   thor (~> 1.0)

data/README.md

@@ -1,32 +1,69 @@
 # Organisir
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/organisir`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A Ruby gem made to organise large number of files effectively using a simple set of predfined rules and checks based on filenames. Currently the rules are hardcoded based on my personal preferences although I am planning to implement a custom rule injection to allow others with working knowledge of ruby to write their own rules for file management.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Run this command to install organisir
 
-```ruby
-gem 'organisir'
+```{shell}
+gem install organisir
 ```
 
-And then execute:
+## Usage
 
-    $ bundle install
+In its current state, organisir supports two types of file organisation.
 
-Or install it yourself as:
+### 1. Moving files inside a source directory(S) to a destination directory(D)
 
-    $ gem install organisir
+Suppose your directory S has a lot of files and your D directory has multiple sub-directories with names d1, d2,...,dn. Each file inside S contains the word(s) d1..dn inside them. Organisir can scan each of these files in S and move them inside the subdirectories inside D. If a filename contains multiple combinations of d1..dn, the first match is selected for moving the file.
 
-## Usage
+#### Example
+
+Source directory is `~/Images`
+Destination directory is `~/Images/Organised`
+
+Your files inside `Images` directory contains the year in their file names eg. `IMG_01_JAN_2018.jpg` and your destination directory has multiple directories with year name eg. `~/Images/Organised/2017, ~/Images/Organised/2018, ~/Images/Organised/2019` and so on.
+
+To move all files inside the `Images` directory to the sub-directories inside `Images/Organised` directory, you can invoke the following command.
+
+```{shell}
+cd ~
+organisir start --source Images --destination Images/Organised
+```
+
+By default, organisir never modifies any files unless specified explicitly. Running the command will give you a full result of the files which matched the rule and the chosen directory for moving. You can review the output and if it looks good, pass an additional `--commit true` flag to the earlier command.
+
+```{shell}
+cd ~
+organisir start --source Images --destination Images/Organised --commit true
+```
 
-TODO: Write usage instructions here
+### 2. Creating references to a file in multiple directories inside a parent directory(P)
+
+This command is useful if you have files inside directory which may also required to be present in other directories based on their filenames. It usually extends on the first scenario.
+
+#### Example
+
+Parent directory is `~/Images/Organised`
+
+Your parent directory may contain multiple sub-directories with some names `d1,d2,..,dn` etc. If you have files in any of these sub-directory which may fulfill the filename rule matching criteria, the symlink command can create symlinks of the original files inside each sub-directory which matches the filename rule match.
+
+```{shell}
+cd ~
+organisir symlink --source Images/Organised
+```
+
+Again by default, organisir never modifies any files unless specified explicitly. Running the command will give you a full list of matches found. You can review the output and if it looks good, pass an additional `--commit true` flag to the earlier command.
+
+```{shell}
+cd ~
+organisir symlink --source Images/Organised --commit true
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
@@ -34,3 +71,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/organisir.
 
+## TODO
+
+- [ ] Provide support for users to write their own ruby code to allow custom matching rules.
+
+- [ ] Allow symlink command to work with a source and destination directory rather than a single source diirectory.

data/lib/organisir/cli.rb

@@ -8,25 +8,6 @@ module Organisir
       true
     end
 
-    COMMANDS = {
-      start: %w[
-        Move files from a source directory to a destination directory based on the filename of all files inside
-        the source directory. Only files present in the source directory will be scanned and moved. The destination
-        directory should ideally contain multiple directories where you would want your files to move.
-      ].join(" "),
-      organise: "Alias of start",
-      symlink: %w[
-        Scan all directories inside a directory and the files contained in each of them (upto one level). Each file
-        which matches multiple rules will have a symlink created in each directory where the rule was matched. The
-        original file will not be moved and new symlinks will refer to the original file path.
-      ].join(" "),
-      clean: %w[
-        Remove all dangling symlinks from a directory by scanning through all the directories inside the given
-        source directory
-      ].join(" "),
-      version: "Display installed tmuxinator version"
-    }.freeze
-
     desc "start 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
@@ -35,7 +16,7 @@ module Organisir
     def start
       if options[:commit]
         say "Preparing to move files in 5 seconds. Cancel the command by pressing Ctrl-C"
-        # sleep(5)
+        sleep(5)
       else
         say "Start command always runs in non-commit mode. Use --commit true to permanently move files.", :red
       end
@@ -45,7 +26,7 @@ module Organisir
       say "Exiting organisir...", :green
     end
 
-    desc "source", "Symlink files in nested directories to matching sub-directories within the given directory"
+    desc "symlink", "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

data/lib/organisir/client.rb

@@ -9,7 +9,7 @@ module Organisir
 
       @verbose = !commit
       @pwd = pwd
-      @file_op = FileOp.new(Dir.pwd)
+      @file_op = FileOp.new(pwd, source_dir)
       execute_start
     end
 
@@ -17,7 +17,7 @@ module Organisir
       @abs_source_dir = File.join(pwd, source_dir)
       @verbose = !commit
       @pwd = pwd
-      @file_op = FileOp.new(Dir.pwd)
+      @file_op = FileOp.new(pwd, source_dir)
 
       execute_symlink
     end
@@ -38,6 +38,7 @@ module Organisir
 
         move_file(f, match_dir)
       end
+      print "Process completed\n"
     end
 
     def execute_symlink
@@ -53,17 +54,18 @@ module Organisir
 
         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)} to be moved directory #{dirname.to_s.colorize(:red)}\n"
+      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)} to be symlinked to directories #{match_dirs.join(", ").to_s.colorize(:red)}\n"
+      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)

data/lib/organisir/file_op.rb

@@ -4,25 +4,28 @@ require "fileutils"
 
 module Organisir
   class FileOp
-    def initialize(root_dir)
+    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)
-      # print "mv#{false ? ' -f' : ''} #{[src,dest].flatten.join ' '}\n".colorize(:green)
       FileUtils.move(src, dest, force: false, verbose: false)
     end
 
     def symlink(src_file, destination_dirs)
-      filename = src_file.split("/").last
+      filename = File.basename(src_file)
       destns = destination_dirs.map do |p|
-        File.join(@root_dir, p, filename)
+        File.join(@root_dir, @source_dir, p, filename)
       end
-
       destns.each do |d|
-        FileUtils.symlink(src_file, d, force: false, verbose: true)
+        begin
+          FileUtils.ln_s(src_file,d , force: false, verbose: false)
+        rescue Errno::EEXIST
+          nil
+        end
       end
     end
 

data/lib/organisir/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: organisir
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - anujchandra