pageflow 0.2.1 → 0.3.0

data/config/locales/activerecord.de.yml

@@ -95,6 +95,8 @@ de:
         url: "Permalink"
         account: "Konto"
         manual_start: "Multimedia Hinweis vor dem Start anzeigen"
+        home_url: "Home-Button URL"
+        home_button_enabled: "Home-Button anzeigen"
       "pageflow/folder":
         account: "Konto"
         name: "Name"
@@ -136,6 +138,7 @@ de:
         linked_pages_layout: "Hervorgehobenes Element"
         hide_title: "Titel ausblenden"
         text_position: "Textposition"
+        autoplay: "Automatische Wiedergabe"
       "pageflow/image_file":
         dimensions: "Maße"
       "pageflow/video_file":
@@ -152,6 +155,8 @@ de:
         imprint_link_url: "Impressum-Link URL"
         copyright_link_label: "Copyright-Link Text"
         copyright_link_url: "Copyright-Link URL"
+        home_url: "Redirect URL"
+        home_button_enabled_by_default: "Home-Button in neuen Beiträgen anzeigen"
     values:
       "pageflow/page":
         template:

data/config/locales/editor.de.yml

@@ -6,6 +6,7 @@ de:
         files: "Dateien"
         options: "Optionen"
         links: "Verweise"
+        widgets: "Erscheinungsbild"
     screens:
       ratio16to9: "16:9"
       ratio4to3: "4:3"
@@ -54,5 +55,9 @@ de:
         summary: "Zusammenfassung die an Soziale Netzwerke weitergeben wird."
         credits: "Text wird zusammen mit dem Impressumsverweis angezeigt."
         manual_start: "Besucher muss den Start des Beitrags durch einen Klick bestätigen."
+        home_button_enabled: "Link zu einer Übersichtsseite anzeigen."
+        home_button_enabled_disabled: "Diese Funktion steht in diesem Theme nicht zur Verfügung."
+        home_url: "URL der Übersichtseite. Leer lassen, um Standard zu übernehmen."
+        home_url_disabled: "Diese Funktion steht in diesem Theme nicht zur Verfügung."
       "pageflow/chapter":
         title: "Wird auf der Übersichtsseite angezeigt."

data/config/routes.rb

@@ -54,6 +54,7 @@ Pageflow::Engine.routes.draw do
 
   resources :entries, :only => [:show]
   get ':id', :to => 'entries#show', :as => :short_entry
+  get '/', :to => 'entries#index', :as => :public_root
 
   get ':id/pages/:page_index', :to => 'entries#page'
 end

data/db/migrate/20140819081454_add_home_url_attributes_to_themings_and_revisions.rb

@@ -0,0 +1,9 @@
+class AddHomeUrlAttributesToThemingsAndRevisions < ActiveRecord::Migration
+  def change
+    add_column :pageflow_themings, :home_url, :string, default: '', null: false
+    add_column :pageflow_themings, :home_button_enabled_by_default, :boolean, default: true, null: false
+
+    add_column :pageflow_revisions, :home_url, :string, default: '', null: false
+    add_column :pageflow_revisions, :home_button_enabled, :boolean, default: false, null: false
+  end
+end

data/lib/generators/pageflow/seeds/seeds_generator.rb

@@ -3,10 +3,10 @@ module Pageflow
     class SeedsGenerator < Rails::Generators::Base
       desc "Requires the pageflow seeds in db/seeds.rb"
 
-      def add_route
-        append_to_file 'db/seeds.rb' do
-          "require 'pageflow/seeds'\n"
-        end
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_initializer
+        template 'seeds.rb', 'db/seeds.rb'
       end
     end
   end

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

@@ -0,0 +1,30 @@
+include Pageflow::Seeds
+
+# Make sure to change the password if you intend to apply this seed to
+# a production system.
+default_user_password('!Pass123')
+
+account(name: 'Pageflow') do |account|
+  entry = sample_entry(account: account, title: 'Example Entry')
+
+  user(account: account,
+       role: 'admin',
+       email: 'admin@example.com',
+       first_name: 'Alice',
+       last_name: 'Adminson')
+
+  user(account: account,
+       role: 'account_manager',
+       email: 'accountmanager@example.com',
+       first_name: 'Alfred',
+       last_name: 'Mc Count')
+
+  user(account: account,
+       email: 'editor@example.com',
+       role: 'editor',
+       first_name: 'Ed',
+       last_name: 'Edison') do |editor|
+
+    membership(user: editor, entry: entry)
+  end
+end

