organize_files 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 887c429ab0830c0802a3132a6d5a649359ffde0d35fb424e252b148b44ae8544
+  data.tar.gz: 47b46adcfcbfc75df4ab50d2d15887c126945acfaa3795af86549a5217faba3a
+SHA512:
+  metadata.gz: e7f3aa76053ee5c09678d7a2fe1803a9dc1e35bb29e7a0395967977c4ba9b15d01b5e8c80452dad81191c4e1ff167feba42d9b6813a7ea770910ff329dea6bc9
+  data.tar.gz: 9df0579e39c59acdcca2d28fefdc6d0dfca7fffeee6227e0bd2fbe5b85c749af2bcd9cce02317844a908246ac561c15a4e328b6c7d686f04a7f96c85a17e48da

data/CONTRIBUTING.md

@@ -0,0 +1,78 @@
+Contributing Guidelines
+
+# Contributing Guidelines
+
+Thank you for considering contributing to the `file_organizer` gem! We welcome contributions of all kinds, from bug reports and feature requests to documentation improvements and code contributions. Please read the following guidelines to help us maintain a high standard for the project and to make the contribution process smooth for everyone involved.
+
+## How to Contribute
+
+### 1. Reporting Issues
+- Search the [issue tracker](https://github.com/mayankagnihotri7/file-organizer/issues) to check if the issue has already been reported.
+- If the issue hasn’t been reported, [open a new issue](https://github.com/mayankagnihotri7/file-organizer/issues/new).
+  - Provide a clear and descriptive title.
+  - Include steps to reproduce the issue, expected results, and actual results.
+  - Add screenshots or error messages if applicable.
+
+### 2. Suggesting Features
+- Before suggesting a new feature, check the [issue tracker](https://github.com/mayankagnihotri7/file-organizer/issues) to see if someone else has already suggested it.
+- If not, [open a new issue](https://github.com/mayankagnihotri7/file-organizer/issues/new) and describe the feature you’d like to see.
+  - Explain why the feature is useful.
+  - Provide details about how it might work.
+
+### 3. Contributing Code
+- Fork the repository and clone your fork locally.
+- Create a new branch for your changes: `git checkout -b feature/your-feature-name`.
+- Follow the [Code of Conduct](#code-of-conduct).
+- Make sure your code adheres to the project’s coding standards:
+  - Follow Ruby’s community guidelines and conventions.
+  - Use meaningful commit messages.
+- Run tests locally to ensure your changes don’t break existing functionality.
+- Open a pull request (PR) and provide a detailed description of your changes.
+
+### 4. Writing Documentation
+- Review the existing documentation to understand the style and structure.
+- Update relevant sections to reflect your changes.
+- If creating entirely new documentation, ensure it is concise and clear.
+
+### 5. Reviewing Pull Requests
+- Be respectful and constructive.
+- Provide actionable feedback.
+
+## Code Standards
+- Use 2 spaces for indentation.
+- Write descriptive method names.
+- Follow the principle of single responsibility for methods and classes.
+- Add comments for complex logic.
+- Write tests for new features or changes using RSpec.
+
+---
+
+# Code of Conduct
+
+## Our Pledge
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+- Using welcoming and inclusive language.
+- Being respectful of differing viewpoints and experiences.
+- Gracefully accepting constructive criticism.
+- Focusing on what is best for the community.
+- Showing empathy towards other community members.
+
+Examples of unacceptable behavior include:
+- The use of sexualized language or imagery and unwelcome sexual attention or advances.
+- Trolling, insulting/derogatory comments, and personal or political attacks.
+- Public or private harassment.
+- Publishing others’ private information, such as a physical or electronic address, without explicit permission.
+- Other conduct which could reasonably be considered inappropriate in a professional setting.
+
+## Our Responsibilities
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+## Enforcement
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
+
+## Attribution
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 File Organizer team, Mayank Agnihotri
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,17 @@
+# OrganizeFiles
+
+This gem provides `Organize Files` integration for Ruby and allows to organize files in your system into their respective folders.
+
+## Getting started
+
+- Install the gem
+`gem install organize_files`
+- Enter the directory you want to sort the files in.
+`organize_files '/path/to/file'`
+
+### Requirements
+
+This gem requires Ruby 3.0+.
+
+## Contributing
+Please see [CONTRIBUTING.md](CONTRIBUTING.md)

data/lib/organize_files/file_handler.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OrganizeFiles
+  # file_handler.rb
+  class FileHandler
+    def initialize(directory)
+      @directory = directory
+    end
+
+    def scan_files
+      Dir.entries(@directory).reject { |file| file.starts_with?('.') }
+    end
+
+    def move_file(file, category)
+      destination = File.join(@destination, category)
+
+      Dir.mkdir(destination) unless Dir.exist?(destination)
+      FileUtils.mv(file, destination)
+    end
+
+    def remove_empty_folders
+      Dir.entries(@directory).each do |file|
+        path = File.join(@directory, file)
+
+        Dir.rmdir(path) if Dir.empty?(path)
+      end
+    end
+  end
+end

data/lib/organize_files/file_sorter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OrganizeFiles
+  # file_sorter.rb
+  class FileOrder
+    TYPES = {
+      images: ['.jpg', '.jpeg', '.png', '.gif'],
+      documents: ['.pdf', '.docx', '.txt', '.md'],
+      audio: ['.mp3', '.wav', '.flac'],
+      videos: ['.mp4', '.mkv', '.avi'],
+      archives: ['.zip', '.tar', '.rar', '.gz']
+    }.freeze
+
+    def initialize(file)
+      @file = file
+    end
+
+    def categorize
+      file_ext = File.extname(file)
+      category = TYPES.find { |_key, exts| exts.include?(file_ext) }
+
+      case category
+      when :images then 'Pictures'
+      when :documents then 'Documents'
+      when :audio then 'Music'
+      when :videos then 'Videos'
+      else
+        'Archives'
+      end
+    end
+  end
+end

data/lib/organize_files/organizer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'file_handler'
+require_relative 'file_order'
+
+module OrganizeFiles
+  # organizer.rb
+  class Organizer
+    attr_reader :directory, :types, :new_folder, :new_path
+
+    def initialize(directory)
+      @directory = directory
+      @file_handler = FileHandler.new(directory)
+    end
+
+    def organize
+      @file_handler.scan_files.each do |file|
+        categorize_file = OrganizeFiles::FileOrder.new(file).categorize
+
+        @file_handler.move_file(file, categorize_file)
+      end
+    end
+  end
+end

data/lib/organize_files/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OrganizeFiles
+  VERSION = '1.0.0'
+end

data/lib/organize_files.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'organize_files/orgnizer'
+
+organizer = OrganizeFiles::Organizer.new(ARGV[0])
+organizer.organize

data/organize_files.gemspec

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/organize_files/version', __dir__)
+
+Gem::Specification.new do |s|
+  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.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 3.1.4'
+  s.extra_rdoc_files = ['README.md']
+  s.add_development_dependency 'rubocop', '~> 1.68'
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: organize_files
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mayank Agnihotri
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.68'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.68'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/organize_files.rb
+- lib/organize_files/file_handler.rb
+- lib/organize_files/file_sorter.rb
+- lib/organize_files/organizer.rb
+- lib/organize_files/version.rb
+- organize_files.gemspec
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Organize files into their own separate folders
+test_files: []