live_record 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdfd93a26658fb2c904c1099d412baa3b340590a
-  data.tar.gz: 40bea540c784bb1d010b53765c7022528e9e4bb2
+  metadata.gz: 4cb6c6112e8dc95504592f04bbcc692184625232
+  data.tar.gz: 8fc5c877c5bc1b14f84c7e4d835880cf057c62e8
 SHA512:
-  metadata.gz: 033ea790203cfa5c9edeb48eb03af908197224c434b78f99ff2fad781ccf1af15c65ed61d146d844f20524082dcc695a239a84824baecacef619a3006c09bd98
-  data.tar.gz: 41573f26ab8d05431c6577344131105ff5c48d3b0fc4376eec2295483a11034a5a3796b8c50958295fb855e753cc6ddd3a52619a19123ec0b1ad6aeeb05074e3
+  metadata.gz: f4f90c7c3dcd0be1ab798a484d87af59d0fda7383c22f1568c5cf9ec0bae8c6cef13d915fa3884ed72d13e30c85128bcb978e4f1c57cd423551087a042a8f944
+  data.tar.gz: 6fbb76854c2369cb1432b4f5dd1989e4880d16cc41707233be861999c5fbf1838cc4c23cf2d3791aca74cfe05424d773056aeafbb2e7fccb82f5e864055294a6

data/README.md

@@ -15,8 +15,8 @@
 
 ## Requirements
 
-* **>= Ruby 2.2.2**
-* **>= Rails 5.0**
+* **Ruby >= 2.2.2**
+* **Rails >= 5.0, < 5.2**
 
 ## Demo
 
@@ -114,7 +114,7 @@
 1. Add the following to your `Gemfile`:
 
     ```ruby
-    gem 'live_record', '~> 0.2.2'
+    gem 'live_record', '~> 0.2.3'
     ```
 
 2. Run:
