entangled 0.0.25 → 0.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ca5362f5aca57e992be81a4856c54006173ff27
-  data.tar.gz: 63181710cbfdb8c0b984a19e684e9d39a519ffaa
+  metadata.gz: 7687c95a8fad6d954ca7b9754d6ad17a40de5919
+  data.tar.gz: 37a20749306f1c7dac1a6f86bc92e1974b54306f
 SHA512:
-  metadata.gz: ea9d8bac58de5cd03d45fc35b253f1a124baf29b6dce187039b149d1151d777365d5453c660952ac3d7103fec5843f2e7f643bcf1028b4e62bddba7e4b36acda
-  data.tar.gz: 84ab4fa51ccbf7eb5058a3ac780bd7552b00c099684ef38997eab065994a59b37bde85a95d06158c56194f5643500234f32db24ba0261fe800e4fc36a0a50ad5
+  metadata.gz: cc6c25b58eb6e18956a9571e88f3933ee96a1b191f440ef3a895ac8bd4bf27cc0fd2bf81bde259584bb7079ce8ffa24b0d58e38c8e63fdb9b49a6bbb6e0a380b
+  data.tar.gz: ded5776561605f68d9a20b839645a4b1388b3a6209812db939c35287787f0208942a2fc09f19599840b8c00a235140edffb8ff5fb530bc9b759fc585f63a0d91

data/README.md

@@ -6,7 +6,7 @@ Real time is important. Users have come to expect real time behavior from every
 
 Entangled stores and syncs data from ActiveRecord instantly across every device. It is a layer behind your models and controllers that pushes updates to all connected clients in real time. It is cross-browser compatible and offers real time validations.
 
