sshyguy 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 225a14fa2b004e45d52ec9a6df5161aa253e4cbb
-  data.tar.gz: 718902b6750ca29d5baa3cd6a7dff6aa33f409c4
+  metadata.gz: 74b1b6c81566ac6efd9220f7f77662983249fa51
+  data.tar.gz: 24e64e5e2c08f3c994a91f35908b80513012517b
 SHA512:
-  metadata.gz: 8647ebf42c79867364153e95b16515d3c63e59fbfe69e4aff54cbfd27058a344f30e16999e1493bf534fcc7f8be5e81376e3b31a13cf35e46cc5c88b5bc724f8
-  data.tar.gz: 496c9c253d03759d27208f04974c743b5dc3478f4f3d2553e7e6207d825b7971654fc505ec50c20bb68cdbd3e6c5240001feabcbfb08d6c768ef527d301a7e20
+  metadata.gz: 42dee875e4f064323a63f0a7ad69db576705bceeb9d0fe22799015ac1fb22ac520297296f56dff12082b33ad57b4f5a0dabee497f76a4ce0472e375b3a1e6b7e
+  data.tar.gz: 54ba820da01574736f22d65b05605c403d0794f8771e2ff1909b0fbffce2af97ebfb945d0807e6dda2e0757778096ac4951670f4bbfc9e7b531376a5ebef053e

data/.gitignore

@@ -6,3 +6,16 @@
 /pkg/
 /spec/reports/
 /tmp/
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/node_modules/
+test/dummy/yarn-error.log
+test/dummy/storage/
+test/dummy/tmp/
+*.gem
+.ruby-version
+

data/Gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sshyguy.gemspec
 gemspec

data/README.md

@@ -23,9 +23,15 @@ Edit your config file add servers.
   "user": "deploy",
   "label": "Production",
   "shortcut": "production",
