spree_cm_commissioner 1.10.0 → 1.11.0.pre.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 634d4cd6a4373be586e59598dab82c2440eb292abe53abeeb1161e6bfca85da2
-  data.tar.gz: 3e0e4f5293ce46f30d227269baf174b7b8b3a32ac269a30b733f3e7ea1065aca
+  metadata.gz: 3c727894cc45a2d005e5c0254542ce6b8bfc054a30fe9d7b9fa6c7dfea61cfc4
+  data.tar.gz: 9d99d30cfc27e987bffda2e0462e91a8cbe4d9a88c44c18dc67df02e947f3278
 SHA512:
-  metadata.gz: 7830251cadb15def91fb9d7bc6c6c68dacb3af529d941f6c1d17364f3dd621c2e3539bf24d7d870d0b82e88f2309d78ab895de19219144192dd8924f1a1943b1
-  data.tar.gz: 64bbba3e3a8227f1788748ac27ee108d8f3ad93d89829336f53817556eb6a7e67fd4c43263ce6aa57e087df046139db1c9a665f57411634e1648d8dbd55b9f33
+  metadata.gz: 51065e106d1939327817aa8c54154d1711faee026b771010c9f104083da88aad01aa2f3ced6383c8f3c952e8c8cfba8035324271ee92548dc2e22449da601bf1
+  data.tar.gz: dbc3410043aea748600477cfdd6724d1916155df35e28b62495a53950475f122eac3bf8b80de97282c82214e60ee880e807629246467ca8872753c519eb4afad

data/.github/workflows/test_and_build_gem.yml

@@ -3,96 +3,117 @@ name: Commissioner Gem
 
 on:
   pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+      - reopened
     branches:
       - develop
+      - milestone-77-scalable-design
   push:
     tags:
       - "*"
 jobs:
-  validate-commits:
-    runs-on: ubuntu-latest
+  # validate-commits:
+  #   runs-on: ubuntu-latest
+
+  #   steps:
+  #     - name: Check PR title format
+  #       uses: actions/github-script@v7
+  #       with:
+  #         script: |
+  #           const title = context.payload.pull_request.title.trim();
+
+  #           console.log("PR title: ", title);
+
+  #           const pattern = /^Close\s+#\d+\s.+/;
+
+  #           if (!pattern.test(title)) {
+  #             core.setFailed(
+  #               `PR title must start with "Close #issue_number message". Example: Close #123 Add login form`
+  #             );
+  #           } else {
+  #             console.log("PR title format is correct.");
+  #           }
+  #     - name: Check commit messages format
+  #       uses: actions/github-script@v7
+  #       with:
+  #         script: |
+  #           const pr = context.payload.pull_request;
+  #           const commits_url = pr.commits_url;
+
+  #           const commits = await github.request(commits_url);
+  #           const pattern = /^Close\s+#\d+\s.+/;
+
+  #           let invalidCommits = [];
+
+  #           for (const commit of commits.data) {
+  #             const msg = commit.commit.message.trim();
+
+  #             console.log("commit message: ", msg);
+
+  #             if (!pattern.test(msg)) {
+  #               invalidCommits.push(`- ${msg}`);
+  #             }
+  #           }
+
+  #           if (invalidCommits.length > 0) {
+  #             core.setFailed(
+  #               `The following commit messages are not in the correct format:\n\n${invalidCommits.join(
+  #                 '\n'
+  #               )}\n\nEach commit message must start with "Close #<issue_number> <message>"`
+  #             );
+  #           } else {
+  #             console.log("All commit messages are correctly formatted.");
+  #           }
+  #     - name: Check for unresolved review threads
+  #       uses: actions/github-script@v7
+  #       with:
+  #         script: |
+  #           const prNumber = context.payload.pull_request.number;
+  #           const { owner, repo } = context.repo;
+
+  #           const query = `
+  #             query($owner: String!, $repo: String!, $prNumber: Int!) {
+  #               repository(owner: $owner, name: $repo) {
+  #                 pullRequest(number: $prNumber) {
+  #                   reviewThreads(first: 100) {
+  #                     nodes {
+  #                       isResolved
+  #                       comments(first: 1) {
+  #                         nodes {
+  #                           body
+  #                           author {
+  #                             login
+  #                           }
+  #                         }
+  #                       }
+  #                     }
+  #                   }
+  #                 }
+  #               }
+  #             }
+  #           `;
+  #           const variables = { owner, repo, prNumber };
+  #           const result = await github.graphql(query, variables);
+  #           const threads = result.repository.pullRequest.reviewThreads.nodes;
+
+  #           const unresolved = threads.filter(t => !t.isResolved);
+
+  #           if (unresolved.length > 0) {
+  #             unresolved.forEach(thread => {
+  #               const comments = thread.comments.nodes;
+  #               if (comments.length > 0) {
+  #                 console.log(`💬 Comment by ${comments[0].author.login}: ${comments[0].body}`);
+  #               }
+  #             });
+  #             core.setFailed(`❌ There are ${unresolved.length} unresolved review thread(s). Please resolve them before merging.`);
+  #           } else {
+  #             console.log("✅ All review threads are resolved.");
+  #           }
 
