live_record 0.0.4 → 0.1.0

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

@@ -1,4 +1,4 @@
 class LiveRecordChannel < ApplicationCable::Channel
   include ActiveSupport::Rescuable
-  include LiveRecord::Channel
+  include LiveRecord::Channel::Implement
 end

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

@@ -9,6 +9,9 @@ class <%= class_name %> < <%= parent_class_name.classify %>
 <% if attributes.any?(&:password_digest?) -%>
   has_secure_password
 <% end -%>
+  
+  include LiveRecord::Model::Callbacks
+  has_many :live_record_updates, as: :recordable
 
   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.

data/lib/live_record/model/callbacks.rb

@@ -0,0 +1,36 @@
+module LiveRecord
+  module Model
+    module Callbacks
+      extend ActiveSupport::Concern
+
+      included do
+        before_update :__live_record_reference_changed_attributes__
+        after_update_commit :__live_record_broadcast_record_update__
+        after_destroy_commit :__live_record_broadcast_record_destroy__
+
+        def self.live_record_whitelisted_attributes(record, current_user)
+          []
+        end
+
+        private
+
+        def __live_record_reference_changed_attributes__
+          @_live_record_changed_attributes = changed
+        end
+
+        def __live_record_broadcast_record_update__
+          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)
+          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)
+        end
+      end
+    end
+  end
+end

data/lib/live_record/spec/factories/posts.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  factory :post do
+    title { Faker::Lorem.sentence }
+    content { Faker::Lorem.paragraph }
+  end
+end

data/lib/live_record/spec/features/live_record_syncing_spec.rb

@@ -0,0 +1,60 @@
+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) 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
+
+  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
+end

data/lib/live_record/spec/internal/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/lib/live_record/spec/internal/app/assets/javascripts/application.js

@@ -0,0 +1,17 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, or any plugin's
+// vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require jquery
+//= require live_record
+//= require live_record/plugins/live_dom
+//= require_tree .

data/lib/live_record/spec/internal/app/assets/javascripts/cable.js

@@ -0,0 +1,12 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

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

@@ -0,0 +1,14 @@
+LiveRecord.Model.create(
+  {
+    modelName: 'Post',
+    plugins: {
+      LiveDOM: true
+    },
+    # See TODO: URL_TO_DOCUMENTATION for supported callbacks
+    # Add Callbacks (callback name => array of functions)
+    # callbacks: {
+    #   'on:disconnect': [],
+    #   'after:update': [],
+    # }
+  }
+)

data/lib/live_record/spec/internal/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

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

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

data/lib/live_record/spec/internal/app/channels/live_record_channel.rb

@@ -0,0 +1,4 @@
+class LiveRecordChannel < ApplicationCable::Channel
+  include ActiveSupport::Rescuable
+  include LiveRecord::Channel::Implement
+end

data/lib/live_record/spec/internal/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/lib/live_record/spec/internal/app/controllers/posts_controller.rb

