entangled 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c90e25e9bc6ff181667253af48ad1b36235425c
-  data.tar.gz: 21dfcd7b48ed82e22056e8528d196962f6c93ae8
+  metadata.gz: fad9b5cc25344895ee783f55c630d30b1d445abb
+  data.tar.gz: 73520ca797c54e54e7b6ddb919448ced2814a873
 SHA512:
-  metadata.gz: 54f037193337876ec1bc462903f3a05fd9960ef9cc94391772ba33bf754b53405786000a84928f0673d34a56c910ec855a632aceb13d6cd903fadcc81ed072a5
-  data.tar.gz: 68e195848fd01c5349fa81d540dbf23b28adac42fc6210e71c1282f67a6bc2e29dfebbc33408d162edd73bf5c0908f6015a09249d5654f13058f727d20f8dbc8
+  metadata.gz: f50e3e90e995d47e4dc85b47eddfe44edf1aac69050571663afb69c1e1467210048b4607ddaec9b8abf5b9a595b6a88292b860b8a7019fa0a32fcaba220258a4
+  data.tar.gz: f8cfa4d6a52154aa26b6da60e7d0f149a38f6e5f2277f932487b3a1852b8894b93073ac48c745bcf1614f93eccfbc5fd0f1179c259fd3c98ee329b64951151e5

data/README.md

@@ -261,6 +261,13 @@ Pick if you want to use Entangled with plain JavaScript or with Angular:
 - [entangled-js](https://github.com/dchacke/entangled-js)
 - [entangled-angular](https://github.com/dchacke/entangled-angular)
 
+## A Note On Cases
+The case conventions differ in Ruby and JavaScript. `snake_case` is the standard in Ruby, whereas `camelCase` is the standard in JavaScript.
+
+To comply with both standards, Entangled automatically converts attribute names to camel case before sending them from the server to the client to comply with JS conventions, and back to snake case before sending them from the client back to the server to comply with Ruby conventions.
+
+All this means for you is that this enables you to use the conventional case for both environments. For example, a `sender_name` attribute on your model in Rails will turn into a `senderName` attribute in the browser, and vice versa. It would be weird to write camel case in Ruby.
+
 ## Planning Your Infrastructure
 This gem is best used for Rails apps that serve as APIs only and are not concerned with rendering views, since Entangled controllers cannot render views. A front end separate from your Rails app is recommended, either in your Rails app's public directory, or a separate front end app altogether.
 
@@ -270,9 +277,12 @@ The gem relies heavily on convention over configuration and currently only works
 ## Development Priorities
 The following features are to be implemented next:
 
+- Parse tubesock message `m` if available and assign to params in other controller actions before yield
+- Make broadcast method non-blocking using [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby); update Readme and repo description accordingly
+- Add compatibility table for Ruby/Angular/JS versions
 - Make prefix of create path `create_message` instead of `create_messages`
 - Support `belongsTo` in front end
-- Support `has_one` association in back end and front end
+- Support `has_one` association in back end and front end and route helper for single resource
 - Add offline capabilities
 - Add authentication - with JWT?
 - On Heroku, tasks are always in different order depending on which ones are checked off and not
@@ -282,10 +292,7 @@ The following features are to be implemented next:
 - Contact Jessy to tweet about it!
 - Handle errors gracefully (e.g. finding a non-existent id, etc, authorization error in the back end, timeouts, etc)
 - Test controllers (see https://github.com/ngauthier/tubesock/issues/41)
-- Freeze destroyed object
-- Set `$persisted()` to false on a destroyed object
 - Add `.destroyAll()` function to `Resources`
-- Add support for plain JavaScript usage (without Angular) and add section about that to Readme
 
 ## Contributing
 1. [Fork it](https://github.com/dchacke/entangled/fork) - you will notice that the repo comes with a back end and a front end part to test both parts of the gem

data/entangled.gemspec

@@ -31,4 +31,10 @@ Gem::Specification.new do |s|
   s.add_dependency 'tubesock', '~> 0.2'
   s.add_dependency 'rails', '~> 4.0'
   s.add_dependency 'redis', '~> 3.2'
+
+  # To convert hashes from snake case to camel case
+  s.add_dependency 'awrence', '~> 0.1'
+
+  # To convert hashes from camel case to snake case
+  s.add_dependency 'plissken', '~> 0.2.0'
 end

data/lib/entangled.rb

@@ -1,5 +1,7 @@
 require 'redis'
 require 'rails/all'
+require 'awrence'
+require 'plissken'
 require 'entangled/version'
 require 'entangled/helpers'
 require 'entangled/model'

data/lib/entangled/model.rb

@@ -68,9 +68,12 @@ module Entangled
       # JSON representation of the resource includes
       # its errors. This is necessary so that errors
       # are sent back to the client along with the
-      # resource on create and update
+      # resource on create and update. Furthermore,
+      # keys are converted to camel case, to comply
+      # with JavaScript conventions on the client
       def as_json(options = nil)
-        super(options || attributes).merge(errors: errors).as_json
+        super(options || attributes).merge(errors: errors).as_json.
+          to_camelback_keys
       end
 
       # Build channels. Channels always at least include
@@ -83,9 +86,8 @@ module Entangled
       def channels(tail = '')
         channels = []
 
-        # If the record is not persisted, it should not have
-        # any channels
-        return channels unless persisted?
+        # If the record is new, it should not have any channels
+        return channels if new_record?
 
         plural_name = self.class.name.underscore.pluralize
 

data/lib/entangled/version.rb

@@ -1,3 +1,3 @@
 module Entangled
-  VERSION = "1.2.0"
+  VERSION = "1.4.0"
 end

data/spec/dummy/public/app/entangled/entangled.js

@@ -39,7 +39,7 @@ angular.module('entangled', [])
         // Update
         var socket = new WebSocket(this.webSocketUrl + '/' + this.id + '/update');
         socket.onopen = function() {
-          socket.send(JSON.stringify(this));
+          socket.send(this.asSnakeJSON());
         }.bind(this);
 
         // Receive updated resource from server
@@ -71,7 +71,7 @@ angular.module('entangled', [])
 
         // Send attributes to server
         socket.onopen = function() {
-          socket.send(JSON.stringify(this));
+          socket.send(this.asSnakeJSON());
         }.bind(this);
 
         // Receive saved resource from server
@@ -133,6 +133,13 @@ angular.module('entangled', [])
               this[key] = data.resource[key];
             }
           }
+
+          // Mark resource as destroyed
+          this.destroyed = true;
+
+          // Freeze resource so as to prevent future
+          // modifications
+          Object.freeze(this);
         }
 
         if (callback) callback(this);
@@ -140,7 +147,7 @@ angular.module('entangled', [])
     };
 
     // $valid() checks if any errors are attached to the object
-    // and return false if so, false otherwise. This doesn't actually
+    // and return false if so, true otherwise. This doesn't actually
     // invoke server side validations, so it should only be used
     // after calling $save() to check if the record was successfully
     // stored in the database
@@ -156,7 +163,38 @@ angular.module('entangled', [])
     // $persisted() checks if the record was successfully stored
     // in the back end's database
     Resource.prototype.$persisted = function() {
-      return !!this.id;
+      return !(this.$newRecord() || this.$destroyed());
+    };
+
+    // $newRecord() checks if the record was just instantiated
+    Resource.prototype.$newRecord = function() {
+      return !this.id;
+    };
+
+    // $destroyed() checks if the record has been destroyed
+    Resource.prototype.$destroyed = function() {
+      return !!this.destroyed;
+    };
+
+    // asSnakeJSON returns a JSON object that looks just like the
+    // resource, except that the keys are snake case to comply
+    // with Ruby conventions once sent to the server
+    Resource.prototype.asSnakeJSON = function() {
+      var newKey,
+          that = this,
+          newObject = {};
+
+      Object.keys(this).forEach(function(key) {
+        if (that.hasOwnProperty(key)) {
+          newKey = key.match(/[A-Za-z][a-z]*/g).map(function(char) {
+            return char.toLowerCase();
+          }).join("_");
+
+          newObject[newKey] = that[key];
+        }
+      });
+
+      return JSON.stringify(newObject);
     };
 
     // Resources wraps all individual Resource objects

data/spec/dummy/public/test/services/entangled_test.js

@@ -42,7 +42,7 @@ describe('Entangled', function() {
     it('creates a list', function(done) {
       List.create({ name: 'foo' }, function(list) {
         expect(list.id).toBeDefined();
-        expect(list.created_at).toBeDefined();
+        expect(list.createdAt).toBeDefined();
         done();
       });
     });
@@ -62,7 +62,7 @@ describe('Entangled', function() {
       List.create({ name: 'foo' }, function(list) {
         List.find(list.id, function(list) {
           expect(list.id).toBeDefined();
-          expect(list.created_at).toBeDefined();
+          expect(list.createdAt).toBeDefined();
           done();
         });
       });
@@ -76,7 +76,7 @@ describe('Entangled', function() {
 
         list.$save(function() {
           expect(list.id).toBeDefined();
-          expect(list.created_at).toBeDefined();
+          expect(list.createdAt).toBeDefined();
           done();
         });
       });
@@ -97,11 +97,11 @@ describe('Entangled', function() {
       it('updates an existing list', function(done) {
         List.create({ name: 'foo' }, function(list) {
           list.name = 'new name';
-          var oldUpdatedAt = list.updated_at;
+          var oldUpdatedAt = list.updatedAt;
 
           list.$save(function() {
             expect(list.name).toBe('new name');
-            expect(list.updated_at).not.toEqual(oldUpdatedAt);
+            expect(list.updatedAt).not.toEqual(oldUpdatedAt);
             done();
           });
         });
@@ -113,12 +113,12 @@ describe('Entangled', function() {
           // empty string, causing model validations
           // in ActiveRecord to fail
           list.name = '';
-          var oldUpdatedAt = list.updated_at;
+          var oldUpdatedAt = list.updatedAt;
 
           list.$save(function() {
             // Assert that the list was not updated
             // by the server
-            expect(list.updated_at).toBe(oldUpdatedAt);
+            expect(list.updatedAt).toBe(oldUpdatedAt);
             expect(list.errors.name.indexOf("can't be blank") > -1).toBeTruthy();
             done();
           });
@@ -130,11 +130,11 @@ describe('Entangled', function() {
   describe('#$update', function() {
     it('updates a list in place', function(done) {
       List.create({ name: 'foo' }, function(list) {
-        var oldUpdatedAt = list.updated_at;
+        var oldUpdatedAt = list.updatedAt;
 
         list.$update({ name: 'new name' }, function() {
           expect(list.name).toBe('new name');
-          expect(list.updated_at).not.toEqual(oldUpdatedAt);
+          expect(list.updatedAt).not.toEqual(oldUpdatedAt);
           done();
         });
       });
@@ -142,7 +142,7 @@ describe('Entangled', function() {
 
     it('receives validation messages', function(done) {
       List.create({ name: 'foo' }, function(list) {
-        var oldUpdatedAt = list.updated_at;
+        var oldUpdatedAt = list.updatedAt;
 
         // Make invalid by setting the name to an
         // empty string, causing model validations
@@ -150,7 +150,7 @@ describe('Entangled', function() {
         list.$update({ name: '' }, function() {
           // Assert that the list was not updated
           // by the server
-          expect(list.updated_at).toBe(oldUpdatedAt);
+          expect(list.updatedAt).toBe(oldUpdatedAt);
           expect(list.errors.name.indexOf("can't be blank") > -1).toBeTruthy();
           done();
         });
@@ -172,6 +172,24 @@ describe('Entangled', function() {
         });
       });
     });
+
+    it('marks the record as destroyed', function(done) {
+      List.create({ name: 'foo' }, function(list) {
+        list.$destroy(function() {
+          expect(list.destroyed).toBeTruthy();
+          done();
+        });
+      });
+    });
+
+    it('freezes the record', function(done) {
+      List.create({ name: 'foo' }, function(list) {
+        list.$destroy(function() {
+          expect(Object.isFrozen(list)).toBeTruthy();
+          done();
+        });
+      });
+    });
   });
 
   describe('#$valid', function() {
@@ -243,6 +261,64 @@ describe('Entangled', function() {
         expect(list.$persisted()).not.toBeTruthy();
       });
     });
+
+    describe('destroyed record', function() {
+      it('is false', function() {
+        list.id = 1;
+        list.destroyed = true;
+        expect(list.$persisted()).not.toBeTruthy();
+      });
+    });
+  });
+
+  describe('#$newRecord', function() {
+    var list;
+
+    beforeEach(function() {
+      list = List.new();
+    });
+
+    describe('new record', function() {
+      it('is true', function() {
+        expect(list.$newRecord()).toBeTruthy();
+      });
+    });
+
+    describe('persisted record', function() {
+      it('is false', function() {
+        list.id = 1;
+        expect(list.$newRecord()).not.toBeTruthy();
+      });
+    });
+  });
+
+  describe('#$destroyed', function() {
+    var list;
+
+    beforeEach(function() {
+      list = List.new();
+    });
+
+    describe('destroyed record', function() {
+      it('is true', function() {
+        list.destroyed = true;
+        expect(list.$destroyed()).toBeTruthy();
+      });
+    });
+
+    describe('non-destroyed record', function() {
+      it('is false', function() {
+        expect(list.$destroyed()).not.toBeTruthy();
+      });
+    });
+  });
+
+  describe('#asSnakeJSON', function() {
+    it('returns the resource as JSON with snake case keys', function() {
+      var list = List.new();
+      list.fooBar = 'bar';
+      expect(JSON.parse(list.asSnakeJSON()).foo_bar).toEqual('bar');
+    });
   });
 
   describe('Associations', function() {

data/spec/models/channels_spec.rb

@@ -24,6 +24,9 @@ RSpec.describe 'Channels', type: :model do
   # Child that's not persisted
   let!(:fetus) { Child.new }
 
+  # Child that's been destroyed
+  let(:dead_body) { child.destroy }
+
   describe "grandmother's channels" do
     it 'has two channels' do
       expect(grandmother.channels.size).to eq 2
@@ -143,9 +146,15 @@ RSpec.describe 'Channels', type: :model do
     end
   end
 
-  describe "fetus's channel" do
-    it 'does not have any channels since it is not persisted' do
+  describe "fetus's channels" do
+    it 'does not have any channels since it is a new record' do
       expect(fetus.channels).to be_empty
     end
   end
+
+  describe "dead body's channels" do
+    it 'still has all channels even though it has been destroyed' do
+      expect(dead_body.channels.size).to eq 8
+    end
+  end
 end

data/spec/models/list_spec.rb

@@ -119,10 +119,23 @@ RSpec.describe List, type: :model do
 
     describe '#as_json' do
       let(:list) { List.create }
+      let(:persisted_list) do
+        list = List.new
+        list.save(validate: false)
+        list
+      end
 
       it 'includes errors' do
         expect(list.as_json["errors"][:name]).to include "can't be blank"
       end
+
+      it 'converts the attributes to camel case' do
+        expect(persisted_list.as_json["created_at"]).to be_nil
+        expect(persisted_list.as_json["createdAt"]).to be_present
+
+        expect(persisted_list.as_json["updated_at"]).to be_nil
+        expect(persisted_list.as_json["updatedAt"]).to be_present
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: entangled
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Dennis Charles Hackethal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-12 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,6 +164,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: awrence
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: plissken
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 description: Makes Rails real time through websockets as a gem in the backend and
   as an Angular library in the front end.
 email: