pageflow-sitemap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7700735a3babaf67d6d170705527fd3598b57735
+  data.tar.gz: 79164f85a72ea5f24efe2973d49d1417c71a5dbe
+SHA512:
+  metadata.gz: 1ee7d4b0eafdf0a66db2d1cad94a1481652eb7cdd793417b9bb7387b34c3876c53d1b8eaa2fae1ea8b65486d4adc3e84664bfe46817fcc4d53e90f165dc69ed7
+  data.tar.gz: cc0f75e0cb6a56798a18cf1b50b7b984e14fcee706052aa5634827f88ebe2f07226cccb664c785b37191e036ff36d1929c959a322d8080f1d31c41f1c6fc5eba

data/.gitignore

@@ -0,0 +1,25 @@
+*.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
+.bundle/
+log/*.log
+pkg/
+spec/dummy
+
+.localeapp

data/.jshintrc

@@ -0,0 +1,18 @@
+{
+  "browser": true,
+  "undef": true,
+  "immed": true,
+  "trailing": true,
+  "globals": {
+    "jQuery": true,
+    "$": true,
+    "Backbone": true,
+    "Cocktail": true,
+    "I18n": true,
+    "_": true,
+    "d3": true,
+
+    "pageflow": true,
+    "sitemap": true
+  }
+}

data/Gemfile

@@ -0,0 +1,24 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in pageflow/sitemap.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+gem 'pageflow', path: '.bundle/linked/pageflow' #, git: 'https://github.com/codevise/pageflow.git', :branch => 'master'
+
+gem 'sqlite3'
+
+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 'ejs'
+
+gem 'pageflow-support', path: '../pageflow/spec/support'
+
+gem 'teaspoon', '~> 0.9.0'
+
+gem "spring-commands-rspec", group: :development
+gem "spring-commands-teaspoon", group: :development

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright 2014 Codevise Solutions Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Pageflow Sitemap
+
+[![Gem Version](https://badge.fury.io/rb/pageflow-sitemap.svg)](http://badge.fury.io/rb/pageflow-sitemap)
+
+An interactive sitemap for the Pageflow editor.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    # Gemfile
+    gem 'pageflow-sitemap'
+
+Register the plugin:
+
+    # config/initializers/pageflow.rb
+    Pageflow.configure do |config|
+      config.plugin(Pageflow::Sitemap.plugin)
+    end
+
+Include javascripts and stylesheets:
+
+    # app/assets/javascripts/pageflow/editor.js
+    //= require pageflow/sitemap/editor
+
+    # app/assets/stylesheets/pageflow/themes/default.css.scss
+    @import "pageflow/sitemap/themes/default";
+
+Execute `bundle install` and restart the application server.
+
+Now you can enable the "Sitemap" feature in your feature settings.
+
+## 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-sitemap/issues).
+
+## Contributing Locales
+
+Edit the translations directly on the
+[pageflow-sitemap](http://www.localeapp.com/projects/public?search=tf/pageflow-sitemap)
+locale project.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PageflowSitemap'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'semmy'
+Semmy::Tasks.install
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/pageflow/sitemap/editor/controllers/abstract_controller.js

@@ -0,0 +1,68 @@
+/*globals _, sitemap, pageflow */
+
+sitemap.AbstractController = pageflow.Object.extend({
+  lineSelected: function (line, event) {},
+
+  storylineSelected: function (storyline, event) {},
+
+  storylinesSelected: function (storylines) {},
+
+  chapterSelected: function (chapter, event) {},
+
+  pageSelected: function (page, event) {},
+
+  pageDblClick: function (page, event) {},
+
+  pageLinkSelected: function (pageLink) {},
+
+  pageLinkDroppedOnPage: function(links, link, page) {},
+
+  newPageLinkDroppedOnPage: function(links, page) {},
+
+  pageLinkDroppedOnPlaceholder: function(sourcePage, links, link, laneAndRow) {},
+
+  newPageLinkDroppedOnPlaceholder: function(sourcePage, links, laneAndRow) {},
+
+  successorLinkSelected: function (link) {},
+
+  successorLinkDroppedOnPage: function(page, targetPage) {},
+
+  successorLinkDroppedOnPlaceholder: function(page, laneAndRow) {},
+
+  storylinesPositioned: function(updates) {},
+
+  pagesMoved: function(pagesGroupedByChapters) {},
+
+  addPage: function (chapter) {},
+
+  insertPageAfter: function (page) {},
+
+  addChapter: function(storyline, configuration) {},
+
+  insertChapterAfter: function(targetChapter) {},
+
+  chaptersMoved: function(chaptersGroupedByStorylines) {},
+
+  addStoryline: function(configuration) {},
+
+  addUpdateHandler: function (handler) {
+    var timeout;
+
+    this.addDebouncedUpdateHandler(function(/* args */) {
+      var args = arguments;
+
+      timeout = timeout || setTimeout(function() {
+        timeout = null;
+        handler.apply(this, args);
+      }, 1);
+    });
+  },
+
+  addDebouncedUpdateHandler: function(handler) {},
+
+  dispose: function() {
+    this.stopListening();
+  }
+});
+
+_.extend(sitemap.AbstractController, Backbone.Events);

