live_record 0.1.2 → 0.2.0

data/lib/live_record.rb

@@ -6,6 +6,8 @@ Dir[__dir__ + '/live_record/*.rb'].each {|file| require file }
 Dir[__dir__ + '/live_record/model/*.rb'].each {|file| require file }
 Dir[__dir__ + '/live_record/channel/*.rb'].each {|file| require file }
 Dir[__dir__ + '/live_record/generators/*.rb'].each {|file| require file }
+Dir[__dir__ + '/live_record/overrides/*.rb'].each {|file| require file }
+Dir[__dir__ + '/live_record/action_view_extensions/*.rb'].each {|file| require file }
 
 module LiveRecord
 end

data/lib/live_record/action_view_extensions/view_helper.rb

@@ -0,0 +1,22 @@
+module LiveRecord
+  module ActionViewExtensions
+    module ViewHelper
+      def live_record_element(record)
+        raw " data-live-record-element='#{record.class.name}-#{record.id}' "
+      end
+
+      def live_record_updatable(record, attribute)
+        raise ArgumentError, "[#{record.class}] does not have an attribute named [#{attribute}]" unless record.attribute_names.include? attribute.to_s
+        raw " data-live-record-update-from='#{record.class.name}-#{record.id}-#{attribute}' "
+      end
+
+      def live_record_destroyable(record)
+        raw " data-live-record-destroy-from='#{record.class.name}-#{record.id}' "
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:action_view) do
+  include LiveRecord::ActionViewExtensions::ViewHelper
+end

data/lib/live_record/configure.rb

@@ -0,0 +1,19 @@
+require 'ostruct'
+
+module LiveRecord
+
+  class Configuration < OpenStruct
+  end
+
+  @configuration = Configuration.new(
+    sync_record_buffer_time: 1.minute
+  )
+
+  class << self
+    attr_accessor :configuration
+
+    def configure(&block)
+      block.call(@configuration)
+    end
+  end
+end

data/lib/live_record/generators/install_generator.rb

@@ -32,10 +32,15 @@ module LiveRecord
         migration_template 'create_live_record_updates.rb', 'db/migrate/create_live_record_updates.rb'
       end
 
-      def copy_live_record_channel_template
-        class_collisions 'LiveRecordChannel'
-        template 'live_record_channel.rb', File.join('app/channels', 'live_record_channel.rb')
-      end
+      # def copy_live_record_changes_channel_template
+      #   class_collisions 'LiveRecordChangesChannel'
+      #   template 'live_record_changes_channel.rb', File.join('app/channels', 'live_record_changes_channel.rb')
+      # end
+
+      # def copy_live_record_publication_channel_template
+      #   class_collisions 'LiveRecordPublicationChannel'
+      #   template 'live_record_publication_channel.rb', File.join('app/channels', 'live_record_publication_channel.rb')
+      # end
 
       def update_application_javascript
         in_root do

data/lib/live_record/generators/templates/create_live_record_updates.rb

@@ -1,5 +1,5 @@
 class CreateLiveRecordUpdates < ActiveRecord::Migration[5.0]
-	def change
+  def change
     create_table :live_record_updates do |t|
       t.references :recordable, polymorphic: true
       t.datetime :created_at, null: false, index: true

data/lib/live_record/generators/templates/index.html.erb

@@ -1,5 +1,6 @@
 <script>
   LiveRecord.helpers.loadRecords({modelName: '<%= singular_table_name.camelcase %>'})
+  LiveRecord.Model.all.<%= singular_table_name.camelcase %>.subscribe();
 </script>
 <p id="notice"><%%= notice %></p>
 

data/lib/live_record/generators/templates/model.rb.rb

@@ -11,12 +11,12 @@ class <%= class_name %> < <%= parent_class_name.classify %>
 <% end -%>
   
   include LiveRecord::Model::Callbacks
-  has_many :live_record_updates, as: :recordable
+  has_many :live_record_updates, as: :recordable, dependent: :destroy
 
   def self.live_record_whitelisted_attributes(<%= class_name.underscore %>, current_user)
-	  # Add attributes to this array that you would like current_user to have access to.
-	  # Defaults to empty array, thereby blocking everything by default, only unless explicitly stated here so.
-	  []
+    # Add attributes to this array that you would like current_user to have access to.
+    # Defaults to empty array, thereby blocking everything by default, only unless explicitly stated here so.
+    []
   end
 end
 <% end -%>

data/lib/live_record/model/callbacks.rb

@@ -7,6 +7,7 @@ module LiveRecord
         before_update :__live_record_reference_changed_attributes__
         after_update_commit :__live_record_broadcast_record_update__
         after_destroy_commit :__live_record_broadcast_record_destroy__
+        after_create_commit :__live_record_broadcast_record_create__
 
         def self.live_record_whitelisted_attributes(record, current_user)
           []
@@ -22,13 +23,18 @@ module LiveRecord
           included_attributes = attributes.slice(*@_live_record_changed_attributes)
           @_live_record_changed_attributes = nil
           message_data = { 'action' => 'update', 'attributes' => included_attributes }
-          LiveRecordChannel.broadcast_to(self, message_data)
+          LiveRecord::ChangesChannel.broadcast_to(self, message_data)
           LiveRecordUpdate.create!(recordable_type: self.class, recordable_id: self.id, created_at: DateTime.now)
         end
 
         def __live_record_broadcast_record_destroy__
           message_data = { 'action' => 'destroy' }
-          LiveRecordChannel.broadcast_to(self, message_data)
+          LiveRecord::ChangesChannel.broadcast_to(self, message_data)
+        end
+
+        def __live_record_broadcast_record_create__
+          message_data = { 'action' => 'create', 'attributes' => attributes }
+          ActionCable.server.broadcast "live_record:publications:#{self.class.name.underscore}", message_data
         end
       end
     end

data/lib/live_record/version.rb

@@ -1,3 +1,3 @@
 module LiveRecord
-	VERSION = '0.1.2'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/live_record.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name        = 'live_record'
   s.version     = LiveRecord::VERSION
   s.summary     = 'Rails 5 ActionCable Live JS Objects and DOM Elements'
-  s.description = "Auto-syncs records in client-side JS (through a Model DSL) from changes in the backend Rails server through ActionCable.\nAuto-updates DOM elements mapped to a record attribute, from changes.\nAutomatically resyncs after client-side reconnection."
+  s.description = "Auto-syncs records in client-side JS (through a Model DSL) from changes (updates/destroy) in the backend Rails server through ActionCable.\n Also supports streaming newly created records to client-side JS.\n Supports lost connection restreaming for both new records (create), and record-changes (updates/destroy).\n Auto-updates DOM elements mapped to a record attribute, from changes (updates/destroy)."
   s.authors     = ['Jules Roman B. Polidario']
   s.email       = 'jrpolidario@gmail.com'
   s.files       = `git ls-files`.split("\n")
@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'rails', '>= 5.0.0', '< 5.2'
 
+  s.add_development_dependency 'rails', '~> 5.1'
   s.add_development_dependency 'bundler', '~> 1.3'
   s.add_development_dependency 'rspec-rails', '~> 3.6'
   s.add_development_dependency 'combustion', '~> 0.7'
@@ -27,7 +28,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'sprockets-rails', '~> 3.2'
   s.add_development_dependency 'coffee-rails', '~> 4.2'
   s.add_development_dependency 'jbuilder', '~> 2.7'
-  s.add_development_dependency 'capybara', '~> 2.15'
   s.add_development_dependency 'chromedriver-helper', '~> 1.1'
   s.add_development_dependency 'selenium-webdriver', '~> 3.5'
   s.add_development_dependency 'faker', '~> 1.8'

data/spec/features/live_record_syncing_spec.rb

@@ -0,0 +1,184 @@
+require 'rails_helper'
+
+RSpec.feature 'LiveRecord Syncing', type: :feature do
+  let(:post1) { create(:post) }
+  let(:post2) { create(:post) }
+  let(:post3) { create(:post) }
+  let!(:posts) { [post1, post2, post3] }
+
+  scenario 'User sees live changes (updates) of post records', js: true do
+    visit '/posts'
+
+    post1_title_td = find('td', text: post1.title, wait: 10)
+    post2_title_td = find('td', text: post2.title, wait: 10)
+    post3_title_td = find('td', text: post3.title, wait: 10)
+
+    post1.update!(title: 'post1newtitle')
+    post2.update!(title: 'post2newtitle')
+
+    expect(post1_title_td).to have_content('post1newtitle', wait: 10)
+    expect(post2_title_td).to have_content('post2newtitle', wait: 10)
+    expect(post3_title_td).to have_content(post3.title, wait: 10)
+  end
+
+  scenario 'User sees live changes (destroy) of post records', js: true do
+    visit '/posts'
+
+    expect{find('td', text: post1.title, wait: 10)}.to_not raise_error
+    expect{find('td', text: post2.title, wait: 10)}.to_not raise_error
+    expect{find('td', text: post3.title, wait: 10)}.to_not raise_error
+
+    post1.destroy
+    post2.destroy
+
+    expect{find('td', text: post1.title)}.to raise_error Capybara::ElementNotFound
+    expect{find('td', text: post2.title)}.to raise_error Capybara::ElementNotFound
+    expect{find('td', text: post3.title)}.to_not raise_error
+  end
+
+  # see spec/internal/app/models/post.rb to view specified whitelisted attributes
+  scenario 'User sees live changes (updates) of post records, but only changes from whitelisted authorised attributes', js: true do
+    visit '/posts'
+
+    post1_title_td = find('td', text: post1.title, wait: 10)
+    post1_content_td = find('td', text: post1.content, wait: 10)
+    post2_title_td = find('td', text: post2.title, wait: 10)
+    post2_content_td = find('td', text: post2.content, wait: 10)
+    post3_title_td = find('td', text: post3.title, wait: 10)
+    post3_content_td = find('td', text: post3.content, wait: 10)
+
+    post1.update!(title: 'post1newtitle', content: 'post1newcontent')
+    post2.update!(title: 'post2newtitle', content: 'post2newcontent')
+    post3.update!(title: 'post3newtitle', content: 'post3newcontent')
+
+    expect(post1_title_td).to have_content('post1newtitle', wait: 10)
+    expect(post1_content_td).to_not have_content('post1newcontent')
+    expect(post2_title_td).to have_content('post2newtitle', wait: 10)
+    expect(post2_content_td).to_not have_content('post2newcontent')
+    expect(post3_title_td).to have_content('post3newtitle', wait: 10)
+    expect(post3_content_td).to_not have_content('post3newcontent')
+  end
+
+  # see spec/internal/app/views/posts/index.html.erb to see the subscribe "conditions"
+  scenario 'JS-Client receives live new (create) post records where specified "conditions" matched', js: true do
+    visit '/posts'
+
+    sleep(5)
+
+    post4 = create(:post, id: 98, is_enabled: true)
+    post5 = create(:post, id: 99, is_enabled: false)
+
+    wait before: -> { evaluate_script("LiveRecord.Model.all.Post.all[#{post4.id}] == undefined") }, becomes: -> (value) { value == false }
+    expect(evaluate_script("LiveRecord.Model.all.Post.all[#{post4.id}] == undefined")).to be false
+
+    wait before: -> { evaluate_script("LiveRecord.Model.all.Post.all[#{post5.id}] == undefined") }, becomes: -> (value) { value == true }
+    expect(evaluate_script("LiveRecord.Model.all.Post.all[#{post5.id}] == undefined")).to be true
+  end
+
+  # see spec/internal/app/views/posts/index.html.erb to see the subscribe "conditions"
+  scenario 'JS-Client receives live new (create) post records where only considered "conditions" are the whitelisted authorised attributes', js: true do
+    visit '/posts'
+
+    sleep(5)
+
+    # in index.html.erb:
+    # LiveRecord.Model.all.Post.subscribe({ where: { is_enabled: true, content: 'somecontent' }});
+    # because `content` is not whitelisted, therefore the `content` condition above is disregarded
+    post4 = create(:post, is_enabled: true, content: 'somecontent')
+    post5 = create(:post, is_enabled: true, content: 'contentisnotwhitelistedthereforewontbeconsidered')
+
+    wait before: -> { evaluate_script("LiveRecord.Model.all.Post.all[#{post4.id}] == undefined") }, becomes: -> (value) { value == false }
+    expect(evaluate_script("LiveRecord.Model.all.Post.all[#{post4.id}] == undefined")).to be false
+    
+    wait before: -> { evaluate_script("LiveRecord.Model.all.Post.all[#{post5.id}] == undefined") }, becomes: -> (value) { value == false }
+    expect(evaluate_script("LiveRecord.Model.all.Post.all[#{post5.id}] == undefined")).to be false
+  end
+
+  # see spec/internal/app/models/post.rb to view specified whitelisted attributes
+  scenario 'JS-Client receives live new (create) post records having only the whitelisted authorised attributes', js: true do
+    visit '/posts'
+
+    sleep(5)
+
+    post4 = create(:post, is_enabled: true, title: 'sometitle', content: 'somecontent')
+
+    wait before: -> { evaluate_script("LiveRecord.Model.all.Post.all[#{post4.id}] == undefined") }, becomes: -> (value) { value == false }
+    expect(evaluate_script("LiveRecord.Model.all.Post.all[#{post4.id}].title()")).to eq post4.title
+    expect(evaluate_script("LiveRecord.Model.all.Post.all[#{post4.id}].content()")).to eq nil
+  end
+
+  # see spec/internal/app/models/post.rb to view specified whitelisted attributes
+  context 'when client got disconnected, and then reconnected' do
+    scenario 'JS-Client resyncs stale records', js: true do
+      post_that_will_be_updated_while_disconnected_1 = create(:post, is_enabled: true)
+      post_that_will_be_updated_while_disconnected_2 = create(:post, is_enabled: true)
+
+      visit '/posts'
+
+      sleep(5)
+
+      disconnection_time = 20 # seconds
+
+      Thread.new do
+        sleep(2)
+
+        # temporarily stop all current publication_channel connections
+        ObjectSpace.each_object(LiveRecord::ChangesChannel) do |changes_channel|
+          changes_channel.connection.close
+        end
+
+        # then we update records while disconnected
+        post_that_will_be_updated_while_disconnected_1.update!(title: 'newtitle')
+        post_that_will_be_updated_while_disconnected_2.update!(title: 'newtitle')
+      end
+
+      # LiveRecord.stop_all_streams
+      sleep(disconnection_time)
+
+      wait before: -> { evaluate_script("LiveRecord.Model.all.Post.all[#{post_that_will_be_updated_while_disconnected_1.id}] == undefined") }, becomes: -> (value) { value == false }, duration: 10.seconds
+      expect(evaluate_script("LiveRecord.Model.all.Post.all[#{post_that_will_be_updated_while_disconnected_1.id}].title()")).to eq 'newtitle'
+
+      wait before: -> { evaluate_script("LiveRecord.Model.all.Post.all[#{post_that_will_be_updated_while_disconnected_2.id}] == undefined") }, becomes: -> (value) { value == false }
+      expect(evaluate_script("LiveRecord.Model.all.Post.all[#{post_that_will_be_updated_while_disconnected_2.id}].title()")).to eq 'newtitle'
+    end
+
+    scenario 'JS-Client receives all post records created during the time it got disconnected', js: true do
+      visit '/posts'
+
+      sleep(5)
+
+      disconnection_time = 20 # seconds
+
+      post_created_before_disconnection = nil
+      post_created_while_disconnected_1 = nil
+      post_created_while_disconnected_2 = nil
+
+      Thread.new do
+        sleep(2)
+
+        # temporarily stop all current publication_channel connections
+        ObjectSpace.each_object(LiveRecord::PublicationsChannel) do |publication_channel|
+          publication_channel.connection.close
+        end
+
+        # then we create records while disconnected
+        post_created_while_disconnected_1 = create(:post, is_enabled: true, created_at: (DateTime.now - LiveRecord.configuration.sync_record_buffer_time) + 30.seconds)
+        post_created_while_disconnected_2 = create(:post, is_enabled: true, created_at: (DateTime.now - LiveRecord.configuration.sync_record_buffer_time) + 99.hours)
+        # we need to create this here, otherwise it will be loaded on the Page immediately by the .loadRecords() in JS
+        post_created_before_disconnection = create(:post, is_enabled: true, created_at: (DateTime.now - LiveRecord.configuration.sync_record_buffer_time) - 30.seconds)
+      end
+
+      # LiveRecord.stop_all_streams
+      sleep(disconnection_time)
+
+      wait before: -> { evaluate_script("LiveRecord.Model.all.Post.all[#{post_created_while_disconnected_1.id}] == undefined") }, becomes: -> (value) { value == false }, duration: 10.seconds
+      expect(evaluate_script("LiveRecord.Model.all.Post.all[#{post_created_while_disconnected_1.id}] == undefined")).to be false
+
+      wait before: -> { evaluate_script("LiveRecord.Model.all.Post.all[#{post_created_while_disconnected_2.id}] == undefined") }, becomes: -> (value) { value == false }
+      expect(evaluate_script("LiveRecord.Model.all.Post.all[#{post_created_while_disconnected_2.id}] == undefined")).to be false
+
+      wait before: -> { evaluate_script("LiveRecord.Model.all.Post.all[#{post_created_before_disconnection.id}] == undefined") }, becomes: -> (value) { value == false }
+      expect(evaluate_script("LiveRecord.Model.all.Post.all[#{post_created_before_disconnection.id}] == undefined")).to be true
+    end
+  end
+end

