atk_toolbox 0.0.106 → 0.0.107

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92a0b43317388c1747b105aa93b15f70a20c829ad86d439120300c8604856284
-  data.tar.gz: 2ce1e06771e1b7cc4900269f5275ba87f32f7ca4d8afb93a236a64ba293ab36a
+  metadata.gz: 4e9e896c1f401e8b333baeaed5ab2f4f437a8a2201cede3d94932b1eb73fe139
+  data.tar.gz: 0a08f89770bf3115820d63a19670d903eef053455d5970770a5f21c361554c79
 SHA512:
-  metadata.gz: 24a92ce26535d23bbe3b38cad85d7d2b72fcab80af72d33fd6c9d1bda2471ee4ae0e1e0f1531cebb6f1ab22ce89448aeb928125f4940b65f3218bdc1d72f885c
-  data.tar.gz: 672dcb0e0bd74af7dac51904f298fa85ceb67a7297135b3ea0d0d78c2b091904481655c83a8ccf96187c2500887c088a45c06bf090b85c1c31e2f94e17a093ef
+  metadata.gz: 11a4ab36e04ac6fadaa8305400d70fc94412798abf2898d6ee724405dd2b21c32d1289e6703dba73441fc41305c200bcb534b94eb645bdc2eef43eae9f92931f
+  data.tar.gz: d5fa4fde8e79e2cb8b3e13fff7df7f75c7ba679a47da5fce87c8479cd9aebc188c546207c5700e555e0ff61dad7bf48800be752af1a65b68073bf15cb490d856

data/lib/atk/atk_info.rb

@@ -17,7 +17,7 @@ class AtkPaths
             when 'info'
                 return HOME/"info.yaml"
             when 'ruby'
-                atk_path_settings = ATK.info["paths"]
+                atk_path_settings = Atk.info["paths"]
                 if atk_path_settings.is_a?(Hash) and atk_path_settings["ruby"].is_a?(String)
                     ruby_path = atk_path_settings["ruby"]
                 elsif OS.is?(:mac)
@@ -38,18 +38,25 @@ class AtkPaths
                 return HOME/"atk"/"installers.yaml"
             when 'installers_folder'
                 return HOME/"atk"/"installers"
+            when 'repos'
+                return HOME/"atk"/"repos"
         end
     end
 end
 
-module ATK
+module Atk
     @@atk_settings_key = "atk_settings"
+    def self.version
+        require_relative '../atk_toolbox/version.rb'
+        return AtkToolbox::VERSION
+    end
+    
     def self.paths
         return AtkPaths
     end
     
     def self.temp_path(filename)
-        new_path = ATK.paths[:temp]/filename
+        new_path = Atk.paths[:temp]/filename
         # make sure the path is empty
         FS.write("", to: new_path)
         FS.delete(new_path)
@@ -57,7 +64,7 @@ module ATK
     end
     
     def self.info
-        settings_path = ATK.paths[:info]
+        settings_path = Atk.paths[:info]
         # if it doesn't exist then create it
         if not FS.exist?(settings_path)
             FS.write("#{@@atk_settings_key}: {}", to: settings_path)
@@ -75,59 +82,23 @@ module ATK
     end
     
     def self.save_info(new_hash)
-        settings_path = ATK.paths[:info]
-        current_settings = ATK.info
+        settings_path = Atk.paths[:info]
+        current_settings = Atk.info
         updated_settings = current_settings.merge(new_hash)
         
-        info_data = YAML.load_file(ATK.paths[:info])
+        info_data = YAML.load_file(Atk.paths[:info])
         if info_file.is_a?(Hash)
             info_data[@@atk_settings_key] = updated_settings
         else
             info_data = { @@atk_settings_key => updated_settings }
         end
         
