From a5c97e7cfd71e873f257919889d3d5a7269feb15 Mon Sep 17 00:00:00 2001
From: Mohamed ABDELLANI <abdellani@gmail.com>
Date: Thu, 26 Oct 2023 10:43:59 +0100
Subject: [PATCH] move tests under shared_examples "order with tax" to context
 "when invoice feature is not enabled"

---
 spec/system/admin/invoice_print_spec.rb | 583 ++++++++++++------------
 1 file changed, 290 insertions(+), 293 deletions(-)

diff --git a/spec/system/admin/invoice_print_spec.rb b/spec/system/admin/invoice_print_spec.rb
index 07419e0728b6..5a14266960e9 100644
--- a/spec/system/admin/invoice_print_spec.rb
+++ b/spec/system/admin/invoice_print_spec.rb
@@ -37,7 +37,7 @@
   end
 
   shared_examples "contains right Payment Description at Checkout information" do
-    let(:url_params) {{}}
+    let(:url_params) { {} }
 
     let!(:payment_method1) do
       create(:stripe_sca_payment_method, distributors: [distributor], description: "description1")
@@ -120,7 +120,7 @@
                                          user: create(:user, email: "xxxxxx@example.com"),
                                          bill_address: create(:address, phone: '1234567890'))
     end
-    let(:url_params) {{}}
+    let(:url_params) { {} }
 
     before do
       allow(Spree::Config).to receive(:invoice_style2?).and_return(alternative_invoice)
@@ -135,315 +135,313 @@
     end
   end
 
