spree_cm_commissioner 2.4.0 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f63b4eb2a25d5dff782d61eb3df12b639c261a418213940ed12d8b9b483b9a1
-  data.tar.gz: 6682f9d70eb92effa0345aee38da3d483c8bf555a74da8c88fc52ddb7553a2e5
+  metadata.gz: 41a0cae2693223db96d5e06211c36bfccd036a7661b2b65dcf8aa96a51ec66a1
+  data.tar.gz: 8c64ffd38289f261b85873082b90b7295dd9d8e72157d48941d21d506f21b84d
 SHA512:
-  metadata.gz: 7abea09634def1e05f839d075bb5fcd1cdfac7bc13ed0392ac6c5aa60e5f9aef3a54600d69afa63778aca0ddf62e09ffc1f5c0200dd88f728b7a1bcd0272faea
-  data.tar.gz: f102b65bf2526916e47c728b0e50eebe7ce188b96bc0f206d92be0434499a734fe0c434f5d364554c20d5bcf0cec20f4b2bdb945d321c213ddb03c1678d9f135
+  metadata.gz: 935aa1894a546795e42928ff46c13b55b95043f3419dde0d842ad5f7a684eb71bcb8e52b1624e9a56766018cdf531e8e92305e4fcf0f1b805974508aa3012759
+  data.tar.gz: d91d61dfb4c16a1c4e5b5e31622c37a9b60e17f3c591e6f2e02f3c2a9b932012b3250e9d2f688af74126ce79c0bbecd3962d0b484d961bc5c9290ac7148b2874

data/Gemfile.lock

@@ -34,7 +34,7 @@ GIT
 PATH
   remote: .
   specs:
-    spree_cm_commissioner (2.4.0)
+    spree_cm_commissioner (2.4.2)
       activerecord-multi-tenant
       activerecord_json_validator (~> 2.1, >= 2.1.3)
       aws-sdk-cloudfront

data/app/controllers/spree/api/v2/storefront/popular_route_places_controller.rb

@@ -18,7 +18,9 @@ module Spree
 
           # override
           def collection
-            @collection ||= collection_finder.new.execute
+            @collection ||= collection_finder.new.execute(
+              route_type: params[:route_type]
+            )
           end
 
           # override

data/app/controllers/spree/api/v2/storefront/route_places_controller.rb

@@ -1,24 +1,42 @@
-# API endpoint for searching places that are used in routes by keyword.
+# API endpoint for searching places connected to a specific place via routes.
 #
 # GET /api/v2/storefront/route_places
 #
-# Searches for places (origins or destinations) that are used in existing routes,
-# filtered by keyword search on place names.
+# Finds places (origins or destinations) that are connected to a given place through existing routes.
+# Optionally filters results by keyword or route_type. Supports two modes:
+#
+# Usage 1: Connected places (requires place_id)
+#   - Finds places connected to a specific place via routes
+#   - Returns origins/destinations that have routes with the specified place
+#
+# Usage 2: Keyword search (requires query, place_id optional)
+#   - Searches all route places by keyword
+#   - Returns all origins/destinations matching the keyword
 #
 # Query Parameters:
-#   - query: [String] Required. Keyword to search in place names (case-insensitive)
 #   - place_type: [String] Required. Type of route place: 'origin' or 'destination'
+#     * 'origin': returns origins that have routes TO the specified place (if place_id provided)
+#     * 'destination': returns destinations that have routes FROM the specified place (if place_id provided)
+#   - place_id: [Integer] Optional. The place ID to find connected places for
+#   - query: [String] Optional. Keyword to filter place names (case-insensitive)
 #   - include: Optional comma-separated list (e.g., 'vendors,nearby_places')
 #
 # Response: Collection of places serialized with PlaceSerializer
 #
 # Behavior:
-#   - Returns empty collection if query is blank or place_type is invalid
-#   - UI should only call this endpoint when user has input a search term
-#   - For initial/empty state, use GET /api/v2/storefront/popular_route_places instead
+#   - Returns empty collection if place_type is invalid
+#   - If place_id provided: returns places connected to that place
+#   - If place_id blank: returns all origins/destinations
+#   - Filters results by keyword or route_type if provided
+#
+# @example Mode 1: Find destinations connected to origin place ID 123
+#   GET /api/v2/storefront/route_places?place_id=123&place_type=destination
+#
+# @example Mode 2: Search all destination places by keyword
+#   GET /api/v2/storefront/route_places?place_type=destination&query=Phnom
 #
-# @example
-#   GET /api/v2/storefront/route_places?query=Phnom&place_type=origin
+# @example Combined: Find origins connected to place 456, filtered by keyword
+#   GET /api/v2/storefront/route_places?place_id=456&place_type=origin&query=Siem
 module Spree
   module Api
     module V2
@@ -28,7 +46,12 @@ module Spree
 
           # override
           def collection
-            @collection ||= collection_finder.new(keyword: params[:query], place_type: params[:place_type]).execute
+            @collection ||= collection_finder.new(
+              place_type: params[:place_type],
+              place_id: params[:place_id],
+              keyword: params[:query],
+              route_type: params[:route_type]
+            ).execute
           end
 
           # override

data/app/finders/spree_cm_commissioner/places/find_with_route.rb

@@ -1,43 +1,80 @@
-# Finds places that are used in routes (as origin or destination) by keyword search.
+# Finds places connected via routes with optional filtering.
 #
-# @param keyword [String] Search term to match against place names (case-insensitive)
-# @param place_type [String] Type of route place: 'origin' or 'destination'
+# @param place_type [String] Required. 'origin' or 'destination'
+# @param place_id [Integer] Optional. Filter by connected place ID
+# @param keyword [String] Optional. Filter by place name (case-insensitive)
+# @param route_type [Symbol, String] Optional. Filter by route type from associated trips (e.g., :ferry, :bus)
 #
-# @return [ActiveRecord::Relation<SpreeCmCommissioner::Place>] Places matching the keyword
-#   that are used as origins or destinations in existing routes. Returns empty relation if
-#   keyword is blank or place_type is invalid.
+# @return [ActiveRecord::Relation<SpreeCmCommissioner::Place>]
 #
-# @note For default/empty state display, use SpreeCmCommissioner::Routes::FindPopular instead
-#   to show popular routes to users before they enter a search term.
+# Modes:
+#   - place_id only: returns connected places (origins TO or destinations FROM given place)
+#   - keyword only: filters by name
+#   - route_type only: filters by trip route types on those routes
+#   - combinations: connected places filtered by name and/or route type
+#   - neither: all origins/destinations in routes
 #
-# @example
-#   finder = SpreeCmCommissioner::Places::FindWithRoute.new(keyword: 'Phnom', place_type: 'origin')
-#   finder.execute # => Returns places with "Phnom" in name that are used as route origins
+# @example Origins with ferry trips to place 123
+#   FindWithRoute.new(place_type: 'origin', place_id: 123, route_type: :ferry).execute
+#
+# @example Destinations filtered by keyword and route type
+#   FindWithRoute.new(place_type: 'destination', keyword: 'Phnom', route_type: :bus).execute
 module SpreeCmCommissioner
   module Places
     class FindWithRoute
-      attr_reader :keyword, :place_type
+      attr_reader :place_type, :place_id, :keyword, :route_type
 
-      def initialize(keyword:, place_type:)
-        @keyword = keyword
+      def initialize(place_type:, place_id: nil, keyword: nil, route_type: nil)
         @place_type = place_type
+        @place_id = place_id
+        @keyword = keyword
+        @route_type = route_type
       end
 
       def execute
-        return SpreeCmCommissioner::Place.none if keyword.blank? || place_type.blank?
+        return SpreeCmCommissioner::Place.none if place_type.blank?
+        return SpreeCmCommissioner::Place.none if place_id.present? && !SpreeCmCommissioner::Place.exists?(place_id)
 
-        scope.where('cm_places.name ILIKE ?', "%#{keyword}%")
+        result = scope
+        result = apply_keyword_filter(result) if keyword.present?
+        result = apply_route_type_filter(result) if route_type.present?
+        result
       end
 
       private
 
       def scope
-        if place_type == 'origin'
-          SpreeCmCommissioner::Place.with_routes_as_origin
+        return SpreeCmCommissioner::Place.none unless valid_place_type?
+
+        base_scope = origin? ? SpreeCmCommissioner::Place.with_routes_as_origin : SpreeCmCommissioner::Place.with_routes_as_destination
+
+        return base_scope if place_id.blank?
+
+        if origin?
+          base_scope.where(routes_as_origin: { destination_place_id: place_id })
         else
-          SpreeCmCommissioner::Place.with_routes_as_destination
+          base_scope.where(routes_as_destination: { origin_place_id: place_id })
         end
       end
+
+      def apply_keyword_filter(result)
+        result.where('cm_places.name ILIKE ?', "%#{keyword}%")
+      end
+
+      def apply_route_type_filter(result)
+        trips_association = origin? ? :trips_as_origin : :trips_as_destination
+        result.joins(trips_association)
+              .where(cm_trips: { route_type: route_type.to_sym })
+              .distinct
+      end
+
+      def origin?
+        place_type == 'origin'
+      end
+
+      def valid_place_type?
+        %w[origin destination].include?(place_type)
+      end
     end
   end
 end

