pageflow 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4f7e93e1fdb9b1a6c4625f17790cd20cf430757
-  data.tar.gz: f9e5c482fbc496bea80d27a92160d123679d0249
+  metadata.gz: a73607737150129fbb7b4aada5619097592844f8
+  data.tar.gz: 9caedfec77d8e308bba2c89a6d9ef65f588c8627
 SHA512:
-  metadata.gz: 1b5741d9d5e09276c7eb3381ba101068e5c18717141102cf6f9de75e8d2022e0a474ac90b54d2b8f1ed41051c722a83d264b753111acb30121071066bf3a3ffc
-  data.tar.gz: 4385c385039d5dacd5abeea0ea3d9b5ddc5381e5b845c5ab0c836bdac2e8334a4ba561e666e86db29b13b3670ae3f482b91b91bb993d708a7dedba626f33808c
+  metadata.gz: a6dcf4e0fe53e80e448a3c9906e323307e856b77a0b763070b1ed915a871cf58a23152e1f25e901cfc0ba0d92e40be8d3a335f0e467520a05d254716764c1ae1
+  data.tar.gz: f30680dae1fcac19f8a50d75080fb311a10c4e46175ccee2c21fa80c7f259962d06ce798b985546ba34121e33210c063feb7203b53373c1ec26c947f243988dc

data/CHANGELOG.md

@@ -1,5 +1,186 @@
 # CHANGELOG
 
