atk_toolbox 0.0.108 → 0.0.109

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5411f6c02f2858c7b8eaacb44b70f64ad2c9d685834f7f698be18ca32b034dbf
-  data.tar.gz: 04be1ee289fd1f0251fa4b885adc997f31d7fc1d799fbea423d7c9b661072459
+  metadata.gz: cb7564990fc348d432e32a8657f4311049b88460b607cb928371d629a6c05a5a
+  data.tar.gz: cc9f1798043595bac786b73b14d219944f2a82fe1524f834dbb0af9401f21d3c
 SHA512:
-  metadata.gz: d3965debfbace8fef01c8940aa672f3207116357d5f6ec9c8a349e17b866b6aa7665b20968fbf22e3fc7893821243bede06f24e5f72e8e94f4063343fab9598a
-  data.tar.gz: 12181aed8b01e777dc4e2baeb7f8ad5bb61edce4b08adb937be23fd7a0d101f8a4bad239b0da75e78a2d64e300952c6f186270e59b93a51917f7432bd4038ef1
+  metadata.gz: c948f809e4e2b229d7aa6e122f9001e4554c8ec6fb6dbc2feb798dff3d0c88e25e9df13bf363f2249feb27515b4527ccc76e738ac2c975ddb9e955d211cd2b3a
+  data.tar.gz: ac8c6d6c24a1540ab1a5867c8a1c5ac5dd5d90741e4eb0367fef828fbf96df5f83d67021712b5aa7452e2d54fdeed5bb152a3e5d6964c43a65d8ee12e2801335

data/lib/atk/autocomplete.rb

@@ -0,0 +1,12 @@
+module Atk
+    def self.autocomplete(which_command)
+        if which_command == '_'
+            require_relative './yaml_info_parser.rb'
+            begin
+                puts Info.project_commands().keys.map { |each| each.gsub(' ', '\ ') }.join(' ')
+            rescue => exception
+                puts ""
+            end
+        end
+    end
+end

data/lib/atk/extra_yaml.rb

@@ -1,4 +1,3 @@
-require_relative './os'
 require_relative './remove_indent'
 require_relative './version'
 require 'json'
@@ -145,11 +144,4 @@ class Psych::Nodes::Node
         new_string = inject_string(@document.string, middle_part, @start_line, @start_column, @end_line, @end_column)
         @document.init( string: new_string )
     end
-end
-
-
-class String
-    def yaml
-        return YAML.load(self)
-    end
-end
+end

data/lib/atk/file_sys.rb

@@ -1,10 +1,6 @@
 require 'etc'
 require 'fileutils'
 require 'pathname'
-require 'open-uri'
-require 'json'
-require 'yaml'
-require 'csv'
 require_relative './os'
 require_relative './remove_indent'
 
@@ -29,7 +25,7 @@ class String
     end
 end
 
-module FileSys
+module FileSystem
     # 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)
@@ -44,7 +40,7 @@ module FileSys
     
     def self.write(data, to:nil)
         # make sure the containing folder exists
-        FileSys.makedirs(File.dirname(to))
+        FileSystem.makedirs(File.dirname(to))
         # actually download the file
         IO.write(to, data)
     end
@@ -58,8 +54,11 @@ module FileSys
         # add a special exception for csv files
         case as
         when :csv
+            require 'csv'
             FS.write(value.map(&:to_csv).join, to: to)
         else
+            require 'json'
+            require 'yaml'
             conversion_method_name = "to_#{as}"
             if value.respond_to? conversion_method_name
                 # this is like calling `value.to_json`, `value.to_yaml`, or `value.to_csv` but programatically
@@ -68,12 +67,12 @@ module FileSys
                     raise <<-HEREDOC.remove_indent
                     
                     