data/app/finders/spree_cm_commissioner/routes/find_popular.rb

@@ -4,21 +4,46 @@
 # 1. fulfilled_order_count (completed orders) - DESC
 # 2. order_count (total orders including incomplete) - DESC
 #
+# @param route_type [Symbol, String] Optional. Filter by route type from associated trips (e.g., :ferry, :bus)
+#
 # @return [ActiveRecord::Relation<SpreeCmCommissioner::Route>] Routes with origin and destination places loaded,
 #   ordered from most to least popular
 #
-# @example
+# @example Get all popular routes
+#   finder = SpreeCmCommissioner::Routes::FindPopular.new
+#   finder.execute # => Returns all routes sorted by fulfillment and order counts
+#
+# @example Get popular ferry routes
+#   finder = SpreeCmCommissioner::Routes::FindPopular.new
+#   finder.execute(route_type: :ferry) # => Returns ferry routes sorted by popularity
+#
+# @example Get popular bus routes
 #   finder = SpreeCmCommissioner::Routes::FindPopular.new
-#   finder.execute # => Returns routes sorted by fulfillment and order counts
+#   finder.execute(route_type: :bus) # => Returns bus routes sorted by popularity
 
 module SpreeCmCommissioner
   module Routes
     class FindPopular
-      def execute
-        SpreeCmCommissioner::Route
-          .includes(:origin_place, :destination_place)
-          .order(Arel.sql('COALESCE(fulfilled_order_count, 0) DESC'))
-          .order(Arel.sql('COALESCE(order_count, 0) DESC'))
+      def execute(route_type: nil)
+        scope(route_type: route_type)
+      end
+
+      private
+
+      def scope(route_type: nil)
+        result = SpreeCmCommissioner::Route
+                 .includes(:origin_place, :destination_place)
+
+        if route_type.present?
+          # Filter routes that have trips with the specified route_type
+          route_scope = SpreeCmCommissioner::Route
+                        .joins(:trips)
+                        .where(cm_trips: { route_type: route_type.to_sym })
+          result = result.where(id: route_scope.select(:id))
+        end
+
+        result.order(Arel.sql('COALESCE(fulfilled_order_count, 0) DESC'))
+              .order(Arel.sql('COALESCE(order_count, 0) DESC'))
       end
     end
   end

data/app/models/concerns/spree_cm_commissioner/vehicle_type.rb

@@ -2,7 +2,7 @@ module SpreeCmCommissioner
   module VehicleType
     extend ActiveSupport::Concern
 
-    VEHICLE_TYPES = %i[suv sedan minivan van sleeping_bus luxury_van air_bus bus].freeze
+    VEHICLE_TYPES = %i[suv sedan minivan van sleeping_bus luxury_van air_bus bus ferry].freeze
 
     included do
       enum vehicle_type: VEHICLE_TYPES if table_exists? && column_names.include?('vehicle_type')

data/app/models/spree_cm_commissioner/place.rb

@@ -24,6 +24,9 @@ module SpreeCmCommissioner
     has_many :routes_as_origin, class_name: 'SpreeCmCommissioner::Route', foreign_key: :origin_place_id
     has_many :routes_as_destination, class_name: 'SpreeCmCommissioner::Route', foreign_key: :destination_place_id
 
+    has_many :trips_as_origin, through: :routes_as_origin, source: :trips
+    has_many :trips_as_destination, through: :routes_as_destination, source: :trips
+
     # Scopes for route-based filtering
     scope :with_routes_as_origin, -> { joins(:routes_as_origin).distinct }
     scope :with_routes_as_destination, -> { joins(:routes_as_destination).distinct }

data/app/request_schemas/spree_cm_commissioner/route_places_request_schema.rb

@@ -2,7 +2,9 @@ module SpreeCmCommissioner
   class RoutePlacesRequestSchema < ApplicationRequestSchema
     params do
       required(:place_type).filled(:string)
-      required(:query).filled(:string)
+      optional(:query).maybe(:string)
+      optional(:place_id).maybe(:integer)
+      optional(:route_type).maybe(:string)
     end
 
     rule(:place_type) do

data/lib/spree_cm_commissioner/version.rb

@@ -1,5 +1,5 @@
 module SpreeCmCommissioner
-  VERSION = '2.4.0'.freeze
+  VERSION = '2.4.2'.freeze
 
   module_function
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_cm_commissioner
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.2
 platform: ruby
 authors:
 - You
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-08 00:00:00.000000000 Z
+date: 2025-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree