power-compass 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 431d772b417bd2496c132fafa4ab6daa644ff347dfcd93be3f9b71ad08937851
-  data.tar.gz: e10fdf20cefaa3aac21d9737c42f22a12c3f666ee3b72901d0ad97cbd8af2e5e
+  metadata.gz: ac4e50196da52d39be29790e8e91a2b31ce1900a2c8f368aa46e03c6725a3fb4
+  data.tar.gz: 922ee98c74a56863508b782944dbe2c72a2b0fc2755bda59429f249c938fc528
 SHA512:
-  metadata.gz: fa9cf9b5b30bea0622fc00717f39fe33aa2bbcec48531e7ae3b4e260acee138a2ab4d1e3ecd05d38508efe635ca2e7753077bc2cbe5f23871d6cf5d9c72f5a78
-  data.tar.gz: c4b4686f64fafb15f12a2e0419ae6785cda3e09792aec553388d95c1582c18a6839ea140c6045be47b11fa0b741c1d3a22bd25364a878ae1632d3858f9f715f4
+  metadata.gz: '08022669193bfc3cfb81ee90cae999688010b00f916512c6c7e0949684adf07df7a3f0433d3ab4624190478c86785d2f3e5bc9d95e3484f89d68ece3b169ca3e'
+  data.tar.gz: 52fce33d8d2101daef6167250e1d258bf3bc5149267970ee7a85e44ea8ab7078dc2e2813a8262994a149a2547d9db1a74e508d992fbacbfe79ee01972ad28a7f

data/app/controllers/compass/search_controller.rb

@@ -6,60 +6,21 @@ module Compass
     include Cors
 
     def index
-      if params[:q]
-        results = Compass::Search::Provider.global_search(params.require(:q), current_context)
-        render json: { results: results }
-      else
-        providers
-      end
+      render json: Compass::Search.providers
     end
 
     def show
-      result = Compass::Search::Provider.search(params[:q], params[:provider_name], current_context)
-      render json: {
-        provider: params[:provider_name],
-        context_id: params[:context_id],
-        **result
-      }
+      render json: Compass::Search.search(params[:q], params[:provider_name], current_context)
     rescue Compass::Search::UnknownProvider => error
