Merge pull request #2117 from tf/cutoff-entry-state

Add hook to access cutoff state

entry_types/scrolled/app/views/pageflow_scrolled/entry_json_seed/_entry.json.jbuilder

@@ -46,6 +46,8 @@ json.config do
   json.file_licenses(
     I18n.t('pageflow.file_licenses', default: {}).slice(*entry_config.available_file_licenses)
   )
+
+  json.cut_off entry.cutoff_mode_enabled_for?(request)
 end
 
 unless options[:skip_i18n]

entry_types/scrolled/package/spec/entryState/cutoff-spec.js

@@ -0,0 +1,17 @@
+import {useCutOff} from 'entryState';
+
+import {renderHookInEntry} from 'support';
+
+describe('useCutOff', () => {
+  it('reads data from config', () => {
+    const {result} = renderHookInEntry(
+      () => useCutOff(), {
+        seed: {
+          cutOff: true
+        }
+      }
+    );
+
+    expect(result.current).toEqual(true);
+  });
+});

entry_types/scrolled/package/src/entryState/cutoff.js

@@ -0,0 +1,6 @@
+import {useEntryStateConfig} from "./EntryStateProvider";
+
+export function useCutOff() {
+  const config = useEntryStateConfig();
+  return config.cutOff;
+}

entry_types/scrolled/package/src/entryState/index.js

@@ -1,5 +1,6 @@
 export {useAdditionalSeedData} from './additionalSeedData';
 export {useContentElementConsentVendor} from './consentVendors';
+export {useCutOff} from './cutoff';
 export {useShareProviders, useShareUrl} from './sharing';
 export {useEntryTranslations} from './entryTranslations';
 export {useEntryMetadata} from './metadata';

entry_types/scrolled/package/src/frontend/index.js

@@ -63,6 +63,7 @@ export {
   useAdditionalSeedData,
   useChapters,
   useCredits,
+  useCutOff,
   useEntryMetadata,
   useEntryStateDispatch,
   useEntryTranslations,

entry_types/scrolled/package/src/testHelpers/normalizeSeed.js

@@ -46,6 +46,7 @@ export function normalizeSeed({
   additionalSeedData,
   consentVendors,
   contentElementConsentVendors,
+  cutOff,
   fileLicenses,
   entryTranslations
 } = {}) {
@@ -90,6 +91,7 @@ export function normalizeSeed({
       },
       consentVendors: consentVendors || [],
       contentElementConsentVendors: contentElementConsentVendors || {},
+      cutOff,
       fileLicenses: fileLicenses || {},
       entryTranslations: entryTranslations || []
     },

entry_types/scrolled/spec/helpers/pageflow_scrolled/entry_json_seed_helper_spec.rb

@@ -1127,6 +1127,67 @@ def render(helper, entry, options = {})
                                          })
         end
       end
+
+      context 'cutoff' do
+        it 'renders false by default' do
+          entry = create(:published_entry,
+                         type_name: 'scrolled')
+
+          result = render(helper, entry)
+
+          expect(result).to include_json(config: {cutOff: false})
+        end
+
+        it 'renders cutoff mode result' do
+          pageflow_configure do |config|
+            config.cutoff_modes.register(
+              :test,
+              proc { true }
+            )
+          end
+
+          site = create(:site, cutoff_mode_name: 'test')
+          entry = create(:published_entry,
+                         site:,
+                         type_name: 'scrolled',
+                         revision_attributes: {
+                           configuration: {
+                             cutoff_section_perma_id: 100
+                           }
+                         })
+          chapter = create(:scrolled_chapter, position: 2, revision: entry.revision)
+          create(:section, chapter:, position: 2, perma_id: 100)
+
+          result = render(helper, entry)
+
+          expect(result).to include_json(config: {cutOff: true})
+        end
+
+        it 'renders false for draft entry' do
+          pageflow_configure do |config|
+            config.cutoff_modes.register(
+              :test,
+              proc { true }
+            )
+          end
+
+          site = create(:site, cutoff_mode_name: 'test')
+          entry = create(:draft_entry,
+                         site:,
+                         type_name: 'scrolled',
+                         revision_attributes: {
+                           configuration: {
+                             cutoff_section_perma_id: 100
+                           }
+                         })
+          chapter = create(:scrolled_chapter, position: 2, revision: entry.revision)
+          create(:section, chapter:, position: 2, perma_id: 100)
+
+          result = render(helper, entry)
+
+          expect(result).to include_json(config: {cutOff: false})
+        end
+      end
     end
 
     describe '#scrolled_entry_json_seed_script_tag' do