data/lib/pageflow/configuration.rb

@@ -68,14 +68,34 @@ module Pageflow
     # accessible via one official url.
     attr_accessor :editor_routing_constraint
 
+    # Either a lambda or an object with a `call` method taking two
+    # parameters: An `ActiveRecord` scope of {Pageflow::Theming} records
+    # and an {ActionDispatch::Request} object. Has to return the scope
+    # in which to find themings.
+    #
+    # Defaults to {CnameThemingRequestScope} which finds themings
+    # based on the request subdomain. Can be used to alter the logic
+    # of finding a theming whose home_url to redirect to when visiting
+    # the public root path.
+    #
+    # Example:
+    #
+    #     config.theming_request_scope = lambda do |themings, request|
+    #       themings.where(id: Pageflow::Account.find_by_name!(request.subdomain).default_theming_id)
+    #     end
+    attr_accessor :theming_request_scope
+
     # Either a lambda or an object with a `call` method taking two
     # parameters: An `ActiveRecord` scope of `Pageflow::Entry` records
     # and an `ActionDispatch::Request` object. Has to return the scope
     # in which to find entries.
     #
-    # Used by all public actions that display entires to restrict the
+    # Used by all public actions that display entries to restrict the
     # available entries by hostname or other request attributes.
     #
+    # Use {#public_entry_url_options} to make sure urls of published
+    # entries conform twith the restrictions.
+    #
     # Example:
     #
     #     # Only make entries of one account available under <account.name>.example.com
@@ -84,6 +104,20 @@ module Pageflow
     #     end
     attr_accessor :public_entry_request_scope
 
+    # Either a lambda or an object with a `call` method taking a
+    # {Theming} as paramater and returing a hash of options used to
+    # construct the url of a published entry.
+    #
+    # Can be used to change the host of the url under which entries
+    # are available.
+    #
+    # Example:
+    #
+    #     config.public_entry_url_options = lambda do |theming|
+    #       {host: "#{theming.account.name}.example.com"}
+    #     end
+    attr_accessor :public_entry_url_options
+
     # Submit video/audio encoding jobs only after the user has
     # explicitly confirmed in the editor. Defaults to false.
     attr_accessor :confirm_encoding_jobs
@@ -100,7 +134,9 @@ module Pageflow
       @quotas = Quotas.new
       @themes = Themes.new
 
+      @theming_request_scope = CnameThemingRequestScope.new
       @public_entry_request_scope = lambda { |entries, request| entries }
+      @public_entry_url_options = Pageflow::ThemingsHelper::DEFAULT_PUBLIC_ENTRY_OPTIONS
 
       @confirm_encoding_jobs = false
     end
@@ -124,5 +160,15 @@ module Pageflow
     def page_type_names
       page_types.map(&:name)
     end
+
+    def revision_components
+      page_types.map(&:revision_components).flatten.uniq
+    end
+
+    # @api private
+    def theming_url_options(theming)
+      options = public_entry_url_options
+      options.respond_to?(:call) ? options.call(theming) : options
+    end
   end
 end

data/lib/pageflow/page_type.rb

@@ -41,6 +41,31 @@ module Pageflow
       []
     end
 
+
+    # ActiveRecord models to be copied together with a revision.
+    #
+    # This allows authors of PageTypes to attach models to the Pageflow
+    # revision mechanism.
+    #
+    # Example:
+    #     class Rainbow < ActiveRecord::Base
+    #       include Pageflow::RevisionComponent
+    #
+    #       [...]
+    #     end
+    #
+    #     class RainbowPageType < Pageflow::PageType
+    #       name 'rainbow'
+    #
+    #       def revision_components
+    #         [Rainbow]
+    #       end
+    #     end
+    #
+    def revision_components
+      []
+    end
+
     # View path of a template containing additional json to pass to
     # the editor. The data is available in the javascript definition
     # of the page type's configuration editor. By default nothing is

data/lib/pageflow/revision_component.rb

