live_record 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a7ce4c6e3d1f684926289b479d1acf70eefd870
-  data.tar.gz: 44c06e78171c35d4c42b76ba90ea8acac76e87d0
+  metadata.gz: d45669bf962d28f44bc9bc0be4dffd39fe870267
+  data.tar.gz: a11548ef1efad7d80a0cc3d4f04463de2a574832
 SHA512:
-  metadata.gz: c9edd5e90852ffed01e349b8b75486d3d8048af00bdc1a66498d5f9b354afc0b00b00789392b66150bcb858bba6affd2fea92af4e0cc830c053403fb4e2076ca
-  data.tar.gz: fddf629d3b446a73d8db1be047e0d976b11aefe747d69892074d9e12e57e27edfc088f3c1ea621056825207f87b21c7b59be8a9f276ecb5f3e88bebb2146d038
+  metadata.gz: 40e8a77a1a61782aab015d500bf447bc923874b1e3464cd666fc326f71406c14741740eaf0791ee357a735d7d356e828e6db2fda0ab8ea514d44fa93aaca3379
+  data.tar.gz: 8be21e6154e5995bea77eddebaa50b6b3ae6931b983af99688ab8d62a226c7ff6dc2d57e2665248c7dd9430785de664ccdeafa885f7bc04d6fe68ea2bba2f1bd

data/.gitignore

@@ -1,7 +1,8 @@
 /.bundle
-/db/*.sqlite3
-/db/*.sqlite3-journal
-/log/*
-/tmp/*
+*.sqlite
+*.sqlite-journal
+/lib/live_record/spec/internal/log/*
+/lib/live_record/spec/internal/tmp/*
 .byebug_history
-*.gem
+*.gem
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,12 @@
+dist: trusty
+addons:
+  chrome: stable
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+before_install:
+  - google-chrome-stable --headless --disable-gpu --remote-debugging-port=9222 http://localhost &
+script: cd lib/live_record && bundle exec rspec

data/Gemfile

@@ -2,4 +2,8 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rails', '~> 5.0', '< 5.2'
+group :development, :test do
+  # issues with Combustion + FactoryGirl factory loading: https://github.com/pat/combustion/issues/33
+  # therefore, this gem should not be part of .gemspec but instead is specified here in the Gemfile
+  gem 'factory_girl_rails', require: false
+end

data/Gemfile.lock

@@ -1,11 +1,209 @@
+PATH
+  remote: .
+  specs:
+    live_record (0.1.0)
+      rails (>= 5.0.0, < 5.2)
+
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (5.1.3)
+      actionpack (= 5.1.3)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.3)
+      actionpack (= 5.1.3)
+      actionview (= 5.1.3)
+      activejob (= 5.1.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.3)
+      actionview (= 5.1.3)
+      activesupport (= 5.1.3)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.3)
+      activesupport (= 5.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.3)
+      activesupport (= 5.1.3)
+      globalid (>= 0.3.6)
+    activemodel (5.1.3)
+      activesupport (= 5.1.3)
+    activerecord (5.1.3)
+      activemodel (= 5.1.3)
+      activesupport (= 5.1.3)
+      arel (~> 8.0)
+    activesupport (5.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    archive-zip (0.7.0)
+      io-like (~> 0.3.0)
+    arel (8.0.0)
+    builder (3.2.3)
+    byebug (9.0.6)
+    capybara (2.15.1)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    childprocess (0.7.1)
+      ffi (~> 1.0, >= 1.0.11)
+    chromedriver-helper (1.1.0)
+      archive-zip (~> 0.7.0)
+      nokogiri (~> 1.6)
+    coffee-rails (4.2.2)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.12.2)
+    combustion (0.7.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.0.5)
+    database_cleaner (1.6.1)
+    diff-lcs (1.3)
+    erubi (1.6.1)
+    execjs (2.7.0)
+    factory_girl (4.8.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.8.0)
+      factory_girl (~> 4.8.0)
+      railties (>= 3.0.0)
+    faker (1.8.4)
+      i18n (~> 0.5)
+    ffi (1.9.18)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    i18n (0.8.6)
+    io-like (0.3.0)
+    jbuilder (2.7.0)
+      activesupport (>= 4.2.0)
+      multi_json (>= 1.2)
+    jquery-rails (4.3.1)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.6)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_mime (0.1.4)
+    mini_portile2 (2.2.0)
+    minitest (5.10.3)
+    multi_json (1.12.1)
+    nio4r (2.1.0)
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
+    public_suffix (2.0.5)
+    puma (3.10.0)
+    rack (2.0.3)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.1.3)
+      actioncable (= 5.1.3)
+      actionmailer (= 5.1.3)
+      actionpack (= 5.1.3)
+      actionview (= 5.1.3)
+      activejob (= 5.1.3)
+      activemodel (= 5.1.3)
+      activerecord (= 5.1.3)
+      activesupport (= 5.1.3)
+      bundler (>= 1.3.0)
+      railties (= 5.1.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.3)
+      actionpack (= 5.1.3)
+      activesupport (= 5.1.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    redis (3.3.3)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-rails (3.6.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubyzip (1.2.1)
+    selenium-webdriver (3.5.1)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+    xpath (2.1.0)
+      nokogiri (~> 1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  bundler (~> 1.3)
+  byebug (~> 9.0)
+  capybara (~> 2.15)
+  chromedriver-helper (~> 1.1)
+  coffee-rails (~> 4.2)
+  combustion (~> 0.7)
+  database_cleaner (~> 1.6)
+  factory_girl_rails
+  faker (~> 1.8)
+  jbuilder (~> 2.7)
+  jquery-rails (~> 4.3)
+  live_record!
+  puma (~> 3.10)
+  redis (~> 3.3)
+  rspec-rails (~> 3.6)
+  selenium-webdriver (~> 3.5)
+  sprockets-rails (~> 3.2)
+  sqlite3 (~> 1.3)
 
 BUNDLED WITH
-   1.12.5
+   1.15.3

data/README.md

@@ -1,15 +1,16 @@
-*WIP! (TODO: Tests)*
+[![Build Status](https://travis-ci.org/jrpolidario/live_record.svg?branch=master)](https://travis-ci.org/jrpolidario/live_record)
 
 ## About
 
 * 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. **(Optional Plugin)**
+* Auto-updates DOM elements mapped to a record attribute, from changes. **(Optional LiveDOM Plugin)**
 * Automatically resyncs after client-side reconnection.
 
 > `live_record` is intentionally designed for read-only one-way syncing from the backend server, and does not support pushing changes to the Rails server from the client-side JS. Updates from client-side then is intended to use the normal HTTP REST requests.
 
 ## Requirements
 
+* **>= Ruby 2.2.2**
 * **>= Rails 5.0**
 
 ## Demo
@@ -37,10 +38,19 @@
 
   // all records in the JS store are automatically subscribed to the backend LiveRecordChannel, which meant syncing (update / destroy) changes from the backend
 
-  // you can add a callback that will be invoked whenever the Book object has been updated
+  // you can add a callback that will be invoked whenever the Book object has been updated (see all supported callbacks further below)
   book.addCallback('after:update', function() {
     // let's say you update the DOM elements here when the attributes have changed
+    // `this` refers to the Book record that has been updated
+    console.log(this);
   });
+
+  // or you can add a Model-wide callback that will be invoked whenever ANY Book object has been updated
+  LiveRecord.Model.all.Book.addCallback('after:update', function() {
+    // let's say you update the DOM elements here when the attributes have changed
+    // `this` refers to the Book record that has been updated
+    console.log(this);
+  })
   ```
 
 * on the backend-side, you can handle attributes authorisation:
@@ -48,6 +58,8 @@
   ```ruby
   # app/models/book.rb
   class Book < ApplicationRecord
+    include LiveRecord::Model::Callbacks
+
     def self.live_record_whitelisted_attributes(book, current_user)
       # Add attributes to this array that you would like `current_user` to have access to when syncing this particular `book`
       # empty array means not-authorised
@@ -68,7 +80,7 @@
 * Add the following to your `Gemfile`:
 
   ```ruby
-  gem 'live_record', '~> 0.0.1'
+  gem 'live_record', '~> 0.1.0'
   ```
 
 * Run:
@@ -83,7 +95,7 @@
   rails generate live_record:install
   ```
 
-  > `rails generate live_record:install --live_dom=false` if you do not need the `LiveDom` plugin; `--live_dom=true` by default
+  > `rails generate live_record:install --live_dom=false` if you do not need the `LiveDOM` plugin; `--live_dom=true` by default
 
 * Run migration to create the `live_record_updates` table, which is going to be used for client reconnection resyncing:
 
@@ -154,7 +166,7 @@
     {
       modelName: 'Book' // should match the Rails model name
       plugins: {
-        LiveDOM: true // remove this if you do not need `LiveDom`
+        LiveDOM: true // remove this if you do not need `LiveDOM`
       }
     }
   )
@@ -234,6 +246,14 @@
   </script>
   ```
 
+  ```html
+  <!-- app/views/books/index.html.erb -->
+  <script>
+    // `loadRecords` you may also specify a URL to loadRecords (`url` defaults to `window.location.href` which is the current page) 
+    LiveRecord.helpers.loadRecords({modelName: 'Book', url: '/some/url/that/returns_books_as_a_json'})
+  </script>
+  ```
+
   ```html
   <!-- app/views/posts/index.html.erb -->
   <script>
@@ -275,10 +295,10 @@
 
 ## Plugins
 
-### LiveDom (Requires JQuery)
+### LiveDOM (Requires JQuery)
 
 * enabled by default, unless explicitly removed.
-* `LiveDom` allows DOM elements' text content to be automatically updated, whenever the mapped record-attribute has been updated.
+* `LiveDOM` allows DOM elements' text content to be automatically updated, whenever the mapped record-attribute has been updated.
 
 > text content is safely escaped using JQuery's `.text()` function
 
@@ -319,7 +339,7 @@
       * `before:destroy`: (Array of functions)
       * `after:destroy`: (Array of functions)
     * `plugins`: (Object)
-      * `LiveDom`: (Boolean)
+      * `LiveDOM`: (Boolean)
   * returns the newly create `MODEL`
 
 `new LiveRecord.Model.all.MODELNAME(ATTRIBUTES)`
@@ -367,3 +387,12 @@
   * `CALLBACKKEY` (String) see supported callbacks above
   * `CALLBACKFUNCTION` (function Object) the function callback that will be removed
   * returns the function Object if successfully removed, else returns `false` if callback is already removed
+
+## TODOs
+* Change `feature` specs into `system` specs after [this rspec-rails pull request](https://github.com/rspec/rspec-rails/pull/1813) gets merged.
+
+## Contributing
+* pull requests and forks are very much welcomed! :) Let me know if you find any bug! Thanks
+
+## License
+* MIT

data/app/assets/javascripts/live_record/plugins/live_dom.coffee

@@ -1,8 +1,7 @@
 this.LiveRecord.plugins.LiveDOM || (this.LiveRecord.plugins.LiveDOM = {});
 
-if (window.jQuery === undefined) {
-   throw new Error('jQuery is not loaded yet, and is a dependency of LiveRecord')
-}
+if window.jQuery == undefined
+  throw new Error('jQuery is not loaded yet, and is a dependency of LiveRecord')
 
 LiveRecord.plugins.LiveDOM.applyToModel = (Model, pluginValue) ->
   return if pluginValue != true

data/lib/live_record.rb

@@ -1,7 +1,10 @@
 require 'rails'
+require 'rails/generators'
 require 'active_support/concern'
 
 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 }
 
 module LiveRecord

data/lib/live_record/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format=documentation

data/lib/live_record/{channel.rb → channel/implement.rb}

@@ -1,8 +1,6 @@
 module LiveRecord
   module Channel
-    extend ActiveSupport::Concern
-
-    included do
+    module Implement
       def subscribed
         find_record_from_params(params) do |record|
           authorised_attributes = authorised_attributes(record, current_user)
@@ -97,7 +95,6 @@ module LiveRecord
           transmit error: { 'code' => 'bad_request', 'message' => (message || 'Invalid request parameters') }
         end
       end
-
     end
   end
 end

data/lib/live_record/config.ru

@@ -0,0 +1,10 @@
+require 'bundler'
+
+Bundler.require :default, :development
+
+require 'live_record'
+require 'action_cable/engine'
+
+Combustion.initialize! :all
+
+run Combustion::Application

data/lib/live_record/generators/install_generator.rb

@@ -37,12 +37,6 @@ module LiveRecord
         template 'live_record_channel.rb', File.join('app/channels', 'live_record_channel.rb')
       end
 
-      def update_application_record
-        in_root do
-          insert_into_file 'app/models/application_record.rb', "  include LiveRecord::Model\n", after: "self.abstract_class = true\n"
-        end
-      end
-
       def update_application_javascript
         in_root do
           insert_into_file 'app/assets/javascripts/application.js', "//= require live_record\n", before: "//= require_tree ."