-    steps:
-      - name: Check PR title format
-        uses: actions/github-script@v7
-        if: github.event_name == 'pull_request'
-        with:
-          script: |
-            const title = context.payload.pull_request.title.trim();
-
-            console.log("PR title: ", title);
-
-            const pattern = /^Close\s+#\d+\s.+/;
-
-            if (!pattern.test(title)) {
-              core.setFailed(
-                `PR title must start with "Close #issue_number message". Example: Close #123 Add login form`
-              );
-            } else {
-              console.log("PR title format is correct.");
-            }
-      - name: Check commit messages format
-        uses: actions/github-script@v7
-        if: github.event_name == 'pull_request'
-        with:
-          script: |
-            const pr = context.payload.pull_request;
-            const commits_url = pr.commits_url;
-
-            const commits = await github.request(commits_url);
-            const pattern = /^Close\s+#\d+\s.+/;
-
-            let invalidCommits = [];
-
-            for (const commit of commits.data) {
-              const msg = commit.commit.message.trim();
-
-              console.log("commit message: ", msg);
-
-              if (!pattern.test(msg)) {
-                invalidCommits.push(`- ${msg}`);
-              }
-            }
-
-            if (invalidCommits.length > 0) {
-              core.setFailed(
-                `The following commit messages are not in the correct format:\n\n${invalidCommits.join(
-                  '\n'
-                )}\n\nEach commit message must start with "Close #<issue_number> <message>"`
-              );
-            } else {
-              console.log("All commit messages are correctly formatted.");
-            }
-      - name: Check for unresolved review threads
-        uses: actions/github-script@v7
-        if: github.event_name == 'pull_request'
-        with:
-          script: |
-            const pr = context.payload.pull_request;
-            const owner = context.repo.owner;
-            const repo = context.repo.repo;
-
-            try {
-              const response = await github.rest.pulls.listReviewComments({
-                owner,
-                repo,
-                pull_number: pr.number,
-                per_page: 100
-              });
-
-              const unresolved = response.data.filter(comment => comment.in_reply_to_id && !comment.resolved);
-
-              if (unresolved.length > 0) {
-                core.setFailed(`There are ${unresolved.length} unresolved review comment(s). Please resolve all threads before merging.`);
-              } else {
-                console.log("All review comments are resolved.");
-              }
-            } catch (error) {
-              console.error("Error fetching review comments:", error.message);
-              core.setFailed("Failed to check for unresolved review threads.");
-            }
   test_and_build_gem:
-    needs: [validate-commits]
     # if: github.head_ref != '2572-enforce-pr-workflow' || github.base_ref != 'develop'
     runs-on: ubuntu-latest
 
@@ -112,6 +133,17 @@ jobs:
           --health-timeout 5s
           --health-retries 5
 