-                        The FileSys.save(value, to: #{to.inspect}, as: #{as.inspect}) had a problem.
+                        The FileSystem.save(value, to: #{to.inspect}, as: #{as.inspect}) had a problem.
                         The as: #{as}, gets converted into value.to_#{as}
                         Normally that returns a string that can be saved to a file
                         However, the value.to_#{as} did not return a string.
                         Value is of the #{value.class} class. Add a `to_#{as}` 
-                        method to that class that returns a string to get FileSys.save() working
+                        method to that class that returns a string to get FileSystem.save() working
                     HEREDOC
                 end
                 FS.write(string_value, to:to)
@@ -81,13 +80,13 @@ module FileSys
                 raise <<-HEREDOC.remove_indent
                 
                 
-                    The FileSys.save(value, to: #{to.inspect}, as: #{as.inspect}) had a problem.
+                    The FileSystem.save(value, to: #{to.inspect}, as: #{as.inspect}) had a problem.
                     
                     The as: #{as}, gets converted into value.to_#{as}
                     Normally that returns a string that can be saved to a file
                     However, the value.to_#{as} is not a method for value
                     Value is of the #{value.class} class. Add a `to_#{as}` 
-                    method to that class that returns a string to get FileSys.save() working
+                    method to that class that returns a string to get FileSystem.save() working
                 HEREDOC
             end
         end
@@ -135,24 +134,24 @@ module FileSys
     
     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)"
+            raise "\n\nFileSystem.copy() needs a new_name: argument\nset new_name:nil if you wish the file/folder to keep the same name\ne.g. FileSystem.copy(from:'place/thing', to:'place', new_name:nil)"
         elsif new_name == nil
             new_name = File.basename(from)
         end
         # make sure the "to" path exists
-        FileSys.touch_dir(to)
+        FileSystem.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)"
+            raise "\n\nFileSystem.move() needs a new_name: argument\nset new_name:nil if you wish the file/folder to keep the same name\ne.g. FileSystem.move(from:'place/thing', to:'place', new_name:nil)"
         elsif new_name == nil
             new_name = File.basename(from)
         end
         # make sure the "to" path exists
-        FileSys.touch_dir(to)
+        FileSystem.touch_dir(to)
         # perform the move
         FileUtils.move(from, to/new_name, force: force, noop: noop, verbose: verbose, secure: secure)
     end
@@ -160,11 +159,11 @@ module FileSys
     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()"
+            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()"
         end
         # make sure the path is clear
         if force
-            FileSys.delete(to)
+            FileSystem.delete(to)
         end
         # perform the copy
         File.rename(from, to)
@@ -177,7 +176,7 @@ module FileSys
     singleton_class.send(:alias_method, :new_file, :touch)
     
     def self.touch_dir(path)
-        if not FileSys.directory?(path)
+        if not FileSystem.directory?(path)
             FileUtils.makedirs(path)
         end
     end
@@ -205,7 +204,7 @@ module FileSys
         extname = File.extname(pieces[-1])
         basebasename = pieces[-1][0...(pieces[-1].size - extname.size)]
         # add the root if the path is absolute
-        if FileSys.abs?(path)
+        if FileSystem.abs?(path)
             if not OS.is?("windows")
                 pieces.unshift('/')
             else
@@ -224,10 +223,10 @@ module FileSys
         Dir.glob(path, File::FNM_DOTMATCH) - %w[. ..]
     end
     def self.list_files(path=".")
-        Dir.children(path).map{|each| path/each }.select {|each| FileSys.file?(each)}
+        Dir.children(path).map{|each| path/each }.select {|each| FileSystem.file?(each)}
     end
     def self.list_folders(path=".")
-        Dir.children(path).map{|each| path/each }.select {|each| FileSys.directory?(each)}
+        Dir.children(path).map{|each| path/each }.select {|each| FileSystem.directory?(each)}
     end
     def self.ls(path=".")
         Dir.children(path)
@@ -379,6 +378,7 @@ module FileSys
     end
     
     def self.download(input=nil, from:nil, url:nil, to:nil)
+        require 'open-uri'
         # if only one argument, either input or url
         if ((input!=nil) != (url!=nil)) && (from==nil) && (to==nil)
             # this covers:
@@ -409,8 +409,8 @@ module FileSys
                     download 'file',  url:'site.com/file'
             HEREDOC
         end
-        FileSys.write(open(URI.encode(the_url)).read, to: file_name)
+        FileSystem.write(open(URI.encode(the_url)).read, to: file_name)
     end
 end
-# create an FS singleton_class.send(:alias_method, :FS = :FileSys)
-FS = FileSys
+# create an FS singleton_class.send(:alias_method, :FS = :FileSystem)
+FS = FileSystem

data/lib/atk/os.rb

@@ -1,47 +1,4 @@
 require_relative './version.rb'
-# every OS version is a perfect heirarchy of versions and sub verisons that may or may not be chronological
-# every OS gets it's own custom heirarchy since there are issues like x86 support and "student edition" etc
-# the plan is to release this heirarchy on its own repo, and to get pull requests for anyone who wants to add their own OS
-os_heirarchy = {
-    "windows" => {
-        "10"    => {},
-        "8.1"   => {},
-        "8"     => {},
-        "7"     => {},
-        "vista" => {},
-        "xp"    => {},
-        "95"    => {},
-    },
-    "mac" => {
-        "mojave"         => {},
-        "high sierra"    => {},
-        "sierra"         => {},
-        "el capitan"     => {},
-        "yosemite"       => {},
-        "mavericks"      => {},
-        "mountain lion"  => {},
-        "lion"           => {},
-        "snow leopard"   => {},
-        "leopard"        => {},
-        "tiger"          => {},
-        "panther"        => {},
-        "jaguar"         => {},
-        "puma"           => {},
-        "cheetah"        => {},
-        "kodiak"         => {},
-    },
-    "ubuntu"     => {},
-    "arch"       => {},
-    "manjaro"    => {},
-    "deepin"     => {},
-    "centos"     => {},
-    "debian"     => {},
-    "fedora"     => {},
-    "elementary" => {},
-    "zorin"      => {},
-    "raspian"    => {},
-    "android"    => {},
-}
 
 # this statment was extracted from the ptools gem, credit should go to them
 # https://github.com/djberg96/ptools/blob/master/lib/ptools.rb

data/lib/atk/yaml_info_parser.rb

@@ -1,11 +1,27 @@
 require "yaml"
-require_relative './console'
+require "colorize"
 require_relative './os'
-require_relative './file_sys'
-require_relative './extra_yaml'
 require 'fileutils'
 require_relative './remove_indent.rb'
 
+# duplicated for the sake of efficieny (so that the parser doesn't need to import all of FileSystem)
+module FileSystem
+    def self.join(*args)
+        if OS.is?("windows")
+            folders_without_leading_or_trailing_slashes = args.map do |each|
+                # replace all forward slashes with backslashes
+                backslashed_only = each.gsub(/\//,"\\")
+                # remove leading/trailing backslashes
+                backslashed_only.gsub(/(^\\|^\/|\\$|\/$)/,"")
+            end
+            # join all of them with backslashes
+            folders_without_leading_or_trailing_slashes.join("\\")
+        else
+            File.join(*args)
+        end
+    end
+end
+
 # TODO: for efficiency, have the parser generate a parsed object, instead of only handling everything dynamically (allow for both)
 
 # 
@@ -103,7 +119,7 @@ class Info
     def self.init
         current_dir = Dir.pwd/"info.yaml"
         # if there isn't a info.yaml then create one
-        if not FS.file?(current_dir)
+        if not File.file?(current_dir)
             # copy the default yaml to the current dir
             FileUtils.cp(__dir__/"default_info.yaml", current_dir)
             puts "info.yaml created successfully"
@@ -225,25 +241,27 @@ class Info
             # @@environment_variables
         
         # get the local yaml file
-        if FS.file?(Info.source_path)
-            begin
-                @@data = YAML.load_file(Info.source_path)
-                if @@data['(using_atk_version)'] != 1.0
-                    raise <<-HEREDOC.remove_indent
-                    
-                    
-                        When opening the info.yaml file in '#{self.folder}'
-                        the (using_atk_version) was listed as: #{@@data['(using_atk_version)'].inspect}
-                        The version of atk_toolbox you have installed is only capable of handling version 1.0
-                        either atk_toolbox needs to be changed, or the (using_atk_version) version needs to be changed.
-                    HEREDOC
-                end
-            rescue => exception
+        absolute_parent_path = File.absolute_path(Info.folder())
+        source = FileSystem.join(absolute_parent_path, "info.yaml")
+        begin
+            @@data = YAML.load_file(source)
+            if @@data['(using_atk_version)'] != 1.0
+                raise <<-HEREDOC.remove_indent
+                
+                
+                    When opening the info.yaml file in '#{self.folder}'
+                    the (using_atk_version) was listed as: #{@@data['(using_atk_version)'].inspect}
+                    The version of atk_toolbox you have installed is only capable of handling version 1.0
+                    either atk_toolbox needs to be changed, or the (using_atk_version) version needs to be changed.
+                HEREDOC
+            end
+        rescue
+            if File.file?(source)
                 puts "\n\nI'm having trouble loading the info.yaml file. Here's the error:\n".red
                 raise exception
+            else
+                raise "\n\nCouldn't find an info.yaml file in #{Dir.pwd}".red
             end
-        else
-            raise "\n\nCouldn't find an info.yaml file in #{Dir.pwd}".red
         end
         @@project = @@data['(project)']
         if @@project == nil
@@ -269,7 +287,7 @@ class Info
         for each_key, each_value in @@paths
             # if its an array, just join it together
             if each_value.is_a?(Array)
-                each_value = FS.join(*each_value)
+                each_value = FileSystem.join(*each_value)
             end
             if each_value.is_a?(String)
                 # remove the ./ if it exists
@@ -279,7 +297,7 @@ class Info
                 # Dont add a source_path if its an absolute path
                 if not each_value.size > 0 && each_value[0] == '/'
                     # convert the path into an absolute path
-                    @@paths[each_key] = FS.absolute_path(FS.dirname(Info.source_path)) / each_value
+                    @@paths[each_key] = FileSystem.join(absolute_parent_path , each_value)
                 end
             end
         end
@@ -304,29 +322,30 @@ class Info
     end
     
     def self.folder()
-        first_location = Dir.pwd/"info.yaml"
-        *folders, name, ext = FS.path_pieces(first_location)
+        folder = Dir.pwd
         loop do
+            # if the info.yaml exists in that folder
+            if FileSystem.join(folder, "info.yaml")
+                return folder
+            end
+
+            next_location = File.dirname(folder)
+            
             # if all folders exhausted
-            if folders.size == 0
+            if next_location == folder
                 raise <<-HEREDOC.remove_indent.red
                     
-                    Couldn't find an info.yaml in the current directory or any parent directory
+                    #{"Couldn't find an info.yaml in the current directory or any parent directory".red}
                         #{Dir.pwd}
                     Are you sure you're running the command from the correct directory?
                 HEREDOC
             end
-            # if the info.yaml exists, then use it
-            path = FS.join(*folders, "info.yaml")
-            if FS.file?(path)
-                return FS.join(*folders)
-            end
-            # go up the folders
-            folders.pop()
+            
+            folder = next_location
         end
     end
     
     def self.source_path()
-        return self.folder()/"info.yaml"
+        return FileSystem.join( self.folder(), "info.yaml")
     end
 end

data/lib/atk_toolbox/version.rb

@@ -1,3 +1,3 @@
 module AtkToolbox
-    VERSION = '0.0.108'
+    VERSION = '0.0.109'
 end

data/test/main.rb

@@ -2,4 +2,7 @@ require_relative '../lib/atk_toolbox'
 
 Dir.chdir __dir__
 
-puts Info.paths.to_yaml
+puts Info.paths.to_yaml
+
+# only require the autocomplete, not the entire ATK toolbox
+require File.dirname(Gem.find_latest_files('atk_toolbox')[0])+"/atk/autocomplete.rb"; Atk.autocomplete('_')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atk_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.0.108
+  version: 0.0.109
 platform: ruby
 authors:
 - Jeff Hykin
@@ -97,6 +97,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/atk/atk_info.rb
+- lib/atk/autocomplete.rb
 - lib/atk/commands/project.rb
 - lib/atk/console.rb
 - lib/atk/default_info.yaml