pageflow 0.8.2 → 0.9.0

data/db/migrate/20141211110226_add_configuration_to_chapters.rb

@@ -0,0 +1,5 @@
+class AddConfigurationToChapters < ActiveRecord::Migration
+  def change
+    add_column :pageflow_chapters, :configuration, :text
+  end
+end

data/db/migrate/20150115175116_add_features_configuration_to_accounts.rb

@@ -0,0 +1,5 @@
+class AddFeaturesConfigurationToAccounts < ActiveRecord::Migration
+  def change
+    add_column :pageflow_accounts, :features_configuration, :text
+  end
+end

data/db/migrate/20150115175207_add_features_configuration_to_entries.rb

@@ -0,0 +1,5 @@
+class AddFeaturesConfigurationToEntries < ActiveRecord::Migration
+  def change
+    add_column :pageflow_entries, :features_configuration, :text
+  end
+end

data/db/migrate/20150603091823_add_password_attributes_to_revisions.rb

@@ -0,0 +1,6 @@
+class AddPasswordAttributesToRevisions < ActiveRecord::Migration
+  def change
+    add_column :pageflow_revisions, :password_protected, :boolean
+    add_column :pageflow_entries, :password_digest, :string
+  end
+end

data/db/migrate/20151022080518_add_first_published_at_to_entries.rb

@@ -0,0 +1,14 @@
+class AddFirstPublishedAtToEntries < ActiveRecord::Migration
+  def change
+    add_column :pageflow_entries, :first_published_at, :datetime
+
+    execute(<<-SQL)
+      UPDATE pageflow_entries SET first_published_at = (
+        SELECT MIN(published_at)
+        FROM pageflow_revisions
+        WHERE pageflow_revisions.entry_id = pageflow_entries.id
+        LIMIT 1
+      );
+    SQL
+  end
+end

data/lib/generators/pageflow/initializer/templates/pageflow.rb

@@ -8,13 +8,12 @@ Pageflow.configure do |config|
 
   # Page types available in the editor. Add futher page types from
   # page type engines below.
-  config.register_page_type(Pageflow::BuiltInPageType.background_image)
-  config.register_page_type(Pageflow::BuiltInPageType.background_video)
-  config.register_page_type(Pageflow::BuiltInPageType.video)
-  config.register_page_type(Pageflow::BuiltInPageType.audio)
-  config.register_page_type(Pageflow::BuiltInPageType.audio_loop)
-  config.register_page_type(Pageflow::BuiltInPageType.internal_links)
-  # config.register_page_type(Pageflow::Rainbow::PageType.new)
+  config.page_types.register(Pageflow::BuiltInPageType.background_image)
+  config.page_types.register(Pageflow::BuiltInPageType.background_video)
+  config.page_types.register(Pageflow::BuiltInPageType.video)
+  config.page_types.register(Pageflow::BuiltInPageType.audio)
+  config.page_types.register(Pageflow::BuiltInPageType.audio_loop)
+  # config.page_types.register(Pageflow::Rainbow::PageType.new)
 
   # Add custom themes by invoking the pageflow:theme generator and
   # registering the theme here.
@@ -35,6 +34,16 @@ Pageflow.configure do |config|
   # pageflow_filesystem_root paperclip interpolation.
   config.paperclip_filesystem_root = 'tmp/attachments/production'
 
+  # How to handle https requests for URLs which will have assets in the page.
+  # If you wish to serve all assets over http and prevent mixed-content warnings,
+  # you can force a redirect to http. The inverse is also true: you can force
+  # a redirect to https for all http requests.
+  #
+  #     config.public_https_mode = :prevent (default) # => redirects https to http
+  #     config.public_https_mode = :enforce # => redirects http to https
+  #     config.public_https_mode = :ignore # => does nothing
+  config.public_https_mode = :ignore
+
   # Rewrite the below section to use your favorite configuration
   # method: ENV variables, secrets.yml, custom yml files. If you use
   # environment variables consider the dotenv gem to configure your
