locd 0.1.12 → 0.1.13

data/lib/locd/cli/command/agent/add.rb

@@ -16,7 +16,7 @@ module  Command
 # Definitions
 # =======================================================================
 
-class Agent < Locd::CLI::Command::Base
+class Agent < Base
   
   desc              "add [OPTIONS] -- CMD_TEMPLATE...",
                     "Add an agent that runs a command in the current directory"
@@ -28,11 +28,18 @@ class Agent < Locd::CLI::Command::Base
     available at http://yard.my_gem.test:8888 (unless Loc'd is running on a
     different port than 8888).
     
-        locd site add --name=yard.my_gem.test -- bundle exec yard server --reload --port {port} --bind {bind}
+        locd site add \\
+          --name=yard.my_gem.test \\
+          -- bundle exec yard server \\
+            --reload \\
+            --port {port} \\
+            --bind {bind}
     
   END
   
-  include_options   groups: [:write, :add, :respond_with_agents]
+  include_shared  t[  groups: t.HasAny( :write,
+                                        :add,
+                                        :respond_with_agents ) ]
   
   def add *cmd_template, **kwds
     logger.trace __method__.to_s,
@@ -42,7 +49,7 @@ class Agent < Locd::CLI::Command::Base
     
     # Merge all the keywords together into the format needed to call
     # {Locd::Agent.add}
-    kwds.merge! **option_kwds( :force, groups: [:write] ),
+    kwds.merge! **option_kwds( :force, groups: [ :write ] ),
                 cmd_template: cmd_template
     
     # Check args
@@ -69,6 +76,7 @@ class Agent < Locd::CLI::Command::Base
   end
 end
 
+
 # /Namespace
 # =======================================================================
 

data/lib/locd/cli/command/agent/ls.rb

@@ -0,0 +1,56 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+
+# Refinements
+# =======================================================================
+
+require 'nrser/refinements/types'
+using NRSER::Types
+
+
+# Namespace
+# =======================================================================
+
+module  Locd
+module  CLI
+module  Command
+
+
+# Definitions
+# =======================================================================
+
+class Agent < Base
+  
+  desc              "ls",
+                    "List agents"
+  
+  map               list: :ls
+  
+  include_shared    t[ name: :pattern, kind: :argument ],
+    required:       false,
+    default:        nil
+
+  include_shared    t[ groups: :pattern, kind: :option ]
+  
+  include_shared    t[ groups: :respond_with_agents ]
+  
+  def ls
+    results = if pattern.nil?
+      agent_class.all
+    else
+      agent_class.list pattern, **option_kwds( groups: :pattern )
+    end
+    
+    respond results.values.sort
+  end
+
+end
+
+
+# /Namespace
+# =======================================================================
+
+end # module  Command
+end # module  CLI
+end # module  Locd

data/lib/locd/cli/command/agent/open.rb

@@ -0,0 +1,53 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+require 'nrser/refinements/types'
+using NRSER::Types
+
+
+# Namespace
+# =======================================================================
+
+module  Locd
+module  CLI
+module  Command
+
+
+# Definitions
+# =======================================================================
+
+class Agent < Base
+  
+  desc              "open",
+                    "Open an agent's URL in the browser"
+
+  include_shared    t[ groups: t.HasAny( :pattern, :multi, :start ) ]
+
+  option            :start,
+    desc:           %{ Start any stopped agents before opening },
+    type:           :boolean,
+    default:        true
+  
+  def open
+    Locd::Agent::Proxy.get!.ensure_running
+    
+    find_multi!( pattern ).each do |agent|
+      if options[:start]
+        agent.ensure_running( **option_kwds( groups: :start ) )
+      end
+      
+      Cmds! "open %s", agent.url
+      
+      logger.info "Opened agent `#{ agent.label }` at #{ agent.url }"
+    end
+  end
+
+end
+
+
+# /Namespace
+# =======================================================================
+
+end # module  Command
+end # module  CLI
+end # module  Locd

data/lib/locd/cli/command/agent/plist.rb

