bcome 1.3.2 → 1.4.0

data/lib/objects/loading_bar/indicator/base.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Bcome
+  module LoadingBar
+    module Indicator
+      class Base
+        CHARACTERS = %w[⣾ ⣷ ⣯ ⣟ ⡿ ⢿ ⣻ ⣽].freeze
+
+        SIGNAL_SUCCESS = 'USR1'
+        SIGNAL_FAILURE = 'USR2'
+        SIGNAL_STOP = 'SIGKILL'
+
+        def initialize(config = {})
+          @progress_size = config[:size]
+          @title = config[:title]
+          @completed_title = config[:completed_title]
+
+          @current_character = 0
+          @progression = ''
+          @results = []
+        end
+
+        def indicate
+          print "\n"
+          loop do
+            increment
+            show
+          end
+        end
+
+        def show
+          raise 'Should be overidden'
+        end
+
+        def increment_success
+          raise 'Should be overidden'
+        end
+
+        def increment_failure
+          raise 'Should be overidden'
+        end
+
+        private
+
+        def increment
+          @current_character += 1
+          @current_character = 0 if completed_cycle?
+        end
+
+        def completed_cycle?
+          @current_character == CHARACTERS.length
+        end
+
+        def progressed_glyph
+          CHARACTERS[0]
+        end
+
+        def glyph
+          CHARACTERS[@current_character]
+        end
+      end
+    end
+  end
+end

data/lib/objects/loading_bar/indicator/basic.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Bcome
+  module LoadingBar
+    module Indicator
+      class Basic < Base
+        def initialize(*params)
+          super
+          @progress_colour = :bc_green
+        end
+
+        def show(done = false)
+          print "\r#{progress_prefix}#{done ? "\s#{@completed_title}\s" : ''}\s"
+        rescue ThreadError
+        end
+
+        def progress_prefix
+          "#{@title}\s#{glyph.send(progress_colour)}"
+        end
+
+        attr_reader :progress_colour
+
+        def increment_success
+          done = true
+          show(done)
+        end
+
+        def increment_failure
+          @progress_colour = :bc_red
+        end
+      end
+    end
+  end
+end

data/lib/objects/loading_bar/indicator/progress.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Bcome
+  module LoadingBar
+    module Indicator
+      class Progress < Base
+        def show
+          line = ''
+          @results.map { |r| line += (r == 1 ? progressed_glyph.to_s.bc_green.bold : progressed_glyph.to_s.bc_red.bold) }
+          line += glyph.bc_orange.to_s * (@progress_size - @results.size)
+          print "\r#{@title}\s#{line}\s(#{@results.size}/#{@progress_size})\s"
+        end
+
+        def increment_success
+          @results << 1
+          @progression += progressed_glyph.bc_green.bold
+        end
+
+        def increment_failure
+          @results << 0
+          @progression += progressed_glyph.bc_red.bold
+        end
+      end
+    end
+  end
+end

data/lib/objects/loading_bar/pid_bucket.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Bcome
+  module LoadingBar
+    class PidBucket
+      include Singleton
+
+      def initialize
+        @pids = []
+      end
+
+      def <<(pid)
+        @pids << pid
+      end
+
+      def -(pid)
+        @pids -= [pid]
+      end
+
+      def stop_all
+        @pids.map do |pid|
+          ::Process.kill(::Bcome::LoadingBar::Indicator::Base::SIGNAL_STOP, pid)
+        end
+      end
+    end
+  end
+end

data/lib/objects/modules/context.rb

@@ -1,13 +1,17 @@
-module Bcome::Context
-  def is_current_context?
-    ::Bcome::Workspace.instance.object_is_current_context?(self)
-  end
+# frozen_string_literal: true
 
-  def irb_workspace=(workspace)
-    @irb_workspace = workspace
-  end
+module Bcome
+  module Context
+    def current_context?
+      ::Bcome::Workspace.instance.object_is_current_context?(self)
+    end
+
+    def irb_workspace=(workspace)
+      @irb_workspace = workspace
+    end
 
-  def previous_irb_workspace=(workspace)
-    @previous_workspace = workspace
+    def previous_irb_workspace=(workspace)
+      @previous_workspace = workspace
+    end
   end
 end

data/lib/objects/modules/registry_management.rb

@@ -1,14 +1,20 @@
-module Bcome::Node::RegistryManagement
-  def user_command_wrapper
-    @user_command_wrapper ||= ::Bcome::Registry::CommandList.instance.group_for_node(self)
-  end
+# frozen_string_literal: true
+
+module Bcome
+  module Node
+    module RegistryManagement
+      def user_command_wrapper
+        @user_command_wrapper ||= ::Bcome::Registry::CommandList.instance.group_for_node(self)
+      end
 
-  def registry
-    command_group = user_command_wrapper
-    if command_group && command_group.has_commands?
-      command_group.pretty_print
-    else
-      puts "\nYou have no registry commands configured for this namespace.\n".warning
+      def registry
+        command_group = user_command_wrapper
+        if command_group&.has_commands?
+          command_group.pretty_print
+        else
+          puts "\nYou have no registry commands configured for this namespace.\n".warning
+        end
+      end
     end
   end
 end

data/lib/objects/modules/ui_output.rb

@@ -1,9 +1,13 @@
-module Bcome::UiOutput
-  def output_error(string)
-    no_console_output(string.error)
-  end
+# frozen_string_literal: true
+
+module Bcome
+  module UiOutput
+    def output_error(string)
+      no_console_output(string.error)
+    end
 
-  def no_console_output(string)
-    puts "\t\n#{string}\n\n"
+    def no_console_output(string)
+      puts "\t\n#{string}\n\n"
+    end
   end
 end

data/lib/objects/modules/workspace_commands.rb

@@ -1,197 +1,201 @@
-module Bcome::WorkspaceCommands
-  def ls(active_only = false)
-    puts "\n\n" + visual_hierarchy.hierarchy + "\n"
-    puts "\t" + "Available #{list_key}s:".title + "\n\n"
-
-    iterate_over = active_only ? @resources.active : @resources
-
-    if iterate_over.any?
-      iterate_over.sort_by(&:identifier).each do |resource|
-        is_active = @resources.is_active_resource?(resource)
-        puts resource.pretty_description(is_active)
-        puts "\n"
+# frozen_string_literal: true
+
+module Bcome
+  module WorkspaceCommands
+    def ssh_connect(params = {})
+      ::Bcome::Ssh::Connector.connect(self, params)
+    end
+
+    def ls(node = self, active_only = false)
+      if node != self && (resource = resources.for_identifier(node))
+        resource.send(:ls, active_only)
+      else
+        puts "\n\n" + visual_hierarchy.hierarchy + "\n"
+        puts "\t" + "Available #{list_key}s:" + "\n\n"
+
+        iterate_over = active_only ? @resources.active : @resources
+
+        if iterate_over.any?
+
+          iterate_over.sort_by(&:identifier).each do |resource|
+            next if resource.hide?
+
+            is_active = @resources.is_active_resource?(resource)
+            puts resource.pretty_description(is_active)
+
+            puts "\n"
+          end
+        else
+          puts "\tNo resources found".informational
+        end
+
+        new_line
+        nil
       end
-    else
-      puts "\tNo resources found".informational
     end
 
-    new_line
-    nil
-  end
+    def lsa
+      show_active_only = true
+      ls(self, show_active_only)
+    end
 
-  def lsa
-    show_active_only = true
-    ls(show_active_only)
-  end
+    def interactive
+      ::Bcome::Interactive::Session.run(self, :interactive_ssh)
+    end
 
-  def interactive
-    ::Bcome::Interactive::Session.run(self, :interactive_ssh)
-  end
+    def tree
+      puts "\nTree view\n".title
+      tab = ''
+      print_tree_view_for_resource(tab, self)
+      list_in_tree("#{tab}\t", resources)
+      print "\n"
+    end
 
-  def tree
-    puts "\nTree view\n".title
-    tab = ''
-    parents.reverse.each do |p|
-      print_tree_view_for_resource(tab, p)
-      tab = "#{tab}\t"
+    def parents
+      ps = []
+      ps << [parent, parent.parents] if has_parent?
+      ps.flatten
     end
-    print_tree_view_for_resource(tab, self)
-    list_in_tree("#{tab}\t", resources)
-    print "\n"
-  end
 
-  def parents
-    ps = []
-    ps << [parent, parent.parents] if has_parent?
-    ps.flatten
-  end
+    def list_in_tree(tab, resources)
+      resources.sort_by(&:identifier).each do |resource|
+        next if resource.parent && !resource.parent.resources.is_active_resource?(resource)
+        next if resource.hide?
 
