harpiya_core 4.3.0.alpha

data/lib/harpiya/testing_support/factories/zone_factory.rb

@@ -0,0 +1,28 @@
+FactoryBot.define do
+  factory :zone, class: Harpiya::Zone do
+    name        { generate(:random_string) }
+    description { generate(:random_string) }
+
+    factory :zone_with_country do
+      kind { :country }
+
+      zone_members do |proxy|
+        zone = proxy.instance_eval { @instance }
+
+        [Harpiya::ZoneMember.create(zoneable: create(:country), zone: zone)]
+      end
+
+      factory :global_zone, class: Harpiya::Zone do
+        sequence(:name) { |n| "GlobalZone_#{n}" }
+
+        zone_members do |proxy|
+          zone = proxy.instance_eval { @instance }
+
+          Harpiya::Country.all.map do |country|
+            Harpiya::ZoneMember.where(zoneable: country, zone: zone).first_or_create
+          end
+        end
+      end
+    end
+  end
+end

data/lib/harpiya/testing_support/factories/zone_member_factory.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :zone_member, class: Harpiya::ZoneMember do
+    zone { |member| member.association(:zone) }
+    zoneable { |member| member.association(:zoneable) }
+  end
+end

data/lib/harpiya/testing_support/flash.rb

@@ -0,0 +1,25 @@
+module Harpiya
+  module TestingSupport
+    module Flash
+      def assert_flash_success(flash)
+        flash = convert_flash(flash)
+
+        within("[class='flash success']") do
+          expect(page).to have_content(flash)
+        end
+      end
+
+      def assert_successful_update_message(resource)
+        flash = Harpiya.t(:successfully_updated, resource: Harpiya.t(resource))
+        assert_flash_success(flash)
+      end
+
+      private
+
+      def convert_flash(flash)
+        flash = Harpiya.t(flash) if flash.is_a?(Symbol)
+        flash
+      end
+    end
+  end
+end

data/lib/harpiya/testing_support/flatpickr_capybara.rb

@@ -0,0 +1,101 @@
+module Harpiya
+  module TestingSupport
+    module FlatpickrCapybara
+      def fill_in_date_manually(label_text, with:)
+        with_open_flatpickr(label_text) do |field|
+          fill_in field[:id], with: with
+        end
+      end
+
+      def fill_in_date_picker(label_text, with:)
+        within_open_flatpickr(label_text) do
+          within_flatpickr_months do
+            fill_in_flatpickr_year(with.split('-')[0])
+
+            select_flatpickr_month(with.split('-')[1])
+
+            click_on_flatpickr_day(with.split('-')[2])
+          end
+        end
+      end
+
+      def fill_in_date_time_picker(label_text, with:)
+        within_open_flatpickr(label_text) do
+          within_flatpickr_months do
+            fill_in_flatpickr_year(with.split('-')[0])
+
+            select_flatpickr_month(with.split('-')[1])
+
+            click_on_flatpickr_day(with.split('-')[2])
+          end
+
+          within_flatpickr_time do
+            select_flatpickr_hour(with.split('-')[3])
+
+            select_flatpickr_min(with.split('-')[4])
+          end
+        end
+      end
+
+      def fill_in_date_with_js(label_text, with:)
+        date_field = find("input[id='#{label_text}']")
+        script = "document.querySelector('#{date_field}').flatpickr().setDate('#{with}');"
+
+        page.execute_script(script)
+      end
+
+      private
+
+      def with_open_flatpickr(label_text)
+        field_label = find_field(id: label_text, type: :hidden)
+
+        date_field = field_label.sibling('.flatpickr-alt-input')
+        date_field.click # Open the widget
+
+        yield(date_field)
+
+        date_field.send_keys :tab # Close the date picker widget
+      end
+
+      def within_open_flatpickr(label_text, &block)
+        with_open_flatpickr(label_text) do
+          within find(:xpath, "/html/body/div[contains(@class, 'flatpickr-calendar')]", &block)
+        end
+      end
+
+      def within_flatpickr_months(&block)
+        within find('.flatpickr-months .flatpickr-month .flatpickr-current-month', &block)
+      end
+
+      def within_flatpickr_time(&block)
+        within find('.flatpickr-time', &block)
+      end
+
+      def select_flatpickr_month(month)
+        find("select.flatpickr-monthDropdown-months > option:nth-child(#{month.to_i})").select_option
+      end
+
+      def fill_in_flatpickr_year(year)
+        find('input.cur-year').set(year)
+      end
+
+      def click_on_flatpickr_day(day)
+        within_flatpickr_days do
+          find('span', text: day).click
+        end
+      end
+
+      def within_flatpickr_days(&block)
+        within find('.flatpickr-innerContainer > .flatpickr-rContainer > .flatpickr-days', &block)
+      end
+
+      def select_flatpickr_hour(hour)
+        find('input.flatpickr-hour').set(hour)
+      end
+
+      def select_flatpickr_min(min)
+        find('input.flatpickr-minute').set(min)
+      end
+    end
+  end
+end

data/lib/harpiya/testing_support/i18n.rb

