pageflow 0.1.0 → 0.2.0

data/db/migrate/20140624135423_remove_attributes_from_themes.rb

@@ -0,0 +1,10 @@
+class RemoveAttributesFromThemes < ActiveRecord::Migration
+  def change
+    remove_column :pageflow_themes, :copyright_link_url, :string
+    remove_column :pageflow_themes, :copyright_link_label, :string
+    remove_column :pageflow_themes, :imprint_link_url, :string
+    remove_column :pageflow_themes, :imprint_link_label, :string
+
+    rename_column :pageflow_themes, :name, :css_dir
+  end
+end

data/db/migrate/20140624135424_create_accounts_themes_join_table.rb

@@ -0,0 +1,8 @@
+class CreateAccountsThemesJoinTable < ActiveRecord::Migration
+  def change
+    create_table :pageflow_accounts_themes, id: false do |t|
+      t.belongs_to :account
+      t.belongs_to :theme
+    end
+  end
+end

data/db/migrate/20140624135425_move_cname_from_account_to_theming.rb

@@ -0,0 +1,21 @@
+class MoveCnameFromAccountToTheming < ActiveRecord::Migration
+  def up
+    add_column :pageflow_themings, :cname, :string, null: false, default: ''
+    add_index :pageflow_themings, :cname
+
+    execute("UPDATE pageflow_themings SET cname = (SELECT cname FROM pageflow_accounts WHERE pageflow_accounts.default_theming_id = pageflow_themings.id LIMIT 1);")
+
+    remove_index :pageflow_accounts, :cname
+    remove_column :pageflow_accounts, :cname
+  end
+
+  def down
+    add_column :pageflow_accounts, :cname, :string, null: false, default: ''
+    add_index :pageflow_accounts, :cname
+
+    execute("UPDATE pageflow_accounts SET cname = (SELECT cname FROM pageflow_themings WHERE pageflow_themings.id = pageflow_accounts.default_theming_id);")
+
+    remove_index :pageflow_themings, :cname
+    remove_column :pageflow_themings, :cname
+  end
+end

data/db/migrate/20140625184800_drop_themes.rb

@@ -0,0 +1,14 @@
+class DropThemes < ActiveRecord::Migration
+  def up
+    rename_column :pageflow_accounts_themes, :theme_id, :theme_name
+    add_column :pageflow_themings, :theme_name, :string
+
+    execute(<<-SQL)
+      UPDATE pageflow_themings SET theme_name =
+        (SELECT css_dir FROM pageflow_themes WHERE pageflow_themes.id = pageflow_themings.theme_id);
+    SQL
+
+    remove_reference :pageflow_themings, :theme
+    drop_table :pageflow_themes
+  end
+end

data/db/migrate/20140704110631_add_confirmed_by_to_encoded_files.rb

@@ -0,0 +1,6 @@
+class AddConfirmedByToEncodedFiles < ActiveRecord::Migration
+  def change
+    add_reference :pageflow_video_files, :confirmed_by
+    add_reference :pageflow_audio_files, :confirmed_by
+  end
+end

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

@@ -15,6 +15,15 @@ Pageflow.configure do |config|
   config.register_page_type(Pageflow::BuiltInPageType.internal_links)
   # config.register_page_type(Pageflow::Rainbow::PageType.new)
 
+  # Add custom themes by invoking the pageflow:theme generator and
+  # registering the theme here.
+  #
+  #     $ rails generate pageflow:theme my_custom_theme
+  #     => creates app/assets/stylesheets/pageflow/themes/my_custom_theme.css.scss
+  #
+  config.themes.register(:default)
+  # config.themes.register(:my_custom_theme)
+
   # String to interpolate into paths of files generated by paperclip
   # preprocessors. This allows to refresh cdn caches after
   # reprocessing attachments.

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

@@ -0,0 +1,28 @@
+module Pageflow
+  module Generators
+    class ThemeGenerator < Rails::Generators::Base
+      desc 'Copies a theme template to the app.'
+
+      argument :name, required: false, default: 'custom',
+               desc: 'The scope to copy views to'
+
+      source_root File.expand_path("../../../../../app/assets", __FILE__)
+
+      def copy_template
+        directory('stylesheets/pageflow/themes/default', themes_path('stylesheets', name))
+        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
+      end
+
+      private
+
+      def themes_path(type, path)
+        File.join('app', 'assets', type, 'pageflow', 'themes', path)
+      end
+    end
+  end
+end

data/lib/pageflow.rb

@@ -1,8 +1,14 @@
 require "pageflow/engine"
 
 module Pageflow