-        FS.save(info_data, to: ATK.paths[:info], as: :yaml )
-    end
-    
-    def self.simplify_package_name(source)
-        source = source.strip
-        # if its starts with "atk/", just remove that part
-        source = source.sub( /^atk\//, "" )
-        # if it starts with "https://github.com/", just remove that part
-        source = source.sub( /^https:\/\/github.com\//, "" )
-        return source
-    end
-    
-    def self.package_name_to_url(package_name)
-        # if its starts with "atk/", just remove that part
-        package_name = ATK.simplify_package_name(package_name)
-        # if the package name does not have a slash in it, then assume it is a core / approved installer
-        if not (package_name =~ /.*\/.*/) 
-            # TODO: turn this into a check for is_core_repo?(package_name)
-            # path_to_core_listing = ATK.paths[:core_yaml]
-            # core = YAML.load_file(path_to_core_listing)
-            # if core[package_name] == nil
-            #     puts "I don't see that package in the core, let me make sure I have the latest info"
-            #     download("https://raw.githubusercontent.com/aggie-tool-kit/atk/master/interface/core.yaml", as: path_to_core_listing)
-            #     core = YAML.load_file(path_to_core_listing)
-            # end
-            # if core[package_name] != nil
-            #     repo_url = core[package_name]["source"]
-            # else
-                raise "That package doesn't seem to be a core package"
-            # end
-         # if it does have a slash, and isn't a full url, then assume its a github repo
-        elsif not package_name.start_with?(/https?:\/\//)
-            repo_url = "https://github.com/"+package_name
-        else
-            repo_url = package_name
-        end
-        return repo_url
+        FS.save(info_data, to: Atk.paths[:info], as: :yaml )
     end
     
     def self.setup(package_name, arguments)
-        repo_url = ATK.package_name_to_url(package_name)
-        project_folder = ATK.info["project_folder"]
+        repo_url = AtkPackage.new(package_name).url
+        project_folder = Atk.info["project_folder"]
         # if there's no project folder
         if not project_folder
             # then use the current folder
@@ -147,11 +118,7 @@ module ATK
                 if setup_command.is_a?(Code)
                     setup_command.run(arguments)
                 else
-                    safe_arguments = arguments.map do |each|
-                        "'"+Console.single_quote_escape(each)+"'"
-                    end
-                    console_line = setup_command+' '+(safe_arguments.join(' '))
-                    system(console_line)
+                    system(setup_command + Console.make_arguments_appendable(arguments))
                 end
             end
             puts "\n\n\n\n============================================================"
@@ -162,7 +129,145 @@ module ATK
         end
     end
     
-    def not_yet_implemented()
+    def self.run(package_name, arguments=[])
+        the_package = AtkPackage.new(package_name)
+        the_package.run(arguments)
+    end
+    
+    def self.not_yet_implemented()
         puts "Sorry, this feature is still under development"
     end
+end
+
+
+
+class AtkPackage
+    def initialize(package_name)
+        @init_name = package_name
+    end
+    
+    def simple_name
+        if @simple_name == nil
+            source = @init_name.strip
+            # if its starts with "atk/", just remove that part
+            source = source.sub( /^atk\//, "" )
+            # if it starts with "https://github.com/", just remove that part
+            @simple_name = source.sub( /^https:\/\/github.com\//, "" )
+        end
+        return @simple_name
+    end
+    
+    def url
+        if @url == nil
+            simple_name = self.simple_name()
+            # if the package name does not have a slash in it, then assume it is a core / approved installer
+            if not (simple_name =~ /.*\/.*/) 
+                # TODO: turn this into a check for is_core_repo?(package_name)
+                # path_to_core_listing = Atk.paths[:core_yaml]
+                # core = YAML.load_file(path_to_core_listing)
+                # if core[package_name] == nil
+                #     puts "I don't see that package in the core, let me make sure I have the latest info"
+                #     download("https://raw.githubusercontent.com/aggie-tool-kit/atk/master/interface/core.yaml", as: path_to_core_listing)
+                #     core = YAML.load_file(path_to_core_listing)
+                # end
+                # if core[package_name] != nil
+                #     repo_url = core[package_name]["source"]
+                # else
+                    raise "That package #{@init_name} doesn't seem to be a core package"
+                # end
+            # if it does have a slash, and isn't a full url, then assume its a github repo
+            elsif not simple_name.start_with?(/https?:\/\//)
+                repo_url = "https://github.com/"+simple_name
+            else
+                repo_url = simple_name
+            end
+            @url = repo_url
+        end
+        return @url
+    end
+    
+    def cache_name()
+        if @cache_name == nil
+            repo_url = self.url()
+            require 'digest'
+            repo_hash = Digest::MD5.hexdigest(repo_url)
+            repo_name = Git.repo_name(repo_url)
+            @cache_name = repo_name+"_"+repo_hash
+        end
+        return @cache_name
+    end
+    
+    def cache_location()
+        if @cache_location == nil
+            @cache_location = Atk.paths['repos']/self.cache_name
+        end
+        return @cache_location
+    end
+    
+    def ensure_cached()
+        if @is_cached == nil
+            Git.ensure_cloned_and_up_to_date(self.cache_location, self.url)
+            @is_cached = true
+        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
+                    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["(installer)"] == nil
+                                custom_message = "✖ there wasn't an (installer) key with a run command".red
+                            end
+                        end
+                    end
+                end
+                
+                # throw error for command not being runable
+                raise <<-HEREDOC.remove_indent
+                    
+                    
+                    #{custom_message}
+                    
+                    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
+            end
+        end
+    end
 end

data/lib/atk/commands/project.rb

@@ -1,6 +1,6 @@
 require_relative '../atk_info'
 
-module ATK
+module Atk
     def self.project(args)
         # TODO: check to make sure project exists
         if args.length == 0
@@ -159,7 +159,7 @@ module ATK
                     end
                 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"])
+                    Atk.project(["help"])
             end
         end
     end

data/lib/atk/console.rb

@@ -61,6 +61,14 @@ class TTY::Prompt
     def single_quote_escape(string)
         string.gsub(/'/, "'\"'\"'")
     end
+    
+    def make_arguments_appendable(arguments)
+        # TODO: make sure this works on windows
+        safe_arguments = arguments.map do |each|
+            " '"+Console.single_quote_escape(each)+"'"
+        end
+        return safe_arguments.join('')
+    end
 end
 
 Console = TTY::Prompt.new

data/lib/atk/file_sys.rb

@@ -200,7 +200,7 @@ module FileSys
     
     def self.path_pieces(path)
         # use this function like this:
-        # *path, filename, extension = FS.path_peices('/Users/jeffhykin/Desktop/place1/file1.pdf')
+        # *path, filename, extension = FS.path_pieces('/Users/jeffhykin/Desktop/place1/file1.pdf')
         pieces = Pathname(path).each_filename.to_a
         extname = File.extname(pieces[-1])
         basebasename = pieces[-1][0...(pieces[-1].size - extname.size)]

data/lib/atk/git.rb

@@ -18,4 +18,10 @@ module Git
         # TODO: make this a force pull
         git_repo.pull
     end
+    
+    def self.repo_name(url)
+        require_relative './file_sys'
+        *folders, name, extension = FS.path_pieces('https://stackoverflow.com/questions/19072070/how-to-find-where-gem-files-are-installed')
+        return name
+    end
 end

data/lib/atk/set_command.rb

@@ -12,9 +12,9 @@ class TTY::Prompt
     def set_command(name, code)
         if OS.is?("unix")
             exec_path = "/usr/local/bin/#{name}"
-            local_place = ATK.temp_path(name)
+            local_place = Atk.temp_path(name)
             # add the hash bang
-            hash_bang = "#!#{ATK.paths[:ruby]}\n"
+            hash_bang = "#!#{Atk.paths[:ruby]}\n"
             # create the file
             FS.write(hash_bang+code, to: local_place)
             # copy to command folder

data/lib/atk/yaml_info_parser.rb

@@ -239,22 +239,22 @@ class Info
                     HEREDOC
                 end
             rescue => exception
-                puts "\n\nI'm having trouble loading the info.yaml file. Here's the error:\n"
+                puts "\n\nI'm having trouble loading the info.yaml file. Here's the error:\n".red
                 raise exception
             end
         else
-            raise "\n\nCouldn't find an info.yaml file in #{Dir.pwd}"
+            raise "\n\nCouldn't find an info.yaml file in #{Dir.pwd}".red
         end
         @@project = @@data['(project)']
         if @@project == nil
             # TODO: maybe change this to be optional in the future and have default settings
-            raise "\n\nThere is no (project): key in the info.yaml\n(so ATK is unable to parse the project settings)"
+            raise "\n\nThere is no (project): key in the info.yaml\n(so ATK is unable to parse the project settings)".red
         end
         
         @@settings = @@project['(advanced_setup)']
         if @@settings == nil
             # TODO: maybe change this to be optional in the future and have default settings
-            raise "\n\nThere is no (advanced_setup): key in the (project) of the info.yaml\n(so ATK is unable to parse the project settings)"
+            raise "\n\nThere is no (advanced_setup): key in the (project) of the info.yaml\n(so ATK is unable to parse the project settings)".red
         end
         Info.parse_advanced_setup(@@settings, @@settings)
         @@dependencies               = @@settings['(dependencies)']
@@ -309,7 +309,7 @@ class Info
         loop do
             # if all folders exhausted
             if folders.size == 0
-                raise <<-HEREDOC.remove_indent
+                raise <<-HEREDOC.remove_indent.red
                     
                     Couldn't find an info.yaml in the current directory or any parent directory
                         #{Dir.pwd}

data/lib/atk_toolbox/version.rb

@@ -1,3 +1,3 @@
 module AtkToolbox
-    VERSION = '0.0.106'
+    VERSION = '0.0.107'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atk_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.0.106
+  version: 0.0.107
 platform: ruby
 authors:
 - Jeff Hykin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-07 00:00:00.000000000 Z
+date: 2019-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zip
@@ -105,7 +105,6 @@ files:
 - lib/atk/git.rb
 - lib/atk/online.rb
 - lib/atk/os.rb
-- lib/atk/output.rb
 - lib/atk/package_managers.rb
 - lib/atk/remove_indent.rb
 - lib/atk/set_command.rb

data/lib/atk/output.rb

@@ -1,5 +0,0 @@
-# Functions to be used for consistent output to the user
-
-module ATKIO
-
-end