+      redis:
+        image: redis
+        # Set health checks to wait until redis has started
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379 # Maps port 6379 on service container to the host
+
     steps:
       - uses: actions/checkout@v3
 
@@ -132,25 +164,26 @@ jobs:
           gem install bundler
           bundle install --jobs 4 --retry 3
 
-      - name: Quality
-        env:
-          DATABASE_URL: postgres://myuser:mypassword@localhost:5432/test_db
-        run: |
-          bundle exec rubocop
+      # - name: Quality
+      #   env:
+      #     DATABASE_URL: postgres://myuser:mypassword@localhost:5432/test_db
+      #   run: |
+      #     bundle exec rubocop
 
-      - name: Security
-        env:
-          DATABASE_URL: postgres://myuser:mypassword@localhost:5432/test_db
-        run: |
-          bundle exec brakeman
+      # - name: Security
+      #   env:
+      #     DATABASE_URL: postgres://myuser:mypassword@localhost:5432/test_db
+      #   run: |
+      #     bundle exec brakeman
 
-      - name: Run test
-        env:
-          DATABASE_URL: postgres://myuser:mypassword@localhost:5432/test_db
+      # - name: Run test
+      #   env:
+      #     DATABASE_URL: postgres://myuser:mypassword@localhost:5432/test_db
+      #     REDIS_URL: redis://localhost:6379/0
 
-        if: github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'develop'
-        run: |
-          bundle exec rake
+      #   if: github.event_name == 'pull_request'
+      #   run: |
+      #     bundle exec rake
 
       # 2405-build-and-publish-gem
       # - name: Rename long migration files

data/.gitignore

@@ -28,4 +28,5 @@ node_modules
 # VScode
 .vscode
 !.vscode/.settings.json
-.env
+.env
+vendor/bundle/

data/.vscode/settings.json

@@ -3,6 +3,6 @@
   "files.trimTrailingWhitespace": true,
   "editor.formatOnSave": true,
   "[yaml]": {
-    "editor.defaultFormatter": "aaron-bond.better-comments"
+    "editor.defaultFormatter": "redhat.vscode-yaml"
   },
 }

data/Gemfile.lock

@@ -34,7 +34,7 @@ GIT
 PATH
   remote: .
   specs:
-    spree_cm_commissioner (1.10.0)
+    spree_cm_commissioner (1.11.0.pre.pre)
       activerecord-multi-tenant
       activerecord_json_validator (~> 2.1, >= 2.1.3)
       aws-sdk-cloudfront
@@ -42,6 +42,7 @@ PATH
       aws-sdk-s3
       blazer (~> 3.0.4)
       byebug
+      connection_pool
       counter_culture (~> 3.2)
       dry-validation (~> 1.10)
       elasticsearch (~> 8.5)
@@ -57,6 +58,8 @@ PATH
       phonelib
       premailer-rails
       rails (~> 7.0.4)
+      redis
+      redis-rails
       rqrcode (~> 2.0)
       searchkick (~> 5.1)
       simple_calendar (~> 2.4)
@@ -617,6 +620,8 @@ GEM
       activesupport (>= 2.3.14)
     racc (1.7.1)
     rack (2.2.8)
+    rack-session (1.0.2)
+      rack (< 3)
     rack-test (2.1.0)
       rack (>= 1.3)
     rails (7.0.8)
@@ -660,8 +665,24 @@ GEM
     rbtree (0.4.6)
     redis (5.0.7)
       redis-client (>= 0.9.0)
+    redis-actionpack (5.5.0)
+      actionpack (>= 5)
+      redis-rack (>= 2.1.0, < 4)
+      redis-store (>= 1.1.0, < 2)
+    redis-activesupport (5.3.0)
+      activesupport (>= 3, < 8)
+      redis-store (>= 1.3, < 2)
     redis-client (0.17.0)
       connection_pool