@@ -0,0 +1,74 @@
+class PostsController < ApplicationController
+  before_action :set_post, only: [:show, :edit, :update, :destroy]
+
+  # GET /posts
+  # GET /posts.json
+  def index
+    @posts = Post.all
+  end
+
+  # GET /posts/1
+  # GET /posts/1.json
+  def show
+  end
+
+  # GET /posts/new
+  def new
+    @post = Post.new
+  end
+
+  # GET /posts/1/edit
+  def edit
+  end
+
+  # POST /posts
+  # POST /posts.json
+  def create
+    @post = Post.new(post_params)
+
+    respond_to do |format|
+      if @post.save
+        format.html { redirect_to @post, notice: 'Post was successfully created.' }
+        format.json { render :show, status: :created, location: @post }
+      else
+        format.html { render :new }
+        format.json { render json: @post.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PATCH/PUT /posts/1
+  # PATCH/PUT /posts/1.json
+  def update
+    respond_to do |format|
+      if @post.update(post_params)
+        format.html { redirect_to @post, notice: 'Post was successfully updated.' }
+        format.json { render :show, status: :ok, location: @post }
+      else
+        format.html { render :edit }
+        format.json { render json: @post.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /posts/1
+  # DELETE /posts/1.json
+  def destroy
+    @post.destroy
+    respond_to do |format|
+      format.html { redirect_to posts_url, notice: 'Post was successfully destroyed.' }
+      format.json { head :no_content }
+    end
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_post
+      @post = Post.find(params[:id])
+    end
+
+    # Never trust parameters from the scary internet, only allow the white list through.
+    def post_params
+      params.require(:post).permit(:title, :content)
+    end
+end

data/lib/live_record/spec/internal/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/lib/live_record/spec/internal/app/models/live_record_update.rb

@@ -0,0 +1,3 @@
+class LiveRecordUpdate < ApplicationRecord
+  belongs_to :recordable, polymorphic: true
+end

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

@@ -0,0 +1,11 @@
+class Post < ApplicationRecord
+	include LiveRecord::Model::Callbacks
+
+	has_many :live_record_updates, as: :recordable
+
+  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]
+  end
+end

data/lib/live_record/spec/internal/app/views/layouts/application.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>LiveRecordExample</title>
+    <%= csrf_meta_tags %>
+    
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/lib/live_record/spec/internal/app/views/posts/_form.html.erb

@@ -0,0 +1,27 @@
+<%= form_with(model: post, local: true) do |form| %>
+  <% if post.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(post.errors.count, "error") %> prohibited this post from being saved:</h2>
+
+      <ul>
+      <% post.errors.full_messages.each do |message| %>
+        <li><%= message %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= form.label :title %>
+    <%= form.text_field :title, id: :post_title %>
+  </div>
+
+  <div class="field">
+    <%= form.label :content %>
+    <%= form.text_area :content, id: :post_content %>
+  </div>
+
+  <div class="actions">
+    <%= form.submit %>
+  </div>
+<% end %>

data/lib/live_record/spec/internal/app/views/posts/_post.json.jbuilder

@@ -0,0 +1,2 @@
+json.extract! post, :id, :title, :content, :created_at, :updated_at
+json.url post_url(post, format: :json)

data/lib/live_record/spec/internal/app/views/posts/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing Post</h1>
+
+<%= render 'form', post: @post %>
+
+<%= link_to 'Show', @post %> |
+<%= link_to 'Back', posts_path %>

data/lib/live_record/spec/internal/app/views/posts/index.html.erb

@@ -0,0 +1,32 @@
+<script>
+  LiveRecord.helpers.loadRecords({modelName: 'Post'})
+</script>
+<p id="notice"><%= notice %></p>
+
+<h1>Posts</h1>
+
+<table>
+  <thead>
+    <tr>
+      <th>Title</th>
+      <th>Content</th>
+      <th colspan="3"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @posts.each do |post| %>
+      <tr data-live-record-destroy-from='Post-<%= post.id %>'>
+        <td data-live-record-update-from='Post-<%= post.id %>-title'><%= post.title %></td>
+        <td data-live-record-update-from='Post-<%= post.id %>-content'><%= post.content %></td>
+        <td><%= link_to 'Show', post %></td>
+        <td><%= link_to 'Edit', edit_post_path(post) %></td>
+        <td><%= link_to 'Destroy', post, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<br>
+
+<%= link_to 'New Post', new_post_path %>

data/lib/live_record/spec/internal/app/views/posts/index.json.jbuilder

@@ -0,0 +1 @@
+json.array! @posts, partial: 'posts/post', as: :post

data/lib/live_record/spec/internal/app/views/posts/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New Post</h1>
+
+<%= render 'form', post: @post %>
+
+<%= link_to 'Back', posts_path %>

data/lib/live_record/spec/internal/app/views/posts/show.html.erb

@@ -0,0 +1,21 @@
+<script>
+  LiveRecord.helpers.loadRecords({modelName: 'Post'})
+</script>
+<p id="notice"><%= notice %></p>
+
+<p>
+  <strong>Title:</strong>
+  <span data-live-record-update-from='Post-<%= @post.id %>-title'>
+  	<%= @post.title %>
+  </span>
+</p>
+
+<p>
+  <strong>Content:</strong>
+  <span data-live-record-update-from='Post-<%= @post.id %>-content'>
+  	<%= @post.content %>
+  </span>
+</p>
+
+<%= link_to 'Edit', edit_post_path(@post) %> |
+<%= link_to 'Back', posts_path %>

data/lib/live_record/spec/internal/app/views/posts/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! "posts/post", post: @post

data/lib/live_record/spec/internal/config/cable.yml

@@ -0,0 +1,8 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: async

data/lib/live_record/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite