ranch-hand 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fcf2dcd9fa4d7109d4e40ee519904acde93eab7d6861444900e045d8f9e85fd
-  data.tar.gz: 579f8858997fc6d180e400d97463cf49f64a6f29084d4224108b7256a61b1708
+  metadata.gz: e00a609606b6a4c9fab740093f660f8de3b4a655cbe8d3ab23a381d6cb26be97
+  data.tar.gz: fe56f11021d0a8ed6e68231bf7096cbc06b053ee02341a7ce53d369f63d92db1
 SHA512:
-  metadata.gz: ee5fa837162469e9076186dd625bd4d8f2491836494a91d72861bc5571fba58a37719be2d8d190a948bc571e9542fb8098dd6888a5bba01073db15b25bfea78f
-  data.tar.gz: 11d3035683053d219e80d1da994b3a0ef634e07c4908344fb924c88ffe728724bd35651aa014d074e31904cdec85856c30334e475311bc803ed4f3de152f104f
+  metadata.gz: 876144c9dc6339c290eb167e6d5f9a3eb29f73b1188e210b9e362eea27b60abcb6c5f6fb881d65b98751b865b2efde82103b4b510ce0f180fec1be1a326d7cb8
+  data.tar.gz: c7ef6622566ab70f3f8765b6d4efb86c8c0380ecd80dcfd049ae1c3b5d4c5ac4a20bec5a5855bf27280fb0ad281b2b87a298e6eda3687e632c0d9206c8b2ab92

data/Changelog.md

@@ -1,3 +1,11 @@
+### 0.8.0
+- Add ability to specify a command prefix that will be added to all commands run via `ranch-hand exec` by default (peregrinator/ranch-hand/issues/8)
+- Add ability to edit the project config file via new command `ranch-hand update_config` (peregrinator/ranch-hand/issues/9)
+- Add ohmyzsh aliases for new commands
+### 0.7.1
+Add Oh My Zsh plugin to provide shortcuts, see files/ranch-hand.plugin.zsh
+Add new `ranch-hand ohmyzsh` command to install plugins
+
 ### 0.7.0
 #### Features
 Add support for command arguments. Commands that use arguments no longer need to be wrapped in a string in order to be passed properly. This provides a better interface for editor plugins that automatically append arguments to the end of a custom command.
@@ -10,4 +18,4 @@ Add support for command arguments. Commands that use arguments no longer need to
 ### 0.6.0
 
 Updates for Ruby 3.0 compat
-  - https://rubyreferences.github.io/rubychanges/3.0.html#keyword-arguments-are-now-fully-separated-from-positional-arguments
+  - https://rubyreferences.github.io/rubychanges/3.0.html#keyword-arguments-are-now-fully-separated-from-positional-arguments

data/bin/ranch-hand

@@ -30,13 +30,20 @@ module RanchHandCLI
     end
   end
 
-  desc 'Initializes ranch hand for project'
+  desc 'Initializes ranch hand for current project'
   command :init do |c|
     c.action do |global_options, command_options, args|
       RanchHand::Base.init
     end
   end
 
+  desc 'Updates ranch hand config for current project'
+  command :update_config do |c|
+    c.action do |global_options, command_options, args|
+      RanchHand::Base.update_config
+    end
+  end
+
   desc 'Execs into a running container'
   command :exec do |c|
     config = RanchHand::Config.load
@@ -44,14 +51,20 @@ module RanchHandCLI
     c.switch [:g, :group], negatable: true, default_value: config[:group] || false, desc: "Group pods returned so that there is only one from each deployment, --no-group can be used to override project config as needed."
     c.switch [:rm, :remove], negatable: false, desc: "Used to indicated that you want to remove a previously saved command."
     c.switch [:r, :repeat], negatable: false, desc: "Repeat the last command ran (against the same pod)."
+    c.switch [:sp, :skip_prefix], negatable: false, default_value: false, desc: "Do not add configured command prefix."
 
     c.flag [:c, :command], desc: "Command to run once (not permanently stored)"
     c.flag [:f, :filter], desc: "Filter pods returned to those that contain the string provided (negative matches supported). Examples: '-f nginx', '-f -apache'"
     c.flag [:n, :namespace], required: true, default_value: config[:namespace], desc: "Namespace against which to retreive pods and run command"
     c.flag [:p, :pod], default_value: config[:pod], desc: "Run command in a specific pod. If used with -g only the pod name can be specified and the command will be run against the first in the group"
 
+    default_command_options = {
+      command_prefix: config[:command_prefix],
+      prefer_ui: config[:prefer_ui]
+    }
+
     c.action do |global_options, command_options, args|
-      RanchHand::KubeCtl.new.exec(args: args, cmd_options: command_options)
+      RanchHand::KubeCtl.new.exec(args: args, cmd_options: default_command_options.merge(command_options))
     end
   end
 

data/files/ranch-hand.plugin.zsh

@@ -1,4 +1,6 @@
-alias rh='ranch-hand'         # main binary alias
-alias rhs='ranch-hand setup'  # setup ranch hand with Rancher CLI credentials
-alias rhi='ranch-hand init'   # initialize default ranch hand settings in a project
-alias rhe='ranch-hand exec'   # run a command in a container
+alias rh='ranch-hand'                       # main binary alias
+alias rhs='ranch-hand setup'                # setup ranch hand with Rancher CLI credentials
+alias rhi='ranch-hand init'                 # initialize default ranch hand settings in a project
+alias rhu='ranch-hand update_config'        # update default ranch hand settings for a project
+alias rhe='ranch-hand exec'                 # run a command in a container
+alias rhes='ranch-hand exec --skip-prefix'  # run a command in a container but skip default command_prefix

data/lib/ranch_hand/base.rb

@@ -34,5 +34,11 @@ module RanchHand
       RanchHand::Logger.info("installation complete")
       RanchHand::Logger.info("Don't forget to add 'ranch-hand' to your plugins in ~/.zshrc -- e.g. plugins=(ranch-hand) -- and then 'source ~/.zshrc'")
     end
+
+    def self.update_config
+      RanchHand::Logger.info("updating ranch-hand config for project")
+      RanchHand::Config.update
+      RanchHand::Logger.info("update complete")
+    end
   end
 end

data/lib/ranch_hand/commands.rb

@@ -10,4 +10,4 @@ module RanchHand
       TTY::Prompt.new
     end
   end
-end
+end

data/lib/ranch_hand/config.rb

@@ -15,24 +15,51 @@ module RanchHand
       end
     end
 
+    def self.update
+      save(generate_config(load))
+    end
+
     private
 
-    def self.generate_config
+    def self.generate_config(current={})
+      unless current.empty?
+        puts "Current config:"
+        pp current
+        puts "A blank entry to the following prompts will keep the current config value."
+      end
+
       namespace = prompt.ask('Namespace:')
       group = prompt.ask('Use group command by default? (Y/n):')
-      group = %w(n N).include?(group) ? false : true
       pod = prompt.ask('Pod name:')
+      prefix = prompt.ask('Command prefix (optional):')
 
-      {
+      # set default value if there is no current or entered value
+      if group.nil? && current[:group].nil?
+        group = %w(n N).include?(group) ? false : true
+      end
+
+      # if command prefix is provided set prefer_ui to false
+      # prefer_ui skips the #exec command line ui if set to true
+      # this supports a base case where the prefix command is the
+      # only command the user wants to run (eg. simple connection to the pod)
+      if current[:prefer_ui]
+        prefer_ui = nil
+      elsif prefix || current[:command_prefix]
+        prefer_ui = false
+      else
+        prefer_ui = true
+      end
+
+      current.merge({
+        command_prefix: prefix,
         group: group,
         namespace: namespace,
-        pod: pod
-      }
+        pod: pod,
+        prefer_ui: prefer_ui
+      }.compact)
     end
 
     def self.save(config)
