render_sync 0.5.0

data/test/sync/scope_definition_test.rb

@@ -0,0 +1,39 @@
+require_relative '../test_helper'
+require_relative '../models/user'
+
+describe RenderSync::ScopeDefinition do
+  include TestHelper
+
+  describe '#ensure_valid_params!' do
+    it 'raises an argument error with one invalid argument' do
+      assert_raises ArgumentError do 
+        # attribute, associtation or instance method 'project' not present in user instance
+        RenderSync::ScopeDefinition.ensure_valid_params!(User, ->(project) { User.all })
+      end
+    end
+    
+    it 'raises an argument error with a valid and an invalid argument' do
+      assert_raises ArgumentError do 
+        # attribute, associtation or instance method 'project' not present in user instance
+        # name is a column on user record
+        RenderSync::ScopeDefinition.ensure_valid_params!(User, ->(name, project) { User.all })
+      end
+    end
+
+    it 'returns true with no arguments' do
+      assert_equal true, RenderSync::ScopeDefinition.ensure_valid_params!(User, -> { User.all })
+    end
+        
+    it 'returns true with one valid argument' do
+      # group is an association on the user record
+      assert_equal true, RenderSync::ScopeDefinition.ensure_valid_params!(User, ->(group) { User.all })
+    end
+
+    it 'returns true with multiple valid argument' do
+      # group is an association on the user record
+      # name is a column on user record
+      assert_equal true, RenderSync::ScopeDefinition.ensure_valid_params!(User, ->(group, name) { User.all })
+    end
+
+  end
+end

data/test/sync/scope_test.rb

@@ -0,0 +1,113 @@
+require 'rails/all'
+require_relative '../test_helper'
+require_relative 'abstract_controller'
+require_relative '../models/user'
+require_relative '../models/project'
+require_relative '../models/group'
+require_relative '../models/todo'
+
+describe RenderSync::Scope do
+  include TestHelper
+
+  describe '#initialize' do
+    it 'return an RenderSync::Scope instance' do
+      assert_kind_of RenderSync::Scope, User.with_group_id(5)
+    end
+
+    it 'raises an argument error with an invalid param (float)' do
+      assert_raises ArgumentError do 
+        User.with_group_id(0.5)
+      end
+    end
+
+    it 'returns an RenderSync::Scope instance and sets instance variables correctly' do
+      scope = User.with_group_id(5)
+      assert_kind_of RenderSync::Scope, scope
+      assert_equal scope.args, [5]
+      assert_equal scope.scope_definition, User.sync_scope_definitions[:with_group_id]
+    end
+  end
+  
+  describe '#new_from_model' do
+    it 'returns an RenderSync::Scope instance and sets instance variables correctly' do
+      scope_definition = User.sync_scope_definitions[:with_group_id]
+      user = User.create(group_id: 3)
+      scope = RenderSync::Scope.new_from_model(scope_definition, user)
+      assert_kind_of RenderSync::Scope, scope
+      assert_equal scope.args, [3]
+      assert_equal scope.scope_definition, scope_definition
+    end
+  end
+
+  describe '#relation' do
+    it 'returns the ActiveRecord::Relation' do
+      scope = User.with_group_id(5)
+      assert_kind_of ActiveRecord::Relation, scope.relation
+    end
+  end
+  
+  describe '#valid?' do
+    it 'returns true for a relation that does not throw an exception' do
+      scope = User.with_group_id(5)
+      assert_equal true, scope.valid?
+    end
+
+    it 'returns false for a relation that throws an exception' do
+      scope_definition = User.sync_scope_definitions[:in_group]
+      user = User.create(group: nil)
+      scope = RenderSync::Scope.new_from_model(scope_definition, user)
+      assert_equal false, scope.valid?
+    end
+  end
+
+  describe '#contains?' do
+    it 'returns true if the given record is in the scope' do
+      todo = Todo.create(user_id: 2)
+      scope = Todo.with_user_id(2)
+      assert_equal true, scope.contains?(todo)
+    end
+
+    it 'returns false if the given record is not in the scope' do
+      todo = Todo.create(user_id: 2)
+      scope = Todo.with_user_id(5)
+      assert_equal false, scope.contains?(todo)
+    end
+  end
+
+  describe 'setting up a sync scope in the model' do
+    it 'adds a simple scope definition to the model class' do
+      class User < ActiveRecord::Base
+        sync_scope :without_name, -> { where(name: nil)}
+      end
+      assert User.sync_scope_definitions[:without_name].present?
+    end
+
+    it 'adds a scope definition if lambda names are correct' do
+      class User < ActiveRecord::Base
+        sync_scope :with_age, ->(age) { where(age: age)}
+      end
+      assert User.sync_scope_definitions[:with_age].present?
+    end
+
+    it 'raises an exception if lambda arg names are invalid' do
+      assert_raises ArgumentError do 
+        class User < ActiveRecord::Base
+          sync_scope :with_max_age, ->(max_age) { where(["age <= ?", max_age])}
+        end
+      end
+      assert User.sync_scope_definitions[:with_max_age].blank?
+    end
+
+    it 'raises an exception if sync scope name method with that name is already defined' do
+      assert_raises ArgumentError do 
+        class User < ActiveRecord::Base
+          sync_scope :old, -> { where(["arg > ?", 70])}
+          sync_scope :old, -> { where(["arg > ?", 90])}
+        end
+      end
+    end
+    
+    
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'yaml'
+require 'json'
+require 'pry'
+require 'codeclimate-test-reporter'
+
+CodeClimate::TestReporter.start
+
+require_relative 'em_minitest_spec'
+
+ENV["RAILS_ENV"] = "test"
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+
+Bundler.require(:default)
+
+def setup_database
+  ActiveRecord::Base.send :extend, RenderSync::Model::ClassMethods
+
+  ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS todos")
+  ActiveRecord::Base.connection.execute("CREATE TABLE todos (id INTEGER PRIMARY KEY, name TEXT, complete BOOLEAN, user_id INTEGER)")
+
+  ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS users")
+  ActiveRecord::Base.connection.execute("CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT, cool BOOLEAN, group_id INTEGER, project_id INTEGER, age INTEGER)")
+
+  ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS groups")
+  ActiveRecord::Base.connection.execute("CREATE TABLE groups (id INTEGER PRIMARY KEY, name TEXT)")
+
+  ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS projects")
+  ActiveRecord::Base.connection.execute("CREATE TABLE projects (id INTEGER PRIMARY KEY, name TEXT)")
+end
+
+module TestHelper
+
+  def setup
+    RenderSync.load_config(
+      File.expand_path("../fixtures/sync_faye.yml", __FILE__),
+      "test"
+    )
+    RenderSync.logger.level = ENV['LOGLEVEL'].present? ? ENV['LOGLEVEL'].to_i : 1
+  end
+end
+
+module TestHelperFaye
+
+  def setup
+    RenderSync.load_config(
+      File.expand_path("../fixtures/sync_faye.yml", __FILE__),
+      "test"
+    )
+    RenderSync.logger.level = ENV['LOGLEVEL'].present? ? ENV['LOGLEVEL'].to_i : 1
+  end
+end
+
+module TestHelperPusher
+
+  def setup
+    RenderSync.load_config(
+      File.expand_path("../fixtures/sync_pusher.yml", __FILE__),
+      "test"
+    )
+    RenderSync.logger.level = ENV['LOGLEVEL'].present? ? ENV['LOGLEVEL'].to_i : 1
+  end
+end

data/test/travis/sync.ru

@@ -0,0 +1,14 @@
+# Run with: rackup sync.ru -E production
+require "bundler/setup"
+require "yaml"
+require "faye"
+require "render_sync"
+
+Faye::WebSocket.load_adapter 'thin'
+
+RenderSync.load_config(
+  File.expand_path("../config/sync.yml", __FILE__),
+  ENV["RAILS_ENV"] || "development"
+)
+
+run RenderSync.pubsub_app

data/test/travis/sync.yml

@@ -0,0 +1,21 @@
+# Faye
+development:
+  server: "http://localhost:9292/faye"
+  adapter_javascript_url: "http://localhost:9292/faye/faye.js" 
+  auth_token: "secret"
+  adapter: "Faye"
+  async: true
+  
+test:
+  server: "http://localhost:9292/faye"
+  adapter_javascript_url: "http://localhost:9292/faye/faye.js" 
+  adapter: "Faye"
+  auth_token: "secret"
+  async: false
+
+production:
+  server: "http://localhost:9292/faye"
+  adapter_javascript_url: "http://localhost:9292/faye/faye.js" 
+  adapter: "Faye"
+  auth_token: "secret"
+  async: true

metadata

@@ -0,0 +1,317 @@
+--- !ruby/object:Gem::Specification
+name: render_sync
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Chris McCord
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faye
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pusher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: cache_digests
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RenderSync turns your Rails partials realtime with automatic updates
+  through Faye
+email: chris@chrismccord.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/sync.coffee
+- app/controllers/sync/refetches_controller.rb
+- app/helpers/render_sync/config_helper.rb
+- config/routes.rb
+- config/sync.yml
+- lib/generators/render_sync/install_generator.rb
+- lib/generators/render_sync/templates/sync.ru
+- lib/generators/render_sync/templates/sync.yml
+- lib/render_sync.rb
+- lib/render_sync/action.rb
+- lib/render_sync/actions.rb
+- lib/render_sync/channel.rb
+- lib/render_sync/clients/dummy.rb
+- lib/render_sync/clients/faye.rb
+- lib/render_sync/clients/pusher.rb
+- lib/render_sync/controller_helpers.rb
+- lib/render_sync/engine.rb
+- lib/render_sync/erb_tracker.rb
+- lib/render_sync/faye_extension.rb
+- lib/render_sync/model.rb
+- lib/render_sync/model_actions.rb
+- lib/render_sync/model_change_tracking.rb
+- lib/render_sync/model_syncing.rb
+- lib/render_sync/model_touching.rb
+- lib/render_sync/partial.rb
+- lib/render_sync/partial_creator.rb
+- lib/render_sync/reactor.rb
+- lib/render_sync/refetch_model.rb
+- lib/render_sync/refetch_partial.rb
+- lib/render_sync/refetch_partial_creator.rb
+- lib/render_sync/renderer.rb
+- lib/render_sync/resource.rb
+- lib/render_sync/scope.rb
+- lib/render_sync/scope_definition.rb
+- lib/render_sync/view_helpers.rb
+- test/dummy/README.rdoc
+- test/dummy/Rakefile
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/sync/users/_show.html.erb
+- test/dummy/app/views/sync/users/refetch/_show.html.erb
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/routes.rb
+- test/dummy/log/test.log
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/favicon.ico
+- test/em_minitest_spec.rb
+- test/fixtures/sync_auth_token_missing.yml
+- test/fixtures/sync_erb.yml
+- test/fixtures/sync_faye.yml
+- test/fixtures/sync_pusher.yml
+- test/models/group.rb
+- test/models/project.rb
+- test/models/todo.rb
+- test/models/user.rb
+- test/sync/abstract_controller.rb
+- test/sync/action_test.rb
+- test/sync/channel_test.rb
+- test/sync/config_test.rb
+- test/sync/erb_tracker_test.rb
+- test/sync/faye_extension_test.rb
+- test/sync/message_test.rb
+- test/sync/model_test.rb
+- test/sync/partial_creator_test.rb
+- test/sync/partial_test.rb
+- test/sync/protected_attributes_test.rb
+- test/sync/reactor_test.rb
+- test/sync/refetch_model_test.rb
+- test/sync/refetch_partial_creator_test.rb
+- test/sync/refetch_partial_test.rb
+- test/sync/renderer_test.rb
+- test/sync/resource_test.rb
+- test/sync/scope_definition_test.rb
+- test/sync/scope_test.rb
+- test/test_helper.rb
+- test/travis/sync.ru
+- test/travis/sync.yml
+homepage: http://github.com/chrismccord/render_sync
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.4
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: Realtime Rails Partials
+test_files: []