live_record 0.1.2 → 0.2.0

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

@@ -1,5 +1,6 @@
 <script>
-  LiveRecord.helpers.loadRecords({modelName: 'Post'})
+  LiveRecord.helpers.loadRecords({ modelName: 'Post' });
+  LiveRecord.Model.all.Post.subscribe({ where: { is_enabled_eq: true, content_eq: 'somecontent' }});
 </script>
 <p id="notice"><%= notice %></p>
 
@@ -16,9 +17,9 @@
 
   <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>
+      <tr <%= live_record_destroyable(post) %>>
+        <td <%= live_record_updatable(post, :title) %>><%= post.title %></td>
+        <td <%= live_record_updatable(post, :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>
@@ -29,4 +30,4 @@
 
 <br>
 
-<%= link_to 'New Post', new_post_path %>
+<%= link_to 'New Post', new_post_path %>

data/{lib/live_record/spec → spec}/internal/db/schema.rb

@@ -10,7 +10,9 @@ ActiveRecord::Schema.define do
   create_table "posts", force: :cascade do |t|
     t.string "title"
     t.text "content"
+    t.boolean "is_enabled"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
+    t.index ["is_enabled"], name: "index_posts_on_is_enabled"
   end
 end

data/{lib/live_record/spec → spec}/rails_helper.rb

@@ -1,14 +1,16 @@
 ENV['RAILS_ENV'] ||= 'test'
 require 'spec_helper'
+Dir[__dir__ + '/helpers/*.rb'].each {|file| require file }
 
 ActiveRecord::Migration.maintain_test_schema!
 
-Capybara.javascript_driver = :selenium_chrome_headless
+Capybara.javascript_driver = :selenium_chrome_headless # :selenium_chrome 
 Capybara.server = :puma
 
 RSpec.configure do |config|
   config.include FactoryGirl::Syntax::Methods
   config.include Capybara::DSL
+  config.include SpecHelpers::Wait
 
   config.use_transactional_fixtures = true
   config.infer_spec_type_from_file_location!
@@ -21,7 +23,7 @@ RSpec.configure do |config|
     DatabaseCleaner.clean
     DatabaseCleaner.strategy = :deletion
   end
-
+  
   config.before(:each) do
     DatabaseCleaner.start
     DatabaseCleaner.clean

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: live_record
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Jules Roman B. Polidario
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2017-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -184,20 +198,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.15'
 - !ruby/object:Gem::Dependency
   name: chromedriver-helper
   requirement: !ruby/object:Gem::Requirement
@@ -255,30 +255,38 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 description: |-
-  Auto-syncs records in client-side JS (through a Model DSL) from changes in the backend Rails server through ActionCable.
-  Auto-updates DOM elements mapped to a record attribute, from changes.
-  Automatically resyncs after client-side reconnection.
+  Auto-syncs records in client-side JS (through a Model DSL) from changes (updates/destroy) in the backend Rails server through ActionCable.
+   Also supports streaming newly created records to client-side JS.
+   Supports lost connection restreaming for both new records (create), and record-changes (updates/destroy).
+   Auto-updates DOM elements mapped to a record attribute, from changes (updates/destroy).
 email: jrpolidario@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - Gemfile
 - README.md
-- app/assets/javascripts/live_record.js
-- app/assets/javascripts/live_record/helpers.js
+- Rakefile
+- app/assets/javascripts/live_record.coffee
+- app/assets/javascripts/live_record/helpers.coffee
 - app/assets/javascripts/live_record/helpers/load_records.coffee
-- app/assets/javascripts/live_record/model.js
+- app/assets/javascripts/live_record/helpers/spaceship.coffee
+- app/assets/javascripts/live_record/model.coffee
 - app/assets/javascripts/live_record/model/all.coffee
 - app/assets/javascripts/live_record/model/create.coffee
-- app/assets/javascripts/live_record/plugins.js
+- app/assets/javascripts/live_record/plugins.coffee
 - app/assets/javascripts/live_record/plugins/live_dom.coffee
+- app/assets/javascripts/live_record/plugins/live_dom/apply_to_model.coffee
+- app/channels/live_record/base_channel.rb
+- app/channels/live_record/changes_channel.rb
+- app/channels/live_record/publications_channel.rb
+- config.ru
 - lib/live_record.rb
-- lib/live_record/.rspec
-- lib/live_record/channel/implement.rb
-- lib/live_record/config.ru
+- lib/live_record/action_view_extensions/view_helper.rb
+- lib/live_record/configure.rb
 - lib/live_record/engine.rb
 - lib/live_record/generators/install_generator.rb
 - lib/live_record/generators/templates/create_live_record_updates.rb
@@ -290,38 +298,38 @@ files:
 - lib/live_record/generators/templates/model.rb.rb
 - lib/live_record/generators/templates/show.html.erb
 - lib/live_record/model/callbacks.rb
-- lib/live_record/spec/factories/posts.rb
-- lib/live_record/spec/features/live_record_syncing_spec.rb
-- lib/live_record/spec/internal/app/assets/config/manifest.js
-- lib/live_record/spec/internal/app/assets/javascripts/application.js
-- lib/live_record/spec/internal/app/assets/javascripts/cable.js
-- lib/live_record/spec/internal/app/assets/javascripts/posts.coffee
-- lib/live_record/spec/internal/app/channels/application_cable/channel.rb
-- lib/live_record/spec/internal/app/channels/application_cable/connection.rb
-- lib/live_record/spec/internal/app/channels/live_record_channel.rb
-- lib/live_record/spec/internal/app/controllers/application_controller.rb
-- lib/live_record/spec/internal/app/controllers/posts_controller.rb
-- lib/live_record/spec/internal/app/models/application_record.rb
-- lib/live_record/spec/internal/app/models/live_record_update.rb
-- lib/live_record/spec/internal/app/models/post.rb
-- lib/live_record/spec/internal/app/views/layouts/application.html.erb
-- lib/live_record/spec/internal/app/views/posts/_form.html.erb
-- lib/live_record/spec/internal/app/views/posts/_post.json.jbuilder
-- lib/live_record/spec/internal/app/views/posts/edit.html.erb
-- lib/live_record/spec/internal/app/views/posts/index.html.erb
-- lib/live_record/spec/internal/app/views/posts/index.json.jbuilder
-- lib/live_record/spec/internal/app/views/posts/new.html.erb
-- lib/live_record/spec/internal/app/views/posts/show.html.erb
-- lib/live_record/spec/internal/app/views/posts/show.json.jbuilder
-- lib/live_record/spec/internal/config/cable.yml
-- lib/live_record/spec/internal/config/database.yml
-- lib/live_record/spec/internal/config/routes.rb
-- lib/live_record/spec/internal/db/schema.rb
-- lib/live_record/spec/internal/public/favicon.ico
-- lib/live_record/spec/rails_helper.rb
-- lib/live_record/spec/spec_helper.rb
 - lib/live_record/version.rb
 - live_record.gemspec
+- spec/factories/posts.rb
+- spec/features/live_record_syncing_spec.rb
+- spec/helpers/wait.rb
+- spec/internal/app/assets/config/manifest.js
+- spec/internal/app/assets/javascripts/application.js
+- spec/internal/app/assets/javascripts/cable.js
+- spec/internal/app/assets/javascripts/posts.coffee
+- spec/internal/app/channels/application_cable/channel.rb
+- spec/internal/app/channels/application_cable/connection.rb
+- spec/internal/app/controllers/application_controller.rb
+- spec/internal/app/controllers/posts_controller.rb
+- spec/internal/app/models/application_record.rb
+- spec/internal/app/models/live_record_update.rb
+- spec/internal/app/models/post.rb
+- spec/internal/app/views/layouts/application.html.erb
+- spec/internal/app/views/posts/_form.html.erb
+- spec/internal/app/views/posts/_post.json.jbuilder
+- spec/internal/app/views/posts/edit.html.erb
+- spec/internal/app/views/posts/index.html.erb
+- spec/internal/app/views/posts/index.json.jbuilder
+- spec/internal/app/views/posts/new.html.erb
+- spec/internal/app/views/posts/show.html.erb
+- spec/internal/app/views/posts/show.json.jbuilder
+- spec/internal/config/cable.yml
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/public/favicon.ico
+- spec/rails_helper.rb
+- spec/spec_helper.rb
 homepage: https://github.com/jrpolidario/live_record
 licenses:
 - MIT

data/app/assets/javascripts/live_record.js

@@ -1,4 +0,0 @@
-//= require_self
-//= require_directory ./live_record/
-
-this.LiveRecord || (this.LiveRecord = {});

data/app/assets/javascripts/live_record/helpers.js

@@ -1,4 +0,0 @@
-//= require_self
-//= require_directory ./helpers/
-
-this.LiveRecord.helpers || (this.LiveRecord.helpers = {});

data/app/assets/javascripts/live_record/model.js

@@ -1,4 +0,0 @@
-//= require_self
-//= require_directory ./model/
-
-this.LiveRecord.Model || (this.LiveRecord.Model = {});

data/app/assets/javascripts/live_record/plugins.js

@@ -1,3 +0,0 @@
-//= require_self
-
-this.LiveRecord.plugins || (this.LiveRecord.plugins = {});

data/lib/live_record/channel/implement.rb

@@ -1,100 +0,0 @@
-module LiveRecord
-  module Channel
-    module Implement
-      def subscribed
-        find_record_from_params(params) do |record|
-          authorised_attributes = authorised_attributes(record, current_user)
-
-          if authorised_attributes.present?
-            stream_for record, coder: ActiveSupport::JSON do |message|
-              begin
-                record.reload
-              rescue ActiveRecord::RecordNotFound
-              end
-              
-              authorised_attributes = authorised_attributes(record, current_user)
-
-              if authorised_attributes.present?
-                response = filtered_message(message, authorised_attributes)
-                transmit response if response.present?
-              else
-                respond_with_error(:forbidden)
-                reject_subscription
-              end
-            end
-          else
-            respond_with_error(:forbidden)
-            reject
-          end
-        end
-      end
-
-      def sync_record(data)
-        find_record_from_params(data.symbolize_keys) do |record|
-          authorised_attributes = authorised_attributes(record, current_user)
-
-          if authorised_attributes.present?
-            live_record_update = LiveRecordUpdate.where(
-              recordable_type: record.class.name,
-              recordable_id: record.id
-            ).where(
-              'created_at >= ?', DateTime.parse(data['stale_since']) - 1.minute
-            ).order(id: :asc)
-
-            if live_record_update.exists?
-              message = { 'action' => 'update', 'attributes' => record.attributes }
-              response = filtered_message(message, authorised_attributes)
-              transmit response if response.present?
-            end
-          else
-            respond_with_error(:forbidden)
-            reject_subscription
-          end
-        end
-      end
-
-      def unsubscribed
-        # Any cleanup needed when channel is unsubscribed
-      end
-
-      private
-
-      def authorised_attributes(record, current_user)
-        return record.class.live_record_whitelisted_attributes(record, current_user).map(&:to_s)
-      end
-
-      def filtered_message(message, filters)
-        if message['attributes'].present?
-          message['attributes'].slice!(*filters)
-        end
-        message
-      end
-
-      def find_record_from_params(params)
-        model_class = params[:model_name].safe_constantize
-
-        if model_class && model_class < ApplicationRecord
-          record = model_class.find_by(id: params[:record_id])
-
-          if record.present?
-            yield record
-          else
-            transmit 'action' => 'destroy'
-          end
-        else
-          respond_with_error(:bad_request, 'Not a correct model name')
-          reject_subscription
-        end
-      end
-
-      def respond_with_error(type, message = nil)
-        case type
-        when :forbidden
-          transmit error: { 'code' => 'forbidden', 'message' => (message || 'You are not authorised') }
-        when :bad_request
-          transmit error: { 'code' => 'bad_request', 'message' => (message || 'Invalid request parameters') }
-        end
-      end
-    end
-  end
-end

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

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