-      # File.new(project_config_path, 'w+', 0640)
-
       File.open(project_config_path, 'w', 0640) do |f|
         f.write(config.to_yaml)
       end

data/lib/ranch_hand/constants.rb

@@ -1,4 +1,4 @@
 module RanchHand
   RANCH_HAND_HOME = File.join(ENV['HOME'], '.ranch-hand')
   STORE_FILE = File.join(RANCH_HAND_HOME, 'store.yml')
-end
+end

data/lib/ranch_hand/kube_ctl.rb

@@ -6,19 +6,27 @@ module RanchHand
       args = Array(args)
 
       namespace = cmd_options.delete(:namespace)
-      
+
       if cmd_options[:remove]
         remove_command(namespace)
       elsif cmd_options[:repeat]
         repeat_command(namespace)
-      elsif cmd_options[:command]
+      elsif cmd_options[:command] || (!cmd_options[:prefer_ui] && cmd_options[:command_prefix])
         pod = select_pod(namespace, cmd_options)
-        run_command(namespace, pod, cmd_options[:command], args)
+        run_command(namespace, pod, generate_command(cmd_options), args)
       else
         choose_command(namespace, cmd_options)
       end
     end
 
+    def generate_command(cmd_options)
+      if cmd_options[:skip_prefix]
+        command = cmd_options[:command]
+      else
+        command = "#{cmd_options[:command_prefix]} #{cmd_options[:command]}".strip
+      end
+    end
+
     def run_command(namespace, pod, cmd, args=[])
       system("rancher kubectl -n #{namespace} exec -it #{pod} -- #{cmd} #{args.join(' ')}".strip)
     end
@@ -26,7 +34,7 @@ module RanchHand
     def choose_command(namespace, options={})
       pod = select_pod(namespace, options)
       type, cmd = select_command(namespace, pod)
-      
+
       run_command(namespace, pod, cmd)
     end
 
@@ -59,9 +67,9 @@ module RanchHand
 
       if options[:filter]
         if options[:filter].start_with?('-')
-          pods = pods.reject{|p| p.match?(/#{options[:filter][1..-1]}/)} 
+          pods = pods.reject{|p| p.match?(/#{options[:filter][1..-1]}/)}
         else
-          pods = pods.select{|p| p.match?(/#{options[:filter]}/)} 
+          pods = pods.select{|p| p.match?(/#{options[:filter]}/)}
         end
       end
       prompt.error("No pods matching filter: '#{options[:filter]}'") and exit if pods.empty?
@@ -183,10 +191,5 @@ module RanchHand
     def storage
       @storage ||= RanchHand::Storage.new
     end
-
-    # def project_config
-    #   project_config_file = File.join(Dir.pwd, ".ranch-hand")
-    #   YAML.load_file(project_config_file) || {}
-    # end
   end
-end
+end

data/lib/ranch_hand/logger.rb

@@ -8,4 +8,4 @@ module RanchHand
       @@logger ||= ::Logger.new(STDOUT)
     end
   end
-end
+end

data/lib/ranch_hand/storage.rb

@@ -21,4 +21,4 @@ module RanchHand
       end
     end
   end
-end
+end

data/lib/ranch_hand/version.rb

@@ -1,3 +1,3 @@
 module RanchHand
-  VERSION = "0.7.1"
+  VERSION = "0.8.0"
 end

data/lib/ranch_hand.rb

@@ -1,6 +1,7 @@
 # stdlib
 require 'fileutils'
 require 'logger'
+require 'pp'
 require 'yaml'
 
 # gems
@@ -15,4 +16,4 @@ require 'ranch_hand/constants.rb'
 require 'ranch_hand/kube_ctl.rb'
 require 'ranch_hand/logger.rb'
 require 'ranch_hand/storage.rb'
-require 'ranch_hand/version.rb'
+require 'ranch_hand/version.rb'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ranch-hand
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Peregrinator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-27 00:00:00.000000000 Z
+date: 2022-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler