sn-collab-editor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49de97f783331e2e553b985f416c595d7d55a103
+  data.tar.gz: f2764ac59a5a37b1837405e6a7acc22438bceac1
+SHA512:
+  metadata.gz: c2d722e15f7aa2bd7d71c955069dc66317e9b06e854929ec0b5e1e629788ab4f929eadfd092361011f0d43ab1a78aa5e469833f2345edd7e18d3caccbacad5d6
+  data.tar.gz: 1d31c2fe4bbaa60d4e0ffe329f81363df4cab6cd597bf954e2faae7efb4cffcc0b7a9e0cd375f03dc9df2b2144543c80376e5568f890dd12307c64c94f9856a6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 
+
+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,28 @@
+# Collab
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'collab'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install collab
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'Collab'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+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/config/collab_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/collab .js
+//= link_directory ../stylesheets/collab .css

data/app/assets/javascripts/collab/application.js

@@ -0,0 +1,3 @@
+//= require_self
+
+window.App = window.App || {};

data/app/assets/javascripts/collab/cable.js

@@ -0,0 +1,40 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+document.addEventListener("DOMContentLoaded", function(event) {
+
+  var clientId = Math.random()*100;
+
+  App.socket = {};
+  App.socket.cable = ActionCable.createConsumer();
+
+  App.socket.subscribeToDoc = function(docId, callback) {
+    App.socket.channel = App.socket.cable.subscriptions.create({channel: "EditChannel", doc_id: docId}, {
+      connected: function() {
+        // Called when the subscription is ready for use on the server
+      },
+
+      disconnected: function() {
+        // Called when the subscription has been terminated by the server
+      },
+
+      received: function(data) {
+        console.log("received data", data);
+        // Called when there's incoming data on the websocket for this channel
+        if(data.clientId != clientId) {
+          callback(data.message);
+        }
+      },
+
+      speak: function(message) {
+        console.log("speaking", message);
+        return this.perform('speak', {message: message, id: docId, sender: clientId});
+      }
+    });
+  };
+
+}.bind(this))

data/app/assets/javascripts/collab/documents.js

@@ -0,0 +1,87 @@
+//= require ./cable.js
+
+document.addEventListener("DOMContentLoaded", function(event) {
+
+  var editor = document.getElementById("editor");
+
+  function createNewDocument() {
+    console.log("doc not found, going to new");
+    window.location.href = "/collab/doc/new";
+  }
+
+  function subscribeToDocId(docId) {
+    // subscribe to updates
+    console.log("subscribing to doc", docId);
+    App.socket.subscribeToDoc(docId, function(message){
+      console.log("Received message in callback:", message);
+      editor.value = message;
+    })
+  }
+
+  var uuidLength = 36;
+  var location = window.location.href;
+  var uuidCandidate = location.split("/").slice(-1)[0];
+  var hasDocument = uuidCandidate.length == uuidLength;
+  var noteId = sessionStorage.getItem("lastNoteId");
+
+  if(window.parent != window) {
+    if(hasDocument) {
+      // inform parent of new document
+      console.log("notifying parent of new doc", noteId);
+      window.parent.postMessage({text: buildParamsString({id: uuidCandidate}), id: noteId}, '*');
+      subscribeToDocId(uuidCandidate);
+    } else {
+      window.parent.postMessage({status: "ready"}, '*');
+    }
+  } else {
+    if(!hasDocument) {
+      createNewDocument();
+    } else {
+      subscribeToDocId(uuidCandidate);
+    }
+  }
+
+  function buildParamsString(doc) {
+    var string = "";
+    for(var key in doc) {
+      string += key + ": " + doc[key] + "\n";
+    }
+    string += "%%Do not modify above this line%%";
+    return string;
+  }
+
+  window.addEventListener("message", function(event){
+
+    console.log("Received message from parent frame", event.data);
+
+    var text = event.data.text || "";
+    sessionStorage.setItem("lastNoteId", event.data.id);
+
+    var paramString = text.split("%%Do not modify above this line%%")[0];
+    var lines = paramString.split("\n");
+    var params = {};
+    lines.forEach(function(line){
+      var comps = line.split(": ");
+      var key = comps[0];
+      var value = comps[1];
+      params[key] = value;
+    })
+
+    console.log("params", params);
+
+    let docId = params["id"]
+    if (docId && docId.length) {
+      window.location.href = "/collab/doc/" + docId;
+    } else {
+      createNewDocument();
+    }
+  }, false);
+
+  if(editor) {
+    editor.addEventListener("input", function(event){
+      var text = event.target.value;
+      App.socket.channel.speak(text);
+    })
+  }
+
+})

data/app/assets/stylesheets/collab/application.css

@@ -0,0 +1,49 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+
+html, body {
+  height: 100%;
+  width: 100%;
+  font-size: 14px;
+  font-family: sans-serif;
+  margin: 0;
+  padding: 7px;
+}
+
+#wrapper {
+  height: 100%;
+  display: flex;
+  flex-direction: column;
+}
+
+#editor {
+  flex: 1;
+  width: 100%;
+  height: 100%:
+  resize: none;
+  font-size: 16px;
+  border: 1px solid rgb(226, 226, 226);
+  border-radius: 4px;
+  padding: 15px;
+  margin-top: 10px;
+  font-family: monospace;
+}
+
+* {
+  box-sizing: border-box;
+}
+
+textarea, input, button { outline: none; }

data/app/assets/stylesheets/collab/documents.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/app/channels/edit_channel.rb

@@ -0,0 +1,21 @@
+class EditChannel < ApplicationCable::Channel
+  def subscribed
+    doc = Collab::Document.find_by_uuid(params['doc_id'])
+    # stream_from "doc_#{params[:doc_id]}"
+    stream_for doc
+  end
+
+  def unsubscribed
+    # ActionCable.server.broadcast('messages', message: render_message(data['message']))
+  end
+
+  def speak(data)
+    puts "received message #{data.inspect}"
+    message = data['message']
+    # ActionCable.server.broadcast('messages', message: message)
+    doc = Collab::Document.find_by_uuid(data['id'])
+    doc.content = message
+    doc.save
+    EditChannel.broadcast_to(doc, {:message => message})
+  end
+end

data/app/controllers/collab/application_controller.rb

@@ -0,0 +1,15 @@
+module Collab
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :null_session
+
+    after_action :allow_iframe
+
+    def allow_iframe
+      response.headers.except! 'X-Frame-Options'
+    end
+
+    def wrapper
+
+    end
+  end
+end

data/app/controllers/collab/documents_controller.rb

@@ -0,0 +1,35 @@
+require_dependency "collab/application_controller"
+
+module Collab
+  class DocumentsController < ApplicationController
+
+    def show
+      if params[:uuid]
+        @doc = Document.find_by_uuid(params[:uuid])
+      end
+      if !@doc
+        return
+      end
+      @url = url
+    end
+
+    def url
+      "#{Collab.mount_url}/doc/#{@doc.uuid}"
+    end
+
+    def create
+      @doc = Document.new
+      @doc.uuid = SecureRandom.uuid
+      @doc.save
+    end
+
+    def new
+      puts "\n\nCreating new document\n\n"
+      @doc = Document.new
+      @doc.uuid = SecureRandom.uuid
+      @doc.save
+      redirect_to(url)
+    end
+
+  end
+end

data/app/helpers/collab/application_helper.rb

@@ -0,0 +1,4 @@
+module Collab
+  module ApplicationHelper
+  end
+end

data/app/helpers/collab/documents_helper.rb

@@ -0,0 +1,4 @@
+module Collab
+  module DocumentsHelper
+  end
+end

data/app/jobs/collab/application_job.rb

@@ -0,0 +1,4 @@
+module Collab
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/collab/application_mailer.rb

