atk_toolbox 0.0.39 → 0.0.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7615bfcaffd4148abbaa23fea5e6dc9b367b5db9b9b4a415b150f6202e88546c
-  data.tar.gz: 51abc23807c65959dde210760d4657c2a4f342cf0a279696839904c5afb36f75
+  metadata.gz: f6eb32f46498701aef8e52e4e8e5ec4e8ae3a9d324d8bd2e56a83862b4d00280
+  data.tar.gz: dab81fc0056d18ad4e623999d5aed82dc3b5db27bc03a92ec0effd05a930a40e
 SHA512:
-  metadata.gz: abb86efc828b1c189f4d0087b9f6464aa156782e52ba78142458e0d8e374104a122f49bf37cdb5e00a649f037d5ce0365fa342d62d0d1c1b2ad393a787698327
-  data.tar.gz: 9910cce97aa11febd1dccee9420be1f2d16b848c1ccbf510042e81047d024ab30e9eb0499d4d3a0b5f5a9ffe604ad9103450f0ec1d9960d19576a360dea181e5
+  metadata.gz: 0c8f3af5288138909110c4ba4ddf16491578692c89bae75dcf97f54677d7d08374be6efe87a52f79cd2d4572f5cb74cfd1e62610cd150bed28fc0bf862b4cc84
+  data.tar.gz: 80d565ce037a4b369c4c25191a15132f88ad2beed8155389cbd1a59d09e2a8e094dc722518e039f47e42ba22442d2299587562410a8eef57cd133178f5f9d793

data/lib/atk/atk_info.rb

@@ -0,0 +1,64 @@
+require_relative './extra_file_utils'
+require_relative './os'
+require 'yaml'
+
+class AtkPaths
+    def self.[](name)
+        # convert symbols to strings
+        name = name.to_s
+        case name
+            when 'atk'
+                return HOME/"atk"
+            when 'temp'
+                return self['atk']/"temp"
+            when 'info'
+                return HOME/"info.yaml"
+            when 'ruby'
+                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?(:unix)
+                    ruby_path = "/usr/bin/ruby"
+                else
+                    # TODO: fix this case
+                    ruby_path = ""
+                end
+                return ruby_path
+        end
+    end
+end
+
+module ATK
+    def self.paths
+        return AtkPaths
+    end
+    
+    def self.temp_path(filepath)
+        new_path = ATK.paths[:temp]/filepath
+        # make sure the path is empty
+        begin
+            File.delete(new_path)
+        end
+        return new_path
+    end
+    
+    def self.info
+        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}: {}")
+            return {}
+        else
+            data = YAML.load_file(settings_path)
+            if data.is_a?(Hash)
+                if data[atk_settings_key].is_a?(Hash)
+                    puts "data[atk_settings_key] is: #{data[atk_settings_key]} "
+                    return data[atk_settings_key]
+                end
+            else
+                return {}
+            end
+        end
+    end
+end

data/lib/atk/extra_yaml.rb

@@ -0,0 +1,155 @@
+require_relative './os'
+require_relative './remove_indent'
+require_relative './version'
+require 'json'
+require 'yaml'
+
+# how the new parser should work
+    # turn every meaninful peice of the yaml file into data that is represented in ruby
+        # reference objects instead of actually replacing the reference with the value
+        # reference insertion keys instead of actually performing the <<:
+        # save the style data (like 0x00 vs 0) to every peice of data
+        # save whether or not the data must be single-line 
+    # tokenize the yaml recursively with the base case of scalar values
+        # HARD: detect when values must be single-line or multiline
+            # non-complex keys are single-line
+            # anything inside of a JSON-like list or array must be single line
+            # everything else I know of can be multiline
+    # have both an inline and multiline conversion function for every data type
+    # when changing data, convert the new data into a single-line or multiline form based on the parent token
+        # if multiline, add the correct amount of indentation
+
+# 
+# 
+# JSON method
+# 
+# 
+    # example:
+        # doc = <<-HEREDOC
+        # (dependencies):
+        #     python: 3.6.7
+        #     gcc: 8.0.0
+        # HEREDOC
+        # document = YamlEdit.new(string:doc)
+        # document["(dependencies)"]["python"].replace_value_with(value: "200")
+        # puts document.string
+        # # creates:
+        # doc = <<-HEREDOC
+        # (dependencies):
+        #     python: "200"
+        #     gcc: 8.0.0
+        # HEREDOC
+
+def inject_string(string, middle_part, start_line, start_column, end_line, end_column)
+    lines = string.split("\n")
+    untouched_begining_lines = lines[0...start_line]
+    untouched_ending_lines   = lines[end_line+1..-1]
+    middle_lines = []
+
+    before_part = lines[start_line][0...start_column]
+    after_part = lines[end_line][end_column..-1]
+
+    return (untouched_begining_lines + [ before_part + middle_part + after_part ] + untouched_ending_lines).join("\n")
+end
+
+class YamlEdit
+    attr_accessor :string
+    
+    def initialize(string:nil, file:nil)
+        self.init(string:string, file: file)
+    end
+    
+    def init(string:nil, file:nil)
+        if string == nil
+            string = IO.read(file)
+        end
+        @root_node = YAML.parse(string).children[0]
+        @string = string
+        self.attach_to_all_children(@root_node, self)
+    end
+    
+    def attach_to_all_children(node, original_document)
+        if node.respond_to?(:children)
+            if node.children.is_a?(Array)
+                for each in node.children
+                    self.attach_to_all_children(each, original_document)
+                end
+            end
+        end
+        node.document = original_document
+    end
+    
+    def [](key)
+        return @root_node[key]
+    end
+    
+    def save_to(file)
+        IO.write(file, @string)
+    end
+end
+
+class Psych::Nodes::Node
+    attr_accessor :document
+    def anchor_and_tag(anchor:nil, tag:nil)
+        anchor = @anchor if anchor == nil 
+        tag = @tag if tag == nil 
+        
+        string = ""
+        if anchor
+            string += "&#{anchor} "
+        end
+        
+        if tag
+            string += "!#{tag} "
+        end
+        return string
+    end
+    
+    # saving this for later once the JSON method can be replaced
+    def indent_level
+        if self.respond_to?(:children)
+            if self.children.size > 0
+                return self.children[0].start_column
+            end
+        end
+        return 4 + self.start_column
+    end
+    
+    def [](key)
+        previous = nil
+        # for seq
+        if key.is_a?(Integer)
+            return self.children[key]
+        end
+        # for maps
+        for each in self.children.reverse
+            if each.respond_to?(:value) && each.value == key
+                return previous
+            end
+            previous = each
+        end
+    end
+    
+    def replace_value_with(value:nil, literal:nil, anchor: nil, tag:nil)
+        # check version
+        if VERSION_OF_RUBY < "2.5.0"
+            raise "\n\nSomewhere, replace_value_with() is being called, which is related to editing yaml\nthe problem is this function needs ruby >= 2.5.0\nbut the code is being run with ruby #{RUBY_VERSION}"
+        end
+        
+        if literal == nil
+            new_value = value.to_json
+        else
+            new_value = literal
+        end
+        middle_part = self.anchor_and_tag(anchor:anchor, tag:tag) + new_value
+        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

data/lib/atk/set_command.rb

@@ -1,18 +1,20 @@
-require 'method_source'
 require_relative './extra_file_utils'
 require_relative './os'
+require_relative './atk_info'
 
 def set_command(name, code)
     if OS.is?("unix")
         exec_path = "/usr/local/bin/#{name}"
-        local_place = HOME/"atk"/"temp"/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, "#!/usr/bin/ruby\n"+code)
+        IO.write(local_place, hash_bang+code)
         # copy to command folder
         system("sudo", "cp", local_place, exec_path)
-        system("sudo", "chmod", "o+x", exec_path)
+        system("sudo", "chmod", "ugo+x", exec_path)
     elsif OS.is?("windows")
         username = `powershell -command "echo $env:UserName"`.chomp
         exec_path = "C:\\Users\\#{username}\\AppData\\local\\Microsoft\\WindowsApps\\#{name}"
@@ -23,3 +25,5 @@ def set_command(name, code)
         IO.write(exec_path+".bat", "@echo off\nruby \"#{exec_path}.rb\" %*")
     end
 end
