pageflow 15.8.0 → 16.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1bbd00f3c57790e6bdeb0ffd65d56fa29eb3c239b31a1b92c11fed242f9423e
-  data.tar.gz: d9d44c5a5273ffd92086d3303bf5806347c16406083ff60ece793b6e09de7e71
+  metadata.gz: f961d4e469b058f29cbba131a2ab69068547a6215111a1e9dae04040b956ddcf
+  data.tar.gz: 91b70f55119f6c1b8f8b8f4d1b98555f9d58bf73160165d7e4d16f8026384d81
 SHA512:
-  metadata.gz: 96f45b7ee97ae6218a92b973b9265437dafc8709587f50035d1a8cfb733022d7dbdfd82a79e3545fa71f5e6d8f45347fcd207c897a2c0cf961c6441045a60381
-  data.tar.gz: 786c1620c4977004d401dcd85ee51868abfb5bb4ce6c48c0131ce4e79fa481e1f8880f05c2a3498bc782b409769eff81d6b7e6c45f496a56901a266b02a4bd59
+  metadata.gz: 82ac9717c4501f56715a6afc1a855ea9ce82f8cf1d3b6c3627ca8785960753a2967ba5114f5c348aa95608160c70b59edf338b9ea21d94fe1aee98cd7704adba
+  data.tar.gz: 0abd22f0d5bf02e29f6ac4b9fb6bc03732eec4a5e3cbd596aed79498f218e333a915bbbe1eee3b923bfe14ce213767f380c433c22180e5cb6294e38aa2694ab8

data/CHANGELOG.md

@@ -1,152 +1,55 @@
 # CHANGELOG
 
-### Version 15.8.0
+### Version 16.0.0
 
-2022-12-23
+2023-01-11
 
