foobara 0.5.10 → 0.6.2

data/projects/command_connectors/src/command_connector/concerns/reflection.rb

@@ -66,18 +66,23 @@ module Foobara
                       unless o.foobara_root_namespace == command_registry
                         next
                       end
-                    elsif o.is_a?(::Class) && o < Foobara::Command
-                      next
+                    elsif o.is_a?(::Class)
+                      if o < Foobara::Command
+                        next
+                      elsif o < Foobara::Value::Processor
+                        full_domain_name = o.foobara_domain.scoped_full_name
+                        exposed_domain = command_registry.create_exposed_domain_if_needed(full_domain_name)
+                        additional_to_include << exposed_domain
+                      end
                     end
                   elsif o.is_a?(Types::Type)
                     if o.sensitive?
-                      # :nocov:
+                      # simplecov:disable
                       raise UnexpectedSensitiveTypeInManifestError,
                             "Unexpected sensitive type in manifest: #{o.scoped_full_path}. " \
                             "Make sure these are not included."
-                      # :nocov:
+                      # simplecov:enable
                     else
-
                       mode = Namespace::LookupMode::ABSOLUTE_SINGLE_NAMESPACE
                       domain_name = o.foobara_domain.scoped_full_name
 
@@ -113,9 +118,9 @@ module Foobara
               category_symbol = command_registry.foobara_category_symbol_for(object)
 
               unless category_symbol
-                # :nocov:
+                # simplecov:disable
                 raise "no category symbol for #{object}"
-                # :nocov:
+                # simplecov:enable
               end
 
               namespace = if object.is_a?(Types::Type)
@@ -154,26 +159,67 @@ module Foobara
           root_manifest = Manifest::RootManifest.new(manifest_hash)
 
           error_category = {}
+          reference_to_category = {}
+
+          # The only thing we can scope to an org is a domain so leaving :organization out
+          [
+            :command,
+            :domain,
+            :type,
+            :error,
+            :processor,
+            :processor_class
+          ].each do |category|
+            root_manifest.relevant_manifest[category]&.each_key do |key|
+              reference_to_category[key.to_s] = category
+            end
+          end
 
           root_manifest.errors.each do |error|
-            error_manifest = if (error.parent_category == :command || error.parent_category == :organization) &&
-                                !root_manifest.contains?(error.parent_name, error.parent_category)
-                               domain = error.domain
-                               index = domain.scoped_full_path.size
+            # TODO: let's deprecate parent_name and use parent_path instead.
+            error_manifest = if root_manifest.contains?(error.parent_name, error.parent_category) &&
+                                root_manifest.contains?(error[:domain], :domain) &&
+                                root_manifest.contains?(error.parent[:domain], :domain)
+
+                               error.relevant_manifest
+                             else
+                               parent = nil
+
+                               fixed_scoped_path = error.scoped_path.dup
+                               parent_path = error.scoped_full_path[..-(fixed_scoped_path.size + 1)]
+
+                               loop do
+                                 fixed_scoped_path.unshift(parent_path.pop)
+                                 parent_name = parent_path.join("::")
+
+                                 if parent_path.empty?
+                                   parent = root_manifest.global_domain
+                                   break
+                                 elsif reference_to_category.include?(parent_name)
+                                   possible_parent = root_manifest.lookup(parent_name)
+
+                                   if root_manifest.contains?(possible_parent[:domain], :domain)
+                                     parent = possible_parent
+                                     break
+                                   end
+                                 end
+                               end
+
+                               fixed_parent = parent.manifest_path
+                               fixed_domain = parent[:domain]
+                               fixed_organization = parent[:organization]
 
-                               fixed_scoped_path = error.scoped_full_path[index..]
-                               fixed_scoped_name = fixed_scoped_path.join("::")
                                fixed_scoped_prefix = fixed_scoped_path[..-2]
-                               fixed_parent = [:domain, domain.reference]
+                               fixed_scoped_name = fixed_scoped_path.join("::")
 
                                error.relevant_manifest.merge(
                                  parent: fixed_parent,
                                  scoped_path: fixed_scoped_path,
                                  scoped_name: fixed_scoped_name,
-                                 scoped_prefix: fixed_scoped_prefix
+                                 scoped_prefix: fixed_scoped_prefix,
+                                 domain: fixed_domain,
+                                 organization: fixed_organization
                                )
-                             else
-                               error.relevant_manifest
                              end
 
             error_category[error.scoped_full_name.to_sym] = error_manifest

data/projects/command_connectors/src/command_connector/request.rb

@@ -26,9 +26,9 @@ module Foobara
         invalid_keys = opts.keys - valid_keys
 
         unless invalid_keys.empty?
-          # :nocov:
+          # simplecov:disable
           raise ArgumentError, "invalid keys: #{invalid_keys} expected only #{valid_keys}"
-          # :nocov:
+          # simplecov:enable
         end
 
         self.inputs = opts[:inputs] if opts.key?(:inputs)
@@ -50,7 +50,13 @@ module Foobara
 
       def authenticate
         return if error
-        return unless command_class.respond_to?(:requires_authentication) && command_class.requires_authentication
+        return unless requires_authentication? || authentication_optional?
+
+        unless authenticator
+          raise CommandConnector::NoAuthenticatorGivenError,
+                "Running a #{command_class.full_command_name} via #{command_connector} " \
+                "requires an authenticator but this connector does not have one"
+        end
 
         authenticated_user, authenticated_credential = authenticator.authenticate(self)
 
@@ -58,11 +64,21 @@ module Foobara
         self.authenticated_user = authenticated_user
         self.authenticated_credential = authenticated_credential
 
+        return unless requires_authentication?
+
         unless authenticated_user
           self.error = CommandConnector::UnauthenticatedError.new
         end
       end
 
+      def authentication_optional?
+        command_class.respond_to?(:authentication_optional) && command_class.authentication_optional
+      end
+
+      def requires_authentication?
+        command_class.respond_to?(:requires_authentication) && command_class.requires_authentication
+      end
+
       def auth_mapped_method?(method_name)
         auth_mappers&.key?(method_name)
       end
@@ -87,9 +103,9 @@ module Foobara
         if auth_mapped_method?(method_name)
           auth_mapped_value_for(method_name)
         else
-          # :nocov:
+          # simplecov:disable
           super
-          # :nocov:
+          # simplecov:enable
         end
       end
 
@@ -108,7 +124,7 @@ module Foobara
         actual_serializers = objects_to_serializers(serializers)
 
         @serializer = if actual_serializers.size == 1
-                        actual_serializers.first
+                        actual_serializers[0]
                       else
                         Value::Processor::Pipeline.new(processors: actual_serializers)
                       end
@@ -191,9 +207,9 @@ module Foobara
             klass = Foobara::CommandConnectors::Serializer.serializer_from_symbol(object)
 
             unless klass
-              # :nocov:
+              # simplecov:disable
               raise "Could not find serializer for #{object}"
-              # :nocov:
+              # simplecov:enable
             end
 
             klass.new(self)
@@ -201,9 +217,9 @@ module Foobara
             if object.respond_to?(:call)
               Value::Transformer.create(transform: object)
             else
-              # :nocov:
+              # simplecov:disable
               raise "Not sure how to convert #{object} into a serializer"
-              # :nocov:
+              # simplecov:enable
             end
           end
         end

data/projects/command_connectors/src/command_connector/response.rb

@@ -26,6 +26,8 @@ module Foobara
       def outcome
         request.outcome
       end
+
+      def authenticated_user = request.authenticated_user
     end
   end
 end

data/projects/command_connectors/src/command_connector.rb

@@ -2,6 +2,7 @@ module Foobara
   class CommandConnector
     class UnexpectedSensitiveTypeInManifestError < StandardError; end
     class AlreadyConnectedError < StandardError; end
