collab 0.1.7 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0a566794428295f9b9ff7c624b1c6f936804bc071756766f340df9637e16938
-  data.tar.gz: 0ccfbe46ff5f6273bfc14aac4d9e22e21a7d20e0a23b4acdfa63ef8968ea0ee7
+  metadata.gz: 4f8a71ae9b78062335060274fe354cfe2af0dadd83efe5c23509148d4121b4b2
+  data.tar.gz: dc1aaa0904bad425bb9f8ec101ec6f760ea64325380ec03a99b1b50194e9072d
 SHA512:
-  metadata.gz: cd20428b6337a7f7609825d01369b3ac0374c17e72eafb81d3ed6239f01ca7e8061ca4f620e7e0278f279ca2ffbe0608a8fc3612f77de2e733470f09456a3e0c
-  data.tar.gz: cc80222ba503f5b2605f77e81615397527fea9865d4b599657bd95226b4eda8bca1979347c2ddbdd6ddbe0ffcea098613b12fddd00c2b745755fc2f23f0e7ab5
+  metadata.gz: 47b8fd7d8996d1b7a417850c88c6c25fe985e02bb71e4e4783f5e36e5758c556295de77a64ac4035282598578dc26c3977e7a7f555811940b4a0e4f8c9423997
+  data.tar.gz: 5c2ca0065053132e5348392fca773696700bc326436bdac01aa22b8091734701544dcbbba52456c7f092d7dbf4204a7d077c8326c8ec256d70e459dcc582e2c4

data/lib/collab.rb

@@ -1,4 +1,4 @@
-require "collab/railtie"
+require "collab/engine"
 
 module Collab
   def self.config
@@ -7,6 +7,7 @@ module Collab
     yield @config
   end
 
+  autoload "Channel", "collab/channel"
   autoload "Config", "collab/config"
   autoload "Bridge", "collab/bridge"
   autoload "HasCollaborativeDocument", "collab/has_collaborative_document"

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
 
@@ -40,7 +40,7 @@ module Collab
     end
     
     def apply_transaction(document, transaction, schema_name:)
-      call("applyTransaction", {doc: document, data: transaction}, schema_name: schemaName)
+      call("applyTransaction", {doc: document, data: transaction}, schema_name: schema_name)
     end
 
     def html_to_document(html, schema_name:)

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/engine.rb

@@ -0,0 +1,4 @@
+module Collab
+  class Engine < ::Rails::Engine
+  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.7'
+  VERSION = '0.2.2'
 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!(data)
+    raise "authorization failed"
+  end
+end

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.7
+  version: 0.2.2
 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,18 +52,19 @@ 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/engine.rb
 - lib/collab/has_collaborative_document.rb
 - lib/collab/models/base.rb
 - lib/collab/models/document.rb
 - lib/collab/models/document_transaction.rb
-- 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

data/lib/collab/railtie.rb

@@ -1,4 +0,0 @@
-module Collab
-  class Railtie < ::Rails::Railtie
-  end
-end