render_sync 0.5.0

data/test/sync/partial_creator_test.rb

@@ -0,0 +1,35 @@
+require_relative '../test_helper'
+
+describe RenderSync::PartialCreator do
+  include TestHelper
+
+  before do
+    @context = ActionController::Base.new
+    @partial_creator = RenderSync::PartialCreator.new("show", User.new, scope = nil, @context)
+  end
+
+  describe '#channel' do
+    it 'always starts with a forward slash to provide Faye valid channel' do
+      assert_equal "/", @partial_creator.channel.first
+    end
+  end
+
+  describe '#selector' do
+    it 'returns a String selector where partials will be appended in DOM' do
+      assert @partial_creator.selector.length > 0
+    end
+  end
+
+  describe '#sync_new' do
+    it 'publishes a new message to faye to append new partials to DOM' do
+      # TODO: Stub Message
+      assert @partial_creator.sync_new
+    end
+  end
+
+  describe '#message' do
+    it 'returns a Message instance for the partial for the update action' do
+      assert_equal RenderSync.client.class::Message, @partial_creator.message.class
+    end
+  end
+end

data/test/sync/partial_test.rb

@@ -0,0 +1,107 @@
+require_relative '../test_helper'
+require 'rails/all'
+require_relative 'abstract_controller'
+require_relative '../models/user'
+
+describe RenderSync::Partial do
+  include TestHelper
+
+  before do
+    @context = ActionController::Base.new
+    @partial = RenderSync::Partial.new("show", User.new, nil, @context)
+  end
+
+  describe '#self.all' do
+    it 'returns an array of all Partials for given model' do
+      assert_equal 1, RenderSync::Partial.all(User.new, @context).size
+      assert_equal RenderSync::Partial, RenderSync::Partial.all(User.new, @context)[0].class
+    end
+  end
+
+  describe '#self.find' do
+    it 'finds partial given resource and partial name' do
+      Dir.stubs(:[]).returns("_show.html.erb")
+      assert_equal RenderSync::Partial, RenderSync::Partial.find(User.new, 'show', nil).class
+    end
+
+    it 'returns nil if partial does not exist' do
+      Dir.stubs(:[]).returns []
+      refute RenderSync::Partial.find(User.new, 'not_exist', nil)
+    end
+  end
+
+  describe '#render_to_string' do
+    it 'renders itself as a string' do
+      assert_equal "<h1>1<\/h1>", @partial.render_to_string
+    end
+  end
+
+  describe '#render' do
+    it 'renders' do
+      # TODO stub out
+      assert @partial.respond_to?(:render)
+    end
+  end
+
+  describe '#sync' do
+    it 'sends update to faye for given partial and update action' do
+      # TODO stub out
+      assert @partial.sync(:update)
+    end
+
+    it 'sends update to faye for given partial and destroy action' do
+      # TODO stub out
+      assert @partial.sync(:destroy)
+    end
+  end
+
+  describe '#message' do
+    it 'returns a Message instance for the partial for the update action' do
+      assert_equal RenderSync.client.class::Message, @partial.message(:update).class
+    end
+
+     it 'returns a Message instance for the partial for the destroy action' do
+      assert_equal RenderSync.client.class::Message, @partial.message(:destroy).class
+    end
+  end
+
+  describe '#channel_prefix' do
+    it 'returns a unique channel prefix for the partial given its name and resource' do
+      assert @partial.channel_prefix
+    end
+  end
+
+  describe 'channel_for_action' do
+    it 'returns the channel for the update action' do
+      assert @partial.channel_for_action(:update)
+    end
+
+    it 'returns the channel for the destroy action' do
+      assert @partial.channel_for_action(:destroy)
+    end
+
+    it 'always starts with a forward slash to provide Faye valid channel' do
+      assert_equal "/", @partial.channel_for_action(:update).first
+      assert_equal "/", @partial.channel_for_action(:destroy).first
+    end
+  end
+
+  describe '#selector_start' do
+    it 'returns a string for the selector to mark element beginning' do
+      assert @partial.selector_start.present?
+    end
+  end
+
+  describe '#selector_end' do
+    it 'returns a string for the selector to mark element ending' do
+      assert @partial.selector_end.present?
+    end
+  end
+
+  describe 'creator_for_scope' do
+    it 'returns a new PartialCreator for given scope' do
+      assert_equal RenderSync::PartialCreator, @partial.creator_for_scope(nil).class
+      assert @partial, @partial.creator_for_scope(nil).partial
+    end
+  end
+end