-  def self.config
-    raise('Pageflow has not been configured yet') unless @config
+  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
 
@@ -28,6 +34,7 @@ module Pageflow
 
   def self.finalize!
     @finalized = true
+    configure!
   end
 
   def self.after_configure(&block)

data/lib/pageflow/ability_mixin.rb

@@ -9,7 +9,7 @@ module Pageflow
 
       can [:read, :use_files], Entry, :id => user.entry_ids
 
-      can [:edit, :update, :edit_outline, :publish, :restore, :snapshot], Entry do |entry|
+      can [:edit, :update, :edit_outline, :publish, :restore, :snapshot, :confirm_encoding], Entry do |entry|
         can_edit_entry?(user, entry)
       end
 

data/lib/pageflow/built_in_page_type.rb

@@ -12,7 +12,7 @@ module Pageflow
     end
 
     def translation_key
-      "activerecord.values.page.template.#{name}"
+      "activerecord.values.pageflow/page.template.#{name}"
     end
 
     # Factory methods to decouple Pageflow initializers from concrete

data/lib/pageflow/configuration.rb

@@ -43,8 +43,50 @@ module Pageflow
     attr_reader :hooks
 
     # Limit the use of certain resources. Any object implementing the
-    # interface of Pageflow::Quota is allowed.
-    attr_accessor :quota
+    # interface of Pageflow::Quota can be registered.
+    #
+    # Example:
+    #
+    #     config.quotas.register(:users, UserQuota)
+    #
+    attr_accessor :quotas
+
+    # Additional themes can be registered to use custom css.
+    #
+    # Example:
+    #
+    #     config.themes.register(:custom)
+    #
+    # @return [Themes]
+    attr_reader :themes
+
+    # Either a lambda or an object with a `match?` method, to restrict
+    # access to the editor routes defined by Pageflow.
+    #
+    # This can be used if published entries shall be available under
+    # different CNAMES but the admin and the editor shall only be
+    # 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::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
+    # available entries by hostname or other request attributes.
+    #
+    # Example:
+    #
+    #     # Only make entries of one account available under <account.name>.example.com
+    #     config.public_entry_request_scope = lambda do |entries, request|
+    #       entries.includes(:account).where(pageflow_accounts: {name: request.subdomain})
+    #     end
+    attr_accessor :public_entry_request_scope
+
+    # Submit video/audio encoding jobs only after the user has
+    # explicitly confirmed in the editor. Defaults to false.
+    attr_accessor :confirm_encoding_jobs
 
     def initialize
       @paperclip_filesystem_default_options = {}
@@ -55,11 +97,12 @@ module Pageflow
       @mailer_sender = 'pageflow@example.com'
 
       @hooks = Hooks.new
-      @quota = Quota::Unlimited.new
-    end
+      @quotas = Quotas.new
+      @themes = Themes.new
+
+      @public_entry_request_scope = lambda { |entries, request| entries }
 
-    def on(*args)
-      hooks.on(*args)
+      @confirm_encoding_jobs = false
     end
 
     # Make a page type available for use in the system.

data/lib/pageflow/engine.rb

@@ -51,15 +51,25 @@ module Pageflow
     # provided by the main app.
     config.assets.precompile += %w(pageflow/editor.js pageflow/editor.css
                                    pageflow/print_view.css
-                                   pageflow/themes/default.css
                                    pageflow/lt_ie9.js pageflow/lt_ie9.css pageflow/ie9.js pageflow/ie9.css
                                    video-js.swf vjs.eot vjs.svg vjs.ttf vjs.woff)
 
+    config.assets.precompile << lambda do |path|
+      Pageflow.config.themes.any? do |theme|
+        path == theme.stylesheet_path
+      end
+    end
+
     # Make sure the configuration is recreated when classes are
     # reloded. Otherwise registered page types might still point to
     # unloaded classes in development mode.
     config.to_prepare do
       Pageflow.configure!
     end
+
+    # Make pageflow factories available to main app specs
+    initializer "pageflow.factories", :after => "factory_girl.set_factory_paths" do
+      FactoryGirl.definition_file_paths.unshift(Engine.root.join('spec', 'factories')) if defined?(FactoryGirl)
+    end
   end
 end

data/lib/pageflow/quota.rb

@@ -1,33 +1,60 @@
 module Pageflow
-  module Quota
-    class ExceededError < RuntimeError
-      attr_reader :quota_name
+  class Quota
+    class ExhaustedError < RuntimeError
+      attr_reader :quota
 