-      render json: {
+      render status: :not_found, json: {
         error: error.message,
-        available_providers: error.available_providers
-      }, status: :not_found
-    end
-
-    def providers
-      render json: {
-        context_id: params[:context_id],
-        providers: available_provider_names.map do |name|
-          provider_class = find_provider_by_name(name)
-
-          base_info = {
-            name: name,
-            class_name: provider_class&.name
-          }
-          begin
-            label = provider_class&.new(**current_context)&.label || name.humanize
-            base_info.merge(label: label)
-          rescue => e
-            Rails.logger.warn "Error getting provider info for #{name}: #{e.message}"
-            base_info.merge(
-                label: name.humanize,
-                error: e.message
-            )
-          end
-        end
+        available_providers: Compass::Search.providers.map(&:name)
       }
-    end
-
-    private
-
-    def find_provider_by_name(name)
-      Compass::Search::Provider.find_by_name(name)
-    end
-
-    def available_provider_names
-      Compass::Search::Provider.available_provider_names
+    rescue => error
+      Compass.logger&.error(
+        "[ Compass::SearchController ] #{params[:provider_name]}: #{error.class}: #{error.message} | Query: #{params[:q].inspect}"
+      )
+      raise
     end
   end
 end

data/config/routes.rb

@@ -7,12 +7,7 @@ Compass::Engine.routes.draw do
   get ":context_id/search", to: "search#index", as: :search
   options ":context_id/search", to: "search#cors"
 
-  get ":context_id/search/providers", to: "search#providers", as: :search_providers
-  options ":context_id/search/providers", to: "search#cors"
-
-  get ":context_id/search/:provider_name", to: "search#show",
-                                           as: :search_provider,
-                                           constraints: { provider_name: /[a-zA-Z_]+/ }
+  get ":context_id/search/:provider_name", to: "search#show", as: :search_provider
   options ":context_id/search/:provider_name", to: "search#cors"
 
   get ":context_id/notifications", to: "notification#index", as: :notifications

data/lib/compass/json_formatter.rb

@@ -45,11 +45,8 @@ module Compass
       # @param attr_options [Hash] the options for the attributes
       # @private
       def format(*attrs, **attr_options)
-        self._json_formatter = Formatter.new(attrs + attr_options.keys, attr_options)
-        define_singleton_method(:format) do |obj = nil, &block|
-          raise ArgumentError, "Format must be defined for provider #{self.class}" if obj
-
-          self._json_formatter&.instance_eval(&block)
+        define_singleton_method(:format) do |&block|
+          self._json_formatter = Formatter.new(attrs + attr_options.keys, attr_options, &block)
 
           define_method(:format) do |object|
             self._json_formatter&.to_h(self, object)
@@ -65,14 +62,17 @@ module Compass
       #
       # @param attrs [Array] the attributes to format
       # @param attr_options [Hash] the options for the attributes
-      def initialize(attrs, attr_options)
-        @attrs = attrs.index_with { nil }
+      def initialize(attrs, attr_options, &block)
+        @attrs = {}
         @attr_options = attr_options
-        attrs.each do |attr|
+        [ *attrs, *attr_options.keys ].each do |attr|
+          @attrs[attr] = nil
           define_singleton_method(attr) do |&block|
             @attrs[attr] = block
           end
         end
+
+        instance_eval(&block)
       end
 
       # Formats an object into a ruby hash.
@@ -81,7 +81,7 @@ module Compass
       # @return [Hash] the formatted hash
       def to_h(service, obj)
         Hash[@attrs.map do |method, formatter|
-          value = formatter ? formatter.call(obj) : service.try(method)
+          value = formatter ? service.instance_exec(obj, &formatter) : service.try(method)
           validate!(method, value)
 
           [ method, value ]

data/lib/compass/search/provider.rb

@@ -1,67 +1,10 @@
 module Compass
   module Search
-    class UnknownProvider < StandardError
-      attr_reader :provider_name, :available_providers
-
-      def initialize(provider_name, available_providers)
-        @provider_name = provider_name
-        @available_providers = available_providers
-        super("Provider '#{provider_name}' not found")
-      end
-    end
-
     class Provider
       include Compass::Search::Rendering
+      include Compass::JsonFormatter
 
-      class << self
-        attr_reader :providers
-
-        # Handles both class objects and string class names
-        def constantize_provider(provider)
-          provider.is_a?(String) ? provider.constantize : provider
-        end
-
-        # Aggregates search results from all registered providers
-        def global_search(query, context = {})
-          Compass.config.search.providers.flat_map do |provider|
-            begin
-              provider_class = constantize_provider(provider)
-              provider_class.new(**context).search(query)
-            rescue => e
-              Compass.logger&.error("[ Compass::Search::Provider ] #{provider_class}: #{e.class}: #{e.message}")
-              []
-            end
-          end
-        end
-
-        # Add this new class method for individual provider search
-        def search(query, provider_name, context = {})
-          provider_class = find_by_name(provider_name)
-          if provider_class
-            provider_class.new(**context).search(query)
-          else
-            raise UnknownProvider.new(provider_name, available_provider_names)
-          end
-        end
-
-        def normalize_name(provider_class)
-          provider_class.name.demodulize.underscore.sub(/_?provider$/, "")
-        end
-
-        def find_by_name(name)
-          Compass.config.search.providers.find do |provider|
-            provider_class = constantize_provider(provider)
-            normalize_name(provider_class) == name.to_s
-          end&.then { |p| constantize_provider(p) }
-        end
-
-        def available_provider_names
-          Compass.config.search.providers.map do |provider|
-            provider_class = constantize_provider(provider)
-            normalize_name(provider_class)
-          end
-        end
-      end
+      format :url, :label, :category, :tag, :html, :confirm, :extra
 
       def initialize(**context)
         @context = context
@@ -69,46 +12,28 @@ module Compass
       end
 
       def search(query)
-        records = fetch_records(query)
-        {
-          label: label,
-          search_options: search_options,
-          results: Array(records).map { |record| format_result(record) }.compact
-        }
-      rescue => e
-        log_error(e, query)
-        {
-          label: label,
-          search_options: search_options,
-          results: []
-        }
+        fetch_records(query).map { |record| format(record) }
       end
 
-      def label
-        self.class.name.demodulize.sub(/Provider$/, "").titleize
-      end
+      def fetch_records(_query) = must_implement(:fetch_records)
 
-      def search_options
-        {}
-      end
+      class_attribute :label
+      class_attribute :search_options, default: {}
 
-      def fetch_records(query)
-        raise NotImplementedError, "#{self.class} must implement #fetch_records"
-      end
+      def self.label = name.to_s.gsub(/(Provider|Search)/i, "").pluralize
 
-      def format_result(record)
+      def self.as_json(*)
         {
-          id: record.try(:id),
-          label: record.try(:label) || record.try(:name) || record.try(:title) || record.try(:to_s),
-          category: record.try(:category) || record.class.name.demodulize,
-          tag: record.try(:tag) || record.try(:role)
-        }.compact
+          provider: name,
+          label: label,
+          search_options: search_options
+        }
       end
 
-      def log_error(error, query)
-         Compass.logger&.error(
-          "[ Compass::Search::Provider ] #{self.class}: #{error.class}: #{error.message} | Query: #{query.inspect}"
-        )
+    private
+
+      def must_implement(method)
+        raise NotImplementedError, "#{self.class} must implement ##{method}"
       end
     end
   end

data/lib/compass/search.rb

@@ -3,5 +3,34 @@ module Compass
     autoload :Rendering, "compass/search/rendering"
     autoload :Provider, "compass/search/provider"
     autoload :ViewContext, "compass/search/view_context"
+
+    class UnknownProvider < StandardError
+      attr_reader :provider_name
+
+      def initialize(provider_name)
+        @provider_name = provider_name
+        super("Provider '#{provider_name}' not found")
+      end
+    end
+
+    # Searches a specific provider
+    # @example
+    #   Compass::Search.search("Tesla", "CarsSearchProvider", { user: current_user })
+    #
+    # @param query [String] the search query
+    # @param provider_name [String] the class name of the provider to search
+    # @param context [Hash] the context for the search
+    # @return [Array] the formatted search results
+    def self.search(query, provider_name, context = {})
+      provider = providers.find { |provider| provider.name == provider_name.to_s }
+      raise UnknownProvider.new(provider_name) if provider.nil?
+      provider.new(**context).search(query)
+    end
+
+    def self.providers
+      Compass.config.search.providers.map do |provider|
+        provider.try(:constantize) || provider
+      end
+    end
   end
 end

data/lib/compass/version.rb

@@ -1,3 +1,3 @@
 module Compass
-  VERSION = "0.7.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: power-compass
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Carlos Palhares
@@ -15,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.0'
@@ -25,7 +25,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.0'