bombay 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7ae8397473ea1785d327c58f45bfd862f63a90940c1ad4de3c5b4efcf9fd86f
-  data.tar.gz: 482d01646e9e341d54e99600a893ab23bff68b6e1b60b8acc80163139b23303e
+  metadata.gz: f5dab1ffb202a5f13e7b80ef01279739f30c27ce1196182678cf0b462da3817a
+  data.tar.gz: e2edca01c328e65ad217dce1b146f74b06c1be38ec4a89eb5dd02a4f1720c3db
 SHA512:
-  metadata.gz: c7e4f03d73d1982f1540a924745c4c32a33b539a8b95222b501a16ccc86af6295cf675c8a12063b07565d40efa3e8abbd077c3cb56b6fd392ce33fcc2174ef90
-  data.tar.gz: 48b9e570acb8fdfeef930b4da57e647c6d856183a48a83ee065922295619e2d3acf80f3f3e9b08c5e31a64ee3d3eb821d4c472b4505f69a0f765400bd29b23fb
+  metadata.gz: e44c38362c6aeac3e4299cf31e9f6363ee1b4aaeb9e05b8f3d1b2887986e15a6e7f4578a2235300d0f4d0c43cbc6c55bc24033f52064b628d253288441c77138
+  data.tar.gz: b8c6675cd4e6913bd6b542d8817cce600c50d912834d94df95d942fa59eeaa79cf016f757d7aac1e43b93f17825ad16a0119e42ad05d537151c77edbdac9b00b

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

@@ -0,0 +1,57 @@
+# 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`:
+
+```bash
+$ ls -al ~/Downloads
+.
+..
+badger-sock.pdf
+parallel-muffin.png
+virtual-monkey.webp
+student-steak.svg
+kind-vulture.epub
+funny-dialect.mp4
+summer-dance.gif
+[redacted]
+```
+
+Let's tell `bombay` to clean it up:
+
+```bash
+~ $ cd Downloads
+
+~/Downloads $ bombay
+
+~ $ ls ~/Pictures
+parallel-muffin.png student-steak.svg virtual-monkey.webp
+
+~ $ ls ~/Documents
+badger-sock.pdf kind-vulture.epub
+
+~ $ ls ~/Videos
+summer-dance.gif funny-dialect.mp4
+```
+
+## Platform support
+
+`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
+
+This software is licensed under the MIT license.

data/bin/bombay

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bombay"
-
 include Bombay
 
 # Parse and process user directories

data/bombay.gemspec

@@ -5,8 +5,8 @@ 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.author = "grtcdr"
+  spec.email = "ba.tahaaziz@gmail.com"
 
   spec.summary = "Organize your $(pwd)."
   spec.homepage = "https://rubygems.org/gems/bombay"
@@ -16,12 +16,14 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/grtcdr/bombay"
 
+  spec.add_runtime_dependency 'os', '~> 0.9.6'
+  
   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 = "bin"
   spec.executables = ["bombay"]
   spec.require_paths = ["lib"]

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.2.0"
+  VERSION = "0.3.0"
 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,45 @@ 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|
+      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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bombay
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - grtcdr
@@ -9,10 +9,23 @@ autorequire:
 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
+email: ba.tahaaziz@gmail.com
 executables:
 - bombay
 extensions: []
@@ -21,10 +34,13 @@ files:
 - ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE
+- README.md
 - Rakefile
 - bin/bombay
 - bombay.gemspec
 - lib/bombay.rb
+- lib/bombay/string.rb
 - lib/bombay/version.rb
 - sig/bombay.rbs
 homepage: https://rubygems.org/gems/bombay