pageflow-linkmap-page 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b493ac7493f526d49f5805c713a211ba6447de0e
+  data.tar.gz: 16e8273aa2955e2abec0d289a3aeb294d6ffb7c5
+SHA512:
+  metadata.gz: a1082d4931f516b774ccf34def7f6ac4bc8dd1e3f1a8a30f1676e70646f0ad55da29379cb76ea8074ca53720e2928ce95632fe83b42d510ea72c90a1687f68fa
+  data.tar.gz: c42dd554b92d398453024079f6d0c826c0b1a5f77f847c7f1bab77b994da0346f6849069ffc5dd23a6562a55e20cd2e6aa92bf5be131099e9f8e28abe2501a40

data/.gitignore

@@ -0,0 +1,21 @@
+*.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
+spec/dummy
+.localeapp

data/.jshintignore

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

data/.jshintrc

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

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# CHANGELOG
+
+### Version 0.1.0
+
+2016-06-09
+
+- Initial release
+

data/Gemfile

@@ -0,0 +1,18 @@
+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'
+
+gem 'pageflow', path: '.bundle/linked/pageflow'
+gem 'pageflow-support', path: '.bundle/linked/pageflow/spec/support'
+
+gem 'teaspoon', git: 'https://github.com/modeset/teaspoon'
+
+gem "spring-commands-rspec", group: :development
+gem "spring-commands-teaspoon", group: :development

data/README.md