@@ -0,0 +1,94 @@
+# This file exists solely to test whether or not there are missing translations
+# within the code that Harpiya's test suite covers.
+#
+# If there is a translation referenced which has no corresponding key within the
+# .yml file, then there will be a message output at the end of the suite showing
+# that.
+#
+# If there is a translation within the locale file which *isn't* used in the
+# test, this will also be shown at the end of the suite run.
+module Harpiya
+  class << self
+    attr_accessor :used_translations, :missing_translation_messages,
+                  :unused_translations, :unused_translation_messages
+    alias normal_t t
+  end
+
+  def self.t(*args)
+    original_args = args.dup
+    options = args.extract_options!
+    self.used_translations ||= []
+    [*args.first].each do |translation_key|
+      key = ([*options[:scope]] << translation_key).join('.')
+      self.used_translations << key
+    end
+    normal_t(*original_args)
+  end
+
+  def self.check_missing_translations
+    self.missing_translation_messages = []
+    self.used_translations ||= []
+    used_translations.map { |a| a.split('.') }.each do |translation_keys|
+      root = translations
+      processed_keys = []
+      translation_keys.each do |key|
+        root = root.fetch(key.to_sym)
+        processed_keys << key.to_sym
+      rescue KeyError
+        error = "#{(processed_keys << key).join('.')} (#{I18n.locale})"
+        unless Harpiya.missing_translation_messages.include?(error)
+          Harpiya.missing_translation_messages << error
+        end
+      end
+    end
+  end
+
+  def self.check_unused_translations
+    self.used_translations ||= []
+    self.unused_translation_messages = []
+    self.unused_translations = []
+    load_translations(translations)
+    translation_diff = unused_translations - used_translations
+    translation_diff.each do |translation|
+      Harpiya.unused_translation_messages << "#{translation} (#{I18n.locale})"
+    end
+  end
+
+  private
+
+  def self.load_translations(hash, root = [])
+    hash.each do |k, v|
+      if v.is_a?(Hash)
+        load_translations(v, root.dup << k)
+      else
+        key = (root + [k]).join('.')
+        unused_translations << key
+      end
+    end
+  end
+
+  def self.translations
+    @translations ||= I18n.backend.send(:translations)[I18n.locale][:harpiya]
+  end
+end
+
+RSpec.configure do |config|
+  # Need to check here again because this is used in i18n_spec too.
+  if ENV['CHECK_TRANSLATIONS']
+    config.after :suite do
+      Harpiya.check_missing_translations
+      if Harpiya.missing_translation_messages.any?
+        puts "\nThere are missing translations within Harpiya:"
+        puts Harpiya.missing_translation_messages.sort
+        exit(1)
+      end
+
+      Harpiya.check_unused_translations
+      if Harpiya.unused_translation_messages.any?
+        puts "\nThere are unused translations within Harpiya:"
+        puts Harpiya.unused_translation_messages.sort
+        exit(1)
+      end
+    end
+  end
+end

data/lib/harpiya/testing_support/image_helpers.rb

@@ -0,0 +1,13 @@
+module Harpiya
+  module TestingSupport
+    module ImageHelpers
+      def create_image(attachable, file)
+        image = attachable.images.new
+        image.attachment.attach(io: file, filename: File.basename(file))
+        image.save!
+        file.rewind
+        image
+      end
+    end
+  end
+end

data/lib/harpiya/testing_support/kernel.rb

@@ -0,0 +1,17 @@
+module Harpiya
+  module TestingSupport
+    module Kernel
+      private
+
+      def silence_stream(stream)
+        old_stream = stream.dup
+        stream.reopen(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ ? 'NUL:' : '/dev/null')
+        stream.sync = true
+        yield
+      ensure
+        stream.reopen(old_stream)
+        old_stream.close
+      end
+    end
+  end
+end

data/lib/harpiya/testing_support/locale_helpers.rb