@@ -0,0 +1,6 @@
+module Collab
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/collab/application_record.rb

@@ -0,0 +1,5 @@
+module Collab
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/collab/document.rb

@@ -0,0 +1,4 @@
+module Collab
+  class Document < ApplicationRecord
+  end
+end

data/app/views/collab/documents/show.html.erb

@@ -0,0 +1,9 @@
+<%= javascript_include_tag  params[:controller] %>
+
+<div id="wrapper">
+  <% if @doc %>
+    <div><strong>Sharing URL</strong>: <%= @url %></div>
+    <textarea id="editor"><%= @doc.content %></textarea>
+  <% else %>
+  <% end %>
+</div>

data/app/views/layouts/collab/application.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Collab</title>
+  <%= stylesheet_link_tag    "collab/application", media: "all" %>
+  <%= javascript_include_tag "collab/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<%= yield %>
+
+</body>
+</html>

data/config/cable.yml

@@ -0,0 +1,9 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: redis
+  url: redis://localhost:6379/1

data/config/initializers/assets.rb

@@ -0,0 +1,3 @@
+%w( documents wrapper ).each do |controller|
+  Rails.application.config.assets.precompile += ["collab/#{controller}.js", "collab/#{controller}.css"]
+end

data/config/routes.rb

@@ -0,0 +1,10 @@
+Collab::Engine.routes.draw do
+   mount ActionCable.server => '/cable'
+
+   get "doc/new" => "documents#new"
+   get "doc/:uuid" => "documents#show"
+   get "doc" => "documents#show"
+   post "doc" => "documents#create"
+
+   root "documents#show"
+end

data/db/migrate/20170222133537_create_collab_documents.rb

@@ -0,0 +1,9 @@
+class CreateCollabDocuments < ActiveRecord::Migration[5.0]
+  def change
+    create_table :collab_documents do |t|
+      t.text :content
+      t.string :uuid
+      t.timestamps
+    end
+  end
+end

data/lib/collab.rb

@@ -0,0 +1,5 @@
+require "collab/engine"
+
+module Collab
+  mattr_accessor :mount_url
+end

data/lib/collab/engine.rb

@@ -0,0 +1,5 @@
+module Collab
+  class Engine < ::Rails::Engine
+    isolate_namespace Collab
+  end
+end

data/lib/collab/version.rb

@@ -0,0 +1,3 @@
+module Collab
+  VERSION = '0.1.0'
+end

data/lib/tasks/collab_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :collab do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: sn-collab-editor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Standard Notes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+description: Standard Notes editor with collaboration abilities.
+email:
+- hello@standardnotes.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/collab_manifest.js
+- app/assets/javascripts/collab/application.js
+- app/assets/javascripts/collab/cable.js
+- app/assets/javascripts/collab/channels/collab/edit.js
+- app/assets/javascripts/collab/documents.js
+- app/assets/stylesheets/collab/application.css
+- app/assets/stylesheets/collab/documents.css
+- app/channels/application_cable/channel.rb
+- app/channels/application_cable/connection.rb
+- app/channels/edit_channel.rb
+- app/controllers/collab/application_controller.rb
+- app/controllers/collab/documents_controller.rb
+- app/helpers/collab/application_helper.rb
+- app/helpers/collab/documents_helper.rb
+- app/jobs/collab/application_job.rb
+- app/mailers/collab/application_mailer.rb
+- app/models/collab/application_record.rb
+- app/models/collab/document.rb
+- app/views/collab/documents/show.html.erb
+- app/views/layouts/collab/application.html.erb
+- config/cable.yml
+- config/initializers/assets.rb
+- config/routes.rb
+- db/migrate/20170222133537_create_collab_documents.rb
+- lib/collab.rb
+- lib/collab/engine.rb
+- lib/collab/version.rb
+- lib/tasks/collab_tasks.rake
+homepage: https://standardnotes.org
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Standard Notes editor with collaboration abilities.
+test_files: []