pageflow 0.0.1

data/lib/generators/pageflow/install/install_generator.rb

@@ -0,0 +1,26 @@
+module Pageflow
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      desc "Installs Pageflow and generates the necessary migrations."
+
+      def generate_all
+        generate 'active_admin:install User --skip-users'
+        generate 'active_admin:devise User'
+        generate 'friendly_id'
+
+        invoke 'pageflow:cancan'
+        invoke 'pageflow:resque'
+
+        invoke 'pageflow:assets'
+        invoke 'pageflow:initializer'
+        invoke 'pageflow:routes'
+        invoke 'pageflow:user'
+        invoke 'pageflow:seeds'
+        invoke 'pageflow:active_admin_menu'
+
+        rake 'pageflow:install:migrations'
+      end
+    end
+  end
+end

data/lib/generators/pageflow/resque/resque_generator.rb

@@ -0,0 +1,17 @@
+module Pageflow
+  module Generators
+    class ResqueGenerator < Rails::Generators::Base
+      desc "Configure resque for pageflow."
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_initializers
+        template 'resque.rb', 'config/initializers/resque.rb'
+        template 'resque_mailer.rb', 'config/initializers/resque_mailer.rb'
+        template 'resque_logger.rb', 'config/initializers/resque_logger.rb'
+        template 'resque_enqueue_after_commit_patch.rb', 'config/initializers/resque_enqueue_after_commit_patch.rb'
+        template 'devise_async.rb', 'config/initializers/devise_async.rb'
+      end
+    end
+  end
+end

data/lib/generators/pageflow/resque/templates/devise_async.rb

@@ -0,0 +1,6 @@
+# Deliver devise mails inside resque jobs.
+
+require 'devise/async'
+
+Devise::Async.enabled = Rails.env.production?
+Devise::Async.backend = :resque

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

@@ -0,0 +1,4 @@
+# Change to use your favorite method of configuration. Consider the
+# dotenv gem to setup your environment with a .env file.
+
+Resque.redis = ENV.fetch('REDIS_URL', 'localhost:6379')

data/lib/generators/pageflow/resque/templates/resque_enqueue_after_commit_patch.rb

@@ -0,0 +1,25 @@
+# Make sure no jobs are enqueued from a rolled back
+# transaction. Pageflow mainly triggers jobs in conjunction with state
+# machine transitions. So this patch ensures state db state and
+# enqueued jobs stay in sync.
+#
+# Note the after_transaction yields immediately if there is no open
+# transcation.
+
+require 'ar_after_transaction'
+require 'resque'
+
+Resque.class_eval do
+  class << self
+    alias_method :enqueue_without_transaction, :enqueue
+    def enqueue(*args)
+      if Resque.inline?
+        enqueue_without_transaction(*args)
+      else
+        ActiveRecord::Base.after_transaction do
+          enqueue_without_transaction(*args)
+        end
+      end
+    end
+  end
+end

data/lib/generators/pageflow/resque/templates/resque_logger.rb

@@ -0,0 +1,16 @@
+# resque-logger is required by the state_machine_job gem to write
+# debug output to logs files. Each queue has its own log file in the
+# directory specified below.
+
+require 'fileutils'
+
+log_dir = Rails.root.join('log', 'jobs', Rails.env)
+FileUtils.mkdir_p(log_dir)
+
+Resque.logger_config = {
+  folder: log_dir,
+  class_name: Logger,
+  class_args: [ 'daily', 1.kilobyte ],
+  level:      Logger::INFO,
+  formatter:  Logger::Formatter.new
+}

data/lib/generators/pageflow/resque/templates/resque_mailer.rb

@@ -0,0 +1,4 @@
+# Used by pageflow's own mailers to perform mail delivery inside
+# resque jobs.
+
+Resque::Mailer.excluded_environments = [:development, :test]

data/lib/generators/pageflow/routes/routes_generator.rb

@@ -0,0 +1,13 @@
+module Pageflow
+  module Generators
+    class RoutesGenerator < Rails::Generators::Base
+      desc "Injects the pageflow mount call into config/routes.rb"
+
+      def add_route
+        inject_into_file 'config/routes.rb', after: "  ActiveAdmin.routes(self)\n" do
+          "  Pageflow.routes(self)\n"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Pageflow
+  module Generators
+    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
+      end
+    end
+  end
+end

