pageflow-external-links 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzY5MDM5ZmNhYzQyOTU4NjY5NzdkNjBhYTBjODQ2M2ZmYWRiZDNkZA==
+  data.tar.gz: !binary |-
+    YzBjZmE0NjcyMGMwOWNlN2E5ZDEwODlmY2FiOWYzOWI0MmFhZTFiZA==
+SHA512:
+  metadata.gz: !binary |-
+    YjU3NDk3MGE5NGQzNDBlZTQzMWI0MjIzNjYyZGJjZWZlMGZlYWM0YTI0MjI2
+    MTlkM2U1M2NlMjU1NjY4NmIxODdhNzBiMzI4Y2JmYmNkZGVjZTBjODk1MDI4
+    Y2MzYzM3YzE2ZjU4ZjhhODZjNGVjYzBjMTQwOTczYTJjOWM3NTE=
+  data.tar.gz: !binary |-
+    NTY1ODlmYzgzNDZmYTNlMTY1OGNkYWMyZjhhNzkyMGFiMDA3Nzg1YmIyOTBh
+    YjA0MmI4ZTJiMjMwMDU2MWJlNTQ2N2NkNjkzMjQ5ZDkxMTc1ZDcxODlhNTc0
+    N2FhNTQzMjY0OGRmNWY1OTliOTJhNDRiYzJjZDliMDE3NDAwOTU=

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+*.sqlite3
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+log
+Gemfile.lock

data/.jshintignore