-  shared_examples "order with tax" do
-    let(:user1) { create(:user, enterprises: [distributor]) }
-    let!(:zone) { create(:zone_with_member) }
-    let(:address) { create(:address) }
-
-    context "included" do
-      let(:shipping_tax_rate_included) {
-        create(:tax_rate, amount: 0.1, included_in_price: true, zone:)
-      }
-      let(:enterprise_fee_rate_included) {
-        create(:tax_rate, amount: 0.15, included_in_price: true, zone:)
-      }
-      let(:shipping_tax_category) {
-        create(:tax_category, tax_rates: [shipping_tax_rate_included])
-      }
-      let(:fee_tax_category) {
-        create(:tax_category, tax_rates: [enterprise_fee_rate_included])
-      }
-      let!(:shipping_method) {
-        create(:shipping_method_with, :expensive_name, distributors: [distributor],
-                                                       tax_category: shipping_tax_category)
-      }
-      let!(:enterprise_fee) {
-        create(:enterprise_fee, enterprise: user1.enterprises.first,
-                                tax_category: fee_tax_category,
-                                calculator: Calculator::FlatRate.new(preferred_amount: 120.0))
-      }
-      let!(:order_cycle) {
-        create(:simple_order_cycle,
-               coordinator: distributor,
-               coordinator_fees: [enterprise_fee],
-               distributors: [distributor],
-               variants: [product1.variants.first, product2.variants.first])
-      }
-
-      let!(:order1) {
-        create(:order, order_cycle:, distributor: user1.enterprises.first,
-                       ship_address: address, bill_address: address)
-      }
-      let!(:product1) {
-        create(:taxed_product, zone:, price: 12.54, tax_rate_amount: 0,
-                               included_in_price: true)
-      }
-      let!(:product2) {
-        create(:taxed_product, zone:, price: 500.15, tax_rate_amount: 0.2,
-                               included_in_price: true)
-      }
-
-      let!(:line_item1) {
-        create(:line_item, variant: product1.variants.first, price: 12.54, quantity: 1,
-                           order: order1)
-      }
-      let!(:line_item2) {
-        create(:line_item, variant: product2.variants.first, price: 500.15, quantity: 3,
-                           order: order1)
-      }
-
-      let(:url_params) {
-        if OpenFoodNetwork::FeatureToggle.enabled?(:invoices)
-          { invoice_id: order1.invoices.first.id }
-        else
-          {}
-        end
-      }
-
-      before do
-        order1.reload
-        while !order1.delivery?
-          break if !order1.next!
-        end
-        order1.select_shipping_method(shipping_method.id)
-        order1.recreate_all_fees!
-        while !order1.payment?
-          break if !order1.next!
-        end
-
-        create(:payment, state: "checkout", order: order1, amount: order1.reload.total,
-                         payment_method: create(:payment_method, distributors: [distributor]))
-        while !order1.complete?
-          break if !order1.next!
-        end
-        order1.invoices.create!
-      end
+  context "when invoice feature is not enabled" do
+    before do
+      Flipper.disable(:invoices)
+    end
+    it_behaves_like "contains right Payment Description at Checkout information"
+    it_behaves_like "Check display on each invoice: legacy and alternative", false
+    it_behaves_like "Check display on each invoice: legacy and alternative", true
+    describe "order with taxes" do
+      let(:user1) { create(:user, enterprises: [distributor]) }
+      let!(:zone) { create(:zone_with_member) }
+      let(:address) { create(:address) }
+
+      context "included" do
+        let(:shipping_tax_rate_included) {
+          create(:tax_rate, amount: 0.1, included_in_price: true, zone:)
+        }
+        let(:enterprise_fee_rate_included) {
+          create(:tax_rate, amount: 0.15, included_in_price: true, zone:)
+        }
+        let(:shipping_tax_category) {
+          create(:tax_category, tax_rates: [shipping_tax_rate_included])
+        }
+        let(:fee_tax_category) {
+          create(:tax_category, tax_rates: [enterprise_fee_rate_included])
+        }
+        let!(:shipping_method) {
+          create(:shipping_method_with, :expensive_name, distributors: [distributor],
+                                                         tax_category: shipping_tax_category)
+        }
+        let!(:enterprise_fee) {
+          create(:enterprise_fee, enterprise: user1.enterprises.first,
+                                  tax_category: fee_tax_category,
+                                  calculator: Calculator::FlatRate.new(preferred_amount: 120.0))
+        }
+        let!(:order_cycle) {
+          create(:simple_order_cycle,
+                 coordinator: distributor,
+                 coordinator_fees: [enterprise_fee],
+                 distributors: [distributor],
+                 variants: [product1.variants.first, product2.variants.first])
+        }
+
+        let!(:order1) {
+          create(:order, order_cycle:, distributor: user1.enterprises.first,
+                         ship_address: address, bill_address: address)
+        }
+        let!(:product1) {
+          create(:taxed_product, zone:, price: 12.54, tax_rate_amount: 0,
+                                 included_in_price: true)
+        }
+        let!(:product2) {
+          create(:taxed_product, zone:, price: 500.15, tax_rate_amount: 0.2,
+                                 included_in_price: true)
+        }
+
+        let!(:line_item1) {
+          create(:line_item, variant: product1.variants.first, price: 12.54, quantity: 1,
+                             order: order1)
+        }
+        let!(:line_item2) {
+          create(:line_item, variant: product2.variants.first, price: 500.15, quantity: 3,
+                             order: order1)
+        }
+
+        let(:url_params) {
+          if OpenFoodNetwork::FeatureToggle.enabled?(:invoices)
+            { invoice_id: order1.invoices.first.id }
+          else
+            {}
+          end
+        }
 
-      context "legacy invoice" do
         before do
-          allow(Spree::Config).to receive(:invoice_style2?).and_return(false)
-          login_as_admin
-          visit spree.print_admin_order_path(order1, params: url_params)
-          convert_pdf_to_page
+          order1.reload
+          while !order1.delivery?
+            break if !order1.next!
+          end
+          order1.select_shipping_method(shipping_method.id)
+          order1.recreate_all_fees!
+          while !order1.payment?
+            break if !order1.next!
+          end
+
+          create(:payment, state: "checkout", order: order1, amount: order1.reload.total,
+                           payment_method: create(:payment_method, distributors: [distributor]))
+          while !order1.complete?
+            break if !order1.next!
+          end
+          order1.invoices.create!
         end
 
