atk_toolbox 0.0.126 → 0.0.127

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57012bac4c7f283b708959f31767468a6462cdc03fe17ccedf389179e57ff554
-  data.tar.gz: 525756a93ce1a7fc587e5fccccf1106d7b0d01815251edc943d90209291ca26c
+  metadata.gz: c9c4d780511982908f64d709071d17ccce1d7d7d7402aaec338fe28b4986c62c
+  data.tar.gz: 1574b3aa46422f14c5904b31cf095a10e4c426b8448f6864350f030c022080d2
 SHA512:
-  metadata.gz: 80e4489665300858017f8ebd8bbcb45bfb47ba80b844db26999b1ad50822d014a81e34b596bf450537db0b7c8655034addf733d5e4600cdc2dc5c4b767d4ad85
-  data.tar.gz: 1ef3e501ed87846015bb249ac16702b9d77e442553f246b67c468aaf2c4febe8440287d1cc394a20cdeaebdea741aa44ff628115ce3bef0d8a51cfc63ca4ab16
+  metadata.gz: a295b532b4bbc450e5f4d6e4b56734f3fbce52ae0662afa394647582a137346751f0eb1e19d93b58eb56bdf9fcb363f6d409ab41bf78fbf0aeac2ee45f1e828a
+  data.tar.gz: 222c45ef0e94b873adb9cc0bcd3a345f8b37c94d08374923b0a1606004d1ad1c3d5112020cce48a2af3bee304790d6e19dde00d47b16aa6b9f2603fe58a4cca5

data/lib/atk/atk_info.rb

@@ -1,6 +1,6 @@
-require_relative './file_sys'
+require_relative './file_system'
 require_relative './console'
-require_relative './yaml_info_parser'
+require_relative './info'
 require_relative './os'
 require_relative './git'
 require 'yaml'
@@ -33,10 +33,16 @@ class AtkPaths
                 end
                 return ruby_path
             when 'gem'
-                # TODO: this eventually needs to link to a specific version of ruby
+                # FUTURE: this should eventually  link to a specific version of ruby instead of the global version
                 return OS.path_for_executable("gem")
             when 'repos'
                 return HOME/"atk"/"repos"
+            when 'commands'
+                if OS.is?("unix")
+                    return "/usr/local/bin"
+                else
+                    return "C:\\Users\\#{FS.username}\\AppData\\local\\Microsoft\\WindowsApps"
+                end
         end
     end
 end
@@ -93,6 +99,48 @@ module Atk
         FS.save(info_data, to: Atk.paths[:info], as: :yaml )
     end
     
+    def self.checkup
+        errors = {}
+        
+        # make sure ruby is the corrct version
+        if VERSION_OF_RUBY >= Version.new("3.0.0")
+            errors[:ruby_version_too_high] = true
+        elsif VERSION_OF_RUBY < Version.new("2.5")
+            errors[:ruby_version_too_low] = true
+        end
+        
+        # make sure git is installed and up to date
+        if not Console.has_command("git")
+            errors[:doesnt_have_git] = true
+        else
+            git_version = Version.extract_from(`git --version`)
+            if git_version < Version.new("2.17")
+                errors[:git_version_too_low] = true
+            end
+        end
+        
+        # FUTURE: checkup on the package manager
+        
+        # FUTURE: verify that windows and unix paths are highest priority
+        
+        if OS.is?("unix")
+            sources = Console.command_sources()
+            top_source = sources[0]
+            path_for_commands = Atk.paths[:commands]
+            if top_source != path_for_commands
+                errors[:commands_are_not_at_top_of_path] = true
+                if not sources.any?{ |each| each == path_for_commands }
+                    errors[:commands_are_not_in_path] = true
+                end
+            end
+        end
+        
+        # 
+        # TODO: talk about any found errors
+        # 
+        
+    end
+    
     def self.setup(package_name, arguments)
         repo_url = AtkPackage.new(package_name).url
         project_folder = Atk.info["project_folder"]
@@ -100,7 +148,7 @@ module Atk
         if not project_folder
             # then use the current folder
             project_folder = FS.pwd
-            puts "Project will be downloaded to #{project_folder.to_s.yellow}"
+            puts "Project will be downloaded to #{project_folder.to_s.color_as :key_term}"
             puts "(your current directory)"
             puts ""
         end
