shelldon 0.0.1 → 0.0.7

data/lib/config/param/boolean_param.rb

@@ -10,7 +10,7 @@ module Shelldon
         v
       elsif v.is_a?(String)
         return true   if v == true || v =~ (/(true|t|yes|y|1)$/i)
-        return false  if v == false || v.blank? || v =~ (/(false|f|no|n|0)$/i)
+        return false  if v == false || v =~ (/(false|f|no|n|0)$/i)
         fail(ArgumentError, "invalid value for Boolean: \"#{v}\"")
       else
         v ? true : false

data/lib/config/param_factory.rb

@@ -21,6 +21,10 @@ module Shelldon
       @default = default_value
     end
 
+    def override(value)
+      @override = value
+    end
+
     def opt(opt)
       @opt = opt
     end
@@ -30,13 +34,14 @@ module Shelldon
       if @param
         @param.pretty    = @pretty_proc if @pretty_proc
         @param.default   = @default unless @default.nil?
+        @param.override  = @override if @override
         @param.opt       = @opt if @opt
         @param.error     = @error if @error
         @param.validator = @validator if @validator
         @param.adjustor  = @adjustor if @adjustor
         @config.register(@param)
       else
-        fail StandardError
+        fail Shelldon::RegisterNilParamError
       end
     end
 

data/lib/dsl.rb

@@ -7,6 +7,10 @@ module Shelldon
     ShellIndex.instance << shell if shell.is_a?(Shelldon::Shell)
   end
 
+  def self.first?(sym)
+    ShellIndex.first?(sym)
+  end
+
   def self.shell(name = (:default), &block)
     ShellFactory.new(name.to_sym, &block)
   end
@@ -18,4 +22,17 @@ module Shelldon
   def self.opts
     Shelldon::Opts.instance.opts
   end
+
+  def self.method_missing(meth, *args, &block)
+    ShellIndex.instance[:default].send(meth, *args, &block)
+  end
+
+  def self.confirm(*args)
+    Shelldon::Confirmation.ask(*args)
+  end
+
+  def self.has_shell?(sym)
+    sym = sym.to_sym unless sym
+    ShellIndex.instance.key?(sym)
+  end
 end

data/lib/{Exceptions → exceptions}/error_factory.rb

@@ -1,5 +1,7 @@
 module Shelldon
   class ErrorFactory
+    attr_reader :on_accept_error, :on_reject_error
+
     def initialize(&block)
       @accept_errors = {}
       @reject_errors = {}
@@ -19,6 +21,14 @@ module Shelldon
       @reject_errors[e] = (block_given? ? block : nil)
     end
 
+    def on_accept(&block)
+      @on_accept_error = block
+    end
+
+    def on_reject(&block)
+      @on_reject_error = block
+    end
+
     def get
       [@accept_errors, @reject_errors]
     end

data/lib/exceptions/exceptions.rb

@@ -0,0 +1,60 @@
+module Shelldon
+  class Error < StandardError
+  end
+
+  class ConfirmationError < Error
+    define_method(:message) { 'User did not provide a valid confirmation.' }
+  end
+
+  class NotImplementedError < Error
+    define_method(:message) { 'This command has not been implemented, or is a placeholder' }
+  end
+
+  class NoSuchCommandError < Error
+    define_method(:message) { 'No such command exists' }
+  end
+
+  class NotBooleanError < Error
+    define_method(:message) { 'The specified config param is not a boolean' }
+  end
+
+  class NotProcError < Error
+    define_method(:message) { 'Autocomplete must be a Proc or an Array' }
+  end
+
+  class DuplicateParamError < Error
+    define_method(:message) { 'Cannot create two params with the same name' }
+  end
+
+  class NoSuchParamError < Error
+    define_method(:message) { 'No such param exists' }
+  end
+
+  class InvalidParamValueError < Error
+    define_method(:message) { 'Param failed to pass validation' }
+  end
+
+  class RegisterNilParamError < Error
+    define_method(:message) { 'The Param Factory is attempting to register a nil.' }
+  end
+
+  class NoSuchOptTypeError < Error
+    define_method(:message) { 'The specified opt type was not :boolean or :required' }
+  end
+
+  class RedefineOptsError < Error
+    define_method(:message) { 'Cannot re-define opts' }
+  end
+
+  class NoSuchShellError < Error
+    define_method(:message) { 'The shell index does not contain that shell' }
+  end
+
+  class NotAShellError < Error
+    define_method(:message) { 'Cannot add non-shells to the shell index' }
+  end
+
+  class TimeoutError < Error
+    define_method(:message) { 'Operation timed out.' }
+  end
+end

data/lib/file_management/config_file_manager.rb

