pageflow-internal-links 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTYxZDcyYmRmMGViYjdlZGMxMzFkNTJmOGI1MmI1ZjQ1ODM3M2QxNQ==
+  data.tar.gz: !binary |-
+    Y2NkMzU4OTliNzRiNWU2MmE3MTg0ZTcxOWRmZTk1ZDQyYzgwOGQ3Zg==
+SHA512:
+  metadata.gz: !binary |-
+    ZDQ2NWFmOGUyMGMzMWUyNGYzYTNmODE4YzgwYjk4NDYwYmNhN2Y2YTdhYjg4
+    Mjg1ZmVlNzFiNTQxMzYyODZjMzIyOWU5MWM4MTIwZmRjNGU4YjBhYzgzMDNj
+    MTg0ZGQ4ZjZkNDJhNjZlYjFkN2UwYzg1YzM5ZTM4ZmQ4MzU4NDY=
+  data.tar.gz: !binary |-
+    OTQ0YTZlY2MyMTJiMDJiNDczMWIwYTNlYjU0NTVjZTI1MjBjMTdkNDgyMWE0
+    YWU4N2M3ZmJhNjJhYjQyNzNmYTBkMjJjMTVlOTJkMTBiZmJmZTg0ZWI1NGI3
+    ZWVhZmM1NGNlZTU0Y2JhYzdiMDE2YWIzZDAzYzRiZjg0MzQ1YjM=