data/app/assets/javascripts/pageflow/sitemap/editor/controllers/editor_mode_controller.js

@@ -0,0 +1,301 @@
+pageflow.sitemap.EditorModeController = pageflow.sitemap.AbstractController.extend({
+  name: 'editor_mode',
+
+  initialize: function() {
+    var s = pageflow.sitemap;
+
+    this.selection = new s.Selection();
+
+    new s.FragmentParser(
+      pageflow.entry,
+      Backbone.history.fragment
+    ).select(this.selection);
+
+    new s.SelectionNavigator({
+      selection: this.selection,
+      multiSelectionPath: '/'
+    }).attach();
+  },
+
+  storylinesSelected: function (storylines) {
+    this.selection.select('storylines', storylines);
+  },
+
+  storylineSelected: function (storyline, event) {
+    if (!this.selection.contains(storyline)) {
+      this.selection.select('storylines', [storyline], {
+        additive: event.ctrlKey
+      });
+    }
+  },
+
+  storylineDblClick: function(storyline) {
+    this.trigger('showStoryline', storyline);
+  },
+
+  chapterSelected: function (chapter, event) {
+    if (!this.selection.contains(chapter)) {
+      this.selection.select('chapters', [chapter], {
+        additive: event.ctrlKey
+      });
+    }
+  },
+
+  pageSelected: function (page, event) {
+    if (!this.selection.contains(page)) {
+      this.selection.select('pages', [page], {
+        additive: event.ctrlKey
+      });
+    }
+  },
+
+  pageDblClick: function(page) {
+    this.trigger('showPage', page);
+  },
+
+  pageLinkSelected: function (pageLink) {
+    this.selection.select('pageLinks', [pageLink]);
+  },
+
+  pageLinkDroppedOnPage: function(links, link, page) {
+    links.updateLink(link, page.get('perma_id'));
+  },
+
+  newPageLinkDroppedOnPage: function(links, page) {
+    links.addLink(page.get('perma_id'));
+  },
+
+  pageLinkDroppedOnPlaceholder: function(sourcePage, links, link, laneAndRow) {
+    var configuration = _.extend({
+      parent_page_perma_id: sourcePage.get('perma_id')
+    }, laneAndRow);
+
+    pageflow.entry.addPageInNewStoryline({
+      storylineAttributes: {configuration: configuration}
+    }).persisted().then(function(page) {
+      links.updateLink(link, page.get('perma_id'));
+    });
+  },
+
+  newPageLinkDroppedOnPlaceholder: function(sourcePage, links, laneAndRow) {
+    var configuration = _.extend({
+      parent_page_perma_id: sourcePage.get('perma_id')
+    }, laneAndRow);
+
+    pageflow.entry.addPageInNewStoryline({
+      storylineAttributes: {configuration: configuration}
+    }).persisted().then(function(page) {
+      links.addLink(page.get('perma_id'));
+    });
+  },
+
+  successorLinkSelected: function (link) {
+    this.selection.select('successorLinks', [link]);
+  },
+
+  successorLinkDroppedOnPage: function(storyline, targetPage) {
+    if (targetPage) {
+      storyline.configuration.set('scroll_successor_id', targetPage.get('perma_id'));
+    }
+  },
+
+  successorLinkDroppedOnPlaceholder: function(storyline, configuration) {
+    pageflow.entry.addPageInNewStoryline({
+      storylineAttributes: {configuration: configuration}
+    }).persisted().then(function(page) {
+      storyline.configuration.set('scroll_successor_id', page.get('perma_id'));
+    });
+  },
+
+  storylinesPositioned: function(updates) {
+    // FIXME should have batch update for chapters
+    _.each(updates, function(update) {
+      update.storyline.configuration.set({
+        row: update.row,
+        lane: update.lane
+      });
+    }, this);
+  },
+
+  chaptersMoved: function(chaptersGroupedByStorylines, laneAndRow) {
+    _.each(chaptersGroupedByStorylines, function(update) {
+      if (!update.storyline &&
+          update.chapters.length === update.chapters[0].storyline.chapters.length) {
+
+        update.chapters[0].storyline.configuration.set(laneAndRow);
+        return;
+      }
+
+      var storyline = update.storyline || pageflow.entry.addStoryline({configuration: laneAndRow});
+      var changeFound = false;
+
+      _.each(update.chapters, function(chapter, index) {
+        if (chapter.get('position') !== index) {
+          changeFound = true;
+          chapter.set('position', index);
+        }
+
+        if (chapter.storyline !== storyline) {
+          changeFound = true;
+
+          chapter.storyline.chapters.remove(chapter);
+          storyline.chapters.add(chapter);
+        }
+      });
+
+      if (changeFound) {
+        storyline.chapters.sort();
+
+        storyline.persisted().then(function() {
+          storyline.chapters.saveOrder();
+        });
+      }
+    });
+  },
+
+  pagesMoved: function(pagesGroupedByChapters, laneAndRow) {
+    _.each(pagesGroupedByChapters, function(update) {
+      if (!update.chapter &&
+          update.pages.length === update.pages[0].chapter.pages.length) {
+
+        update.pages[0].chapter.configuration.set(laneAndRow);
+        return;
+      }
+
+      var chapter = update.chapter || pageflow.entry.addChapterInNewStoryline({
+        storylineAttributes: {configuration: laneAndRow}
+      });
+
+      var changeFound = false;
+
+      _.each(update.pages, function(page, index) {
+        if (page.get('position') !== index) {
+          changeFound = true;
+          page.set('position', index);
+        }
+
+        if (page.chapter !== chapter) {
+          changeFound = true;
+
+          page.chapter.pages.remove(page);
+          chapter.pages.add(page);
+        }
+      });
+
+      if (changeFound) {
+        chapter.pages.sort();
+
+        chapter.persisted().then(function() {
+          chapter.pages.saveOrder();
+        });
+      }
+    });
+  },
+
+  addPage: function (chapter) {
+    var page = chapter.addPage();
+    var selection = this.selection;
+
+    page.once('sync', function() {
+      selection.select('pages', [page]);
+    });
+  },
+
+  insertPageAfter: function (targetPage) {
+    var chapter = targetPage.chapter;
+    var selection = this.selection;
+    var delta = 0;
+
+    chapter.pages.each(function(page, index) {
+      page.set('position', index + delta);
+
+      if (page === targetPage) {
+        delta = 1;
+      }
+    });
+
+    var newPage = chapter.addPage({
+      position: targetPage.get('position') + 1
+    });
+
+    chapter.pages.sort();
+    chapter.pages.saveOrder();
+
+    newPage.once('sync', function() {
+      selection.select('pages', [newPage]);
+    });
+  },
+
+  addChapter: function(storyline, configuration) {
+    var selection = this.selection;
+    var chapter = storyline.scaffoldChapter({configuration: configuration}).chapter;
+
+    chapter.once('sync', function() {
+      selection.select('chapters', [chapter]);
+    });
+  },
+
+  insertChapterAfter: function(targetChapter) {
+    var storyline = targetChapter.storyline;
+    var selection = this.selection;
+    var delta = 0;
+
+    storyline.chapters.each(function(chapter, index) {
+      chapter.set('position', index + delta);
+
+      if (chapter === targetChapter) {
+        delta = 1;
+      }
+    });
+
+    var newChapter = storyline.scaffoldChapter({
+      chapterAttributes: {position: targetChapter.get('position') + 1}
+    }).chapter;
+
+    storyline.chapters.sort();
+    storyline.chapters.saveOrder();
+
+    newChapter.once('sync', function() {
+      selection.select('chapters', [newChapter]);
+    });
+  },
+
+  addStoryline: function(configuration) {
+    pageflow.entry.addPageInNewStoryline({
+      storylineAttributes: {configuration: configuration}
+    });
+  },
+
+  addDebouncedUpdateHandler: function (handler) {
+    var session = {
+      entry: pageflow.entry,
+      selection: this.selection
+    };
+
+    handler(session);
+
+    this.listenTo(pageflow.chapters, 'remove', function() {
+      this.selection.reset();
+    });
+
+    this.listenTo(pageflow.pages, 'destroying', function() {
+      this.selection.reset();
+    });
+
+    this.listenTo(pageflow.storylines, 'add remove destroying change change:configuration', function() {
+      handler(session);
+    });
+
+    this.listenTo(pageflow.chapters, 'add remove destroying change change:configuration', function() {
+      handler(session);
+    });
+
+    this.listenTo(pageflow.pages, 'add remove destroying destroy change change:configuration', function() {
+      handler(session);
+    });
+
+    this.listenTo(this.selection, 'change', function() {
+      handler(session);
+    });
+  }
+});

data/app/assets/javascripts/pageflow/sitemap/editor/controllers/fragment_parser.js

@@ -0,0 +1,31 @@
+pageflow.sitemap.FragmentParser = pageflow.Object.extend({
+  patterns: {
+    storylines: /^\/?storylines\/(\d+)/,
+    chapters: /^\/?chapters\/(\d+)/,
+    pages: /^\/?pages\/(\d+)/
+  },
+
+  initialize: function(entry, fragment) {
+    this.entry = entry;
+    this.fragment = fragment;
+  },
+
+  select: function(selection) {
+    _(this.patterns).any(function(pattern, name) {
+      var model = this.getModel(name);
+
+      if (model) {
+        selection.select(name, model);
+        return true;
+      }
+    }, this);
+  },
+
+  getModel: function(name) {
+    var match = this.fragment.match(this.patterns[name]);
+
+    if (match) {
+      return this.entry[name].get(match[1]);
+    }
+  }
+});

data/app/assets/javascripts/pageflow/sitemap/editor/controllers/selection_mode_controller.js

@@ -0,0 +1,37 @@
+pageflow.sitemap.SelectionModeController = pageflow.sitemap.AbstractController.extend({
+  name: 'selection_mode',
+
+  initialize: function(entry, options) {
+    this.entry = entry;
+    this.options = options || {};
+  },
+
+  pageSelected: function (page) {
+    this.trigger('selected', page);
+  },
+
+  addDebouncedUpdateHandler: function (handler) {
+    var fragmentParser = new pageflow.sitemap.FragmentParser(this.entry, Backbone.history.fragment);
+    var options = this.options;
+
+    var session = {
+      entry: this.entry,
+      selection: new pageflow.sitemap.Selection(),
+      isPageDisabled: function(page) {
+        return options.isAllowed && !options.isAllowed(page);
+      },
+      highlightedPage: this.options.noHighlight ? null : fragmentParser.getModel('pages'),
+      highlightedStoryline: this.options.noHighlight ? null : fragmentParser.getModel('storylines')
+    };
+
+    handler(session);
+
+    this.listenTo(this.entry.chapters, 'add remove destroying change:configuration', function() {
+      handler(session);
+    });
+
+    this.listenTo(this.entry.pages, 'add remove destroying destroy change change:configuration', function() {
+      handler(session);
+    });
+  }
+});