@@ -0,0 +1,43 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+require 'nrser/refinements/types'
+using NRSER::Types
+
+
+# Namespace
+# =======================================================================
+
+module  Locd
+module  CLI
+module  Command
+
+
+# Definitions
+# =======================================================================
+
+class Agent < Base
+  
+  desc              "plist",
+                    "Print an agent's launchd property list"
+  
+  include_shared    t[ groups: :pattern ]
+  
+  def plist
+    agent = find_only! pattern
+    
+    if options[:json] || options[:yaml]
+      respond agent.plist
+    else
+      respond agent.path.read
+    end
+  end
+  
+end
+
+# /Namespace
+# =======================================================================
+
+end # module  Command
+end # module  CLI
+end # module  Locd

data/lib/locd/cli/command/agent/restart.rb

@@ -0,0 +1,43 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+require 'nrser/refinements/types'
+using NRSER::Types
+
+
+# Namespace
+# =======================================================================
+
+module  Locd
+module  CLI
+module  Command
+
+
+# Definitions
+# =======================================================================
+
+class Agent < Base
+  
+  desc              "restart",
+                    "Restart an agent"
+  
+  include_shared    t[ groups: t.HasAny( :pattern, :multi, :restart ) ]
+  
+  include_shared    t[ name: t.or( :enable, :force ), groups: :start ]
+  
+  def restart
+    find_multi!( pattern ).
+      each { |agent|
+        agent.restart **option_kwds( groups: [ :restart, :stop, :start ] )
+      }
+  end
+
+end
+
+
+# /Namespace
+# =======================================================================
+
+end # module  Command
+end # module  CLI
+end # module  Locd

data/lib/locd/cli/command/agent/rm.rb

@@ -0,0 +1,46 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+require 'nrser/refinements/types'
+using NRSER::Types
+
+
+# Namespace
+# =======================================================================
+
+module  Locd
+module  CLI
+module  Command
+
+
+# Definitions
+# =======================================================================
+
+class Agent < Base
+  
+  desc              "rm PATTERN [OPTIONS]",
+                    "Remove (uninstall, delete) a agent"
+  
+  map               remove: :rm
+  
+  include_shared    t[ groups: t.has_any( :pattern, :multi ) ]
+  
+  option            :logs,
+                    desc: "Remove logs too",
+                    type: :boolean,
+                    default: false
+  
+  def rm
+    kwds = option_kwds :logs
+    find_multi!( pattern ).each { |agent| agent.remove **kwds }
+  end
+
+end
+
+
+# /Namespace
+# =======================================================================
+
+end # module  Command
+end # module  CLI
+end # module  Locd

data/lib/locd/cli/command/agent/shared.rb

