shelldon 0.0.1 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1050dd8126c65561d242ce862a4cf2947ed61618
-  data.tar.gz: fd6ad927cc21f2087011bd1584e652d4b4ac415d
+  metadata.gz: 4c9b127c3231b3a6616c774fe92a69847b25bb10
+  data.tar.gz: d9a68228b4bcfe2ac70c55123c3b08ce99ca4a41
 SHA512:
-  metadata.gz: f9a2c2be6b2cba4b8bd61fa6b666fd1b5daf9d15bc9d8d04eb2c1bfb2c7811aa3836f18357d779d8ca86ef6f98b9fbe64cdcbb2c0c48f23d2ee0150bb1a767c4
-  data.tar.gz: 168ab3b8d30c478081e3d2dbac3f032f5b74f93d93736c618eb2909e235207eb5f0bcf9a409bdb75ae8bf440b05c270aee8148e81feb79fcdea04d457f77787d
+  metadata.gz: 3b2f291dd74ff9ab4e29f2626a3331f93a72da07629f0f3eb6026466b188eff6e4b92af70c3371f41bc0eddc03fd6bc6787768ef8b45270389d95551f51828e3
+  data.tar.gz: 413aa23e7e03186a0d6684c3a74b38226f6d8f7ee05a46dcab1297638122446667efb1ec3c38db8864afefb0bf9e55f638cfb1a3acd1b2be3ed17d71e02e519d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+send_to_opsadm01.sh

data/.rubocop.yml