data/.gitignore

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

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/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+### Version 0.1.0
+
+2015-10-23
+
+Initial release.

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,63 @@
+# Pageflow Internal Links
+
+[![Gem Version](https://badge.fury.io/rb/pageflow-internal-links.svg)](http://badge.fury.io/rb/pageflow-internal-links)
+
+Page types for linking to pages inside a Pageflow.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    # Gemfile
+    gem 'pageflow-internal-links'
+
+Register the page types:
+
+    # config/initializers/pageflow.rb
+    Pageflow.configure do |config|
+      config.page_types.register(Pageflow::InternalLinks.grid_page_type)
+    end
+
+Include javascripts and stylesheets:
+
+    # app/assets/javascripts/pageflow/application.js
+    //= require pageflow/internal_links
+
+    # app/assets/javascripts/pageflow/editor.js
+    //= require pageflow/internal_links/editor
+
+    # app/assets/stylesheets/pageflow/application.css.scss
+    @import "pageflow/internal_links";
+
+    # app/assets/stylesheets/pageflow/editor.css.scss
+    @import "pageflow/internal_links/editor";
+
+Install dependencies:
+
+    bundle install
+
+Copy migrations of pageflow-internal-links into your project:
+
+    bundle exec rake pageflow_internal_links:install:migrations
+
+Migrate the database:
+
+    bundle exec rake db:migrate
+
+Restart the application server.
+
+## Troubleshooting
+
+If you run into problems while installing the page type, please also
+refer to the
+[Troubleshooting](https://github.com/codevise/pageflow/wiki/Troubleshooting)
+wiki page in the
+[Pageflow repository](https://github.com/codevise/pageflow). If that
+doesn't help, consider
+[filing an issue](https://github.com/codevise/pageflow-internal-links/issues).
+
+## Contributing Locales
+
+Edit the translations directly on the
+[pageflow-internal-links](http://www.localeapp.com/projects/public?search=tf/pageflow-internal-links)
+locale project.

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/javascripts/pageflow/internal_links/editor/collections/grid_page_links_collection.js

@@ -0,0 +1,20 @@
+//= require ./page_links_collection
+
+pageflow.internalLinks.GridPageLinksCollection = pageflow.internalLinks.PageLinksCollection.extend({
+  canAddLink: function() {
+    return this.defaultPosition() !== undefined;
+  },
+
+  defaultPosition: function() {
+    var collection = this;
+
+    return _.chain(25)
+      .times(function(index) {
+        return index;
+      })
+      .find(function(position) {
+        return !collection.findWhere({position: position});
+      })
+      .value();
+  }
+});

data/app/assets/javascripts/pageflow/internal_links/editor/collections/list_page_links_collection.js

@@ -0,0 +1,12 @@
+//= require ./page_links_collection
+
+pageflow.internalLinks.ListPageLinksCollection = pageflow.internalLinks.PageLinksCollection.extend({
+  defaultPosition: function() {
+    return Math.max(0, _.max(this.map(function(pageLink) {
+      return pageLink.get('position');
+    }))) + 1;
+  },
+
+  saveOrder: function() {
+  }
+});

data/app/assets/javascripts/pageflow/internal_links/editor/collections/page_links_collection.js

@@ -0,0 +1,90 @@
+pageflow.internalLinks.PageLinksCollection = Backbone.Collection.extend({
+  model: pageflow.internalLinks.PageLink,
+
+  comparator: 'position',
+
+  initialize: function(models, options) {
+    this.configuration = options.configuration;
+    this.page = options.configuration.page;
+
+    this.load();
+
+    this.listenTo(this, 'add remove change', this.save);
+    this.listenTo(this.configuration, 'change:internal_links', this.load);
+  },
+
+  addLink: function(targetPageId) {
+    this.addWithPosition(this.defaultPosition(), targetPageId);
+  },
+
+  canAddLink: function(targetPageId) {
+    return true;
+  },
+
+  updateLink: function(link, targetPageId) {
+    link.set('target_page_id', targetPageId);
+  },
+
+  removeLink: function(link) {
+    this.remove(link);
+  },
+
+  addWithPosition: function(position, targetPageId) {
+    this.add(this.pageLinkAttributes(position, targetPageId));
+  },
+
+  removeByPosition: function(position) {
+    this.remove(this.findByPosition(position));
+  },
+
+  findByPosition: function(position) {
+    return this.findWhere({position: position});
+  },
+
+  load: function() {
+    this.set(this.pageLinksAttributes() ||
+             this.legacyPageLinksAttributes());
+  },
+
+  save: function(referenceKey, pageId) {
+    this.configuration.set('internal_links', this.map(function(pageLink) {
+      return pageLink.toSerializedJSON();
+    }));
+  },
+
+  pageLinksAttributes: function() {
+    if (this.configuration.has('internal_links')) {
+      return this.configuration.get('internal_links') || [];
+    }
+  },
+
+  legacyPageLinksAttributes: function() {
+    return _(this.configuration.get('linked_page_ids') || {}).reduce(function(result, pageId, position) {
+      var page = pageflow.pages.getByPermaId(pageId);
+
+      if (page) {
+        result.push(this.pageLinkAttributes(parseInt(position, 10) - 1,
+                                            pageId,
+                                            this.configuration.page.id + ':' + position));
+      }
+
+      return result;
+    }, [], this);
+  },
+
+  pageLinkAttributes: function(position, targetPageId, id) {
+    return {
+      id: id || this.getUniqueId(),
+      target_page_id: targetPageId,
+      position: position
+    };
+  },
+
+  getUniqueId: function() {
+    var maxId = Math.max(0, _.max(this.map(function(pageLink) {
+      return parseInt(pageLink.id.split(':').pop(), 10);
+    })));
+
+    return this.configuration.page.id + ':' + (maxId + 1);
+  }
+});

data/app/assets/javascripts/pageflow/internal_links/editor/config.js

@@ -0,0 +1,45 @@
+pageflow.editor.pageTypes.register('internal_links_grid', {
+  configurationEditorView: pageflow.internalLinks.GridConfigurationEditorView,
+
+  embeddedViews: {
+    'nav li': {
+      view: pageflow.internalLinks.GridItemEmbeddedView,
+      options: {propertyName: 'linked_page_ids'}
+    },
+
+    '.background_image': {
+      view: pageflow.BackgroundImageEmbeddedView,
+      options: {propertyName: 'background_image_id'}
+    }
+  },
+
+  pageLinks: function(configuration) {
+    return configuration.internalLinksGrid();
+  }
+});
+
+pageflow.editor.pageTypes.register('internal_links_list', {
+  configurationEditorView: pageflow.internalLinks.ListConfigurationEditorView,
+
+  embeddedViews: {
+    'nav': {
+      view: pageflow.internalLinks.ListEmbeddedView
+    },
+
+    '.background_image': {
+      view: pageflow.BackgroundImageEmbeddedView,
+      options: {propertyName: 'background_image_id'}
+    }
+  },
+
+  pageLinks: function(configuration) {
+    return configuration.internalLinksList();
+  }
+});
+
+pageflow.editor.registerPageConfigurationMixin(pageflow.internalLinks.pageConfigurationMixin);
+
+pageflow.editor.registerSideBarRouting({
+  router: pageflow.internalLinks.SideBarRouter,
+  controller: pageflow.internalLinks.SideBarController
+});

data/app/assets/javascripts/pageflow/internal_links/editor/controllers/side_bar_controller.js

@@ -0,0 +1,14 @@
+pageflow.internalLinks.SideBarController = Backbone.Marionette.Controller.extend({
+  initialize: function(options) {
+    this.region = options.region;
+  },
+
+  pageLink: function(pageId, linkId) {
+    var page = pageflow.pages.get(pageId);
+
+    this.region.show(new pageflow.internalLinks.EditPageLinkView({
+      model: page.pageLinks().get(linkId),
+      page: page
+    }));
+  }
+});

data/app/assets/javascripts/pageflow/internal_links/editor/models/page_configuration_mixin.js

@@ -0,0 +1,19 @@
+pageflow.internalLinks.pageConfigurationMixin = {
+  internalLinksList: function() {
+    this._internalLinksList = this._internalLinksList ||
+      new pageflow.internalLinks.ListPageLinksCollection(null, {
+        configuration: this
+      });
+
+    return this._internalLinksList;
+  },
+
+  internalLinksGrid: function() {
+    this._internalLinksGrid = this._internalLinksGrid ||
+      new pageflow.internalLinks.GridPageLinksCollection(null, {
+        configuration: this
+      });
+
+    return this._internalLinksGrid;
+  }
+};

data/app/assets/javascripts/pageflow/internal_links/editor/models/page_link.js

@@ -0,0 +1,35 @@
+pageflow.internalLinks.PageLink = Backbone.Model.extend({
+  i18nKey: 'pageflow/internal_links/page_link',
+
+  targetPage: function() {
+    return pageflow.pages.getByPermaId(this.get('target_page_id'));
+  },
+
+  label: function() {
+    return this.get('label');
+  },
+
+  editPath: function() {
+    return '/internal_links_pages/' + this.getRoutableId() + '/page_links/' + this.id;
+  },
+
+  getRoutableId: function() {
+    return this.collection.page.id;
+  },
+
+  toSerializedJSON: function() {
+    return _.omit(this.attributes, 'highlighted');
+  },
+
+  highlight: function() {
+    this.set('highlighted', true);
+  },
+
+  resetHighlight: function() {
+    this.unset('highlighted');
+  },
+
+  remove: function() {
+    this.collection.remove(this);
+  }
+});

data/app/assets/javascripts/pageflow/internal_links/editor/routers/side_bar_router.js

@@ -0,0 +1,5 @@
+pageflow.internalLinks.SideBarRouter = Backbone.Marionette.AppRouter.extend({
+  appRoutes: {
+    'internal_links_pages/:pageId/page_links/:id': 'pageLink'
+  }
+});

data/app/assets/javascripts/pageflow/internal_links/editor/templates/edit_page_link.jst.ejs

@@ -0,0 +1,3 @@
+<a class="back"><%= I18n.t('pageflow.internal_links.editor.templates.edit_page_link.back') %></a>
+<a class="destroy"><%= I18n.t('pageflow.internal_links.editor.templates.edit_page_link.destroy') %></a>
+<div class="form_container"></div>

data/app/assets/javascripts/pageflow/internal_links/editor/templates/grid_item_embedded.jst.ejs

@@ -0,0 +1,4 @@
+<a class="edit" href="" title="<%= I18n.t('pageflow.internal_links.editor.templates.embedded.grid_page_link.edit') %>"></a>
+<a class="set" href="" title="<%= I18n.t('pageflow.internal_links.editor.templates.embedded.grid_page_link.set') %>"></a>
+<div class="placeholder"></div>
+<span class="title"></span>

data/app/assets/javascripts/pageflow/internal_links/editor/templates/list_item_embedded.jst.ejs

@@ -0,0 +1,7 @@
+<a class="edit" href="" title="<%= I18n.t('pageflow.internal_links.editor.templates.list_item_embedded.edit') %>"></a>
+
+<a class="page_link" href="#">
+  <div class="details">
+    <p class="page_description"></p>
+  </div>
+</a>

data/app/assets/javascripts/pageflow/internal_links/editor/views/edit_page_link_view.js

@@ -0,0 +1,67 @@
+pageflow.internalLinks.EditPageLinkView = Backbone.Marionette.Layout.extend({
+  template: 'pageflow/internal_links/editor/templates/edit_page_link',
+
+  regions: {
+    formContainer: '.form_container'
+  },
+
+  ui: {
+    backButton: 'a.back'
+  },
+
+  events: {
+    'click a.back': 'goBack',
+
+    'click a.destroy': 'destroy'
+  },
+
+  onRender: function() {
+    var configurationEditor = new pageflow.ConfigurationEditorView({
+      model: this.model
+    });
+
+    this.configure(configurationEditor);
+    this.formContainer.show(configurationEditor);
+
+    this.highlight();
+  },
+
+  highlight: function() {
+    var page = this.model.collection.page;
+
+    this.model.highlight();
+    page.set('internal_links_editable', true);
+
+    this.listenTo(this, 'close', function() {
+      this.model.resetHighlight();
+      page.unset('internal_links_editable');
+    });
+  },
+
+  configure: function(configurationEditor) {
+    configurationEditor.tab('general', function() {
+      this.input('label', pageflow.TextInputView);
+      this.input('target_page_id', pageflow.PageLinkInputView);
+      this.input('page_transition', pageflow.SelectInputView, {
+        translationKeyPrefix: 'pageflow.page_transitions',
+        includeBlank: true,
+        blankTranslationKey: 'pageflow.internal_links.editor.views.edit_page_link_view.default_page_transition',
+        values: pageflow.pageTransitions.names()
+      });
+      this.input('description', pageflow.TextAreaInputView, {
+        size: 'short'
+      });
+    });
+  },
+
+  destroy: function() {
+    if (confirm(I18n.t('pageflow.internal_links.editor.views.edit_page_link_view.confirm_destroy'))) {
+      this.model.remove();
+      this.goBack();
+    }
+  },
+
+  goBack: function() {
+    pageflow.editor.navigate('/pages/' + this.options.page.id + '/links', {trigger: true});
+  }
+});

data/app/assets/javascripts/pageflow/internal_links/editor/views/editable_links_mode_view.js

@@ -0,0 +1,10 @@
+pageflow.internalLinks.EditableLinksModeView = Backbone.Marionette.View.extend({
+  render: function() {
+    this.model.set('internal_links_editable', true);
+    return this;
+  },
+
+  onClose: function() {
+    this.model.unset('internal_links_editable');
+  }
+});

data/app/assets/javascripts/pageflow/internal_links/editor/views/grid_configuration_editor_view.js

@@ -0,0 +1,30 @@
+pageflow.internalLinks.GridConfigurationEditorView = pageflow.ConfigurationEditorView.extend({
+  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,
+        positioning: false
+      });
+    });
+
+    this.tab('links', function() {
+      this.view(pageflow.internalLinks.EditableLinksModeView, {
+        model: this.model.page
+      });
+
+      this.input('linked_pages_layout', pageflow.SelectInputView, {values: pageflow.Page.linkedPagesLayouts});
+      this.view(pageflow.PageLinksView, {
+        model: this.model.page
+      });
+    });
+
+    this.tab('options', function() {
+      this.group('options');
+    });
+  }
+});