atk_toolbox 0.0.45 → 0.0.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99c34226e0e1d77b1616de7e5e16cce6a8496eb47fda2020fa76ee2597c62498
-  data.tar.gz: b0725578fae82ad3df7139e6a7fc546a664ab423aff7ec561d34e4dcb0628c04
+  metadata.gz: b3b9bd3949490ee39a6afe827c568f40b9e9c152f530269ffe17e80e797bc8e4
+  data.tar.gz: 6a7ca257444314078b134db311eb33e1b397eb75538e9b0c098dabe0a0e02651
 SHA512:
-  metadata.gz: 1b2096e55bdc352c77064a619ea7ae813bda4d2afd49b022e32c2ebe1cfdcc71e6695ba28504f9f7b7517798f27401b050c2580a6fc8e44c82504cae79d4cb15
-  data.tar.gz: bf3a9017e56c9ff1b06698c2254162666a9b12533834e37fce980797eabb63b5906dcbbd7f06e87c076cccfbc01b8a49b2d24b8930370a0498db363ffff2da04
+  metadata.gz: 590cd15964c6322f6501fc4032fd914cddee9ca1eb45b75d3d44eaa9929b8435c9a2f2a5dce495175bc4c59d0be49fa8bed1f7a7da930345655820896e891203
+  data.tar.gz: 034a4883a6274a8f0d1dd1273d0d595601310bc5762688dafacde4f5958a42d9471ad932fc92fcc426b6bf15a8a3c3d238e8b47d1de8058d6393aec83b93fecc

data/lib/atk/atk_info.rb

@@ -36,9 +36,8 @@ module ATK
     def self.temp_path(filepath)
         new_path = ATK.paths[:temp]/filepath
         # make sure the path is empty
-        begin
-            File.delete(new_path)
-        end
+        FS.write("", to: new_path)
+        FS.delete(new_path)
         return new_path
     end
     
@@ -46,8 +45,8 @@ module ATK
         settings_path = ATK.paths[:info]
         atk_settings_key = "atk_settings"
         # if it doesn't exist then create it
-        if not File.exist?(settings_path)
-            IO.write(settings_path, "#{atk_settings_key}: {}")
+        if not FS.exist?(settings_path)
+            FS.write("#{atk_settings_key}: {}", to: settings_path)
             return {}
         else
             data = YAML.load_file(settings_path)

data/lib/atk/extra_file_utils.rb

@@ -1,6 +1,7 @@
 require 'etc'
 require 'fileutils'
-require 'set'
+require 'pathname'
+require 'open-uri'
 require_relative './os'
 
 if OS.is?("unix")
@@ -10,6 +11,8 @@ else # windows
 end
 
 class String
+    # this is for easy creation of cross-platform filepaths
+    # ex: "foldername"/"filename"
     def /(next_string)
         if OS.is?("windows")
             self + "\\" + next_string
@@ -17,9 +20,67 @@ class String
             File.join(self, next_string)
         end
     end