data/spec/helpers/wait.rb

@@ -0,0 +1,19 @@
+module SpecHelpers
+  module Wait
+    # Wait before the value of the "before" Proc becomes "becomes",
+    # but only wait until "duration" number of seconds,
+    # while checking the value each "interval" seconds interval.
+    def wait(duration: 5.seconds, interval: (0.5).second, before:, becomes:)
+      # use a different thread to prevent blocking the main thread due to sleep()
+      Thread.new do
+        start = Time.now
+
+        loop do
+          break if becomes.call(before.call)
+          sleep interval.seconds
+          break if (Time.now - start).seconds > duration
+        end
+      end.join
+    end
+  end
+end

data/spec/internal/app/assets/javascripts/posts.coffee

@@ -0,0 +1,8 @@
+LiveRecord.Model.create(
+  {
+    modelName: 'Post',
+    plugins: {
+      LiveDOM: true
+    }
+  }
+)

data/{lib/live_record/spec → spec}/internal/app/channels/application_cable/connection.rb

@@ -1,8 +1,8 @@
 module ApplicationCable
   class Connection < ActionCable::Connection::Base
-  	identified_by :current_user
-
-  	def current_user
-  	end
+    identified_by :current_user
+    
+    def current_user
+    end
   end
 end

data/{lib/live_record/spec → spec}/internal/app/controllers/posts_controller.rb

@@ -4,6 +4,7 @@ class PostsController < ApplicationController
   # GET /posts
   # GET /posts.json
   def index
+    request.session['init'] = true if request.session.id.nil?
     @posts = Post.all
   end
 

data/spec/internal/app/models/post.rb

@@ -0,0 +1,11 @@
+class Post < ApplicationRecord
+  include LiveRecord::Model::Callbacks
+
+  has_many :live_record_updates, as: :recordable, dependent: :destroy
+
+  def self.live_record_whitelisted_attributes(post, current_user)
+    # Add attributes to this array that you would like current_user to have access to.
+    # Defaults to empty array, thereby blocking everything by default, only unless explicitly stated here so.
+    [:title, :is_enabled, :created_at, :updated_at]
+  end
+end