loose_leaf 0.0.1

data/app/channels/loose_leaf/collaboration_channel.rb

@@ -0,0 +1,56 @@
+module LooseLeaf
+  # An ActionCable channel for TLooseLeaf
+  class CollaborationChannel < ApplicationCable::Channel
+    attr_reader :client_id
+
+    def subscribed
+      @client_id = SecureRandom.uuid
+
+      transmit action: 'subscribed', client_id: client_id
+    end
+
+    # Subscribe to changes to a document
+    def document(data)
+      document = collaborative_model.find_by_collaborative_key(data['id'])
+
+      @documents ||= []
+      @documents << document
+
+      send_attribute_versions(document)
+
+      stream_from "loose_leaf.documents.#{document.id}.operations"
+    end
+
+    def operation(data)
+      data = ActiveSupport::HashWithIndifferentAccess.new(data)
+      document = collaborative_model.find_by_collaborative_key(data[:document_id])
+
+      version, operation = document.apply_operation(data)
+      data[:sent_version] = data[:version]
+      data[:version] = version
+      data[:operation] = operation.to_a
+
+      ActionCable.server.broadcast "loose_leaf.documents.#{document.id}.operations", data
+    end
+
+    private
+
+    def collaborative_model
+      raise 'You must override the collaborative_model method to specify your collaborative model'
+    end
+
+    # Send out initial versions
+    def send_attribute_versions(document)
+      collaborative_model.collaborative_attributes.each do |attribute_name|
+        attribute = document.collaborative_attribute(attribute_name)
+
+        transmit(
+          document_id: document.id,
+          action: 'attribute',
+          attribute: attribute_name,
+          version: attribute.version
+        )
+      end
+    end
+  end
+end

data/app/controllers/loose_leaf/application_controller.rb

@@ -0,0 +1,4 @@
+module LooseLeaf
+  class ApplicationController < ActionController::Base
+  end
+end

data/lib/loose_leaf.rb

@@ -0,0 +1,8 @@
+require 'ot'
+require 'loose_leaf/engine'
+require 'loose_leaf/document'
+require 'loose_leaf/document_attribute'
+
+module LooseLeaf
+  # Your code goes here...
+end

data/lib/loose_leaf/document.rb

@@ -0,0 +1,99 @@
+# code base
+# https://github.com/ball-hayden/Collaborate
+
+module LooseLeaf
+  module Document
+    extend ActiveSupport::Concern
+
+    included do
+      after_initialize :setup_collaborative_attributes
+    end
+
+    module ClassMethods
+      def collaborative_attributes(*attributes)
+        return @collaborative_attributes if attributes.size.zero?
+
+        @collaborative_attributes = attributes.map(&:to_s)
+
+        bind_collaborative_document_attributes
+      end
+
+      def collaborative_key(attribute = nil)
+        return @collaborative_key || :id if attribute.blank?
+        @collaborative_key ||= attribute
+      end
+
+      def find_by_collaborative_key(key)
+        query = {}
+        query[collaborative_key] = key
+        find_by(query)
+      end
+
+      private
+
+      def bind_collaborative_document_attributes
+        collaborative_attributes.each do |attribute|
+          bind_collaborative_document_attribute(attribute)
+        end
+      end
+
+      def bind_collaborative_document_attribute(attribute)
+        define_method("collaborative_#{attribute}") do
+          collaborative_attribute(attribute).value
+        end
+
+        define_method("collaborative_#{attribute}=") do |value|
+          collaborative_attribute(attribute).value = value
+        end
+
+        # Override the normal setter so that we can update our cache
+        define_method("#{attribute}=") do |value|
+          super(value)
+
+          collaborative_attribute(attribute).value = value
+        end
+      end
+    end
+
+    def collaborative_attribute(attribute_name)
+      @collaborative_attributes[attribute_name.to_s]
+    end
+
+    def collaborative_id
+      @collaborative_id ||= send(self.class.collaborative_key)
+    end
+
+    def apply_operation(data)
+      operation = OT::TextOperation.from_a data[:operation]
+      attribute = data[:attribute]
+      version = data[:version]
+
+      collaborative_attribute(attribute).apply_operation(operation, version)
+    end
+
+    def commit_collaborative_attributes(*attributes)
+      attributes = attributes.flatten.map(&:to_s)
+
+      # Intersect with allowed attributes
+      attributes &= self.class.collaborative_attributes
+
+      attributes.each do |attribute|
+        send("#{attribute}=", send("collaborative_#{attribute}"))
+      end
+
+      save
+    end
+
+    def clear_collaborative_cache(attribute)
+      collaborative_attribute(attribute).clear_cache
+    end
+
+    def setup_collaborative_attributes
+      @collaborative_attributes = {}
+
+      self.class.collaborative_attributes.each do |attribute|
+        @collaborative_attributes[attribute] = DocumentAttribute.new(self, attribute)
+      end
+    end
+  end
+end