+
+puts ATK.paths[:ruby]

data/lib/atk/version.rb

@@ -0,0 +1,39 @@
+# create a variable for the current ruby version
+
+class Version
+    attr_accessor :major, :minor, :patch
+    
+    def initialize(version_as_string)
+        # TODO: make this more safe/better error handling
+        @major, @minor, @patch = version_as_string.split('.').map{|each| each.to_i}
+        @as_string = version_as_string
+    end
+    
+    def <=>(other_version)
+        if not other_version.is_a?(Version)
+            raise "When doing version comparision, both sides must be a version object"
+        end
+        major_size = (@major <=> other_version.major * 100)
+        minor_size = (@minor <=> other_version.minor * 10 )
+        patch_size = (@patch <=> other_version.patch * 1 )
+        return (major_size + minor_size + patch_size) <=> 0
+    end
+    
+    def >(other_version)
+        return (self <=> other_version) == 1
+    end
+    
+    def <(other_version)
+        return (self <=> other_version) == -1
+    end
+    
+    def ==(other_version)
+        return (self <=> other_version) == 0
+    end
+    
+    def to_s
+        @as_string
+    end
+end
+
+VERSION_OF_RUBY = Version.new(RUBY_VERSION)

data/lib/atk/yaml_info_parser.rb

@@ -3,7 +3,7 @@ require "yaml"
 require_relative './cmd'
 require_relative './os'
 require_relative './extra_file_utils'
-require_relative '../yaml_edit/yaml_edit.rb'
+require_relative './extra_yaml'
 require 'fileutils'
 
 # 
@@ -262,14 +262,4 @@ class Info
     def self.source_path()
         return "."/"info.yaml"
     end
-    
-    def self.set_key(key_list, new_value)
-        path = Info.source_path
-        IO.write(path, YAML.set_key(IO.read(path), key_list, new_value))
-    end
-    
-    def self.remove_key(key_list, new_value)
-        path = Info.source_path
-        IO.write(path, YAML.remove_key(IO.read(path), key_list))
-    end
 end

data/lib/atk_toolbox/version.rb

@@ -1,3 +1,3 @@
 module AtkToolbox
-  VERSION = '0.0.39'
+  VERSION = '0.0.40'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atk_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.0.39
+  version: 0.0.40
 platform: ruby
 authors:
 - Jeff Hykin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-02 00:00:00.000000000 Z
+date: 2019-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zip
@@ -50,36 +50,18 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
-- !ruby/object:Gem::Dependency
-  name: method_source
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.2
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.2
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.2
 description: ''
 email: jeff.hykin@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 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
 - lib/atk/online.rb
 - lib/atk/os.rb
@@ -87,13 +69,11 @@ files:
 - lib/atk/package_managers.rb
 - lib/atk/remove_indent.rb
 - lib/atk/set_command.rb
+- lib/atk/version.rb
 - lib/atk/yaml_info_parser.rb
 - lib/atk/zip.rb
 - lib/atk_toolbox.rb
 - lib/atk_toolbox/version.rb
-- lib/yaml_edit/remove_key.py
-- lib/yaml_edit/set_key.py
-- lib/yaml_edit/yaml_edit.rb
 - test/info.yaml
 - test/main.rb
 homepage: http://github.com//atk-toolbox
@@ -116,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: The Ruby gem for all the standard tools ATK uses internally

data/lib/yaml_edit/remove_key.py

@@ -1,29 +0,0 @@
-import ruamel.yaml
-import json
-import sys
-
-yaml_string   = sys.argv[1]
-json_key_list = sys.argv[2]
-
-# a tool from https://stackoverflow.com/questions/14692690/access-nested-dictionary-path-via-a-list-of-keys
-from functools import reduce  # forward compatibility for Python 3
-import operator
-def get_by_path(data, path):
-    """Access a nested object in data by item sequence."""
-    return reduce(operator.getitem, path, data)
-
-def set_by_path(data, path, value):
-    """Set a value in a nested object in data by item sequence."""
-    get_by_path(data, path[:-1])[path[-1]] = value
-
-
-# parse the yaml
-data = ruamel.yaml.round_trip_load(yaml_string)
-# parse the path
-path_to_element = json.loads(json_key_list)
-# get the parent element
-path_element = get_by_path(data, path_to_element[:-1])
-# remove the key
-del path_element[path_to_element[-1]]
-# output the data
-print(ruamel.yaml.round_trip_dump(data))