+### Version 0.11.0
+
+2016-09-09
+
+[Compare changes](https://github.com/codevise/pageflow/compare/v0.10.0...v0.11.0)
+
+##### Breaking Changes
+
+- Pageflow now depends on Rails 4.2, which is the only version below
+  Rails 5 that still receives security and bug fixes. See the
+  [Upgrading Rails guide](http://guides.rubyonrails.org/upgrading_ruby_on_rails.html)
+  for changes you need to apply to your application.
+  ([#575](https://github.com/codevise/pageflow/pull/575))
+
+- Active Admin/Devise have been updated. The `gem` entries for
+  `activeadmin`, `ransack`, `inherited_resources` and `formtastic`
+  have to be removed. Furthermore, delete the following line from the
+  Pageflow initializer:
+
+        ActiveAdmin.application.load_paths.unshift(Dir[Pageflow::Engine.root.join('admins')])
+
+  Instead insert the following line at the top of the Active Admin
+  initializer:
+
+        ActiveAdmin.application.load_paths.unshift(Pageflow.active_admin_load_path)
+
+  See the
+  [Active Admin changelog](https://github.com/activeadmin/activeadmin/blob/master/CHANGELOG.md)
+  for instructions on how to upgrade the Active Admin initializer.
+  ([#500](https://github.com/codevise/pageflow/pull/500))
+
+- Error pages now live in the `public` directory of the host
+  application. Run the following generator to copy the default error
+  pages to `public/pageflow/error_pages`:
+
+        $ bin/rails generate pageflow:error_pages
+
+  Feel free to change the generated files however you like.
+  ([#572](https://github.com/codevise/pageflow/pull/572))
+
+- The default theme has partly been rewritten. See
+  [the new theme guide](https://github.com/codevise/pageflow/blob/master/doc/creating_themes.md)
+  for instructions on how to build themes that are decoupled from
+  Pageflow implementation details.
+  ([#470](https://github.com/codevise/pageflow/pull/470),
+   [#576](https://github.com/codevise/pageflow/pull/576),
+   [#586](https://github.com/codevise/pageflow/pull/586),
+   [#590](https://github.com/codevise/pageflow/pull/590),
+   [#591](https://github.com/codevise/pageflow/pull/591),
+   [#592](https://github.com/codevise/pageflow/pull/592),
+   [#593](https://github.com/codevise/pageflow/pull/593),
+   [#594](https://github.com/codevise/pageflow/pull/594),
+   [#596](https://github.com/codevise/pageflow/pull/596),
+   [#597](https://github.com/codevise/pageflow/pull/597),
+   [#598](https://github.com/codevise/pageflow/pull/598),
+   [#626](https://github.com/codevise/pageflow/pull/626),
+   [#618](https://github.com/codevise/pageflow/pull/618),
+   [#600](https://github.com/codevise/pageflow/pull/600))
+
+##### Public Site
+
+- Rebrush default theme
+  ([#612](https://github.com/codevise/pageflow/pull/612),
+   [#611](https://github.com/codevise/pageflow/pull/611),
+   [#588](https://github.com/codevise/pageflow/pull/588))
+- Minimalistic player controls
+  ([#558](https://github.com/codevise/pageflow/pull/558))
+- Move share button in mobile navigation to bottom
+  ([#551](https://github.com/codevise/pageflow/pull/551))
+- Scroll to active item in overview item
+  ([#555](https://github.com/codevise/pageflow/pull/555))
+- Improve hide text css
+  ([#541](https://github.com/codevise/pageflow/pull/541))
+- Improve focus outline handling
+  ([#543](https://github.com/codevise/pageflow/pull/543))
+- Increase fastclick compatibility of share menu
+  ([#548](https://github.com/codevise/pageflow/pull/548))
+- Disable atmo on mobile platform
+  ([#554](https://github.com/codevise/pageflow/pull/554))
+- Ensure facebook app does not crop viewport
+  ([#607](https://github.com/codevise/pageflow/pull/607))
+- Apply widget margin to mobile scroll indicator
+  ([#606](https://github.com/codevise/pageflow/pull/606))
+- Bug fix: Fix keyboard access to sub share menu
+  ([#553](https://github.com/codevise/pageflow/pull/553))
+- Bug fix: Do not set video src on video page activate
+  ([#547](https://github.com/codevise/pageflow/pull/547))
+- Bug fix: Prevent native scrolling on multimedia alert
+  ([#550](https://github.com/codevise/pageflow/pull/550))
+- Bug fix: Ensure entry cache is invalidated when theming changes
+  ([#627](https://github.com/codevise/pageflow/pull/627))
+
+##### Admin
+
+- Improve filtering, sorting and pagination of admin tables
+  ([#568](https://github.com/codevise/pageflow/pull/568),
+   [#567](https://github.com/codevise/pageflow/pull/567),
+   [#563](https://github.com/codevise/pageflow/pull/563))
+- Allow setting defaults for meta tags per theming
+  ([#538](https://github.com/codevise/pageflow/pull/538),
+   [#573](https://github.com/codevise/pageflow/pull/573))
+- Improve revisions table on entry admin page
+  ([#619](https://github.com/codevise/pageflow/pull/619))
+
+##### Editor
+
+- Allow specifying custom share url
+  ([#581](https://github.com/codevise/pageflow/pull/581))
+- Add option to hide overview button
+  ([#556](https://github.com/codevise/pageflow/pull/556))
+- Display warning for ie 9 in editor
+  ([#552](https://github.com/codevise/pageflow/pull/552))
+- Bug fix: Prevent scrolling preview while focus in sidebar
+  ([#549](https://github.com/codevise/pageflow/pull/549))
+
+##### Rails Engine
+
+- Update activeadmin to 1.0.pre4
+  ([#617](https://github.com/codevise/pageflow/pull/617),
+   [#610](https://github.com/codevise/pageflow/pull/610))
+- Update sass to 3.4
+  ([#540](https://github.com/codevise/pageflow/pull/540))
+- Switch to cancancan from cancan
+  ([#615](https://github.com/codevise/pageflow/pull/615))
+- Add config option to forbid deleting user account
+  ([#535](https://github.com/codevise/pageflow/pull/535))
+- Encapsulate active admin load path setup
+  ([#570](https://github.com/codevise/pageflow/pull/570))
+- Add off event emitter method to pageflow.hidetext.
+  ([#542](https://github.com/codevise/pageflow/pull/542))
+- Introduce widgets api
+  ([#544](https://github.com/codevise/pageflow/pull/544))
+- Introduce widget margins
+  ([#557](https://github.com/codevise/pageflow/pull/557))
+- Add page css classes for scroller boundary position
+  ([#545](https://github.com/codevise/pageflow/pull/545))
+- Allow overriding logic to determine highlightes page
+  ([#605](https://github.com/codevise/pageflow/pull/605))
+- Theme generator for configurable default theme
+  ([#560](https://github.com/codevise/pageflow/pull/560))
+- Prevent account with entries being deleted
+  ([#599](https://github.com/codevise/pageflow/pull/599))
+- Correct the documentation for js widget types
+  ([#571](https://github.com/codevise/pageflow/pull/571))
+- Update ruby version requirement in readme
+  ([#620](https://github.com/codevise/pageflow/pull/620))
+- Make sliderinputview more configurable
+  ([#602](https://github.com/codevise/pageflow/pull/602))
+- Add classnames to title bar action-items
+  ([#608](https://github.com/codevise/pageflow/pull/608))
+- Add browser agent based detection for ie up to 11
+  ([#601](https://github.com/codevise/pageflow/pull/601))
+
+##### Internals
+
+- Upgrade to rspec 3
+  ([#569](https://github.com/codevise/pageflow/pull/569))
+- Add ruby 2.3.1 to travis file
+  ([#609](https://github.com/codevise/pageflow/pull/609))
+- Use parallel coverall builds
+  ([#614](https://github.com/codevise/pageflow/pull/614))
+- Generator unit tests
+  ([#574](https://github.com/codevise/pageflow/pull/574))
+- Generate theme documentation
+  ([#559](https://github.com/codevise/pageflow/pull/559))
+- Install coveralls test coverage reporter
+  ([#561](https://github.com/codevise/pageflow/pull/561))
+- Import new rubocop default from hound repository
+  ([#580](https://github.com/codevise/pageflow/pull/580))
+- Add scss_lint and rubocop to development dependency
+  ([#625](https://github.com/codevise/pageflow/pull/625))
+- Rename .css.scss files to just .scss
+  ([#613](https://github.com/codevise/pageflow/pull/613))
+- Ignore a few more files
+  ([#565](https://github.com/codevise/pageflow/pull/565))
+- Increase the test coverage
+  ([#603](https://github.com/codevise/pageflow/pull/603),
+   [#604](https://github.com/codevise/pageflow/pull/604))
+- Bug fix: Narrow sprockets-rails version
+  ([#546](https://github.com/codevise/pageflow/pull/546))
+
 ### Version 0.10.0
 
 2016-06-09

data/README.md

@@ -2,15 +2,17 @@
 
 [![Gem Version](https://badge.fury.io/rb/pageflow.svg)](http://badge.fury.io/rb/pageflow)
 [![Build Status](https://travis-ci.org/codevise/pageflow.svg?branch=master)](https://travis-ci.org/codevise/pageflow)
+[![Coverage Status](https://coveralls.io/repos/github/codevise/pageflow/badge.svg?branch=master)](https://coveralls.io/github/codevise/pageflow?branch=master)
+[![Code Climate](https://codeclimate.com/github/codevise/pageflow/badges/gpa.svg)](https://codeclimate.com/github/codevise/pageflow)
 
 Multimedia story telling for the web.
 
 For a high level introduction and example Pageflow stories see
 [pageflow.io](http://pageflow.io).
 
-In addition to this README, there is also a [Getting Started Wiki page](https://github.com/codevise/pageflow/wiki/Getting-Started)
-to guide you through the steps of setting up a Rails application with Pageflow
-on your development machine.
+* [Getting Started](https://github.com/codevise/pageflow/wiki/Getting-Started)
+* [Guides](https://github.com/codevise/pageflow/blob/master/doc/index.md)
+* [Theme Settings](http://codevise.github.io/pageflow/theme/master/)
 
 ## Updating
 
@@ -34,20 +36,19 @@ components:
 Pageflow assumes the following choice of libraries:
 
 * [Devise](https://github.com/plataformatec/devise) for authentication
-* [CanCan](https://github.com/ryanb/cancan) for authorization
+* [CanCanCan](https://github.com/CanCanCommunity/cancancan) for authorization
 * [ActiveAdmin](http://activeadmin.info/) for administration
 * [Resque](https://github.com/resque/resque) for background jobs
 * [FriendlyId](https://github.com/norman/friendly_id) for pretty URLs
 * [Paperclip](https://github.com/thoughtbot/paperclip) for attachment handling
 * [Backbone](http://backbonejs.org/) [Marionette](http://marionettejs.com/) for client side development
 
-
 ## Requirements
 
 Pageflow runs in environments with:
 
-* Ruby >= 1.9.3 and < 2.2.0 because of [ActiveAdmin](https://github.com/activeadmin/activeadmin/issues/3715)
-* Rails 4.0 or 4.1
+* Ruby >= 2.1
+* Rails 4.2
 * Redis server (for Resque)
 * A database server supported by Active Record (tested with MySQL)
 * ImageMagick
@@ -82,17 +83,7 @@ Add this line to your application's Gemfile:
     # Gemfile
     gem 'pageflow'
 
-At the moment, Pageflow depends on a frozen version of Active Admin
-since, back when development started, no Rails 4 compatible version of
-Active Admin was available as a gem. You therefore need to bundle the
-`rails4` branch that we have forked into our github organization:
-
-    # Gemfile
-    gem 'activeadmin', git: 'https://github.com/codevise/active_admin.git', branch: 'rails4'
-    gem 'ransack'
-    gem 'inherited_resources', '1.4.1'
-    gem 'formtastic', '2.3.0'
-    # Only required for Rails 4.1:
+    # Required for Rails 4.1:
     gem 'state_machine', git: 'https://github.com/codevise/state_machine.git'
 
 Run bundler to install dependencies:
@@ -117,12 +108,6 @@ safely read on.
 
 ### Database Migration
 
-_Devise migration name fix_: In some cases, the Devise generator creates
-a migration file without file extension. This needs to be fixed manually
-at the moment:
-
-    $ rename 's/$/.rb/' db/migrate/*_devise_create_users
-
 Now you can migrate the database.
 
     $ rake db:migrate
@@ -155,19 +140,8 @@ application.
 ## Running Pageflow
 
 In addition to the Rails server, you need to start two Rake tasks for
-the background job processing. First, start a Resque worker which handles
-jobs from all queues:
-
-    $ QUEUE=* rake resque:work
-
-Image and video processing are examples of jobs that are executes by these workers.
-
-Some jobs need to be executed repeatedly. For example, while videos are being
-encoded by Zencoder, there is a job that runs every few seconds to fetch the
-current progress. This delayed invocation of jobs is handled by the Resque
-Scheduler Rake task:
-
-     $ QUEUE=* rake resque:scheduler
+the background job processing. These tasks are listed in `Procfile` which
+is generated in the project root folder by the Pageflow installer.
 
 Consider using the [foreman gem](https://github.com/ddollar/foreman) to start all of
 these processes (including the Rails server) with a single command in your

data/admins/pageflow/accounts.rb

@@ -3,14 +3,24 @@ module Pageflow
     menu :priority => 3
 
     config.batch_actions = false
-    config.clear_sidebar_sections!
 
     index do
       column :name do |account|
         link_to account.name, admin_account_path(account)
       end
+      column :entries_count do |account|
+        account.entries_count
+      end
+      column :users_count do |account|
+        account.users_count
+      end
+      column :default_theming do |account|
+        account.default_theming.theme_name
+      end
     end
 
+    filter :name
+
     form :partial => 'form'
 
     show :title => :name do |account|
@@ -25,6 +35,7 @@ module Pageflow
     controller do
       helper Pageflow::Admin::FeaturesHelper
       helper Pageflow::Admin::WidgetsHelper
+      helper Pageflow::Admin::FormHelper
       helper ThemesHelper
 
       def new
@@ -67,6 +78,10 @@ module Pageflow
         result
       end
 
+      def scoped_collection
+        super.includes(:default_theming)
+      end
+
       private
 
       def permitted_account_attributes
@@ -88,7 +103,10 @@ module Pageflow
           :copyright_link_url,
           :copyright_link_label,
           :home_url,
-          :home_button_enabled_by_default
+          :home_button_enabled_by_default,
+          :default_author,
+          :default_publisher,
+          :default_keywords
         ] +
           permitted_attributes_for(:theming)
       end

data/admins/pageflow/entry.rb

@@ -3,36 +3,58 @@ module Pageflow
     menu :priority => 1
 
     config.batch_actions = false
-    config.clear_sidebar_sections!
 
     index do
-      column :title, :sortable => 'title' do |entry|
-        link_to entry.title, admin_entry_path(entry)
+      column class: 'publication_state' do |entry|
+        entry_publication_state_indicator(entry)
       end
-      column I18n.t('pageflow.admin.entries.members'), :class => 'members' do |entry|
+      column :title, sortable: 'title' do |entry|
+        link_to(entry.title, admin_entry_path(entry))
+      end
+      column I18n.t('pageflow.admin.entries.members'), class: 'members' do |entry|
         entry_user_badge_list(entry)
       end
       if authorized?(:read, Account)
-        column :account, :sortable => 'account_id' do |entry|
-          link_to(entry.account.name, admin_account_path(entry.account), :data => {:id => entry.account.id})
+        column :account, sortable: 'account_id' do |entry|
+          link_to(entry.account.name,
+                  admin_account_path(entry.account),
+                  data: {id: entry.account.id})
         end
       end
       column :created_at
-      column :updated_at
-      column :class => 'buttons' do |entry|
+      column :edited_at
+      column :published_at, sortable: 'pageflow_revisions.published_at'
+
+      column class: 'buttons' do |entry|
         if authorized?(:edit, Entry)
-          span(link_to(I18n.t('pageflow.admin.entries.editor'), pageflow.edit_entry_path(entry), :class => 'editor button'))
+          icon_link_to(pageflow.edit_entry_path(entry),
+                       tooltip: I18n.t('pageflow.admin.entries.editor_hint'),
+                       class: 'editor')
         end
-        span(link_to(I18n.t('pageflow.admin.entries.preview'), preview_admin_entry_path(entry), :class => 'preview button'))
+
+        icon_link_to(preview_admin_entry_path(entry),
+                     tooltip: I18n.t('pageflow.admin.entries.preview'),
+                     class: 'preview')
+
         if entry.published?
-          span(link_to(I18n.t('pageflow.admin.entries.show_public'), pretty_entry_url(entry), :class => 'show_public button'))
+          icon_link_to(pretty_entry_url(entry),
+                       tooltip: I18n.t('pageflow.admin.entries.show_public_hint'),
+                       class: 'show_public')
         end
       end
     end
 
+    filter :title
+    filter :account
+    filter :created_at
+    filter :edited_at
+    filter :first_published_at
+    filter :published_revision_published_at, as: :date_range
+    filter :with_publication_state, as: :select, collection: -> { collection_for_entry_publication_states }
+
     sidebar :folders, :only => :index do
       text_node(link_to(I18n.t('pageflow.admin.entries.add_folder'), new_admin_folder_path, :class => 'new'))
-      grouped_folder_list(Folder.accessible_by(Ability.new(current_user), :read),
+      grouped_folder_list(Folder.includes(:account).accessible_by(Ability.new(current_user), :read),
                           :class => authorized?(:manage, Folder) ? 'editable' : nil,
                           :active_id => params[:folder_id],
                           :grouped_by_accounts => authorized?(:read, Account))
@@ -57,26 +79,28 @@ module Pageflow
       f.actions
     end
 
-    action_item :only => :show do
+    action_item(:depublish, only: :show) do
       if authorized?(:publish, Entry) && entry.published?
         button_to(I18n.t('pageflow.admin.entries.depublish'),
                   pageflow.current_entry_revisions_path(entry),
-                  :method => :delete,
-                  :data => {
-                    :rel => 'depublish',
-                    :confirm => I18n.t('pageflow.admin.entries.confirm_depublish')
+                  method: :delete,
+                  form_class: 'action_item depublish',
+                  data: {
+                    rel: 'depublish',
+                    confirm: I18n.t('pageflow.admin.entries.confirm_depublish')
                   })
       end
     end
 
-    action_item :only => :show do
+    action_item(:duplicate, only: :show) do
       if authorized?(:duplicate, entry)
         button_to(I18n.t('pageflow.admin.entries.duplicate'),
                   duplicate_admin_entry_path(entry),
-                  :method => :post,
-                  :data => {
-                    :rel => 'duplicate',
-                    :confirm => I18n.t('pageflow.admin.entries.confirm_duplicate')
+                  method: :post,
+                  form_class: 'action_item duplicate',
+                  data: {
+                    rel: 'duplicate',
+                    confirm: I18n.t('pageflow.admin.entries.confirm_duplicate')
                   })
       end
     end
@@ -114,8 +138,15 @@ module Pageflow
     controller do
       helper FoldersHelper
       helper EntriesHelper
+      helper Pageflow::Admin::EntriesHelper
       helper Pageflow::Admin::FeaturesHelper
       helper Pageflow::Admin::RevisionsHelper
+      helper Pageflow::Admin::FormHelper
+
+      after_build do |entry|
+        entry.account ||= current_user.account
+        entry.theming ||= entry.account.default_theming
+      end
 
       def update
         update! do |success, _|
@@ -124,14 +155,8 @@ module Pageflow
       end
 
       def scoped_collection
-        params.key?(:folder_id) ? super.where(:folder_id => params[:folder_id]) : super
-      end
-
-      def build_new_resource
-        super.tap do |entry|
-          entry.account ||= current_user.account
-          entry.theming ||= entry.account.default_theming
-        end
+        result = super.includes(:theming, :account, :users, :published_revision).references(:published_revision)
+        params.key?(:folder_id) ? result.where(folder_id: params[:folder_id]) : result
       end
 
       def permitted_params