pageflow 15.6.1 → 15.7.0

data/lib/pageflow/configuration.rb

@@ -95,6 +95,13 @@ module Pageflow
     # @since 15.1
     attr_reader :entry_types
 
+    # Either a lambda or an object with a `call` method taking an
+    # {Account} as paramater and returing the entry type that shall be
+    # selected by default when creating a new entry.
+    # @return [#call]
+    # @since 15.7
+    attr_accessor :default_entry_type
+
     # List of {FileType} instances.
     # Can be registered globally or provided by page types.
     # @return [FileTypes]
@@ -207,8 +214,22 @@ module Pageflow
     # construct the embed url of a published entry.
     attr_accessor :entry_embed_url_options
 
+    # Either a lambda or an object with a `call` method taking a hash
+    # of theme option overrides and an {EntryAtRevision} and returning
+    # a transformed hash of overrides. Can be used to filter overrides
+    # based on feature flags and other entry or account traits.
+    attr_accessor :transform_theme_customization_overrides
+
+    # Either a lambda or an object with a `call` method taking a hash
+    # of theme customization files and an {EntryAtRevision} and
+    # returning a transformed hash of files. Can be used to filter
+    # files based on feature flags and other entry or account traits.
+    attr_accessor :transform_theme_customization_files
+
     # Submit video/audio encoding jobs only after the user has
-    # explicitly confirmed in the editor. Defaults to false.
+    # explicitly confirmed in the editor. Can either be set to a
+    # boolean or a lambda that is passed the file and returns a
+    # boolean. Defaults to false.
     attr_accessor :confirm_encoding_jobs
 
     # Used by Pageflow extensions to provide new tabs to be displayed
@@ -387,6 +408,9 @@ module Pageflow
       @public_entry_url_options = Pageflow::ThemingsHelper::DEFAULT_PUBLIC_ENTRY_OPTIONS
       @entry_embed_url_options = {protocol: 'https'}
 
+      @transform_theme_customization_overrides = ->(overrides, _entry) { overrides }
+      @transform_theme_customization_files = ->(files, _entry) { files }
+
       @confirm_encoding_jobs = false
 
       @admin_resource_tabs = Pageflow::Admin::Tabs.new
@@ -481,6 +505,15 @@ module Pageflow
       @features.lint!
     end
 
+    # @api private
+    def confirm_encoding_jobs?(file)
+      if confirm_encoding_jobs.respond_to?(:call)
+        confirm_encoding_jobs.call(file)
+      else
+        confirm_encoding_jobs
+      end
+    end
+
     # @api private
     def theming_url_options(theming)
       options = public_entry_url_options

data/lib/pageflow/entry_type.rb

@@ -4,7 +4,8 @@ module Pageflow
   # @since 15.1
   class EntryType
     # @api private
-    attr_reader :name, :frontend_app, :editor_fragment_renderer, :configuration, :editor_app
+    attr_reader :name, :frontend_app, :editor_fragment_renderer, :configuration, :editor_app,
+                :theme_files
 
     # @param name [String] A unique name.
     #
@@ -20,12 +21,20 @@ module Pageflow
     # @param editor_app [#call] A rack app that extends the REST
     #   interface used by editor Backbone collections. Mounted at
     #   `/editor/entries/:id/<entry_type_name>/`
-    def initialize(name:, frontend_app:, editor_fragment_renderer:, configuration:, editor_app: nil)
+    #
+    # @param theme_files [Hash] A hash of the following form defining
+    #   what files can be uploaded when customizing themes of the
+    #   entry type and which Paperclip styles shall be processed:
+    #   `{logo: {content_type: %r{^image/}, styles: {small:
+    #   '300x300>'}}`.
+    def initialize(name:, frontend_app:, editor_fragment_renderer:, configuration:, editor_app: nil,
+                   theme_files: {})
       @name = name
       @frontend_app = frontend_app
       @editor_fragment_renderer = editor_fragment_renderer
       @configuration = configuration
       @editor_app = editor_app
+      @theme_files = theme_files
     end
   end
 end

data/lib/pageflow/entry_type_configuration.rb

@@ -18,6 +18,8 @@ module Pageflow
     delegate :revision_components, to: :@config
     delegate :themes, to: :@config
     delegate :widget_types, to: :@config