+    class NoAuthenticatorGivenError < StandardError; end
 
     include Concerns::Desugarizers
     include Concerns::Reflection
@@ -39,9 +40,9 @@ module Foobara
         authenticator = to_authenticator(*authenticatorish_args)
 
         unless authenticator.symbol
-          # :nocov:
+          # simplecov:disable
           raise ArgumentError, "Expected authenticator to have a symbol"
-          # :nocov:
+          # simplecov:enable
         end
 
         authenticator_registry[authenticator.symbol] = authenticator
@@ -51,13 +52,13 @@ module Foobara
       def to_authenticator(*args)
         symbol, object = case args.size
                          when 1
-                           [nil, args.first]
+                           [nil, args[0]]
                          when 2
                            args
                          else
-                           # :nocov:
+                           # simplecov:disable
                            raise ArgumentError, "Expected 1 or 2 arguments, got #{args.size}"
-                           # :nocov:
+                           # simplecov:enable
                          end
 
         case object
@@ -65,17 +66,17 @@ module Foobara
           if object < Authenticator
             object.instance
           else
-            # :nocov:
+            # simplecov:disable
             raise ArgumentError, "Expected a class that inherits from Authenticator"
-            # :nocov:
+            # simplecov:enable
           end
         when Authenticator, nil
           object
         when ::String
           if symbol
-            # :nocov:
+            # simplecov:disable
             raise ArgumentError, "Was not expecting a symbol and a string"
-            # :nocov:
+            # simplecov:enable
           end
 
           to_authenticator(object.to_sym)
@@ -83,9 +84,9 @@ module Foobara
           authenticator = authenticator_registry[object]
 
           unless authenticator
-            # :nocov:
+            # simplecov:disable
             raise "No authenticator found for #{object}"
-            # :nocov:
+            # simplecov:enable
           end
 
           authenticator
@@ -93,11 +94,11 @@ module Foobara
           case object.size
           when 0
             # TODO: test this
-            # :nocov:
+            # simplecov:disable
             nil
-            # :nocov:
+            # simplecov:enable
           when 1
-            to_authenticator(object.first)
+            to_authenticator(object[0])
           else
             authenticators = object.map { |authenticatorish| to_authenticator(authenticatorish) }
             AuthenticatorSelector.new(authenticators:, symbol:)
@@ -106,9 +107,9 @@ module Foobara
           if object.respond_to?(:call)
             Authenticator.new(symbol:, &object)
           else
-            # :nocov:
+            # simplecov:disable
             raise "Not sure how to convert #{object} into an AllowedRule object"
-            # :nocov:
+            # simplecov:enable
           end
         end.tap do |resolved_authenticator|
           if resolved_authenticator
@@ -133,33 +134,33 @@ module Foobara
             size = element_types.size
 
             first_required_input = if size == 1
-                                     element_types.keys.first
+                                     element_types.keys[0]
                                    elsif size > 1
                                      declaration = inputs_type&.declaration_data
                                      required_attribute_names = declaration&.[](:required) || EMPTY_ARRAY
 
                                      if required_attribute_names.size == 1
-                                       required_attribute_names.first
+                                       required_attribute_names[0]
                                      else
-                                       # :nocov:
+                                       # simplecov:disable
                                        raise ArgumentError,
                                              "Ambiguous inputs when trying to use #{object} as a mapper. " \
                                              "Should have either only 1 input or only 1 required input."
-                                       # :nocov:
+                                       # simplecov:enable
                                      end
                                    else
-                                     # :nocov:
+                                     # simplecov:disable
                                      raise ArgumentError, "To use a command as a mapper it must take an input to map"
-                                     # :nocov:
+                                     # simplecov:enable
                                    end
 
             build_auth_mapper(object.result_type) do |authenticated_user|
               object.run!(first_required_input => authenticated_user)
             end
           else
-            # :nocov:
+            # simplecov:disable
             raise ArgumentError, "not sure how to convert a #{object} to an auth mapper"