+    redis-rack (3.0.0)
+      rack-session (>= 0.2.0)
+      redis-store (>= 1.2, < 2)
+    redis-rails (5.0.2)
+      redis-actionpack (>= 5.0, < 6)
+      redis-activesupport (>= 5.0, < 6)
+      redis-store (>= 1.2, < 2)
+    redis-store (1.11.0)
+      redis (>= 4, < 6)
     regexp_parser (2.8.2)
     representable (3.2.0)
       declarative (< 0.1.0)

data/Rakefile

@@ -2,7 +2,7 @@ require 'bundler'
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
-require 'spree/testing_support/extension_rake'
+require 'spree/testing_support/common_rake'
 
 RSpec::Core::RakeTask.new
 
@@ -14,8 +14,37 @@ task :default do
   Rake::Task[:spec].invoke
 end
 
+# Copied from:
+# spree_core:lib/spree/testing_support/common_rake.rb
+# But refactored to skip frontend & backend setup.
 desc 'Generates a dummy app for testing'
-task :test_app do
-  ENV['LIB_NAME'] = 'spree_cm_commissioner'
-  Rake::Task['extension:test_app'].invoke
+task :test_app do |_t, args|
+  require 'spree_cm_commissioner'
+  require "generators/spree_cm_commissioner/install/install_generator"
+
+  Rails.env = ENV['RAILS_ENV'] = 'test'
+
+  Spree::DummyGeneratorHelper.inject_extension_requirements = true
+  Spree::DummyGenerator.start ["--lib_name=spree_cm_commissioner", '--quiet']
+  Spree::InstallGenerator.start [
+    "--lib_name=spree_cm_commissioner",
+    '--auto-accept',
+    '--migrate=false',
+    '--seed=false',
+    '--sample=false',
+    '--quiet',
+    '--copy_storefront=false',
+    "--install_storefront=false",
+    "--install_admin=false",
+    "--user_class=Spree::User"
+  ]
+
+  puts 'Setting up dummy database...'
+  system('bin/rails db:environment:set RAILS_ENV=test')
+  system('bundle exec rake db:drop db:create')
+  Spree::DummyModelGenerator.start
+  system('bundle exec rake db:migrate')
+
+  puts 'Running extension installation generator...'
+  SpreeCmCommissioner::Generators::InstallGenerator.start(['--auto-run-migrations'])
 end

data/app/controllers/spree/admin/stock_managements_controller.rb

@@ -5,6 +5,8 @@ module Spree
 
       before_action :load_parent
 
+      helper_method :inventory_item_message
+
       def load_parent
         @product = Spree::Product.find_by(slug: params[:product_id])
       end
@@ -12,9 +14,58 @@ module Spree
       def index
         @variants = @product.variants.includes(:images, stock_items: :stock_location, option_values: :option_type)
         @variants = [@product.master] if @variants.empty?
-
         @stock_locations = (@variants.flat_map(&:stock_locations) + @product.vendor.stock_locations).uniq
 
+        load_inventories unless @product.permanent_stock?
+      end
+
+      def create
+        result = SpreeCmCommissioner::Stock::StockMovementCreator.call(
+          variant_id: params[:variant_id],
+          stock_location_id: params[:stock_location_id],
+          current_store: current_store,
+          stock_movement_params: stock_movement_params
+        )
+
+        if result.success?
+          flash[:success] = flash_message_for(result.stock_movement, :successfully_created)
+        else
+          flash[:error] = result.message
+        end
+
+        redirect_back fallback_location: admin_product_stock_managements_path(@product)
+      end
+
+      def calendar
+        @year = params[:year].present? ? params[:year].to_i : Time.zone.today.year
+
+        from_date = Date.new(@year, 1, 1).beginning_of_year
+        to_date = Date.new(@year, 1, 1).end_of_year
+
+        @inventory_items = @product.inventory_items.includes(:variant).where(inventory_date: from_date..to_date).to_a
+        @cached_inventory_items = ::SpreeCmCommissioner::RedisStock::CachedInventoryItemsBuilder.new(@inventory_items)
+                                                                                                .call
+                                                                                                .index_by(&:inventory_item_id)
+        @events = SpreeCmCommissioner::CalendarEvent.from_inventory_items(@inventory_items)
+      end
+
+      def inventory_item_message(inventory_item, cached_inventory_item)
+        synced = inventory_item.quantity_available == cached_inventory_item.quantity_available
+
+        if synced
+          "Synced: Quantity available matches in both DB and Redis (#{cached_inventory_item.quantity_available})."
+        else
+          "Out of sync: Redis shows #{cached_inventory_item.quantity_available} available, which doesn't match the database."
+        end
+      end
+
+      private
+
+      def load_inventories
+        @inventory_items = @product.inventory_items.group_by { |item| item.variant.id }
+        @cached_inventory_items = ::SpreeCmCommissioner::RedisStock::CachedInventoryItemsBuilder.new(@product.inventory_items)
+                                                                                                .call
+                                                                                                .index_by(&:inventory_item_id)
         @reserved_stocks = Spree::LineItem
                            .complete
                            .where(variant_id: @variants.pluck(:id))