-        it "displays $0.00 when a line item has no tax" do
-          expect(page).to have_content Spree::Product.first.name
-          expect(page).to have_content "(1g)"
-          expect(page).to have_content "1 $0.00 $12.54"
+        context "legacy invoice" do
+          before do
+            allow(Spree::Config).to receive(:invoice_style2?).and_return(false)
+            login_as_admin
+            visit spree.print_admin_order_path(order1, params: url_params)
+            convert_pdf_to_page
+          end
+
+          it "displays $0.00 when a line item has no tax" do
+            expect(page).to have_content Spree::Product.first.name
+            expect(page).to have_content "(1g)"
+            expect(page).to have_content "1 $0.00 $12.54"
+          end
+
+          it "displays the taxes correctly" do
+            # header
+            expect(page).to have_content "Item Qty GST Price"
+            # second line item, included tax
+            expect(page).to have_content Spree::Product.second.name.to_s
+            expect(page).to have_content "(1g)" # display as
+            expect(page).to have_content "3 $250.08 $1,500.45"
+            # Enterprise fee
+            expect(page).to have_content "Whole order - #{
+                                          enterprise_fee.name
+                                        } fee by coordinator " \
+                                         "#{
+                                          user1.enterprises.first.name
+                                        } 1 $15.65 (included) $120.00"
+            # Shipping
+            expect(page).to have_content "Shipping 1 $9.14 (included) $100.55"
+            # Order Totals
+            expect(page).to have_content "GST Total: $274.87"
+            expect(page).to have_content "Total (Excl. tax): $1,458.67"
+            expect(page).to have_content "Total (Incl. tax): $1,733.54"
+          end
         end
 
-        it "displays the taxes correctly" do
-          # header
-          expect(page).to have_content "Item Qty GST Price"
-          # second line item, included tax
-          expect(page).to have_content Spree::Product.second.name.to_s
-          expect(page).to have_content "(1g)" # display as
-          expect(page).to have_content "3 $250.08 $1,500.45"
-          # Enterprise fee
-          expect(page).to have_content "Whole order - #{
-                                        enterprise_fee.name
-                                      } fee by coordinator " \
-                                       "#{
-                                        user1.enterprises.first.name
-                                      } 1 $15.65 (included) $120.00"
-          # Shipping
-          expect(page).to have_content "Shipping 1 $9.14 (included) $100.55"
-          # Order Totals
-          expect(page).to have_content "GST Total: $274.87"
-          expect(page).to have_content "Total (Excl. tax): $1,458.67"
-          expect(page).to have_content "Total (Incl. tax): $1,733.54"
+        context "alternative invoice" do
+          before do
+            allow(Spree::Config).to receive(:invoice_style2?).and_return(true)
+            login_as_admin
+            visit spree.print_admin_order_path(order1, params: url_params)
+            convert_pdf_to_page
+          end
+
+          it "displays the taxes correctly" do
+            # header
+            expect(page).to have_content "Item Qty"
+            expect(page).to have_content "Unit price (Incl. tax)"
+            expect(page).to have_content "Total price (Incl. tax)"
+            expect(page).to have_content "Tax rate"
+            # first line item, no tax
+            expect(page).to have_content Spree::Product.first.name.to_s
+            expect(page).to have_content "(1g)" # display as
+            expect(page).to have_content "1 $12.54 $12.54 0.0%"
+            # second line item, included tax
+            expect(page).to have_content Spree::Product.second.name.to_s
+            expect(page).to have_content "(1g)" # display as
+            expect(page).to have_content "3 $500.15 $1,500.45 20.0%"
+            # Enterprise fee
+            expect(page).to have_content "#{enterprise_fee.name} fee by coordinator " \
+                                         "#{user1.enterprises.first.name} $120.00"
+            # Shipping
+            expect(page).to have_content "Shipping $100.55 10.0%"
+            # Tax totals
+            expect(page).to have_content "Total tax (10.0%): $9.14 " \
+                                         "Total tax (15.0%): $15.65 Total tax (20.0%): $250.08"
+            # Order Totals
+            expect(page).to have_content "Total (Incl. tax): $1,733.54"
+            expect(page).to have_content "Total (Excl. tax): $1,458.67"
+          end
         end
       end
 