@@ -0,0 +1,78 @@
+module Harpiya
+  module TestingSupport
+    module LocaleHelpers
+      # rubocop:disable Layout/ArgumentAlignment
+      def add_french_locales
+        I18n.backend.store_translations(:fr,
+          harpiya: {
+            added_to_cart: 'Ajouté au panier avec succès!',
+            continue_shopping: 'Continuer vos achats',
+            choose_currency: 'Choisir la devise',
+            internationalization: 'Internationalisation',
+            i18n: {
+              language: 'Langue',
+              this_file_language: 'Français (FR)'
+            },
+            cart_page: {
+              header: 'Votre panier',
+              empty_info: 'Votre panier est vide',
+              add_promo_code: 'AJOUTER UN CODE PROMOTIONNEL',
+              checkout: 'Passer la commande',
+              product: 'articles',
+              quantity: 'quantité',
+              title: 'Panier',
+              change_quantity: 'Changer la quantité',
+              remove_from_cart: 'Retirer du panier'
+            },
+            shopping_cart: 'Panier',
+            cart: 'Panier',
+            close: 'Fermer',
+            search: 'Rechercher',
+            home: 'Accueil',
+            nav_bar: {
+              admin_panel: "Panneau d'administration",
+              close_menu: 'Fermer le menu',
+              go_to_previous_menu: 'Vers le menu précédent',
+              show_menu: 'Afficher le menu',
+              show_search: 'Afficher la recherche',
+              show_user_menu: 'Afficher le menu utilisateur',
+              change_country: 'Changer de pays',
+              desktop: 'Navigation sur le bureau',
+              mobile: 'Navigation mobile'
+            },
+            login: 'Connexion',
+            logout: 'Se déconnecter',
+            sign_up: 'Enregistrer',
+            email: 'Courriel',
+            password: 'Mot de passe',
+            remember_me: 'Se souvenir de moi',
+            my_account: 'Mon compte',
+            my_orders: 'Mes commandes',
+            logged_in_succesfully: 'Connexion réussie'
+          })
+      end
+      # rubocop:enable Layout/ArgumentAlignment
+
+      def open_i18n_menu
+        find('#header #internationalization-button-desktop').click
+        expect(page).to have_selector('#internationalization-options-desktop')
+      end
+
+      def close_i18n_menu
+        find('#header #internationalization-button-desktop').click
+        expect(page).not_to have_selector('#internationalization-options-desktop')
+      end
+
+      def switch_to_currency(currency)
+        open_i18n_menu
+        select currency, from: 'switch_to_currency'
+        expect(page).to have_no_css '.turbolinks-progress-bar'
+      end
+
+      def switch_to_locale(locale)
+        open_i18n_menu
+        select locale, from: 'Language'
+      end
+    end
+  end
+end

data/lib/harpiya/testing_support/next_instance_of.rb

@@ -0,0 +1,38 @@
+# Helper services with prepended ServiceModule
+# https://gitlab.com/gitlab-org/gitlab-foss/-/issues/33587
+#
+# ex:
+# expect_next_instance_of(service_class) do |instance|
+#   expect(instance).to receive(:call)
+# end
+
+module NextInstanceOf
+  def expect_next_instance_of(klass, *new_args)
+    stub_new(expect(klass), *new_args) do |expectation|
+      yield(expectation)
+    end
+  end
+
+  def allow_next_instance_of(klass, *new_args)
+    stub_new(allow(klass), *new_args) do |allowance|
+      yield(allowance)
+    end
+  end
+
+  private
+
+  def stub_new(target, *new_args)
+    receive_new = receive(:new)
+    receive_new.with(*new_args) if new_args.any?
+
+    target.to receive_new.and_wrap_original do |method, *original_args|
+      method.call(*original_args).tap do |instance|
+        yield(instance)
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include NextInstanceOf
+end

data/lib/harpiya/testing_support/order_walkthrough.rb

@@ -0,0 +1,78 @@
+class OrderWalkthrough
+  def self.up_to(state)
+    store = if Harpiya::Store.exists?
+              # Ensure the default store is used
+              Harpiya::Store.default || FactoryBot.create(:store, default: true)
+            else
+              # Create a default store
+              FactoryBot.create(:store, default: true)
+            end
+
+    # A payment method must exist for an order to proceed through the Address state
+    unless Harpiya::PaymentMethod.exists?
+      FactoryBot.create(:check_payment_method, stores: [store])
+    end
+
+    # Need to create a valid zone too...
+    zone = FactoryBot.create(:zone)
+    country = FactoryBot.create(:country)
+    zone.members << Harpiya::ZoneMember.create(zoneable: country)
+    country.states << FactoryBot.create(:state, country: country)
+
+    # A shipping method must exist for rates to be displayed on checkout page
+    unless Harpiya::ShippingMethod.exists?
+      FactoryBot.create(:shipping_method).tap do |sm|
+        sm.calculator.preferred_amount = 10
+        sm.calculator.preferred_currency = store.default_currency
+        sm.calculator.save
+      end
+    end
+
+    order = Harpiya::Order.create!(email: 'harpiya@example.com')
+    add_line_item!(order)
+    order.next!
+
+    end_state_position = states.index(state.to_sym)
+    states[0...end_state_position].each do |state|
+      send(state, order)
+    end
+
+    order
+  end
+
+  private
+
+  def self.add_line_item!(order)
+    FactoryBot.create(:line_item, order: order)
+    order.reload
+  end
+
+  def self.address(order)
+    order.bill_address = FactoryBot.create(:address, country_id: Harpiya::Zone.global.members.first.zoneable.id)
+    order.ship_address = FactoryBot.create(:address, country_id: Harpiya::Zone.global.members.first.zoneable.id)
+    order.next!
+  end
+
+  def self.delivery(order)
+    order.next!
+  end
+
+  def self.payment(order)
+    FactoryBot.create :payment,
+      order: order,
+      payment_method: Harpiya::PaymentMethod.first,
+      amount: order.total
+
+    # TODO: maybe look at some way of making this payment_state change automatic
+    order.payment_state = 'paid'
+    order.next!
+  end
+
+  def self.complete(_order)
+    # noop?
+  end
+
+  def self.states
+    [:address, :delivery, :payment, :complete]
+  end
+end