data/test/sync/protected_attributes_test.rb

@@ -0,0 +1,39 @@
+require_relative '../test_helper'
+require 'mocha/setup'
+require 'rails/all'
+
+setup_database
+
+describe RenderSync::Model do
+
+  it 'publishes record (create/update/destroy) to main new channel' do
+    RenderSync::Model.enable do
+      user = UserWithProtectedAttributes.new
+
+      # Create
+      user.save!
+      assert user.persisted?
+      assert_equal 1, user.sync_actions.size
+
+      assert_equal :new, user.sync_actions[0].name
+      assert_equal "/user_with_protected_attributes/#{user.id}", user.sync_actions[0].test_path
+
+      # Update
+      user.update_attribute(:name, "Foo")
+      assert user.persisted?
+      assert_equal 1, user.sync_actions.size
+
+      assert_equal :update, user.sync_actions[0].name
+      assert_equal "/user_with_protected_attributes/#{user.id}", user.sync_actions[0].test_path
+
+      # Destroy
+      user.destroy
+      assert user.destroyed?
+      assert_equal 1, user.sync_actions.size
+
+      assert_equal :destroy, user.sync_actions[0].name
+      assert_equal "/user_with_protected_attributes/#{user.id}", user.sync_actions[0].test_path
+    end
+  end
+
+end

data/test/sync/reactor_test.rb

@@ -0,0 +1,18 @@
+require_relative '../test_helper'
+require 'mocha/setup'
+
+
+describe RenderSync::Reactor do
+  include TestHelper
+  
+  describe '#perform' do
+    it 'starts EventMachine thread and runs block' do
+      refute RenderSync.reactor.running?
+      ran_block = false
+      RenderSync.reactor.perform { ran_block = true}
+      assert RenderSync.reactor.running?
+      sleep 0.1
+      assert ran_block
+    end
+  end
+end

data/test/sync/refetch_model_test.rb

@@ -0,0 +1,26 @@
+require_relative '../test_helper'
+require_relative '../models/user'
+require 'mocha/setup'
+
+describe RenderSync::RefetchModel do
+  include TestHelper
+
+  describe '#find_by_class_name_and_id' do
+    it 'finds record by model name and id' do
+      User.expects(:find).once.returns(User.new)
+      RenderSync::RefetchModel.stubs(:supported_classes).returns ["User"]
+      assert RenderSync::RefetchModel.find_by_class_name_and_id("user", 1).is_a? User
+    end
+
+    it 'Returns nil if class name is not sync model' do
+      Object.expects(:find).never
+      refute RenderSync::RefetchModel.find_by_class_name_and_id("object", 1)
+    end
+
+    it "Returns nil if record is not found for id" do
+      User.expects(:find).once.raises(StandardError.new("Record not found"))
+      RenderSync::RefetchModel.stubs(:supported_classes).returns ["User"]
+      refute RenderSync::RefetchModel.find_by_class_name_and_id("user", 1)
+    end
+  end
+end

data/test/sync/refetch_partial_creator_test.rb

@@ -0,0 +1,16 @@
+require_relative '../test_helper'
+
+describe RenderSync::RefetchPartialCreator do
+  include TestHelper
+
+  before do
+    @context = ActionController::Base.new
+    @partial_creator = RenderSync::RefetchPartialCreator.new("show", User.new, scope = nil, @context)
+  end
+
+  describe '#message' do
+    it 'returns a Message instance for the partial for the update action' do
+      assert_equal RenderSync.client.class::Message, @partial_creator.message.class
+    end
+  end
+end

data/test/sync/refetch_partial_test.rb

