pageflow 17.0.5 → 17.2.0

data/lib/pageflow/zencoder_video_output_definition.rb

@@ -1,4 +1,5 @@
 module Pageflow
+  # @api private
   class ZencoderVideoOutputDefinition < ZencoderOutputDefinition
     cattr_accessor :skip_hls, :skip_smil
 
@@ -35,6 +36,7 @@ module Pageflow
 
     def mp4_highdef_definitions
       return [] unless video_file.encode_highdef?
+
       [transferable(mp4_4k_definition), transferable(mp4_fullhd_definition)]
     end
 
@@ -43,15 +45,15 @@ module Pageflow
         label: '4k',
         prepare_for_segmenting: ['hls', 'dash'],
         path: video_file.mp4_4k.path,
-        video_bitrate: 22000,
-        decoder_bitrate_cap: 24420,
-        decoder_buffer_size: 36631,
+        video_bitrate: 22_000,
+        decoder_bitrate_cap: 24_420,
+        decoder_buffer_size: 36_631,
         audio_bitrate: 320,
-        size: '3839x2160',
+        size: size(3839, 2160),
         skip: {
           min_size: MIN_SIZE_FOR_4K
         },
-        public: 1,
+        public: 1
       }
     end
 
@@ -64,11 +66,11 @@ module Pageflow
         decoder_bitrate_cap: 6660,
         decoder_buffer_size: 9990,
         audio_bitrate: 192,
-        size: '1919x1080',
+        size: size(1919, 1080),
         skip: {
           min_size: MIN_SIZE_FOR_FULLHD
         },
-        public: 1,
+        public: 1
       }
     end
 
@@ -81,8 +83,8 @@ module Pageflow
         decoder_bitrate_cap: 3410,
         decoder_buffer_size: 7326,
         audio_bitrate: 128,
-        size: '1280x720',
-        public: 1,
+        size: size(1280, 720),
+        public: 1
       }
     end
 
@@ -96,7 +98,7 @@ module Pageflow
         decoder_buffer_size: 2557,
         audio_bitrate: 64,
         audio_channels: 1,
-        size: '853x480',
+        size: size(853, 480),
         public: 1
       }
     end
@@ -111,7 +113,7 @@ module Pageflow
         decoder_buffer_size: 924,
         audio_bitrate: 64,
         audio_channels: 1,
-        size: '640x360',
+        size: size(640, 360),
         public: 1,
         h264_profile: 'baseline'
       }
@@ -123,7 +125,8 @@ module Pageflow
           non_transferable(dash_high_definition),
           non_transferable(dash_medium_definition),
           non_transferable(dash_low_definition),
-          non_transferable(dash_playlist_definition)
+          non_transferable(dash_playlist_definition),
+          non_transferable(dash_playlist_high_and_up_definition)
         ]
     end
 
@@ -144,7 +147,8 @@ module Pageflow
           non_transferable(hls_high_definition),
           non_transferable(hls_medium_definition),
           non_transferable(hls_low_definition),
-          non_transferable(hls_playlist_definition)
+          non_transferable(hls_playlist_definition),
+          non_transferable(hls_playlist_high_and_up_definition)
         ]
     end
 
@@ -228,46 +232,47 @@ module Pageflow
     end
 
     def dash_playlist_definition
-      {
+      Playlist.build(
         label: 'dash-playlist',
-        streams: dash_stream_definitions,
-        allow_skipped_sources: true,
-        type: 'playlist',
-        streaming_delivery_format: 'dash',
-        path: video_file.dash_playlist.path,
-        public: 1
-      }
+        attachment: video_file.dash_playlist,
+        format: 'dash'
+      ) do |streams|
+        streams.from(dash_low_definition)
+        streams.from(dash_medium_definition)
+        streams.from(dash_high_definition)
+
+        if video_file.encode_highdef?
+          streams.from(dash_fullhd_definition)
+          streams.from(dash_4k_definition)
+        end
+      end
     end
 