-      context "alternative invoice" do
-        before do
-          allow(Spree::Config).to receive(:invoice_style2?).and_return(true)
-          login_as_admin
-          visit spree.print_admin_order_path(order1, params: url_params)
-          convert_pdf_to_page
-        end
-
-        it "displays the taxes correctly" do
-          # header
-          expect(page).to have_content "Item Qty"
-          expect(page).to have_content "Unit price (Incl. tax)"
-          expect(page).to have_content "Total price (Incl. tax)"
-          expect(page).to have_content "Tax rate"
-          # first line item, no tax
-          expect(page).to have_content Spree::Product.first.name.to_s
-          expect(page).to have_content "(1g)" # display as
-          expect(page).to have_content "1 $12.54 $12.54 0.0%"
-          # second line item, included tax
-          expect(page).to have_content Spree::Product.second.name.to_s
-          expect(page).to have_content "(1g)" # display as
-          expect(page).to have_content "3 $500.15 $1,500.45 20.0%"
-          # Enterprise fee
-          expect(page).to have_content "#{enterprise_fee.name} fee by coordinator " \
-                                       "#{user1.enterprises.first.name} $120.00"
-          # Shipping
-          expect(page).to have_content "Shipping $100.55 10.0%"
-          # Tax totals
-          expect(page).to have_content "Total tax (10.0%): $9.14 " \
-                                       "Total tax (15.0%): $15.65 Total tax (20.0%): $250.08"
-          # Order Totals
-          expect(page).to have_content "Total (Incl. tax): $1,733.54"
-          expect(page).to have_content "Total (Excl. tax): $1,458.67"
-        end
-      end
-    end
-
-    context "added" do
-      let(:shipping_tax_rate_added) {
-        create(:tax_rate, amount: 0.10, included_in_price: false, zone:)
-      }
-      let(:enterprise_fee_rate_added) {
-        create(:tax_rate, amount: 0.15, included_in_price: false, zone:)
-      }
-      let(:shipping_tax_category) {
-        create(:tax_category, tax_rates: [shipping_tax_rate_added])
-      }
-      let(:fee_tax_category) { create(:tax_category, tax_rates: [enterprise_fee_rate_added]) }
-      let!(:shipping_method) {
-        create(:shipping_method_with, :expensive_name, distributors: [distributor],
-                                                       tax_category: shipping_tax_category)
-      }
-      let(:enterprise_fee) {
-        create(:enterprise_fee, enterprise: user1.enterprises.first,
-                                tax_category: fee_tax_category,
-                                calculator: Calculator::FlatRate.new(preferred_amount: 120.0))
-      }
-      let(:order_cycle2) {
-        create(:simple_order_cycle, coordinator: distributor,
-                                    coordinator_fees: [enterprise_fee],
-                                    distributors: [distributor],
-                                    variants: [product3.variants.first, product4.variants.first])
-      }
-
-      let(:order2) {
-        create(:order, order_cycle: order_cycle2, distributor: user1.enterprises.first,
-                       ship_address: address, bill_address: address)
-      }
-      let(:product3) {
-        create(:taxed_product, zone:, price: 12.54, tax_rate_amount: 0,
-                               included_in_price: false)
-      }
-      let(:product4) {
-        create(:taxed_product, zone:, price: 500.15, tax_rate_amount: 0.2,
-                               included_in_price: false)
-      }
-
-      let!(:line_item3) {
-        create(:line_item, variant: product3.variants.first, price: 12.54, quantity: 1,
-                           order: order2)
-      }
-      let!(:line_item4) {
-        create(:line_item, variant: product4.variants.first, price: 500.15, quantity: 3,
-                           order: order2)
-      }
+      context "added" do
+        let(:shipping_tax_rate_added) {
+          create(:tax_rate, amount: 0.10, included_in_price: false, zone:)
+        }
+        let(:enterprise_fee_rate_added) {
+          create(:tax_rate, amount: 0.15, included_in_price: false, zone:)
+        }
+        let(:shipping_tax_category) {
+          create(:tax_category, tax_rates: [shipping_tax_rate_added])
+        }
+        let(:fee_tax_category) { create(:tax_category, tax_rates: [enterprise_fee_rate_added]) }
+        let!(:shipping_method) {
+          create(:shipping_method_with, :expensive_name, distributors: [distributor],
+                                                         tax_category: shipping_tax_category)
+        }
+        let(:enterprise_fee) {
+          create(:enterprise_fee, enterprise: user1.enterprises.first,
+                                  tax_category: fee_tax_category,
+                                  calculator: Calculator::FlatRate.new(preferred_amount: 120.0))
+        }
+        let(:order_cycle2) {
+          create(:simple_order_cycle, coordinator: distributor,
+                                      coordinator_fees: [enterprise_fee],
+                                      distributors: [distributor],
+                                      variants: [product3.variants.first, product4.variants.first])
+        }
+
+        let(:order2) {
+          create(:order, order_cycle: order_cycle2, distributor: user1.enterprises.first,
+                         ship_address: address, bill_address: address)
+        }
+        let(:product3) {
+          create(:taxed_product, zone:, price: 12.54, tax_rate_amount: 0,
+                                 included_in_price: false)
+        }
+        let(:product4) {
+          create(:taxed_product, zone:, price: 500.15, tax_rate_amount: 0.2,
+                                 included_in_price: false)
+        }
+
+        let!(:line_item3) {
+          create(:line_item, variant: product3.variants.first, price: 12.54, quantity: 1,
+                             order: order2)
+        }
+        let!(:line_item4) {
+          create(:line_item, variant: product4.variants.first, price: 500.15, quantity: 3,
+                             order: order2)
+        }
 