-      def initialize(quota_name)
-        @quota_name = quota_name
+      def initialize(quota)
+        @quota = quota
       end
     end
 
-    def exceeded?(name, account)
-      raise(NotImplementedError, 'Quota#exceeded? must be implemented.')
+    class ExceededError < ExhaustedError; end
+
+    attr_reader :name, :account
+
+    def initialize(name, account)
+      @name = name
+      @account = account
+    end
+
+    def state
+      raise(NotImplementedError, 'Quota#state must be implemented and return either "available", "exhausted" or "exceeded".')
     end
 
-    def state_description(name, account)
+    def state_description
       raise(NotImplementedError, 'Quota#state_description must be implemented.')
     end
 
-    def verify!(name, account)
-      raise(ExceededError.new(name), "Quota #{name} exceeded.") if exceeded?(name, account)
+    def available?
+      state == 'available'
     end
 
-    class Unlimited
-      include Quota
+    def exhausted?
+      !available?
+    end
+
+    def exceeded?
+      state == 'exceeded'
+    end
+
+    def verify_available!
+      raise(ExhaustedError.new(self), "Quota '#{name}' exhausted.") unless available?
+    end
+
+    def verify_not_exceeded!
+      raise(ExceededError.new(self), "Quota '#{name}' exceeded.") if exceeded?
+    end
+
+    def assume(assumptions)
+      self
+    end
 
-      def exceeded?(name, account)
-        false
+    class Unlimited < Quota
+      def state
+        'available'
       end
 
-      def state_description(name, account)
+      def state_description
         nil
       end
     end

data/lib/pageflow/quotas.rb

@@ -0,0 +1,15 @@
+module Pageflow
+  class Quotas
+    def initialize
+      @factories = HashWithIndifferentAccess.new
+    end
+
+    def register(name, factory)
+      @factories[name] = factory
+    end
+
+    def get(name, account)
+      @factories.fetch(name, Quota::Unlimited).new(name, account)
+    end
+  end
+end

data/lib/pageflow/seeds.rb

@@ -3,25 +3,21 @@
 module Pageflow
   # Default Account
 
-  if Theme.any?
-    default_theme = Theme.first
-    puts "   Theme exists."
-  else
-    default_theme = Theme.create!(:name => 'default',
-      :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')
-    puts "   Created theme."
-  end
-
-  # Default Account
-
   if Account.any?
     default_account = Account.first
     puts "   Account exists."
   else
-    default_account = Account.create!(:name => 'Pageflow', :default_theme_id => default_theme.id)
+    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'
+      end
+    end
+
     puts "   Created default account."
   end
 
@@ -64,7 +60,7 @@ module Pageflow
   # Sample entry
 
   unless Entry.any?
-    entry = default_account.entries.create!(:title => 'Fiese Flut', :theme_id => default_theme.id)
+    entry = default_account.entries.create!(:title => 'Fiese Flut', :theming_id => default_account.default_theming.id)
 
     chapter = entry.draft.chapters.create!(:title => 'Kapitel 1')
     chapter.pages.create!(:template => 'background_image')

data/lib/pageflow/theme.rb

@@ -0,0 +1,14 @@
+module Pageflow
+  class Theme
+    attr_reader :name, :directory_name
+
+    def initialize(name)
+      @name = name.to_s
+      @directory_name = name.to_s
+    end
+
+    def stylesheet_path
+      "pageflow/themes/#{name}.css"
+    end
+  end
+end

data/lib/pageflow/themes.rb

@@ -0,0 +1,25 @@
+module Pageflow
+  class Themes
+    include Enumerable
+
+    def initialize
+      @themes = HashWithIndifferentAccess.new
+    end
+
+    def register(name)
+      @themes[name] = Theme.new(name)
+    end
+
+    def get(name)
+      @themes.fetch(name) { raise(ArgumentError, "Unknown theme '#{name}'.") }
+    end
+
+    def names
+      map(&:name)
+    end
+
+    def each(&block)
+      @themes.values.each(&block)
+    end
+  end
+end

data/lib/pageflow/user_mixin.rb

@@ -14,7 +14,7 @@ module Pageflow
       has_many :memberships, :dependent => :destroy, :class_name => 'Pageflow::Membership'
       has_many :entries, :through => :memberships, :class_name => 'Pageflow::Entry'
 
-      has_many :revisions, :class_name => 'Pageflow::Revision'
+      has_many :revisions, :class_name => 'Pageflow::Revision', :foreign_key => :creator_id
 
       validates :first_name, :last_name, :presence => true
       validates :role, :inclusion => ROLES