+    delegate :transform_theme_customization_overrides=, to: :@config
+    delegate :transform_theme_customization_files=, to: :@config
 
     def plugin(plugin)
       plugin.configure(self)

data/lib/pageflow/file_type.rb

@@ -123,6 +123,14 @@ module Pageflow
       @css_background_image_class_prefix || model.model_name.singular
     end
 
+    def css_background_image_urls_for(file, options)
+      if call_arity(css_background_image_urls) == 1
+        css_background_image_urls.call(file)
+      else
+        css_background_image_urls.call(file, options)
+      end
+    end
+
     # @api private
     def param_key
       model.model_name.param_key.to_sym
@@ -154,5 +162,21 @@ module Pageflow
         {}
       end
     end
+
+    def call_arity(callable)
+      # lambda's #call method always claims to have no required
+      # parameters:
+      #
+      #   lambda { |file| }.method(:call).arity # => -1
+      #   lambda { |file, entry:| }.method(:call).arity # => -1
+      #
+      # Use arity of lambda itself instead:
+      #
+      #   lambda { |file| }.arity # => 1
+      #   lambda { |file, entry:| }.arity # => 1
+      return callable.arity if callable.respond_to?(:arity)
+
+      callable.method(:call).arity
+    end
   end
 end

data/lib/pageflow/paperclip_processors/audio_waveform.rb

@@ -0,0 +1,42 @@
+require 'open3'
+
+module Pageflow
+  module PaperclipProcessors
+    # @api private
+    class AudioWaveform < Paperclip::Processor
+      def make
+        destination = make_tempfile_for(file.path)
+
+        generate_peak_data(input: file.path,
+                           output: destination.path)
+
+        destination
+      end
+
+      private
+
+      def generate_peak_data(input:, output:)
+        _stdout, stderr, status = Open3.capture3('audiowaveform',
+                                                 '-i',
+                                                 input,
+                                                 '-o',
+                                                 output,
+                                                 '--pixels-per-second',
+                                                 '10',
+                                                 '--bits',
+                                                 '8')
+
+        raise "audiowaveform failed: #{stderr}" unless status.success?
+      end
+
+      def make_tempfile_for(path)
+        basename = File.basename(path, File.extname(path))
+
+        tempfile = Tempfile.new([basename, '.json'])
+        tempfile.binmode
+
+        tempfile
+      end
+    end
+  end
+end

data/lib/pageflow/paperclip_processors/noop.rb

@@ -0,0 +1,10 @@
+module Pageflow
+  module PaperclipProcessors
+    # @api private
+    class Noop < Paperclip::Processor
+      def make
+        File.new(file.path)
+      end
+    end
+  end
+end

data/lib/pageflow/theme_customizations.rb

@@ -0,0 +1,61 @@
+module Pageflow
+  # Apply account wide customizations to themes of a specific entry
+  # type.
+  #
+  # @since 15.7
+  class ThemeCustomizations
+    # Override theme options and files for entries of an entry type in
+    # a specific account.
+    def update(account:, entry_type_name:, overrides: {}, file_ids: {})
+      ThemeCustomization
+        .find_or_initialize_by(account: account, entry_type_name: entry_type_name)
+        .update!(overrides: overrides, selected_file_ids: file_ids)
+    end
+
+    # Construct an entry that uses the given overrides and files in
+    # its theme without actually updating the theme customization.
+    #
+    # @return [PublishedEntry]
+    def preview(account:, entry:, overrides: {}, file_ids: {})
+      theme_customization =
+        ThemeCustomization
+        .find_or_initialize_by(account: account, entry_type_name: entry.type_name)
+
+      theme_customization.assign_attributes(overrides: overrides, selected_file_ids: file_ids)
+
+      theme = CustomizedTheme.build(entry: entry,
+                                    theme: entry.draft.theme,
+                                    theme_customization: theme_customization)
+
+      PublishedEntry.new(entry, entry.draft, theme: theme)
+    end
+
+    # Get customization for entry type and account.
+    #
+    # @return [ThemeCustomization]
+    def get(account:, entry_type_name:)
+      ThemeCustomization
+        .find_or_initialize_by(account: account, entry_type_name: entry_type_name)
+    end
+
+    # Upload a file that shall be used to customize a theme. Uploading
+    # the file does not result in visible changes. Call [#update] and
+    # assign a role via the `file_ids` parameter.
+    #
+    # @return [ThemeCustomizationFile]
+    def upload_file(account:, entry_type_name:, type_name:, attachment:)
+      theme_customization_file =
+        ThemeCustomization
+        .find_or_create_by(account: account, entry_type_name: entry_type_name)
+        .uploaded_files
+        .build(type_name: type_name)
+
+      # Assign attachment in separate step to make sure theme
+      # customization association (which is used to look up Paperclip
+      # styles and validation content type) has already been set when Paperclip runs.
+      theme_customization_file.attachment = attachment
+      theme_customization_file.save!
+      theme_customization_file
+    end
+  end
+end