@@ -0,0 +1,39 @@
+module Pageflow
+  # RevisionComponent represents a model that is attached to the revision
+  # mechanism of Pageflow.
+  #
+  # In order to be used as a ComponentModel a model is required to
+  # have an integer field `perma_id` and a belongs_to field `revision`.
+  module RevisionComponent
+    extend ActiveSupport::Concern
+
+    included do
+      belongs_to :revision, class_name: 'Pageflow::Revision'
+      before_save :ensure_perma_id
+    end
+
+    def copy_to(revision)
+      record = dup
+      record.revision = revision
+      record.save!
+    end
+
+    def ensure_perma_id
+      self.perma_id ||= (self.class.maximum(:perma_id) || 0) + 1
+    end
+
+    module ClassMethods
+      def all_for_revision(revision)
+        where(revision_id: revision.id)
+      end
+
+      def from_perma_ids(revision, perma_ids)
+        return [] if revision.blank? || perma_ids.blank?
+
+        perma_ids.map do |perma_id|
+          find_by_revision_id_and_perma_id(revision.id, perma_id)
+        end.compact
+      end
+    end
+  end
+end

data/lib/pageflow/seeds.rb

@@ -1,90 +1,172 @@
-# Require this file in db/seeds.rb to create example records for development mode.
-
 module Pageflow
-  # Default Account
-
-  if Account.any?
-    default_account = Account.first
-    puts "   Account exists."
-  else
-    default_account = Account.create!(:name => 'Pageflow') do |account|
-      account.build_default_theming do |theming|
-        theming.theme_name = Pageflow.config.themes.names.first
-
-        theming.imprint_link_label = 'Impressum'
-        theming.imprint_link_url = 'http://example.com/impressum.html'
-        theming.copyright_link_label = '© Pageflow 2014'
-        theming.copyright_link_url = 'http://www.example.com/copyright.html'
+  # Provides a DSL for seeding the database with Pageflow
+  # models. Include this module in your `db/seeds.rb` file.
+  #
+  # @example
+  #
+  #   # db/seeds.rb
+  #   include Pageflow::Seeds
+  #
+  #   default_password 'supersecret'
+  #
+  #   account(name: 'example') do |account|
+  #     user(account: account,
+  #          email: 'admin@example.com',
+  #          role: 'admin',
+  #          first_name: 'John',
+  #          last_name: 'Doe')
+  #   end
+  module Seeds
+    DEFAULT_USER_PASSWORD = '!Pass123'
+
+    # Create an {Account} with a default {Theming} if no account by
+    # that name exists.
+    #
+    # @param [Hash] attributes  attributes to override defaults
+    # @option attributes [String] :name  required
+    # @yield [account] a block to be called before the account is saved
+    # @return [Account] newly created account
+    def account(attributes, &block)
+      Account.find_or_create_by!(attributes.slice(:name)) do |account|
+        account.attributes = attributes.reverse_merge(name: 'Pageflow')
+
+        build_default_theming_for(account)
+
+        say_creating_account(account)
+        yield(account) if block_given?
       end
     end
 
-    puts "   Created default account."
-  end
-
-  # Users
-
-  def self.create_user(options)
-    options[:password_confirmation] = options[:password]
-    Account.first.users.create!(options)
+    # Build a default {Theming} for an {Account}. To be used inside a
+    # block passed to {#account}.
+    #
+    # @example
+    #
+    #   account(name: 'example') do |account|
+    #     build_default_theming_for(account) do |theming|
+    #       theming.theme_name = 'mdr'
+    #     end
+    #   end
+    #
+    # @param [Account] account  the account to build a default themeing for
+    # @param [Hash] attributes  further attributes to override defaults
+    # @yield [theming] a block which is passed the newly built theming
+    # @return [Theming] newly built theming
+    def build_default_theming_for(account, attributes = {}, &block)
+      default_attributes = {
+        theme_name: Pageflow.config.themes.names.first,
+
+        imprint_link_label: 'Impressum',
+        imprint_link_url: 'http://example.com/impressum.html',
+        copyright_link_label: '© Pageflow 2014',
+        copyright_link_url: 'http://www.example.com/copyright.html'
+      }
+
+      account.build_default_theming(default_attributes.merge(attributes), &block)
+    end
 
-    puts <<-END
-   Created #{options[:admin] ? 'admin' : 'editor'} user:
+    # Create a {User} if non with the given email exists yet.
+    #
+    # @param [Hash] attributes  attributes to override defaults
+    # @option attributes [String] :email  required
+    # @yield [user] a block to be called before the user is saved
+    # @return [User] newly created user
+    def user(attributes, &block)
+      default_attributes = {
+        password: default_user_password,
+        first_name: 'Elliot',
+        last_name: 'Example'
+      }
+
+      User.find_or_create_by!(attributes.slice(:email)) do |user|
+        user.attributes = default_attributes.merge(attributes)
+        user.password_confirmation = user.password
+
+        say_creating_user(user)
+        yield(user) if block_given?
+      end
+    end
 
