pageflow 15.1.2 → 15.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e36aad3da1e0af8d6a54b98c01e7af7d09712f38
-  data.tar.gz: b1553c60fd5fc7b617f06f831020f16eb9522c97
+  metadata.gz: 0f634bdc5700407153c1e555eb991eac53f2572d
+  data.tar.gz: 47766062e1a5fedffcce3c969fae1fa52ba10ed3
 SHA512:
-  metadata.gz: a00637112da27485532da857f43aaa9664aa0f7c533492fbd10cf7da92912cfd091282f873dab6d577f6fc5d4b4d7cdd6f25a798775a908f837fdcc96f9044d7
-  data.tar.gz: b4cdb7118d5d89ebb3b2e1f228475a1ba17ce4249619059f2995f3aa3738558939f1071b53c2325ce7234212c62712cd1469bde28519408721cadcf0623f393b
+  metadata.gz: 8a87e52617931eeff9d0bce5bf8b09ef2673e4543173d9cd00edd88d2e2fab165222a6216785560fb099635e2a8fc7e7df9f1c69d3c8c79d94cde602aedcf5a2
+  data.tar.gz: ebcb2edecf5aca9a2dbbd2037a4e07120cdf3fcc3c578de36ba5a19d08507298a493e3ef15b21714829061dd0a43d777e4d882a2303a3beed8f0942506e2adf5

data/CHANGELOG.md

@@ -1,218 +1,110 @@
 # CHANGELOG
 
-### Version 15.1.2
+### Version 15.2.0
 
 2020-04-01
 
