locd 0.1.3

data/lib/locd/cli/command/proxy.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+require 'shellwords'
+
+# Deps
+# -----------------------------------------------------------------------
+require 'thor'
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+using NRSER
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+# CLI interface using the `thor` gem.
+# 
+# @see http://whatisthor.com/
+# 
+class Locd::CLI::Command::Proxy < Locd::CLI::Command::Agent
+  
+  
+  # Helpers
+  # ============================================================================
+  # 
+  
+  def self.agent_class
+    Locd::Agent::Proxy
+  end
+  
+  
+  protected
+  # ========================================================================
+    
+    def proxy
+      @proxy ||= begin
+        proxy = Locd::Agent::Proxy.get
+        
+        if proxy.nil?
+          logger.error "Proxy agent plist not found",
+            expected_path: Locd::Agent::Proxy.plist_abs_path.to_s
+            
+          logger.info "Run `locd setup` to create it."
+          
+          exit 1
+        end
+        
+        proxy
+      end
+    end
+    
+  # end protected
+  public
+  
+  
+  
+  # Commands
+  # ============================================================================
+  
+  desc              "setup",
+                    "Add agents that runs a command in the current directory"
+  include_options   groups: [:write, :add, :respond_with_agents]
+  def setup
+    agent = agent_class.add **option_kwds( groups: :write )
+    
+    logger.info "`#{ agent.label }` agent created."
+    
+    agent.load if options[:load]
+    
+    respond agent
+  end
+  
+  
+  desc              "run",
+                    "Run the proxy server (in the foreground)"
+  method_option     :bind,
+                    desc: "Address to bind the proxy server to",
+                    aliases: ['-b', '--host', '-h'],
+                    type: :string,
+                    default: Locd.config[:proxy, :bind]
+  method_option     :port,
+                    desc: "Port to run the proxy on",
+                    aliases: '-p',
+                    type: :numeric,
+                    default: Locd.config[:proxy, :port]
+  def run_
+    Locd::Proxy.serve \
+      bind: options[:bind],
+      port: options[:port]
+  end
+  
+  
+  desc              "port",
+                    "Get port Loc'd proxy is running on or configured for"
+  def port
+    respond Locd::Proxy.port
+  end
+  
+  
+  # Agent Interface
+  # ----------------------------------------------------------------------------
+  
+  desc              'status',
+                    'Print proxy status'
+  def status
+    respond \
+      label:  proxy.label,
+      port:   proxy.port,
+      status: proxy.status
+  end
+  
+  
+  desc              "rm",
+                    "Remove (uninstall, delete) the proxy agent"
+  map               remove: :rm
+  def rm
+    proxy.remove
+  end
+  
+  
+  desc              "plist",
+                    "Show the proxy's launchd property list"
+  def plist
+    agent = proxy
+    
+    if options[:json] || options[:yaml]
+      respond agent.plist
+    else
+      respond agent.path.read
+    end
+  end
+  
+    
+  desc              "start",
+                    "Start the proxy"
+  option            :write,
+                    desc: "Set `launchd` *Disabled* key to `false`",
+                    type: :boolean
+  def start
+    proxy.start **option_kwds( :write )
+  end
+  
+  
+  desc              "stop",
+                    "Stop the proxy"
+  include_options   groups: [:stop]
+  option            :write,
+                    desc: "Set `launchd` *Disabled* key to `true`",
+                    type: :boolean
+  def stop
+    proxy.stop **option_kwds( :unload, groups: :stop )
+  end
+  
+  
+  desc              "restart",
+                    "Restart the proxy"
+  include_options   groups: [:stop]
+  option            :write,
+                    desc: "Set `launchd` *Disabled* key to `false`",
+                    type: :boolean
+  def restart
+    proxy.restart **option_kwds( :write, groups: :stop )
+  end
+  
+end # module Locd::CLI::Proxy

