can_cli 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb5c053bbbf8102436ce4aec55efc7b86fac408956d1a9142de27a3f3957d75b
-  data.tar.gz: 42e1a620e7b4854ad79590ef6d157878181d3b7a6ef4c586ab77a8bd01cacbe7
+  metadata.gz: 802816b1df3e8c6731ea2bc7d8fd6cfcecc563e148e5036d9ae5cc7c39322225
+  data.tar.gz: 1d9edb9f93abdff569f55c4642fd20ac124b7375c64731545b22559bcd8efbf2
 SHA512:
-  metadata.gz: 52ae4ad60138789b13dd8fa2283efd453e778142589c081680279d9732009077186c0437c10bf6e61978c90a4967ada8fe355ae322b349658613e29403b0dcb5
-  data.tar.gz: af61bbee9f9b42d2537dd4b6dd446a50d751210dafbac26ecc7e97303f32e16dc75efa3d7dd9fa2c9084fa91ebb4417a4538d58530449685c6a524fb1390288d
+  metadata.gz: fe0f322150b2b80ab2625848e211df9e5b987f15daa07ea0edd5795d95d91fec004cbe96656311ea42e0fc6cb5ff4de2157be574a52ca5cf784bf510bfeac4b6
+  data.tar.gz: 4648ca8f4fe19bdda8c87492fb523d0168897803ad944703bdb72408c4ba6819c669b4803bed5000b5c2d2b380965c145b9c5cac364f23dfce50dfad9af5afe3

data/README.md