-      before do
-        order2.reload
-        while !order2.delivery?
-          break if !order2.next!
-        end
-        order2.select_shipping_method(shipping_method.id)
-        order2.recreate_all_fees!
-        while !order2.payment?
-          break if !order2.next!
-        end
-
-        create(:payment, state: "checkout", order: order2, amount: order2.reload.total,
-                         payment_method: create(:payment_method, distributors: [distributor]))
-        while !order2.complete?
-          break if !order2.next!
-        end
-      end
-
-      context "legacy invoice" do
         before do
-          allow(Spree::Config).to receive(:invoice_style2?).and_return(false)
-          login_as_admin
-          visit spree.print_admin_order_path(order2)
-          convert_pdf_to_page
-        end
-        it "displays $0.0 when a line item has no tax" do
-          expect(page).to have_content Spree::Product.first.name
-          expect(page).to have_content "(1g)"
-          expect(page).to have_content "1 $0.00 $12.54"
+          order2.reload
+          while !order2.delivery?
+            break if !order2.next!
+          end
+          order2.select_shipping_method(shipping_method.id)
+          order2.recreate_all_fees!
+          while !order2.payment?
+            break if !order2.next!
+          end
+
+          create(:payment, state: "checkout", order: order2, amount: order2.reload.total,
+                           payment_method: create(:payment_method, distributors: [distributor]))
+          while !order2.complete?
+            break if !order2.next!
+          end
         end
 
-        it "displays the added tax on the GST colum" do
-          expect(page).to have_content Spree::Product.second.name.to_s
-          expect(page).to have_content "(1g)" # display as
-          expect(page).to have_content "3 $300.09 $1,500.45"
+        context "legacy invoice" do
+          before do
+            allow(Spree::Config).to receive(:invoice_style2?).and_return(false)
+            login_as_admin
+            visit spree.print_admin_order_path(order2)
+            convert_pdf_to_page
+          end
+          it "displays $0.0 when a line item has no tax" do
+            expect(page).to have_content Spree::Product.first.name
+            expect(page).to have_content "(1g)"
+            expect(page).to have_content "1 $0.00 $12.54"
+          end
+
+          it "displays the added tax on the GST colum" do
+            expect(page).to have_content Spree::Product.second.name.to_s
+            expect(page).to have_content "(1g)" # display as
+            expect(page).to have_content "3 $300.09 $1,500.45"
+          end
+
+          it "displays the taxes correctly" do
+            # header
+            expect(page).to have_content "Item Qty GST Price"
+            # Enterprise fee
+            expect(page).to have_content "Whole order - #{
+                                          enterprise_fee.name
+                                        } fee by coordinator " \
+                                         "#{
+                                          user1.enterprises.first.name
+                                        } 1 $18.00 $120.00"
+            # Shipping
+            expect(page).to have_content "Shipping 1 $10.06 $100.55"
+            # Order Totals
+            expect(page).to have_content "GST Total: $328.15"
+            expect(page).to have_content "Total (Excl. tax): $1,733.54"
+            expect(page).to have_content "Total (Incl. tax): $2,061.69"
+          end
         end
 