data/lib/pageflow/version.rb

@@ -1,3 +1,3 @@
 module Pageflow
-  VERSION = '15.6.1'.freeze
+  VERSION = '15.7.0'.freeze
 end

data/lib/pageflow.rb

@@ -44,4 +44,13 @@ module Pageflow
   def self.built_in_widget_types_plugin
     BuiltInWidgetTypesPlugin.new
   end
+
+  # Apply account wide customizations to themes of a specific entry
+  # type.
+  #
+  # @return [ThemeCustomizations]
+  # @since 15.7
+  def self.theme_customizations
+    ThemeCustomizations.new
+  end
 end

data/package/config/jest/index.js

@@ -2,6 +2,7 @@ const path = require('path');
 
 module.exports = {
   globals: {
+    __webpack_public_path__: '',
     pageflow: {
       config: {}
     }
@@ -22,7 +23,7 @@ module.exports = {
 
   transform: {
     '^.+\\.jst$': resolve('./transformers/jst'),
-    '^.+\\.jsx?$': resolve('./transformers/upwardBabel'),
+    '^.+\\.jsx?$': ['babel-jest', {rootMode: "upward"}],
     '^.+\\.module.css$': 'jest-css-modules-processor'
   }
 }

data/package/config/postcss/scaleFunctions.js

@@ -0,0 +1,71 @@
+const scale = Object.entries({
+  '0.5': '0.125rem',
+  '1':   '0.25rem',
+  '1.5': '0.375rem',
+  '2':   '0.5rem',
+  '2.5': '0.625rem',
+  '3':   '0.75rem',
+  '3.5': '0.875rem',
+  '4':   '1rem',
+  '5':   '1.25rem',
+  '6':   '1.5rem',
+  '7':   '1.75rem',
+  '8':   '2rem',
+  '9':   '2.25rem',
+  '10':  '2.5rem',
+  '11':  '2.75rem',
+  '12':  '3rem',
+  '14':  '3.5rem',
+  '16':  '4rem',
+  '20':  '5rem',
+  '24':  '6rem',
+  '28':  '7rem',
+  '32':  '8rem',
+  '36':  '9rem',
+  '40':  '10rem',
+  '44':  '11rem',
+  '48':  '12rem',
+  '52':  '13rem',
+  '56':  '14rem',
+  '60':  '15rem',
+  '64':  '16rem',
+  '72':  '18rem',
+  '80':  '20rem',
+  '96':  '24rem'
+}).reduce((result, e) => {
+  const [key, value] = e;
+  return {
+    ...result,
+    [key]: value,
+    [`-${key}`]: `-${value}`
+  };
+}, {});
+
+const rounded = {
+  'sm': '0.125rem',
+  'base': '0.25rem',
+  'md': '0.375rem',
+  'lg': '0.5rem',
+  'xl': '0.75rem',
+  '2xl': '1em',
+  '3xl': '1.5rem',
+  'full': '9999px'
+};
+
+module.exports = require('postcss-functions')({
+  functions: {
+    rounded: loopUpFunction(rounded, 'rounded'),
+    size: loopUpFunction(scale, 'size'),
+    space: loopUpFunction(scale, 'space')
+  }
+});
+
+function loopUpFunction(map, name) {
+  return function(key = 'base') {
+    if (!map[key]) {
+      throw new Error(`Unknown ${name} ${key}`);
+    }
+
+    return map[key];
+  }
+}