collab 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cb3d5c84a09fbfdcadf548291acb8c10029accff305db17230b93d18516a7a8
-  data.tar.gz: 79496d3f80f590a45702ac7b5ccb2bd1f8b8eb7a7aa12cf17e8a90775c81ed13
+  metadata.gz: ae9c092826099d0d81012ba20446f93518d9f998136d110ae71141bed2a58e22
+  data.tar.gz: e6de0fca8c103f77bdf6677fb0ab993a8740eae2baf7292f28cf601a5946f4b7
 SHA512:
-  metadata.gz: 821930a89df64df41fb0efc9e7963392e0d935b172c44cdf5270b48c4e1a4c7da052055ae478ba19fe01b30c652b2d3eb8c61c7b8f8c3ec00a8ea08e16acacca
-  data.tar.gz: 4010cd1d1b9457897739a0336ec93a277fa14e464bceb5f6bd6f488154696d4874f8b6695dd9fc3871233585a375c0a1c6f04a8e5f52f71ffc5690ea873f2e5a
+  metadata.gz: a9db9beb2c46f7b4818fd494075ddb31ee68bcb137c3a347f71acf754efc3788afbaf2b67248b9e7b1a9bd80a780015a2a1db5a5778533823d32a83134550954
+  data.tar.gz: d65efb8027b52bf44c14e3a36829f66a845130dca3cffaf002b0ec0fe8cdeed2a137fd6e671aff6555c52ed03705b66e72f54fab5b2872aaa30d872f4f83d476

data/lib/collab.rb

@@ -1,3 +1,5 @@
+require "collab/railtie"
+
 module Collab
   def self.config
     @config ||= Collab::Config.new
@@ -7,7 +9,6 @@ module Collab
 
   autoload "Config", "collab/config"
   autoload "Bridge", "collab/bridge"
-  autoload "Railtie", "collab/railtie"
   autoload "HasCollaborativeDocument", "collab/has_collaborative_document"
   
   module Models

data/lib/collab/bridge.rb

@@ -23,7 +23,7 @@ module Collab
     
     def initialize
       @node = Dir.chdir(Rails.root) do
-        IO.popen(["node", "-e", %q{"require('rails-collab-server')"}], "r+")
+        IO.popen(["node", "-e", "require('rails-collab-server')"], "r+")
       end
     end
 
@@ -31,24 +31,24 @@ module Collab
       @current ||= new
     end
 
-    def call(name, data = nil, schemaName:)
-      req = {name: name, data: data, schemaPackage: ::Collab.config.schema_package, schemaName: schemaName}
+    def call(name, data = nil, schema_name:)
+      req = {name: name, data: data, schemaPackage: ::Collab.config.schema_package, schemaName: schema_name}
       @node.puts(JSON.generate(req))
       res = JSON.parse(@node.gets)
       raise ::Collab::Bridge::JSRuntimeError.new(res["error"]) if res["error"]
       res["result"]
     end
     
-    def apply_transaction(document, transaction, schemaName:)
-      call("applyTransaction", {doc: document, data: transaction}, schemaName: schemaName)
+    def apply_transaction(document, transaction, schema_name:)
+      call("applyTransaction", {doc: document, data: transaction}, schema_name: schema_name)
     end
 
-    def html_to_document(html, schemaName:)
-      call("htmlToDoc", html, schemaName: schemaName)
+    def html_to_document(html, schema_name:)
+      call("htmlToDoc", html, schema_name: schema_name)
     end
 
-    def document_to_html(document, schemaName:)
-      call("docToHtml", document, schemaName: schemaName)
+    def document_to_html(document, schema_name:)
+      call("docToHtml", document, schema_name: schema_name)
     end
   end
 end

data/lib/collab/channel.rb

@@ -0,0 +1,32 @@
+module Collab
+  module Channel
+    def document; @document end
+
+    def subscribed
+      @document = find_document
+
+      starting_version = params[:startingVersion]&.to_i
+      raise "missing startingVersion" if starting_version.nil?
+
+      stream_for document
+      
+      transactions = document.transactions
+                              .where("document_version > ?", starting_version)
+                              .order(document_version: :asc)
+                              .load
+              
+      raise "invalid version" unless transactions.first.document_version == (starting_version + 1) unless transactions.empty?
+
+      transactions.lazy.map(&:as_json).each(method(:transmit))
+    end
+
+    def submit(data)
+      authorize_submit!(data)
+      document.perform_transaction_later(data)
+    end
+
+    def unsubscribed
+      stop_all_streams # this may not be needed
+    end
+  end
+end

data/lib/collab/config.rb

@@ -1,15 +1,5 @@
 module Collab
   class Config
-    attr_accessor :max_transactions, :application_job, :queue_document_transaction_job_as, :schema_package, :application_record, :document_transaction_model, :document_model
-    
-    def find_document_for_subscribe(&block)
-      @find_document_for_subscribe unless block
-      @find_document_for_subscribe = block
-    end
-
-    def authorize_update_document(&block)
-      @authorize_update_document unless block
-      @authorize_update_document = block
-    end
+    attr_accessor :max_transactions, :application_job, :queue_document_transaction_job_as, :schema_package, :application_record, :document_transaction_model, :document_model, :channel_name
   end
 end

data/lib/collab/models/document.rb

@@ -29,8 +29,6 @@ module Collab
     end
 
     def from_html(html)
-      raise "cannot override a persisted document" if self.persisted?
-      
       self.document = ::Collab::Bridge.current.html_to_document(html, schema_name: schema_name)
     end
 

data/lib/collab/models/document_transaction.rb

@@ -16,7 +16,7 @@ module Collab
     end
 
     def broadcast
-      ::Collab::DocumentChannel.broadcast_to(document, as_json)
+      ::Collab.config.channel_name.constantize.broadcast_to(document, as_json)
     end
   end
-end
+end

data/lib/collab/version.rb

@@ -1,3 +1,3 @@
 module Collab
-  VERSION = '0.1.5'
+  VERSION = '0.2.0'
 end

data/lib/generators/collab/install/install_generator.rb

@@ -22,6 +22,8 @@ module Collab
         "db/migrate/create_collab_tables.rb",
       )
       
+      copy_file "channel.rb", "app/channels/collab_document_channel.rb"
+
       copy_file "initializer.rb", "config/initializers/collab.rb"
     end
   end

data/lib/generators/collab/install/templates/channel.rb

@@ -0,0 +1,19 @@
+class CollabDocumentChannel < ApplicationCable::Channel
+  include Collab::Channel
+
+  private
+
+  # Find the document to subscribe to based on the params passed to the channel
+  # Authorization may also be performed here (raise an error)
+  def find_document
+    Collab::Models::Document.find(params[:document_id]).tap do |document|
+      raise "authorization failed"
+    end
+  end
+
+  # Called when a client submits a transaction in order to update a document
+  # You should throw an error if unauthorized
+  def authorize_submit!
+    raise "authorization failed"
+  end
+end

data/lib/generators/collab/install/templates/create_collab_tables.rb

@@ -17,7 +17,7 @@ class CreateCollabTables < ActiveRecord::Migration[6.0]
     end
 
     create_table :collab_document_transactions, id: false do |t|
-      t.references :document, null: false, foreign_key: {to_table: :collaborative_documents}, type: :uuid, index: false
+      t.references :document, null: false, foreign_key: {to_table: :collab_documents}, type: :uuid, index: false
 
       t.jsonb :steps, array: true, null: false
       t.integer :document_version, null: false

data/lib/generators/collab/install/templates/initializer.rb

@@ -6,20 +6,11 @@ Collab.config do |c|
   # How many old transactions to keep per document
   c.max_transactions = 250
 
-  # Handlers
-  # ========
-  # Find a the document to subscribe to based on the params passed to the channel
-  # Authorization may also be performed here (raise an error)
-  # The block is executed in the scope of the ActionCable channel within #subscribe
-  c.find_document_for_subscribe do
-    Collab::Models::Document.find params[:document_id]
-  end
-  # Called when a client submits a transaction in order to update a document
-  # You should throw an error if unauthorized
-  # The block is executed in the instance of the channel
-  c.authorize_update_document do |document, transaction_data|
-    # raise "authorization failed"
-  end
+  # ActionCable settings
+  # ====================
+  # The document channel to use for collaboration
+  # If you change this, you must pass {channel: "[ChannelName]"} as subscription params to the Javascript client
+  c.channel_name = "::CollabDocumentChannel"
 
   # ActionJob settings
   # ==================

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: collab
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Aubin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-30 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,10 +52,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Rakefile
-- app/channels/collab/document_channel.rb
 - app/jobs/collab/document_transaction_job.rb
 - lib/collab.rb
 - lib/collab/bridge.rb
+- lib/collab/channel.rb
 - lib/collab/config.rb
 - lib/collab/has_collaborative_document.rb
 - lib/collab/models/base.rb
@@ -64,6 +64,7 @@ files:
 - lib/collab/railtie.rb
 - lib/collab/version.rb
 - lib/generators/collab/install/install_generator.rb
+- lib/generators/collab/install/templates/channel.rb
 - lib/generators/collab/install/templates/create_collab_tables.rb
 - lib/generators/collab/install/templates/initializer.rb
 - lib/tasks/collab_tasks.rake

data/app/channels/collab/document_channel.rb

@@ -1,28 +0,0 @@
-class Collab::DocumentChannel < ApplicationCable::Channel
-  def subscribed
-    @document = instance_exec(::Collab.config.find_document_for_subscribe)
-
-    starting_version = params[:startingVersion]&.to_i
-    raise "missing startingVersion" if starting_version.nil?
-
-    stream_for @document
-    
-    transactions = @document.transactions
-                            .where("document_version > ?", starting_version)
-                            .order(document_version: :asc)
-                            .load
-            
-    raise "invalid version" unless transactions.first.document_version == (starting_version + 1) unless transactions.empty?
-
-    transactions.lazy.map(&:as_json).each(method(:transmit))
-  end
-
-  def submit(data)
-    instance_exec(@document, data, &::Collab.config.authorize_update_document)
-    @document.perform_transaction_later(data)
-  end
-
-  def unsubscribed
-    stop_all_streams # this may not be needed
-  end
-end