-[Compare changes](https://github.com/codevise/pageflow/compare/v15.1.1...v15.1.2)
-
-- Bug fix: Make multimedia alert and new pages box display again for
-  new paged entries
-  ([#1368](https://github.com/codevise/pageflow/pull/1368))
-
-### Version 15.1.1
-
-2020-02-12
-
-[Compare changes](https://github.com/codevise/pageflow/compare/v15.1.0...v15.1.1)
-
-- Re-add entry.configuration in editor for backwards compatibility
-  ([#1332](https://github.com/codevise/pageflow/pull/1332))
-
-### Version 15.1.0
-
-2020-02-05
-
-[Compare changes](https://github.com/codevise/pageflow/compare/15-0-stable...v15.1.0)
-
-See
-[changes grouped by pre releases](https://github.com/codevise/pageflow/blob/v15.1.0.rc0/CHANGELOG.md).
+[Compare changes](https://github.com/codevise/pageflow/compare/15-1-stable...v15.2.0)
 
 #### Core
 
-##### Host Application
-
-- Updated Active Admin to 2.5.0
-  ([#1280](https://github.com/codevise/pageflow/pull/1280))
-
-  Starting with Active Admin 2.0, using `unshift` (or any other
-  mutating method) to add load paths no longer work reliably (see
-  [activeadmin/activeadmin#5995](https://github.com/activeadmin/activeadmin/issues/5995).
-  Apply the following change to your host application's
-  `active_admin.rb` initializer:
-
-  ```diff
-  - ActiveAdmin.application.unshift(Pageflow.active_admin_load_path)
-  + ActiveAdmin.application.load_paths += [Pageflow.active_admin_load_path]
-  ```
-
-- Improve support for Webpack setup in host appplication
-  ([#1276](https://github.com/codevise/pageflow/pull/1276),
-   [#1279](https://github.com/codevise/pageflow/pull/1279))
+##### Editor
 
-##### Admin
+- Bug fix: Re-add entry.configuration in editor for backwards compatibility
+  ([#1331](https://github.com/codevise/pageflow/pull/1331))
+- Bug fix: Fix help link in editor page type drop down
+  ([#1372](https://github.com/codevise/pageflow/pull/1372))
 
-- Improve add member button
-  ([#1195](https://github.com/codevise/pageflow/pull/1195))
+##### Documentation
 
-##### Editor
-
-- Bug fix: Prevent including pageflow/ui in pageflow/editor
-  ([#1309](https://github.com/codevise/pageflow/pull/1309))
-
-##### Engine Config
-
-- Add entry type concept
-  ([#1249](https://github.com/codevise/pageflow/pull/1249))
-- Render entry type specific editor seed data
-  ([#1265](https://github.com/codevise/pageflow/pull/1265))
-- Entry type specific editor views
-  ([#1262](https://github.com/codevise/pageflow/pull/1262))
-- Entry type specific editor assets
-  ([#1257](https://github.com/codevise/pageflow/pull/1257))
-- Let entry types provide frontend apps to render entries
-  ([#1254](https://github.com/codevise/pageflow/pull/1254),
-   [#1255](https://github.com/codevise/pageflow/pull/1255))
-- Extend config DSL for entry types
-  ([#1267](https://github.com/codevise/pageflow/pull/1267))
-- Allow scoping file types and widget types by entry types
-  ([#1283](https://github.com/codevise/pageflow/pull/1283))
-- Decouple revision components and file types from page types
-  ([#1256](https://github.com/codevise/pageflow/pull/1256),
-   [#1259](https://github.com/codevise/pageflow/pull/1259))
-- Consider feature flags for file types available in editor
-  ([#1275](https://github.com/codevise/pageflow/pull/1275))
-- Extract part of appearance options into paged entry type
-  ([#1304](https://github.com/codevise/pageflow/pull/1304),
-   [#1321](https://github.com/codevise/pageflow/pull/1321))
-- Scope existing built ins to paged entry type
-  ([#1296](https://github.com/codevise/pageflow/pull/1296))
-- Integrate entry type specific config with feature flags
-  ([#1295](https://github.com/codevise/pageflow/pull/1295))
-- Decouple editor layout
-  ([#1284](https://github.com/codevise/pageflow/pull/1284))
-- Let entry types define editor controllers
-  ([#1271](https://github.com/codevise/pageflow/pull/1271))
-- Add authentication provider
-  ([#1236](https://github.com/codevise/pageflow/pull/1236))
-- Bug fix: Change revision#locale to always return string
-  ([#1239](https://github.com/codevise/pageflow/pull/1239))
-
-##### File Importers
-
-- Introduce file importer API
-  ([#1250](https://github.com/codevise/pageflow/pull/1250),
-   [#1266](https://github.com/codevise/pageflow/pull/1266),
-   [#1258](https://github.com/codevise/pageflow/pull/1258),
-   [#1269](https://github.com/codevise/pageflow/pull/1269),
-   [#1323](https://github.com/codevise/pageflow/pull/1323))
+- Remind developers to configure their editor with ESLint before starting to contribute
+  ([#1369](https://github.com/codevise/pageflow/pull/1369))
+- Move troubleshooting to docs
+  ([#1327](https://github.com/codevise/pageflow/pull/1327))
 
 ##### Internal
 
-- Add configuration to revisions
-  ([#1306](https://github.com/codevise/pageflow/pull/1306))
-- Add entry type engines
-  ([#1247](https://github.com/codevise/pageflow/pull/1247))
-- Migrate legacy JavaScript to Rollup/Jest
-  ([#1241](https://github.com/codevise/pageflow/pull/1241))
-- Update pageflow-react build stack
-  ([#1240](https://github.com/codevise/pageflow/pull/1240))
-- Modernize editor JavaScript build stack
-  ([#1238](https://github.com/codevise/pageflow/pull/1238))
-- Replace chromedriver-helper by webdrivers
-  ([#1251](https://github.com/codevise/pageflow/pull/1251))
+- Extract entry template from theming
+  ([#1315](https://github.com/codevise/pageflow/pull/1315))
+- Use Ruby 2.6.5 in Travis
+  ([#1334](https://github.com/codevise/pageflow/pull/1334))
+- Remove pageflow-react from yarn workspace list
+  ([#1329](https://github.com/codevise/pageflow/pull/1329))
 
 #### Paged Entry Type
 
-##### Editor
-
-- Bug fix: Fix page selection view
-  ([#1281](https://github.com/codevise/pageflow/pull/1281))
-
 ##### Published Entry
 
-- Add width/height to social share images to make Facebook display
-  them faster.
-  ([#1223](https://github.com/codevise/pageflow/pull/1223))
-- Add translations for some text track languages
-  ([#1237](https://github.com/codevise/pageflow/pull/1237))
-- Add meta charset tag in application layout of paged entries
-  ([#1322](https://github.com/codevise/pageflow/pull/1322))
-- Bug fix: Invalidate page partial cache on locale change
-  ([#1311](https://github.com/codevise/pageflow/pull/1311))
-- Bug fix: Do not prefix partial paths with pageflow_paged
-  ([#1320](https://github.com/codevise/pageflow/pull/1320))
-- Bug fix: Fix `link_to home_button` raises URLGenerationError
-  ([#1310](https://github.com/codevise/pageflow/pull/1310))
+- Allow hiding the logo on page level
+  ([#1356](https://github.com/codevise/pageflow/pull/1356))
+- Bug fix: Make multimedia alert and new pages box display again for
+  new entries
+  ([#1366](https://github.com/codevise/pageflow/pull/1366))
 
-##### Internal
+#### Scrolled Entry Type
 
-- Move PagedEntriesController to paged entry type engine
-  ([#1285](https://github.com/codevise/pageflow/pull/1285))
-- Move editor actions into editor controller
-  ([#1282](https://github.com/codevise/pageflow/pull/1282))
+##### Content Elements
 
-#### Scrolled Entry Type
+- Add before/after content element
+  ([#1351](https://github.com/codevise/pageflow/pull/1351))
+- dataWrapperChart content element
+  ([#1349](https://github.com/codevise/pageflow/pull/1349),
+   [#1355](https://github.com/codevise/pageflow/pull/1355))
+- External link content element
+  ([#1346](https://github.com/codevise/pageflow/pull/1346))
+- Add videoEmbed content element
+  ([#1336](https://github.com/codevise/pageflow/pull/1336))
 
-##### Published Entry
+##### Widgets
 
-- Import scrolled entry type React app
-  ([#1264](https://github.com/codevise/pageflow/pull/1264))
-- Use seed data in scrolled entries
-  ([#1248](https://github.com/codevise/pageflow/pull/1248),
-   [#1270](https://github.com/codevise/pageflow/pull/1270),
-   [#1278](https://github.com/codevise/pageflow/pull/1278),
-   [#1286](https://github.com/codevise/pageflow/pull/1286),
-   [#1314](https://github.com/codevise/pageflow/pull/1314),
-   [#1242](https://github.com/codevise/pageflow/pull/1242))
-- Fix section index and references to adjacent chapters
-  ([#1316](https://github.com/codevise/pageflow/pull/1316))
-- Render uploaded images in scrolled entries
-  ([#1299](https://github.com/codevise/pageflow/pull/1299),
-   [#1303](https://github.com/codevise/pageflow/pull/1303))
-- Use chapters from db in navigaition bar
-  ([#1298](https://github.com/codevise/pageflow/pull/1298),
-   [#1300](https://github.com/codevise/pageflow/pull/1300),
-   [#1308](https://github.com/codevise/pageflow/pull/1308))
-- Sharing, imprint, privacy in navigation
-  ([#1319](https://github.com/codevise/pageflow/pull/1319))
+- Improve navigation
+  ([#1347](https://github.com/codevise/pageflow/pull/1347))
 
 ##### Editor
 
-- Render demo in editor
-  ([#1268](https://github.com/codevise/pageflow/pull/1268))
-- Use data from Backbone collections in scrolled editor preview
-  ([#1288](https://github.com/codevise/pageflow/pull/1288),
-   [#1293](https://github.com/codevise/pageflow/pull/1293),
-   [#1292](https://github.com/codevise/pageflow/pull/1292),
-   [#1294](https://github.com/codevise/pageflow/pull/1294),
-   [#1305](https://github.com/codevise/pageflow/pull/1305))
-- Outline editing for scrolled entries
-  ([#1318](https://github.com/codevise/pageflow/pull/1318))
+- Adding content elements
+  ([#1337](https://github.com/codevise/pageflow/pull/1337))
+- Edit content elements in the editor
+  ([#1335](https://github.com/codevise/pageflow/pull/1335))
+- Add inline help texts for scrolled editor
+  ([#1353](https://github.com/codevise/pageflow/pull/1353))
+- Add section editing options in editor sidebar
+  ([#1363](https://github.com/codevise/pageflow/pull/1363))
+
+##### JavaScript API
+
+- Export useFile hook from scrolled frontend
+  ([#1371](https://github.com/codevise/pageflow/pull/1371))
+- Fix useFileRights hook
+  ([#1357](https://github.com/codevise/pageflow/pull/1357))
+- I18n for scrolled frontend
+  ([#1342](https://github.com/codevise/pageflow/pull/1342))
+- Content element frontend api
+  ([#1324](https://github.com/codevise/pageflow/pull/1324))
+- Enable registering content elements with default config
+  ([#1354](https://github.com/codevise/pageflow/pull/1354),
+   [#1360](https://github.com/codevise/pageflow/pull/1360))
+- Introduce configuration editor groups in scrolled editor
+  ([#1352](https://github.com/codevise/pageflow/pull/1352),
+   [#1365](https://github.com/codevise/pageflow/pull/1365))
+- Improve guides
+  ([#1362](https://github.com/codevise/pageflow/pull/1362),
+   [#1348](https://github.com/codevise/pageflow/pull/1348),
+   [#1344](https://github.com/codevise/pageflow/pull/1344))
 
 ##### Internal
 
-- Pass scrolled entry to watchCollections in tests
-  ([#1317](https://github.com/codevise/pageflow/pull/1317))
-- Setup Capybara for scrolled engine
-  ([#1289](https://github.com/codevise/pageflow/pull/1289))
-- Set PAGEFLOW_EDITOR global in scrolled editor
-  ([#1287](https://github.com/codevise/pageflow/pull/1287))
-
-#### Development Setup
-
-- DB seed data for scrolled entries
-  ([#1274](https://github.com/codevise/pageflow/pull/1274),
-   [#1302](https://github.com/codevise/pageflow/pull/1302))
-- Split Travis run into multiple jobs
-  ([#1261](https://github.com/codevise/pageflow/pull/1261))
-- Generate JSDoc and SassDoc in GitHub workflow
-  ([#1307](https://github.com/codevise/pageflow/pull/1307))
-- Add needed command to node package development docs
-  ([#1290](https://github.com/codevise/pageflow/pull/1290))
-- Improve Capybara Chrome setup
-  ([#1291](https://github.com/codevise/pageflow/pull/1291))
+- Make package imports external by default in Rollup config
+  ([#1341](https://github.com/codevise/pageflow/pull/1341))
+- Make pageflow-scrolled Capybara specs less flaky
+  ([#1339](https://github.com/codevise/pageflow/pull/1339))
+- Prevent Percy from reporting different video loading progress
+  ([#1343](https://github.com/codevise/pageflow/pull/1343))
+- Enable React devtools in editor iframe
+  ([#1338](https://github.com/codevise/pageflow/pull/1338))
+- Setup Storybook for content element development
+  ([#1326](https://github.com/codevise/pageflow/pull/1326))
 
 See
-[15-0-stable branch](https://github.com/codevise/pageflow/blob/15-0-stable/CHANGELOG.md)
+[15-1-stable branch](https://github.com/codevise/pageflow/blob/15-1-stable/CHANGELOG.md)
 for previous changes.

data/README.md

@@ -168,8 +168,7 @@ is only available for admins.
 
 ## Troubleshooting
 
-If you run into problems during the installation of Pageflow, please refer to the [Troubleshooting](https://github.com/codevise/pageflow/wiki/Troubleshooting) wiki
-page. If that doesn't help, consider [filing an issue](https://github.com/codevise/pageflow/issues?state=open).
+If you run into problems during the installation of Pageflow, please refer to the [Troubleshooting](doc/troubleshooting.md) docs. If that doesn't help, consider [filing an issue](https://github.com/codevise/pageflow/issues?state=open).
 
 ## Security Policy
 

data/admins/pageflow/accounts.rb

@@ -31,7 +31,7 @@ module Pageflow
         end
       end
       column :default_theming do |account|
-        account.default_theming.theme_name if authorized?(:read, account)
+        account.first_paged_entry_template.theme_name if authorized?(:read, account)
       end
     end
 
@@ -63,6 +63,7 @@ module Pageflow
     show :title => :name do |account|
       render 'account_details', :account => account
       render 'theming_details', :account => account
+      render 'entry_template_details', account: account
 
       tabs_view(Pageflow.config.admin_resource_tabs.find_by_resource(account.default_theming),
                 i18n: 'pageflow.admin.resource_tabs',
@@ -80,28 +81,65 @@ module Pageflow
 
       def new
         @account = Account.new
-        @account.build_default_theming(
+        @account.build_default_theming
+        @entry_template = @account.entry_templates.build(
           default_locale: current_user.locale,
-          share_providers: Pageflow.config.default_share_providers
+          share_providers: Pageflow.config.default_share_providers,
+          entry_type: 'paged'
         )
       end
 
       def create
-        @account = Account.new(permitted_params[:account])
-        @account.build_default_theming(permitted_params.fetch(:account, {})[:default_theming_attributes])
+        account_params = (permitted_params[:account] || {})
+                         .except(:paged_entry_template_attributes)
+        @account = Account.new(account_params)
+        @account.build_default_theming(permitted_params.fetch(:account, {})[
+                                         :default_theming_attributes])
+        @entry_template = @account.entry_templates.build({entry_type: 'paged'}
+                                                  .merge(entry_template_params))
+
+        super
+        update_widgets('paged')
+      end
+
+      def edit
+        @entry_template = resource.first_paged_entry_template
         super
-        update_widgets
       end
 
       def update
+        @entry_template = resource.entry_templates.find_or_initialize_by(
+          entry_type: 'paged'
+        )
+        @entry_template.assign_attributes(entry_template_params)
+        @entry_template.save
         update! do |success, failure|
           success.html { redirect_to(admin_account_path(resource, params.permit(:tab))) }
         end
-        update_widgets
+        update_widgets('paged')
+      end
+
+      def entry_template_params
+        current_params = permitted_params_with_entry_template_attributes.fetch(:account, {})[
+          :paged_entry_template_attributes]&.to_hash
+        if current_params
+          config = true_false_strings_to_booleans_or_numbers(
+            current_params['configuration']
+          )
+          share_providers = true_false_strings_to_booleans_or_numbers(
+            current_params['share_providers']
+          )
+          current_params.merge('configuration' => config, 'share_providers' => share_providers)
+        else
+          {}
+        end
       end
 
-      def update_widgets
-        @account.default_theming.widgets.batch_update!(widgets_params) if @account.valid?
+      def update_widgets(entry_type)
+        if @account.valid?
+          EntryTemplate.find_by(account_id: @account.id, entry_type: entry_type)
+            &.widgets&.batch_update!(widgets_params)
+        end
       end
 
       def widgets_params
@@ -113,11 +151,13 @@ module Pageflow
       def permitted_params
         result = params.permit(account: permitted_account_attributes)
 
-        if result[:account]
-          permit_feature_states(result[:account])
-        end
+        with_permitted_feature_states(result)
+      end
 
-        result
+      def permitted_params_with_entry_template_attributes
+        result = params.permit(account: permitted_account_attributes_plus_entry_template)
+
+        with_permitted_feature_states(result)
       end
 
       def scoped_collection
@@ -126,6 +166,31 @@ module Pageflow
 
       private
 
+      def with_permitted_feature_states(result)
+        result[:account] && permit_feature_states(result[:account])
+
+        result
+      end
+
+      def true_false_strings_to_booleans_or_numbers(hash)
+        hash&.map { |k, v| [k, to_boolean_or_number(v)] }&.to_h
+      end
+
+      def to_boolean_or_number(value)
+        case value
+        when 'false'
+          false
+        when 'true'
+          true
+        when '0'
+          0
+        when '1'
+          1
+        else
+          value
+        end
+      end
+
       def permitted_account_attributes
         [
           :name,
@@ -135,25 +200,35 @@ module Pageflow
           permitted_attributes_for(:account)
       end
 
+      def permitted_account_attributes_plus_entry_template
+        permitted_account_attributes +
+          [paged_entry_template_attributes: permitted_entry_template_attributes]
+      end
+
       def permitted_theming_attributes
         [
           :cname,
           :additional_cnames,
-          :theme_name,
           :imprint_link_url,
           :imprint_link_label,
           :copyright_link_url,
           :copyright_link_label,
           :privacy_link_url,
-          :home_url,
-          :home_button_enabled_by_default,
+          :home_url
+        ] +
+          permitted_attributes_for(:theming)
+      end
+
+      def permitted_entry_template_attributes
+        [
+          :theme_name,
           :default_author,
           :default_publisher,
           :default_keywords,
           :default_locale,
-          share_providers: []
-        ] +
-          permitted_attributes_for(:theming)
+          share_providers: {},
+          configuration: {}
+        ]
       end
 
       def permitted_attributes_for(resource_name)