-        it "displays the taxes correctly" do
-          # header
-          expect(page).to have_content "Item Qty GST Price"
-          # Enterprise fee
-          expect(page).to have_content "Whole order - #{
-                                        enterprise_fee.name
-                                      } fee by coordinator " \
-                                       "#{
-                                        user1.enterprises.first.name
-                                      } 1 $18.00 $120.00"
-          # Shipping
-          expect(page).to have_content "Shipping 1 $10.06 $100.55"
-          # Order Totals
-          expect(page).to have_content "GST Total: $328.15"
-          expect(page).to have_content "Total (Excl. tax): $1,733.54"
-          expect(page).to have_content "Total (Incl. tax): $2,061.69"
-        end
-      end
-
-      context "alternative invoice" do
-        before do
-          allow(Spree::Config).to receive(:invoice_style2?).and_return(true)
-          login_as_admin
-          visit spree.print_admin_order_path(order2)
-          convert_pdf_to_page
-        end
-        it "displays the taxes correctly" do
-          # header
-          expect(page).to have_content "Item Qty"
-          expect(page).to have_content "Unit price (Incl. tax)"
-          expect(page).to have_content "Total price (Incl. tax)"
-          expect(page).to have_content "Tax rate"
-          # first line item, no tax
-          expect(page).to have_content Spree::Product.first.name.to_s
-          expect(page).to have_content "(1g)" # display as
-          expect(page).to have_content "1 $12.54 $12.54 0.0%"
-          # second line item, included tax
-          expect(page).to have_content Spree::Product.second.name.to_s
-          expect(page).to have_content "(1g)" # display as
-          expect(page).to have_content "3 $500.15 $1,500.45 20.0%"
-          # Enterprise fee
-          expect(page).to have_content "#{enterprise_fee.name} fee by coordinator " \
-                                       "#{user1.enterprises.first.name} $120.00"
-          # Shipping
-          expect(page).to have_content "Shipping $100.55 10.0%"
-          # Tax totals
-          expect(page).to have_content "Total tax (10.0%): $10.06 " \
-                                       "Total tax (15.0%): $18.00 Total tax (20.0%): $300.09"
-          # Order Totals
-          expect(page).to have_content "Total (Incl. tax): $2,061.69"
-          expect(page).to have_content "Total (Excl. tax): $1,733.54"
+        context "alternative invoice" do
+          before do
+            allow(Spree::Config).to receive(:invoice_style2?).and_return(true)
+            login_as_admin
+            visit spree.print_admin_order_path(order2)
+            convert_pdf_to_page
+          end
+          it "displays the taxes correctly" do
+            # header
+            expect(page).to have_content "Item Qty"
+            expect(page).to have_content "Unit price (Incl. tax)"
+            expect(page).to have_content "Total price (Incl. tax)"
+            expect(page).to have_content "Tax rate"
+            # first line item, no tax
+            expect(page).to have_content Spree::Product.first.name.to_s
+            expect(page).to have_content "(1g)" # display as
+            expect(page).to have_content "1 $12.54 $12.54 0.0%"
+            # second line item, included tax
+            expect(page).to have_content Spree::Product.second.name.to_s
+            expect(page).to have_content "(1g)" # display as
+            expect(page).to have_content "3 $500.15 $1,500.45 20.0%"
+            # Enterprise fee
+            expect(page).to have_content "#{enterprise_fee.name} fee by coordinator " \
+                                         "#{user1.enterprises.first.name} $120.00"
+            # Shipping
+            expect(page).to have_content "Shipping $100.55 10.0%"
+            # Tax totals
+            expect(page).to have_content "Total tax (10.0%): $10.06 " \
+                                         "Total tax (15.0%): $18.00 Total tax (20.0%): $300.09"
+            # Order Totals
+            expect(page).to have_content "Total (Incl. tax): $2,061.69"
+            expect(page).to have_content "Total (Excl. tax): $1,733.54"
+          end
         end
       end
     end
   end
-
-  context "when invoice feature is not enabled" do
-    before do
-      Flipper.disable(:invoices)
-    end
-    it_behaves_like "contains right Payment Description at Checkout information"
-    it_behaves_like "Check display on each invoice: legacy and alternative", false
-    it_behaves_like "Check display on each invoice: legacy and alternative", true
-    it_behaves_like "order with tax"
-  end
   context "when invoice feature is enabled" do
     before do
       Flipper.enable(:invoices)
@@ -451,7 +449,6 @@
     it_behaves_like "contains right Payment Description at Checkout information"
     it_behaves_like "Check display on each invoice: legacy and alternative", false
     it_behaves_like "Check display on each invoice: legacy and alternative", true
-    it_behaves_like "order with tax"
   end
 end