collab 0.1.8 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb2ee35163aa059b11156c14d30c0366c5f69b79475e0c7d7ee5a97fbcf9ade9
-  data.tar.gz: ded15f9d6aebc4fcd40adf92cb8105caeddd94b9894e596fe05fea1943518fa0
+  metadata.gz: 2efe75edc1fb38bc6c91ea6b81182c98258f1e8fef1e494356d25151871ebaa7
+  data.tar.gz: e7d6e12431300c01d37ebada5cd7d52c0dcbe6abec825ce7b436f76b5ddbbe52
 SHA512:
-  metadata.gz: fe270eefabd2bc3753bef65a2892a359da7b9c16a6d4d2dff3d94006645a767744aad493268a795d6f339cf0e13259b6d0d6a383656da2b811c0aae4262fcf03
-  data.tar.gz: 40da589d2a889569e10bbc6541892388ee6f061f0a6bca73fee2c8b470498a9211fd546c738da7dd184aa936ed56b2f5939136a82e0435195a0c85454b799961
+  metadata.gz: 143fc779846435452295416d8ed9f88497ee3bf56be85cbc6c091c95676eb7b1383119c61de85c639c402150a6e1efe940bee15e36509a9738b1f2dba0e14e72
+  data.tar.gz: b67060677d363c4a6527a505b4c6b3941b5f347e134db4fd7b3d6d530343f219964e268c7da702e4225acd076a1f8f6dcf63a9eb8ba62f577c78429b37897482

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
 

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

@@ -33,7 +33,7 @@ module Collab
     end
 
     def perform_transaction_later(data)
-      ::Collab::DocumentTransactionJob.perform_later(@document, data)
+      ::Collab::DocumentTransactionJob.perform_later(self, data)
     end
 
     def apply_transaction_now(data)

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.8'
+  VERSION = '0.2.3'
 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.8
+  version: 0.2.3
 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