@@ -1,4 +1,5 @@
-# can
+<h1 style="text-align: center;">can</h1>
+-----------------------------
 
 A command line implementation of the [Freedesktop XDG trash
 specification](https://specifications.freedesktop.org/trash-spec/trashspec-latest.html).
@@ -6,42 +7,42 @@ specification](https://specifications.freedesktop.org/trash-spec/trashspec-lates
 Can seeks to follow the behavior of the GNOME Files
 (Nautilus) trash implementation.
 
-As of now, it is partially implemented. You can use Can on
-multiple files---it will create an info file for each and
-move each to the trash directory.
+## Installation
 
-# Usage
+Can is available as a
+[Gem](https://rubygems.org/gems/can_cli) and as an [AUR
+package](https://aur.archlinux.org/packages/can).
 
-**Does not cover all options**
+Install Gem:
+`gem install can`
 
-## Trash files
+Install on AUR:
+`paru -S can`
 
-`can foo.txt bar.txt`
+## Usage
+
+**Does not cover all options**
 
-## Trash directories and files
+**Trash files**
+`can foo.txt bar.txt`
 
+**Trash directories and files**
 `can -r foo.txt bar.d`
 
-## List files in trashcan
-
+**List files in trashcan**
 `can -l`
 
-## List files in trashcan that match a regex
-
+**List files in trashcan that match a regex**
 `can -l '^foo'`
 
-## View trashinfo of files
-
+**View trashinfo of files**
 `can -n foo.txt bar.d`
 
-## Untrash files
-
+**Untrash files**
 `can -u foo.txt bar.d`
 
-## Empty files from trashcan
-
+**Empty files from trashcan**
 `can -e foo.txt bar.d`
 
-## Empty entire trashcan
-
+**Empty entire trashcan**
 `can -e`

data/bin/can

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'can'
 
-Can::can
+Can.can

data/can.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/can/version'
 
 Gem::Specification.new do |s|
@@ -8,7 +10,24 @@ Gem::Specification.new do |s|
   s.description = 'A command-line trashcan interface implementing the FreeDesktop trash specification as a drop-in replacement for rm.'
   s.authors     = ['Sawyer Shepherd']
   s.email       = 'contact@sawyershepherd.org'
-  s.files       = `git ls-files -z`.split "\x0"
+  s.files       = [
+    'LICENSE',
+    'README.md',
+    'bin/can',
+    'can.gemspec',
+    'lib/can/argparse.rb',
+    'lib/can/version.rb',
+    'lib/can.rb',
+    'lib/empty.rb',
+    'lib/error.rb',
+    'lib/info.rb',
+    'lib/list.rb',
+    'lib/trash.rb',
+    'lib/trashinfo.rb',
+    'lib/untrash.rb'
+  ]
   s.homepage    = 'https://github.com/sawshep/can'
   s.license     = 'GPL-3.0'
+  s.required_ruby_version = '>= 3.0'
+  s.add_runtime_dependency 'highline', '~> 2.0'
 end

data/lib/can/argparse.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'optparse'
 require 'set'
 require 'can/version'
 
-$options = Set.new
 
 # This needs to be here because OptParse only looks
 # at `Version` and @version for the version number,
@@ -14,79 +15,79 @@ module Can
   USAGE = 'Usage: can [OPTION] [FILE]...'
 
   MODES = {
-    :list     => ['-l', '--list',
-                  'list files in the trash'],
-    :info     => ['-n', '--info',
-                  'see information about a trashed file'],
-    :untrash  => ['-u', '--untrash',
-                  'restore a trashed file'],
-    :empty    => ['-e', '--empty',
-                  'permanently remove a file from the trash;
+    list: ['-l', '--list',
+           'list files in the trash'],
+    info: ['-n', '--info',
+           'see information about a trashed file'],
+    untrash: ['-u', '--untrash',
+              'restore a trashed file'],
+    empty: ['-e', '--empty',
+            'permanently remove a file from the trash;
                   use with no arguments to empty entire
-                  trashcan'],
-  }
+                  trashcan']
+  }.freeze
 
   OPTIONS = {
-    :force =>     ['-f', '--force',
-                'ignore nonexistent files and arguments,
+    force: ['-f', '--force',
+            'ignore nonexistent files and arguments,
                 never prompt'],
-    :prompt =>    ['-i', nil, 'prompt before every trashing'],
-    :recursive => ['-r', '--recursive',
-                   'trash directories and their contents
+    prompt: ['-i', nil, 'prompt before every trashing'],
+    recursive: ['-r', '--recursive',
+                'trash directories and their contents
                    recursively']
-  }
+  }.freeze
 
-  ALL_FLAGS = MODES.merge(OPTIONS)
+  ALL_FLAGS = MODES.merge(OPTIONS).freeze
 
   module ArgParse
     Version = VERSION
     def self.init_args
+      options = Set.new
+
       OptionParser.new do |opts|
         opts.banner = USAGE
 
-        ALL_FLAGS.each do |mode,v|
-          opts.on(short_opt(mode), long_opt(mode), help_string(mode)) do |opt|
-            $options << mode
+        ALL_FLAGS.each do |mode, _v|
+          opts.on(short_opt(mode), long_opt(mode), help_string(mode)) do |_opt|
+            options << mode
           end
         end
       end.parse!
 
-      if ArgParse.incompatible_opts?
-        Error.fatal "Too many mode arguments"
-      end
+      Error.fatal 'Too many mode arguments' if ArgParse.incompatible_opts?(options)
+
+      options
     end
 
-    # Sees if $options has incompatible items
-    def self.incompatible_opts?
+    # Sees if options has incompatible items
+    def self.incompatible_opts?(options)
       modes = MODES.keys
-      ($options & modes).length > 1
+      (options & modes).length > 1
     end
 
-    def self.get_mode
-      ($options & MODES.keys).first || :trash
+    def self.mode(options)
+      (options & MODES.keys).first || :trash
     end
 
-    def self.short_opt (mode)
+    def self.short_opt(mode)
       ALL_FLAGS[mode][0]
     end
 
-    def self.long_opt (mode)
+    def self.long_opt(mode)
       ALL_FLAGS[mode][1]
     end
 
     # Returns a mode's help string
-    def self.help_string (mode)
+    def self.help_string(mode)
       ALL_FLAGS[mode][2]
     end
 
     # Returns an options's corresponding mode, if it is valid
-    def self.valid_opt? (opt)
-      result = MODES.find { |k,v|
+    def self.valid_opt?(opt)
+      result = MODES.find do |_k, v|
         v[0..2].include? opt
-      }
-      if result
-        result.first
       end
+      result&.first
     end
   end
 end

data/lib/can/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Can
-  VERSION = '0.1.1'
+  VERSION = '0.1.4'
 end

data/lib/can.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 
 require 'can/argparse'
@@ -18,22 +20,20 @@ module Can
   HOME_TRASH_INFO_DIRECTORY = File.join(HOME_TRASH_DIRECTORY, 'info')
   HOME_TRASH_FILES_DIRECTORY = File.join(HOME_TRASH_DIRECTORY, 'files')
 
-  def self.init_dirs()
+  def self.init_dirs
     FileUtils.mkpath HOME_TRASH_FILES_DIRECTORY
     FileUtils.mkpath HOME_TRASH_INFO_DIRECTORY
   end
 
   def self.can
-    ArgParse.init_args
+    @options = ArgParse.init_args
 
-    mode = ArgParse.get_mode
+    mode = ArgParse.mode @options
 
-    self.init_dirs
+    init_dirs
 
-    self.send mode
+    send mode
 
-    if $options.include? :force
-      $exit = EXIT_SUCCESS
-    end
+    $exit = EXIT_SUCCESS if @options.include?(:force)
   end
 end

data/lib/empty.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 module Can
   def self.empty
     # Remove everything in the files and info directory
-    if ARGV.length == 0
+    if ARGV.empty?
       FileUtils.rm_r Dir.glob("#{HOME_TRASH_INFO_DIRECTORY}/*"), secure: true
       FileUtils.rm_r Dir.glob("#{HOME_TRASH_FILES_DIRECTORY}/*"), secure: true
     else
-      ARGV.map { |filename|
-        trashinfo_filename = filename + '.trashinfo'
+      ARGV.each do |filename|
+        trashinfo_filename = "#{filename}.trashinfo"
 
         file_path = File.join(HOME_TRASH_FILES_DIRECTORY, filename)
         trashinfo_file_path = File.join(HOME_TRASH_INFO_DIRECTORY, trashinfo_filename)
 
         FileUtils.remove_entry_secure file_path
         FileUtils.remove_entry_secure trashinfo_file_path
-      }
+      end
     end
   end
 end

data/lib/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 EXIT_SUCCESS = 0
 EXIT_FAILURE = 1
 
@@ -8,14 +10,14 @@ at_exit do
 end
 
 module Error
-  def self.nonfatal (message)
-    STDERR.puts('can: ' + message)
+  def self.nonfatal(message)
+    warn "can: #{message}"
     $exit = EXIT_FAILURE
   end
 
   # Exits without callbacks to at_exit
-  def self.fatal (message)
-    STDERR.puts('can: ' + message)
+  def self.fatal(message)
+    warn "can: #{message}"
     exit!(EXIT_FAILURE)
   end
 end

data/lib/info.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Can
   # TODO: Parse the .trashinfo files to make them more human
   # readable. Also, display the filename above the information
@@ -5,19 +7,19 @@ module Can
   def self.info
     # Fails with a fatal error even with --force, intended
     # behavior.
-    if ARGV.length == 0
+    if ARGV.empty?
       Error.fatal 'missing operand'
     else
-      ARGV.each_with_index { |file, i|
-        trashinfo_filename = file + '.trashinfo'
+      ARGV.each_with_index do |file, i|
+        trashinfo_filename = "#{file}.trashinfo"
         trashinfo_path = File.join(HOME_TRASH_INFO_DIRECTORY, trashinfo_filename)
 
-        if not File.exist? trashinfo_path
+        unless File.exist? trashinfo_path
           Error.nonfatal "no such file in trashcan: '#{file}'"
           next
         end
 
-        trashinfo = Trashinfo.parse(File.read trashinfo_path)
+        trashinfo = Trashinfo.parse(File.read(trashinfo_path))
 
         # TODO: Checking if i is not zero every single
         # iteration is a little inefficient. Maybe there is a
@@ -28,7 +30,7 @@ module Can
           Path: #{trashinfo[:path]}
           Deletion Date: #{trashinfo[:deletion_date]}
         INFO
-      }
+      end
     end
   end
 end

data/lib/list.rb

@@ -1,21 +1,23 @@
+# frozen_string_literal: true
+
 module Can
   def self.list
     # Given no args, show every trashed file
-    if ARGV.length == 0
+    if ARGV.empty?
       puts Dir.children(HOME_TRASH_FILES_DIRECTORY)
 
     # Given a regex pattern as an arg, print trashed files
     # that fit
     elsif ARGV.length == 1
       regex = Regexp.new(ARGV[0])
-      puts Dir.children(HOME_TRASH_FILES_DIRECTORY).select { |file|
-        regex =~ file
-      }
+      puts(
+        Dir.children(HOME_TRASH_FILES_DIRECTORY).select do |file|
+          regex =~ file
+        end
+      )
 
     else
-      raise StandardError.new(
-        "can: mode --list expects 0 to 1 arguments, given #{ARGV.length}"
-      )
+      raise StandardError, "can: mode --list expects 0 to 1 arguments, given #{ARGV.length}"
     end
   end
 end

data/lib/trash.rb

@@ -1,18 +1,19 @@
+# frozen_string_literaL: true
+
 require 'highline'
 
 # Returns filename with all trailing extensions removed
 def strip_extensions(filename)
   ext = File.extname filename
-  if ext.empty?
-    return filename
-  end
+  return filename if ext.empty?
+
   strip_extensions(File.basename(filename, ext))
 end
 
 # Returns all extensions of a filename
 def gather_extensions(filename)
   exts = ''
-  while not File.extname(filename).empty?
+  until File.extname(filename).empty?
     ext = File.extname(filename)
     exts = ext + exts
     filename = File.basename(filename, ext)
@@ -22,41 +23,30 @@ end
 
 module Can
   def self.trash
-    if ARGV.length == 0 and not $options.include? :force
-        Error.fatal 'missing operand'
-    end
+    Error.fatal 'missing operand' if ARGV.empty? && !@options.include?(:force)
 
     ARGV.each do |path|
-
       # TODO: If both `-f` and `-i` are used, can should
       # prompt if `-i` is used last. If `-f` is used last,
       # can should not prompt trashings. This follows the
       # behavior of rm.
-      if not File.exist?(path)
-        if not $options.include? :force
-          Error.nonfatal "cannot trash '#{path}': No such file or directory"
-        end
+      unless File.exist?(path)
+        Error.nonfatal "cannot trash '#{path}': No such file or directory" unless @options.include? :force
         next
       end
 
       # If --recursive is not used and a directory is given as an
       # argument, a non-zero error code should be returned
       # regardless if --force is used.
-      if File.directory? path and not File.symlink? path
-        if not $options.include? :recursive
-          Error.nonfatal "cannot remove '#{path}': Is a directory"
-        end
+      if File.directory?(path) && !File.symlink?(path)
+        Error.nonfatal "cannot remove '#{path}': Is a directory" unless @options.include? :recursive
         next
       end
 
       # TODO: Highline.agree prints to stdout, when it should
       # print to stderr. It also uses `puts`, while this use
       # case should use `print`.
-      if $options.include? :prompt
-        unless HighLine.agree "can: remove file '#{path}'?"
-          next
-        end
-      end
+      next if @options.include?(:prompt) && !(HighLine.agree "can: remove file '#{path}'?")
 
       filename = File.basename path
 
@@ -75,12 +65,12 @@ module Can
       i = 0
       while existing_trash_files.include?(filename)
         i += 1
-        filename = basename + ".#{i}" + exts
+        filename = "#{basename}.#{i}#{exts}"
       end
 
       FileUtils.mv(path, File.join(HOME_TRASH_FILES_DIRECTORY, filename))
 
-      trashinfo_filename = filename + '.trashinfo'
+      trashinfo_filename = "#{filename}.trashinfo"
       trashinfo_out_path = File.join(HOME_TRASH_INFO_DIRECTORY, trashinfo_filename)
       File.new(trashinfo_out_path, 'w').syswrite(trashinfo_string)
     end

data/lib/trashinfo.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 require 'cgi'
 
 module Trashinfo
-  def self.new (path)
-    trashinfo_string = <<~DESKTOP
+  def self.new(path)
+    <<~DESKTOP
       [Trash Info]
-      Path=#{CGI.escape(File.expand_path path)}
+      Path=#{CGI.escape(File.expand_path(path))}
       DeletionDate=#{Time.now.strftime('%Y-%m-%dT%H:%M:%S')}
     DESKTOP
   end
 
-  def self.parse (trashinfo)
+  def self.parse(trashinfo)
     regex = /\A\[Trash Info\]\nPath=(?<path>\S+)\nDeletionDate=(?<deletion_date>\S+)/m
 
     matches = regex.match trashinfo
 
-    parts = {
-      :path => CGI.unescape(matches[:path]),
-      :deletion_date => matches[:deletion_date]
+    {
+      path: CGI.unescape(matches[:path]),
+      deletion_date: matches[:deletion_date]
     }
   end
 end

data/lib/untrash.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 module Can
   def self.untrash
     ARGV.each do |filename|
       file_path = File.join(HOME_TRASH_FILES_DIRECTORY, filename)
 
-      if not File.exist? file_path
-          if not $options.include? :force
-            Error.nonfatal "cannot untrash '#{filename}': No such file or directory in trash"
-          end
+      unless File.exist? file_path
+        unless @options.include? :force
+          Error.nonfatal "cannot untrash '#{filename}': No such file or directory in trash"
+        end
         next
       end
 
-      trashinfo_filename = filename + '.trashinfo'
+      trashinfo_filename = "#{filename}.trashinfo"
       trashinfo_path = File.join(HOME_TRASH_INFO_DIRECTORY, trashinfo_filename)
-      trashinfo = Trashinfo.parse(File.read trashinfo_path)
+      trashinfo = Trashinfo.parse(File.read(trashinfo_path))
 
       original_path = trashinfo[:path]
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: can_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Sawyer Shepherd
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-11 00:00:00.000000000 Z
-dependencies: []
+date: 2022-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: A command-line trashcan interface implementing the FreeDesktop trash
   specification as a drop-in replacement for rm.
 email: contact@sawyershepherd.org
@@ -18,8 +32,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
 - LICENSE
 - README.md
 - bin/can
@@ -38,7 +50,7 @@ homepage: https://github.com/sawshep/can
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -46,15 +58,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.8
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: Command-line trash manager
 test_files: []

data/.gitignore

@@ -1,56 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-# Ignore Byebug command history file.
-.byebug_history
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'highline'