@@ -110,7 +158,7 @@ module Atk
         FS.in_dir(project_path) do
             setup_command = Info.commands['(setup)']
             if setup_command.is_a?(Code) || setup_command.is_a?(String)
-                puts "\n\nRunning (setup) command:\n".green
+                puts "\n\n#{"Running (setup) command:".color_as :title}\n"
                 sleep 1
                 if setup_command.is_a?(Code)
                     setup_command.run(arguments)
@@ -119,10 +167,10 @@ module Atk
                 end
             end
             puts "\n\n\n\n============================================================"
-            puts "Finished running setup for: #{project_path.green}"
+            puts "Finished running setup for: #{project_path.color_as :good}"
             puts "This project has these commands avalible:"
             system "project commands"
-            puts "\ndon't forget to do:\n#{"cd '#{project_path}'".blue}"
+            puts "\ndon't forget to do:\n#{"cd '#{project_path}'".color_as :code}"
         end
     end
     
@@ -135,16 +183,43 @@ module Atk
         puts "Sorry, this feature is still under development"
     end
     
-    def self.update()
-        system(Atk.paths['gem'], 'install', "atk_toolbox")
+    def self.update(*args)
+        # 
+        # update a specific repo/package
+        # 
+        if args.size != 0
+            Atk.not_yet_implemented()
+            return
+        end
+        
+        # 
+        # update ATK itself
+        #
+        puts "Checking latest online version"
+        console_output = IO.popen([Atk.paths['gem'], "list", "atk_toolbox", "--remote"]).read
+        filtered = console_output.split("\n").select{|each| each =~ /^atk_toolbox \(/}
+        latest_version = Version.extract_from(filtered[0])
+        # if update avalible
+        if Atk.version < latest_version
+            puts "Newer version avalible, installing now"
+            # install the new gem
+            system(Atk.paths['gem'], "install", "atk_toolbox")
+            # run the update handler
+            temp_file = Atk.temp_path("after_gem_update.rb")
+            FS.download("https://raw.githubusercontent.com/aggie-tool-kit/atk-toolbox/master/lib/after_gem_update.rb", to: temp_file)
+            system(Atk.paths["ruby"], temp_file, Atk.version.to_s)
+        else
+            puts "System up to date"
+        end
     end
 end
 ATK = Atk
 
-
 class AtkPackage
     def initialize(package_name)
         @init_name = package_name
+        @package_info_loaded = false
+        @dont_exist = {}
     end
     
     def simple_name
@@ -200,63 +275,158 @@ class AtkPackage
         end
     end
     
-    def run(arguments)
-        # make sure the repo is downloaded
-        self.ensure_cached()
-        FS.in_dir(self.cache_location) do
-            run_command = nil
-            begin
-                run_command = Info["(installer)"]["(commands)"]["(run)"]
-            rescue
-            end
-            if run_command.is_a?(String)
-                system(run_command + Console.make_arguments_appendable(arguments))
-            else
-                # 
-                # refine the error message
-                # 
-                custom_message = ""
-                if run_command != nil && ( !run_command.is_a?(String) )
-                    custom_message = "✖ the (run) command wasn't a string".red
-                else
-                    yaml_exists = File.exist?(self.cache_location()/"info.yaml")
-                    
-                    if not yaml_exists
-                        custom_message = "✖ there was no info.yaml for this package".red
+    # 
+    # parse package
+    #     
+    def ensure_package_info()
+        if not @package_info_loaded
+            @package_info_loaded = true
+            self.ensure_cached()
+            FS.in_dir(self.cache_location) do
+                if not FS.file?("./info.yaml")
+                    @dont_exist[:yaml_file] = true
+                end
+                begin
+                    # must be in top most dir
+                    @info = YAML.load_file("./info.yaml")
+                rescue => exception
+                    @dont_exist[:correctly_formatted_yaml_file] = true
+                end
+                
+                # attempt to load a version
+                begin
+                    version = Version.new(@info['(using_atk_version)'])
+                rescue => exception
+                    version = nil
+                    @dont_exist[:using_atk_version] = true
+                end
+                # if there is a version
+                if version.is_a?(Version)
+                    # if the version is really old
+                    if version <= Version.new("1.0.0")
+                        raise <<-HEREDOC.remove_indent
+                            
+                            
+                            It appears that the #{self.simple_name()} package is using
+                            the alpha version of ATK (1.0.0), which is no longer supported.
+                            This is probably just a simple versioning mistake.
+                            Please ask the maintainer of the #{self.simple_name()} package to
+                            update it to a newer ATK package format
+                        HEREDOC
+                    elsif version <= Version.new("1.1.0")
+                        self.parser_version_1_1(@info)
                     else
-                        error_loading_yaml = false
-                        begin
-                            YAML.load_file("./info.yaml")
-                        rescue
-                            error_loading_yaml = true
-                        end
-                        if error_loading_yaml
-                            custom_message = "✖ there was an issue loading the info.yaml for this package".red
-                        else
-                            if run_command == nil
-                                custom_message = "✖ there wasn't an (installer) key with a run command".red
-                            end
-                        end
-                    end
+                        raise <<-HEREDOC.remove_indent
+                            
+                            
+                            The package #{self.simple_name()} has a (using_atk_version)
+                            that is newer than the currently installed ATK can handle:
+                            version: #{version}
+                            
+                            This means either
+                                1. ATK needs to be updated (which you can do with #{'atk update'.color_as :code})
+                                2. The package has specified a version of ATK that doesn't exist
+                        HEREDOC
+                    end  
                 end
+            end
+        end
+    end
+    
+    # 
+    # (using_atk_version) 1.1.0
+    # 
+    # (package):
+    #     (actions):
+    #          (run): *run command as string*
+    def parser_version_1_1(info)
+        # 
+        # inits:
+        #    @package_info: nil
+        #    @actions: {}
+        #    @run: nil
+        # 
+        if @info.is_a?(Hash)
+            @package_info = @info['(package)']
+            if @package_info.is_a?(Hash)
+                @actions = @package_info['(actions)']
+            else 
+                @dont_exist[:package_info] = true
+            end
+            if not @actions.is_a?(Hash)
+                @actions = {}
+                @dont_exist[:actions] = true
+            end
+            
+            @run = @actions['(run)']
+            if not @run.is_a?(String)
+                @dont_exist[:run_action] = true
+            end
+        end
+    end
+    
+    def run(arguments)
+        self.ensure_package_info()
+        # if it exists, run it
+        if @run.is_a?(String)
+            FS.in_dir(self.cache_location) do
+                system(@run + Console.make_arguments_appendable(arguments))
+                return $?.success?
+            end
+        # if not, explain why not
+        else
+            custom_message = <<-HEREDOC.remove_indent
+            
+                When trying 
+                    to perform the #{"run".color_as :code} action
+                    on the #{self.simple_name.to_s.color_as :key_term} module
+                    with these arguments: #{arguments.inspect.to_s.color_as :argument}
                 
-                # throw error for command not being runable
-                raise <<-HEREDOC.remove_indent
-                    
+                There was an issue because:
+            HEREDOC
+            
+            # FUTURE: make a more standardized error reporting tool and it that here
+            
+            good = ->(message) do
+                "    ✓ #{message.color_as :good}"
+            end
+            bad = ->(message) do
+                "    ✖ #{message.color_as :bad}"
+            end
+            
+            if @dont_exist[:yaml_file]
+                custom_message += <<-HEREDOC.remove_indent
+                    #{bad("there was no info.yaml for that package")}
+                    and an info.yaml is the location for defining a run action 
                     
-                    #{custom_message}
+                HEREDOC
+            elsif @dont_exist[:correctly_formatted_yaml_file]
+                custom_message += <<-HEREDOC.remove_indent
+                    #{good("there was a info.yaml for that package")}
+                    #{bad("the info.yaml is not parseable")}
+                    and an info.yaml is the location for defining a run action
                     
-                    For the repository to be runnable
-                    1. There needs to be an #{"info.yaml".blue}
-                    2. The info.yaml needs to be in the root directory/folder
-                    3. It needs to contain:
-                    #{"
-                    (installer):
-                        (commands):
-                            (run): \"a commandline command\"
-                    ".blue}
+                HEREDOC
+            elsif @dont_exist[:using_atk_version]
+                custom_message += <<-HEREDOC.remove_indent
+                    #{good("there was a info.yaml for that package")}
+                    #{good("the info.yaml was parseable")}
+                    #{@dont_exist[:using_atk_version] && bad("the info.yaml didn't have a (using_atk_version) key")}
+                    #{@dont_exist[:package_info]      && bad("the info.yaml didn't have a (package_info) key")}
+                    #{@dont_exist[:actions]           && bad("the info.yaml didn't have a (package_info): (actions) key")}
+                    #{@dont_exist[:run_action]        && bad("the info.yaml didn't have a (package_info): (actions): (run) key")}
                 HEREDOC
             end
+            
+            raise <<-HEREDOC.remove_indent
+                
+                
+                #{custom_message}
+                
+                This is almost certainly a problem with the package
+                Please contact the maintainer of #{self.simple_name}
+                and let them know about the above issue
+            HEREDOC
         end
     end
 end

data/lib/atk/autocomplete.rb

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

data/lib/atk/commands/project.rb

@@ -2,70 +2,91 @@ require_relative '../atk_info'
 
 module Atk
     def self.project(args)
-        # TODO: check to make sure project exists
+        # 
+        # no arguments
+        # 
         if args.length == 0
-            puts "if you don't know how to use #{"project".blue} just run #{"project help".blue}"
+            begin
+                info = Info.new
+            rescue Info::YamlFileDoesntExist => exception
+                puts <<-HEREDOC.remove_indent
+                    
+                    It appears there is no #{"info.yaml".color_as :code} file
+                    Meaning you're probably not in folder that contains a project
+                    
+                    To convert the current folder into a project folder run:
+                        #{"project init".color_as :code}
+                    
+                    If you don't know how to use #{"project".color_as :code} just run #{"project help".color_as :code}
+                HEREDOC
+                exit
+            end
+            puts "If you don't know how to use #{"project".color_as :code} just run #{"project help".color_as :code}"
             puts ""
             # if there are commands then show them
-            commands = Info.commands
+            commands = info.commands
             if commands.is_a?(Hash) && commands.keys.size > 0
                 puts "commands for current project:"
                 puts `project commands`
             end
         else
-            # 
-            # Check dependencies
-            # 
-                # if they're not met, then warn the user about that
-                # check a hash of the file to see if anything has changed
             case args[0]
+                # 
+                # help
+                # 
                 when 'help', '--help', '-h'
                     puts <<-HEREDOC.remove_indent
-                        #{"help".yellow}
-                            #{"info:".green} displays the avalible tools
-                            #{"examples:".green} #{'project help'.blue}
+                        #{"help".color_as :key_term}
+                            #{"info:".color_as :title} displays the avalible tools
+                            #{"examples:".color_as :title} #{'project help'.color_as :code}
                         
-                        #{"initialize".yellow}
-                            #{"examples:".green}
-                                #{'project init'.blue}
-                                #{'project initialize'.blue}
-                            #{"info:".green}
+                        #{"initialize".color_as :key_term}
+                            #{"examples:".color_as :title}
+                                #{'project init'.color_as :code}
+                                #{'project initialize'.color_as :code}
+                            #{"info:".color_as :title}
                                 This will create an info.yaml in your current directory
                                 The info.yaml will contain all the standard project managment tools
                                 In the future this command will be more interactive
 
-                        #{"synchronize".yellow}
-                            #{"examples:".green}
-                                #{'project sync'.blue}
-                                #{'project synchronize'.blue}
-                                #{'project synchronize --message=\'updated the readme\''.blue}
-                            #{"info:".green}
+                        #{"synchronize".color_as :key_term}
+                            #{"examples:".color_as :title}
+                                #{'project sync'.color_as :code}
+                                #{'project synchronize'.color_as :code}
+                                #{'project synchronize --message=\'updated the readme\''.color_as :code}
+                            #{"info:".color_as :title}
                                 Adds, commits, and then pulls/pushes all git changes
                                 If there is merge conflict, it will show up as normal
-                            #{"format:".green}
-                                #{"project".blue} #{"synchronize".yellow} #{"<package>".cyan} #{"--message='your message'".light_magenta}
+                            #{"format:".color_as :title}
+                                #{"project".color_as :code} #{"synchronize".color_as :key_term} #{"<package>".color_as :argument} #{"--message='your message'".color_as :optional}
                         
-                        #{"execute".yellow} 
-                            #{"examples:".green}
-                                #{'project execute compile'.blue}
-                                #{'project exec compile'.blue}
-                                #{'project exec main'.blue}
-                                #{'project exec server'.blue}
-                            #{"info:".green}
+                        #{"execute".color_as :key_term} 
+                            #{"examples:".color_as :title}
+                                #{'project execute compile'.color_as :code}
+                                #{'project exec compile'.color_as :code}
+                                #{'project exec main'.color_as :code}
+                                #{'project exec server'.color_as :code}
+                            #{"info:".color_as :title}
                                 This will look at the info.yaml file in your project to find commands
                                 You can use the `project init` command to generate an info.yaml which 
                                 has example commands. Commands can be CMD/terminal/console commands, or ruby code.
-                            #{"format:".green}
-                                #{"project".blue} #{"execute".yellow} #{"<name-of-command>".cyan} #{"<arg1-for-command>".light_magenta} #{"<arg2-for-command>".light_magenta} #{"<...etc>".light_magenta}
+                            #{"format:".color_as :title}
+                                #{"project".color_as :code} #{"execute".color_as :key_term} #{"<name-of-command>".color_as :argument} #{"<arg1-for-command>".color_as :optional} #{"<arg2-for-command>".color_as :optional} #{"<...etc>".color_as :optional}
 
-                        #{"commands".yellow}
-                            #{"examples:".green} #{'project commands'.blue}
-                            #{"info:".green}
+                        #{"commands".color_as :key_term}
+                            #{"examples:".color_as :title} #{'project commands'.color_as :code}
+                            #{"info:".color_as :title}
                                 This will read the local info.yaml of your project to find commands
                                 then it will list out each command with a short preview of the contents of that command
                     HEREDOC
+                # 
+                # init
+                # 
                 when 'initialize', 'init'
                     Info.init
+                # 
+                # sync
+                # 
                 when 'synchronize', 'sync'
                     # if there is an argument
                     git_folder_path = FS.dirname(Info.path)/".git"
@@ -103,35 +124,13 @@ module Atk
                     system('git pull --no-edit')
                     # push up everything
                     system('git push')
-                    
-                when 'mix'
-                    not_yet_implemented()
-                    structure_name = args[1]
-                    # use this to mix a structure into the project
-                    # TODO:
-                    # get the context
-                        # if there is a --context='something' command line option, then use that
-                        # otherwise use the default(--context) speficied in the info.yaml
-                        # re-iterate through the info.yaml (advanced_setup) keys
-                        # find all of the "when(--context = 'something')" keys
-                        # find the (dependencies) sub-key for them, create one if the key doesn't exist
-                        # add the project and version to the 
-                when 'add'
-                    not_yet_implemented()
-                    package = args[1]
-                    # check if there is an info.yaml
-                    # check if there is an local_package_manager in the info.yaml
-                    # if there is only 1, then use it
-                    # if there is more than one, ask which one the user wants to use
-                when 'remove'
-                    not_yet_implemented()
-                    package = args[1]
-                    # check if there is an local_package_manager in the info.yaml
-                    # if it does use it to remove the package
+                # 
+                # execute
+                # 
                 when 'execute', 'exec'
                     # extract the (project_commands) section from the info.yaml, 
                     # then find the command with the same name as args[1] and run it
-                    # TODO: use https://github.com/piotrmurach/tty-markdown#ttymarkdown- to highlight the ruby code 
+                    # FUTURE: use https://github.com/piotrmurach/tty-markdown#ttymarkdown- to highlight the ruby code 
                     _, command_name, *command_args = args
                     command = Info.commands[command_name]
                     # temporairly set the dir to be the same as the info.yaml 
@@ -144,16 +143,22 @@ module Atk
                             puts "I don't think that command is in the info.yaml file"
                         end
                     end
+                # 
+                # commands
+                # 
                 when 'commands'
                     max_number_of_chars_to_show = 80
                     commands = Info.commands
                     if commands.keys.size == 0
-                        puts "0 avalible commands".cyan
+                        puts "0 avalible commands".color_as :message
                     else
                         for each_key, each_value in commands
-                            puts "    #{each_key.to_s.yellow}: #{each_value.to_s.strip[0..max_number_of_chars_to_show].sub(/(.*)[\s\S]*/,'\1')}"
+                            puts "    #{each_key.to_s.color_as :key_term}: #{each_value.to_s.strip[0..max_number_of_chars_to_show].sub(/(.*)[\s\S]*/,'\1')}"
                         end
                     end
+                # 
+                # unrecognized
+                # 
                 else
                     puts "I don't recognized that command\nhere's the `project --help` which might get you what you're looking for:"
                     Atk.project(["help"])