@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+require 'nrser/refinements/types'
+using NRSER::Types
+
+
+# Namespace
+# =======================================================================
+
+module  Locd
+module  CLI
+module  Command
+
+
+# Definitions
+# =======================================================================
+
+# CLI interface using the `thor` gem.
+# 
+# @see http://whatisthor.com/
+# 
+class Agent < Base
+  
+  # Shared Options
+  # ============================================================================
+  
+  def_shared  :option,
+    name:     :long,
+    groups:   :respond_with_agents,
+    group:    "Display",
+    desc:     "Display agent details table",
+    aliases:  'l',
+    type:     :boolean
+  
+
+  # `:pattern` Group
+  # ----------------------------------------------------------------------------
+  # 
+  # Options when provided a `PATTERN` argument used to find agents by label.
+  # 
+
+  def_shared  :argument,
+    name:     :pattern,
+    groups:   :pattern,
+    desc:     "Label or workdir pattern to find agent(s)",
+    type:     :string,
+    required: false,
+    complete: ->( klass:, **etc ) { klass.agent_class.labels.to_a } 
+
+  def_shared  :option,
+    name:     :full,
+    groups:   :pattern,
+    group:    "Pattern",
+    desc:     "Require label PATTERN to match entire string",
+    aliases:  [ '-u', ],
+    type:     :boolean
+
+  def_shared  :option,
+    name:     :ignore_case,
+    groups:   :pattern,
+    group:    "Pattern",
+    desc:     "Make label PATTERN case-insensitive",
+    aliases:  [ 'i' ],
+    type:     :boolean
+  
+  def_shared  :option,
+    name:     :recursive,
+    groups:   :pattern,
+    group:    "Pattern",
+    desc:     "Make workdir PATTERN match all subdirs too",
+    aliases:  [ 'r' ],
+    type:     :boolean
+  
+  # NOTE  We don't expose the workdir pattern's `:cwd` option...
+  #       If you want to match a directory from the CLI, just provide that
+  #       directory... no reason to specify the `:cwd` in an option then
+  #       provide a relative PATTERN
+  # 
+  
+  # `:multi` Group
+  # ----------------------------------------------------------------------------
+  # 
+  # For commands that can match multiple agents.
+  # 
+  
+  def_shared  :option,
+    name:     :all,
+    groups:   :multi,
+    group:    "Pattern",
+    desc:     "Apply to ALL agents that PATTERN matches",
+    aliases:  [ 'a' ],
+    type:     :boolean
+
+
+  # `:write` Group
+  # ----------------------------------------------------------------------------
+  # 
+  # Options when writing an agent `.plist` (`create`, `update`).
+  # 
+
+  def_shared  :option,
+    name:     :label,
+    groups:   :write,
+    desc: 
+      "Agent label, which is also the domain the proxy will serve it at",
+    aliases:  [ '--name', '-n' ],
+    type:     :string,
+    required: true
+
+  def_shared  :option,
+    name:     :workdir,
+    groups:   :write,
+    desc:     "Working directory for the agent's command",
+    aliases:  [ '--dir' ],
+    type:     :string
+
+  def_shared  :option,
+    name:     :log_path,
+    groups:   :write,
+    desc:     "Path to log agent's STDOUT and STDERR (combined)",
+    aliases:  [ '--log' ],
+    type:     :string
+  
+  def_shared  :option,
+    name:     :keep_alive,
+    groups:   :write,
+    desc:     "Try to keep the agent running",
+    type:     :boolean,
+    default:  false
+  
+  def_shared  :option,
+    name:     :run_at_load,
+    groups:   :write,
+    desc:     "Start the agent when loading it",
+    type:     :boolean,
+    default:  false
+
+  
+  # `:add` Group
+  # ----------------------------------------------------------------------------
+  
+  def_shared  :option,
+    name:     :force,
+    groups:   :add,
+    group:    "Add",
+    desc:     "Overwrite any existing agent",
+    type:     :boolean,
+    default:  false
+  
+  
+  def_shared  :option,
+    name:     :load,
+    groups:   :add,
+    group:    "Add",
+    desc:     "Load the agent into `launchd`",
+    type:     :boolean,
+    default:  true
+  
+  
+  # `:start` Group
+  # --------------------------------------------------------------------------
+  # 
+  # Relevant options when starting agents.
+  # 
+  
+  def_shared  :option,
+    name:     :load,
+    groups:   :start,
+    group:    "Start",
+    desc:     "Load the agent before starting",
+    type:     :boolean,
+    default:  true
+  
+  def_shared  :option,
+    name:     :force,
+    groups:   :start,
+    group:    "Start",
+    desc:     "Force loading of agent even if it's disabled",
+    type:     :boolean,
+    default:  false
+  
+  def_shared  :option,
+    name:     :enable,
+    groups:   :start,
+    group:    "Start",
+    desc:     "Set `launchd` *Disabled* key to `false`",
+    type:     :boolean,
+    default:  false
+    
+    
+  # `:stop` Group
+  # --------------------------------------------------------------------------
+  # 
+  # Relevant options when stopping agents.
+  # 
+  
+  def_shared  :option,
+    name:     :unload,
+    groups:   :stop,
+    group:    "Stop",
+    desc:     "Unload the agent from `launchd` after stopping",
+    type:     :boolean,
+    default:  true
+  
+  def_shared  :option,
+    name:     :disable,
+    groups:   :stop,
+    group:    "Stop",
+    desc:     "Set `launchd` *Disabled* key to `true`",
+    type:     :boolean,
+    default:  false
+    
+    
+  # `:restart` Group
+  # --------------------------------------------------------------------------
+  # 
+  # Relevant options when stopping agents.
+  # 
+  
+  def_shared  :option,
+    name:     :reload,
+    groups:   :restart,
+    group:    "Restart",
+    desc:     "Unload and reload the agent in `launchd`",
+    type:     :boolean,
+    default:  true
+  
+  
+end # class Locd::CLI::Command::Agent
+
+
+# /Namespace
+# =======================================================================
+
+end # module  Command
+end # module  CLI
+end # module  Locd