data/lib/generators/pageflow/user/user_generator.rb

@@ -0,0 +1,13 @@
+module Pageflow
+  module Generators
+    class UserGenerator < Rails::Generators::Base
+      desc "Injects the Pageflow::User mixin into the User class."
+
+      def include_mixin
+        inject_into_file 'app/models/user.rb', before: /end$/ do
+          "\n  include Pageflow::UserMixin\n"
+        end
+      end
+    end
+  end
+end

data/lib/pageflow.rb

@@ -0,0 +1,53 @@
+require "pageflow/engine"
+
+module Pageflow
+  def self.config
+    raise('Pageflow has not been configured yet') unless @config
+    @config
+  end
+
+  def self.configure(&block)
+    @configure_blocks ||= []
+    @configure_blocks << block
+  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
+  end
+
+  def self.finalize!
+    @finalized = true
+  end
+
+  def self.after_configure(&block)
+    @after_configure_blocks ||= []
+    @after_configure_blocks << block
+  end
+
+  def self.routes(router)
+    router.instance_eval do
+      namespace :admin do
+        resources :users do
+          resources :memberships
+        end
+
+        resources :entries do
+          resources :memberships
+        end
+      end
+
+      mount Pageflow::Engine, at: '/'
+    end
+  end
+end

data/lib/pageflow/ability_mixin.rb

@@ -0,0 +1,91 @@
+module Pageflow
+  # Defines the default abilities for the Pageflow models.
+  module AbilityMixin
+    # Call this in the ability initializer.
+    def pageflow_default_abilities(user)
+      return if user.nil?
+
+      can :read, Folder, :id => user.entries.map(&:folder_id)
+
+      can [:read, :use_files], Entry, :id => user.entry_ids
+
+      can [:edit, :update, :edit_outline, :publish, :restore, :snapshot], Entry do |entry|
+        can_edit_entry?(user, entry)
+      end
+
+      can :manage, Chapter do |record|
+        can_edit_entry?(user, record.entry)
+      end
+
+      can :manage, [ImageFile, VideoFile, AudioFile] do |record|
+        can_edit_any_entry_using_file?(user, record)
+      end
+
+      can :manage, Page do |page|
+        can_edit_entry?(user, page.chapter.entry)
+      end
+
+      can :manage, Revision do |revision|
+        can_edit_entry?(user, revision.entry)
+      end
+
+      if user.admin?
+        can [:read, :create, :update], Account
+        can :destroy, Account do |account|
+          account.users.empty? && account.entries.empty?
+        end
+
+        can :manage, ::User
+
+        can :destroy, Membership
+        can :create, Membership do |membership|
+          membership.entry.nil? ||
+            membership.user.nil? ||
+            membership.entry.account == membership.user.account
+        end
+
+        can :manage, Folder
+        can :manage, [Entry, Revision]
+        can :manage, [Chapter, Page]
+        can :manage, [ImageFile, VideoFile, AudioFile]
+
+        can :manage, Resque
+      elsif user.account_manager?
+        can :manage, Folder, :account_id => user.account.id
+        can :manage, Entry, :account_id => user.account.id
+        can :manage, ::User, :account_id => user.account.id
+        can :manage, Revision, :entry => {:account_id => user.account.id}
+
+        can :destroy, Membership, :entry => {:account_id => user.account.id}
+        can :destroy, Membership, :user => {:account_id => user.account.id}
+
+        can :create, Membership do |membership|
+          (membership.entry.nil? || membership.entry.account == user.account) &&
+            (membership.user.nil? || membership.user.account == user.account)
+        end
+      end
+    end
+
+    private
+
+    def can_edit_entry?(user, entry)
+      user.entries.include?(entry) || account_manager_of_entries_account?(user, entry)
+    end
+
+    def account_manager_of_entries_account?(user, entry)
+      user.account_manager? && entry.account_id == user.account_id
+    end
+
+    def can_edit_any_entry_using_file?(user, file)
+      member_of_any_entry_using_file?(user, file) || account_manager_of_account_using_file?(user, file)
+    end
+
+    def member_of_any_entry_using_file?(user, file)
+      (user.entry_ids & file.using_entry_ids).any?
+    end
+
+    def account_manager_of_account_using_file?(user, file)
+      user.account_manager? && file.using_account_ids.include?(user.account_id)
+    end
+  end
+end

