atk_toolbox 0.0.126 → 0.0.127

data/lib/atk/console.rb

@@ -1,14 +1,11 @@
 require "tty-prompt"
 require_relative "./os.rb"
-require "colorize"
-
-
-# TODO: switch to using https://github.com/piotrmurach/tty-command#2-interface 
+require_relative "../console_colors.rb"
 
 # easy access to the commandline
 class String
     # add a - operator to strings that makes it behave like a system() call 
-    # but it shows stderr and returns a success value
+    # but it returns a success value for chaining commands with || or &&
     def -@
         Process.wait(Process.spawn(self))
         return $?.success?
@@ -20,8 +17,6 @@ end
 # Console 
 # 
 # see https://github.com/piotrmurach/tty-prompt
-# TODO: look into https://piotrmurach.github.io/tty/  to animate the terminal
-# TODO: look at https://github.com/pazdera/catpix to add an ATK logo in the terminal
 class TTY::Prompt
     attr_accessor :verbose
     def _save_args
@@ -57,18 +52,104 @@ class TTY::Prompt
     def has_command(name_of_executable)
         return OS.has_command(name_of_executable)
     end
+    alias :has_command? :has_command
     
-    def single_quote_escape(string)
-        string.gsub(/'/, "'\"'\"'")
+    def as_shell_argument(argument)
+        argument = argument.to_s
+        if OS.is?(:unix)
+            # use single quotes to perfectly escape any string
+            return " '"+argument.gsub(/'/, "'\"'\"'")+"'"
+        else
+            # *sigh* Windows
+            # this problem is unsovleable
+            # see: https://superuser.com/questions/182454/using-backslash-to-escape-characters-in-cmd-exe-runas-command-as-example
+            #       "The fact is, there's nothing that will escape " within quotes for argument passing. 
+            #        You can brood over this for a couple of years and arrive at no solution. 
+            #        This is just some of the inherent limitations of cmd scripting.
+            #        However, the good news is that you'll most likely never come across a situation whereby you need to do so.
+            #        Sure, there's no way to get echo """ & echo 1 to work, but that's not such a big deal because it's simply
+            #        a contrived problem which you'll likely never encounter.
+            #        For example, consider runas. It works fine without needing to escape " within quotes
+            #        because runas knew that there's no way to do so and made internal adjustments to work around it.
+            #        runas invented its own parsing rules (runas /flag "anything even including quotes") and does not
+            #        interpret cmd arguments the usual way.
+            #        Official documentation for these special syntax is pretty sparse (or non-existent).
+            #        Aside from /? and help, it's mostly trial-and-error."
+            # 
+            
+            
+            # according to Microsoft see: https://docs.microsoft.com/en-us/archive/blogs/twistylittlepassagesallalike/everyone-quotes-command-line-arguments-the-wrong-way
+            # the best possible (but still broken) implementation is to quote things 
+            # in accordance with their default C++ argument parser
+            # so thats what this function does
+            
+            # users are going to have to manually escape things like ^, !, % etc depending on the context they're used in
+            
+            simple_char = "[a-zA-Z0-9_.,;`=-*?\\/\\[\\]]"
+            
+            # if its a simple argument just pass it on
+            if argument =~ /\A(#{simple_char})*\z/
+                return " #{argument}"
+            # if it is complicated, then quote it and escape quotes
+            else
+                # find any backslashes that come before a double quote or the ending of the argument
+                # then double the number of slashes
+                escaped = argument.gsub(/(?<slashes>\/+)(?="|\z)/) do |each_match|
+                    "\/" * (each_match['slashes'].size * 2)
+                end
+                
+                # then find all the double quotes and escape them
+                escaped.gsub!(/"/, '\\"')
+                
+                # all of the remaining escapes are up to Windows user's/devs
+
+                return " \"#{escaped}\""
+            end
+        end
     end
     
     def make_arguments_appendable(arguments)
-        # TODO: make sure this works on windows
         safe_arguments = arguments.map do |each|
-            " '"+Console.single_quote_escape(each)+"'"
+            Console.as_shell_argument(each)
         end
         return safe_arguments.join('')
     end
+    
+    # returns the locations where commands are stored from highest to lowest priority
+    def command_sources()
+        if OS.is?('unix')
+            return ENV['PATH'].split(':')
+        else
+            return ENV['PATH'].split(';')
+        end
+    end
+    
+    def require_superuser()
+        if OS.is?('unix')
+            system("sudo echo 'permissions acquired'")
+        else
+            # check if already admin
+            # $currentPrincipal = New-Object Security.Principal.WindowsPrincipal([Security.Principal.WindowsIdentity]::GetCurrent())
+            # $currentPrincipal.IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)
+            # FUTURE: add a check here and raise an error if not admin
+            puts "(in the future this will be an automatic check)"
+            puts "(if you're unsure, then the answer is probably no)"
+            if Console.yes?("Are you running this \"as an Administrator\"?\n(caution: incorrectly saying 'yes' can cause broken systems)")
+                puts "assuming permissions are acquired"
+            else
+                puts <<-HEREDOC.remove_indent
+                    
+                    You'll need to 
+                    - close the current program
+                    - reopen it "as Administrator"
+                    - redo whatever steps you did to get here
+                    
+                HEREDOC
+                Console.keypress("Press enter to end the current process", keys: [:return])
+                exit
+            end
+        end
+    end
 end
 
 Console = TTY::Prompt.new

data/lib/atk/default_info.yaml

@@ -1,4 +1,4 @@
-(using_atk_version): 1.0
+(using_atk_version): 1.1.0
 (project):
     name: Your Project Name Here
     description: Describe your project here

data/lib/atk/{file_sys.rb → file_system.rb}

@@ -31,12 +31,14 @@ module FileSystem
     # 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
+    # FUTURE add
         # change_owner
         # set_permissions
         # relative_path_between
         # relative_path_to
         # add a force: true option to most of the commands
+        # zip
+        # unzip
     
     def self.write(data, to:nil)
         # make sure the containing folder exists
@@ -156,17 +158,25 @@ module FileSystem
         FileUtils.move(from, to/new_name, force: force, noop: noop, verbose: verbose, secure: secure)
     end
     
-    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\nFileSystem.rename() requires that the the file stay in the same place and only change names.\nIf you want to move a file, use FileSystem.move()"
+    def self.rename(path, new_name:nil, force: true)
+        if File.dirname(new_name) != "."
+            raise <<-HEREDOC.remove_indent
+                
+                
+                When using FileSystem.rename(path, new_name)
+                    The new_name needs to be a filename, not a file path
+                    e.g. "foo.txt" not "a_folder/foo.txt"
+                    
+                    If you want to move the file, use FileSystem.move(from:nil, to:nil, new_name:"")
+            HEREDOC
         end
+        to = path/new_name
         # make sure the path is clear
         if force
             FileSystem.delete(to)
         end
-        # perform the copy
-        File.rename(from, to)
+        # perform the rename
+        File.rename(path, to)
     end
     
     def self.touch(*args)
@@ -208,7 +218,7 @@ module FileSystem
             if not OS.is?("windows")
                 pieces.unshift('/')
             else
-                # TODO: eventually make this work for any drive, not just the current drive
+                # FUTURE: eventually make this work for any drive, not just the current drive
                 pieces.unshift('\\')
             end
         end
@@ -377,40 +387,79 @@ module FileSystem
         File.stat(*args)
     end
     
-    def self.download(input=nil, from:nil, url:nil, to:nil)
+    def self.download(the_url, to:nil)
         require 'open-uri'
-        # 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
+        FileSystem.write(open(URI.encode(the_url)).read, to: to)
+    end
+    
+    def self.online?
+        require 'open-uri'
+        begin
+            true if open("http://www.google.com/")
+        rescue
+            false
         end
-        FileSystem.write(open(URI.encode(the_url)).read, to: file_name)
     end
 end
 # create an FS singleton_class.send(:alias_method, :FS = :FileSystem)
-FS = FileSystem
+FS = FileSystem
+
+
+
+
+# TODO: add zip/unzip functionality
+# spec.add_runtime_dependency 'zip', '~> 2.0', '>= 2.0.2'
+# require 'zip'
+
+# class ZipFileGenerator
+#     # Initialize with the directory to zip and the location of the output archive.
+#     def initialize(input_dir, output_file)
+#         @input_dir = input_dir
+#         @output_file = output_file
+#     end
+
+#     # Zip the input directory.
+#     def write
+#         entries = Dir.entries(@input_dir) - %w[. ..]
+
+#         Zip::ZipFile.open(@output_file, Zip::ZipFile::CREATE) do |zipfile|
+#         write_entries entries, '', zipfile
+#         end
+#     end
+
+#     private
+
+#     # A helper method to make the recursion work.
+#     def write_entries(entries, path, zipfile)
+#         entries.each do |e|
+#         zipfile_path = path == '' ? e : File.join(path, e)
+#         disk_file_path = File.join(@input_dir, zipfile_path)
+
+#         if File.directory? disk_file_path
+#             recursively_deflate_directory(disk_file_path, zipfile, zipfile_path)
+#         else
+#             put_into_archive(disk_file_path, zipfile, zipfile_path)
+#         end
+#         end
+#     end
+
+#     def recursively_deflate_directory(disk_file_path, zipfile, zipfile_path)
+#         zipfile.mkdir zipfile_path
+#         subdir = Dir.entries(disk_file_path) - %w[. ..]
+#         write_entries subdir, zipfile_path, zipfile
+#     end
+
+#     def put_into_archive(disk_file_path, zipfile, zipfile_path)
+#         zipfile.add(zipfile_path, disk_file_path)
+#     end
+# end
+
+
+# def zip(source, destination=nil)
+#     if destination == nil
+#         destination = source + ".zip"
+#     end
+    
+#     zip_helper = ZipFileGenerator.new(source, destination)
+#     zip_helper.write()
+# end

data/lib/atk/git.rb

@@ -1,26 +1,27 @@
-require 'git'
-require 'logger'
-
 module Git
     def self.ensure_cloned_and_up_to_date(target_dir, git_repo_url)
         # check if it exists
-        if FS.directory?(target_dir)
-            if Console.verbose
-                git_repo = Git.open(target_dir,  :log => Logger.new(STDOUT))
+        if FS.folder?(target_dir)
+            # check if its a git repo
+            if FS.folder?(target_dir/".git")
+                # fetch master
+                system("git fetch origin master")
+                if $?.success?
+                    # force pull
+                    system("git reset --hard origin/master")
+                end
+                return
             else
-                git_repo = Git.open(target_dir)
+                # clear the path
+                FS.delete(target_dir)
             end
-        # if it doesn't exist, then clone it
-        else
-            git_repo = Git.clone(git_repo_url, target_dir)
         end
-        # pull from origin master
-        # TODO: make this a force pull
-        git_repo.pull
+        # clone the directory if pulling didn't occur
+        system("git", "clone", git_repo_url, target_dir)
     end
     
     def self.repo_name(url)
-        require_relative './file_sys'
+        require_relative './file_system'
         *folders, name, extension = FS.path_pieces(url)
         return name
     end

data/lib/atk/{yaml_info_parser.rb → info.rb}

@@ -1,7 +1,7 @@
 require "yaml"
-require "colorize"
 require 'fileutils'
 require_relative './os'
+require_relative "../console_colors.rb"
 require_relative './remove_indent.rb'
 require_relative './version.rb'
 
@@ -32,8 +32,6 @@ module FileSystem
     end
 end
 
-# TODO: for efficiency, have the parser generate a parsed object, instead of only handling everything dynamically (allow for both)
-
 # 
 # Create loaders for ruby code literal and console code literal
 # 
@@ -52,8 +50,7 @@ end
         end
         
         def run
-            # TODO: improve this error message
-            raise "This needs to be overloaded"
+            raise "#{self.class}.run needs to be overloaded"
         end
         
         def to_s
@@ -66,10 +63,12 @@ end
     # 
     class RubyCode < Code
         def run(*args)
+            # FUTURE: generate this name to ensure there are never name conflicts
             temp_file = ".info_language_runner_cache.rb"
-            IO.write(temp_file, @value)
+            # a file needs to be created in the root dir so that things like __dir__ work properly
+            # the first line of the temp file deletes itself so that it appears as if no file ever existed
+            IO.write(temp_file, "File.delete('./.info_language_runner_cache.rb')\n#{@value}")
             Process.wait(Process.spawn("ruby", temp_file, *args))
-            File.delete(temp_file)
         end
     end
     register_tag('!language/ruby', RubyCode)
@@ -84,13 +83,13 @@ end
         end
     end
 
-    # 
+    #
     # Console Code
-    # 
-    # TODO: add support for console code
+    #
     class ConsoleCode < Code
         def run
-            -"#{@value}"
+            system(@value)
+            return $?
         end
     end
     register_tag('!language/console', ConsoleCode)
@@ -110,6 +109,9 @@ class Info
     class ReRaiseException < Exception
     end
     
+    class YamlFileDoesntExist < Exception
+    end
+    
     def initialize()
         # 
         # find the yaml file
@@ -117,7 +119,7 @@ class Info
         begin
             @path = Info.path
         rescue
-            raise <<-HEREDOC.remove_indent
+            raise YamlFileDoesntExist, <<-HEREDOC.remove_indent
                 
                 
                 When calling Info.new
@@ -143,24 +145,35 @@ class Info
         # 
         # check the version, and parse accordingly
         # 
-        version = nil
+        @version = nil
         begin
-            version = Version.new(@data['(using_atk_version)'].to_s)
+            @version = Version.new(@data['(using_atk_version)'].to_s)
         rescue => exception
             # if no version, then don't worry about parsing
         end
-        if version.is_a?(Version)
+        if @version.is_a?(Version)
             begin
-                if version <= Version.new("1.0.0")
-                    self.parser_version1(@data)
+                if @version <= Version.new("1.0.0")
+                    raise ReRaiseException, <<-HEREDOC.remove_indent
+                        
+                        So it looks like you're info.yaml file version is 1.0
+                        That was the alpha version of ATK, which is the only version that will not be supported
+                        
+                        #{"This is likely just an accident and the only thing that needs to be done is change:".color_as :message}
+                            (using_atk_version): 1.0
+                        #{"to:".color_as :message}
+                            (using_atk_version): 1.1.0
+                    HEREDOC
+                elsif @version <= Version.new("1.1.0")
+                    self.parser_version_1_1(@data)
                 else
-                    # TODO: in the future do an online check to see if the latest ATK could handle this
-                    raise <<-HEREDOC.remove_indent
+                    # FUTURE: in the future do an online check to see if the latest ATK could handle this
+                    raise ReRaiseException, <<-HEREDOC.remove_indent
                         
                         Hey I think you need to update atk:
                             `atk update`
                         Why?
-                            The (using_atk_version) in the info.yaml is: #{version}
+                            The (using_atk_version) in the info.yaml is: #{@version}
                             However, I (your current version of ATK) don't know
                             how to handle that version.
                     HEREDOC
@@ -183,7 +196,7 @@ class Info
                     please go here:
                     https://github.com/aggie-tool-kit/atk-toolbox/issues/new
                     and tell us what happened before getting this message
-                    and also paste the original error message:
+                    and also paste the original error message
                     
                     Sorry for the bug!
                 HEREDOC
@@ -203,9 +216,9 @@ class Info
             
             # if all folders exhausted
             if next_location == folder
-                raise <<-HEREDOC.remove_indent.red
+                raise <<-HEREDOC.remove_indent
                     
-                    #{"Couldn't find an info.yaml in the current directory or any parent directory".red}
+                    #{"Couldn't find an info.yaml in the current directory or any parent directory".color_as(:bad)}
                         #{Dir.pwd}
                     Are you sure you're running the command from the correct directory?
                 HEREDOC
@@ -219,7 +232,11 @@ class Info
         return FileSystem.join( self.folder(), "info.yaml")
     end
     
-    def parser_version1(data)
+    def version()
+        return @version
+    end
+    
+    def parser_version_1_1(data)
         # 
         # parse the commands
         #