ranch-hand 0.5.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48c84c3e4ddf11d37bb17c9bc444ccc0700f1f9ed384625e44a076bb87430cff
-  data.tar.gz: eececbaadd4d0f51df193d4bf347475a53e8c4adfd1597eaaeaa688b701d2475
+  metadata.gz: 1fcf2dcd9fa4d7109d4e40ee519904acde93eab7d6861444900e045d8f9e85fd
+  data.tar.gz: 579f8858997fc6d180e400d97463cf49f64a6f29084d4224108b7256a61b1708
 SHA512:
-  metadata.gz: 8dc1dfd8aacea8c3e94052f9b4e5d3bef1b6bfe9613a0c70a76ebbea48e3e8b85fd3dba10a1e8d9aa7b64d78dc02f36ed3f27f2fc3f08180dca8ab34865eb8cc
-  data.tar.gz: d728d0493913d69331764620855311288c49c98529f0b47fe5917f800e41b28aca5ddb11545fddbb5a60321c78a83e7152b24cc116304d53868298bc02e7198f
+  metadata.gz: ee5fa837162469e9076186dd625bd4d8f2491836494a91d72861bc5571fba58a37719be2d8d190a948bc571e9542fb8098dd6888a5bba01073db15b25bfea78f
+  data.tar.gz: 11d3035683053d219e80d1da994b3a0ef634e07c4908344fb924c88ffe728724bd35651aa014d074e31904cdec85856c30334e475311bc803ed4f3de152f104f

data/Changelog.md

@@ -0,0 +1,13 @@
+### 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.
+  - https://github.com/peregrinator/ranch-hand/commit/a70d44042507d407c0088a2a8ffa4d4514a800af
+  - ex: before: `ranch-hand exec -c 'rspec spec/foo.rb:21'`, now: `ranch-hand exec -c rspec spec/foo.rb:21`
+
+#### Bugfixes:
+- d76855: correctly handle scenario in which the namespace queried has no pods
+
+### 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

data/README.md

@@ -5,7 +5,7 @@
 Provides a simple interface on top the Rancher CLI and the Kubectl commands to make running commands in pods easier.
 This is particularily useful when using Kubernetes in a development environment.
 