-  def list_in_tree(tab, resources)
-    resources.sort_by(&:identifier).each do |resource|
-      next if resource.parent && !resource.parent.resources.is_active_resource?(resource)
-      resource.load_nodes if resource.inventory? && !resource.nodes_loaded?
-      print_tree_view_for_resource(tab, resource)
-      list_in_tree("#{tab}\t", resource.resources)
+        resource.load_nodes if resource.inventory? && !resource.nodes_loaded?
+        print_tree_view_for_resource(tab, resource)
+        list_in_tree("#{tab}\t", resource.resources)
+      end
     end
-  end
 
-  def print_tree_view_for_resource(tab, resource)
-    separator = '-'
-    tree_item = tab.to_s + separator.resource_key + " #{resource.type.resource_key} \s#{resource.identifier.resource_value}"
-    tree_item += ' (empty set)' if !resource.server? && !resource.resources.has_active_nodes?
-    puts tree_item
-  end
+    def print_tree_view_for_resource(tab, resource)
+      separator = '-'
+      tree_item = tab.to_s + separator.resource_key + " #{resource.type.resource_key} \s#{resource.identifier.resource_value}"
+      tree_item += ' (empty set)' if !resource.server? && !resource.resources.has_active_nodes?
+      puts tree_item
+    end
 
-  def cd(identifier)
-    if resource = resources.for_identifier(identifier)
-      if resource.parent.resources.is_active_resource?(resource)
-        ::Bcome::Workspace.instance.set(current_context: self, context: resource)
+    def cd(identifier)
+      if (resource = resources.for_identifier(identifier))
+        if resource.parent.resources.is_active_resource?(resource)
+          ::Bcome::Workspace.instance.set(current_context: self, context: resource)
+        else
+          puts "\nCannot enter context - #{identifier} is disabled. To enable enter 'enable #{identifier}'\n".error
+        end
       else
-        puts "\nCannot enter context - #{identifier} is disabled. To enable enter 'enable #{identifier}'\n".error
+        raise Bcome::Exception::InvalidBreadcrumb, "Cannot find a node named '#{identifier}'"
+        puts "#{identifier} not found"
       end
-    else
-      raise Bcome::Exception::InvalidBreadcrumb, "Cannot find a node named '#{identifier}'"
-      puts "#{identifier} not found"
     end
-  end
 
-  def run(*raw_commands)
-    raise Bcome::Exception::MethodInvocationRequiresParameter, "Please specify commands when invoking 'run'" if raw_commands.empty?
-    results = {}
+    def run(*raw_commands)
+      raise Bcome::Exception::MethodInvocationRequiresParameter, "Please specify commands when invoking 'run'" if raw_commands.empty?
+
+      results = {}
 
-    ::Bcome::Ssh::ConnectionHandler.connect(self, {})
+      ssh_connect(show_progress: true)
 
-    machines.pmap do |machine|
-      commands = machine.do_run(raw_commands)
-      results[machine.namespace] = commands
+      machines.pmap do |machine|
+        commands = machine.do_run(raw_commands)
+        results[machine.namespace] = commands
+      end
+      results
     end
-    results
-  end
 
-  def ping
-    ::Bcome::Ssh::ConnectionHandler.connect(self, is_ping: true)
-  end
+    def ping
+      ssh_connect(is_ping: true, show_progress: true)
+    end
 
-  def pretty_description(is_active = true)
-    desc = ''
-    list_attributes.each do |key, value|
-      next unless respond_to?(value) || instance_variable_defined?("@#{value}")
-      attribute_value = send(value)
-      next unless attribute_value
-
-      desc += "\t"
-      desc += is_active ? key.to_s.resource_key : key.to_s.resource_key_inactive
-      desc += "\s" * (12 - key.length)
-      desc += is_active ? attribute_value.resource_value : attribute_value.resource_value_inactive
-      desc += "\n"
-      desc = desc unless is_active
-    end
-    desc
-  end
+    def pretty_description(is_active = true)
+      desc = ''
+      list_attributes.each do |key, value|
+        next unless respond_to?(value) || instance_variable_defined?("@#{value}")
 
-  def back
-    exit
-  end
+        attribute_value = send(value)
+        next unless attribute_value
 
