organisir 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0dadc67c7d01274914cd72e80465d626bd301156413aaab76e1a300d6c90441
+  data.tar.gz: d7f6c8029b92de538bbf3047a157f7baff018193a591ce7342a15ad89b6ecff5
+SHA512:
+  metadata.gz: dc07f03a7b247ad434d7212c295edaa9cb242288bd5cbae9951060a180618b08dbc752a2e814f88a75e38c8868be778fc9053a104cf03145a4eb90678f2f03c6
+  data.tar.gz: beb27b3f0db78af1cf7786da39d65c59f15998d0a7fda9f78e460c9e02f0d58865e00bfc0ec94e7d7758afe6ffd6405558b512a87c3ac5d9728dfeb24dc87d78

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6.5
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.0.rc.2
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in organisir.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 0.80"
+
+gem "thor", "~> 1.0"
+
+gem "colorize", "~> 0.8.1"

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    organisir (0.1.0)
+
+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)
+    rexml (3.2.4)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.2.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    thor (1.0.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+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)
+
+BUNDLED WITH
+   2.2.0.rc.2

data/README.md

@@ -0,0 +1,36 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'organisir'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install organisir
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/organisir.
+

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/organisir

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "thor"
+require "organisir"
+
+Organisir::Cli.start ARGV

data/lib/organisir.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "thor"
+require "colorize"
+
+
+module Organisir
+end
+
+# require "organisir/"
+require "organisir/cli"
+require "organisir/client"
+require "organisir/file_op"
+require "organisir/rule"
+require "organisir/symlink_rule"
+require "organisir/validator"
+require "organisir/version"

data/lib/organisir/cli.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module Organisir
+  class Cli < Thor
+    def self.exit_on_failure?
+      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
+    option :commit, type: :boolean, default: false
+
+    def start
+      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
+      end
+      pwd = Dir.pwd
+      Organisir::Client.new.start(options[:source], options[:destination], pwd, options[:commit])
+    rescue Interrupt
+      say "Exiting organisir...", :green
+    end
+
+    desc "source", "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)
+      else
+        say "Symlink command always runs in non-commit mode. Use --commit true to symlink files.", :red
+      end
+      pwd = Dir.pwd
+      Organisir::Client.new.symlink(options[:source], pwd, options[:commit])
+    rescue Interrupt
+      say "Exiting organisir...", :green
+    end
+  end
+end

data/lib/organisir/client.rb

@@ -0,0 +1,83 @@
+# 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(Dir.pwd)
+      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(Dir.pwd)
+
+      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
+    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
+    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"
+      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"
+      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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module Organisir
+  class FileOp
+    def initialize(root_dir)
+      @root_dir = root_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
+      destns = destination_dirs.map do |p|
+        File.join(@root_dir, p, filename)
+      end
+
+      destns.each do |d|
+        FileUtils.symlink(src_file, d, force: false, verbose: true)
+      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

data/lib/organisir/rule.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Organisir
+  class Rule
+    def initialize(dirs)
+      @dirs = dirs
+      @dir_map = {}
+      @dirs.map do |dir|
+        @dir_map[dir] = gen_regex_for_dir_name(dir)
+      end
+    end
+
+    def match(file)
+      resp = []
+      @dir_map.keys.each do |k|
+        resp << k if file.downcase.match(@dir_map[k])
+      end
+
+      resp.min unless resp.empty?
+    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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Organisir
+  class SymlinkRule
+    def initialize(dirs)
+      @dirs = dirs
+      @dir_map = {}
+      @dirs.map do |dir|
+        @dir_map[dir] = gen_regex_for_dir_name(dir)
+      end
+    end
+
+    def match(file)
+      resp = []
+      filename = file.split("/").last.downcase
+      file_dir = file.split("/").fetch(-2)
+      @dirs.each do |d|
+        next if file_dir.include? 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/validator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Organisir
+  class Validator
+    class << self
+      def validate_start(source_dir, dest_dir)
+        raise "#{source_dir} is not a valid directory path" unless File.directory?(source_dir)
+
+        raise "#{dest_dir} is not a valid directory path" unless File.directory?(dest_dir)
+      end
+    end
+  end
+end

data/lib/organisir/version.rb

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

data/organisir.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/organisir/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "organisir"
+  spec.version       = Organisir::VERSION
+  spec.authors       = ["anujchandra"]
+  spec.email         = ["anujc4@gmail.com"]
+
+  spec.summary       = "Gem to organise files based on their filename"
+  spec.description   = "Gem to organise files based on their filename"
+  spec.homepage      = "https://github.com/anujc4/organisir"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/anujc4/organisir"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  # spec.files = Dir["lib/**/*.rb"]
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: organisir
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- anujchandra
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-01 00:00:00.000000000 Z
+dependencies: []
+description: Gem to organise files based on their filename
+email:
+- anujc4@gmail.com
+executables:
+- organisir
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/setup
+- exe/organisir
+- lib/organisir.rb
+- lib/organisir/cli.rb
+- lib/organisir/client.rb
+- lib/organisir/file_op.rb
+- lib/organisir/rule.rb
+- lib/organisir/symlink_rule.rb
+- lib/organisir/validator.rb
+- lib/organisir/version.rb
+- organisir.gemspec
+homepage: https://github.com/anujc4/organisir
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/anujc4/organisir
+  source_code_uri: https://github.com/anujc4/organisir
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Gem to organise files based on their filename
+test_files: []