-Currently, Entangled runs on Rails 4.2 and Ruby 2.0 in the back end, and Angular 1.3 in the front end.
+Currently, Entangled runs on Rails 4.2 and Ruby 2.0. In the front end, libraries are available in [plain JavaScript](https://github.com/dchacke/entangled-js) and for [Angular](https://github.com/dchacke/entangled-angular).
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -100,6 +100,18 @@ entangle only: :create
 entangle only: [:create, :update]
 ```
 
+Calling `entangled` creates the following channels (sticking with the example of a `Message` model):
+
+```ruby
+# For the collection
+"/messages"
+
+# For a member, e.g. /messages/1
+"/messages/:id"
+```
+
+`:id` being the record's id, just as with routes.
+
 ### Controllers
 Your controllers will be a little more lightweight than in a standard restful Rails app. A restful-style controller is expected and should look like this:
 
@@ -152,6 +164,7 @@ Note the following:
 - The `show`, `create`, `update`, and `destroy` actions will expect an instance variable with the singular name of your controller (e.g. `@message` in a `MessagesController`)
 - The instance variables are sent to clients as stringified JSON
 - Strong parameters are expected
+- The path to your controllers' index action has to match the model's channel for the collection, and the path to your controller's show action has to match the model's channel for a single member (which it will automatically if you stay RESTful)
 
 ### Server
 
@@ -161,160 +174,14 @@ Remember to run Redis whenever you run your server:
 $ redis-server
 ```
 
-Otherwise the channels won't work.
+Redis is needed to subscribe and publish to the channels that are created by Entangled internally to communicate over websockets.
 
 If you store your Redis instance in `$redis` or `REDIS` (e.g. in an initializer), Entangled will use that assigned instance so that you can configure Redis just like you're used to. Otherwise, Entangled will instantiate Redis itself and use its default settings.
 
-## The Client
-You will need to configure your client to create Websockets and understand incoming requests on those sockets. In order to use the helper methods for the front end provided by the Entangled Angular library, you must use Angular in your front end. The use of Angular as counterpart of this gem is highly recommended, since its inherent two way data binding complements the real time functionality of this gem nicely.
-
-### Installation
-You can either download or reference the file `entangled.js` from this repository, or simply install it with Bower:
-
-```shell
-$ bower install entangled
-```
-
-Then include it in your HTML.
-
-Lastly, add the Entangled module as a dependency to your Angular app:
-
-```javascript
-angular.module('appName', ['entangled']);
-```
-
-### Usage
-Entangled is best used within Angular services. For example, consider a `Message` service for a chat app:
-
-```javascript
-app.factory('Message', function(Entangled) {
-  return new Entangled('ws://localhost:3000/messages');
-});
-```
-
-In the above example, first we inject Entangled into our service, then instantiate a new Entangled object and return it. The Entangled object takes one argument when instantiated: the URL of your resource's index action (in this case, `/messages`). Note that the socket URL looks just like a standard restful URL with http, except that the protocol part has been switched with `ws` to use the websocket protocol. Also note that you need to use `wss` instead if you want to use SSL.
-
-The Entangled service comes with these functions:
-
-- `new(params)`
-- `create(params, callback)`
-- `find(id, callback)`
-- `all(callback)`
-
-...and the following functions on returned objects:
-
-- `$save(callback)`
-- `$update(params, callback)`
-- `$destroy(callback)`
-
-They're just like class and instance methods in Active Record.
-
-In your controller, you could then inject that `Message` service and use it like so:
-
-```javascript
-// To instantiate a blank message, e.g. for a form;
-// You can optionally pass in an object to new() to
-// set some default values
-$scope.message = Message.new();
-
-// To instantiate and save a message in one go
-Message.create({ body: 'text' }, function(message) {
-  $scope.$apply(function() {
-    $scope.message = message;
-  });
-});
-
-// To retrieve a specific message from the server
-// with id 1 and subscribe to its channel
-Message.find(1, function(message) {
-  $scope.$apply(function() {
-    $scope.message = message;
-  });
-});
-
-// To retrieve all messages from the server and
-// subscribe to the collection's channel
-Message.all(function(messages) {
-  $scope.$apply(function() {
-    $scope.messages = messages;
-  });
-});
-
-// To store a newly instantiated or update an existing message.
-// If saved successfully, $scope.message is updated in place
-// with the attributes id, created_at and updated_at
-$scope.message.body = 'new body';
-$scope.message.$save(function() {
-  // Do stuff after save
-});
-
-// To update a newly instantiated or existing message in place.
-// If updated successfully, $scope.message is updated in place
-// with the attributes id, created_at and updated_at
-$scope.message.$update({ body: 'new body' }, function() {
-  // Do stuff after update
-});
-
-// To destroy a message
-$scope.message.$destroy(function() {
-  // Do stuff after destroy
-});
-```
-
-All functions above will interact with your server's controllers in real time. Your scope variables will always reflect your server's most current data.
-
-#### Validations
-Objects from the Entangled service automatically receive ActiveRecord's error messages from your model when you `$save()`. An additional property called `errors` containing the error messages is available, formatted the same way you're used to from calling `.errors` on a model in Rails.
-
-For example, consider the following scenario:
-
-```ruby
-# Message model (Rails)
-validates :body, presence: true
-```
-
-```javascript
-// Controller (Angular)
-$scope.message.$save(function() {
-  console.log($scope.message.errors);
-  // => { body: ["can't be blank"] }
-});
-```
-
-You could then display these error messages to your users.
-
-To check if a resource is valid, you can use `$valid()` and `$invalid()`. Both functions return booleans. For example:
-
-```javascript
-$scope.message.$save(function() {
-  // Check if record has no errors
-  if ($scope.message.$valid()) { // similar to ActiveRecord's .valid?
-    alert('Yay!');
-  }
-
-  // Check if record errors
-  if ($scope.message.$invalid()) { // similar to ActiveRecord's .invalid?
-    alert('Nay!');
-  }
-});
-```
-
-Note that `$valid()` and `$invalid()` should only be used after $saving a resource, i.e. in the callback of `$save`, since they don't actually invoke server side validations. They only check if a resource contains errors.
-
-#### Persistence
-Just as with ActiveRecord's `persisted?` method, you can use `$persisted()` on an object to check if it was successfully stored in the database.
-
-```javascript
-$scope.message.$persisted();
-// => true or false
-```
-
-#### Associations
+### Associations
 What if you want to only fetch and subscribe to children that belong to a specific parent? Or maybe you want to create a child in your front end and assign it to a specific parent?
 
-Entangled currently supports one `belongs_to` association per model.
-
-For example, imagine the following Parent > Children relationship in your models:
+Imagine the following Parent > Children relationship in your models:
 
 ```ruby
 class Parent < ActiveRecord::Base
@@ -332,7 +199,25 @@ class Child < ActiveRecord::Base
 end
 ```
 
-To reflect this in your front end, you just need to add three things to your app:
+Entangled takes note of every `belongs_to` association and creates two additional channels for each `belongs_to` association in the child model:
+
+```ruby
+"/parents/:parent_id/children"
+"/parents/:parent_id/children/:id"
+```
+
+So in total, the `Child` model will have all of the following channels:
+
+```ruby
+"/children"
+"/children/:id"
+"/parents/:parent_id/children"
+"/parents/:parent_id/children/:id"
+```
+
+Channels are deeply nested for child/parent/grandparent etc associations. There is no limit. To get a list of all available channels on a record, you can call the method `channels` on any entangled instance.
+
+To reflect associations in your front end, you just need to add three things to your app:
 
 - Nest your routes so that they resemble the parent/child relationship:
 
@@ -358,7 +243,9 @@ class ChildrenController < ApplicationController
   # Create child of specific parent
   def create
     broadcast do
-      @child = Parent.find(params[:parent_id]).children.create(child_params)
+      @child = Child.new(child_params)
+      @child.parent_id = params[:parent_id]
+      @child.save
     end
   end
 
@@ -366,56 +253,24 @@ class ChildrenController < ApplicationController
 end
 ```
 
-- Lastly, inform your Angular parent service about the association:
-
-```javascript
-app.factory('Parent', function(Entangled) {
-  // Instantiate Entangled service
-  var Parent = new Entangled('ws://localhost:3000/parents');
-
-  // Set up association  
-  Parent.hasMany('children');
-
-  return Parent;
-});
-```
-
-This makes a `children()` function available on your parent records on which you can chain all other functions to fetch/manipulate data:
-
-```javascript
-Parent.find(1, function(parent) {
-  parent.children().all(function(children) {
-    // children here all belong to parent with id 1
-  });
-
-  parent.children().find(1, function(child) {
-    // child has id 1 and belongs to parent with id 1
-  });
-
-  parent.children().create({ foo: 'bar' }, function(child) {
-    // child has been persisted and associated with parent
-  });
+Check out the JavaScript guides to implement associations on the client.
 
-  // etc
-});
-```
-
-This is the way to go if you want to fetch records that only belong to a certain record, or create records that should belong to a parent record. In short, it is ideal to scope records to parent records.
+## The Client
+Pick if you want to use Entangled with plain JavaScript or with Angular:
 
-Naturally, all nested records are also synced in real time across all connected clients.
+- [entangled-js](https://github.com/dchacke/entangled-js)
+- [entangled-angular](https://github.com/dchacke/entangled-angular)
 
 ## 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.
 
 ## Limitations
-The gem relies heavily on convention over configuration and currently only works with restful style controllers as shown above. More features will be available soon, such as associations, authentication, and more.
+The gem relies heavily on convention over configuration and currently only works with restful style controllers as shown above. More features will be available soon. See the list of development priorities below.
 
 ## Development Priorities
 The following features are to be implemented next:
 
-- Allow for more than one level of nesting of `#channels` in `Entangled::Model`
 - Support `belongsTo` in front end
-- Support deeply nested `belongs_to`, e.g. `Parent > Child > Grandchild`
 - Support `has_one` association in back end and front end
 - Add offline capabilities
 - Add authentication - with JWT?

data/lib/entangled/model.rb

@@ -77,40 +77,38 @@ module Entangled
       # a collection channel, i.e. /tacos, and a member
       # channel, i.e. /tacos/1, for direct access.
       # 
-      # If the model belongs_to other models, two nested
-      # channels are added for each belongs_to association.
-      # E.g., if child belongs_to parent, the two channels
-      # that are added are parents/1/children, and
-      # parents/1/children/1, leaving a total of four channels
-      def channels
+      # If the model belongs_to other models, nested channels
+      # are created for all parents, grand parents, etc
+      # recursively
+      def channels(tail = '')
         channels = []
         plural_name = self.class.name.underscore.pluralize
 
-        # Add collection's channel
-        channels << "/#{plural_name}"
-
-        # Add member's channel
-        channels << "/#{plural_name}/#{to_param}"
+        # Add collection channel for child only. If the tails
+        # is not empty, the function is being called recursively
+        # for one of the parents, for which only member channels
+        # are needed
+        if tail.empty?
+          collection_channel = "/#{plural_name}" + tail
+          channels << collection_channel
+        end
 
-        # Find parent names from belongs_to associations
-        parents = self.class.reflect_on_all_associations(:belongs_to)
+        # Add member channel
+        member_channel = "/#{plural_name}/#{to_param}" + tail
+        channels << member_channel
 
         # Add nested channels for each parent
-        parents.map(&:name).each do |parent_name|
-          # Get parent record from name
-          parent = send(parent_name)
-
-          # Get parent class's plural underscore name
-          parent_plural_name = parent_name.to_s.underscore.pluralize
-
-          # Add collection's channel nested under parent's member channel
-          channels << "/#{parent_plural_name}/#{parent.to_param}/#{plural_name}"
+        parents.each do |parent|
+          # Only recusively add collection channel
+          # for child
+          if tail.empty?
+            channels << parent.channels(collection_channel)
+          end
 
-          # Add member's channel nested under parent's member channel
-          channels << "/#{parent_plural_name}/#{parent.to_param}/#{plural_name}/#{to_param}"
+          channels << parent.channels(member_channel)
         end
 
-        channels
+        channels.flatten
       end
 
       private
@@ -132,6 +130,13 @@ module Entangled
           resource: self
         }.to_json
       end