-    def dash_stream_definitions
-      [
-        {
-          source: 'dash-low',
-          path: video_file.dash_low.url_relative_to(video_file.dash_playlist)
-        },
-        {
-          source: 'dash-medium',
-          path: video_file.dash_medium.url_relative_to(video_file.dash_playlist)
-        },
-        {
-          source: 'dash-high',
-          path: video_file.dash_high.url_relative_to(video_file.dash_playlist)
-        }
-      ] + dash_highdef_stream_definitions
+    def dash_playlist_high_and_up_definition
+      Playlist.build(
+        label: 'dash-playlist-high-and-up',
+        attachment: video_file.dash_playlist_high_and_up,
+        format: 'dash'
+      ) do |streams|
+        streams.from(dash_high_definition)
+
+        if video_file.encode_highdef?
+          streams.from(dash_fullhd_definition)
+          streams.from(dash_4k_definition)
+        end
+      end
     end
 
-    def dash_highdef_stream_definitions
-      return [] unless video_file.encode_highdef?
-      [
-        {
-          source: 'dash-fullhd',
-          path: video_file.dash_fullhd.url_relative_to(video_file.dash_playlist)
-        },
-        {
-          source: 'dash-4k',
-          path: video_file.dash_4k.url_relative_to(video_file.dash_playlist)
-        }
-      ]
+    def dash_playlist_fullhd_and_up_definition
+      Playlist.build(
+        label: 'dash-playlist-fullhd-and-up',
+        attachment: video_file.dash_playlist_fullhd_and_up,
+        format: 'dash',
+        min_size: MIN_SIZE_FOR_FULLHD
+      ) do |streams|
+        streams.from(dash_fullhd_definition)
+        streams.from(dash_4k_definition)
+      end
     end
 
     def hls_low_definition
@@ -336,50 +341,47 @@ module Pageflow
     end
 
     def hls_playlist_definition
-      {
+      Playlist.build(
         label: 'hls-playlist',
-        streams: hls_stream_definitions,
-        allow_skipped_sources: true,
-        type: 'playlist',
-        path: video_file.hls_playlist.path,
-        public: 1
-      }
+        attachment: video_file.hls_playlist,
+        format: 'hls'
+      ) do |streams|
+        streams.from(hls_medium_definition, bandwidth: 1769)
+        streams.from(hls_low_definition, bandwidth: 619)
+        streams.from(hls_high_definition, bandwidth: 3538)
+
+        if video_file.encode_highdef?
+          streams.from(hls_fullhd_definition, bandwidth: 8575)
+          streams.from(hls_4k_definition, bandwidth: 32_000)
+        end
+      end
     end
 
-    def hls_stream_definitions
-      [
-        {
-          source: 'hls-medium',
-          path: video_file.hls_medium.url_relative_to(video_file.hls_playlist),
-          bandwidth: 1769
-        },
-        {
-          source: 'hls-low',
-          path: video_file.hls_low.url_relative_to(video_file.hls_playlist),
-          bandwidth: 619
-        },
-        {
-          source: 'hls-high',
-          path: video_file.hls_high.url_relative_to(video_file.hls_playlist),
-          bandwidth: 3538
-        }
-      ] + hls_highdef_stream_definitions
+    def hls_playlist_high_and_up_definition
+      Playlist.build(
+        label: 'hls-playlist-high-and-up',
+        attachment: video_file.hls_playlist_high_and_up,
+        format: 'hls'
+      ) do |streams|
+        streams.from(hls_high_definition, bandwidth: 3538)
+
+        if video_file.encode_highdef?
+          streams.from(hls_fullhd_definition, bandwidth: 8575)
+          streams.from(hls_4k_definition, bandwidth: 32_000)
+        end
+      end
     end
 
-    def hls_highdef_stream_definitions
-      return [] unless video_file.encode_highdef?
-      [
-        {
-          source: 'hls-fullhd',
-          path: video_file.hls_fullhd.url_relative_to(video_file.hls_playlist),
-          bandwidth: 8575
-        },
-        {
-          source: 'hls-4k',
-          path: video_file.hls_4k.url_relative_to(video_file.hls_playlist),
-          bandwidth: 32000
-        }
-      ]
+    def hls_playlist_fullhd_and_up_definition
+      Playlist.build(
+        label: 'hls-playlist-fullhd-and-up',
+        attachment: video_file.hls_playlist_fullhd_and_up,
+        format: 'hls',
+        min_size: MIN_SIZE_FOR_FULLHD
+      ) do |streams|
+        streams.from(hls_fullhd_definition, bandwidth: 8575)
+        streams.from(hls_4k_definition, bandwidth: 32_000)
+      end
     end
 
     def smil_definitions