-  def disable(*ids)
-    ids.each { |id| resources.do_disable(id) }
-  end
+        desc += "\t"
+        desc += is_active ? key.to_s.resource_key : key.to_s.resource_key_inactive
+        desc += "\s" * (12 - key.length)
+        desc += is_active ? attribute_value.resource_value : attribute_value.resource_value_inactive
+        desc += "\n"
+        desc = desc unless is_active
+      end
+      desc
+    end
 
-  def enable(*ids)
-    ids.each { |id| resources.do_enable(id) }
-  end
+    def back
+      exit
+    end
 
-  def clear!
-    # Clear any disabled selection at this level and at all levels below
-    resources.clear!
-    resources.each(&:clear!)
-    nil
-  end
+    def disable(*ids)
+      ids.each { |id| resources.do_disable(id) }
+    end
 
-  def workon(*ids)
-    resources.disable!
-    ids.each { |id| resources.do_enable(id) }
-    puts "\nYou are now working on '#{ids.join(', ')}\n".informational
-  end
+    def enable(*ids)
+      ids.each { |id| resources.do_enable(id) }
+    end
 
-  def disable!
-    resources.disable!
-    resources.each(&:disable!)
-    nil
-  end
+    def clear!
+      # Clear any disabled selection at this level and at all levels below
+      resources.clear!
+      resources.each(&:clear!)
+      nil
+    end
 
-  def enable!
-    resources.enable!
-    resources.each(&:enable!)
-    nil
-  end
+    def workon(*ids)
+      resources.disable!
+      ids.each { |id| resources.do_enable(id) }
+      puts "\nYou are now working on '#{ids.join(', ')}\n".informational
+    end
 
-  ## Helpers --
+    def disable!
+      resources.disable!
+      resources.each(&:disable!)
+      nil
+    end
 
-  def resource_identifiers
-    resources.collect(&:identifier)
-  end
+    def enable!
+      resources.enable!
+      resources.each(&:enable!)
+      nil
+    end
 
-  def is_node_level_method?(method_sym)
-    respond_to?(method_sym) || method_is_available_on_node?(method_sym)
-  end
+    ## Helpers --
 
-  def method_missing(method_sym, *arguments)
-    unless method_is_available_on_node?(method_sym)
-      raise NameError, "NameError: undefined local variable or method '#{method_sym}'"
+    def resource_identifiers
+      resources.collect(&:identifier)
     end
 
-    if resource_identifiers.include?(method_sym.to_s)
-      method_sym.to_s
-    elsif instance_variable_defined?("@#{method_sym}")
-      instance_variable_get("@#{method_sym}")
-    else
-      command = user_command_wrapper.command_for_console_command_name(method_sym)
-      command.execute(self, arguments)
+    def is_node_level_method?(method_sym)
+      respond_to?(method_sym) || method_is_available_on_node?(method_sym)
     end
-  end
 
-  def method_in_registry?(method_sym)
-    ::Bcome::Registry::CommandList.instance.command_in_list?(self, method_sym)
-  end
+    def method_in_registry?(method_sym)
+      ::Bcome::Registry::CommandList.instance.command_in_list?(self, method_sym)
+    end
 
-  def method_is_available_on_node?(method_sym)
-    resource_identifiers.include?(method_sym.to_s) || instance_variable_defined?("@#{method_sym}") || method_in_registry?(method_sym) || respond_to?(method_sym)
-  end
+    def method_is_available_on_node?(method_sym)
+      resource_identifiers.include?(method_sym.to_s) || method_in_registry?(method_sym) || respond_to?(method_sym) || instance_variable_defined?("@#{method_sym}")
+    end
 
-  def visual_hierarchy
-    tabs = 0
-    hierarchy = ''
-    tree_descriptions.each { |d| hierarchy += "#{"\s\s\s" * tabs}|- #{d}\n"; tabs += 1; }
-    hierarchy
-  end
+    def visual_hierarchy
+      tabs = 0
+      hierarchy = ''
+      tree_descriptions.each do |d|
+        hierarchy += "#{"\s\s\s" * tabs}|- #{d}\n"
+        tabs += 1
+      end
+      hierarchy
+    end
 
-  def tree_descriptions
-    d = parent ? parent.tree_descriptions + [description] : [description]
-    d.flatten
-  end
+    def tree_descriptions
+      d = parent ? parent.tree_descriptions + [description] : [description]
+      d.flatten
+    end
 
-  def new_line
-    puts "\n"
+    def new_line
+      puts "\n"
+    end
   end
 end