+  "command": "",
+  "options": ""
 }
 ```
 
+### Notes
+
+If `command` is present (not blank/empty/nil), it will be used to spawn the SSH connection. Otherwise, it will be built with `ssh $user@$hostname -p $port $options`. 
+
 ## Usage
 
 Feeling lazy? 

data/Rakefile

@@ -1,2 +1,4 @@
-require "bundler/gem_tasks"
-task :default => :spec
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "sshyguy"
+require 'bundler/setup'
+require 'sshyguy'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "sshyguy"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/sshyguy

@@ -1,11 +1,12 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'sshyguy'
 
 begin
   SshyGuy::CLI.run
 rescue Interrupt => e
-  puts ""
-  puts ""
-  puts "Goodbye."
+  puts ''
+  puts ''
+  puts 'Goodbye.'
 end

data/lib/data/example.json

@@ -1,14 +1,15 @@
 {
+  "version": 1,
   "config": {
     "debug": false,
-    "include_shortcut": true,
     "cycle": true,
     "filter": true,
-    "editor": "subl",
-    "folders": true,
+    "editor": "vi",
     "ssh_defaults": {
       "user": "root",
-      "port": 22
+      "port": 22,
+      "options": "",
+      "hostname": ""
     }
   },
   "servers": [

data/lib/sshyguy.rb

@@ -1,7 +1,11 @@
-require "sshyguy/version"
+# frozen_string_literal: true
+
+require 'sshyguy/version'
 require 'tty-prompt'
 require 'optionparser'
 require 'json'
+require 'sshyguy/params'
+require 'sshyguy/servers'
 require 'sshyguy/config'
 require 'sshyguy/prompt'
 require 'sshyguy/core_ext'
@@ -11,23 +15,9 @@ require 'sshyguy/command'
 require 'sshyguy/cli'
 
 module SshyGuy
-  def self.params
-    @params ||= {}
-  end
-  def self.params=(val)
-    @params = val
-  end
-  def self.reload_params!
-    self.params = {}
-  end
-
-  def self.servers=(val)
-    @servers = val
-  end
-
-  def self.servers
-    @servers ||= []
-  end
+  extend SshyGuy::Servers
+  extend SshyGuy::Params
+  class Error < StandardError; end
 
   def self.configuration
     @configuration ||= Config.new
@@ -36,31 +26,54 @@ module SshyGuy
   def self.config
     configuration
   end
-  class Error < StandardError; end
 
   def self.log(str)
     if SshyGuy.config.debug?
       puts str
+      puts caller(0)
     end
   end
 
   def self.config_file
-    File.expand_path("~/.sshyguy.json")
+    File.expand_path('~/.sshyguy.json')
   end
 
   def self.load_config!
-    unless File.exist?(self.config_file)
-      puts "No config file found at #{self.config_file}"
-      puts "Install this with sshyguy --install"
+    SshyGuy.log("Checking if config_file exists at #{config_file}")
+    unless File.exist?(config_file)
+      SshyGuy.log('config_file not found')
+      puts "No config file found at #{config_file}"
+      puts 'Install this with sshyguy --install'
+      SshyGuy.log('Exiting program')
       exit
     end
     begin
-      json = JSON.parse(File.read(self.config_file))
-      json['config'].each do |k,v|
+      SshyGuy.log('Parsing config_file')
+      file = File.read(config_file)
+      SshyGuy.log('File read')
+      SshyGuy.log('File contents:')
+      SshyGuy.log(file)
+      SshyGuy.log('Parsing file')
+      json = JSON.parse(file)
+      if json['version'].to_i < SshyGuy::CONFIG_VERSION
+        puts 'Warning: Configuration out of date.'
+      end
+      SshyGuy.log('Parsed')
+      SshyGuy.log('Parsed contents')
+      SshyGuy.log(json)
+      SshyGuy.log('Loading config defaults')
+      json['config'].each do |k, v|
+        SshyGuy.log("Setting default '#{k}' to '#{v}'")
         configuration.send("#{k}=", v)
       end
-      Server.build(json['servers'].reject { |server| !server['command'].present? && !server['hostname'].present? })
-    rescue => e
+      json['servers'].each do |server|
+        if server['command'].present? || server['hostname'].present?
+          Server.new(server)
+        else
+          log("Skipping server #{server.inspect}")
+        end
+      end
+    rescue JSON::ParserError => e
       puts e
       puts "Unable to parse config file. Ensure it's valid JSON."
       exit

data/lib/sshyguy/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sshyguy/screen'
 require 'sshyguy/screens/help_screen'
 require 'sshyguy/screens/main_screen'
@@ -9,20 +11,19 @@ module SshyGuy
     def self.run
       options = {}
       OptionParser.new do |opts|
-        opts.banner = "Usage: sshy [options]"
-
-        opts.on("-v", "--verbose", "Run verbosely") do |v|
-          options[:verbose] = v
-        end
-        opts.on("-h", "--help", "Help") do |v|
+        opts.banner = 'Usage: sshyguy [options]'
+        opts.on('-h', '--help', 'Help') do |_v|
           options[:help] = true
         end
-        opts.on("-s", "--shortcut SHORTCUT", "Shortcut") do |v|
+        opts.on('-s', '--shortcut SHORTCUT', 'Shortcut') do |v|
           options[:shortcut] = v
         end
-        opts.on('--install') do |v|
+        opts.on('--install') do |_v|
           options[:install] = true
         end
+        opts.on('-d', '--debug', 'Debug') do |_v|
+          SshyGuy.config.debug = true
+        end
       end.parse!
       new(options).run
     end
@@ -35,9 +36,10 @@ module SshyGuy
     def run
       if options[:install]
         puts "Writing to #{SshyGuy.config_file}"
-        File.open(SshyGuy.config_file, "w+") { |f| f.puts(File.read("lib/data/example.json")) }
+        File.open(SshyGuy.config_file, 'w+') { |f| f.puts(File.read('lib/data/example.json')) }
         exit
       end
+      SshyGuy.log('Loading config')
       SshyGuy.load_config!
       if options[:help]
         Screens::HelpScreen.show(options)
@@ -46,4 +48,4 @@ module SshyGuy
       end
     end
   end
-end
+end

data/lib/sshyguy/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SshyGuy
   class Command
     attr_reader :to_command
@@ -6,29 +8,23 @@ module SshyGuy
     end
 
     def to_command
+      SshyGuy.log('Building command')
+      SshyGuy.log(@config['command'])
       if @config['command'].present?
         @config['command']
       else
-        parts = ["ssh"]
-        if @config['options'].present?
-          parts << @config['options']
-        end
+        parts = ['ssh']
+        parts << @config['options'] if @config['options'].present?
         parts << "#{user}@#{hostname}"
         parts << "-p #{port}"
-        parts.join(" ")
+        parts.join(' ')
       end
     end
 
-    def hostname
-      @config['hostname'] || SshyGuy.config.ssh_defaults['hostname']
-    end
-
-    def user
-      @config['user'].presence || SshyGuy.config.ssh_defaults['user']
-    end
-
-    def port
-      @config['port'].presence || SshyGuy.config.ssh_defaults['port']
+    %i[hostname user port options].each do |option|
+      define_method(option) do
+        @config[option.to_s].presence || SshyGuy.config.ssh_defaults[option.to_s]
+      end
     end
   end
-end
+end

data/lib/sshyguy/config.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 module SshyGuy
   class Config
     attr_accessor :ssh_defaults, :debug, :include_shortcut, :cycle, :filter, :servers, :editor, :folders
     def cycle?
       cycle
     end
+
     def filter?
       filter
     end
+
     def debug?
       debug
     end
   end
-end
+end

data/lib/sshyguy/core_ext.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 class NilClass
   def presence
     false
   end
+
   def present?
     false
   end
@@ -11,6 +14,7 @@ class String
   def presence
     present? ? self : false
   end
+
   def present?
     !empty?
   end
@@ -20,15 +24,18 @@ class FalseClass
   def presence
     false
   end
+
   def present?
     false
   end
 end
+
 class TrueClass
   def presence
     true
   end
+
   def present?
     true
   end
-end
+end

data/lib/sshyguy/menu.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 module SshyGuy
   class Menu
-    def initialize
-    end
+    def initialize; end
 
     def items
       @items ||= Server.all
     end
   end
-end
+end

data/lib/sshyguy/params.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SshyGuy
+  module Params
+    def self.params
+      @params ||= {}
+    end
+
+    def self.params=(val)
+      @params = val
+    end
+
+    def self.reload_params!
+      self.params = {}
+    end
+  end
+end

data/lib/sshyguy/prompt.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module SshyGuy
   class Prompt < TTY::Prompt
     def select(question, *args, &block)
       super(question, *args, cycle: SshyGuy.config.cycle?, filter: SshyGuy.config.filter?, &block)
     end
   end
-end
+end

data/lib/sshyguy/screen.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SshyGuy
   class Screen
     def self.show(options)
@@ -21,11 +23,11 @@ module SshyGuy
     end
 
     def current_folder?
-      current_folder.present? && current_folder != "__ALL"
+      current_folder.present? && current_folder != '__ALL'
     end
 
     def params
       SshyGuy.params
     end
   end
-end
+end

data/lib/sshyguy/screens/folder_screen.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 module SshyGuy
   module Screens
     class FolderScreen < Screen
       def show
-        selected = prompt.select("Select a folder") do |select|
+        selected = prompt.select('Select a folder') do |select|
           Server.folders.each do |folder|
             select.choice(folder)
           end
-          select.choice("All servers", "__ALL")
+          select.choice('All servers', '__ALL')
         end
         SshyGuy.params[:folder] = selected
         MainScreen.show(options)
       end
     end
   end
-end
+end

data/lib/sshyguy/screens/help_screen.rb

@@ -1,23 +1,32 @@
+# frozen_string_literal: true
+
 module SshyGuy
   module Screens
     class HelpScreen < Screen
       def show
-        selection = prompt.select("How can I help?") do |select|
+        SshyGuy.log('HelpScreen initialized')
+        selection = prompt.select('How can I help?') do |select|
           select.enum '.'
-          select.choice("Edit config file", :edit)
-          select.choice("Jk", :close)
-          select.choice("Exit", :exit)
+          select.choice('Edit config file', :edit)
+          select.choice('Jk', :close)
+          select.choice('Exit', :exit)
         end
         case selection
         when :edit
+          SshyGuy.log('Selected :edit')
           system("#{SshyGuy.config.editor} #{SshyGuy.config_file}")
           exit
         when :exit
-          puts "Bye."
+          SshyGuy.log('Selected :exit')
+          puts 'Bye.'
+          SshyGuy.log('Exiting program')
           exit
         when :close
+          SshyGuy.log('Selected :close')
+          SshyGuy.log('Closing window')
+
         end
       end
     end
   end
-end
+end

data/lib/sshyguy/screens/main_screen.rb

@@ -1,32 +1,29 @@
+# frozen_string_literal: true
+
 module SshyGuy
   module Screens
     class MainScreen < Screen
       def show
-        if options[:shortcut]
-          server = SshyGuy::Server.all.detect { |server| server.shortcut == options[:shortcut] }
-          if server
-            server.spawn
-          else
-            puts "No shortcut server found for '#{options[:shortcut]}'"
-            exit
-          end
-        end
-        label = "Select a server."
+        SshyGuy.log('MainScreen initialized')
+        ShortcutScreen.show(options) if options[:shortcut]
+        SshyGuy.log('Building server menu')
+        label = 'Select a server.'
         servers = SshyGuy::Server.all
-        server = prompt.select(label, cycle: SshyGuy.config.cycle?, filter: SshyGuy.config.filter?) do |select|
+        server = prompt.select(label) do |select|
           select.enum '.'
           servers.each do |item|
             select.choice(item.to_label, item)
           end
-          select.choice("Exit folder", :close_folder) if current_folder?
+          select.choice('Exit folder', :close_folder) if current_folder?
         end
+        SshyGuy.log("Selected #{server.inspect}")
         if server == :close_folder
-          SshyGuy.params[:folder] = '__ALL'
           MainScreen.show(options)
         else
+          SshyGuy.log("Spawning server #{server.inspect}")
           server.spawn
         end
       end
     end
   end
-end
+end

data/lib/sshyguy/screens/shortcut_screen.rb

@@ -1,16 +1,21 @@
+# frozen_string_literal: true
+
 module SshyGuy
   module Screens
     class ShortcutScreen < Screen
       def show
-        menu = Menu.new
-        shortcut = menu.items.detect { |item| item.shortcut == args[:shortcut] }
-        unless shortcut
-          puts "No shortcut found for '#{args[:shortcut]}'"
+        unless find_shortcut
+          puts "No shortcut found for '#{options[:shortcut]}'"
           exit
         end
-        shortcut.spawn
-        exit
+        find_shortcut.spawn
+      end
+
+      private
+
+      def find_shortcut
+        @find_shortcut ||= Server.all.detect { |item| item.shortcut == options[:shortcut] }
       end
     end
   end
-end
+end

data/lib/sshyguy/server.rb

@@ -1,21 +1,14 @@
+# frozen_string_literal: true
+
 module SshyGuy
   class Server
     def self.all
       @all ||= []
     end
 
-    def self.build(servers)
-      servers.each do |server|
-        self.all << Server.new(server)
-      end
-    end
-
-    def self.folders
-      @folders ||= self.all.map(&:folder).uniq
-    end
-
     def initialize(config)
       @config = config
+      self.class.all << self
     end
 
     def to_label
@@ -33,7 +26,7 @@ module SshyGuy
     end
 
     def folder
-      @config['folder'].presence || "Default"
+      @config['folder'].presence || 'Default'
     end
 
     def shortcut
@@ -41,7 +34,7 @@ module SshyGuy
     end
 
     def group
-      @config['group'].presence || "Default"
+      @config['group'].presence || 'Default'
     end
   end
-end
+end

data/lib/sshyguy/servers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SshyGuy
+  module Servers
+    def self.servers=(val)
+      @servers = val
+    end
+
+    def self.servers
+      @servers ||= []
+    end
+  end
+end

data/lib/sshyguy/version.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
 module SshyGuy
-  VERSION = '0.1.5'
-end
+  VERSION = '0.1.6'
+  CONFIG_VERSION = 1
+end

data/sshyguy.gemspec

@@ -1,31 +1,32 @@
-lib = File.expand_path("lib", __dir__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require "sshyguy/version"
+require 'sshyguy/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sshyguy"
+  spec.name          = 'sshyguy'
   spec.version       = SshyGuy::VERSION
-  spec.authors       = ["Josh Brody"]
-  spec.email         = ["josh@josh.mn"]
+  spec.authors       = ['Josh Brody']
+  spec.email         = ['josh@josh.mn']
 
-  spec.summary       = "A lazy SSH manager."
+  spec.summary       = 'A lazy SSH manager.'
   spec.description   = spec.summary
-  spec.homepage      = "https://github.com/joshmn/sshyguy"
-
+  spec.homepage      = 'https://github.com/joshmn/sshyguy'
 
-  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata['homepage_uri'] = spec.homepage
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "bin"
-  spec.executables   = ["sshyguy"]
-  spec.require_paths = ["lib"]
+  spec.bindir        = 'bin'
+  spec.executables   = ['sshyguy']
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_dependency "tty-prompt"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'tty-prompt'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshyguy
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Josh Brody
@@ -75,6 +75,7 @@ files:
 - lib/sshyguy/config.rb
 - lib/sshyguy/core_ext.rb
 - lib/sshyguy/menu.rb
+- lib/sshyguy/params.rb
 - lib/sshyguy/prompt.rb
 - lib/sshyguy/screen.rb
 - lib/sshyguy/screens/folder_screen.rb
@@ -82,6 +83,7 @@ files:
 - lib/sshyguy/screens/main_screen.rb
 - lib/sshyguy/screens/shortcut_screen.rb
 - lib/sshyguy/server.rb
+- lib/sshyguy/servers.rb
 - lib/sshyguy/version.rb
 - sshyguy.gemspec
 homepage: https://github.com/joshmn/sshyguy