data/app/assets/javascripts/pageflow/sitemap/editor/controllers/selection_navigator.js

@@ -0,0 +1,43 @@
+pageflow.sitemap.SelectionNavigator = pageflow.Object.extend({
+  initialize: function(options) {
+    this.api = options.api || pageflow.editor;
+    this.selection = options.selection;
+    this.options = options;
+  },
+
+  attach: function() {
+    this.listenToSelection('pages', function(page) {
+      return '/pages/' + page.id;
+    });
+
+    this.listenToSelection('chapters', function(chapter) {
+      return '/chapters/' + chapter.id;
+    });
+
+    this.listenToSelection('storylines', function(storyline) {
+      return '/storylines/' + storyline.id;
+    });
+
+    this.listenToSelection('successorLinks', function(link) {
+      return '/storylines/' + link.successor.id;
+    });
+
+    this.listenToSelection('pageLinks', function(pageLink) {
+      return pageLink.editPath ? pageLink.editPath() : this.options.emptySelectionPath;
+    });
+  },
+
+  listenToSelection: function(name, path) {
+    this.listenTo(this.selection, 'select:' + name, function(models) {
+      if (models.length === 1) {
+        this.api.navigate(path(models[0]), {trigger: true});
+      }
+      else if (models.length > 1) {
+        this.api.navigate(this.options.multiSelectionPath, {trigger: true});
+      }
+      else {
+        this.api.navigate(this.options.emptySelectionPath, {trigger: true});
+      }
+    });
+  }
+});