discourse/spec/lib/wizard/step_updater_spec.rb

# frozen_string_literal: true

describe Wizard::StepUpdater do
  before do
    SiteSetting.wizard_enabled = true
  end

  fab!(:user) { Fabricate(:admin) }
  let(:wizard) { Wizard::Builder.new(user).build }

  context "locale" do
    it "does not require refresh when the language stays the same" do
      locale = SiteSettings::DefaultsProvider::DEFAULT_LOCALE
      updater = wizard.create_updater('locale', default_locale: locale)
      updater.update
      expect(updater.refresh_required?).to eq(false)
      expect(wizard.completed_steps?('locale')).to eq(true)
    end

    it "updates the locale and requires refresh when it does change" do
      updater = wizard.create_updater('locale', default_locale: 'ru')
      updater.update
      expect(SiteSetting.default_locale).to eq('ru')
      expect(updater.refresh_required?).to eq(true)
      expect(wizard.completed_steps?('locale')).to eq(true)
    end
  end

  it "updates the forum title step" do
    updater = wizard.create_updater('forum_title', title: 'new forum title', site_description: 'neat place', short_site_description: 'best community')
    updater.update

    expect(updater.success?).to eq(true)
    expect(SiteSetting.title).to eq("new forum title")
    expect(SiteSetting.site_description).to eq("neat place")
    expect(SiteSetting.short_site_description).to eq("best community")
    expect(wizard.completed_steps?('forum-title')).to eq(true)
  end

  it "updates the introduction step" do
    topic = Fabricate(:topic, title: "Welcome to Discourse")
    welcome_post = Fabricate(:post, topic: topic, raw: "this will be the welcome topic post\n\ncool!")

    updater = wizard.create_updater('introduction', welcome: "Welcome to my new awesome forum!")
    updater.update

    expect(updater.success?).to eq(true)
    welcome_post.reload
    expect(welcome_post.raw).to eq("Welcome to my new awesome forum!\n\ncool!")

    expect(wizard.completed_steps?('introduction')).to eq(true)

  end

  it "won't allow updates to the default value, when required" do
    updater = wizard.create_updater('forum_title', title: SiteSetting.title, site_description: 'neat place')
    updater.update

    expect(updater.success?).to eq(false)
  end

  context "privacy settings" do
    it "updates to open correctly" do
      updater = wizard.create_updater('privacy', privacy: 'open', privacy_options: 'open')
      updater.update
      expect(updater.success?).to eq(true)
      expect(SiteSetting.login_required?).to eq(false)
      expect(SiteSetting.invite_only?).to eq(false)
      expect(wizard.completed_steps?('privacy')).to eq(true)
    end

    it "updates to private correctly" do
      updater = wizard.create_updater('privacy', privacy: 'restricted', privacy_options: 'invite_only')
      updater.update
      expect(updater.success?).to eq(true)
      expect(SiteSetting.login_required?).to eq(true)
      expect(SiteSetting.invite_only?).to eq(true)
      expect(wizard.completed_steps?('privacy')).to eq(true)
    end
  end

  context "contact step" do
    it "updates the fields correctly" do
      p = Fabricate(:post, raw: '<contact_email> template')
      SiteSetting.tos_topic_id = p.topic_id

      updater = wizard.create_updater('contact',
                                      contact_email: 'eviltrout@example.com',
                                      contact_url: 'http://example.com/custom-contact-url',
                                      site_contact: user.username)

      updater.update
      expect(updater).to be_success
      expect(SiteSetting.contact_email).to eq("eviltrout@example.com")
      expect(SiteSetting.contact_url).to eq("http://example.com/custom-contact-url")
      expect(SiteSetting.site_contact_username).to eq(user.username)

      # Should update the TOS topic
      raw = Post.where(topic_id: SiteSetting.tos_topic_id, post_number: 1).pluck_first(:raw)
      expect(raw).to eq("<eviltrout@example.com> template")

      # Can update the TOS topic again
      updater = wizard.create_updater('contact', contact_email: 'alice@example.com')
      updater.update
      raw = Post.where(topic_id: SiteSetting.tos_topic_id, post_number: 1).pluck_first(:raw)
      expect(raw).to eq("<alice@example.com> template")

      # Can update the TOS to nothing
      updater = wizard.create_updater('contact', {})
      updater.update
      raw = Post.where(topic_id: SiteSetting.tos_topic_id, post_number: 1).pluck_first(:raw)
      expect(raw).to eq("<contact_email> template")

      expect(wizard.completed_steps?('contact')).to eq(true)
    end

    it "doesn't update when there are errors" do
      updater = wizard.create_updater('contact',
                                      contact_email: 'not-an-email',
                                      site_contact_username: 'not-a-username')
      updater.update
      expect(updater).to_not be_success
      expect(updater.errors).to be_present
      expect(wizard.completed_steps?('contact')).to eq(false)
    end
  end

  context "corporate step" do

    it "updates the fields properly" do

      p = Fabricate(:post, raw: 'company_name - governing_law - city_for_disputes template')
      SiteSetting.tos_topic_id = p.topic_id

      updater = wizard.create_updater('corporate',
                                      company_name: 'ACME, Inc.',
                                      governing_law: 'New Jersey law',
                                      city_for_disputes: 'Fairfield, New Jersey')
      updater.update
      expect(updater).to be_success
      expect(SiteSetting.company_name).to eq("ACME, Inc.")
      expect(SiteSetting.governing_law).to eq("New Jersey law")
      expect(SiteSetting.city_for_disputes).to eq("Fairfield, New Jersey")

      # Should update the TOS topic
      raw = Post.where(topic_id: SiteSetting.tos_topic_id, post_number: 1).pluck_first(:raw)
      expect(raw).to eq("ACME, Inc. - New Jersey law - Fairfield, New Jersey template")

      # Can update the TOS topic again
      updater = wizard.create_updater('corporate',
                                      company_name: 'Pied Piper Inc',
                                      governing_law: 'California law',
                                      city_for_disputes: 'San Francisco, California')
      updater.update
      raw = Post.where(topic_id: SiteSetting.tos_topic_id, post_number: 1).pluck_first(:raw)
      expect(raw).to eq("Pied Piper Inc - California law - San Francisco, California template")

      # Can update the TOS to nothing
      updater = wizard.create_updater('corporate', {})
      updater.update
      raw = Post.where(topic_id: SiteSetting.tos_topic_id, post_number: 1).pluck_first(:raw)
      expect(raw).to eq("company_name - governing_law - city_for_disputes template")

      expect(wizard.completed_steps?('corporate')).to eq(true)
    end
  end

  context "styling step" do
    it "updates fonts" do
      updater = wizard.create_updater('styling',
        body_font: 'open_sans',
        heading_font: 'oswald',
        homepage_style: 'latest'
      )
      updater.update
      expect(updater.success?).to eq(true)
      expect(wizard.completed_steps?('styling')).to eq(true)
      expect(SiteSetting.base_font).to eq('open_sans')
      expect(SiteSetting.heading_font).to eq('oswald')
    end

    context "colors" do
      context "with an existing color scheme" do
        fab!(:color_scheme) { Fabricate(:color_scheme, name: 'existing', via_wizard: true) }

        it "updates the scheme" do
          updater = wizard.create_updater('styling',
            color_scheme: 'Dark',
            body_font: 'arial',
            heading_font: 'arial',
            homepage_style: 'latest'
          )
          updater.update
          expect(updater.success?).to eq(true)
          expect(wizard.completed_steps?('styling')).to eq(true)
          theme = Theme.find_by(id: SiteSetting.default_theme_id)
          expect(theme.color_scheme.base_scheme_id).to eq('Dark')
        end
      end

      context "with an existing default theme" do
        fab!(:theme) { Fabricate(:theme) }

        before do
          theme.set_default!
        end

        it "should update the color scheme of the default theme" do
          updater = wizard.create_updater('styling',
            color_scheme: 'Neutral',
            body_font: 'arial',
            heading_font: 'arial',
            homepage_style: 'latest'
          )
          expect { updater.update }.not_to change { Theme.count }
          theme.reload
          expect(theme.color_scheme.base_scheme_id).to eq('Neutral')
        end
      end

      context "without an existing theme" do
        before do
          Theme.delete_all
        end

        context 'dark theme' do
          it "creates the theme" do
            updater = wizard.create_updater('styling',
              color_scheme: 'Dark',
              body_font: 'arial',
              heading_font: 'arial',
              homepage_style: 'latest'
            )

            expect { updater.update }.to change { Theme.count }.by(1)

            theme = Theme.last

            expect(theme.user_id).to eq(wizard.user.id)
            expect(theme.color_scheme.base_scheme_id).to eq('Dark')
          end
        end

        context 'light theme' do
          it "creates the theme" do
            updater = wizard.create_updater('styling',
              color_scheme: ColorScheme::LIGHT_THEME_ID,
              body_font: 'arial',
              heading_font: 'arial',
              homepage_style: 'latest'
            )

            expect { updater.update }.to change { Theme.count }.by(1)

            theme = Theme.last

            expect(theme.user_id).to eq(wizard.user.id)

            expect(theme.color_scheme).to eq(ColorScheme.find_by(name:
              ColorScheme::LIGHT_THEME_ID
            ))
          end
        end
      end

      context "without an existing scheme" do
        it "creates the scheme" do
          ColorScheme.destroy_all
          updater = wizard.create_updater('styling',
            color_scheme: 'Dark',
            body_font: 'arial',
            heading_font: 'arial',
            homepage_style: 'latest'
          )
          updater.update
          expect(updater.success?).to eq(true)
          expect(wizard.completed_steps?('styling')).to eq(true)

          color_scheme = ColorScheme.where(via_wizard: true).first
          expect(color_scheme).to be_present
          expect(color_scheme.colors).to be_present

          theme = Theme.find_by(id: SiteSetting.default_theme_id)
          expect(theme.color_scheme_id).to eq(color_scheme.id)
        end
      end

      context "auto dark mode" do
        before do
          dark_scheme = ColorScheme.where(name: "Dark").first
          SiteSetting.default_dark_mode_color_scheme_id = dark_scheme.id
        end

        it "does nothing when selected scheme is light" do
          updater = wizard.create_updater('styling',
            color_scheme: 'Neutral',
            body_font: 'arial',
            heading_font: 'arial',
            homepage_style: 'latest'
          )

          expect { updater.update }.not_to change { SiteSetting.default_dark_mode_color_scheme_id }
        end

        it "unsets auto dark mode site setting when default selected scheme is also dark" do
          updater = wizard.create_updater('styling',
            color_scheme: 'Latte',
            body_font: 'arial',
            heading_font: 'arial',
            homepage_style: 'latest'
          )

          expect { updater.update }.to change { SiteSetting.default_dark_mode_color_scheme_id }.to(-1)
        end
      end

    end

    context "homepage style" do
      it "updates the fields correctly" do
        updater = wizard.create_updater('styling',
          body_font: 'arial',
          heading_font: 'arial',
          homepage_style: "categories_and_top_topics"
        )
        updater.update

        expect(updater).to be_success
        expect(wizard.completed_steps?('styling')).to eq(true)
        expect(SiteSetting.top_menu).to eq('categories|latest|new|unread|top')
        expect(SiteSetting.desktop_category_page_style).to eq('categories_and_top_topics')

        updater = wizard.create_updater('styling',
          body_font: 'arial',
          heading_font: 'arial',
          homepage_style: "latest"
        )
        updater.update
        expect(updater).to be_success
        expect(SiteSetting.top_menu).to eq('latest|new|unread|top|categories')
      end
    end

  end

  context "logos step" do
    it "updates the fields correctly" do
      upload = Fabricate(:upload)
      upload2 = Fabricate(:upload)

      updater = wizard.create_updater(
        'logos',
        logo: upload.url,
        logo_small: upload2.url
      )

      updater.update

      expect(updater).to be_success
      expect(wizard.completed_steps?('logos')).to eq(true)
      expect(SiteSetting.logo).to eq(upload)
      expect(SiteSetting.logo_small).to eq(upload2)
    end
  end

  context "icons step" do
    it "updates the fields correctly" do
      upload = Fabricate(:upload)
      upload2 = Fabricate(:upload)

      updater = wizard.create_updater('icons',
        favicon: upload.url,
        large_icon: upload2.url
      )

      updater.update

      expect(updater).to be_success
      expect(wizard.completed_steps?('icons')).to eq(true)
      expect(SiteSetting.favicon).to eq(upload)
      expect(SiteSetting.large_icon).to eq(upload2)
    end
  end

  context "invites step" do
    let(:invites) {
      return [{ email: 'regular@example.com', role: 'regular' },
              { email: 'moderator@example.com', role: 'moderator' }]
    }

    it "updates the fields correctly" do
      updater = wizard.create_updater('invites', invite_list: invites.to_json)
      updater.update

      expect(updater).to be_success
      expect(wizard.completed_steps?('invites')).to eq(true)

      reg_invite = Invite.where(email: 'regular@example.com').first
      expect(reg_invite).to be_present
      expect(reg_invite.moderator?).to eq(false)

      mod_invite = Invite.where(email: 'moderator@example.com').first
      expect(mod_invite).to be_present
      expect(mod_invite.moderator?).to eq(true)
    end
  end

end