@@ -4,24 +4,20 @@ module Shelldon
   class ConfigFileManager < YamlManager
     def initialize(shell, config_file)
       @shell = shell
-      @config_file = config_file
+      @file = config_file
     end
 
     def ensure_dir(dir)
       FileUtils.mkdir_p(dir)
     end
 
-    def ensure_file(file)
-      File.open(file, 'w') { |f| f.write({}.to_yaml) } unless File.exist?(file)
-    end
-
     def export
       super(@shell.config)
     end
 
     def setup
-      @file     = @config_file.expand_path
-      @file_dir = @config_file.dirname.expand_path
+      @file     = @file.expand_path
+      @file_dir = @file.dirname.expand_path
       ensure_dir(@file_dir)
       ensure_file(@file)
     end

data/lib/file_management/history_file.rb

@@ -10,8 +10,6 @@ module Shelldon
       @file = Pathname.new(@file).expand_path
       hist  = File.open(@file, 'r') { |f| f.read }.split("\n")
       hist.each do |line|
-        # puts line
-        # pp Readline::HISTORY.to_a
         Readline::HISTORY.push(line)
       end
     end

data/lib/file_management/yaml_manager.rb

@@ -1,4 +1,3 @@
-
 module Shelldon
   class YamlManager < FileManager
     def ensure_file(file)
@@ -10,7 +9,17 @@ module Shelldon
     end
 
     def import(_yaml)
+      reset unless valid?
       YAML.load_file(@file)
     end
+
+    def valid?
+      File.exist?(@file) && !File.zero?(@file)
+    end
+
+    def reset
+      FileUtils.mv(@file, "#{@file}-#{Time.now.strftime('%y%m%d-%k%M%S')}.invalid")
+      ensure_file(@file)
+    end
   end
 end

data/lib/helpers/confirmation.rb

@@ -0,0 +1,20 @@
+module Shelldon
+  class Confirmation
+    def self.ask(*args)
+      new(*args).ask
+    end
+
+    def initialize(msg = 'Confirm? (y/n)',
+                   ok = %w(y Y yes Yes YES))
+      @msg = msg
+      @ok  = ok
+    end
+
+    def ask
+      puts @msg
+      print '> '
+      response = $stdin.gets.chomp
+      @ok.include?(response) ? true : fail(Shelldon::ConfirmationError)
+    end
+  end
+end

data/lib/helpers/timer.rb

@@ -1,5 +1,10 @@
 module Shelldon
   class Timer
+    def self.start
+      t = new
+      t.start
+      t
+    end
     def initialize(strftime = '%s')
       @strftime = strftime
     end

data/lib/opts/opt_factory.rb

@@ -1,9 +1,10 @@
 module Shelldon
   class OptFactory
-    def initialize(&block)
+    def initialize(name, &block)
+      @name    = name
       @opt_arr = []
       instance_eval(&block)
-      Shelldon.opts = get_opts
+      Shelldon.opts = get_opts if Shelldon.first?(@name)
     end
 
     def get_opts
@@ -23,7 +24,7 @@ module Shelldon
       when :required
         Getopt::REQUIRED
       else
-        fail StandardError
+        fail Shelldon::NoSuchOptTypeError
       end
     end
   end

data/lib/opts/opts.rb

@@ -6,7 +6,7 @@ module Shelldon
     end
 
     def set(opts_arr)
-      fail StandardError unless @opts.nil?
+      fail Shelldon::RedefineOptsError unless @opts.nil?
       @opts ||= opts_arr
     end
   end

data/lib/shell/shell.rb

@@ -1,11 +1,11 @@
-require 'byebug'
 require 'readline'
+require_relative '../auto_complete'
+# require 'byebug'
 
 module Shelldon
   class Shell
-    attr_accessor :command_list, :config,
-                  :accept_errors, :reject_errors
-    attr_reader :home, :name
+    attr_accessor :command_list, :config, :accept_errors, :reject_errors, :on_opts, :on_pipe
+    attr_reader :home, :name, :config, :logger
     attr_writer :history, :history_file
 
     def initialize(name, &block)
@@ -15,25 +15,39 @@ module Shelldon
       @errors        = {}
       @history       = true
       @command_list  = CommandList.new(self)
-      @config        = Config.new(self)
+      @config        = Shelldon::Config.new(self)
+      @autocomplete  = Shelldon::AutoComplete.new(self) # if defined?(Shelldon::AutoComplete)
+      @on_opts       = {}
       setup(&block) if block_given?
     end
 
+    def shell
+      self
+    end
+
     def self.method_missing(meth_name, *args, &block)
       Shelldon::ShellIndex[:default].send(meth_name, *args, &block)
     end
 
+    def self.[](key)
+      fail Shelldon::NoSuchShellError unless Shelldon::ShellIndex[key]
+      Shelldon::ShellIndex[key]
+    end
+
     def setup(&block)
       instance_eval(&block)
-      FileUtils.mkdir_p(@home.to_s) unless File.exist?(@home)
+      FileUtils.mkdir_p(@home.to_s) unless File.exist?(@home) if @home
       Dir.chdir(@home) if @home
-      Readline.completion_proc = proc { [] }
+      if @auto_complete_proc
+        Readline.completion_proc = @auto_complete_proc
+      else
+        @autocomplete.set_proc if @autocomplete
+      end
+
       if @history_path && @history
         @history_helper = Shelldon::HistoryFile.new(@history_path)
-        @history_helper.load if @history_helper
       end
       @config.load_config_file
-      run
     end
 
     def quit
@@ -42,35 +56,65 @@ module Shelldon
       exit 0
     end
 
+    def run_opt_conditions
+      @on_opts.each do |opt, procs|
+        if Shelldon.opts && Shelldon.opts.key?(opt)
+          procs.each do |proc|
+            instance_eval(&proc)
+          end
+        end
+      end
+    end
+
+    def handle_piped_input
+      return if $stdin.tty?
+      if @on_pipe
+        instance_exec($stdin.readlines, &@on_pipe)
+      else
+        $stdin.readlines.each { |cmd| run_commands(cmd) }
+      end
+      exit 0
+    end
+
     def run
+      @history_helper.load
+      run_opt_conditions
+      handle_piped_input
       instance_eval(&@startup) if @startup
       begin
         run_repl
       rescue *@accept_errors.keys => e
         print_error(e)
-        on_error(e, @accept_errors[e.class])
+        @logger.warn(e)
+        on_error(e, @accept_errors[e.class], :accept)
         retry
       rescue *@reject_errors.keys => e
         print_error(e)
-        on_error(e, @reject_errors[e.class])
+        @logger.fatal(e)
+        on_error(e, @reject_errors[e.class], :reject)
       rescue StandardError => e
         print_error(e)
         puts "Reached fatal error. G'bye!"
-        raise e
       ensure
+        # puts "Last exception: #{$!.inspect}" #if @config[:debug_mode]
+        # puts "Last backtrace: \n#{$@.join("\n")}"# if @config[:debug_mode]
         instance_eval(&@shutdown) if @shutdown
         @history_helper.save if @history_helper
         quit
       end
     end
 
-    def on_error(e, proc)
-      instance_exec(e, &proc)
+    def on_error(e, proc, type = nil)
+      run_accept_error(e) if type == :accept
+      run_reject_error(e) if type == :reject
+      instance_exec(e, &proc) if proc
     end
 
     def print_error(e)
-      return false unless @config[:debug_mode]
-      puts e.message
+      return unless @config[:debug_mode]
+      puts "Hit Error! (#{e.class})"
+      msg = (e.message == e.class.to_s ? '' : "(#{e.message})")
+      puts msg unless msg == '()'
       puts e.backtrace.join("\n")
     end
 
@@ -101,7 +145,7 @@ module Shelldon
     end
 
     def run_command(cmd)
-      @history_helper << cmd
+      @history_helper << cmd if @history_helper
       run_precommand(cmd)
       @command_list.run(cmd)
       run_postcommand(cmd)
@@ -115,6 +159,14 @@ module Shelldon
       instance_exec(cmd, &@post_command) if @post_command
     end
 
+    def run_accept_error(error)
+      instance_exec(error, &@on_accept_error) if @on_accept_error
+    end
+
+    def run_reject_error(error)
+      instance_exec(error, &@on_reject_error) if @on_reject_error
+    end
+
     def init(&block)
       instance_eval(&block)
     end
@@ -131,6 +183,11 @@ module Shelldon
       @history_path = file
     end
 
+    def log_file(filepath, freq = 'daily')
+      filepath = Pathname.new(filepath).expand_path.to_s
+      @logger = Logger.new(filepath, freq)
+    end
+
     def prompt(str = '> ', &block)
       if block_given?
         @prompt_setter = block
@@ -160,8 +217,14 @@ module Shelldon
     end
 
     def errors(&block)
-      @accept_errors, @reject_errors =
-          Shelldon::ErrorFactory.new(&block).get
+      error_factory = Shelldon::ErrorFactory.new(&block)
+      @accept_errors, @reject_errors = error_factory.get
+      @on_accept_error = error_factory.on_accept_error
+      @on_reject_error = error_factory.on_reject_error
+    end
+
+    def autocomplete(&block)
+      @auto_complete_proc = block.to_proc
     end
   end
 end