Class: Foobara::CommandConnector

Inherits:
Object
  • Object
show all
Includes:
Concerns::Desugarizers, Concerns::Reflection
Defined in:
foobara-0.3.0/projects/command_connectors/src/authenticator.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector.rb,
foobara-0.3.0/projects/command_connectors/src/authenticator_selector.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/request.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/response.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/commands/ping.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/unknown_error.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/not_found_error.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/commands/describe.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/not_allowed_error.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/concerns/reflection.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/no_type_found_error.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/concerns/desugarizers.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/invalid_context_error.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/unauthenticated_error.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/commands/list_commands.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/no_command_found_error.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/command_connector_error.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/commands/query_git_commit_info.rb,
foobara-0.3.0/projects/command_connectors/src/command_connector/no_command_or_type_found_error.rb

Defined Under Namespace

Modules: Commands, Concerns Classes: AlreadyConnectedError, Authenticator, AuthenticatorSelector, CommandConnectorError, InvalidContextError, NoCommandFoundError, NoCommandOrTypeFoundError, NoTypeFoundError, NotAllowedError, NotFoundError, Request, Response, UnauthenticatedError, UnexpectedSensitiveTypeInManifestError, UnknownError

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name: nil, authenticator: nil, capture_unknown_error: nil, default_serializers: nil, default_pre_commit_transformers: nil) ⇒ CommandConnector

Returns a new instance of CommandConnector.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'projects/command_connectors/src/command_connector.rb', line 123

def initialize(name: nil,
               authenticator: nil,
               capture_unknown_error: nil,
               default_serializers: nil,
               default_pre_commit_transformers: nil)
  authenticator = self.class.to_authenticator(authenticator)

  self.authenticator = authenticator
  self.command_registry = CommandRegistry.new(authenticator:)
  self.capture_unknown_error = capture_unknown_error
  self.name = name

  Util.array(default_serializers).each do |serializer|
    add_default_serializer(serializer)
  end

  Util.array(default_pre_commit_transformers).each do |pre_commit_transformer|
    add_default_pre_commit_transformer(pre_commit_transformer)
  end

  self.class.allowed_rules_to_register.each do |ruleish_args|
    command_registry.allowed_rule(*ruleish_args)
  end
end

Instance Attribute Details

#authenticator ⇒ Object

Returns the value of attribute authenticator.



121
122
123
 
# File 'projects/command_connectors/src/command_connector.rb', line 121

def authenticator
  @authenticator
end

#capture_unknown_error ⇒ Object

Returns the value of attribute capture_unknown_error.



121
122
123
 
# File 'projects/command_connectors/src/command_connector.rb', line 121

def capture_unknown_error
  @capture_unknown_error
end

#command_registry ⇒ Object

Returns the value of attribute command_registry.



121
122
123
 
# File 'projects/command_connectors/src/command_connector.rb', line 121

def command_registry
  @command_registry
end

#name ⇒ Object

Returns the value of attribute name.



121
122
123
 
# File 'projects/command_connectors/src/command_connector.rb', line 121

def name
  @name
end

Class Method Details

.allowed_rules_to_register ⇒ Object 



14
15
16
17
18
19
20
21
22
 
# File 'projects/command_connectors/src/command_connector.rb', line 14

def allowed_rules_to_register
  return @allowed_rules_to_register if defined?(@allowed_rules_to_register)

  @allowed_rules_to_register = if superclass == Object
                                 []
                               else
                                 superclass.allowed_rules_to_register.dup
                               end
end

.authenticator_registry ⇒ Object 



28
29
30
31
32
33
34
35
36
 
# File 'projects/command_connectors/src/command_connector.rb', line 28

def authenticator_registry
  return @authenticator_registry if defined?(@authenticator_registry)

  @authenticator_registry = if superclass == Object
                              {}
                            else
                              superclass.authenticator_registry.dup
                            end
end

.find_builtin_command_class(command_class_name) ⇒ Object 



10
11
12
 
# File 'projects/command_connectors/src/command_connector.rb', line 10

def find_builtin_command_class(command_class_name)
  Util.find_constant_through_class_hierarchy(self, "Commands::#{command_class_name}")
end

.register_allowed_rule(*rule_args) ⇒ Object 



24
25
26
 
# File 'projects/command_connectors/src/command_connector.rb', line 24

def register_allowed_rule(*rule_args)
  allowed_rules_to_register << rule_args
end

.register_authenticator(*authenticatorish_args) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
 
# File 'projects/command_connectors/src/command_connector.rb', line 38

def register_authenticator(*authenticatorish_args)
  authenticator = to_authenticator(*authenticatorish_args)

  unless authenticator.symbol
    # :nocov:
    raise ArgumentError, "Expected authenticator to have a symbol"
    # :nocov:
  end

  authenticator_registry[authenticator.symbol] = authenticator
end

.to_authenticator(*args) ⇒ Object