@@ -457,7 +459,7 @@ module Pageflow
         smil_fullhd_stream_definitions,
         {
           path: video_file.mp4_4k.url(host: :hls_origin, default_protocol: 'http'),
-          bandwidth: 32000
+          bandwidth: 32_000
         }
       ].flatten
     end
@@ -472,6 +474,15 @@ module Pageflow
       result
     end
 
+    def size(max, min)
+      if video_file.width && video_file.height &&
+         video_file.width < video_file.height
+        "#{min}x#{max}"
+      else
+        "#{max}x#{min}"
+      end
+    end
+
     def thumbnails_definition(url_helper)
       {
         thumbnails: [
@@ -491,5 +502,46 @@ module Pageflow
         ]
       }
     end
+
+    # @api private
+    class Playlist
+      def self.build(**args)
+        builder = new(**args)
+        yield builder
+        builder.build_definition
+      end
+
+      def initialize(label:, attachment:, format:, min_size: nil)
+        @label = label
+        @attachment = attachment
+        @format = format
+        @min_size = min_size
+        @streams = []
+      end
+
+      def from(source_definition, bandwidth: nil)
+        @streams << {
+          source: source_definition[:label],
+          path: @attachment.relative_path_to(source_definition[:path]),
+          bandwidth:
+        }.compact
+      end
+
+      def build_definition
+        definition = {
+          label: @label,
+          streams: @streams,
+          allow_skipped_sources: true,
+          type: 'playlist',
+          path: @attachment.path,
+          public: 1
+        }
+
+        definition[:streaming_delivery_format] = @format if @format == 'dash'
+        definition[:skip] = {min_size: @min_size} if @min_size
+
+        definition
+      end
+    end
   end
 end

data/lib/pageflow.rb

@@ -2,8 +2,9 @@ require 'pageflow/engine'
 require 'pageflow/global_config_api'
 require 'pageflow/news_item_api'
 require 'pageflow/version'
+require 'pageflow/deprecation'
 
-module Pageflow
+module Pageflow # rubocop:todo Style/Documentation
   extend GlobalConfigApi
   extend NewsItemApi
 
@@ -29,7 +30,12 @@ module Pageflow
 
   def self.active_admin_settings(config)
     config.before_action do
-      I18n.locale = current_user.try(:locale) || http_accept_language.compatible_language_from(I18n.available_locales) || I18n.default_locale
+      I18n.locale =
+        current_user.try(:locale) ||
+        http_accept_language.compatible_language_from(
+          I18n.available_locales
+        ) ||
+        I18n.default_locale
     end
   end
 

data/lib/tasks/pageflow_tasks.rake

@@ -24,7 +24,7 @@ namespace :pageflow do
 
   namespace :prune_auto_snapshots_jobs do
     desc 'Enqueue jobs to destroy old auto snapshot revisions'