@@ -25,6 +76,10 @@ module Spree
       def model_class
         Spree::StockItem
       end
+
+      def stock_movement_params
+        params.require(:stock_movement).permit(permitted_stock_movement_attributes)
+      end
     end
   end
 end

data/app/controllers/spree/api/v2/storefront/accommodations/variants_controller.rb

@@ -0,0 +1,42 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        class Accommodations::VariantsController < ::Spree::Api::V2::ResourceController
+          private
+
+          # override
+          def collection
+            @collection ||= SpreeCmCommissioner::Accommodations::FindVariant.new(
+              from_date: params[:from_date]&.to_date,
+              to_date: params[:to_date]&.to_date,
+              vendor_id: params[:accommodation_id],
+              number_of_adults: params[:number_of_adults].to_i,
+              number_of_kids: params[:number_of_kids].to_i
+            ).execute
+          end
+
+          # override
+          def resource
+            @resource ||= collection.find(params[:id])
+          end
+
+          # override
+          def resource_serializer
+            Spree::V2::Storefront::VariantSerializer
+          end
+
+          # override
+          def collection_serializer
+            Spree::V2::Storefront::VariantSerializer
+          end
+
+          # override
+          def required_schema
+            SpreeCmCommissioner::VariantRequestSchema
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -5,55 +5,38 @@ module Spree
         class AccommodationsController < ::Spree::Api::V2::ResourceController
           private
 
+          # override
           def collection
-            @collection ||= collection_finder.call(params: params).value
-          end
-
-          def paginated_collection
-            return @paginated_collection if defined?(@paginated_collection)
-
-            @paginated_collection = super
-            @paginated_collection = apply_service_availability(@paginated_collection)
+            @collection ||= SpreeCmCommissioner::Accommodations::Find.new(
+              from_date: params[:from_date]&.to_date,
+              to_date: params[:to_date]&.to_date,
+              state_id: params[:state_id],
+              number_of_adults: params[:number_of_adults].to_i,
+              number_of_kids: params[:number_of_kids].to_i
+            ).execute
           end
 
+          # override
           def resource
-            resource = resource_finder.call(params: params).value
-            raise ActiveRecord::RecordNotFound if resource.nil?
-
-            apply_service_availability(resource)
-          end
-
-          def apply_service_availability(resource)
-            SpreeCmCommissioner::ApplyServiceAvailability.call(calendarable: resource,
-                                                               from_date: params[:from_date].to_date,
-                                                               to_date: params[:to_date].to_date
-                                                              ).value
+            @resource ||= collection.find(params[:id])
           end
 
+          # override
           def allowed_sort_attributes
             super << :min_price << :max_price
           end
 
-          def model_class
-            Spree::Vendor
-          end
-
+          # override
           def resource_serializer
             Spree::V2::Storefront::AccommodationSerializer
           end
 
+          # override
           def collection_serializer
             Spree::V2::Storefront::AccommodationSerializer
           end
 
-          def collection_finder
-            SpreeCmCommissioner::AccommodationSearchDetail
-          end
-
-          def resource_finder
-            SpreeCmCommissioner::AccommodationSearchDetail
-          end
-
+          # override
           def required_schema
             SpreeCmCommissioner::AccommodationRequestSchema
           end

data/app/controllers/spree/api/v2/storefront/queue_cart/line_items_controller.rb

@@ -12,9 +12,9 @@ module Spree
               spree_authorize! :update, spree_current_order, order_token
               spree_authorize! :show, @variant
 
-              availability_checker = SpreeCmCommissioner::Stock::AvailabilityChecker.new(@variant)
+              availability_checker = SpreeCmCommissioner::Stock::AvailabilityChecker.new(@variant, add_item_params[:options])
 
-              unless availability_checker.can_supply?(add_item_params[:quantity].to_i, add_item_params[:options])
+              unless availability_checker.can_supply?(add_item_params[:quantity].to_i)
                 return render_error_payload(availability_checker.error_message || I18n.t('variant_availability.items_out_of_stock'))
               end
 

data/app/finders/spree_cm_commissioner/accommodations/find.rb

@@ -0,0 +1,40 @@
+module SpreeCmCommissioner
+  module Accommodations
+    class Find
+      attr_reader :from_date, :to_date, :state_id, :number_of_guests
+
+      def initialize(from_date:, to_date:, state_id:, number_of_adults:, number_of_kids:)
+        @from_date = from_date
+        @to_date = to_date
+        @state_id = state_id
+        @number_of_guests = number_of_adults.to_i + number_of_kids.to_i
+      end
+
+      def execute
+        scope
+          .where(default_state_id: state_id)
+          .where(inventory_items: { inventory_date: date_range_excluding_checkout })
+          .where('CAST(spree_variants.public_metadata->\'cm_options\'->>\'number-of-adults\' AS INTEGER) +
+                  CAST(spree_variants.public_metadata->\'cm_options\'->>\'number-of-kids\' AS INTEGER) >= ?', number_of_guests
+          )
+          .where('inventory_items.quantity_available > 0')
+          .distinct
+      end
+
+      private
+
+      def scope
+        Spree::Vendor
+          .joins(variants: :inventory_items)
+          .where(primary_product_type: :accommodation, state: :active)
+      end
+
+      # Why? check_out date is not considered to be charged
+      # For example, if you check in on 2023-10-01 and check out on 2023-10-02,
+      # you will be charged for one night (2023-10-01).
+      def date_range_excluding_checkout
+        from_date..to_date.prev_day
+      end
+    end
+  end
+end

data/app/finders/spree_cm_commissioner/accommodations/find_variant.rb

@@ -0,0 +1,35 @@
+module SpreeCmCommissioner
+  module Accommodations
+    class FindVariant
+      attr_reader :vendor_id, :from_date, :to_date, :number_of_guests
+
+      def initialize(vendor_id:, from_date:, to_date:, number_of_adults:, number_of_kids:)
+        @vendor_id = vendor_id
+        @from_date = from_date
+        @to_date = to_date
+        @number_of_guests = number_of_adults.to_i + number_of_kids.to_i
+      end
+
+      def execute
+        Spree::Variant
+          .joins(:inventory_items)
+          .where(vendor_id: vendor_id)
+          .where(inventory_items: { inventory_date: date_range_excluding_checkout })
+          .where('CAST(public_metadata->\'cm_options\'->>\'number-of-adults\' AS INTEGER) +
+                  CAST(public_metadata->\'cm_options\'->>\'number-of-kids\' AS INTEGER) >= ?', number_of_guests
+          )
+          .where('inventory_items.quantity_available > 0')
+          .distinct
+      end
+
+      private
+
+      # Why? check_out date is not considered to be charged
+      # For example, if you check in on 2023-10-01 and check out on 2023-10-02,
+      # you will be charged for one night (2023-10-01).
+      def date_range_excluding_checkout
+        from_date..to_date.prev_day
+      end
+    end
+  end
+end