@@ -0,0 +1,74 @@
+require_relative '../test_helper'
+require 'rails/all'
+require_relative 'abstract_controller'
+require_relative '../models/user'
+
+describe RenderSync::RefetchPartial do
+  include TestHelper
+
+  before do
+    @context = ActionController::Base.new
+    @partial = RenderSync::RefetchPartial.new("show", User.new, nil, @context)
+  end
+ 
+  describe '#self.all' do
+    it 'returns an array of all Partials for given model' do
+      assert_equal 1, RenderSync::RefetchPartial.all(User.new, @context).size
+      assert_equal RenderSync::RefetchPartial, RenderSync::RefetchPartial.all(User.new, @context)[0].class
+    end
+  end
+
+  describe '#self.find' do
+    it 'finds partial given resource and partial name' do
+      assert_equal RenderSync::RefetchPartial, RenderSync::RefetchPartial.find(User.new, 'show', @context).class
+    end
+
+    it 'returns nil if partial does not exist' do
+      refute RenderSync::RefetchPartial.find(User.new, 'not_exist', nil)
+    end
+  end
+
+  describe '#self.find_by_authorized_resource' do
+
+    it 'returns partial when given auth token for resource and template' do
+      assert_equal RenderSync::RefetchPartial, RenderSync::RefetchPartial.find_by_authorized_resource(
+        @partial.resource.model,
+        @partial.name,
+        nil, 
+        @partial.auth_token
+      ).class
+    end
+
+    it 'returns nil when given invalid auth token for resource and template' do
+      refute RenderSync::RefetchPartial.find_by_authorized_resource(
+        @partial.resource.model,
+        @partial.name,
+        nil, 
+        "invalid auth token"
+      )
+    end
+  end
+
+  describe '#render_to_string' do
+    it 'renders itself as a string from the refetch directory' do
+      assert_equal "<h1>Refetch 1<\/h1>", @partial.render_to_string
+    end
+  end
+
+  describe '#message' do
+    it 'returns a Message instance for the partial for the update action' do
+      assert_equal RenderSync.client.class::Message, @partial.message(:update).class
+    end
+
+     it 'returns a Message instance for the partial for the destroy action' do
+      assert_equal RenderSync.client.class::Message, @partial.message(:destroy).class
+    end
+  end
+
+  describe 'creator_for_scope' do
+    it 'returns a new PartialCreator for given scope' do
+      assert_equal RenderSync::RefetchPartialCreator, @partial.creator_for_scope(nil).class
+      assert @partial, @partial.creator_for_scope(nil).partial
+    end
+  end
+end

data/test/sync/renderer_test.rb

@@ -0,0 +1,19 @@
+require_relative '../test_helper'
+require_relative '../models/user'
+
+describe RenderSync::Renderer do
+  include TestHelper
+
+  class ApplicationController < ActionController::Base
+  end
+
+  let(:renderer){ RenderSync::Renderer.new }
+
+  describe '#render_to_string' do
+    it 'renders partial as string' do
+      assert_equal "<h1>1<\/h1>", renderer.render_to_string(
+        partial: 'sync/users/show', locals: { user: User.new }
+      )
+    end
+  end
+end

data/test/sync/resource_test.rb