-     email:     #{options[:email]}
-     password:  #{options[:password]}
+    # Set the default password to use for created users. Call before
+    # using {#user}.
+    #
+    # @param [String] password
+    def default_user_password(password = nil)
+      if password
+        @default_user_password = password
+      else
+        @default_user_password || DEFAULT_USER_PASSWORD
+      end
+    end
 
-  END
-  end
+    # Create a sample {Entry} with some chapter and pages if no
+    # entry with that title exists in the given account.
+    #
+    # @param [Hash] attributes  attributes to override defaults
+    # @option attributes [Account] :account  required
+    # @option attributes [title] :title  required
+    # @yield [entry] a block to be called before the entry is saved
+    # @return [Entry] newly created entry
+    def sample_entry(attributes)
+      entry = Entry.where(attributes.slice(:account, :title)).first
+
+      if entry.nil?
+        entry = Entry.create!(attributes) do |entry|
+          entry.theming = attributes.fetch(:account).default_theming
+
+          say_creating_entry(entry)
+          yield(entry) if block_given?
+        end
+
+        chapter = entry.draft.chapters.create!(title: 'Kapitel 1')
+        chapter.pages.create!(template: 'background_image')
+        chapter.pages.create!(template: 'background_image')
+
+        chapter = entry.draft.chapters.create!(title: 'Kapitel 2')
+        chapter.pages.create!(template: 'video')
+      end
 
-  if default_account.users.none?
-    create_user(:email => 'admin@example.com',
-                :password => '!Pass123',
-                :first_name => 'Alice',
-                :last_name => 'Adminson',
-                :role => 'admin')
-
-    create_user(:email => 'accountmanager@example.com',
-                :password => '!Pass123',
-                :first_name => 'Alfred',
-                :last_name => 'Mc Count',
-                :role => 'account_manager')
-
-    create_user(:email => 'editor@example.com',
-                :password => '!Pass123',
-                :first_name => 'Ed',
-                :last_name => 'Edison')
-  else
-    puts "   Users exist."
-  end
+      entry
+    end
 
-  # Sample entry
+    # Create a {Membership} for the given user and entry.
+    #
+    # @param [Hash] attributes  attributes to override defaults
+    # @option attributes [User] :user  required
+    # @option attributes [Entry] :entry  required
+    # @return [Membership] newly created membership
+    def membership(attributes)
+      Membership.find_or_create_by!(attributes) do |membership|
+        say_creating_membership(membership)
+      end
+    end
 
-  unless Entry.any?
-    entry = default_account.entries.create!(:title => 'Fiese Flut', :theming_id => default_account.default_theming.id)
+    private
 
-    chapter = entry.draft.chapters.create!(:title => 'Kapitel 1')
-    chapter.pages.create!(:template => 'background_image')
-    chapter.pages.create!(:template => 'background_image')
+    def say_creating_account(account)
+      say("\n-- creating account '#{account.name}'\n\n")
+    end
 
-    chapter = entry.draft.chapters.create!(:title => 'Kapitel 2')
-    chapter.pages.create!(:template => 'video')
+    def say_creating_user(user)
+     say(<<-END)
+   #{user.role} user:
 
-    puts "   Created sample entry."
-  end
+     email:     #{user.email}
+     password:  #{user.password}
 
-  # Sample membership
+END
+    end
 
-  unless Membership.any?
-    membership = Membership.create!(:user => default_account.users.editors.first,
-      :entry => Entry.first)
-    puts "   Created sample membership."
-  end
+    def say_creating_entry(entry)
+      say("   sample entry '#{entry.title}'")
+    end
 
-  # Sample revision
+    def say_creating_membership(membership)
+      say("   membership for user '#{membership.user.email}' and entry '#{membership.entry.title}'")
+    end
 
-  unless Revision.any?
-    revision = Revision.create!(:creator => default_account.users.editors.first,
-      :entry => Entry.first)
-    puts "   Created sample revision."
+    def say(text)
+      puts(text) unless Rails.env.test?
+    end
   end
 end