bombay 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6995fb52e822ad155c50c7929a7739b5ec7d33634adf40406f922d2a7c5986a2
-  data.tar.gz: d580dba8b3d38f32c47e7fec855292203d91cc2a15f2f18d2a25e3210f47530f
+  metadata.gz: 258caa2ba9f5deb75fd7be84e4084af50b6b2937d2fcd28fae7851f56289c9a3
+  data.tar.gz: 4231b016c7a18e0fef2a9e00532b36f04e57ef91e7786f84fc9a173198c2f230
 SHA512:
-  metadata.gz: bdcaa147d64877122dae7fb9b16260a6c54c5cc83ee65f31a8ff0acc66dbed17007c11aa2e6a54be94a44480362c89491aa1a8630a6b79ba2c59d99609d98210
-  data.tar.gz: 7703560c17159d3a2230f01f5f7afed389f528843e68450240b7a977045512fc2787bb58648e7824196c72f17d064cc54f3329a745992a3c858f8dabf2860c25
+  metadata.gz: 58a1ca1a28350a1f7158e39290372c59d686cbcf64d120594060ab22180eeec360b3bb5d4710553bd513c27053488fcdabd0e4c061ca519d99ef9f472f574e25
+  data.tar.gz: 154d7ae5209e966741e01e66f1899711e3976d101f2026a2b40cb65d21c333a726f8554990eef3bdca76b6837d28e9b443f4c9dcb76e6c06bd9d06de5dfd17ca

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2022 Aziz Ben Ali
+
+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

@@ -1,8 +1,16 @@
 # bombay
 
+[![Gem Version](https://badge.fury.io/rb/bombay.svg)](https://badge.fury.io/rb/bombay)
+
 `bombay` sorts the files in your working directory by filetype, and
 sends them to their appropriate `$XDG_*_DIR`.
 
+## Installation
+
+```
+gem install bombay
+```
+
 ## Usage
 
 Imagine you had this mess in your `~/Downloads`:
@@ -38,15 +46,11 @@ badger-sock.pdf kind-vulture.epub
 summer-dance.gif funny-dialect.mp4
 ```
 
-`bombay` will parse your `$XDG_CONFIG_HOME/user-dirs.dirs` to locate
-the directories inside of which the files will be organized. Because
-of this, it is limited to *Linux* for the moment.
-
-## Installation
+## Platform support
 
-```
-gem install bombay
-```
+`bombay` was initially built for Linux with support for XDG user
+directories, but has been extended to support macOS, although that remains to
+be tested. The program will not run on any other platforms.
 
 ## Copying
 

data/bin/bombay

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bombay"
+include Bombay
+
+# Parse and process user directories
+directories = Directories.new
+
+# Initialize filetypes
+filetypes = Filetypes.new
+
+# Group files by filetype
+pictures = filter_files(filetypes.pictures)
+videos = filter_files(filetypes.videos)
+documents = filter_files(filetypes.documents)
+
+# Stack files into their appropriate directory
+stack(pictures, directories.pictures)
+stack(videos, directories.videos)
+stack(documents, directories.documents)

data/lib/bombay/string.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Provides some helpful methods for strings
+class String
+  # Unquotes a string.
+  def unquote
+    tr('"', "")
+  end
+
+  # Expands $HOME.
+  def expand
+    gsub("$HOME", Dir.home)
+  end
+end

data/lib/bombay/version.rb

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

data/lib/bombay.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "bombay/version"
+require_relative "bombay/string"
+
 require "fileutils"
+require "os"
 
 # This module exposes the methods used to organize your $(pwd).
 module Bombay
@@ -19,7 +22,6 @@ module Bombay
     src_dir = FileUtils.pwd
 
     return if src_dir == dest_dir
-
     return if files.empty?
 
     FileUtils.mkdir(dest_dir) unless File.directory?(dest_dir)
@@ -36,26 +38,48 @@ class Directories
     ENV["XDG_CONFIG_HOME"] || File.join(Dir.home, ".config")
   end
 
-  def user_dirs
+  def xdg_directory_type(dir)
+    dir.delete_prefix("XDG_").delete_suffix("_DIR")
+  end
+
+  def user_dirs_file
     File.join(config_directory, "user-dirs.dirs")
   end
 
-  def parse_entry(line)
-    entry = line.split("=")
-    key = entry.first
-    value = entry.last.tr('"', "").gsub("$HOME", Dir.home).strip
-    [key, value]
+  def xdg_directories
+    dirs = {}
+    File.open(user_dirs_file).each do |line|
+      next if line.start_with?("#")
+      next if line.strip.empty?
+      
+      entry = line.split("=")
+      key = xdg_directory_type(entry.first)
+      value = entry.last.unquote.expand.strip
+      dirs.store(key, value)
+    end
+    dirs
+  end
+
+  def macos_directories
+    dirs = {}
+    dirs.store("DOCUMENTS", File.join(Dir.home, "Documents"))
+    dirs.store("PICTURES", File.join(Dir.home, "Pictures"))
+    dirs.store("VIDEOS", File.join(Dir.home, "Movies"))
+    dirs
   end
 
   def initialize
-    File.open(user_dirs).each do |line|
-      xdg_dir = parse_entry(line)
-      case xdg_dir.first
-      when "XDG_DOCUMENTS_DIR" then @documents = xdg_dir.last
-      when "XDG_PICTURES_DIR" then @pictures = xdg_dir.last
-      when "XDG_VIDEOS_DIR" then @videos = xdg_dir.last
-      end
-    end
+    dirs = if OS.linux?
+             xdg_directories
+           elsif OS.macos?
+             macos_directories
+           else
+             abort("Unsupported platform.")
+           end
+
+    @documents = dirs["DOCUMENTS"]
+    @pictures = dirs["PICTURES"]
+    @videos = dirs["VIDEOS"]
   end
 end
 

metadata

@@ -1,36 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: bombay
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - grtcdr
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2022-05-21 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
 description:
-email:
-- ba.tahaaziz@gmail.com
-executables: []
+email: ba.tahaaziz@gmail.com
+executables:
+- bombay
 extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
-- bombay.gemspec
+- bin/bombay
 - lib/bombay.rb
+- lib/bombay/string.rb
 - lib/bombay/version.rb
 - sig/bombay.rbs
-homepage: https://github.com/grtcdr/bombay
+homepage: https://rubygems.org/gems/bombay
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/grtcdr/bombay
+  homepage_uri: https://rubygems.org/gems/bombay
   source_code_uri: https://github.com/grtcdr/bombay
 post_install_message:
 rdoc_options: []
@@ -50,5 +66,5 @@ requirements: []
 rubygems_version: 3.3.8
 signing_key:
 specification_version: 4
-summary: Organize your $(pwd)
+summary: Organize your $(pwd).
 test_files: []

data/bombay.gemspec

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/bombay/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "bombay"
-  spec.version = Bombay::VERSION
-  spec.authors = ["grtcdr"]
-  spec.email = ["ba.tahaaziz@gmail.com"]
-
-  spec.summary = "Organize your $(pwd)"
-  spec.homepage = "https://github.com/grtcdr/bombay"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-
-  # 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(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-end