@@ -212,13 +212,23 @@
     )
     ```
 
-    ### Example 2 - Model + Callbacks
+    ### Example 2 - Model + Callbacks + Associations
 
     ```js
     // app/assets/javascripts/books.js
     LiveRecord.Model.create(
       {
         modelName: 'Book',
+        belongsTo: {
+          // allows you to do `bookInstance.user()` and `bookInstance.library()`
+          user: { foreignKey: 'user_id', modelName: 'User' },
+          library: { foreignKey: 'library_id', modelName: 'Library' }
+        },
+        hasMany: {
+          // allows you to do `bookInstance.pages()` and `bookInstance.bookReviews()`
+          pages: { foreignKey: 'book_id', modelName: 'Page' },
+          bookReviews: { foreignKey: 'book_id', modelName: 'Review' }
+        },
         callbacks: {
           'on:connect': [
             function() {
@@ -238,7 +248,7 @@
       #### Model Callbacks supported:
       * `on:connect`
       * `on:disconnect`
-      * `on:response_error`
+      * `on:responseError`
       * `before:create`
       * `after:create`
       * `before:update`
@@ -248,7 +258,7 @@
 
       > Each callback should map to an array of functions
 
-      * `on:response_error` supports a function argument: The "Error Code". i.e.
+      * `on:responseError` supports a function argument: The "Error Code". i.e.
 
         ### Example 3 - Handling Response Error
 
@@ -257,7 +267,7 @@
           {
             modelName: 'Book',
             callbacks: {
-              'on:response_error': [
+              'on:responseError': [
                 function(errorCode) {
                   console.log(errorCode); // errorCode is a string, representing the type of error. See Response Error Codes below:
                 }
@@ -451,10 +461,18 @@
 ### `LiveRecord.Model.create(CONFIG)`
   * `CONFIG` (Object)
     * `modelName`: (String, Required)
+    * `belongsTo`: (Object)
+      * `ASSOCIATIONNAME`: (Object)
+        * `foreignKey`: (String)
+        * `modelName`: (String)
+    * `hasMany`: (Object)
+      * `ASSOCIATIONNAME`: (Object)
+        * `foreignKey`: (String)
+        * `modelName`: (String)
     * `callbacks`: (Object)
       * `on:connect`: (Array of functions)
       * `on:disconnect`: (Array of functions)
-      * `on:response_error`: (Array of functions; function argument = ERROR_CODE (String))
+      * `on:responseError`: (Array of functions; function argument = ERROR_CODE (String))
       * `before:create`: (Array of functions)
       * `after:create`: (Array of functions)
       * `before:update`: (Array of functions)
@@ -464,6 +482,7 @@
     * `plugins`: (Object)
       * `LiveDOM`: (Boolean)
   * creates a `MODEL` and stores it into `LiveRecord.Model.all` array
+  * `hasMany` and `belongsTo` `modelName` above should be a valid defined `LiveRecord.Model`
   * returns the newly created `MODEL`
 
 ### `MODEL.all`
@@ -512,6 +531,11 @@
 ### `MODELINSTANCE.ATTRIBUTENAME()`
   * returns the attribute value of corresponding to `ATTRIBUTENAME`. (i.e. `bookInstance.id()`, `bookInstance.created_at()`)
 
+### `MODELINSTANCE.ASSOCIATIONAME()`
+  * if association is "has many", then returns an array of associated records (if any exists in current store)
+  * if association is "belongs to", then returns the record (if exists in current store)
+  * (i.e. `bookInstance.user()`, `bookInstance.reviews()`)
+
 ### `MODELINSTANCE.subscribe()`
   * subscribes to the `LiveRecord::ChangesChannel`. This instance should already be subscribed by default after being stored, unless there is a `on:response_error` or manually `unsubscribed()` which then you should manually call this `subscribe()` function after correctly handling the response error, or whenever desired.
   * returns the `subscription` object (the ActionCable subscription object itself)
@@ -572,10 +596,16 @@
 * MIT
 
 ## Changelog
+* 0.2.3
+  * IMPORTANT! renamed callback from `on:response_error` to `on:responseError` for conformity. So please update your code accordingly.
+  * added [associations](#example-2---model--callbacks--associations):
+    * `hasMany` which allows you to do `bookInstance.reviews()`
+    * `belongsTo` which allows you to do `bookInstance.user()`
+  * fixed `loadRecords()` throwing an error when there is no response
 * 0.2.2
   * minor fix: "new records" subscription: `.modelName` was not being referenced properly, but should have not affected any functionalities.
 * 0.2.1
-  * you can now access what attributes have changed; see [`MODEL.changes`](#modelinstancechanges) above.
+  * you can now access what attributes have changed; see [`MODELINSTANCE.changes`](#modelinstancechanges) above.
 * 0.2.0
   * Ability to subscribe to new records (supports lost connection auto-restreaming)
     * See [9th step of Setup above](#setup)

data/app/assets/javascripts/live_record/helpers/case_converter.coffee

@@ -0,0 +1,16 @@
+# ref: https://jamesroberts.name/blog/2010/02/22/string-functions-for-javascript-trim-to-camel-case-to-dashed-and-to-underscore/
+
+LiveRecord.helpers.caseConverter =
+  toCamel: (string) ->
+    string.replace(
+      /(\-[a-z])/g,
+      ($1) ->
+        $1.toUpperCase().replace('-','')
+    )
+
+  toUnderscore: (string) ->
+	  string.replace(
+      /([A-Z])/g,
+      ($1) ->
+        "_"+$1.toLowerCase()
+    )

data/app/assets/javascripts/live_record/helpers/load_records.coffee

@@ -7,7 +7,7 @@ LiveRecord.helpers.loadRecords = (args) ->
   $.getJSON(
     args['url']
   ).done(
-    (data) -> 
+    (data) ->
       record_or_records = undefined
 
       # Array JSON
@@ -23,7 +23,7 @@ LiveRecord.helpers.loadRecords = (args) ->
         record_or_records = records
 
       # Single-Record JSON
-      else
+      else if data
         record_attributes = data
         record = new LiveRecord.Model.all[args['modelName']](record_attributes)
         record.create()
@@ -34,4 +34,4 @@ LiveRecord.helpers.loadRecords = (args) ->
   ).fail(
     (jqxhr, textStatus, error) ->
       args['onError'].call(this, jqxhr, textStatus, error) if args['onError']
-  )
+  )

data/app/assets/javascripts/live_record/model/create.coffee

@@ -15,13 +15,43 @@ LiveRecord.Model.create = (config) ->
 
   Model.modelName = config.modelName
 
+  Model.associations =
+    hasMany: config.hasMany
+    belongsTo: config.belongsTo
+
+  # getting has_many association records
+  for associationName, associationConfig of Model.associations.hasMany
+    Model.prototype[associationName] = ->
+      self = this
+      associatedModel = LiveRecord.Model.all[associationConfig.modelName]
+      throw new Error('No defined model for "' + associationConfig.modelName + '"') unless associatedModel
+
+      # TODO: speed up searching for associated records, or use cache-maps
+      associatedRecords = []
+
+      for id, record of associatedModel.all
+        isAssociated = record[associationConfig.foreignKey]() == self.id()
+        associatedRecords.push(record) if isAssociated
+
+      associatedRecords
+
+  # getting belongs_to association record
+  for associationName, associationConfig of Model.associations.belongsTo
+    Model.prototype[associationName] = ->
+      self = this
+      associatedModel = LiveRecord.Model.all[associationConfig.modelName]
+      throw new Error('No defined model for "' + associationConfig.modelName + '"') unless associatedModel
+
+      belongsToID = self[associationConfig.foreignKey]()
+      associatedModel.all[belongsToID]
+
   Model.all = {}
 
   Model.subscriptions = []
 
   Model.subscribe = (config) ->
-    config || (config = {})
-    config.callbacks || (config.callbacks = {})
+    config ||= {}
+    config.callbacks ||= {}
 
     subscription = App.cable.subscriptions.create(
       {
@@ -110,7 +140,7 @@ LiveRecord.Model.create = (config) ->
         if data.error
           @record()._staleSince = (new Date()).toISOString() unless @record()._staleSince
           @onError[data.error.code].call(this, data)
-          @record()._callCallbacks('on:response_error', [data.error.code])
+          @record()._callCallbacks('on:responseError', [data.error.code])
           delete @record()['subscription']
         else
           @onAction[data.action].call(this, data)
@@ -198,7 +228,7 @@ LiveRecord.Model.create = (config) ->
   Model._callbacks = {
     'on:connect': [],
     'on:disconnect': [],
-    'on:response_error': [],
+    'on:responseError': [],
     'before:create': [],
     'after:create': [],
     'before:update': [],
@@ -210,7 +240,7 @@ LiveRecord.Model.create = (config) ->
   Model.prototype._callbacks = {
     'on:connect': [],
     'on:disconnect': [],
-    'on:response_error': [],
+    'on:responseError': [],
     'before:create': [],
     'after:create': [],
     'before:update': [],

data/lib/live_record/generators/templates/javascript.coffee.rb

@@ -3,14 +3,21 @@ LiveRecord.Model.create(
   {
     modelName: '<%= singular_table_name.camelcase %>',
     plugins: {
+      # remove this line if you're not using LiveDOM
       LiveDOM: true
     },
-    # See TODO: URL_TO_DOCUMENTATION for supported callbacks
-    # Add Callbacks (callback name => array of functions)
+
+    ## More configurations below. See https://github.com/jrpolidario/live_record#example-1---model
+    # belongsTo: {
+    #   user: { foreignKey: 'user_id', modelName: 'User' }
+    # },
+    # hasMany: {
+    #   books: { foreignKey: '<%= singular_table_name %>_id', modelName: 'Book' }
+    # },
     # callbacks: {
     #   'on:disconnect': [],
     #   'after:update': [],
     # }
   }
 )
-<% end -%>
+<% end -%>

data/lib/live_record/version.rb

@@ -1,3 +1,3 @@
 module LiveRecord
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.2.3'.freeze
 end

data/spec/factories/posts.rb

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

data/spec/factories/users.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :user do
+    email { Faker::Internet.email }
+  end
+end

data/spec/features/live_record_syncing_spec.rb

@@ -1,9 +1,12 @@
 require 'rails_helper'
 
 RSpec.feature 'LiveRecord Syncing', type: :feature do
-  let(:post1) { create(:post) }
-  let(:post2) { create(:post) }
-  let(:post3) { create(:post) }
+  let(:user1) { create(:user) }
+  let(:user2) { create(:user) }
+  let(:post1) { create(:post, user: user1) }
+  let(:post2) { create(:post, user: user1) }
+  let(:post3) { create(:post, user: nil) }
+  let!(:users) { [user1, user2] }
   let!(:posts) { [post1, post2, post3] }
 
   scenario 'User sees live changes (updates) of post records', js: true do
@@ -59,6 +62,38 @@ RSpec.feature 'LiveRecord Syncing', type: :feature do
     expect(post3_content_td).to_not have_content('post3newcontent')
   end
 
+  scenario 'JS-Client can access Model associations record objects in its current store', js: true do
+    visit '/posts'
+
+    # let's wait for all records first before checking correct associations
+    wait before: -> { evaluate_script('Object.keys( LiveRecord.Model.all.User.all ).length') }, becomes: -> (value) { value == users.size }, duration: 10.seconds
+    expect(evaluate_script('Object.keys( LiveRecord.Model.all.User.all ).length')).to eq users.size
+    wait before: -> { evaluate_script('Object.keys( LiveRecord.Model.all.Post.all ).length') }, becomes: -> (value) { value == posts.size }, duration: 10.seconds
+    expect(evaluate_script('Object.keys( LiveRecord.Model.all.Post.all ).length')).to eq posts.size
+
+    # users should have correct associated posts
+    expect(evaluate_script(
+      <<-eos
+      LiveRecord.Model.all.User.all[#{user1.id}].posts().map(
+        function(post) { return post.id() }
+      )
+      eos
+    )).to eq user1.posts.pluck(:id)
+
+    expect(evaluate_script(
+      <<-eos
+      LiveRecord.Model.all.User.all[#{user2.id}].posts().map(
+        function(post) { return post.id() }
+      )
+      eos
+    )).to eq user2.posts.pluck(:id)
+
+    # posts should belong to correct associated user
+    expect(evaluate_script("LiveRecord.Model.all.Post.all[#{post1.id}].user().id()")).to eq post1.user.id
+    expect(evaluate_script("LiveRecord.Model.all.Post.all[#{post2.id}].user().id()")).to eq post2.user.id
+    expect(evaluate_script("LiveRecord.Model.all.Post.all[#{post3.id}].user()")).to eq nil
+  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'
@@ -89,7 +124,7 @@ RSpec.feature 'LiveRecord Syncing', type: :feature do
 
     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

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

@@ -1,6 +1,9 @@
 LiveRecord.Model.create(
   {
     modelName: 'Post',
+    belongsTo: {
+      user: { foreignKey: 'user_id', modelName: 'User' }
+    },
     plugins: {
       LiveDOM: true
     }

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

@@ -0,0 +1,11 @@
+LiveRecord.Model.create(
+  {
+    modelName: 'User',
+    hasMany: {
+      posts: { foreignKey: 'user_id', modelName: 'Post' }
+    },
+    plugins: {
+      LiveDOM: true
+    }
+  }
+)

data/spec/internal/app/controllers/users_controller.rb

@@ -0,0 +1,75 @@
+class UsersController < ApplicationController
+  before_action :set_user, only: [:show, :edit, :update, :destroy]
+
+  # GET /users
+  # GET /users.json
+  def index
+    request.session['init'] = true if request.session.id.nil?
+    @users = User.all
+  end
+
+  # GET /users/1
+  # GET /users/1.json
+  def show
+  end
+
+  # GET /users/new
+  def new
+    @user = User.new
+  end
+
+  # GET /users/1/edit
+  def edit
+  end
+
+  # POST /users
+  # POST /users.json
+  def create
+    @user = User.new(user_params)
+
+    respond_to do |format|
+      if @user.save
+        format.html { redirect_to @user, notice: 'User was successfully created.' }
+        format.json { render :show, status: :created, location: @user }
+      else
+        format.html { render :new }
+        format.json { render json: @user.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PATCH/PUT /users/1
+  # PATCH/PUT /users/1.json
+  def update
+    respond_to do |format|
+      if @user.update(user_params)
+        format.html { redirect_to @user, notice: 'User was successfully updated.' }
+        format.json { render :show, status: :ok, location: @user }
+      else
+        format.html { render :edit }
+        format.json { render json: @user.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /users/1
+  # DELETE /users/1.json
+  def destroy
+    @user.destroy
+    respond_to do |format|
+      format.html { redirect_to users_url, notice: 'User was successfully destroyed.' }
+      format.json { head :no_content }
+    end
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_user
+      @user = User.find(params[:id])
+    end
+
+    # Never trust parameters from the scary internet, only allow the white list through.
+    def user_params
+      params.require(:user).permit(:email)
+    end
+end

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

@@ -1,11 +1,12 @@
 class Post < ApplicationRecord
   include LiveRecord::Model::Callbacks
 
+  belongs_to :user
   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]
+    [:title, :is_enabled, :user_id, :created_at, :updated_at]
   end
 end

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

@@ -0,0 +1,12 @@
+class User < ApplicationRecord
+  include LiveRecord::Model::Callbacks
+
+  has_many :live_record_updates, as: :recordable, dependent: :destroy
+  has_many :posts
+
+  def self.live_record_whitelisted_attributes(user, 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.
+    [:email, :created_at, :updated_at]
+  end
+end

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

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

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

@@ -1,5 +1,6 @@
 <script>
   LiveRecord.helpers.loadRecords({ modelName: 'Post' });
+  LiveRecord.helpers.loadRecords({ modelName: 'User', url: '<%= j users_path %>' });
   LiveRecord.Model.all.Post.subscribe({ where: { is_enabled_eq: true, content_eq: 'somecontent' }});
 </script>
 <p id="notice"><%= notice %></p>

data/spec/internal/app/views/users/_user.json.jbuilder

@@ -0,0 +1,2 @@
+json.extract! user, :id, :email, :created_at, :updated_at
+json.url user_url(user, format: :json)

data/spec/internal/app/views/users/index.json.jbuilder

@@ -0,0 +1 @@
+json.array! @users, partial: 'users/user', as: :user

data/spec/internal/config/routes.rb

@@ -1,3 +1,4 @@
 Rails.application.routes.draw do
   resources :posts
+  resources :users
 end

data/spec/internal/db/schema.rb

@@ -11,8 +11,16 @@ ActiveRecord::Schema.define do
     t.string "title"
     t.text "content"
     t.boolean "is_enabled"
+    t.integer "user_id"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
     t.index ["is_enabled"], name: "index_posts_on_is_enabled"
+    t.index ["user_id"], name: "index_posts_on_user_id"
+  end
+
+  create_table "users", force: :cascade do |t|
+    t.string "email"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
 end

data/spec/rails_helper.rb

@@ -4,7 +4,7 @@ Dir[__dir__ + '/helpers/*.rb'].each {|file| require file }
 
 ActiveRecord::Migration.maintain_test_schema!
 
-Capybara.javascript_driver = :selenium_chrome_headless # :selenium_chrome 
+Capybara.javascript_driver = :selenium_chrome_headless # :selenium_chrome
 Capybara.server = :puma
 
 RSpec.configure do |config|
@@ -23,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.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Jules Roman B. Polidario
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-18 00:00:00.000000000 Z
+date: 2017-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -272,6 +272,7 @@ files:
 - Rakefile
 - app/assets/javascripts/live_record.coffee
 - app/assets/javascripts/live_record/helpers.coffee
+- app/assets/javascripts/live_record/helpers/case_converter.coffee
 - app/assets/javascripts/live_record/helpers/load_records.coffee
 - app/assets/javascripts/live_record/helpers/spaceship.coffee
 - app/assets/javascripts/live_record/model.coffee
@@ -301,19 +302,23 @@ files:
 - lib/live_record/version.rb
 - live_record.gemspec
 - spec/factories/posts.rb
+- spec/factories/users.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/assets/javascripts/users.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/controllers/users_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/models/user.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
@@ -323,6 +328,8 @@ files:
 - 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/app/views/users/_user.json.jbuilder
+- spec/internal/app/views/users/index.json.jbuilder
 - spec/internal/config/cable.yml
 - spec/internal/config/database.yml
 - spec/internal/config/routes.rb