ranch-hand 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28e355a00dd066ac8d0b0270f59a2a97c25bd28e69066a289aec029db9661fa9
-  data.tar.gz: 56a686da7e0be9a823b75fd7d349d75b7d7cd8c497106d153fe3018f6921ce87
+  metadata.gz: 739b914a9a3aaa61cbd1ea414310158a5de894f02f93028c6c6927d3dcf4d567
+  data.tar.gz: 0166cfe7b29ad795d8f8ee3e0bef4a91bb3fce4e55e2a662ab24e7cf06474596
 SHA512:
-  metadata.gz: d7639b1029f2cfb0a415794dd22ca8af87f38a20be8efdb757373a0218ae2fbdbf50f13365985afdd55a0e44fdcce72e6cf40c260d33823f1dd8dafe0ece392b
-  data.tar.gz: be9d54eed465ab6b3bb9b09f845ddb1d514f701076cf9d1f4b601b07fadfad36e2672c74d3b816380ab311ec4d619825ef4b966ebd657d7f4293f92900bd24f8
+  metadata.gz: d0608be5112035aa5f4ca5e9e7ce1fc570763f485d688541de6c9095bcd3345cf0ce69378c820f60b782f0051b88322e4f7c052960f75db9c18ddffd3be44dc8
+  data.tar.gz: 957785da2e00ac1fb0834a9cb9cec97a6ed7628d1c0ad02e458ab1da3fdf76625801b733c1d4439a58ab8d1437d7ab6b3ce80ad09978a4d79417e1e39ff86f72

data/.gitignore

@@ -9,3 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+# https://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+Gemfile.lock

data/Changelog.md

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

@@ -1,8 +1,12 @@
 # RanchHand
 
-Provides an interface between the Rancher CLI and the Kubectl commands to make running commands in pods easier.
+[![Gem Version](https://badge.fury.io/rb/ranch-hand.svg)](https://badge.fury.io/rb/ranch-hand)
+
+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/main/doc/ranch-hand-demo.gif "Ranch-hand Demo")
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -19,6 +23,17 @@ Or install it yourself as:
 
     $ gem install ranch-hand
 
+## Setup
+
+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 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, and instead just run: `ranch-hand -c /bin/bash`.
+
 ## Usage
 
 RanchHand makes use of the [GLI](https://github.com/davetron5000/gli) (Git Like Interface) gem to create a CLI with features similar to the Git CLI. Run `ranch-hand help` or `ranch-hand command help` for usage information.

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,19 +23,28 @@ module RanchHandCLI
     end
   end
 
+  desc 'Initializes ranch hand for project'
+  command :init do |c|
+    c.action do |global_options, command_options, args|
+      RanchHand::Base.init
+    end
+  end
+
   desc 'Execs into a running container'
   command :exec do |c|
-    c.switch [:g, :group], negatable: false, desc: "Group pods returned so that there is only one from each deployment."
+    config = RanchHand::Config.load
+
+    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, desc: "Namespace against which to retreive pods and run command"
-    c.flag [:p, :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.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/lib/ranch_hand.rb

@@ -10,6 +10,7 @@ require 'tty-prompt'
 # our files
 require 'ranch_hand/base.rb'
 require 'ranch_hand/commands.rb'
+require 'ranch_hand/config.rb'
 require 'ranch_hand/constants.rb'
 require 'ranch_hand/kube_ctl.rb'
 require 'ranch_hand/logger.rb'

data/lib/ranch_hand/base.rb

@@ -6,5 +6,11 @@ module RanchHand
       File.new(RanchHand::STORE_FILE, 'w+', 0640)
       RanchHand::Logger.info("complete")
     end
+
+    def self.init
+      RanchHand::Logger.info("initializing ranch-hand for project")
+      RanchHand::Config.create
+      RanchHand::Logger.info("initialization complete")
+    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/config.rb

@@ -0,0 +1,45 @@
+module RanchHand
+  class Config
+    extend RanchHand::Commands
+
+    def self.create
+      save(generate_config)
+      RanchHand::Logger.info("Config file saved to #{project_config_path}")
+    end
+
+    def self.load
+      begin
+        YAML.load_file(project_config_path)
+      rescue Errno::ENOENT
+        {}
+      end
+    end
+
+    private
+
+    def self.generate_config
+      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:')
+
+      {
+        group: group,
+        namespace: namespace,
+        pod: pod
+      }
+    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
+    end
+
+    def self.project_config_path
+      File.join(Dir.pwd, ".ranch-hand")
+    end
+  end
+end

data/lib/ranch_hand/kube_ctl.rb

@@ -2,23 +2,25 @@ module RanchHand
   class KubeCtl
     include RanchHand::Commands
 
-    def exec(options={})
-      namespace = options.delete(:namespace)
+    def exec(args: [], cmd_options: {})
+      args = Array(args)
+
+      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={})
@@ -173,11 +175,18 @@ 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
       @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

data/lib/ranch_hand/version.rb

@@ -1,3 +1,3 @@
 module RanchHand
-  VERSION = "0.4.0"
+  VERSION = "0.7.0"
 end

data/ranch-hand.gemspec

@@ -20,15 +20,17 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }.reject { |f| f.match(%r{.gem$}) }
   end
   spec.bindir        = "bin"
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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.4.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Peregrinator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-03 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,63 +58,61 @@ 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
 executables:
-- console
 - ranch-hand
-- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -122,17 +120,19 @@ files:
 - ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Changelog.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/ranch-hand
 - bin/setup
+- doc/ranch-hand-demo.gif
 - lib/ranch_hand.rb
 - lib/ranch_hand/base.rb
 - lib/ranch_hand/commands.rb
+- lib/ranch_hand/config.rb
 - lib/ranch_hand/constants.rb
 - lib/ranch_hand/kube_ctl.rb
 - lib/ranch_hand/logger.rb
@@ -149,17 +149,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.3
 signing_key: 
 specification_version: 4
 summary: Provides an interface between the Rancher CLI and the Kubectl commands

data/Gemfile.lock

@@ -1,67 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ranch-hand (0.3.0)
-      gli (~> 2.18)
-      pry (~> 0.12.2)
-      tty-command (~> 0.8.2)
-      tty-prompt (~> 0.18.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    equatable (0.5.0)
-    gli (2.18.0)
-    method_source (0.9.2)
-    necromancer (0.4.0)
-    pastel (0.7.2)
-      equatable (~> 0.5.0)
-      tty-color (~> 0.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    timers (4.3.0)
-    tty-color (0.4.3)
-    tty-command (0.8.2)
-      pastel (~> 0.7.0)
-    tty-cursor (0.6.1)
-    tty-prompt (0.18.1)
-      necromancer (~> 0.4.0)
-      pastel (~> 0.7.0)
-      timers (~> 4.0)
-      tty-cursor (~> 0.6.0)
-      tty-reader (~> 0.5.0)
-    tty-reader (0.5.0)
-      tty-cursor (~> 0.6.0)
-      tty-screen (~> 0.6.4)
-      wisper (~> 2.0.0)
-    tty-screen (0.6.5)
-    wisper (2.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  rake (~> 10.0)
-  ranch-hand!
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   2.0.1