+
+      # Find parent classes from belongs_to associations
+      def parents
+        self.class.
+          reflect_on_all_associations(:belongs_to).
+          map{ |a| send(a.name) }
+      end
     end
     
     def self.included(receiver)

data/lib/entangled/version.rb

@@ -1,3 +1,3 @@
 module Entangled
-  VERSION = "0.0.25"
+  VERSION = "0.0.26"
 end

data/spec/dummy/app/models/child.rb

@@ -0,0 +1,6 @@
+class Child < ActiveRecord::Base
+  include Entangled::Model
+  entangle
+
+  belongs_to :parent, required: true
+end

data/spec/dummy/app/models/grandfather.rb

@@ -0,0 +1,6 @@
+class Grandfather < ActiveRecord::Base
+  include Entangled::Model
+  entangle
+
+  has_many :parents, dependent: :destroy
+end

data/spec/dummy/app/models/grandmother.rb

@@ -0,0 +1,6 @@
+class Grandmother < ActiveRecord::Base
+  include Entangled::Model
+  entangle
+
+  has_many :parents, dependent: :destroy
+end

data/spec/dummy/app/models/item.rb

@@ -3,4 +3,6 @@ class Item < ActiveRecord::Base
   entangle
 
   belongs_to :list, required: true
+
+  validates :name, presence: true
 end

data/spec/dummy/app/models/parent.rb