data/lib/locd/cli/command/rotate_logs.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+require 'shellwords'
+
+# Deps
+# -----------------------------------------------------------------------
+require 'thor'
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+using NRSER
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+# Manage log rotation.
+# 
+class Locd::CLI::Command::RotateLogs < Locd::CLI::Command::Agent
+  
+  
+  # Helpers
+  # ============================================================================
+  # 
+  
+  def self.agent_class
+    Locd::Agent::RotateLogs
+  end
+  
+  
+  protected
+  # ========================================================================
+    
+    def agent
+      @agent ||= begin
+        agent = agent_class.get
+        
+        if agent.nil?
+          logger.error "Agent plist not found",
+            expected_path: agent_class.plist_abs_path.to_s
+            
+          logger.info "Run `locd setup` to create it."
+          
+          exit 1
+        end
+        
+        agent
+      end
+    end
+    
+  # end protected
+  public
+  
+  
+  # Commands
+  # ============================================================================
+  
+  desc              "setup",
+                    "Add agents that runs a command in the current directory"
+  include_options   groups: [:write, :add, :respond_with_agents]
+  def setup
+    agent = agent_class.add **option_kwds( groups: :write )
+    
+    logger.info "`#{ agent.label }` agent created."
+    
+    agent.load if options[:load]
+    
+    respond agent
+  end
+  
+  
+  desc              "run",
+                    "Rotate agent logs using `newsyslog`"
+  def run_
+    Locd::Newsyslog.run_all
+  end
+  
+  
+  # Agent Interface
+  # ----------------------------------------------------------------------------
+  
+  desc              'status',
+                    'Print agent status'
+  def status
+    respond \
+      label:  agent.label,
+      status: agent.status
+  end
+  
+  
+  desc              "rm",
+                    "Remove (uninstall, delete) the agent"
+  map               remove: :rm
+  def rm
+    agent.remove
+  end
+  
+  
+  desc              "plist",
+                    "Show the agent's launchd property list"
+  def plist
+    if options[:json] || options[:yaml]
+      respond agent.plist
+    else
+      respond agent.path.read
+    end
+  end
+  
+    
+  desc              "start",
+                    "Start the agent"
+  option            :write,
+                    desc: "Set `launchd` *Disabled* key to `false`",
+                    type: :boolean
+  def start
+    agent.start **option_kwds( :write )
+  end
+  
+  
+  desc              "stop",
+                    "Stop the agent"
+  include_options   groups: [:stop]
+  option            :write,
+                    desc: "Set `launchd` *Disabled* key to `true`",
+                    type: :boolean
+  def stop
+    agent.stop **option_kwds( :unload, groups: :stop )
+  end
+  
+  
+  desc              "restart",
+                    "Restart the agent"
+  include_options   groups: [:stop]
+  option            :write,
+                    desc: "Set `launchd` *Disabled* key to `false`",
+                    type: :boolean
+  def restart
+    agent.restart **option_kwds( :write, groups: :stop )
+  end
+  
+end # module Locd::CLI::RotateLogs

data/lib/locd/cli/command/site.rb

@@ -0,0 +1,47 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+
+# Refinements
+# =======================================================================
+
+using NRSER
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+# TODO  Doc me pls
+# 
+class Locd::CLI::Command::Site < Locd::CLI::Command::Agent
+  
+  # Helpers
+  # ============================================================================
+  # 
+  
+  def self.agent_class
+    Locd::Agent::Site
+  end
+  
+  
+  protected
+  # ========================================================================
+    
+    def agent_table agents
+      Locd::CLI::Table.build do |t|
+        t.col "PID", &:pid
+        t.col "LEC", desc: "Last Exit Code", &:last_exit_code
+        t.col "URL", &:url
+        t.col "Port", &:port
+        t.col "File" do |agent| agent_file agent end
+        
+        t.rows agents
+      end
+    end
+    
+  # end protected
+  public
+  
+  
+end # class Locd::CLI::Command::Site

data/lib/locd/cli/table.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+using NRSER
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+# 
+class Locd::CLI::Table
+  # Unicode superscript number to use as references for columns with
+  # descriptions.
+  # 
+  # @return [Array<String>]
+  # 
+  SUPERSCRIPT_NUMBERS = [
+    "\u2070",
+    "\u00B9",
+    "\u00B2",
+    "\u00B3",
+    "\u2070",
+    "\u2074",
+    "\u2075",
+    "\u2076",
+    "\u2077",
+    "\u2078",
+    "\u2079",
+  ].freeze
+  
+  NULL = '␀'
+  
+  
+  # Mixins
+  # ============================================================================
+  
+  include Enumerable
+  include NRSER::Ext::Enumerable
+  
+  
+  # Classes
+  # ============================================================================
+  
+  # A column in a table.
+  # 
+  class Column
+    attr_reader :name, :getter, :desc
+    
+    def initialize name, desc: nil, &getter
+      @name = name
+      @getter = getter
+      @desc = desc
+    end
+  end # class Column
+  
+  
+  # @todo Document build method.
+  # 
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  # 
+  # @return [return_type]
+  #   @todo Document return value.
+  # 
+  def self.build &block
+    new.tap &block
+  end # .build
+  
+  def initialize
+    @columns = []
+    @rows = []
+  end
+  
+  def each &block
+    @rows.each &block
+  end
+  
+  def each_index &block
+    @rows.each_index &block
+  end
+  
+  def column *args, &getter
+    @columns << Column.new( *args, &getter )
+  end
+  
+  alias_method :col, :column
+  
+  
+  def rows entries = nil
+    unless entries.nil?
+      @rows = entries.to_a
+    end
+    
+    @rows
+  end
+  
+  
+  def to_a header: true, col_desc_refs: true
+    [].tap do |array|
+    
+      if header
+        desc_ref_index = 0
+        array << @columns.map { |column|
+          if column.desc && col_desc_refs
+            desc_ref_index += 1
+            "#{ column.name }#{ SUPERSCRIPT_NUMBERS[desc_ref_index] }"
+          else
+            column.name
+          end
+        }
+      end
+        
+      @rows.each do |row|
+        values = if NRSER.array_like? row
+          row.to_a
+        else
+          @columns.map do |column|
+            column.getter.call( row )
+          end
+        end
+        
+        array << values.map { |value|
+          if value.nil?
+            NULL
+          else
+            value.to_s
+          end
+        }
+      end
+    
+    end
+  end # #to_a
+  
+  def footer
+    NULL + " Null\n" +
+    @columns.select { |col| col.desc }.each_with_index.map { |col, index|
+      "#{ SUPERSCRIPT_NUMBERS[index + 1] } #{ col.desc }"
+    }.join( "\n" )
+  end
+  
+end # class Locd::CLI::Table