-    task :enqueue => :environment do
+    task enqueue: :environment do
       options = {
         created_before: ENV['CREATED_BEFORE'] ? Time.parse(ENV['CREATED_BEFORE']) : 1.month.ago,
         keep_count: ENV.fetch('KEEP_COUNT', 20)

data/package/config/eslint-rules/documented-in-toc.js

@@ -0,0 +1,125 @@
+const fs = require('fs');
+const path = require('path');
+const yaml = require('js-yaml');
+
+// JSDoc comments on these are either nested under another item or
+// excluded from the generated docs, so they do not need toc entries.
+const skippedTags = /@(private|internal|ignore|memberof)\b/;
+
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description:
+        'Ensure JSDoc documented top level items are listed in the toc ' +
+        'of documentation.yml. Otherwise they render at an arbitrary ' +
+        'spot at the end of the generated docs.'
+    },
+    schema: []
+  },
+
+  create(context) {
+    const config = findTocConfig(path.dirname(context.getFilename()));
+
+    if (!config) {
+      return {};
+    }
+
+    const sourceCode = context.getSourceCode();
+
+    return {
+      Program(program) {
+        program.body.forEach(statement => {
+          const comment = jsdocCommentBefore(statement);
+
+          if (!comment || skippedTags.test(comment.value)) {
+            return;
+          }
+
+          const name = documentedName(comment, statement);
+
+          if (name && !config.names.has(name)) {
+            context.report({
+              loc: comment.loc,
+              message:
+                `'${name}' has a JSDoc comment, but is not listed in the ` +
+                `toc in ${config.relativePath}. Add it to the section ` +
+                'where it should show up in the generated docs.'
+            });
+          }
+        });
+      }
+    };
+
+    function jsdocCommentBefore(statement) {
+      const comments = sourceCode.getCommentsBefore(statement);
+      const comment = comments[comments.length - 1];
+
+      return comment &&
+             comment.type === 'Block' &&
+             comment.value.startsWith('*') ? comment : null;
+    }
+  }
+};
+
+function documentedName(comment, statement) {
+  const tagMatch = comment.value.match(/@(?:name|alias)\s+([\w.#]+)/);
+
+  if (tagMatch) {
+    return tagMatch[1];
+  }
+
+  return declaredName(statement);
+}
+
+function declaredName(statement) {
+  switch (statement.type) {
+  case 'ExportNamedDeclaration':
+  case 'ExportDefaultDeclaration':
+    return statement.declaration && declaredName(statement.declaration);
+  case 'FunctionDeclaration':
+  case 'ClassDeclaration':
+    return statement.id && statement.id.name;
+  case 'VariableDeclaration':
+    return statement.declarations[0].id.type === 'Identifier' ?
+           statement.declarations[0].id.name : null;
+  default:
+    return null;
+  }
+}
+
+const configCache = new Map();
+
+function findTocConfig(directory) {
+  if (configCache.has(directory)) {
+    return configCache.get(directory);
+  }
+
+  const configPath = path.join(directory, 'documentation.yml');
+  let config;
+
+  if (fs.existsSync(configPath)) {
+    config = loadTocConfig(configPath);
+  }
+  else {
+    const parent = path.dirname(directory);
+    config = parent === directory ? null : findTocConfig(parent);
+  }
+
+  configCache.set(directory, config);
+  return config;
+}
+
+function loadTocConfig(configPath) {
+  const toc = yaml.safeLoad(fs.readFileSync(configPath, 'utf8')).toc || [];
+  const names = new Set();
+
+  toc.forEach(section =>
+    (section.children || []).forEach(child => names.add(child))
+  );
+
+  return {
+    names,
+    relativePath: path.relative(process.cwd(), configPath)
+  };
+}

data/package/config/jest/index.js

@@ -13,7 +13,6 @@ module.exports = {
   moduleNameMapper: {
     '^jquery$': resolve('../../vendor/jquery'),
     '^jquery-ui$': resolve('../../vendor/jquery-ui'),
-    '^jquery.minicolors$': resolve('../../vendor/jquery.minicolors'),
     '^backbone.marionette$': resolve('../../vendor/backbone.marionette'),
     '^backbone.babysitter$': resolve('../../vendor/backbone.babysitter'),
     '^backbone$': resolve('../../vendor/backbone'),

data/package/config/webpack.js

@@ -5,7 +5,6 @@ module.exports = {
     'cocktail': 'Cocktail',
     'jquery': 'jQuery',
     'jquery-ui': 'jQuery',
-    'jquery.minicolors': 'jQuery',
     'underscore': '_',
     'backbone.marionette': 'Backbone.Marionette',
     'iscroll': 'IScroll',

data/package/config/webpack5.js

@@ -5,7 +5,6 @@ module.exports = {
     'cocktail': 'Cocktail',
     'jquery': 'jQuery',
     'jquery-ui': 'jQuery',
-    'jquery.minicolors': 'jQuery',
     'underscore': '_',
     'backbone.marionette': 'Backbone.Marionette',
     'iscroll': 'IScroll',