data/lib/pageflow/built_in_page_type.rb

@@ -0,0 +1,42 @@
+module Pageflow
+  # Definition of page type located inside the Pageflow gem.
+  class BuiltInPageType < PageType
+    attr_reader :name
+
+    def initialize(name)
+      @name = name.to_s
+    end
+
+    def template_path
+      File.join('pageflow', 'pages', 'templates', "_#{name}.html.erb")
+    end
+
+    def translation_key
+      "activerecord.values.page.template.#{name}"
+    end
+
+    # Factory methods to decouple Pageflow initializers from concrete
+    # page type classes, so we might decide later to create a
+    # VideoPageType subclass etc.
+
+    def self.audio
+      new('audio')
+    end
+
+    def self.background_image
+      new('background_image')
+    end
+
+    def self.background_video
+      new('background_video')
+    end
+
+    def self.internal_links
+      new('internal_links')
+    end
+
+    def self.video
+      new('video')
+    end
+  end
+end

data/lib/pageflow/configuration.rb

@@ -0,0 +1,59 @@
+module Pageflow
+  # Options to be defined in the pageflow initializer of the main app.
+  class Configuration
+    # Default options for paperclip attachments which are supposed to
+    # use filesystem storage.
+    attr_accessor :paperclip_filesystem_default_options
+
+    # Default options for paperclip attachments which are supposed to use
+    # s3 storage.
+    attr_accessor :paperclip_s3_default_options
+
+    # String to interpolate into paths of files generated by paperclip
+    # preprocessors. This allows to refresh cdn caches after
+    # reprocessing attachments.
+    attr_accessor :paperclip_attachments_version
+
+    # Path to the location in the filesystem where attachments shall
+    # be stored. The value of this option is available via the
+    # pageflow_filesystem_root paperclip interpolation.
+    attr_accessor :paperclip_filesystem_root
+
+    # Refer to the pageflow initializer template for a list of
+    # supported options.
+    attr_accessor :zencoder_options
+
+    # A constraint used by the pageflow engine to restrict access to
+    # the editor related HTTP end points. This can be used to ensure
+    # the editor is only accessable via a certain host when different
+    # CNAMES are used to access the public end points of pageflow.
+    attr_accessor :editor_route_constraint
+
+    def initialize
+      @paperclip_filesystem_default_options = {}
+      @paperclip_s3_default_options = {}
+
+      @zencoder_options = {}
+    end
+
+    # Make a page type available for use in the system.
+    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)
+    end
+  end
+end

data/lib/pageflow/engine.rb

@@ -0,0 +1,57 @@
+require 'state_machine'
+require 'state_machine_job'
+require 'paperclip'
+require 'aws-sdk'
+require 'friendly_id'
+require 'devise'
+require 'cancan'
+require 'jbuilder'
+
+require 'resque_mailer'
+require 'resque_scheduler'
+
+require 'active_admin'
+require 'active_admin/patches/views/attributes_table'
+require 'active_admin/patches/views/table_for'
+
+require 'jquery-layout-rails'
+require 'videojs_rails'
+require 'backbone-rails'
+require 'marionette-rails'
+require 'jquery-fileupload-rails'
+require 'wysihtml5-rails'
+require 'i18n-js'
+
+module Pageflow
+  # Rails integration
+  class Engine < ::Rails::Engine
+    isolate_namespace Pageflow
+
+    config.autoload_paths << File.join(config.root, 'lib')
+
+    config.i18n.load_path += Dir[config.root.join('config', 'locales', '**', '*.yml').to_s]
+    config.i18n.default_locale = :de
+
+    # Supress deprecation warning. This is the future default value of the option.
+    I18n.config.enforce_available_locales = true
+
+    # FORCE RAILS TO MAKE I18N AVAILABLE TO ACTIVE ADMIN
+    config.before_configuration do
+      I18n.load_path += Dir[Engine.root.join('config', 'locales', '**', '*.yml').to_s]
+      I18n.locale = :de
+      I18n.default_locale = :de
+      config.i18n.load_path += Dir[Engine.root.join('config', 'locales', '**', '*.yml').to_s]
+      config.i18n.locale = :de
+      # bypasses rails bug with i18n in production
+      I18n.reload!
+      config.i18n.reload!
+    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
+  end
+end