-            # :nocov:
+            # simplecov:enable
           end
         when ::Hash
           object => { to:, map: }
@@ -168,9 +169,9 @@ module Foobara
           object => [to, map]
           build_auth_mapper(to, &map)
         else
-          # :nocov:
+          # simplecov:disable
           raise ArgumentError, "Not sure how to convert #{object} to an auth mapper"
-          # :nocov:
+          # simplecov:enable
         end
       end
 
@@ -262,7 +263,7 @@ module Foobara
     def connect(*args, **opts)
       args, opts = desugarize_connect_args(args, opts)
 
-      registerable = args.first
+      registerable = args[0]
 
       if opts.key?(:authenticator)
         authenticator = opts[:authenticator]
@@ -273,9 +274,9 @@ module Foobara
       case registerable
       when Class
         unless registerable < Command
-          # :nocov:
+          # simplecov:disable
           raise "Don't know how to register #{registerable} (#{registerable.class})"
-          # :nocov:
+          # simplecov:enable
         end
 
         command_registry.register(*args, **opts)
@@ -299,16 +300,16 @@ module Foobara
 
           connected.flatten
         else
-          # :nocov:
+          # simplecov:disable
           raise "Don't know how to register #{registerable} (#{registerable.class})"
-          # :nocov:
+          # simplecov:enable
         end
       when Symbol, String
         connect_delayed(*args, **opts)
       else
-        # :nocov:
+        # simplecov:disable
         raise "Don't know how to register #{registerable} (#{registerable.class})"
-        # :nocov:
+        # simplecov:enable
       end
     end
 
@@ -346,15 +347,15 @@ module Foobara
     end
 
     def add_default_response_mutator(mutator)
-      # :nocov:
+      # simplecov:disable
       command_registry.add_default_response_mutator(mutator)
-      # :nocov:
+      # simplecov:enable
     end
 
     def allowed_rule(*)
-      # :nocov:
+      # simplecov:disable
       command_registry.allowed_rule(*)
-      # :nocov:
+      # simplecov:enable
     end
 
     def allowed_rules(*)
@@ -366,9 +367,9 @@ module Foobara
     end
 
     def each_transformed_command_class(&)
-      # :nocov:
+      # simplecov:disable
       command_registry.each_transformed_command_class(&)
-      # :nocov:
+      # simplecov:enable
     end
 
     def all_transformed_command_classes
@@ -409,9 +410,9 @@ module Foobara
         transformed_command_class = transformed_command_from_name(full_command_name)
 
         unless transformed_command_class
-          # :nocov:
+          # simplecov:disable
           raise NoCommandFoundError.new(message: "Could not find command registered for #{full_command_name}")
-          # :nocov:
+          # simplecov:enable
         end
       else
         action = case action
@@ -422,9 +423,9 @@ module Foobara
                  when "list"
                    "list_commands"
                  else
-                   # :nocov:
+                   # simplecov:disable
                    raise InvalidContextError.new(message: "Not sure what to do with #{action}")
-                   # :nocov:
+                   # simplecov:enable
                  end
 
         command_name = Util.classify(action)
@@ -456,11 +457,11 @@ module Foobara
                        end
 
         unless manifestable
-          # :nocov:
+          # simplecov:disable
           raise NoCommandOrTypeFoundError.new(
             message: "Could not find command or type registered for #{manifestable_name}"
           )
-          # :nocov:
+          # simplecov:enable
         end
 
         request.inputs.merge(manifestable:, request:)
@@ -468,9 +469,9 @@ module Foobara
         transformed_command_class = transformed_command_from_name(full_command_name)
 
         unless transformed_command_class
-          # :nocov:
+          # simplecov:disable
           raise NoCommandFoundError.new(message: "Could not find command registered for #{full_command_name}")
-          # :nocov:
+          # simplecov:enable
         end
 
         request.inputs.merge(manifestable: transformed_command_class, request:)
