hss 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1daa6c499987f664f1debc997165bd07e4d4d199
-  data.tar.gz: 1e85d0b28020d648c2496bef51074796fcda9312
+  metadata.gz: 24849b698b736574e86170ba2249d9a937b509f0
+  data.tar.gz: ffc1254913b1c7c0ae0ad9a1ab90335a10149f4e
 SHA512:
-  metadata.gz: 0495ca1ce274046ecd6f484d3c9da982125e11feaf09f53eadfa254710c3ae98b1579d5196a1da87d020725806bdf89a1d07ec0be1987b88ebf0abecbe27d711
-  data.tar.gz: f1de32083e1c9962d6ad34e752aefc24b2926c343a790cd885643af68cba0421a64a07f46dcf5cad0cfc03566a015d584a3d704280687745ca957aa6753bdf45
+  metadata.gz: 96192df55e26bd41698d3a8d5f612710b2c29770e847f7befa678032dad7dc26fd740d11eccdbe798d8a30f474aa08744544f4234651e739bdf20950c801e67e
+  data.tar.gz: 9cd091bd67d04f4af7478891a093f40dabf39e67055f07a23e0ab46995e04eeb7d118de14e80476c7692dec13525677bf5617c1d2e6cab3ac575f9aa5e55fd28

data/.gitignore

@@ -1,2 +1,3 @@
-config.yml
-*.gem
+pkg/*.gem
+coverage/
+.coveralls.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--color

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Excludes:
+    - spec/test/bad_helpers/module.rb
+Encoding:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+rvm:
+- ruby-head
+- 2.0.0
+- 1.9.3
+notifications:
+  email: false
+  irc:
+    channels:
+      - ircs://irc.oftc.net:6697#akerl
+    channel_key: sekrit
+    template:
+      - '%{repository}/%{branch}/%{build_number}: %{message} -- %{build_url}'

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    hss (0.2.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (1.1.0)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    diff-lcs (1.2.5)
+    docile (1.1.0)
+    fuubar (1.2.1)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.2.0)
+      ruby-progressbar (~> 1.0)
+    hashr (0.0.22)
+    mime-types (2.0)
+    multi_json (1.8.2)
+    parser (2.1.0.pre1)
+      ast (~> 1.1)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    rainbow (1.1.4)
+    rake (10.1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-instafail (0.2.4)
+    rspec-mocks (2.14.4)
+    rubocop (0.15.0)
+      parser (~> 2.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.1.4)
+    ruby-progressbar (1.2.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.4.7)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    tins (0.13.1)
+    travis-lint (1.7.0)
+      hashr (~> 0.0.22)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  fuubar
+  hss!
+  parser (~> 2.1.0.pre1)
+  rake
+  rspec
+  rubocop
+  travis-lint

data/README.md

@@ -2,21 +2,19 @@ hss
 =========
 
 [![Gem Version](https://badge.fury.io/rb/hss.png)](http://badge.fury.io/rb/hss)
-[![Stories in Ready](https://badge.waffle.io/akerl/hss.png)](http://waffle.io/akerl/hss)
+[![Dependency Status](https://gemnasium.com/akerl/hss.png)](https://gemnasium.com/akerl/hss)
+[![Code Climate](https://codeclimate.com/github/akerl/hss.png)](https://codeclimate.com/github/akerl/hss)
+[![Coverage Status](https://coveralls.io/repos/akerl/hss/badge.png)](https://coveralls.io/r/akerl/hss)
+[![Build Status](https://travis-ci.org/akerl/hss.png?branch=master)](https://travis-ci.org/akerl/hss)
 
 SSH helper that uses regex and fancy expansion to dynamically manage SSH shortcuts
 
-## Usage
-
-1. Install as per the Installation section below
-2. Set your configuration yaml up as desired (See Configuration below)
-3. Run `hss help` for a list of available commands
-4. Run `hss $command` to do that thing
-
 ## Installation
 
-    gem install hss
-    ln -s /path/to/your/config.yml ~/.hss.yml
+```
+gem install hss
+ln -s /path/to/your/config.yml ~/.hss.yml
+```
 
 ## Configuration
 
@@ -28,26 +26,50 @@ SSH helper that uses regex and fancy expansion to dynamically manage SSH shortcu
     * Use matching to collect things you want to use in the expanded form
   * long: Expanded form of this shortcut ("root@#$1.example.org")
     * This will be evaluated using Ruby's string interpolation, so you can use "#{var}", "#$1", "#{function()}", etc.
-3. Other helpers are available for use in long forms
-  * expand(x): Uses the "expansions" section of the config. Format for this section is a hash of lists, as such
-    expansions:
-        expanded_form:
-            - short_form1
-            - short_form2
-            - shrtfrm3
+3. Helpers are available for use in long forms
+  * expand(x): Uses the "expansions" section of the config. Format for this section is a hash of lists, as such:
+
+```
+expansions:
+    expanded_form:
+        - short_form1
+        - short_form2
+        - shrtfrm3
+```
+
   * shortcut(x): Uses the "shortcuts" section of the config. Format for this section is a hash of strings, as such
-    shortcuts:
-        short1: expand to this
-        other_short: 'expand to something else!'
+
+```
+shortcuts:
+    short1: expand to this
+    other_short: 'expand to something else!'
+```
+
   * command(x): Runs the given string as a command and uses the output for the expanded form
   * default(x, y): If x is not nil, uses x. If it's nil, use y
+  * external(source, key): Loads source as a YAML file and looks for the given key. The YAML should be made of hashes (you can nest them) and the key should be dot-separated:
+
+```
+fish:
+    color: blue # accessible with key = 'fish.color'
+    alpha:
+        dog: sparky
+        cat: grouchy # accessible with key 'fish.alpha.cat'
+```
+
+## Usage
+
+1. Run `hss help` for a list of available commands
+2. Run `hss $command` to do that thing
 
 ## Debugging
 
 If you want hss to print the command it would have run rather than executing it, you just need to set the HSS\_DEBUG environment variable to something:
 
-    export HSS_DEBUG=foo
-    hss bar # will print rather than exec
+```
+export HSS_DEBUG=foo
+hss bar # will print rather than exec
+```
 
 ## License
 

data/Rakefile

@@ -1,2 +1,20 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+desc 'Run tests'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run Rubocop on the gem'
+Rubocop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/*.rb', 'spec/helpers/*.rb', 'bin/*']
+  task.fail_on_error = true
+end
+
+desc 'Run travis-lint on .travis.yml'
+task :travislint do
+  fail 'There is an issue with your .travis.yml' unless system('travis-lint')
+end
+
+task default: [:spec, :travislint, :rubocop, :build, :install]
 

data/bin/hss

@@ -2,24 +2,23 @@
 
 require 'hss'
 
-My_Handler = HSS::Handler.new ENV['HSS_CONFIG']
+My_Handler = HSS::Handler.new(config: ENV['HSS_CONFIG'])
 
 if ARGV == ['version']
-    puts HSS::Version
-    exit
-elsif ARGV == ['help'] or ARGV.empty?
-    puts 'How to use:'
-    puts '(what you type) -> (where it takes you)'
-    My_Handler.patterns.each { |pattern| puts pattern['example'] }
-    exit
+  puts HSS::Version
+  exit
+elsif ARGV == ['help'] || ARGV.empty?
+  puts 'How to use:'
+  puts '(what you type) -> (where it takes you)'
+  My_Handler.patterns.each { |pattern| puts pattern['example'] }
+  exit
 end
 
-Short_Host = ARGV.delete_at( ARGV.find_index { |x| x[0, 1] != '-' } || 0 )
-Args = ARGV.inject('') { |memo, obj| memo += " '" + obj.gsub(/([$"])/, '\1') + "'" }
-Command = (ENV.include? 'HSS_DEBUG') ? 'echo ssh' : 'ssh'
+short_host = ARGV.delete_at(ARGV.find_index { |x| x[0, 1] != '-' } || 0)
+args = ARGV.reduce('') { |a, e| a + " '" + e.gsub(/([$"])/, '\1') + "'" }
+command = ENV.include?('HSS_DEBUG') ? 'echo ssh' : 'ssh'
 
-Long_Host = My_Handler.handle Short_Host
-
-$stdout.syswrite "\033]0;#{Short_Host}\007" if $stdout.tty? and $stdin.tty?
-exec "#{Command} #{Long_Host} #{Args}"
+long_host = My_Handler.handle short_host
 
+$stdout.syswrite "\033]0;#{short_host}\007" if $stdout.tty? && $stdin.tty?
+exec "#{command} #{long_host} #{args}"

data/hss.gemspec

@@ -1,16 +1,26 @@
-require File.join(Dir.pwd, 'lib/hss.rb')
+$:.unshift File.expand_path('../lib/', __FILE__)
+require 'version'
 
 Gem::Specification.new do |s|
   s.name        = 'hss'
-  s.version     = HSS::Version
+  s.version     = HSS::VERSION
   s.date        = Time.now.strftime("%Y-%m-%d") 
   s.summary     = 'SSH helper'
   s.description = 'Regex-based SSH shortcut tool'
   s.authors     = ['Les Aker']
   s.email       = 'me@lesaker.org'
   s.files       = `git ls-files`.split
+  s.test_files  = `git ls-files spec/*`.split
   s.executables = ['hss']
   s.homepage    = 'https://github.com/akerl/hss'
   s.license     = 'MIT'
+
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'travis-lint'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'fuubar'
+  s.add_development_dependency 'parser', '~> 2.1.0.pre1'
 end
 

data/lib/helpers/command.rb

@@ -1,6 +1,16 @@
+require 'English'
+
+##
+# Runs a shell command and returns the output
+
 class HSS::Parser
-    def command(input)
-        return IO.popen(input) { |cmd| cmd.read }
-    end
-end
+  private
 
+  def command(input)
+    result = IO.popen(input) { |cmd| cmd.read.chomp }
+    fail "Command failed: #{input}" unless $CHILD_STATUS == 0
+    result
+  rescue Errno::ENOENT
+    raise "Command not found: #{input}"
+  end
+end

data/lib/helpers/default.rb

@@ -1,6 +1,10 @@
+##
+# Provides a helper to have default values
+
 class HSS::Parser
-    def default(a, b)
-        (a.nil? or a.empty?) ? b : a
-    end
-end
+  private
 
+  def default(a, b)
+    a.nil? || a.empty? ? b : a
+  end
+end

data/lib/helpers/expand.rb

@@ -1,7 +1,13 @@
+##
+# Expand a shortcode based the config hash
+
 class HSS::Parser
-    def expand(input)
-        @config['expansions'].each { |long, shorts| return long if shorts.include? input }
-        raise NameError, "No expansion found for: #{input}"
+  private
+
+  def expand(input)
+    @config['expansions'].each do |long, shorts|
+      return long if shorts.include? input
     end
+    fail NameError, "No expansion found for: #{input}"
+  end
 end
-

data/lib/helpers/external.rb

@@ -0,0 +1,21 @@
+require 'yaml'
+
+##
+# Load values from an external YAML hash
+
+class HSS::Parser
+  private
+
+  def external(source, key)
+    begin
+      config = open(File.expand_path(source)) { |f| YAML.load f.read }
+    rescue Psych::SyntaxError, Errno::ENOENT
+      raise "Failed to open YAML file: #{source}"
+    end
+    begin
+      key.split('.').reduce(config) { |a, e| a[e] } || fail
+    rescue
+      raise NameError, "Key not found in YAML: #{key}"
+    end
+  end
+end

data/lib/helpers/shortcut.rb

@@ -1,6 +1,12 @@
+##
+# Allow shortcut expansion from the config
+
 class HSS::Parser
-    def shortcut(input)
-        return @config['shortcuts'][input]
-    end
-end
+  private
 
+  def shortcut(input)
+    @config['shortcuts'][input] || fail
+  rescue
+    raise NameError, "Shortcut does not exist #{input}"
+  end
+end

data/lib/hss.rb

@@ -1,68 +1,108 @@
 require 'yaml'
 require 'pathname'
-require 'erb'
+require 'version'
+
+##
+# HSS module provides a helper for SSH shortcuts
 
 module HSS
-    Version = '0.2.4'
-    Default_Config = '~/.hss.yml'
-    Default_Library = Pathname.new(__FILE__).realpath.split()[0].to_s + '/helpers'
+  DEFAULT_CONFIG = '~/.hss.yml'
+  DEFAULT_LIBRARY = Pathname.new(__FILE__).realpath.split[0].to_s + '/helpers'
 
-    class << self
-        def new(*args)
-            HSS::Handler.new(*args)
-        end
+  class << self
+    ##
+    # Insert a helper .new() method for creating a new Cache object
+
+    def new(*args)
+      HSS::Handler.new(*args)
     end
+  end
 
-    class Handler
-        attr_reader :patterns, :config
+  ##
+  # Handlers load configurations and control their use
 
-        def initialize(config_path = nil, helper_path = nil)
-            load_config(config_path)
-            load_parser(helper_path)
-        end
+  class Handler
+    attr_reader :patterns, :config, :helpers
 
-        def load_config(config_path = nil)
-            begin
-                @config = YAML.load open(File.expand_path(config_path || HSS::Default_Config)).read
-                @patterns = @config.delete('patterns')
-            rescue
-                raise "Failed to load config: #{config_path}"
-            end
-        end
+    ## Make a new handler with a config and parser
 
-        def load_parser(helper_path = nil)
-            Dir::glob((helper_path || HSS::Default_Library) + '/*').each do |helper|
-                begin
-                    require_relative helper
-                rescue LoadError
-                    raise LoadError, "Failed to load helper: #{helper}"
-                end
-            end
-            @parser = HSS::Parser.new(@config)
-        end
+    def initialize(params = {})
+      params = { config: params } if params.is_a? String
+      load_config(params[:config])
+      @helpers = []
+      load_helpers(params[:helpers])
+      @parser = HSS::Parser.new(@config)
+    end
 
-        def handle(input)
-            @patterns.each do |pattern|
-                next unless @parser.check(input, pattern['short'])
-                return @parser.parse(pattern['long'])
-            end
-            raise "Couldn't find a matching host for: #{input}"
-        end
+    ##
+    # Check patterns for a match and parse the long form
+
+    def handle(input)
+      @patterns.each do |pattern|
+        next unless @parser.check(input, pattern['short'])
+        return @parser.parse(pattern['long'])
+      end
+      fail "Couldn't find a matching host for: #{input}"
     end
 
-    class Parser
-        def initialize(config)
-            @config = config
-        end
+    private
 
-        def check(input, short_form)
-            return false unless input.match short_form
-            @match_data = binding
-            true
-        end
-        def parse(long_form)
-            eval '"' +  long_form + '"', @match_data
+    ##
+    # Load the config file
+
+    def load_config(config_path = nil)
+      path = File.expand_path(config_path || HSS::DEFAULT_CONFIG)
+      @config = YAML.load open(path).read
+      @patterns = @config.delete('patterns') || fail
+    rescue Psych::SyntaxError, RuntimeError, Errno::ENOENT
+      raise "Failed to load config: #{config_path}"
+    end
+
+    ##
+    # Load helper modules
+
+    def load_helpers(helper_path = nil)
+      helper_path ||= HSS::DEFAULT_LIBRARY
+      helper_path = File.absolute_path(helper_path)
+      Dir.glob(helper_path + '/*').each do |helper|
+        begin
+          require helper
+          @helpers << helper
+        rescue LoadError, SyntaxError
+          raise LoadError, "Failed to load helper: #{helper}"
         end
+      end
+    end
+  end
+
+  ##
+  # Parser objects exist as containers for helper methods
+
+  class Parser
+    ##
+    # The config is scoped here so it is available to helpers
+
+    def initialize(config)
+      @config = config
     end
-end
 
+    ##
+    # Check for a match
+    # If the input matches, store the context for use in helpers
+
+    def check(input, short_form)
+      return false unless input.match short_form
+      x = Regexp.last_match # rubocop:disable UselessSetterCall
+      @match_data = binding
+      true
+    end
+
+    ##
+    # Evaluate the long_form using the stored context
+
+    def parse(long_form)
+      a = eval '%Q{' + long_form + '}', @match_data # rubocop:disable Eval
+      a == long_form ? a : parse(a)
+    end
+  end
+end