+    
+    # this is for having docstrings that get their indent removed
+    # this is used frequently for multi-line strings and error messages
+    # example usage 
+    # puts <<-HEREDOC.remove_indent
+    # This command does such and such.
+    #     this part is extra indented
+    # HEREDOC
+    def remove_indent
+        gsub(/^[ \t]{#{self.match(/^[ \t]*/)[0].length}}/, '')
+    end
 end
 
 class FileSys
+    # This is a combination of the FileUtils, File, Pathname, IO, Etc, and Dir classes,
+    # along with some other helpful methods
+    # It is by-default forceful (dangerous/overwriting)
+    # it is made to get things done in a no-nonsense error-free way and to have every pratical tool in one place
+
+    # TODO
+        # change_owner
+        # set_permissions
+        # relative_path_between
+        # relative_path_to
+        # add a force: true option to most of the commands
+    
+    def self.write(data, to:nil)
+        # make sure the containing folder exists
+        FileSys.makedirs(File.dirname(to))
+        # actually download the file
+        IO.write(to, data)
+    end
+    
+    def self.read(filepath)
+        begin
+            return IO.read(filepath)
+        rescue Errno::ENOENT => exception
+            return nil
+        end
+    end
+    
+    def self.delete(path)
+        if File.file?(path)
+            File.delete(path)
+        elsif File.directory?(path)
+            FileUtils.rm_rf(path)
+        end
+    end
+    
+    def username
+        if OS.is?(:windows)
+            return File.basename(ENV["userprofile"])
+        else
+            return Etc.getlogin
+        end
+    end
+    
+    def self.makedirs(path)
+        FileUtils.makedirs(path)
+    end
+    
     def self.in_dir(path_to_somewhere)
         # save the current working dir
         current_dir = Dir.pwd
@@ -32,27 +93,206 @@ class FileSys
         return output
     end
     
-    def self.write(data, to:nil)
-        # make sure the containing folder exists
-        FileUtils.makedirs(File.dirname(to))
-        # actually download the file
-        IO.write(to, data)
+    def self.copy(from:nil, to:nil, new_name:"", force: true, preserve: false, dereference_root: false)
+        if new_name == ""
+            raise "\n\nFileSys.copy() needs a new_name: argument\nset new_name:nil if you wish the file/folder to keep the same name\ne.g. FileSys.copy(from:'place/thing', to:'place', new_name:nil)"
+        end
+        # make sure the "to" path exists
+        FileSys.touch_dir(to)
+        # perform the copy
+        FileUtils.copy_entry(from, to/new_name, preserve, dereference_root, force)
+    end
+
+    def self.move(from:nil, to:nil, new_name:"", force: true, noop: nil, verbose: nil, secure: nil)
+        if new_name == ""
+            raise "\n\nFileSys.move() needs a new_name: argument\nset new_name:nil if you wish the file/folder to keep the same name\ne.g. FileSys.move(from:'place/thing', to:'place', new_name:nil)"
+        end
+        # make sure the "to" path exists
+        FileSys.touch_dir(to)
+        # perform the move
+        FileUtils.move(from, to/new_name, force: force, noop: noop, verbose: verbose, secure: secure)
     end
     
-    def self.read(filepath)
-        begin
-            return IO.read(filepath)
-        rescue => exception
-            return nil
+    def self.rename(from:nil, to:nil, force: true)
+        # if the directories are different, then throw an error
+        if not File.identical?(File.dirname(from), File.dirname(to))
+            raise "\n\nFileSys.rename() requires that the the file stay in the same place and only change names.\nIf you want to move a file, use FileSys.move()"
         end
+        # make sure the path is clear
+        if force
+            FileSys.delete(to)
+        end
+        # perform the copy
+        File.rename(from, to)
     end
     
-    def self.delete(filepath)
-        begin
-            return File.delete(filepath)
-        # if file doesnt exist, thats fine
-        rescue Errno::ENOENT => exception
-            return nil
+    def self.touch(*args)
+        return FileUtils.touch(*args)
+    end
+    
+    def self.touch_dir(path)
+        if not FileSys.directory?(path)
+            FileUtils.makedirs(path)
         end
     end
-end
+    
+    # Pathname aliases
+    def self.absolute_path?(path)
+        Pathname.new(path).absolute?
+    end
+    def self.abs?(path)
+        Pathname.new(path).absolute?
+    end
+    def self.relative_path?(path)
+        Pathname.new(path).relative?
+    end
+    def self.rel?(path)
+        Pathname.new(path).relative?
+    end
+    
+    # dir aliases
+    def self.home
+        HOME
+    end
+    def self.glob(path)
+        Dir.glob(path, File::FNM_DOTMATCH) - %w[. ..]
+    end
+    def list_files(path=".")
+        Dir.children(path).select {|each| FileSys.file?(each)}
+    end
+    def list_folders(path=".")
+        Dir.children(path).select {|each| FileSys.directory?(each)}
+    end
+    def ls(path)
+        Dir.children(path)
+    end
+    def pwd
+        Dir.pwd
+    end
+    def cd(path, verbose: false)
+        FileUtils.cd(path, verbose: verbose)
+    end
+    def chdir(path, verbose: false)
+        FileUtils.cd(path, verbose: verbose)
+    end
+    
+    # File aliases
+    def self.time_access(*args, **kwargs)
+        File.atime(*args, **kwargs)
+    end
+    def self.time_created(*args, **kwargs)
+        File.birthtime(*args, **kwargs)
+    end
+    def self.time_modified(*args, **kwargs)
+    end
+    def self.dir?(*args, **kwargs)
+        File.directory?(*args, **kwargs)
+    end
+    def self.exists?(*args, **kwargs)
+        File.exist?(*args,**kwargs)
+    end
+    
+    # inherit from File
+    def self.absolute_path(*args, **kwargs)
+        File.absolute_path(*args,**kwargs)
+    end
+    def self.dirname(*args, **kwargs)
+        File.dirname(*args,**kwargs)
+    end
+    def self.basename(*args, **kwargs)
+        File.basename(*args,**kwargs)
+    end
+    def self.extname(*args, **kwargs)
+        File.extname(*args,**kwargs)
+    end
+    def self.directory?(*args, **kwargs)
+        File.directory?(*args,**kwargs)
+    end
+    def self.file?(*args, **kwargs)
+        File.file?(*args,**kwargs)
+    end
+    def self.empty?(*args, **kwargs)
+        File.empty?(*args,**kwargs)
+    end
+    def self.exist?(*args, **kwargs)
+        File.exist?(*args,**kwargs)
+    end
+    def self.executable?(*args, **kwargs)
+        File.executable?(*args,**kwargs)
+    end
+    def self.symlink?(*args, **kwargs)
+        File.symlink?(*args,**kwargs)
+    end
+    def self.owned?(*args, **kwargs)
+        File.owned?(*args,**kwargs)
+    end
+    def self.pipe?(*args, **kwargs)
+        File.pipe?(*args,**kwargs)
+    end
+    def self.readable?(*args, **kwargs)
+        File.readable?(*args,**kwargs)
+    end
+    def self.size?(*args, **kwargs)
+        File.size?(*args,**kwargs)
+    end
+    def self.socket?(*args, **kwargs)
+        File.socket?(*args,**kwargs)
+    end
+    def self.world_readable?(*args, **kwargs)
+        File.world_readable?(*args,**kwargs)
+    end
+    def self.world_writable?(*args, **kwargs)
+        File.world_writable?(*args,**kwargs)
+    end
+    def self.writable?(*args, **kwargs)
+        File.writable?(*args,**kwargs)
+    end
+    def self.writable_real?(*args, **kwargs)
+        File.writable_real?(*args,**kwargs)
+    end
+    def self.expand_path(*args, **kwargs)
+        File.expand_path(*args,**kwargs)
+    end
+    def self.mkfifo(*args, **kwargs)
+        File.mkfifo(*args,**kwargs)
+    end
+    def self.stat(*args, **kwargs)
+        File.stat(*args,**kwargs)
+    end
+    
+    def download(input=nil, from:nil, url:nil, to:nil)
+        # if only one argument, either input or url
+        if ((input!=nil) != (url!=nil)) && (from==nil) && (to==nil)
+            # this covers:
+            #    download     'site.com/file'
+            the_url = url || input
+            file_name = the_url.match /(?<=\/)[^\/]+\z/ 
+            file_name = file_name[0]
+        elsif (to != nil) && ((input!=nil)!=(url!=nil))
+            # this covers:
+            #    download     'site.com/file' to:'file'
+            #    download url:'site.com/file' to:'file'
+            the_url = url || input
+            file_name = to
+        elsif ((from!=nil) != (url!=nil)) && input!=nil
+            # this covers:
+            #    download 'file' from:'site.com/file'
+            #    download 'file'  url:'site.com/file'
+            the_url = from || url
+            file_name = input
+        else
+            raise <<-HEREDOC.remove_indent
+                I'm not sure how you're using the download function.
+                Please use one of the following methods:
+                    download     'site.com/file'
+                    download     'site.com/file', to:'file'
+                    download url:'site.com/file', to:'file'
+                    download 'file', from:'site.com/file'
+                    download 'file',  url:'site.com/file'
+            HEREDOC
+        end
+        FileSys.write(open(URI.encode(the_url)).read, to: file_name)
+    end
+end
+# create an FS alias
+FS = FileSys

data/lib/atk/set_command.rb

@@ -6,12 +6,10 @@ def set_command(name, code)
     if OS.is?("unix")
         exec_path = "/usr/local/bin/#{name}"
         local_place = ATK.temp_path(name)
-        # create temp if it doesn't exist
-        FileUtils.makedirs(File.dirname(local_place))
         # add the hash bang
         hash_bang = "#!#{ATK.paths[:ruby]}\n"
         # create the file
-        IO.write(local_place, hash_bang+code)
+        FS.write(hash_bang+code, to: local_place)
         # copy to command folder
         system("sudo", "cp", local_place, exec_path)
         system("sudo", "chmod", "ugo+x", exec_path)
@@ -25,8 +23,8 @@ def set_command(name, code)
         exec_path = "C:\\Users\\#{username}\\AppData\\local\\Microsoft\\WindowsApps\\#{name}"
         
         # create the code
-        IO.write(exec_path+".rb", code)
+        FS.write(code, to: exec_path+".rb")
         # create an executable to call the code
-        IO.write(exec_path+".bat", "@echo off\nruby \"#{exec_path}.rb\" %*")
+        FS.write("@echo off\nruby \"#{exec_path}.rb\" %*",  to: exec_path+".bat")
     end
 end

data/lib/atk_toolbox/version.rb

@@ -1,3 +1,3 @@
 module AtkToolbox
-  VERSION = '0.0.45'
+  VERSION = '0.0.46'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atk_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.0.45
+  version: 0.0.46
 platform: ruby
 authors:
 - Jeff Hykin
@@ -59,7 +59,6 @@ files:
 - lib/atk/atk_info.rb
 - lib/atk/cmd.rb
 - lib/atk/default_info.yaml
-- lib/atk/download.rb
 - lib/atk/extra_file_utils.rb
 - lib/atk/extra_yaml.rb
 - lib/atk/git.rb

data/lib/atk/download.rb

@@ -1,38 +0,0 @@
-require 'open-uri'
-require 'fileutils'
-require_relative './extra_file_utils'
-
-def download(input_1=nil, from:nil, url:nil, as:nil)
-    # argument checking 
-        # if only one argument, either input_1 or url
-        if ((input_1!=nil) != (url!=nil)) && (from==nil) && (as==nil)
-            # this covers:
-            #    download     'site.com/file'
-            the_url = url || input_1
-            file_name = the_url.match /(?<=\/)[^\/]+\z/ 
-            file_name = file_name[0]
-        elsif (as != nil) && ((input_1!=nil)!=(url!=nil))
-            # this covers:
-            #    download     'site.com/file' as:'file'
-            #    download url:'site.com/file' as:'file'
-            the_url = url || input_1
-            file_name = as
-        elsif ((from!=nil) != (url!=nil)) && input_1!=nil
-            # this covers:
-            #    download 'file' from:'site.com/file'
-            #    download 'file'  url:'site.com/file'
-            the_url = from || url
-            file_name = input_1
-        else
-            message_ = "I'm not sure how you're using the download function.\n"
-            message_ << "Please use one of the following methods:\n"
-            message_ << "    download     'site.com/file'\n"
-            message_ << "    download     'site.com/file', as:'file'\n"
-            message_ << "    download url:'site.com/file', as:'file'\n"
-            message_ << "    download 'file', from:'site.com/file'\n"
-            message_ << "    download 'file',  url:'site.com/file'\n"
-            raise message_
-        end#if
-    #end argument checking
-    FileSys.write(open(URI.encode(the_url)).read, to: file_name)
-end