-![ranch-hand demo](https://github.com/peregrinator/ranch-hand/raw/master/doc/ranch-hand-demo.gif "Ranch-hand Demo")
+![ranch-hand demo](https://github.com/peregrinator/ranch-hand/raw/main/doc/ranch-hand-demo.gif "Ranch-hand Demo")
 
 ## Installation
 
@@ -25,14 +25,14 @@ Or install it yourself as:
 
 ## Setup
 
-Once ranch-hand is installed, run `ranch-hand setup` from the command line. This will the necessary files in a `~/.ranch-hand`.
+Once ranch-hand is installed, run `ranch-hand setup` from the command line. This will create the necessary files in `~/.ranch-hand`.
 
 #### Project setup
 
-Project setup is optional. You can create a set of default values for certain flags by running `ranch-hand init` in any directory. When ranch-hand is run from a directory it will use the values in a `.ranch-hand` file if it is present.
+Project setup is optional. You can create a set of default values for certain flags by running `ranch-hand init` in any directory. When ranch-hand is run from a directory it will use the values in the `.ranch-hand` file if it is present.
 
 Normally you might run the following command: `ranch-hand -n my-namespace -g -p my-project -c /bin/bash`
-Using `ranch-hand init` you can set the namespace, grouping flag and pod name as defaults, instead allowing you to just run: `ranch-hand -c /bin/bash`.
+Using `ranch-hand init` you can set the namespace, grouping flag and pod name as defaults, and instead just run: `ranch-hand -c /bin/bash`.
 
 ## Usage
 

data/bin/ranch-hand

@@ -14,7 +14,7 @@ module RanchHandCLI
   version RanchHand::VERSION
 
   subcommand_option_handling :normal
-  arguments :strict
+  arguments :loose
 
   desc 'Sets up ranch hand'
   command :setup do |c|
@@ -23,6 +23,13 @@ module RanchHandCLI
     end
   end
 
+  desc 'Installs ranch hand Oh My Zsh shortcuts'
+  command :ohmyzsh do |c|
+    c.action do |global_options, options, args|
+      RanchHand::Base.install_ohmyzsh
+    end
+  end
+
   desc 'Initializes ranch hand for project'
   command :init do |c|
     c.action do |global_options, command_options, args|
@@ -37,14 +44,14 @@ 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.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"
 
     c.action do |global_options, command_options, args|
-      RanchHand::KubeCtl.new.exec(command_options)
+      RanchHand::KubeCtl.new.exec(args: args, cmd_options: command_options)
     end
   end
 

data/files/ranch-hand.plugin.zsh

@@ -0,0 +1,4 @@
+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

data/lib/ranch_hand/base.rb

@@ -12,5 +12,27 @@ module RanchHand
       RanchHand::Config.create
       RanchHand::Logger.info("initialization complete")
     end
+
+    def self.install_ohmyzsh
+      RanchHand::Logger.info("installing ranch-hand Oh My Zsh shortcuts")
+
+      unless ENV['ZSH_CUSTOM'] || ENV['ZSH']
+        RanchHand::Logger.warn("Could not find $ZSH_CUSTOM or $ZSH in your environment, can not install shortcuts")
+        return
+      end
+
+      zsh_custom_dir = ENV['ZSH_CUSTOM'] || File.join(ENV['ZSH'], 'custom')
+
+      zsh_plugin_dir = File.join(zsh_custom_dir, 'plugins', 'ranch-hand')
+      FileUtils.mkdir_p(zsh_plugin_dir)
+
+      current_path = File.expand_path(File.dirname(__FILE__))
+      gem_plugin_path = File.join(current_path, '..', '..', 'files', 'ranch-hand.plugin.zsh')
+
+      FileUtils.cp(gem_plugin_path, zsh_plugin_dir)
+
+      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
   end
-end
+end

data/lib/ranch_hand/commands.rb

@@ -3,7 +3,7 @@ module RanchHand
     private
 
     def command(opts={})
-      TTY::Command.new(opts)
+      TTY::Command.new(**opts)
     end
 
     def prompt

data/lib/ranch_hand/kube_ctl.rb

@@ -2,25 +2,25 @@ module RanchHand
   class KubeCtl
     include RanchHand::Commands
 
-    def exec(options={})
-      # options = project_config.merge(options)
+    def exec(args: [], cmd_options: {})
+      args = Array(args)
 
-      namespace = options.delete(:namespace)
+      namespace = cmd_options.delete(:namespace)
       
-      if options[:remove]
+      if cmd_options[:remove]
         remove_command(namespace)
-      elsif options[:repeat]
+      elsif cmd_options[:repeat]
         repeat_command(namespace)
-      elsif options[:command]
-        pod = select_pod(namespace, options)
-        run_command(namespace, pod, options[:command])
+      elsif cmd_options[:command]
+        pod = select_pod(namespace, cmd_options)
+        run_command(namespace, pod, cmd_options[:command], args)
       else
-        choose_command(namespace, options)
+        choose_command(namespace, cmd_options)
       end
     end
 
-    def run_command(namespace, pod, cmd)
-      system("rancher kubectl -n #{namespace} exec -it #{pod} -- #{cmd}")
+    def run_command(namespace, pod, cmd, args=[])
+      system("rancher kubectl -n #{namespace} exec -it #{pod} -- #{cmd} #{args.join(' ')}".strip)
     end
 
     def choose_command(namespace, options={})
@@ -175,7 +175,9 @@ module RanchHand
 
     def pods(namespace)
       pods_cmd = "rancher kubectl -n #{namespace} get po"
-      command(printer: :null).run(pods_cmd).out.split("\n")[1..-1].map{|l| l.split(/\s+/)[0]}
+      pods = command(printer: :null).run(pods_cmd).out.split("\n")[1..-1]&.map{|l| l.split(/\s+/)[0]}
+
+      pods || []
     end
 
     def storage

data/lib/ranch_hand/version.rb

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

data/ranch-hand.gemspec

@@ -23,12 +23,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/ranch-hand}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '~> 3.0'
+
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
-  spec.add_runtime_dependency "gli", "~> 2.18"
-  spec.add_runtime_dependency "pry", "~> 0.12.2"
-  spec.add_runtime_dependency "tty-command", "~> 0.8.2"
-  spec.add_runtime_dependency "tty-prompt", "~> 0.18.1"
+  spec.add_runtime_dependency "gli", "~> 2.20"
+  spec.add_runtime_dependency "pry", "~> 0.14"
+  spec.add_runtime_dependency "tty-command", "~> 0.10"
+  spec.add_runtime_dependency "tty-prompt", "~> 0.23"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ranch-hand
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Peregrinator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-22 00:00:00.000000000 Z
+date: 2021-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,56 +58,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.18'
+        version: '2.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.18'
+        version: '2.20'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '0.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: tty-command
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: '0.23'
 description: ''
 email:
 - bob.burbach@gmail.com
@@ -120,6 +120,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Changelog.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -128,6 +129,7 @@ files:
 - bin/ranch-hand
 - bin/setup
 - doc/ranch-hand-demo.gif
+- files/ranch-hand.plugin.zsh
 - lib/ranch_hand.rb
 - lib/ranch_hand/base.rb
 - lib/ranch_hand/commands.rb
@@ -148,17 +150,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Provides an interface between the Rancher CLI and the Kubectl commands