@@ -48,23 +57,23 @@ Pageflow.configure do |config|
   # calls are allowed.
   config.paperclip_s3_default_options.merge!(
     :s3_credentials => {
-      :bucket => 'com-example-pageflow-development',
-      :access_key_id => 'xxx',
-      :secret_access_key => 'xxx',
-      :s3_host_name => 's3-eu-west-1.amazonaws.com'
+      :bucket => ENV.fetch('S3_BUCKET', 'com-example-pageflow-development'),
+      :access_key_id => ENV.fetch('S3_ACCESS_KEY', 'xxx'),
+      :secret_access_key => ENV.fetch('S3_SECRET_KEY', 'xxx'),
+      :s3_host_name => ENV.fetch('S3_HOST_NAME', 's3-eu-west-1.amazonaws.com')
     },
-    :s3_host_alias => 'com-example-pageflow.s3-website-eu-west-1.amazonaws.com',
-    :s3_protocol => 'http'
+    :s3_host_alias => ENV.fetch('S3_HOST_ALIAS', 'com-example-pageflow.s3-website-eu-west-1.amazonaws.com'),
+    :s3_protocol => ENV.fetch('S3_PROTOCOL', 'http')
   )
 
   # Default options for paperclip attachments which are supposed to
   # use filesystem storage. All options allowed in paperclip has_attached_file
   # calls are allowed.
   config.zencoder_options.merge!(
-    :api_key => 'xxx',
-    :output_bucket => 'com-example-pageflow-out',
-    :s3_host_alias => 'com-example-pageflow-out.s3-website-eu-west-1.amazonaws.com',
-    :s3_protocol => 'http',
+    :api_key => ENV.fetch('ZENCODER_API_KEY', 'xxx'),
+    :output_bucket => ENV.fetch('S3_OUTPUT_BUCKET', 'com-example-pageflow-out'),
+    :s3_host_alias => ENV.fetch('S3_OUTPUT_HOST_ALIAS', 'com-example-pageflow-out.s3-website-eu-west-1.amazonaws.com'),
+    :s3_protocol => ENV.fetch('S3_PROTOCOL','http'),
     :attachments_version => 'v1'
   )
 end

data/lib/generators/pageflow/theme/theme_generator.rb

@@ -13,9 +13,10 @@ module Pageflow
         directory('images/pageflow/themes/default', themes_path('images', name))
 
         template('stylesheets/pageflow/themes/default.css.scss', themes_path('stylesheets', "#{name}.css.scss")) do |content|
-          content.gsub!('$theme-name: "default";', %Q'$theme-name: "#{name}";')
           content.gsub!('@import "./default/', %Q'@import "./#{name}/')
         end
+
+        gsub_file themes_path('stylesheets', "#{name}/variables.css.scss"), '$theme-name: "default";', %Q'$theme-name: "#{name}";'
       end
 
       private

data/lib/pageflow.rb

@@ -1,52 +1,8 @@
 require "pageflow/engine"
+require "pageflow/global_config_api"
 
 module Pageflow
-  def self.config(options = {})
-    unless @config
-      if options[:ignore_not_configured]
-        return Configuration.new
-      else
-        raise('Pageflow has not been configured yet')
-      end
-    end
-    @config
-  end
-
-  def self.configure(&block)
-    @configure_blocks ||= []
-    @configure_blocks << block
-  end
-
-  def self.configured?
-    !!@config
-  end
-
-  def self.configure!
-    return unless @finalized
-
-    config = Configuration.new
-    @configure_blocks ||= []
-
-    @configure_blocks.each do |block|
-      block.call(config)
-    end
-
-    @after_configure_blocks.each do |block|
-      block.call(config)
-    end
-
-    @config = config
-  end
-
-  def self.finalize!
-    @finalized = true
-    configure!
-  end
-
-  def self.after_configure(&block)
-    @after_configure_blocks ||= []
-    @after_configure_blocks << block
-  end
+  extend GlobalConfigApi
 
   def self.routes(router)
     router.instance_eval do

data/lib/pageflow/admin/form_input.rb

@@ -0,0 +1,18 @@
+module Pageflow
+  module Admin
+    # @api private
+    class FormInput
+      attr_reader :attribute_name
+
+      def initialize(attribute_name, options)
+        @attribute_name = attribute_name
+        @options = options
+      end
+
+      def build(form_builder)
+        options = @options.respond_to?(:call) ? @options.call : @options
+        form_builder.input(attribute_name, options)
+      end
+    end
+  end
+end

data/lib/pageflow/admin/form_inputs.rb

@@ -0,0 +1,41 @@
+module Pageflow
+  module Admin
+    # A registry of additional inputs for admin forms.
+    #
+    # @since 0.9
+    class FormInputs
+      def initialize
+        @resources = {}
+      end
+
+      # Register a proc which adds additional inputs to admin forms.
+      #
+      # @param resource_name [Symbol] A resource name like `:entry`,
+      #   `:account` or `:theming`
+      # @param attribute_name [Symbol] The name of the additional
+      #   attribute
+      # @param options [Hash] Formtastic options
+      def register(resource_name, attribute_name, options = {})
+        @resources[resource_name] ||= []
+        @resources[resource_name] << FormInput.new(attribute_name, options)
+      end
+
+      # @api private
+      def build(resource_name, form_builder)
+        find_all_for(resource_name).each do |form_input|
+          form_input.build(form_builder)
+        end
+      end
+
+      # @api private
+      def permitted_attributes_for(resource_name)
+        find_all_for(resource_name).map(&:attribute_name)
+      end
+
+      # @api private
+      def find_all_for(resource_name)
+        @resources.fetch(resource_name, [])
+      end
+    end
+  end
+end

data/lib/pageflow/built_in_page_type.rb

@@ -62,10 +62,6 @@ module Pageflow
           thumbnail_candidates: video_thumbnail_candidates)
     end
 
-    def self.internal_links
-      new('internal_links', file_type_models: ['Pageflow::ImageFile'])
-    end
-
     def self.video
       new('video',
           file_type_models: ['Pageflow::ImageFile', 'Pageflow::VideoFile'],

data/lib/pageflow/configuration.rb

@@ -33,6 +33,22 @@ module Pageflow
     # new users
     attr_accessor :mailer_sender
 
+    # Extend the configuration based on feature flags set for accounts
+    # or entries.
+    #
+    # @example
+    #
+    # Make a page type only available if a feature flag is set on the
+    # entry or its account
+    #
+    #   config.features.register('some_special_page_type' do |config
+    #     config.page_types.register(Pageflow::SomeSpecial.page_type)
+    #   end
+    #
+    # @since 0.9
+    # @returns [Features}
+    attr_reader :features
+
     # Subscribe to hooks in order to be notified of events. Any object
     # with a call method can be a subscriber
     #
@@ -60,6 +76,11 @@ module Pageflow
     # @return [Themes]
     attr_reader :themes
 
+    # Register new types of pages.
+    # @return [PageTypes]
+    # @since 0.9
+    attr_reader :page_types
+
     # List of {FileType} instances provided by page types.
     # @return [FileTypes]
     attr_reader :file_types
@@ -159,14 +180,39 @@ module Pageflow
     #
     #     config.admin_resource_tabs.register(:entry, Admin::CustomTab)
     #
-    # @return [Admin::TabsRegistry]
+    # @return [Admin::Tabs]
     attr_reader :admin_resource_tabs
 
+    # Add custom form fields to admin forms.
+    #
+    # @example
+    #
+    #     config.admin_form_inputs.register(:entry) do |form|
+    #       form.input(:custom_field)
+    #     end
+    #
+    # @since 0.9
+    # @return [Admin::FormInputs]
+    attr_reader :admin_form_inputs
+
     # Array of locales which can be chosen as interface language by a
     # user or for an entry. Defaults to `I18n.available_locales`.
     # @since 0.7
     attr_accessor :available_locales
 
+    # How to handle https requests for URLs which will have assets in the page.
+    # If you wish to serve all assets over http and prevent mixed-content warnings,
+    # you can force a redirect to http. The inverse is also true: you can force
+    # a redirect to https for all http requests.
+    #
+    # @example
+    #
+    #     config.public_https_mode = :prevent (default) # => redirects https to http
+    #     config.public_https_mode = :enforce # => redirects http to https
+    #     config.public_https_mode = :ignore # => does nothing
+    # @since 0.9
+    attr_accessor :public_https_mode
+
     def initialize
       @paperclip_filesystem_default_options = {validate_media_type: false}
       @paperclip_s3_default_options = {validate_media_type: false}
@@ -175,9 +221,11 @@ module Pageflow
 
       @mailer_sender = 'pageflow@example.com'
 
+      @features = Features.new
       @hooks = Hooks.new
       @quotas = Quotas.new
       @themes = Themes.new
+      @page_types = PageTypes.new
       @file_types = FileTypes.new(page_types)
       @widget_types = WidgetTypes.new
       @help_entries = HelpEntries.new
@@ -192,8 +240,11 @@ module Pageflow
       @confirm_encoding_jobs = false
 
       @admin_resource_tabs = Pageflow::Admin::Tabs.new
+      @admin_form_inputs = Pageflow::Admin::FormInputs.new
 
       @available_locales = Engine.config.i18n.available_locales
+
+      @public_https_mode = :prevent
     end
 
     # Activate a plugin.
@@ -204,24 +255,10 @@ module Pageflow
       plugin.configure(self)
     end
 
-    # Make a page type available for use in the system.
+    # @deprecated Use `config.page_types.register` instead.
     def register_page_type(page_type)
-      page_types << page_type
-
-      @page_types_by_name ||= {}
-      @page_types_by_name[page_type.name] = page_type
-    end
-
-    def lookup_page_type(name)
-      @page_types_by_name.fetch(name)
-    end
-
-    def page_types
-      @page_types ||= []
-    end
-
-    def page_type_names
-      page_types.map(&:name)
+      ActiveSupport::Deprecation.warn('Pageflow::Configuration#register_page_type is deprecated. Use config.page_types.register instead.', caller)
+      page_types.register(page_type)
     end
 
     def revision_components
@@ -233,5 +270,24 @@ module Pageflow
       options = public_entry_url_options
       options.respond_to?(:call) ? options.call(theming) : options
     end
+
+    # @api private
+    def enable_features(names)
+      features.enable(names, FeatureLevelConfiguration.new(self))
+    end
+
+    # @api private
+    def enable_all_features
+      features.enable_all(FeatureLevelConfiguration.new(self))
+    end
+
+    # Restricts the configuration interface to those parts which can
+    # be used from inside features.
+    class FeatureLevelConfiguration < Struct.new(:config)
+      delegate :page_types, to: :config
+      delegate :widget_types, to: :config
+      delegate :help_entries, to: :config
+      delegate :admin_form_inputs, to: :config
+    end
   end
 end

data/lib/pageflow/feature.rb

@@ -0,0 +1,33 @@
+module Pageflow
+  # Represents a set of configuration changes that can be performed
+  # based on account or entry feature flags.
+  #
+  # @since 0.9
+  class Feature
+    # Unique identifyer of feature.
+    #
+    # @return [String]
+    attr_reader :name
+
+    # Create a block based feature.
+    #
+    # @param name [String] Unique identifyer of feature.
+    # @yieldparam config [Configuration] The configuration object to manipulate.
+    def initialize(name, &block)
+      @name = name
+      @block = block
+    end
+
+    # Perform any configuration change that is needed to activate this
+    # feature.
+    #
+    # @param config [Configuration]
+    def enable(config)
+      @block.call(config) if @block
+    end
+
+    def name_translation_key
+      "pageflow.#{name}.feature_name"
+    end
+  end
+end

data/lib/pageflow/features.rb

@@ -0,0 +1,68 @@
+module Pageflow
+  # A registry of [Feature} objects.
+  #
+  # @since 0.9
+  class Features
+    include Enumerable
+
+    # @api private
+    def initialize
+      @features = {}
+      @enabled_features = []
+    end
+
+    # Register a feature that can be enabled for accounts of
+    # entries. If the first parameter is a string, a block can be
+    # passed to provide the enable method. If only a string is passed,
+    # enabling the feature is no-op.
+    #
+    # @overload register(feature)
+    #   @param feature [Feature]
+    #
+    # @overload register(feature)
+    #   @param feature [String]
+    #   @yieldparam config [Configuration] Use the block as enable
+    #     method.
+    #
+    # @overload register(feature)
+    #   @param feature [String]
+    def register(feature, &block)
+      if feature.is_a?(String)
+        return register(Feature.new(feature, &block))
+      end
+
+      if @features.key?(feature.name)
+        raise(ArgumentError, "Feature #{feature.name} is already registered.")
+      end
+
+      @features[feature.name] = feature
+    end
+
+    # Check if a feature has been enabled.
+    #
+    # @return [Boolean]
+    def enabled?(name)
+      @enabled_features.include?(name)
+    end
+
+    # @api private
+    def enable(names, config)
+      @enabled_features = names
+
+      names.each do |name|
+        raise(ArgumentError, "Cannot enable unknown feature #{name}.") unless @features.key?(name)
+
+        @features[name].enable(config)
+      end
+    end
+
+    # @api private
+    def enable_all(config)
+      enable(@features.keys, config)
+    end
+
+    def each(&block)
+      @features.values.each(&block)
+    end
+  end
+end