organize_files 1.0.8 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9008f41b4a6121547ffd984547a2e350bed7eb7e2ae04b1c5edf52b8ba8d2b41
-  data.tar.gz: f84214ec8cee553ef23ec51e9c5f14209133ddbf2f3b5d6c60c077d14604dab4
+  metadata.gz: 423b385e662072ba24906140c76d00b8ee2bf1c782b84e1eb54fcb3971049017
+  data.tar.gz: d64f1c10aa79af48758da287679721a644a46804e94a14ad783fc59d4a916c41
 SHA512:
-  metadata.gz: 226557a4787f761c5cf1f3ea9647df83ad1f80d9dd2c4dc1b4a84f1eb1da82548df0fce853e58ab460c5c68633bf1ba79e61c24d2c2ebac83fa9fa1d0593c3a8
-  data.tar.gz: 9e4ee7a8529da9cd70a3e09903f678560142f926b6c21c18448c7107bd425123d3b57d1a10d7a3e383cbc86c1d945653160e0caf97041900eb4336b927198fe8
+  metadata.gz: 6de2a007e0c69634c8e348bd5ecd40fc59710037e8636e7113973e9475b65b29a1abcc0db7c0bcb61c284b3badb623b9f79ce741eccdcee644a6add4f4c1da9a
+  data.tar.gz: 56c40d0c6f0d304b26e7c99ab26b5b2e9a3f74cfdd4ad260f6ed56eda634bbf5e66de3eb6cdd7d0ce9304462c0454cd54aad76f0a07ac94593c7cecc8b811870

data/Gemfile

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
-source 'http://rubygems.org'
+source "http://rubygems.org"
 
 gemspec
+
+gem "pry", "~> 0.14.2"

data/README.md

@@ -1,17 +1,79 @@
 # OrganizeFiles
 
-This gem provides `Organize Files` integration for Ruby and allows to organize files in your system into their respective folders.
+Decluttering your file system doesn’t have to be a hassle anymore. Moving files into their appropriate folders can be tedious and time-consuming—especially when done manually.
+
+The Organize Files gem for Ruby streamlines this process by automatically organizing files based on their extensions. Simply point it to a directory, and it will sort the files into their respective folders. If a folder for a specific file extension doesn't already exist, it will be created for you.
 
 ## Getting started
 
-- Install the gem
-`gem install organize_files`
-- Enter the directory you want to sort the files in.
-`organize_files '/path/to/file'`
+Install the gem
+```bash
+gem install organize_files
+```
+
+## Usage
+
+Enter the directory you want to sort the files in.
+
+```bash
+organize_files [options] <directory>
+```
+- <directory> The directory you want to organize
+
+Example:
+```bash
+organize_files '/path/to/downloads'
+```
+
+Output:
+```bash
+Successfully moved index2.pdf to /path/to/downloads/Documents/index2.pdf
+```
+
+Options:
+- `-c`, `--config`, CONFIG_FILE: Specify the configuration file to use.
+
+- If not provided, the script will look for `~/.organize_config.yml` in your home directory.
+- If ~/.organize_config.yml is not found, it will use the built-in default configuration.
+- `-h`, `--help`, Prints this help message.
+
+
+## Configuration
+You can customize how files are categorized by creating a YAML configuration file.
+
+Default Configuration File:
+
+The script will automatically look for a configuration file named ~/.organize_config.yml in your home directory.
+
+Example ~/.organize_config.yml:
+
+```YAML
+images:
+  - .jpg
+  - .jpeg
+  - .png
+documents:
+  - .pdf
+  - .docx
+  - .txt
+audio:
+  - .mp3
+  - .wav
+videos:
+  - .mp4
+  - .mov
+archives:
+  - .zip
+  - .rar
+programming:
+  - .rb
+  - .py
+  - .js
+```
 
 ### Requirements
 
 This gem requires Ruby 3.0+.
 
 ## Contributing
-Please see [CONTRIBUTING.md](CONTRIBUTING.md)
+Please see [CONTRIBUTING.md](CONTRIBUTING.md)

data/exe/organize_files

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require_relative "../lib/organize_files"
+require "optparse"
+
+options = {}
+options[:directory] = ARGV[0]
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: organize_files [options]"
+
+  opts.on("-i", "--ignore-empty-directories", "Ignore Empty Directories") do
+    options[:ignore_empty_directory] = true
+  end
+
+  opts.on("-c", "--config CONFIG_FILE", "Specify config file (default: .organize_config.yml)") do |config|
+    options[:config] = config
+  end
+
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end.parse!
+
+if options[:directory].nil?
+  puts "You must specify a directory to organize"
+  exit 1
+end
+
+sorter = OrganizeFiles::Organizer.new(options)
+sorter.organize
+
+puts "Files in '#{options[:directory]}' have been organized"

data/lib/organize_files/file_handler.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require 'fileutils'
+require "fileutils"
 
 module OrganizeFiles
-  # file_handler.rb
   class FileHandler
     def initialize(directory)
       @directory = directory

data/lib/organize_files/file_order.rb

@@ -1,35 +1,40 @@
 # frozen_string_literal: true
 
 module OrganizeFiles
-  # file_sorter.rb
   class FileOrder
-    TYPES = {
-      images: ['.jpg', '.jpeg', '.png', '.gif', '.avif'],
-      documents: ['.pdf', '.docx', '.txt', '.md', '.json', '.csv', '.xls', '.xlsx', '.ppt', '.pptx'],
-      audio: ['.mp3', '.wav', '.flac'],
-      videos: ['.mp4', '.mkv', '.avi'],
-      archives: ['.zip', '.tar', '.rar', '.gz', '.7z', '.iso'],
-      apks: ['.apk']
-    }.freeze
-
-    def initialize(file)
+    def initialize(file, config_file = nil)
       @file = file
+      @config_file = config_file || "~/.organize_config.yml"
+      @types = load_config
     end
 
     def categorize
       file_ext = File.extname(@file)
-      category = TYPES.find { |_key, exts| exts.include?(file_ext) }
-      return 'Archives' unless category
+      category = @types.find { |_key, exts| exts.include?(file_ext) }
+      return "Miscellaneous" unless category
+
+      category[0].to_s.capitalize
+    end
 
-      case category[0]
-      when :images then 'Pictures'
-      when :documents then 'Documents'
-      when :audio then 'Music'
-      when :videos then 'Videos'
-      when :apks then 'Apks'
+    private
+
+    def load_config
+      if File.exist?(@config_file)
+        YAML.load_file(@config_file)
       else
-        'Archives'
+        default_config
       end
     end
+
+    def default_config
+      {
+        pictures: [".jpg", ".jpeg", ".png", ".gif", ".avif"],
+        documents: [".pdf", ".docx", ".txt", ".md", ".json", ".csv", ".xls", ".xlsx", ".ppt", ".pptx"],
+        music: [".mp3", ".wav", ".flac"],
+        videos: [".mp4", ".mkv", ".avi"],
+        archives: [".zip", ".tar", ".rar", ".gz", ".7z", ".iso"],
+        apks: [".apk"]
+      }
+    end
   end
 end

data/lib/organize_files/organizer.rb

@@ -1,36 +1,32 @@
 # frozen_string_literal: true
 
-require_relative 'file_handler'
-require_relative 'file_order'
-
 module OrganizeFiles
-  # organizer.rb
   class Organizer
-    attr_reader :directory
-
-    def initialize(directory)
-      @directory = directory
-      @file_handler = FileHandler.new(directory)
+    def initialize(options)
+      @directory = options[:directory]
+      @config = options[:config]
+      @file_handler = FileHandler.new(@directory)
+      @ignore_empty_directory = options[:ignore_empty_directory]
     end
 
     def organize
       @file_handler.scan_files.each do |file|
         next if file_directory?(file)
 
-        categorize_file = OrganizeFiles::FileOrder.new(file).categorize
+        categorize_file = FileOrder.new(file, @config).categorize
         @file_handler.move_file(file, categorize_file)
-        @file_handler.remove_empty_folders
       end
+      @file_handler.remove_empty_folders unless @ignore_empty_directory
     end
 
     private
 
     def file_directory?(file)
-      directory = []
+      directories = []
       expanded_file_path = File.expand_path(file, @directory)
-      File.directory?(expanded_file_path) && directory << expanded_file_path
+      File.directory?(expanded_file_path) && directories << expanded_file_path
 
-      !directory.empty?
+      !directories.empty?
     end
   end
 end

data/lib/organize_files/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OrganizeFiles
-  VERSION = '1.0.8'
+  VERSION = "1.1.1"
 end

data/lib/organize_files.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
-require 'organize_files/organizer'
+require "zeitwerk"
+require "yaml"
 
-organizer = OrganizeFiles::Organizer.new(ARGV[0])
-organizer.organize
+module OrganizeFiles
+  @loader = Zeitwerk::Loader.for_gem
+  @loader.setup
+end

data/organize_files.gemspec

@@ -1,22 +1,28 @@
 # frozen_string_literal: true
 
-require File.expand_path('lib/organize_files/version', __dir__)
+require File.expand_path("lib/organize_files/version", __dir__)
 
 Gem::Specification.new do |s|
-  s.name = 'organize_files'
-  s.authors = ['Mayank Agnihotri']
+  s.name = "organize_files"
+  s.authors = ["Mayank Agnihotri"]
   s.version = OrganizeFiles::VERSION
-  s.files = Dir['README.md', 'LICENSE', 'CHANGELOG.md', 'lib/**/*.rb', 'lib/**/*.rake', 'organize_files.gemspec',
-                '.github/*.md', 'Gemfile', 'Rakefile', 'CONTRIBUTING.md']
-  s.licenses = ['MIT']
-  s.summary = 'Organize files into their own separate folders'
+  s.files = Dir["README.md", "LICENSE", "CHANGELOG.md", "lib/**/*.rb", "lib/**/*.rake", "organize_files.gemspec",
+                ".github/*.md", "Gemfile", "Rakefile", "CONTRIBUTING.md", "exe/*"]
+  s.licenses = ["MIT"]
+  s.summary = "Organize files into their own separate folders"
   s.platform = Gem::Platform::RUBY
-  s.required_ruby_version = '>= 3.1.4'
-  s.extra_rdoc_files = ['README.md']
-  s.add_development_dependency 'rubocop', '~> 1.68'
-  s.executables = ['organize_files']
-  s.homepage = 'https://github.com/mayankagnihotri7/file-organizer'
+  s.required_ruby_version = ">= 3.1.4"
+  s.extra_rdoc_files = ["README.md"]
+  s.add_dependency "zeitwerk", "~> 2.4"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rubocop", "~> 1.68"
+
+  s.bindir = "exe"
+  s.executables = s.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  s.homepage = "https://github.com/mayankagnihotri7/file-organizer"
+
   s.metadata = {
-    'source_code_uri' => 'https://github.com/mayankagnihotri7/file-organizer'
+    "source_code_uri" => "https://github.com/mayankagnihotri7/file-organizer"
   }
 end

metadata

@@ -1,15 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: organize_files
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.1.1
 platform: ruby
 authors:
 - Mayank Agnihotri
-autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2024-12-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -24,8 +51,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.68'
-description:
-email:
 executables:
 - organize_files
 extensions: []
@@ -36,7 +61,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
-- bin/organize_files
+- exe/organize_files
 - lib/organize_files.rb
 - lib/organize_files/file_handler.rb
 - lib/organize_files/file_order.rb
@@ -48,7 +73,6 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/mayankagnihotri7/file-organizer
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -63,8 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Organize files into their own separate folders
 test_files: []

data/bin/organize_files

@@ -1,28 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'optparse'
-require 'organize_files'
-
-options = {}
-OptionParser.new do |opts|
-  opts.banner = 'Usage: organize_files [options]'
-
-  opts.on('-d', '--directory DIRECTORY', 'Directory to organize') do |directory|
-    options[:directory] = directory
-  end
-
-  opts.on('-h', '--help', 'Prints this help') do
-    puts opts
-    exit
-  end
-end.parse!
-
-if options[:directory].nil?
-  puts 'You must specify a directory to organize'
-  exit 1
-end
-
-sorter = OrganizeFiles::Organizer.new(options[:directory])
-sorter.organize
-
-puts "Files in '#{options[:directory]}' have been organized"