@@ -0,0 +1 @@
+vendor/assets/javascripts/**

data/.jshintrc

@@ -0,0 +1,22 @@
+{
+  "browser": true,
+  "undef": true,
+  "immed": true,
+  "trailing": true,
+  "globals": {
+    "jQuery": true,
+    "$": true,
+    "Backbone": true,
+    "Cocktail": true,
+    "_": true,
+    "vjs": true,
+    "Audio5js": true,
+    "I18n": true,
+
+    "pageflow": true,
+    "editor": true,
+    
+    "confirm": true,
+    "alert": true
+  }
+}

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chart.gemspec
+gemspec
+
+# Rails 4 compat
+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.rc2'

data/README.md

@@ -0,0 +1,49 @@
+# Pageflow External Links
+
+Page type to display links to external pages.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+    gem 'pageflow-external-links'
+
+Register the page type inside the configure block in `config/initializers/pageflow.rb`
+
+    Pageflow.configure do |config|
+      config.register_page_type(Pageflow::ExternalLinks::PageType.new)
+    end
+
+Include javascripts and stylesheets:
+
+    # app/assets/javascripts/pageflow/application.js
+    //= require pageflow/external_links
+
+    # app/assets/javascripts/pageflow/editor.js
+    //= require pageflow/external_links/editor
+
+    # app/assets/stylesheets/pageflow/application.scss.css
+    @import "pageflow/external_links";
+
+    # app/assets/stylesheets/pageflow/editor.scss.css
+    @import "pageflow/external_links/editor";
+
+Mount the routes in `config/routes.rb`:
+
+    authenticated do
+      mount Pageflow::ExternalLinks::Engine, :at => '/external_links'
+    end
+
+Install dependencies:
+
+    bundle install
+
+Copy migrations of pageflow-external-links into your project:
+
+    bundle exec rake pageflow_external_links:install:migrations
+
+Migrate the database:
+
+    bundle exec rake db:migrate
+
+Restart the application server.

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascript/pageflow/external_links.js

@@ -0,0 +1,4 @@
+//= require_self
+//= require ./external_links/page_type
+
+pageflow.externalLinks = pageflow.externalLinks || {};

data/app/assets/javascript/pageflow/external_links/editor.js

@@ -0,0 +1,12 @@
+//= require_self
+
+//= require_tree ./editor/models
+//= require_tree ./editor/collections
+//= require_tree ./editor/routers
+//= require_tree ./editor/controllers
+//= require_tree ./editor/templates
+//= require_tree ./editor/views
+
+//= require ./editor/config
+
+pageflow.externalLinks = pageflow.externalLinks || {};

data/app/assets/javascript/pageflow/external_links/editor/collections/site_references_collection.js

@@ -0,0 +1,11 @@
+pageflow.externalLinks.SiteReferencesCollection = Backbone.Collection.extend({
+  model: pageflow.externalLinks.SiteReference,
+
+  comparator: function(chapter) {
+    return chapter.get('position');
+  },
+
+  saveOrder: function() {
+    // no op
+  }
+});

data/app/assets/javascript/pageflow/external_links/editor/collections/sites_collection.js

@@ -0,0 +1,22 @@
+pageflow.externalLinks.SitesCollection = Backbone.Collection.extend({
+  model: pageflow.externalLinks.Site,
+
+  url: function() {
+    return '/external_links/entries/' + pageflow.entry.get('id') + '/sites';
+  },
+
+  getByPermaId: function(permaId) {
+    return this.findWhere({perma_id: permaId});
+  },
+
+  ensureFetched: function(callback) {
+    var collection = this;
+
+    this.fetchedPromise = this.fetchedPromise || new $.Deferred(function(deferred) {
+      collection.once('sync', deferred.resolve);
+      collection.fetch();
+    }).promise();
+
+    return this.fetchedPromise;
+  }
+});

data/app/assets/javascript/pageflow/external_links/editor/config.js

@@ -0,0 +1,17 @@
+pageflow.editor.registerPageConfigurationMixin(pageflow.externalLinks.pageConfigurationMixin);
+
+pageflow.editor.registerSideBarRouting({
+  router: pageflow.externalLinks.SidebarRouter,
+  controller: pageflow.externalLinks.SidebarController
+});
+
+pageflow.editor.registerFileSelectionHandler('externalLinks.site', pageflow.externalLinks.SiteFileSelectionHandler);
+
+pageflow.editor.registerMainMenuItem({
+  translationKey: 'pageflow.external_links.manage_sites',
+  path: '/external_links/sites'
+});
+
+pageflow.editor.addInitializer(function() {
+  pageflow.externalLinks.sites = new pageflow.externalLinks.SitesCollection();
+});

data/app/assets/javascript/pageflow/external_links/editor/controllers/sidebar_controller.js

@@ -0,0 +1,34 @@
+pageflow.externalLinks.SidebarController = Backbone.Marionette.Controller.extend({
+  initialize: function(options) {
+    this.region = options.region;
+  },
+
+  sites: function(pageId) {
+    var page = pageflow.pages.get(pageId);
+    var referer = page ? '/pages/' + page.id + '/links ' : '/';
+
+    this.region.show(new pageflow.BackButtonDecoratorView({
+      referer: referer,
+      view: new pageflow.externalLinks.SitesView({
+        selectionHandler: page && new pageflow.externalLinks.SiteSelectionHandler({
+          page: page
+        }),
+        page: page,
+        referer: referer
+      })
+    }));
+  },
+
+  site: function(id, pageId, returnTo) {
+    var page = pageflow.pages.get(pageId);
+    var region = this.region;
+
+    pageflow.externalLinks.sites.ensureFetched().then(function() {
+      region.show(new pageflow.externalLinks.EditSiteView({
+        model: pageflow.externalLinks.sites.get(id),
+        page: page,
+        returnTo: returnTo
+      }));
+    });
+  }
+});

data/app/assets/javascript/pageflow/external_links/editor/models/configuration_mixin.js

@@ -0,0 +1,38 @@
+pageflow.externalLinks.pageConfigurationMixin = {
+  externalSiteReferences: function() {
+    var configuration = this;
+
+    this._externalSiteReferences = this._externalSiteReferences || create();
+    return this._externalSiteReferences;
+
+    function create() {
+      var collection = new pageflow.externalLinks.SiteReferencesCollection();
+
+      pageflow.externalLinks.sites.ensureFetched().then(function() {
+        collection.add(siteReferenceAttributes());
+
+        configuration.listenTo(collection, 'add remove sort', function() {
+          configuration.set('linked_external_site_perma_ids', _.map(collection.pluck('site'), function(site) {
+            return site.get('perma_id');
+          }));
+        });
+      });
+
+      return collection;
+    }
+
+    function siteReferenceAttributes() {
+      return _.compact(_.map(referencedSitePermaIds(), function(permaId) {
+        var site = pageflow.externalLinks.sites.getByPermaId(permaId);
+
+        return site && {
+          site: site
+        };
+      }));
+    }
+
+    function referencedSitePermaIds() {
+      return configuration.get('linked_external_site_perma_ids') || [];
+    }
+  }
+};

data/app/assets/javascript/pageflow/external_links/editor/models/site.js

@@ -0,0 +1,25 @@
+pageflow.externalLinks.Site = Backbone.Model.extend({
+  modelName: 'site',
+  paramRoot: 'site',
+  i18nKey: 'site',
+
+  mixins: [pageflow.failureTracking, pageflow.transientReferences],
+
+  defaults: {
+    'open_in_new_tab': true
+  },
+
+  initialize: function(attributes, options) {
+    this.listenTo(this, 'change', function() {
+      this.save();
+    });
+  },
+
+  urlRoot: function() {
+    return this.isNew() ? this.collection.url() : '/external_links/sites';
+  },
+
+  getThumbnail: function() {
+    return this.getReference('thumbnail', pageflow.imageFiles);
+  }
+});

data/app/assets/javascript/pageflow/external_links/editor/models/site_file_selection_handler.js

@@ -0,0 +1,13 @@
+pageflow.externalLinks.SiteFileSelectionHandler = function(options) {
+  this.call = function(file) {
+    pageflow.externalLinks.sites.ensureFetched().then(function() {
+      var site = pageflow.externalLinks.sites.get(options.id);
+      site.setReference(options.attributeName, file);
+    });
+  };
+
+  this.getReferer = function() {
+    var query = (options.pageId && options.returnTo) ? '/?page=' + options.pageId + '&return_to=' + options.returnTo : '';
+    return '/external_links/sites/' + options.id + query;
+  };
+};

data/app/assets/javascript/pageflow/external_links/editor/models/site_reference.js

@@ -0,0 +1,7 @@
+pageflow.externalLinks.SiteReference = Backbone.Model.extend({
+  modelName: 'siteReference',
+
+  initialize: function() {
+    this.listenTo(this.get('site'), 'destroy', this.destroy);
+  }
+});

data/app/assets/javascript/pageflow/external_links/editor/models/site_selection_handler.js

@@ -0,0 +1,7 @@
+pageflow.externalLinks.SiteSelectionHandler = function(options) {
+  this.call = function(site) {
+    options.page.configuration.externalSiteReferences().add({
+      site: site
+    });
+  };
+};

data/app/assets/javascript/pageflow/external_links/editor/routers/sidebar_router.js

@@ -0,0 +1,8 @@
+pageflow.externalLinks.SidebarRouter = Backbone.Marionette.AppRouter.extend({
+  appRoutes: {
+    'external_links/sites': 'sites',
+    'external_links/sites?page=:page_id': 'sites',
+    'external_links/sites/:id': 'site',
+    'external_links/sites/:id/?page=:page_id&return_to=:return_to': 'site',
+  }
+});

data/app/assets/javascript/pageflow/external_links/editor/templates/edit_site.jst.ejs

@@ -0,0 +1,10 @@
+<a class="back">Externe Verweise</a>
+<a class="destroy">Löschen</a>
+
+<div class="failure">
+  <p>Beim Speichern des externen Verweises ist ein Problem aufgetreten.</p>
+  <p class="message"></p>
+  <a class="retry" href="">Erneut versuchen</a>
+</div>
+
+<div class="form_container"></div>

data/app/assets/javascript/pageflow/external_links/editor/templates/embedded/list_item.jst.ejs

@@ -0,0 +1,5 @@
+<div class="link-thumbnail"></div>
+<div class="link-details">
+  <p class="link-title"></p>
+  <p class="link-description"></p>
+</div>

data/app/assets/javascript/pageflow/external_links/editor/templates/inputs/site_reference.jst.ejs

@@ -0,0 +1,7 @@
+<label>
+  <span class="name"></span>
+  <span class="inline_help"></span>
+</label>
+<ul class="sites outline"></ul>
+
+<a href="" class="add_reference">Hinzufügen</a>

data/app/assets/javascript/pageflow/external_links/editor/templates/site_item.jst.ejs

@@ -0,0 +1,6 @@
+<a href="">
+  <span class="thumbnail"></span>
+  <span class="title"></span>
+  <span class="failure_icon" title="Beim Speichern der Seite ist ein Fehler aufgetreten." />
+</a>
+<a class="select">Auswählen</a>

data/app/assets/javascript/pageflow/external_links/editor/templates/site_reference_item.jst.ejs

@@ -0,0 +1,6 @@
+<a href="">
+  <span class="thumbnail"></span>
+  <span class="title"></span>
+  <a class="edit" title="Bearbeiten"></a>
+  <a class="remove" title="Löschen"></a>
+</a>

data/app/assets/javascript/pageflow/external_links/editor/templates/sites.jst.ejs

@@ -0,0 +1 @@
+<a class="add" href="">Hinzufügen</a>

data/app/assets/javascript/pageflow/external_links/editor/templates/sites_blank_slate.jst.ejs

@@ -0,0 +1 @@
+<li class="blank_slate">Es wurden noch keine Seiten erstellt.<li>

data/app/assets/javascript/pageflow/external_links/editor/views/configuration_editor.js

@@ -0,0 +1,23 @@
+pageflow.ConfigurationEditorView.register('external_links', {
+  configure: function() {
+    this.tab('general', function() {
+      this.group('general');
+    });
+
+    this.tab('files', function() {
+      this.input('background_image_id', pageflow.FileInputView, {collection: pageflow.imageFiles});
+      this.input('thumbnail_image_id', pageflow.FileInputView, {
+        collection: pageflow.imageFiles,
+        imagePositioning: false
+      });
+    });
+
+    this.tab('links', function() {
+      this.input('linked_external_site_perma_ids', pageflow.externalLinks.SiteReferenceInputView);
+    });
+
+    this.tab('options', function() {
+      this.group('options');
+    });
+  }
+});

data/app/assets/javascript/pageflow/external_links/editor/views/edit_site_view.js

@@ -0,0 +1,69 @@
+pageflow.externalLinks.EditSiteView = Backbone.Marionette.Layout.extend({
+  template: 'pageflow/external_links/editor/templates/edit_site',
+  className: 'edit_external_site',
+
+  mixins: [pageflow.failureIndicatingView],
+
+  regions: {
+    formContainer: '.form_container'
+  },
+
+  ui: {
+    backButton: 'a.back'
+  },
+
+  events: {
+    'click a.back': 'goBack',
+    'click a.destroy': 'destroy',
+  },
+
+  onRender: function() {
+    var options = this.options;
+    var configurationEditor = new pageflow.ConfigurationEditorView({
+      model: this.model
+    });
+
+    configurationEditor.tab('general', function() {
+      this.input('url', pageflow.TextInputView, {
+        required: true
+      });
+      this.input('open_in_new_tab', pageflow.CheckBoxInputView);
+      this.input('thumbnail', pageflow.FileInputView, {
+        collection: pageflow.imageFiles,
+        fileSelectionHandler: 'externalLinks.site',
+        fileSelectionHandlerOptions: {
+          pageId: options.page && options.page.id,
+          returnTo: options.returnTo
+        },
+        imagePositioning: false
+      });
+      this.input('title', pageflow.TextInputView, {
+        required: true
+      });
+      this.input('description', pageflow.TextAreaInputView, {size: 'short'});
+    });
+
+    if (this.options.returnTo === 'page' && this.options.page) {
+      this.ui.backButton.text('Zurück');
+    }
+
+    this.formContainer.show(configurationEditor);
+  },
+
+  destroy: function() {
+    if (confirm("Externen Verweis wirklich löschen?\n\nAlle Benutzungen dieses Verweises auf Seiten werden ebenfalls entfernt. Dieser Schritt kann nicht rückgängig gemacht werden.")) {
+      this.model.destroy();
+      this.goBack();
+    }
+  },
+
+  goBack: function() {
+    if (this.options.returnTo === 'page' && this.options.page) {
+      pageflow.editor.navigate('/pages/' + this.options.page.id + '/links', {trigger: true});
+    }
+    else {
+      var query = this.options.page ? '?page=' + this.options.page.id : '';
+      pageflow.editor.navigate('/external_links/sites' + query, {trigger: true});
+    }
+  }
+});