@@ -478,9 +479,9 @@ module Foobara
         type = type_from_name(full_command_name)
 
         unless type
-          # :nocov:
+          # simplecov:disable
           raise NoTypeFoundError.new(message: "Could not find type registered for #{full_command_name}")
-          # :nocov:
+          # simplecov:enable
         end
 
         request.inputs.merge(manifestable: type, request:)
@@ -493,9 +494,9 @@ module Foobara
       when "list"
         request.inputs.merge(request:)
       else
-        # :nocov:
+        # simplecov:disable
         raise InvalidContextError.new(message: "Not sure what to do with #{action}")
-        # :nocov:
+        # simplecov:enable
       end
     end
 
@@ -552,9 +553,9 @@ module Foobara
       key = registerable_name.to_s
 
       if delayed_connections.key?(key)
-        # :nocov:
+        # simplecov:disable
         raise AlreadyConnectedError, "Already connected #{key}"
-        # :nocov:
+        # simplecov:enable
       else
         delayed_connections[key] = { args:, opts: }
       end
@@ -583,9 +584,9 @@ module Foobara
         self.class.desugarizer.process_value!([args, opts])
       else
         # TODO: test this code path by removing all desugarizers in a spec.
-        # :nocov:
+        # simplecov:disable
         [args, opts]
-        # :nocov:
+        # simplecov:enable
       end
     end
 
@@ -601,7 +602,10 @@ module Foobara
       command_class = determine_command_class(request)
       request.command_class = command_class
 
-      if command_class.respond_to?(:requires_authentication) && command_class.requires_authentication
+      requires_auth = command_class.respond_to?(:requires_authentication) && command_class.requires_authentication
+      optional_auth = command_class.respond_to?(:authentication_optional) && command_class.authentication_optional
+
+      if requires_auth || optional_auth
         request.authenticator ||= command_class.authenticator || authenticator
 
         if auth_map
@@ -625,10 +629,10 @@ module Foobara
           unless request.error
             if command
               run_command(request)
-              # :nocov:
+              # simplecov:disable
             else
               raise "No command returned from #request_to_command"
-              # :nocov:
+              # simplecov:enable
             end
           end
         end

data/projects/command_connectors/src/command_registry/exposed_command.rb

@@ -16,6 +16,7 @@ module Foobara
                     :response_mutators,
                     :allowed_rule,
                     :requires_authentication,
+                    :authentication_optional,
                     :authenticator,
                     :scoped_path
 
@@ -33,6 +34,7 @@ module Foobara
         serializers: nil,
         allowed_rule: nil,
         requires_authentication: nil,
+        authentication_optional: nil,
         authenticator: nil,
         aggregate_entities: nil,
         atomic_entities: nil
@@ -103,6 +105,7 @@ module Foobara
         self.serializers = serializers
         self.allowed_rule = allowed_rule
         self.requires_authentication = requires_authentication
+        self.authentication_optional = authentication_optional
         self.authenticator = authenticator
 
         # A bit hacky... we should check if we need to shim in a LoadDelegatedAttributesEntitiesPreCommitTransformer
@@ -161,6 +164,7 @@ module Foobara
             serializers,
             allowed_rule,
             requires_authentication,
+            authentication_optional,
             authenticator,
             result_has_sensitive_types?
           ]
@@ -182,6 +186,7 @@ module Foobara
                                            serializers:,
                                            allowed_rule:,
                                            requires_authentication:,
+                                           authentication_optional:,
                                            authenticator:
                                          )
                                        end
@@ -196,10 +201,10 @@ module Foobara
         if result_type.nil?
           false
         elsif result_type.sensitive?
-          # :nocov:
+          # simplecov:disable
           # TODO: we should convert it to nil I suppose
           raise "Not sure yet how to handle a sensitive result type hmmmm..."
-          # :nocov:
+          # simplecov:enable
         else
           command_class.result_type.has_sensitive_types?
         end