@@ -0,0 +1,62 @@
+# Pageflow Linkmap Page
+
+[![Gem Version](https://badge.fury.io/rb/pageflow-linkmap-page.svg)](http://badge.fury.io/rb/pageflowlinkmap-page)
+
+Page type to display customizable link areas to internal/external
+pages and inline audio players.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+    gem 'pageflow-linkmap-page'
+
+Register the page type inside the configure block in `config/initializers/pageflow.rb`
+
+    Pageflow.configure do |config|
+      config.plugin(Pageflow::LinkmapPage.plugin)
+    end
+
+Include javascripts and stylesheets:
+
+    # app/assets/javascripts/pageflow/application.js
+    //= require pageflow/linkmap_page
+
+    # app/assets/javascripts/pageflow/editor.js
+    //= require pageflow/linkmap_page/editor
+
+    # app/assets/stylesheets/pageflow/application.css.scss
+    @import "pageflow/linkmap_page";
+
+    # app/assets/stylesheets/pageflow/editor.css.scss
+    @import "pageflow/linkmap_page/editor";
+
+Import default theme additions:
+
+    # app/assets/stylesheets/pageflow/themes/default.css.scss
+
+    @import "pageflow/linkmap_page/themes/default";
+
+    /* Display arrows left and right to indicate panorama */
+    @import "pageflow/linkmap_page/themes/default/scroll_indicators";
+
+Install dependencies:
+
+    bundle install
+
+Restart the application server and enable the corresponding page type
+feature.
+
+## 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-linkmap-page/issues).
+
+## Contributing Locales
+
+Edit the translations directly on the
+[pageflow-internal-links](http://www.localeapp.com/projects/public?search=tf/pageflow-linkmap-page)
+locale project.

data/Rakefile

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

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

@@ -0,0 +1,9 @@
+//= require_self
+//= require ./linkmap_page/features
+//= require ./linkmap_page/page_type
+//= require ./linkmap_page/vendor/gyro
+//= require_tree ./linkmap_page/widgets
+
+pageflow.linkmapPage = pageflow.linkmapPage || {};
+
+pageflow.linkmapPage.toggleMarkerOptions = ['no_marker', 'dynamic_marker'];

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

@@ -0,0 +1,25 @@
+//= 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.linkmapPage = pageflow.linkmapPage || {};
+
+pageflow.linkmapPage.areaTypesFor = function(pageConfiguration) {
+  return new Backbone.Collection(_([
+    pageflow.linkmapPage.PageLinkAreaType,
+    pageflow.linkmapPage.AudioFileAreaType,
+    pageflow.linkmapPage.ExternalLinkAreaType,
+    pageflow.linkmapPage.TextOnlyAreaType
+  ]).map(function(constructor) {
+    return new constructor({}, {
+      pageConfiguration: pageConfiguration
+    });
+  }));
+};

data/app/assets/javascript/pageflow/linkmap_page/editor/collections/areas_collection.js

@@ -0,0 +1,57 @@
+pageflow.linkmapPage.AreasCollection = Backbone.Collection.extend({
+  model: pageflow.linkmapPage.Area,
+
+  initialize: function(models, options) {
+    this.page = options.page;
+    this.defaultPosition = {
+      left: 10,
+      top: 10
+    };
+  },
+
+  /**
+   * @param [Object, Function] value
+   */
+  setDefaultPosition: function(value) {
+    this.defaultPosition = value;
+  },
+
+  canAddLink: function() {
+    return true;
+  },
+
+  addLink: function(targetPageId) {
+    this.addWithPosition({
+      target_type: 'page',
+      target_id: targetPageId
+    });
+  },
+
+  addAudioFile: function(audioFileId) {
+    this.addWithPosition({
+      target_type: 'audio_file',
+      target_id: audioFileId
+    });
+  },
+
+  addExternalSite: function(siteId) {
+    this.addWithPosition({
+      target_type: 'external_site',
+      target_id: siteId
+    });
+  },
+
+  addTextOnly: function() {
+    this.addWithPosition({
+      target_type: 'text_only'
+    });
+  },
+
+  addWithPosition: function(attributes) {
+    this.add(_.extend(
+      {width: 7, height: 7},
+      _.result(this, 'defaultPosition'),
+      attributes
+    ));
+  }
+});

data/app/assets/javascript/pageflow/linkmap_page/editor/collections/page_links_collection.js

@@ -0,0 +1,29 @@
+pageflow.linkmapPage.PageLinksCollection = pageflow.SubsetCollection.extend({
+  constructor: function(options) {
+    this.areas = options.areas;
+
+    pageflow.SubsetCollection.prototype.constructor.call(this, {
+      parent: options.areas,
+
+      filter: function(area) {
+        return area.get('target_type') === 'page';
+      }
+    });
+  },
+
+  canAddLink: function() {
+    return this.areas.canAddLink();
+  },
+
+  addLink: function(targetPageId) {
+    this.areas.addLink(targetPageId);
+  },
+
+  updateLink: function(link, targetPageId) {
+    link.set({target_id: targetPageId});
+  },
+
+  removeLink: function(link) {
+    this.remove(link);
+  },
+});

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

@@ -0,0 +1,51 @@
+pageflow.editor.pageTypes.register('linkmap_page', {
+  configurationEditorView: pageflow.linkmapPage.ConfigurationEditorView,
+
+  embeddedViews: {
+    '.scroller': {
+      view: pageflow.linkmapPage.PanoramaEmbeddedView,
+      options: {
+        disableMarginScrollingPropertyName: 'areas_editable'
+      }
+    },
+
+    '.panorama_image': {
+      view: pageflow.BackgroundImageEmbeddedView,
+      options: {
+        propertyName: 'panorama_image_id',
+        dataSizeAttributes : true
+      }
+    },
+
+    '.panorama_video': {
+      view: pageflow.LazyVideoEmbeddedView,
+      options: {
+        propertyName: 'panorama_video_id',
+        dataSizeAttributes: true
+      }
+    },
+
+    '.linkmap_areas': {
+      view: pageflow.linkmapPage.AreasEmbeddedView
+    },
+
+    '.fixed_background': {
+      view: pageflow.BackgroundImageEmbeddedView,
+      options: {propertyName: 'fixed_background_image_id'}
+    }
+  },
+
+  pageLinks: function(configuration) {
+    return configuration.linkmapPageLinks();
+  }
+});
+
+pageflow.editor.registerPageConfigurationMixin(pageflow.linkmapPage.pageConfigurationMixin);
+
+pageflow.editor.registerFileSelectionHandler('linkmapPage.area', pageflow.linkmapPage.AreaFileSelectionHandler);
+pageflow.editor.registerFileSelectionHandler('linkmapPage.newArea', pageflow.linkmapPage.NewAreaFileSelectionHandler);
+
+pageflow.editor.registerSideBarRouting({
+  router: pageflow.linkmapPage.SideBarRouter,
+  controller: pageflow.linkmapPage.SideBarController
+});

data/app/assets/javascript/pageflow/linkmap_page/editor/controllers/side_bar_controller.js

@@ -0,0 +1,15 @@
+pageflow.linkmapPage.SideBarController = Backbone.Marionette.Controller.extend({
+  initialize: function(options) {
+    this.region = options.region;
+  },
+
+  area: function(pageId, areaIndex) {
+    var page = pageflow.pages.get(pageId);
+
+    this.region.show(new pageflow.linkmapPage.EditAreaView({
+      model: page.configuration.linkmapAreas().at(parseInt(areaIndex, 10)),
+      page: page,
+      areaIndex: areaIndex
+    }));
+  }
+});

data/app/assets/javascript/pageflow/linkmap_page/editor/models/area.js

@@ -0,0 +1,79 @@
+pageflow.linkmapPage.Area = Backbone.Model.extend({
+  modelName: 'area',
+  i18nKey: 'pageflow/linkmap_page/area',
+
+  mixins: [pageflow.transientReferences],
+
+  target: function() {
+    // This should eventually be replaces with some sort of
+    // polymorphic lookup for referenceable objects i.e.
+    //
+    //     pageflow.xxx.getPolymorphic(this.get('target_type'), this.get('target_id'));
+    //
+    if (this.get('target_type') === 'audio_file') {
+      return pageflow.audioFiles.get(this.get('target_id'));
+    }
+    else if (this.get('target_type') === 'page') {
+      return pageflow.pages.getByPermaId(this.get('target_id'));
+    }
+    else if (this.get('target_type') === 'external_site') {
+      return pageflow.externalLinks.sites.getByPermaId(this.get('target_id'));
+    }
+  },
+
+  targetPage: function() {
+    return this.get('target_type') === 'page' ? this.target() : null;
+  },
+
+  title: function() {
+    var target = this.target();
+    return target ? target.title() : null;
+  },
+
+  thumbnailFile: function() {
+    if (this.get('target_type') === 'text_only') {
+      return this.textOnlyAreaPlaceholderFile();
+    }
+
+    var target = this.target();
+    return target ? target.thumbnailFile() : null;
+  },
+
+  textOnlyAreaPlaceholderFile: function() {
+    if (!pageflow.linkmapPage.Area.textOnlyAreaPlaceholderFile) {
+      var file = new pageflow.AudioFile({
+        state: 'encoded'
+      });
+
+      file.thumbnailPictogram = 'text_only';
+      pageflow.linkmapPage.Area.textOnlyAreaPlaceholderFile = file;
+    }
+
+    return pageflow.linkmapPage.Area.textOnlyAreaPlaceholderFile;
+  },
+
+  label: function() {
+    return this.get('name');
+  },
+
+  highlight: function() {
+    this.set('highlighted', true);
+  },
+
+  resetHighlight: function() {
+    this.unset('highlighted');
+  },
+
+  editPath: function() {
+    var areaIndex = this.collection.indexOf(this);
+    return '/linkmap_pages/' + this.getRoutableId() + '/areas/' + areaIndex;
+  },
+
+  getRoutableId: function() {
+    return this.collection.page.id;
+  },
+
+  remove: function() {
+    this.collection.remove(this);
+  }
+});