@@ -0,0 +1,8 @@
+class Parent < ActiveRecord::Base
+  include Entangled::Model
+  entangle
+
+  has_many :children, dependent: :destroy
+  belongs_to :grandmother, required: true
+  belongs_to :grandfather, required: true
+end

data/spec/dummy/db/migrate/20150329034759_create_children.rb

@@ -0,0 +1,9 @@
+class CreateChildren < ActiveRecord::Migration
+  def change
+    create_table :children do |t|
+      t.integer :parent_id
+
+      t.timestamps null: false
+    end
+  end
+end

data/spec/dummy/db/migrate/20150329034900_create_parents.rb

@@ -0,0 +1,10 @@
+class CreateParents < ActiveRecord::Migration
+  def change
+    create_table :parents do |t|
+      t.integer :grandmother_id
+      t.integer :grandfather_id
+
+      t.timestamps null: false
+    end
+  end
+end

data/spec/dummy/db/migrate/20150329034915_create_grandmothers.rb

@@ -0,0 +1,8 @@
+class CreateGrandmothers < ActiveRecord::Migration
+  def change
+    create_table :grandmothers do |t|
+
+      t.timestamps null: false
+    end
+  end
+end

data/spec/dummy/db/migrate/20150329034923_create_grandfathers.rb

@@ -0,0 +1,8 @@
+class CreateGrandfathers < ActiveRecord::Migration
+  def change
+    create_table :grandfathers do |t|
+
+      t.timestamps null: false
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20150316034305) do
+ActiveRecord::Schema.define(version: 20150329034923) do
 
   create_table "barfoos", force: :cascade do |t|
     t.text     "body"
@@ -25,6 +25,12 @@ ActiveRecord::Schema.define(version: 20150316034305) do
     t.datetime "updated_at", null: false
   end
 
+  create_table "children", force: :cascade do |t|
+    t.integer  "parent_id"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
   create_table "foobars", force: :cascade do |t|
     t.text     "body"
     t.datetime "created_at", null: false
@@ -37,6 +43,16 @@ ActiveRecord::Schema.define(version: 20150316034305) do
     t.datetime "updated_at", null: false
   end
 
+  create_table "grandfathers", force: :cascade do |t|
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  create_table "grandmothers", force: :cascade do |t|
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
   create_table "items", force: :cascade do |t|
     t.string   "name"
     t.boolean  "complete",   default: false
@@ -51,4 +67,11 @@ ActiveRecord::Schema.define(version: 20150316034305) do
     t.datetime "updated_at", null: false
   end
 
+  create_table "parents", force: :cascade do |t|
+    t.integer  "grandmother_id"
+    t.integer  "grandfather_id"
+    t.datetime "created_at",     null: false
+    t.datetime "updated_at",     null: false
+  end
+
 end

data/spec/dummy/public/app/controllers/list.js

@@ -13,7 +13,6 @@ angular.module('entangledTest')
       });
 
       $scope.item = $scope.list.items().new();
-      console.log($scope.item);
     });
   });
 

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

@@ -9,8 +9,8 @@ angular.module('entangled', [])
   // methods $save(), $destroy, and others. A Resource also
   // stores the socket's URL it was retrieved from so it
   // can be reused for other requests.
-  var Resource = function(params, webSocketUrl, hasMany) {
-    // Assign proerties
+  function Resource(params, webSocketUrl, hasMany) {
+    // Assign properties
     for (var key in params) {
       // Skip inherent object properties
       if (params.hasOwnProperty(key)) {
@@ -160,7 +160,7 @@ angular.module('entangled', [])
 
   // Resources wraps all individual Resource objects
   // in a collection.
-  var Resources = function(resources, webSocketUrl, hasMany) {
+  function Resources(resources, webSocketUrl, hasMany) {
     this.all = [];
 
     for (var i = 0; i < resources.length; i++) {
@@ -178,9 +178,7 @@ angular.module('entangled', [])
   // Entangled is a constructor that takes the URL
   // of the index action on the server where the
   // Resources can be retrieved.
-  var Entangled = function(webSocketUrl) {
-    this.className = 'Entangled';
-
+  function Entangled(webSocketUrl) {
     // Store the root URL that sockets
     // will connect to
     this.webSocketUrl = webSocketUrl;
@@ -297,5 +295,6 @@ angular.module('entangled', [])
     }.bind(this);
   };
 
+  // Return Entangled object as Angular service
   return Entangled;
 });

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

@@ -15,9 +15,9 @@ describe('Entangled', function() {
     List.hasMany('items');
   }));
 
-  describe('.className', function() {
+  describe('constructor', function() {
     it('is "Entangled"', function() {
-      expect(List.className).toBe('Entangled');
+      expect(List.constructor.name).toBe('Entangled');
     });
   });
 
@@ -255,7 +255,7 @@ describe('Entangled', function() {
         // an instance of Entangled, meaning
         // in turn that all class and instance
         // methods are available on it
-        expect(list.items().className).toBe('Entangled');
+        expect(list.items().constructor.name).toBe('Entangled');
         done();
       });
     });

data/spec/models/channels_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+# Test channels inferred from relationships
+RSpec.describe 'Channels', type: :model do
+  let!(:grandmother) { Grandmother.create }
+  let!(:grandfather) { Grandfather.create }
+
+  let!(:parent) do
+    Parent.create(
+      grandmother_id: grandmother.id,
+      grandfather_id: grandfather.id
+    )
+  end
+
+  let!(:child) { Child.create(parent_id: parent.id) }
+
+  describe "grandmother's channels" do
+    it 'has two channels' do
+      expect(grandmother.channels.size).to eq 2
+    end
+
+    it 'has a collection channel' do
+      expect(grandmother.channels).to include '/grandmothers'
+    end
+
+    it 'has a member channel' do
+      expect(grandmother.channels).to include "/grandmothers/#{grandmother.to_param}"
+    end
+  end
+
+  describe "grandfather's channels" do
+    it 'has two channels' do
+      expect(grandfather.channels.size).to eq 2
+    end
+
+    it 'has a collection channel' do
+      expect(grandfather.channels).to include '/grandfathers'
+    end
+
+    it 'has a member channel' do
+      expect(grandfather.channels).to include "/grandfathers/#{grandfather.to_param}"
+    end
+  end
+
+  describe "parent's channels" do
+    it 'has six channels' do
+      expect(parent.channels.size).to eq 6
+    end
+
+    it 'has a collection channel' do
+      expect(parent.channels).to include '/parents'
+    end
+
+    it 'has a member channel' do
+      expect(parent.channels).to include "/parents/#{parent.to_param}"
+    end
+
+    it 'has a collection channel nested under its grandmother' do
+      expect(parent.channels).to include "/grandmothers/#{grandmother.to_param}/parents"
+    end
+
+    it 'has a member channel nested under its grandmother' do
+      expect(parent.channels).to include "/grandmothers/#{grandmother.to_param}/parents/#{parent.to_param}"
+    end
+
+    it 'has a collection channel nested under its grandfather' do
+      expect(parent.channels).to include "/grandfathers/#{grandfather.to_param}/parents"
+    end
+
+    it 'has a member channel nested under its grandfather' do
+      expect(parent.channels).to include "/grandfathers/#{grandfather.to_param}/parents/#{parent.to_param}"
+    end
+  end
+
+  describe "child's channels" do
+    it 'has eight channels' do
+      expect(child.channels.size).to eq 8
+    end
+
+    it 'has a collection channel' do
+      expect(child.channels).to include '/children'
+    end
+
+    it 'has a member channel' do
+      expect(child.channels).to include "/children/#{child.to_param}"
+    end
+
+    it 'has a collection channel nested under its parent' do
+      expect(child.channels).to include "/parents/#{parent.to_param}/children"
+    end
+
+    it 'has a member channel nested under its parent' do
+      expect(child.channels).to include "/parents/#{parent.to_param}/children/#{child.to_param}"
+    end
+
+    it 'has a collection channel nested under its parent and grandmother' do
+      expect(child.channels).to include "/grandmothers/#{grandmother.to_param}/parents/#{parent.to_param}/children"
+    end
+
+    it 'has a member channel nested under its parent and grandmother' do
+      expect(child.channels).to include "/grandmothers/#{grandmother.to_param}/parents/#{parent.to_param}/children/#{child.to_param}"
+    end
+
+    it 'has a collection channel nested under its parent and grandfather' do
+      expect(child.channels).to include "/grandfathers/#{grandfather.to_param}/parents/#{parent.to_param}/children"
+    end
+
+    it 'has a member channel nested under its parent and grandfather' do
+      expect(child.channels).to include "/grandfathers/#{grandfather.to_param}/parents/#{parent.to_param}/children/#{child.to_param}"
+    end
+  end
+end

data/spec/models/child_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe Child, type: :model do
+  describe 'Associations' do
+    it { is_expected.to belong_to :parent }
+  end
+
+  describe 'Attributes' do
+    it { is_expected.to respond_to :parent_id }
+  end
+
+  describe 'Database' do
+    it { is_expected.to have_db_column(:parent_id).of_type(:integer) }
+  end
+
+  describe 'Validations' do
+    it { is_expected.to validate_presence_of :parent }
+  end
+end

data/spec/models/grandfather_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+RSpec.describe Grandfather, type: :model do
+  describe 'Associations' do
+    it { is_expected.to have_many(:parents).dependent(:destroy) }
+  end
+end

data/spec/models/grandmother_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+RSpec.describe Grandmother, type: :model do
+  describe 'Associations' do
+    it { is_expected.to have_many(:parents).dependent(:destroy) }
+  end
+end

data/spec/models/item_spec.rb

@@ -17,34 +17,8 @@ RSpec.describe Item, type: :model do
     it { is_expected.to belong_to :list }
   end
 
-  describe 'Methods' do
-    let(:list) { List.create(name: 'foo') }
-    let(:item) { list.items.create(name: 'bar') }
-
-    describe '#channels' do
-      it 'is an array of channels' do
-        expect(item.channels).to be_an Array
-      end
-
-      it "includes the collection's channel" do
-        expect(item.channels).to include '/items'
-      end
-
-      it "includes the item's direct channel" do
-        expect(item.channels).to include "/items/#{item.to_param}"
-      end
-
-      it "includes the collection's nested channel" do
-        expect(item.channels).to include "/lists/#{list.to_param}/items"
-      end
-
-      it "includes the item's nested channel" do
-        expect(item.channels).to include "/lists/#{list.to_param}/items/#{item.to_param}"
-      end
-    end
-  end
-
   describe 'Validations' do
     it { is_expected.to validate_presence_of :list }
+    it { is_expected.to validate_presence_of :name }
   end
 end

data/spec/models/list_spec.rb

@@ -16,132 +16,113 @@ RSpec.describe List, type: :model do
   describe 'Methods' do
     let(:list) { List.create(name: 'foo') }
 
-    describe '#channels' do
-      it 'is an array of channels' do
-        expect(list.channels).to be_an Array
-      end
-
-      it "includes the collection's channel" do
-        expect(list.channels).to include '/lists'
-      end
-
-      it "includes the member's channel" do
-        expect(list.channels).to include "/lists/#{list.to_param}"
-      end
-    end
-  end
-
-  describe '#entangle' do
-    let(:stub_redis) do
-      mock("redis").tap do |redis|
-        redis.stubs(:publish)
-        Redis.stubs(:new).returns(redis)
-      end
-    end
-
-    describe 'creation' do
-      let(:list) { List.create(name: 'foo') }
-
-      it 'broadcasts the creation to the collection channel' do
-        redis = stub_redis
-
-        list.channels.each do |channel|
-          expect(redis).to have_received(:publish).with(
-            channel, {
-              action: :create,
-              resource: list
-            }.to_json
-          )
+    describe '#entangle' do
+      let(:stub_redis) do
+        mock("redis").tap do |redis|
+          redis.stubs(:publish)
+          Redis.stubs(:new).returns(redis)
         end
       end
 
-      it 'broadcasts the creation to the member channel' do
-        redis = stub_redis
+      describe 'creation' do
+        it 'broadcasts the creation to the collection channel' do
+          redis = stub_redis
+
+          list.channels.each do |channel|
+            expect(redis).to have_received(:publish).with(
+              channel, {
+                action: :create,
+                resource: list
+              }.to_json
+            )
+          end
+        end
 
-        list.channels.each do |channel|
-          expect(redis).to have_received(:publish).with(
-            channel, {
-              action: :create,
-              resource: list
-            }.to_json
-          )
+        it 'broadcasts the creation to the member channel' do
+          redis = stub_redis
+
+          list.channels.each do |channel|
+            expect(redis).to have_received(:publish).with(
+              channel, {
+                action: :create,
+                resource: list
+              }.to_json
+            )
+          end
         end
       end
-    end
 
-    describe 'update' do
-      let!(:list) { List.create(name: 'foo') }
+      describe 'update' do
+        it 'broadcasts the update to the collection channel' do
+          redis = stub_redis
 
-      it 'broadcasts the update to the collection channel' do
-        redis = stub_redis
+          list.update(name: 'bar')
 
-        list.update(name: 'bar')
-
-        list.channels.each do |channel|
-          expect(redis).to have_received(:publish).with(
-            channel, {
-              action: :update,
-              resource: list
-            }.to_json
-          )
+          list.channels.each do |channel|
+            expect(redis).to have_received(:publish).with(
+              channel, {
+                action: :update,
+                resource: list
+              }.to_json
+            )
+          end
         end
-      end
 
-      it 'broadcasts the update to the member channel' do
-        redis = stub_redis
+        it 'broadcasts the update to the member channel' do
+          redis = stub_redis
 
-        list.update(name: 'bar')
+          list.update(name: 'bar')
 
-        list.channels.each do |channel|
-          expect(redis).to have_received(:publish).with(
-            channel, {
-              action: :update,
-              resource: list
-            }.to_json
-          )
+          list.channels.each do |channel|
+            expect(redis).to have_received(:publish).with(
+              channel, {
+                action: :update,
+                resource: list
+              }.to_json
+            )
+          end
         end
       end
-    end
 
-    describe 'destruction' do
-      let!(:list) { List.create(name: 'foo') }
+      describe 'destruction' do
+        it 'broadcasts the destruction to the collection channel' do
+          redis = stub_redis
 
-      it 'broadcasts the destruction to the collection channel' do
-        redis = stub_redis
+          list.destroy
 
-        list.destroy
-
-        list.channels.each do |channel|
-          expect(redis).to have_received(:publish).with(
-            channel, {
-              action: :destroy,
-              resource: list
-            }.to_json
-          )
+          list.channels.each do |channel|
+            expect(redis).to have_received(:publish).with(
+              channel, {
+                action: :destroy,
+                resource: list
+              }.to_json
+            )
+          end
         end
-      end
 
-      it 'broadcasts the destruction to the member channel' do
-        redis = stub_redis
-        
-        list.destroy
-
-        list.channels.each do |channel|
-          expect(redis).to have_received(:publish).with(
-            channel, {
-              action: :destroy,
-              resource: list
-            }.to_json
-          )
+        it 'broadcasts the destruction to the member channel' do
+          redis = stub_redis
+          
+          list.destroy
+
+          list.channels.each do |channel|
+            expect(redis).to have_received(:publish).with(
+              channel, {
+                action: :destroy,
+                resource: list
+              }.to_json
+            )
+          end
         end
       end
     end
-  end
 
-  describe '#as_json' do
-    it 'includes errors' do
-      list = List.create
-      expect(list.as_json["errors"][:name]).to include "can't be blank"
+    describe '#as_json' do
+      let(:list) { List.create }
+
+      it 'includes errors' do
+        expect(list.as_json["errors"][:name]).to include "can't be blank"
+      end
     end
   end
 

data/spec/models/parent_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+RSpec.describe Parent, type: :model do
+  describe 'Associations' do
+    it { is_expected.to have_many(:children).dependent(:destroy) }
+    it { is_expected.to belong_to :grandmother }
+    it { is_expected.to belong_to :grandfather }
+  end
+
+  describe 'Attributes' do
+    it { is_expected.to respond_to :grandmother_id }
+    it { is_expected.to respond_to :grandfather_id }
+  end
+
+  describe 'Database' do
+    it { is_expected.to have_db_column(:grandmother_id).of_type(:integer) }
+    it { is_expected.to have_db_column(:grandfather_id).of_type(:integer) }
+  end
+
+  describe 'Validations' do
+    it { is_expected.to validate_presence_of :grandmother }
+    it { is_expected.to validate_presence_of :grandfather }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: entangled
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.0.26
 platform: ruby
 authors:
 - Dennis Charles Hackethal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-22 00:00:00.000000000 Z
+date: 2015-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -177,9 +177,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bower.json
 - entangled.gemspec
-- entangled.js
 - lib/entangled.rb
 - lib/entangled/controller.rb
 - lib/entangled/helpers.rb
@@ -195,12 +193,16 @@ files:
 - spec/dummy/app/models/.keep
 - spec/dummy/app/models/bar.rb
 - spec/dummy/app/models/barfoo.rb
+- spec/dummy/app/models/child.rb
 - spec/dummy/app/models/concerns/.keep
 - spec/dummy/app/models/foo.rb
 - spec/dummy/app/models/foobar.rb
+- spec/dummy/app/models/grandfather.rb
+- spec/dummy/app/models/grandmother.rb
 - spec/dummy/app/models/item.rb
 - spec/dummy/app/models/list.rb
 - spec/dummy/app/models/message.rb
+- spec/dummy/app/models/parent.rb
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
 - spec/dummy/bin/rake
@@ -232,6 +234,10 @@ files:
 - spec/dummy/db/migrate/20150314054548_create_lists.rb
 - spec/dummy/db/migrate/20150314055847_create_items.rb
 - spec/dummy/db/migrate/20150316034305_drop_messages.rb
+- spec/dummy/db/migrate/20150329034759_create_children.rb
+- spec/dummy/db/migrate/20150329034900_create_parents.rb
+- spec/dummy/db/migrate/20150329034915_create_grandmothers.rb
+- spec/dummy/db/migrate/20150329034923_create_grandfathers.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/log/.keep
 - spec/dummy/public/Gruntfile.js
@@ -248,9 +254,14 @@ files:
 - spec/dummy/public/views/lists/index.html
 - spec/dummy/public/views/lists/show.html
 - spec/helpers/redis_spec.rb
+- spec/models/channels_spec.rb
+- spec/models/child_spec.rb
+- spec/models/grandfather_spec.rb
+- spec/models/grandmother_spec.rb
 - spec/models/inclusion_exclusion_spec.rb
 - spec/models/item_spec.rb
 - spec/models/list_spec.rb
+- spec/models/parent_spec.rb
 - spec/routing/inclusion_exclusion_routing_spec.rb
 - spec/routing/nested_routing_spec.rb
 - spec/spec_helper.rb
@@ -288,12 +299,16 @@ test_files:
 - spec/dummy/app/models/.keep
 - spec/dummy/app/models/bar.rb
 - spec/dummy/app/models/barfoo.rb
+- spec/dummy/app/models/child.rb
 - spec/dummy/app/models/concerns/.keep
 - spec/dummy/app/models/foo.rb
 - spec/dummy/app/models/foobar.rb
+- spec/dummy/app/models/grandfather.rb
+- spec/dummy/app/models/grandmother.rb
 - spec/dummy/app/models/item.rb
 - spec/dummy/app/models/list.rb
 - spec/dummy/app/models/message.rb
+- spec/dummy/app/models/parent.rb
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
 - spec/dummy/bin/rake
@@ -325,6 +340,10 @@ test_files:
 - spec/dummy/db/migrate/20150314054548_create_lists.rb
 - spec/dummy/db/migrate/20150314055847_create_items.rb
 - spec/dummy/db/migrate/20150316034305_drop_messages.rb
+- spec/dummy/db/migrate/20150329034759_create_children.rb
+- spec/dummy/db/migrate/20150329034900_create_parents.rb
+- spec/dummy/db/migrate/20150329034915_create_grandmothers.rb
+- spec/dummy/db/migrate/20150329034923_create_grandfathers.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/log/.keep
 - spec/dummy/public/Gruntfile.js
@@ -341,9 +360,14 @@ test_files:
 - spec/dummy/public/views/lists/index.html
 - spec/dummy/public/views/lists/show.html
 - spec/helpers/redis_spec.rb
+- spec/models/channels_spec.rb
+- spec/models/child_spec.rb
+- spec/models/grandfather_spec.rb
+- spec/models/grandmother_spec.rb
 - spec/models/inclusion_exclusion_spec.rb
 - spec/models/item_spec.rb
 - spec/models/list_spec.rb
+- spec/models/parent_spec.rb
 - spec/routing/inclusion_exclusion_routing_spec.rb
 - spec/routing/nested_routing_spec.rb
 - spec/spec_helper.rb

data/bower.json

@@ -1,20 +0,0 @@
-{
-  "name": "entangled",
-  "version": "0.0.8",
-  "authors": [
-    "Dennis Charles Hackethal <dennis.hackethal@gmail.com>"
-  ],
-  "description": "Angular library that communicates with a real time backend to enable three way data binding",
-  "license": "MIT",
-  "homepage": "https://github.com/dchacke/entangled",
-  "ignore": [
-    "lib",
-    "spec",
-    ".gitignore",
-    "entangled.gemspec",
-    "Gemfile",
-    "Gemfile.lock",
-    "Rakefile"
-  ],
-  "main": "entangled.js"
-}

data/entangled.js

@@ -1 +0,0 @@
-angular.module("entangled",[]).factory("Entangled",function(){var e=function(e,t,r){for(var i in e)e.hasOwnProperty(i)&&(this[i]=e[i]);this.webSocketUrl=t,r&&(this[r]=function(){return new s(this.webSocketUrl+"/"+this.id+"/"+r)})};e.prototype.$save=function(e){if(this.id){var t=new WebSocket(this.webSocketUrl+"/"+this.id+"/update");t.onopen=function(){t.send(JSON.stringify(this))}.bind(this),t.onmessage=function(t){if(t.data){var r=JSON.parse(t.data);if(r.resource)for(key in r.resource)this[key]=r.resource[key]}this[this.hasMany]=new s(this.webSocketUrl+"/"+this.id+"/"+this.hasMany),e&&e(this)}.bind(this)}else{var t=new WebSocket(this.webSocketUrl+"/create");t.onopen=function(){t.send(JSON.stringify(this))}.bind(this),t.onmessage=function(t){if(t.data){var s=JSON.parse(t.data);if(s.resource)for(key in s.resource)this[key]=s.resource[key]}e&&e(this)}.bind(this)}},e.prototype.$update=function(e,t){for(var s in e)e.hasOwnProperty(s)&&(this[s]=e[s]);this.$save(t)},e.prototype.$destroy=function(e){var t=new WebSocket(this.webSocketUrl+"/"+this.id+"/destroy");t.onopen=function(){t.send(null)},t.onmessage=function(t){if(t.data){var s=JSON.parse(t.data);if(s.resource)for(key in s.resource)this[key]=s.resource[key]}e&&e(this)}.bind(this)},e.prototype.$valid=function(){return!(this.errors&&Object.keys(this.errors).length)},e.prototype.$invalid=function(){return!this.$valid()},e.prototype.$persisted=function(){return!!this.id};var t=function(t,s,r){this.all=[];for(var i=0;i<t.length;i++){var o=new e(t[i],s,r);this.all.push(o)}},s=function(e){this.className="Entangled",this.webSocketUrl=e};return s.prototype.hasMany=function(e){this.hasMany=e},s.prototype["new"]=function(t){return new e(t,this.webSocketUrl,this.hasMany)},s.prototype.all=function(s){var r=new WebSocket(this.webSocketUrl);r.onmessage=function(i){if(i.data.length){var o=JSON.parse(i.data);if(o.resources)this.resources=new t(o.resources,r.url,this.hasMany);else if(o.action)if("create"===o.action)this.resources.all.push(new e(o.resource,r.url,this.hasMany));else if("update"===o.action){for(var n,a=0;a<this.resources.all.length;a++)this.resources.all[a].id===o.resource.id&&(n=a);this.resources.all[n]=new e(o.resource,r.url,this.hasMany)}else if("destroy"===o.action){for(var n,a=0;a<this.resources.all.length;a++)this.resources.all[a].id===o.resource.id&&(n=a);this.resources.all.splice(n,1)}else console.log("Something else other than CRUD happened..."),console.log(o)}s(this.resources.all)}.bind(this)},s.prototype.create=function(e,t){var s=this["new"](e);s.$save(t)},s.prototype.find=function(t,s){var r=this.webSocketUrl,i=new WebSocket(r+"/"+t);i.onmessage=function(t){if(t.data.length){var i=JSON.parse(t.data);i.resource&&!i.action?this.resource=new e(i.resource,r,this.hasMany):i.action?"update"===i.action?this.resource=new e(i.resource,r,this.hasMany):"destroy"===i.action&&(this.resource=void 0):(console.log("Something else other than CRUD happened..."),console.log(i))}s(this.resource)}.bind(this)},s});