@@ -0,0 +1,181 @@
+require 'rails/all'
+require_relative '../test_helper'
+require_relative 'abstract_controller'
+require_relative '../models/user'
+require_relative '../models/project'
+require_relative '../models/group'
+
+describe RenderSync::Partial do
+  include TestHelper
+
+  before do
+    @user = User.create
+    @group = Group.create 
+    @project = Project.create
+  end
+
+  describe '#name' do
+    it 'returns the underscored model class name' do
+      assert_equal "user", RenderSync::Resource.new(@user).name
+    end
+  end
+
+  describe '#plural_name' do
+    it 'returns the underscored model class name' do
+      assert_equal "users", RenderSync::Resource.new(@user).plural_name
+    end
+  end
+
+  describe '#id' do
+    it 'returns the models id' do
+      assert_equal 1, RenderSync::Resource.new(@user).id
+    end
+  end
+
+  describe '#scopes=' do
+    before do
+      @resource = RenderSync::Resource.new(@user)
+    end
+
+    it 'ignores nil' do
+      @resource.scopes = nil
+      assert_nil @resource.scopes
+    end
+
+    it 'converts scalar value to an array' do
+      @resource.scopes = :en
+      assert_equal [:en], @resource.scopes
+    end
+
+  end
+
+  describe '#scopes_path' do
+    describe 'a resource without a scope' do
+      it 'returns /' do
+        resource = RenderSync::Resource.new(@user)
+        assert_equal '/', resource.scopes_path.to_s
+      end
+    end
+
+    describe 'a resource with a simple scope' do
+      it 'returns a path prefixed with the scope' do
+        resource = RenderSync::Resource.new(@user, :admin)
+        assert_equal '/admin', resource.scopes_path.to_s
+      end
+    end
+
+    describe 'a resource with a parent model as scope' do
+      it "returns the parent model's path" do
+        resource = RenderSync::Resource.new(@user, @project)
+        assert_equal "/projects/#{@project.id}", resource.scopes_path.to_s
+      end
+    end
+
+    describe 'a resource with mixed scopes' do
+      it 'returns a path including all scopes' do
+        resource = RenderSync::Resource.new(@user, [:en, :admin, @project])
+        assert_equal "/en/admin/projects/#{@project.id}", resource.scopes_path.to_s
+      end
+    end
+  end
+
+  describe '#polymorphic_path' do
+    describe 'a resource without a scope' do
+      it 'returns the path for the model' do
+        assert_equal "/users/1", RenderSync::Resource.new(@user).polymorphic_path.to_s
+      end
+    end
+
+    describe 'a resource with a simple scope' do
+      it 'returns the path for the model, prefixed by the scope' do
+        resource = RenderSync::Resource.new(@user, :en) 
+        assert_equal "/en/users/1", resource.polymorphic_path.to_s
+      end
+    end
+
+    describe 'a resource with a parent model as scope' do
+      it 'returns the path for the model, prefixed by parent path' do
+        child = RenderSync::Resource.new(@user, @project)
+        assert_equal "/projects/#{@project.id}/users/1", child.polymorphic_path.to_s
+      end
+    end
+
+    describe 'a resource with an RenderSync::Scope object as scope' do
+      it 'returns the path for the model, prefixed by sync_scope path' do
+        child = RenderSync::Resource.new(@user, User.cool)
+        assert_equal "/cool/users/1", child.polymorphic_path.to_s
+      end
+    end
+
+    describe 'a resource with an RenderSync::Scope object with AR-param as scope' do
+      it 'returns the path for the model, prefixed by sync_scope path' do
+        child = RenderSync::Resource.new(@user, User.in_group(@group))
+        assert_equal "/in_group/group/#{@group.id}/users/1", child.polymorphic_path.to_s
+      end
+    end
+
+    describe 'a resource with an RenderSync::Scope object with Integer-param as scope' do
+      it 'returns the path for the model, prefixed by sync_scope path' do
+        child = RenderSync::Resource.new(@user, User.with_group_id(@group.id))
+        assert_equal "/with_group_id/group_id/#{@group.id}/users/1", child.polymorphic_path.to_s
+      end
+    end
+
+    describe 'a resource with an RenderSync::Scope object with multiple params as scope' do
+      it 'returns the path for the model, prefixed by sync_scope path' do
+        child = RenderSync::Resource.new(@user, User.with_min_age_in_group(15, @group.id))
+        assert_equal "/with_min_age_in_group/age/15/group_id/#{@group.id}/users/1", child.polymorphic_path.to_s
+      end
+    end
+
+    describe 'a resource with mixed scopes' do
+      it 'returns the path for the model, prefixed by all scopes' do
+        child = RenderSync::Resource.new(@user, [:en, :admin, @project, User.cool, User.in_group(@group)])
+        assert_equal "/en/admin/projects/#{@project.id}/cool/in_group/group/#{@group.id}/users/1", child.polymorphic_path.to_s
+      end
+    end
+  end
+
+  describe '#model_path' do
+    it 'returns the raw path of the model without any scopes' do
+      child = RenderSync::Resource.new(@user, @project)
+      assert_equal "/users/1", child.model_path.to_s
+    end
+  end
+
+  describe '#polymorphic_new_path' do
+    describe 'a resource without a scope' do
+      it 'returns the path for the model' do
+        assert_equal "/users/new", RenderSync::Resource.new(@user).polymorphic_new_path.to_s
+      end
+    end
+
+    describe 'a resource with a simple scope' do
+      it 'returns the path for the model, prefixed by the scope' do
+        resource = RenderSync::Resource.new(@user, :en)
+        assert_equal "/en/users/new", resource.polymorphic_new_path.to_s
+      end
+    end
+
+    describe 'a resource with a parent model as scope' do
+      it 'returns the path for the model, prefixed by parent path' do
+        child = RenderSync::Resource.new(@user, @project)
+        assert_equal "/projects/#{@project.id}/users/new", child.polymorphic_new_path.to_s
+      end
+    end
+
+    describe 'a resource with a RenderSync::Scope object as scope' do
+      it 'returns the path for the model, prefixed by parent path' do
+        child = RenderSync::Resource.new(@user, User.cool)
+        assert_equal "/cool/users/new", child.polymorphic_new_path.to_s
+      end
+    end
+
+    describe 'a resource with mixed scopes' do
+      it 'returns the path for the model, prefixed by all scopes' do
+        child = RenderSync::Resource.new(@user, [:en, :admin, @project, User.cool, User.in_group(@group)])
+        assert_equal "/en/admin/projects/#{@project.id}/cool/in_group/group/#{@group.id}/users/new", child.polymorphic_new_path.to_s
+      end
+    end
+  end
+end