-[Compare changes](https://github.com/codevise/pageflow/compare/15-7-stable...v15.8.0)
+[Compare changes](https://github.com/codevise/pageflow/compare/15-x-stable...v16.0.0)
 
 #### Core
 
-##### Rails Engine
+##### Breaking Changes
 
-- Permalinks
-  ([#1883](https://github.com/codevise/pageflow/pull/1883))
-- Add user_changed hook
-  ([#1859](https://github.com/codevise/pageflow/pull/1859))
-- Allow adding id in data attribute when adding editor main menu item
-  ([#1837](https://github.com/codevise/pageflow/pull/1837))
+- The `Theming` model has been renamed to `Site`.
+  ([#1903](https://github.com/codevise/pageflow/pull/1903),
+   [#1914](https://github.com/codevise/pageflow/pull/1914))
 
-##### Admin
+  Related associations like `Entry#theming` or
+  `Account#default_theming` have been renamed to `Entry#site` and
+  `Account#default_site` accordingly.
 
-- Improve membership update
-  ([#1862](https://github.com/codevise/pageflow/pull/1862))
+- Entry templates and theme customizations now belong to sites instead
+  of accounts.
+  ([#1904](https://github.com/codevise/pageflow/pull/1904),
+   [#1915](https://github.com/codevise/pageflow/pull/1915))
 
-##### Editor
-
-- Improve file import controller
-  ([#1847](https://github.com/codevise/pageflow/pull/1847))
-
-##### Published Entry
-
-- Display opt-out vendors as accepted by default on privacy page
-  ([#1899](https://github.com/codevise/pageflow/pull/1899))
-
-##### JavaScript API
-
-- Pass alt text in media events
-  ([#1901](https://github.com/codevise/pageflow/pull/1901))
-- Provide more tracking data
-  ([#1885](https://github.com/codevise/pageflow/pull/1885))
+  Accounts can now contain multiple sites with their own set of
+  templates and customized theme.
 
 ##### Internal
 
-- Migrate to supported setup-ruby action
-  ([#1892](https://github.com/codevise/pageflow/pull/1892))
-
-
-#### Paged Entry Type
-
-##### Published Entry
-
-- Add feature flag to enforce usage of FullHD videos
-  ([#1879](https://github.com/codevise/pageflow/pull/1879))
-- Allow enforcing best video quality in Paged entries
-  ([#1863](https://github.com/codevise/pageflow/pull/1863))
-- Ensure scroller content is accessible via OS X Spoken Content
-  ([#1870](https://github.com/codevise/pageflow/pull/1870))
-
-##### Internal
-
-- Missing semicolon in themes/default/page.scss
-  ([#1898](https://github.com/codevise/pageflow/pull/1898))
+- Add reusable GitHub workflow to run RSpec tests
+  ([#1905](https://github.com/codevise/pageflow/pull/1905))
 
 #### Scrolled Entry Type
 
-##### Editor
-
-- Set correct lang attribute on html element in editor preview iframe
-  ([#1867](https://github.com/codevise/pageflow/pull/1867),
-   [#1872](https://github.com/codevise/pageflow/pull/1872))
-- Bug: Ensure link tooltip is readable in inverted sections
-  ([#1849](https://github.com/codevise/pageflow/pull/1849))
-
-##### Published Entry
-
-- Section and chapter inline links
-  ([#1886](https://github.com/codevise/pageflow/pull/1886))
-- Typography variants
-  ([#1842](https://github.com/codevise/pageflow/pull/1842),
-   [#1845](https://github.com/codevise/pageflow/pull/1845))
-- Improve backdrop hiding
-  ([#1882](https://github.com/codevise/pageflow/pull/1881),
-   [#1881](https://github.com/codevise/pageflow/pull/1882))
-- Backdrop effects
-  ([#1841](https://github.com/codevise/pageflow/pull/1841),
-   [#1846](https://github.com/codevise/pageflow/pull/1846))
-- Make border radius of cards appearance configurable
-  ([#1838](https://github.com/codevise/pageflow/pull/1838))
-- Allow using SVG images as backdrops and inline images
-  ([#1860](https://github.com/codevise/pageflow/pull/1860))
-- Improve scrolled favicons
-  ([#1858](https://github.com/codevise/pageflow/pull/1858))
-- Use public translations from pageflow-public-i18n in scrolled
-  ([#1853](https://github.com/codevise/pageflow/pull/1853))
-- Rewrite backdrop/motif area logic based on CSS as experimental feature
-  ([#1854](https://github.com/codevise/pageflow/pull/1854),
-   [#1855](https://github.com/codevise/pageflow/pull/1855),
-   [#1856](https://github.com/codevise/pageflow/pull/1856))
-- Bug: Prevent foreground shadow from overlaying next section
-  ([#1900](https://github.com/codevise/pageflow/pull/1900))
-- Bug: Ensure backdrop covers viewport in iOS in-app browers
-  ([#1884](https://github.com/codevise/pageflow/pull/1884))
-
-##### Content Elements
-
-- Disable automatic hyphenation in text block headings
-  ([#1875](https://github.com/codevise/pageflow/pull/1875))
-- Disable top padding for new headings
-  ([#1896](https://github.com/codevise/pageflow/pull/1896))
-- Remove space before heading in cards appearance
-  ([#1851](https://github.com/codevise/pageflow/pull/1851))
-- Text block line breaks
-  ([#1869](https://github.com/codevise/pageflow/pull/1869),
-   [#1871](https://github.com/codevise/pageflow/pull/1871))
-- Improve mobile block quote size
-  ([#1868](https://github.com/codevise/pageflow/pull/1868))
-- Preserve Tweet hide when unloading
-  ([#1864](https://github.com/codevise/pageflow/pull/1864))
-- Question content element
-  ([#1861](https://github.com/codevise/pageflow/pull/1861))
-- Improve video embed content element
-  ([#1848](https://github.com/codevise/pageflow/pull/1848),
-   [#1850](https://github.com/codevise/pageflow/pull/1850))
-
-##### Widgets
-
-- Fix info box position when all share providers are disabled
-  ([#1877](https://github.com/codevise/pageflow/pull/1877))
-- Add option to prevent collapsing default navigation on desktop
-  ([#1891](https://github.com/codevise/pageflow/pull/1891))
-- Options for scrolled default navigation
-  ([#1866](https://github.com/codevise/pageflow/pull/1866))
-
-##### Themes
-
-- Let themes define external link list variants
-  ([#1880](https://github.com/codevise/pageflow/pull/1880))
-- Text block theme properties
-  ([#1873](https://github.com/codevise/pageflow/pull/1873))
-- Add theme properties for cards colors
-  ([#1865](https://github.com/codevise/pageflow/pull/1865))
-- Pass consistent arguments when transforming theme options
-  ([#1844](https://github.com/codevise/pageflow/pull/1844))
+- Simplify borders in default navigation mobile chapter menu
+  ([#1913](https://github.com/codevise/pageflow/pull/1913))
+- Add theme property for chapter link separator color
+  ([#1912](https://github.com/codevise/pageflow/pull/1912))
+- Add widget slot to default navigation
+  ([#1911](https://github.com/codevise/pageflow/pull/1911))
+- Improve theme property for default navigation progress bar height
+  ([#1910](https://github.com/codevise/pageflow/pull/1910))
+- Add theme option to use smaller menu icon variant
+  ([#1909](https://github.com/codevise/pageflow/pull/1909))
+- Allow using custom icons for share options
+  ([#1907](https://github.com/codevise/pageflow/pull/1907))
 
-##### Internal
+[Compare changes](https://github.com/codevise/pageflow/compare/15-x-stable...master)
 
-- Also set Webpack public path for editor JS.
-  ([#1874](https://github.com/codevise/pageflow/pull/1874))
+None so far.
 
 See
-[15-7-stable branch](https://github.com/codevise/pageflow/blob/15-7-stable/CHANGELOG.md)
+[15-x-stable branch](https://github.com/codevise/pageflow/blob/15-x-stable/CHANGELOG.md)
 for previous changes.

data/admins/pageflow/accounts.rb

@@ -59,12 +59,11 @@ module Pageflow
 
     show :title => :name do |account|
       render 'account_details', :account => account
-      render 'theming_details', :account => account
 
-      tabs_view(Pageflow.config.admin_resource_tabs.find_by_resource(account.default_theming),
+      tabs_view(Pageflow.config.admin_resource_tabs.find_by_resource(account),
                 i18n: 'pageflow.admin.resource_tabs',
-                authorize: :see_theming_admin_tab,
-                build_args: [account.default_theming])
+                authorize: :see_account_admin_tab,
+                build_args: [account])
     end
 
     controller do
@@ -76,14 +75,14 @@ module Pageflow
 
       def new
         @account = Account.new
-        @account.build_default_theming
+        @account.build_default_site
       end
 
       def create
         account_params = permitted_params[:account] || {}
         @account = Account.new(account_params)
-        @account.build_default_theming(permitted_params.fetch(:account, {})[
-                                         :default_theming_attributes])
+        @account.build_default_site(permitted_params.fetch(:account, {})[
+                                         :default_site_attributes])
         super
       end
 
@@ -100,7 +99,7 @@ module Pageflow
       end
 
       def scoped_collection
-        super.includes(:default_theming)
+        super.includes(:default_site)
       end
 
       private
@@ -115,12 +114,12 @@ module Pageflow
         [
           :name,
           :default_file_rights,
-          default_theming_attributes: permitted_theming_attributes
+          default_site_attributes: permitted_site_attributes
         ] +
           permitted_attributes_for(:account)
       end
 
-      def permitted_theming_attributes
+      def permitted_site_attributes
         [
           :cname,
           :additional_cnames,
@@ -131,15 +130,12 @@ module Pageflow
           :privacy_link_url,
           :home_url
         ] +
-          permitted_attributes_for(:theming)
+          permitted_attributes_for(:site)
       end
 
       def permitted_attributes_for(resource_name)
-        if params[:id]
-          Pageflow.config_for(resource).admin_form_inputs.permitted_attributes_for(resource_name)
-        else
-          []
-        end
+        config = params[:id] ? Pageflow.config_for(resource) : Pageflow.config
+        config.admin_form_inputs.permitted_attributes_for(resource_name)
       end
 
       def permit_feature_states(attributes)

data/admins/pageflow/entry.rb

@@ -99,13 +99,13 @@ module Pageflow
                                   .order(:name)
                               end)
 
-    searchable_select_options(name: :eligible_themings,
-                              text_attribute: :name,
+    searchable_select_options(name: :eligible_sites,
+                              text_attribute: :name_with_account_prefix,
                               scope: lambda do |params|
-                                entry = Entry.find(params[:entry_id])
-                                ThemingPolicy::Scope
-                                  .new(current_user, Theming)
-                                  .themings_allowed_for(entry.account)
+                                account = Account.find(params[:account_id])
+                                SitePolicy::Scope
+                                  .new(current_user, Site)
+                                  .sites_allowed_for(account)
                               end,
                               filter: lambda do |term, scope|
                                 scope.ransack(account_name_cont: term).result
@@ -139,11 +139,13 @@ module Pageflow
       end
     end
 
-    collection_action :entry_type_name_input do
+    collection_action :entry_site_and_type_name_input do
       account = Pageflow::Account.find(params[:account_id])
       @entry = Pageflow::Entry.new(account: account,
                                    type_name: params[:entry_type_name])
 
+      apply_entry_defaults(@entry)
+
       if authorized?(:see_entry_types, account)
         render(layout: false)
       else
@@ -197,7 +199,7 @@ module Pageflow
       helper FoldersHelper
       helper EntriesHelper
       helper EmbedCodeHelper
-      helper ThemingsHelper
+      helper SitesHelper
       helper Admin::EntriesHelper
       helper Admin::FeaturesHelper
       helper Admin::FormHelper
@@ -206,6 +208,7 @@ module Pageflow
       helper Admin::RevisionsHelper
 
       helper_method :account_policy_scope
+      helper_method :site_policy_scope
 
       after_build do |entry|
         apply_entry_defaults(entry)
@@ -218,8 +221,8 @@ module Pageflow
       end
 
       before_update do |entry|
-        if entry.account_id_changed? && !authorized?(:update_theming_on, resource)
-          entry.theming = entry.account.default_theming
+        if entry.account_id_changed? && !authorized?(:update_site_on, resource)
+          entry.site = entry.account.default_site
         end
       end
 
@@ -232,7 +235,7 @@ module Pageflow
       def scoped_collection
         result =
           super
-          .includes(:theming,
+          .includes(:site,
                     {permalink: :directory},
                     :account,
                     {memberships: :user},
@@ -256,15 +259,15 @@ module Pageflow
 
       def apply_entry_defaults(entry)
         entry.account ||= account_policy_scope.entry_creatable.first || Account.first
-        entry.theming ||= entry.account.default_theming
+        entry.site ||= entry.account.default_site
       end
 
       def account_policy_scope
         AccountPolicy::Scope.new(current_user, Account)
       end
 
-      def theming_policy_scope
-        ThemingPolicy::Scope.new(current_user, Theming)
+      def site_policy_scope
+        SitePolicy::Scope.new(current_user, Site)
       end
 
       def permitted_attributes
@@ -286,10 +289,10 @@ module Pageflow
         if params[:id]
           accounts = resource.account
         else
-          accounts = account_policy_scope.themings_accessible
+          accounts = account_policy_scope.sites_accessible
         end
 
-        result += permitted_theming_attributes(accounts)
+        result += permitted_site_attributes(accounts)
 
         result
       end
@@ -301,26 +304,26 @@ module Pageflow
         end
       end
 
-      def permitted_theming_attributes(accounts)
-        if (create_or_new_action? || authorized?(:update_theming_on, resource)) &&
-           theming_params_present? && theming_in_allowed_themings_for?(accounts)
-          [:theming_id]
+      def permitted_site_attributes(accounts)
+        if (create_or_new_action? || authorized?(:update_site_on, resource)) &&
+           site_params_present? && site_in_allowed_sites_for?(accounts)
+          [:site_id]
         else
           []
         end
       end
 
-      def theming_params_present?
-        params[:entry] && params[:entry][:theming_id]
+      def site_params_present?
+        params[:entry] && params[:entry][:site_id]
       end
 
       def create_or_new_action?
         [:create, :new, :permalink_inputs].include?(action_name.to_sym)
       end
 
-      def theming_in_allowed_themings_for?(accounts)
-        theming_policy_scope.themings_allowed_for(accounts)
-          .include?(Theming.find(params[:entry][:theming_id]))
+      def site_in_allowed_sites_for?(accounts)
+        site_policy_scope.sites_allowed_for(accounts)
+          .include?(Site.find(params[:entry][:site_id]))
       end
 
       def permitted_account_attributes

data/admins/pageflow/entry_templates.rb

@@ -5,7 +5,7 @@ module Pageflow
     actions :index, :new, :create, :edit, :update
     form partial: 'form'
 
-    belongs_to :account, parent_class: Pageflow::Account
+    belongs_to :site, parent_class: Pageflow::Site
 
     breadcrumb do
       breadcrumb_links.first 3
@@ -20,9 +20,7 @@ module Pageflow
       end
 
       def new
-        account = Account.find(params[:account_id])
-        @entry_template = EntryTemplate.new(
-          account: account,
+        @entry_template = parent.entry_templates.build(
           entry_type_name: params[:entry_type_name]
         )
 
@@ -32,8 +30,8 @@ module Pageflow
       end
 
       def create
-        @entry_template = EntryTemplate.new(
-          entry_template_params.merge(account_id: permitted_params[:account_id])
+        @entry_template = parent.entry_templates.build(
+          entry_template_params
         )
         @page_title = page_title('new', @entry_template.entry_type_name)
         authorize!(:create, @entry_template)
@@ -87,7 +85,7 @@ module Pageflow
       end
 
       def redirect_path
-        admin_account_path(params[:account_id], tab: 'entry_templates')
+        admin_account_site_path(parent.account, parent, tab: 'entry_templates')
       end
 
       def entry_template_params

data/admins/pageflow/sites.rb

@@ -0,0 +1,50 @@
+module Pageflow
+  ActiveAdmin.register Site, as: 'Site' do
+    belongs_to :account
+
+    menu false
+    actions :index, :show, :new, :edit, :create, :update
+
+    show do
+      render 'attributes_table', site: site
+
+      tabs_view(Pageflow.config.admin_resource_tabs.find_by_resource(site),
+                i18n: 'pageflow.admin.resource_tabs',
+                authorize: :see_site_admin_tab,
+                build_args: [site])
+    end
+
+    form partial: 'form'
+
+    permit_params do
+      [
+        :name,
+        :cname,
+        :additional_cnames,
+        :imprint_link_url,
+        :imprint_link_label,
+        :copyright_link_url,
+        :copyright_link_label,
+        :privacy_link_url,
+        :home_url
+      ] + permitted_admin_form_input_params
+    end
+
+    controller do
+      helper Pageflow::Admin::FormHelper
+
+      def index
+        redirect_to admin_account_path(parent, tab: 'sites')
+      end
+
+      private
+
+      def permitted_admin_form_input_params
+        Pageflow
+          .config_for(parent)
+          .admin_form_inputs
+          .permitted_attributes_for(:site)
+      end
+    end
+  end
+end

data/app/assets/javascripts/pageflow/admin/entries.js

@@ -88,17 +88,26 @@ jQuery(function($) {
 
   $('.admin_entries form.pageflow_entry').each(function() {
     var accountSelect = $('#entry_account_id', this);
-    var themingSelect = $('#entry_theming_id', this);
+    var siteSelect = $('#entry_site_id', this);
     var titleInput = $('#entry_title', this);
 
-    function updateEntryTypeInput() {
+    function updateSiteAndEntryTypeInput() {
       var selectedAccountId = accountSelect.val();
 
-      $.get('/admin/entries/entry_type_name_input' +
+      $.get('/admin/entries/entry_site_and_type_name_input' +
             '?account_id=' + selectedAccountId +
             '&entry_type_name=' + $('[name="entry[type_name]"]').val())
        .done(function(response) {
-         $('#entry_type_name_input').replaceWith(response);
+         $('#entry_type_name_input').replaceWith($(response).filter('#entry_type_name_input'));
+         $('#entry_site_input').replaceWith($(response).filter('#entry_site_input'));
+
+         // Set up searchable select
+         $(document).trigger('page:load');
+
+         siteSelect = $('#entry_site_id');
+         siteSelect.on('change', updatePermalinkInput);
+
+         updatePermalinkInput();
        });
     }
 
@@ -119,15 +128,15 @@ jQuery(function($) {
     function fetchPermalinkInput(callback) {
       $.get('/admin/entries/permalink_inputs' +
             '?entry[account_id]=' + accountSelect.val() +
-                   (themingSelect.val() ? '&entry[theming_id]=' + themingSelect.val() : '') +
+                   (siteSelect.val() ? '&entry[site_id]=' + siteSelect.val() : '') +
             '&entry[title]=' + encodeURIComponent(titleInput.val()))
        .done(callback);
     }
 
-    accountSelect.on('change', updateEntryTypeInput);
+    accountSelect.on('change', updateSiteAndEntryTypeInput);
 
     accountSelect.on('change', updatePermalinkInput);
-    themingSelect.on('change', updatePermalinkInput);
+    siteSelect.on('change', updatePermalinkInput);
 
     titleInput.on('change keyup', debounce(updateSlugPlaceholder, 300));
   });

data/app/controllers/pageflow/entries_controller.rb

@@ -6,9 +6,9 @@ module Pageflow
     include EntryPasswordProtection
 
     def index
-      theming = Theming.for_request(request).with_home_url.first!
+      site = Site.for_request(request).with_home_url.first!
 
-      redirect_to(theming.home_url)
+      redirect_to(site.home_url)
     end
 
     def show

data/app/helpers/pageflow/admin/permalinks_helper.rb

@@ -2,9 +2,9 @@ module Pageflow
   module Admin
     # @api private
     module PermalinksHelper
-      def collection_for_permalink_directories(theming, permalink)
+      def collection_for_permalink_directories(site, permalink)
         options_from_collection_for_select(
-          theming.permalink_directories,
+          site.permalink_directories,
           'id',
           'path',
           permalink.directory_id

data/app/helpers/pageflow/common_entry_seed_helper.rb

@@ -10,7 +10,7 @@ module Pageflow
       config = Pageflow.config_for(entry)
 
       json.locale entry.locale
-      json.theming entry.theming.as_json(only: [:privacy_link_url])
+      json.site entry.site.as_json(only: [:privacy_link_url])
       json.enabled_feature_names entry.enabled_feature_names
       json.page_types PageTypesSeed.new(config).as_json
 

data/app/helpers/pageflow/embed_code_helper.rb

@@ -24,7 +24,7 @@ module Pageflow
 
       def entry_embed_url_options(entry)
         options = Pageflow.config.entry_embed_url_options
-        options = options.call(entry.theming) if options.respond_to?(:call)
+        options = options.call(entry.site) if options.respond_to?(:call)
         options
       end
     end