data/lib/yaml_edit/set_key.py

@@ -1,45 +0,0 @@
-import ruamel.yaml
-import regex as re
-import json
-import sys
-
-yaml_string   = sys.argv[1]
-json_key_list = sys.argv[2]
-new_key_value = sys.argv[3]
-
-
-# a tool from https://stackoverflow.com/questions/14692690/access-nested-dictionary-path-via-a-list-of-keys
-from functools import reduce  # forward compatibility for Python 3
-import operator
-def get_by_path(data, path):
-    """Access a nested object in data by item sequence."""
-    return reduce(operator.getitem, path, data)
-
-def set_by_path(data, path, value):
-    """Set a value in a nested object in data by item sequence."""
-    get_by_path(data, path[:-1])[path[-1]] = value
-
-# detect the indent
-indent_match = re.search(r'^ +', yaml_string, flags=re.MULTILINE)
-if indent_match == None:
-    indent = 4
-else:
-    indent = len(indent_match[0])
-
-
-
-# parse the yaml
-data = ruamel.yaml.round_trip_load(yaml_string)
-# parse the path
-path_to_element = json.loads(json_key_list)
-# parse the new value
-new_value = json.loads(new_key_value)
-# set the value
-set_by_path(data, path_to_element, new_value)
-# output the data
-yaml = ruamel.yaml.YAML()
-yaml.indent(mapping=4, sequence=4, offset=2)
-yaml.width = float("Infinity")
-yaml.default_flow_style = False
-yaml.dump(data, sys.stdout)
-# print(ruamel.yaml.round_trip_dump(data, indent=indent, block_seq_indent=int(indent/2), width=, default_flow_style=False))

data/lib/yaml_edit/yaml_edit.rb

@@ -1,58 +0,0 @@
-require_relative '../atk/os'
-require_relative '../atk/remove_indent'
-require 'open3'
-require 'json'
-require 'yaml'
-
-def execute_with_local_python(python_file_path, *args)
-    # save the current directory
-    pwd = Dir.pwd
-    # change to where this file is
-    Dir.chdir __dir__
-    # run the python file with the virtual environment
-    stdout_str, stderr_str, status = Open3.capture3('python3', python_file_path, *args)
-    # change back to the original dir
-    Dir.chdir pwd
-    return [stdout_str, stderr_str, status]
-end
-
-module YAML
-    def set_key(yaml_string, key_list, new_value)
-        if not key_list.is_a?(Array)
-            raise "when using YAML.set_key, the second argument needs to be a list of keys"
-        end
-        # run the python file with the virtual environment
-        stdout_str, stderr_str, status = execute_with_local_python('set_key.py', yaml_string, key_list.to_json, new_value.to_json)
-        if not status.success?
-            raise "\n\nFailed to set key in yaml file:\n#{stderr_str}"
-        end
-        return stdout_str
-    end
-
-    def remove_key(yaml_string, key_list)
-        if not key_list.is_a?(Array)
-            raise "when using YAML.remove_key, the second argument needs to be a list of keys"
-        end
-        # run the python file with the virtual environment
-        stdout_str, stderr_str, status = execute_with_local_python('remove_key.py', yaml_string, key_list.to_json)
-        if not status.success?
-            raise "\n\nFailed to remove key in yaml file:\n#{stderr_str}"
-        end
-        return stdout_str
-    end
-    module_function :remove_key, :set_key
-end
-
-# yaml_test_string = <<-HEREDOC
-# foo:
-#     a: 1
-#     b: 2
-#     list:
-#         - 1
-#         - 2
-#         - 3
-# thing:
-#     a: 10
-# HEREDOC
-# puts remove_key(yaml_test_string, ["foo", "list", 2])
-# puts set_key(yaml_test_string, ["foo", "c"], 3)