TODO: relocate to Authenticator



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'projects/command_connectors/src/command_connector.rb', line 51

def to_authenticator(*args)
  symbol, object = case args.size
                   when 1
                     [nil, args.first]
                   when 2
                     args
                   else
                     # :nocov:
                     raise ArgumentError, "Expected 1 or 2 arguments, got #{args.size}"
                     # :nocov:
                   end

  case object
  when Class
    if object < Authenticator
      object.new
    else
      # :nocov:
      raise ArgumentError, "Expected a class that inherits from Authenticator"
      # :nocov:
    end
  when Authenticator, nil
    object
  when ::String
    if symbol
      # :nocov:
      raise ArgumentError, "Was not expecting a symbol and a string"
      # :nocov:
    end

    to_authenticator(object.to_sym)
  when ::Symbol
    authenticator = authenticator_registry[object]

    unless authenticator
      # :nocov:
      raise "No authenticator found for #{object}"
      # :nocov:
    end

    authenticator
  when ::Array
    case object.size
    when 0
      # TODO: test this
      # :nocov:
      nil
      # :nocov:
    when 1
      to_authenticator(object.first)
    else
      authenticators = object.map { |authenticatorish| to_authenticator(authenticatorish) }
      AuthenticatorSelector.new(authenticators:, symbol:)
    end
  else
    if object.respond_to?(:call)
      Authenticator.new(symbol:, &object)
    else
      # :nocov:
      raise "Not sure how to convert #{object} into an AllowedRule object"
      # :nocov:
    end
  end.tap do |resolved_authenticator|
    if resolved_authenticator
      resolved_authenticator.symbol ||= symbol
    end
  end
end

Instance Method Details

#all_exposed_command_names ⇒ Object 



242
243
244
 
# File 'projects/command_connectors/src/command_connector.rb', line 242

def all_exposed_command_names
  all_exposed_commands.map(&:full_command_name)
end

#all_exposed_commands ⇒ Object 



236
237
238
239
240
 
# File 'projects/command_connectors/src/command_connector.rb', line 236

def all_exposed_commands
  process_delayed_connections

  command_registry.foobara_all_command(mode: Namespace::LookupMode::ABSOLUTE_SINGLE_NAMESPACE)
end

#command_connected?(original_command_class) ⇒ Boolean

Returns:

  • (Boolean) 


246
247
248
249
250
 
# File 'projects/command_connectors/src/command_connector.rb', line 246

def command_connected?(original_command_class)
  all_exposed_commands.any? do |command|
    command.command_class == original_command_class
  end
end

#connect(*args, **opts) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'projects/command_connectors/src/command_connector.rb', line 148

def connect(*args, **opts)
  args, opts = desugarize_connect_args(args, opts)

  registerable = args.first

  if opts.key?(:authenticator)
    authenticator = opts[:authenticator]
    authenticator = self.class.to_authenticator(authenticator)
    opts = opts.merge(authenticator:)
  end

  case registerable
  when Class
    unless registerable < Command
      # :nocov:
      raise "Don't know how to register #{registerable} (#{registerable.class})"
      # :nocov:
    end

    command_registry.register(*args, **opts)
  when Module
    if registerable.foobara_organization?
      args = args[1..]
      registerable.foobara_domains.map do |domain|
        connect(domain, *args, **opts)
      end.flatten
    elsif registerable.foobara_domain?
      args = args[1..]
      connected = []

      registerable = registerable.foobara_all_command(mode: Namespace::LookupMode::DIRECT)

      registerable.each do |command_class|
        unless command_class.abstract?
          connected << connect(command_class, *args, **opts)
        end
      end

      connected.flatten
    else
      # :nocov:
      raise "Don't know how to register #{registerable} (#{registerable.class})"
      # :nocov:
    end
  when Symbol, String
    connect_delayed(*args, **opts)
  else
    # :nocov:
    raise "Don't know how to register #{registerable} (#{registerable.class})"
    # :nocov:
  end
end

#find_builtin_command_class(command_class_name) ⇒ Object 



210
211
212
 
# File 'projects/command_connectors/src/command_connector.rb', line 210

def find_builtin_command_class(command_class_name)
  self.class.find_builtin_command_class(command_class_name)
end

#lookup_command(name) ⇒ Object 



228
229
230
 
# File 'projects/command_connectors/src/command_connector.rb', line 228

def lookup_command(name)
  command_registry.foobara_lookup_command(name)
end

#run ⇒ Object

TODO: maybe introduce a Runner interface?



202
203
204
205
206
207
208
 
# File 'projects/command_connectors/src/command_connector.rb', line 202

def run(...)
  process_delayed_connections

  request = build_request(...)

  run_request(request)
end

#type_from_name(name) ⇒ Object 



232
233
234
 
# File 'projects/command_connectors/src/command_connector.rb', line 232

def type_from_name(name)
  Foobara.foobara_lookup_type(name, mode: Namespace::LookupMode::RELAXED)
end