data/lib/loose_leaf/document_attribute.rb

@@ -0,0 +1,90 @@
+module LooseLeaf
+  class DocumentAttribute
+    attr_reader :document, :attribute
+
+    def initialize(document, attribute)
+      @document = document
+      @attribute = attribute
+
+      @operations = []
+    end
+
+    # Based on https://github.com/Operational-Transformation/ot.js/blob/15d4e7/lib/server.js#L16
+    def apply_operation(operation, client_version)
+      Rails.logger.debug "Applying client version #{client_version}, server version: #{version}"
+
+      unless client_version > version
+        operation = transform_old_operation(operation, client_version)
+      end
+
+      store_operation(operation)
+
+      self.value = new_text(operation)
+
+      [version, operation]
+    end
+
+    def version
+      operations.length
+    end
+
+    def value
+      cached_value || document.attributes[attribute.to_s]
+    end
+
+    def value=(value)
+      return unless document.persisted?
+
+      Rails.cache.write(value_key, value)
+    end
+
+    def clear_cache
+      Rails.cache.delete(value_key)
+    end
+
+    def clear_operations_cache
+      Rails.cache.delete(operations_key)
+    end
+
+    private
+
+    def value_key
+      "loose_leaf-#{document.class}-#{document.id}-#{attribute}"
+    end
+
+    def cached_value
+      return unless document.persisted?
+      Rails.cache.read(value_key)
+    end
+
+    def operations_key
+      "loose_leaf-#{document.class}-#{document.id}-#{attribute}-operations"
+    end
+
+    def operations
+      Rails.cache.read(operations_key) || []
+    end
+
+    def store_operation(operation)
+      Rails.cache.write(operations_key, operations + [operation])
+    end
+
+    def new_text(operation)
+      operation.apply(value || '')
+    end
+
+    def transform_old_operation(operation, client_version)
+      server_version = version
+      concurrent_operations = operations.slice(
+          client_version - 1,
+          server_version - client_version + 1
+      )
+
+      concurrent_operations.each do |other_operation|
+        operation = OT::TextOperation.transform(operation, other_operation).first
+      end
+
+      operation
+    end
+  end
+end

data/lib/loose_leaf/engine.rb

@@ -0,0 +1,16 @@
+module LooseLeaf
+  class Engine < ::Rails::Engine
+    isolate_namespace LooseLeaf
+
+    initializer 'loose_leaf.vendor_assets' do |app|
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.factory_girl suffix: 'factory'
+      g.helper false
+      g.stylesheets false
+      g.javascripts false
+    end
+  end
+end

data/lib/loose_leaf/version.rb

@@ -0,0 +1,3 @@
+module LooseLeaf
+  VERSION = '0.0.1'.freeze
+end

data/lib/tasks/loose_leaf_tasks.rake

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

metadata

@@ -0,0 +1,342 @@
+--- !ruby/object:Gem::Specification
+name: loose_leaf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Akira Takahashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-19 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.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+- !ruby/object:Gem::Dependency
+  name: ot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-state
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- rike422@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/loose_leaf/index.js
+- app/channels/loose_leaf/collaboration_channel.rb
+- app/controllers/loose_leaf/application_controller.rb
+- lib/loose_leaf.rb
+- lib/loose_leaf/document.rb
+- lib/loose_leaf/document_attribute.rb
+- lib/loose_leaf/engine.rb
+- lib/loose_leaf/version.rb
+- lib/tasks/loose_leaf_tasks.rake
+homepage: https://github.com/rike422/loose-leaf
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Rails gem for real-time collaboration using ActionCable
+test_files: []