@@ -0,0 +1,60 @@
+#inherit_from: ../.rubocop.yml
+
+# Why do I even use robocop lol
+# Oh yeah because it puts a space in before my comments.
+
+AllCops:
+  Exclude:
+    - test_scripts/*
+    - example_data/*
+
+Metrics/LineLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false
+
+Style/Semicolon:
+  Enabled: false
+
+Style/AccessorMethodName:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/PredicateName:
+  Enabled: false
+
+Style/NestedTernaryOperator:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false

data/Gemfile

@@ -1,8 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'byebug'
-gem 'terminal-table'
-gem 'rb-readline'
-gem 'getopt'
-
 gemspec

data/README.md

@@ -10,7 +10,6 @@ There are some good gems out there for building command-line executables, but I
 # Gemfile
 gem 'shelldon'
 
-
 $ bundle install
 ```
 Or just `gem install shelldon` -- You know the drill.

data/lib/auto_complete.rb

@@ -0,0 +1,34 @@
+# require 'abbrev'
+
+module Shelldon
+  class AutoComplete
+    def initialize(shell)
+      @shell = shell
+    end
+
+    def set_proc
+      @comp                                    = proc { |s| auto_comp.grep(/^#{Regexp.escape(s)}/) }
+      Readline.completion_append_character     = ' '
+      Readline.completion_proc                 = @comp
+    end
+
+    def buf
+      Readline.line_buffer
+    end
+
+    def auto_comp
+      Readline.completion_append_character = ' '
+      @commands = @shell.command_list.commands.map(&:to_s)
+      length = buf.split(' ').length
+      return @commands if length <= 1 && !buf.end_with?(' ')
+      cmd, = @shell.command_list.find(buf)
+      return [] unless cmd
+      remainder = buf.gsub("#{cmd.christian_name} ", '')
+      cmd.complete(remainder)
+    end
+
+    def tokenize(str)
+      str.split(' ')
+    end
+  end
+end

data/lib/command/command.rb

@@ -1,6 +1,6 @@
 module Shelldon
   class Command
-    attr_reader :name, :aliases, :subcommands, :parent
+    attr_reader :name, :aliases, :subcommands, :parent, :autocomplete, :times_out
 
     def initialize(name, parent, &block)
       @name        = name
@@ -8,6 +8,7 @@ module Shelldon
       @subcommands = {}
       @show        = true
       @parent      = parent
+      @times_out   = true
       instance_eval(&block)
     end
 
@@ -19,8 +20,12 @@ module Shelldon
       end
     end
 
+    def fuzzy(cmd)
+      FuzzyMatch.new(command_list.to_a.map(&:first).map(&:to_s)).find(cmd)
+    end
+
     def command_list
-      @parent
+      @parent.command_list
     end
 
     def shell
@@ -34,8 +39,10 @@ module Shelldon
     end
 
     def run(tokens = [])
-      tokens = [tokens] unless tokens.is_a?(Array)
-      instance_exec(tokens.join(' '), &@action)
+      tokens         = [tokens] unless tokens.is_a?(Array)
+      Timeout.timeout(timeout_length, Shelldon::TimeoutError) do
+        instance_exec(tokens.join(' '), &@action)
+      end
     end
 
     def valid?(input)
@@ -47,10 +54,6 @@ module Shelldon
       end
     end
 
-    def auto_complete(_input)
-      @autocomplete = @subcommands.values
-    end
-
     def has_subcommand?
       !@subcommands.empty?
     end
@@ -98,14 +101,41 @@ module Shelldon
       end
     end
 
-    def timeout(i = nil)
-      i ? @timeout = i : @timeout
+    def to_a
+      [@name, @aliases.map { |a| "'#{a}'" }.join(', '), @help || '']
+    end
+
+    def sub_to_a
+      @subcommands.values.uniq
+        .map { |cmd| cmd.show ? cmd.to_a : nil }
+        .compact.sort_by { |(n, _, _)| n.to_s }
+    end
+
+    def timeout_length(_i = nil)
+      return 0 unless @times_out
+      return shell.config[:timeout] unless @timeout
+      @timeout
+    end
+
+    def complete(buf)
+      length = buf.split(' ').length
+      res    = (length <= 1 && !buf.end_with?(' ')) ? subcommand_list : []
+      res += instance_exec(buf, &@autocomplete) if @autocomplete
+      res
     end
 
     # DSL Only
 
     private
 
+    def times_out(bool = true)
+      @times_out = bool
+    end
+
+    def timeout(i = nil)
+      i ? @timeout = i : @timeout
+    end
+
     def validate(error, &block)
       @error     = error if error
       @validator = block
@@ -123,12 +153,34 @@ module Shelldon
       @subcommands[name.to_sym] = Shelldon::Command.new(name, self, &block)
     end
 
+    def subcommand_list
+      return [] if @subcommands.empty?
+      @subcommands.keys.map(&:to_s)
+    end
+
+    def script(dir)
+      Shelldon::Script.from_dir(dir, self).each do |cmd|
+        @subcommands[cmd.name.to_sym] = cmd
+      end
+    end
+
+    alias_method :scripts, :script
+
     def completion(arr = [], &block)
       @completion = (block_given? ? block : arr)
     end
 
     def placeholder
-      @action = proc { fail StandardError }
+      @action = proc { fail Shelldon::NotImplementedError }
+    end
+
+    def autocomplete(arr = nil, &block)
+      if block_given?
+        @autocomplete = block.to_proc
+      else
+        arr ||= []
+        @autocomplete = proc { arr }
+      end
     end
   end
 end

data/lib/command/command_list.rb

@@ -13,6 +13,10 @@ module Shelldon
       command.aliases.each { |a| @commands[a.to_sym] = command }
     end
 
+    def command_list
+      self
+    end
+
     def register_default(cmd)
       @default_command = cmd
     end
@@ -38,11 +42,11 @@ module Shelldon
     end
 
     def compile_help(cmd)
-      res = [['Command', cmd.christian_name]]
-      res << ['Help', cmd.help] if cmd.help
-      res << ['Usage', "\"#{cmd.usage}\""] if cmd.usage
-      res << ['Examples', cmd.examples] if cmd.examples
-      res << ['Subcommands', cmd.subcommands.values.map(&:name)] unless cmd.subcommands.empty?
+      res               = { command: cmd.christian_name }
+      res[:help]        = cmd.help if cmd.help
+      res[:usage]       = "\"#{cmd.usage}\"" if cmd.usage
+      res[:examples]    = cmd.examples if cmd.examples
+      res[:subcommands] = cmd.subcommands.values.map(&:name).join(', ') unless cmd.subcommands.empty?
       res
     end
 
@@ -52,9 +56,9 @@ module Shelldon
       else
         cmd = find(str).first
         if cmd.show && !is_default?(cmd)
-          compile_help(cmd)
+          [compile_help(cmd), cmd.sub_to_a]
         else
-          fail StandardError
+          fail Shelldon::NoSuchCommandError
         end
       end
     end
@@ -65,8 +69,12 @@ module Shelldon
 
     def to_a
       @commands.values.uniq
-        .map { |cmd| cmd.show ? [cmd.name, cmd.aliases, cmd.help] : nil }
+        .map { |cmd| cmd.show ? cmd.to_a : nil }
         .compact.sort_by { |(n, _, _)| n.to_s }
     end
+
+    def commands
+      @commands.keys
+    end
   end
 end

data/lib/command/script.rb

@@ -0,0 +1,33 @@
+module Shelldon
+  class Script < Command
+    def self.from_dir(dir, shell)
+      commands = []
+      Dir["#{Pathname.new(dir).expand_path}/*"].reject { |f| File.directory?(f) }.each do |script|
+        commands << new(script, shell.command_list)
+      end
+      commands
+    end
+
+    def initialize(filepath, parent, &block)
+      @path = Pathname.new(filepath)
+      @name        = @path.basename.to_s.split('.')[0].to_sym
+      @aliases     = []
+      @subcommands = {}
+      @show        = true
+      @parent      = parent
+      instance_eval(&block) if block_given?
+    end
+
+    def run(tokens = [], &block)
+      tokens = [tokens] unless tokens.is_a?(Array)
+      cmd = "#{@path.expand_path}"
+      cmd << " #{tokens.join(' ')}" unless tokens.empty?
+      res = `#{@path.expand_path} #{tokens.join(' ')}`
+      if block_given?
+        instance_exec(res, &block)
+      else
+        puts res
+      end
+    end
+  end
+end

data/lib/config/config.rb

@@ -20,8 +20,13 @@ module Shelldon
       load_config_file
     end
 
+    def toggle(key)
+      fail Shelldon::NotBooleanError unless @config[key].is_a?(Shelldon::BooleanParam)
+      @config[key].toggle
+    end
+
     def register(param)
-      fail StandardError if @config.key?(param.name)
+      fail Shelldon::DuplicateParamError if @config.key?(param.name)
       @config[param.name] = param
     end
 
@@ -43,7 +48,7 @@ module Shelldon
     end
 
     def to_a
-      @config.map { |k, v| [k, v.pretty] }.sort_by(&:first)
+      @config.values.map(&:to_a).sort_by(&:first)
     end
 
     def to_hash
@@ -54,7 +59,7 @@ module Shelldon
       if @config.key?(key.to_sym)
         true
       else
-        raise ? fail(StandardError) : false
+        raise ? fail(Shelldon::NoSuchParamError) : false
       end
     end
 
@@ -67,7 +72,11 @@ module Shelldon
       # Then we validate them all
       hash.each do |k, v|
         key = k.to_sym
-        @config.key?(key) ? set(key, v) : fail(StandardError)
+        if @config.key?(key)
+          set(key, v) unless @config[key].override || Shelldon.opts.key?(@config[key].opt)
+        else
+          fail(Shelldon::NoSuchParamError)
+        end
       end
       hash.each do |k, _|
         @config[k].valid? unless @config[k].val == @config[k].default

data/lib/config/config_factory.rb

@@ -1,5 +1,9 @@
+require 'logger'
+
 module Shelldon
   class ConfigFactory
+    attr_accessor :on_opts, :config_file_manager
+
     def self.create(shell, &block)
       ConfigFactory.new(shell, &block)
     end

data/lib/config/param.rb

@@ -1,6 +1,6 @@
 module Shelldon
   class Param
-    attr_accessor :pretty, :default, :opt, :validator, :adjustor, :error
+    attr_accessor :pretty, :default, :opt, :validator, :adjustor, :error, :override
     attr_reader :name
 
     def self.create(name, &block)
@@ -13,20 +13,14 @@ module Shelldon
     end
 
     def val
-      if @val.nil?
-        if Shelldon.opts.key?(@opt)
-          Shelldon.opts[@opt]
-        else
-          @default
-        end
-      else
-        @val
-      end
+      return @val if @val
+      return @override if @override
+      @val = Shelldon.opts.key?(@opt) ? Shelldon.opts[@opt] : @default
     end
 
     def val=(value)
       value = instance_exec(value, &adjustor) if adjustor
-      valid?(value) ? @val = value : fail(StandardError)
+      valid?(value) ? @val = value : fail(Shelldon::InvalidParamValueError)
     end
 
     def set(value)
@@ -34,6 +28,18 @@ module Shelldon
       @val  = value
     end
 
+    def to_a
+      flag =
+        if @opt.nil?
+          ''
+        elsif @opt.length > 1
+          "'--#{@opt}'"
+        else
+          "'-#{@opt}'"
+        end
+      [@name, pretty, "#{flag}"]
+    end
+
     def pretty
       if @pretty
         instance_exec(val, &@pretty)