Add breadcrumb metadata to pages

1 files changed, 182 insertions, 5 deletions

diff --git a/spec/lib/helpers/generic_spec.rb b/spec/lib/helpers/generic_spec.rb
index 0ed21853..6fa9d4fb 100644
--- a/spec/lib/helpers/generic_spec.rb
+++ b/spec/lib/helpers/generic_spec.rb
@@ -12,11 +12,17 @@ RSpec.describe Nanoc::Helpers::Generic do
     item.new(path)
   end
 
-  subject { mock_class.docs_section(mock_item.path.to_s) }
-
   describe '#docs_section' do
     using RSpec::Parameterized::TableSyntax
 
+    subject { mock_class.docs_section(mock_item.path.to_s) }
+
+    before do
+      mock_items = { '/_data/navigation.yaml' => YAML.load_file('spec/lib/fixtures/navigation-mock.yaml', symbolize_names: true) }
+      mock_sections = mock_items['/_data/navigation.yaml'][:sections]
+      allow(mock_class).to receive(:get_nav_sections).and_return(mock_sections)
+    end
+
     where(:path, :expected_section_title) do
       "/ee/tutorials/" | "Learn GitLab with tutorials"
       "/ee/topics/set_up_organization.html" | "Use GitLab"
@@ -25,15 +31,186 @@ RSpec.describe Nanoc::Helpers::Generic do
       "/updog.html" | nil
     end
 
+    with_them do
+      it "returns the section title for the given path" do
+        expect(subject).to eq(expected_section_title)
+      end
+    end
+  end
+
+  describe '#build_breadcrumb_list' do
     before do
       mock_items = { '/_data/navigation.yaml' => YAML.load_file('spec/lib/fixtures/navigation-mock.yaml', symbolize_names: true) }
       mock_sections = mock_items['/_data/navigation.yaml'][:sections]
       allow(mock_class).to receive(:get_nav_sections).and_return(mock_sections)
     end
 
-    with_them do
-      it "returns the section title for the given path" do
-        expect(subject).to eq(expected_section_title)
+    # Test all six levels of the menu
+    let(:test_data) do
+      [
+        {
+          path: '/ee/user/',
+          expected_items: [
+            {
+              '@type': "ListItem",
+              position: 1,
+              name: "Use GitLab"
+            }
+          ]
+        },
+        {
+          path: '/ee/topics/set_up_organization.html',
+          expected_items: [
+            {
+              '@type': "ListItem",
+              position: 1,
+              name: "Use GitLab",
+              item: "https://docs.gitlab.com/ee/user/"
+            },
+            {
+              '@type': "ListItem",
+              position: 2,
+              name: "Set up your organization"
+            }
+          ]
+        },
+        {
+          path: '/ee/user/namespace/',
+          expected_items: [
+            {
+              '@type': "ListItem",
+              position: 1,
+              name: "Use GitLab",
+              item: "https://docs.gitlab.com/ee/user/"
+            },
+            {
+              '@type': "ListItem",
+              position: 2,
+              name: "Set up your organization",
+              item: "https://docs.gitlab.com/ee/topics/set_up_organization.html"
+            },
+            {
+              '@type': "ListItem",
+              position: 3,
+              name: "Namespaces"
+            }
+          ]
+        },
+        {
+          path: '/ee/user/group/manage.html',
+          expected_items: [
+            {
+              '@type': "ListItem",
+              position: 1,
+              name: "Use GitLab",
+              item: "https://docs.gitlab.com/ee/user/"
+            },
+            {
+              '@type': "ListItem",
+              position: 2,
+              name: "Set up your organization",
+              item: "https://docs.gitlab.com/ee/topics/set_up_organization.html"
+            },
+            {
+              '@type': "ListItem",
+              position: 3,
+              name: "Groups",
+              item: "https://docs.gitlab.com/ee/user/group/"
+            },
+            {
+              '@type': "ListItem",
+              position: 4,
+              name: "Manage groups"
+            }
+          ]
+        },
+        {
+          path: '/ee/user/group/saml_sso/scim_setup.html',
+          expected_items: [
+            {
+              '@type': "ListItem",
+              position: 1,
+              name: "Use GitLab",
+              item: "https://docs.gitlab.com/ee/user/"
+            },
+            {
+              '@type': "ListItem",
+              position: 2,
+              name: "Set up your organization",
+              item: "https://docs.gitlab.com/ee/topics/set_up_organization.html"
+            },
+            {
+              '@type': "ListItem",
+              position: 3,
+              name: "Groups",
+              item: "https://docs.gitlab.com/ee/user/group/"
+            },
+            {
+              '@type': "ListItem",
+              position: 4,
+              name: "SAML SSO for GitLab.com groups",
+              item: "https://docs.gitlab.com/ee/user/group/saml_sso/"
+            },
+            {
+              '@type': "ListItem",
+              position: 5,
+              name: "Configure SCIM"
+            }
+          ]
+        },
+        {
+          path: '/ee/topics/autodevops/cicd_variables.html',
+          expected_items: [
+            {
+              '@type': "ListItem",
+              position: 1,
+              name: "Use GitLab",
+              item: "https://docs.gitlab.com/ee/user/"
+            },
+            {
+              '@type': "ListItem",
+              position: 2,
+              name: "Build your application",
+              item: "https://docs.gitlab.com/ee/topics/build_your_application.html"
+            },
+            {
+              '@type': "ListItem",
+              position: 3,
+              name: "CI/CD",
+              item: "https://docs.gitlab.com/ee/ci/"
+            },
+            {
+              '@type': "ListItem",
+              position: 4,
+              name: "Auto DevOps",
+              item: "https://docs.gitlab.com/ee/topics/autodevops/"
+            },
+            {
+              '@type': "ListItem",
+              position: 5,
+              name: "Customize",
+              item: "https://docs.gitlab.com/ee/topics/autodevops/customize.html"
+            },
+            {
+              '@type': "ListItem",
+              position: 6,
+              name: "CI/CD variables"
+            }
+          ]
+        }
+      ]
+    end
+
+    it 'returns an array of menu items in schema.org breadcrumblist format' do
+      test_data.each do |data|
+        expected_items = data[:expected_items]
+        expected_json = {
+          '@context': "https://schema.org",
+          '@type': "BreadcrumbList",
+          itemListElement: expected_items
+        }
+        param_value = data[:path]
+        expect(mock_class.build_breadcrumb_list(param_value)).to eq(expected_json)
       end
     end
   end