hyper-mesh 0.5.0 → 0.5.1

data/docs/simple_poller_quickstart.md

@@ -1,82 +1,48 @@
 ### Simple Poller Quickstart
 
-The easiest way to get started is to use the built-in simple polling transport.
+The easiest push transport is the built-in simple poller.  This is great for demos or trying out HyperMesh but because it is constantly polling it is not suitable for production systems or any kind of real debug or test activities.
 
-#### 1 Get yourself a rails app
+#### 1 Add the HyperLoop gems to your Rails app
 
-Either take an existing rails app, or create a new one the usual way.
+If you have not already installed the `hyper-react` and `hyper-mesh` gems, then do so now using the [hyper-rails](https://github.com/ruby-hyperloop/hyper-rails) gem.
 
-#### 2 Add ReactRb
-
-If you have not already installed the `hyper-react` and `reactive-record` gems, then do so now using the [reactrb-rails-generator](https://github.com/hyper-react/reactrb-rails-generator) gem.
-
-- add `gem 'reactrb-rails-generator'` to your gem file (in the development section)
+- add `gem 'hyper-rails'` to your gem file (in the development section)
 - run `bundle install`
-- run `bundle exec rails g hyper-react:install --all` (make sure to use the --all option)
+- run `rails g hyperloop:install --all` (make sure to use the --all option)
 - run `bundle update`
 
-#### 3 Add the synchromesh gem
-
-- add `gem 'synchromesh', git: 'https://github.com/hyper-react/synchromesh', branch: 'authorization-policies'`
-- then `bundle install`  
-- and in `app/views/components.rb` add `require 'hyper-mesh'`  
- immediately below`require 'reactive-record'`
+#### 2 Set the transport
 
-#### 4 Set the transport
-
-Once you have hyper-react installed then add this initializer:
+Once you have HyperMesh installed then add this initializer:
 ```ruby
 #config/initializers/synchromesh.rb
 HyperMesh.configuration do |config|
   config.transport = :simple_poller
   # options
-  config.opts = {
-    seconds_between_poll: 5, # default is 0.5 you may need to increase if testing with Selenium
-    seconds_polled_data_will_be_retained: 1.hour  # clears channel data after this time, default is 5 minutes
-  }
+  # config.opts = {
+  #   seconds_between_poll: 5, # default is 0.5 you may need to increase if testing with Selenium
+  #   seconds_polled_data_will_be_retained: 1.hour  # clears channel data after this time, default is 5 minutes
+  # }
 end
 ```
 
-#### 5 Make sure caching is enabled
-
-HyperMesh uses the rails cache to keep track of what connections are alive in a transport independent fashion.  Rails 5 by default will have caching off in development mode.
-
-Check in `config/development.rb` and make sure that `cache_store` is never being set to `:null_store`.  
-
-If you would like to be able to interact via
-the `rails console` you should set the store to be something like this:
-
-```ruby
-# config/development.rb
-Rails.application.configure do
-  config.cache_store = :file_store, './rails_cache_dir'
-end
-```
+#### 3 Try It Out  
 
-#### 6 Define Your Policies
-
-To start just open everything up by adding a policies directory and defining a policy file like this:
-
-```ruby
-# app/policies/application_policy.rb
-class ApplicationPolicy
-  always_allow_connection
-  regulate_all_broadcasts { |policy| policy.send_all }
-  allow_change(to: :all, on: [:create, :update, :destroy]) { true }
-end
-```
-
-#### 8 Try It Out  
-
-If you don't already have a model to play with,  add one now:
+If you don't already have a model to play with add one now:
 
 `bundle exec rails generate model Word text:string`
 
 `bundle exec rake db:migrate`
 
+Move `app/models/word.rb` to `app/models/public/word.rb`
+
+**Leave** `app/models/model.rb` where it is.  This is your models client side manifest file.
+
 Whatever model(s) you will plan to access on the client need to moved to the `app/models/public` directory.  This allows reactive-record to build a client side proxy for the models.  Models not moved will be completely invisible on the client side.
 
-If you don't already have a simple component to play with,  here is a simple one (make sure you add the Word model):
+**Important** in rails 5 there is also a base `ApplicationRecord` class, that all other models are built from.  This class must be moved to the public directory as well.
+
+If you don't already have a component to play with,  here is a simple one (make sure you added the Word model):
 
 ```ruby
 # app/views/components/app.rb
@@ -123,4 +89,4 @@ Fire up rails with `bundle exec rails s` and open your app in a couple of browse
 
 You can also fire up a rails console, and then for example do a `Word.new(text: "Hello").save` and again see any browsers updating.
 
-If you want to go into more details with example check out [words-example](/docs/words-example.md)
+If you want to go into more details with the example check out [words-example](/docs/words-example.md)

data/docs/todo-example.md

@@ -1,3 +1,5 @@
+# ![](/work-in-progress-drinking.png) WARNING DOCS AND EXAMPLES ARE BEING REWRITTEN  MANY LINKS MAY BE BROKEN  STAY TUNED OR CHECK IN AT [![Join the chat at https://gitter.im/reactrb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/reactrb/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) FOR MORE INFO 
+
 Lets look at part of a very simple Todo application with one model:
 
 ```ruby

data/docs/words-example.md

@@ -1,3 +1,6 @@
+# ![](/work-in-progress-drinking.png) WARNING DOCS AND EXAMPLES ARE BEING REWRITTEN  MANY LINKS MAY BE BROKEN  STAY TUNED OR CHECK IN AT [![Join the chat at https://gitter.im/reactrb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/reactrb/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) FOR MORE INFO 
+
+
 ## Random Words example
 
 This is the example app used by the quick start guides, and if you want to dive deeper this is the place to be.

data/examples/action-cable/Gemfile

@@ -33,7 +33,6 @@ gem 'jbuilder', '~> 2.5'
 group :development, :test do
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem 'byebug', platform: :mri
-  gem 'reactrb-rails-generator'
 end
 
 group :development do
@@ -41,18 +40,18 @@ group :development do
   gem 'web-console'
   gem 'listen', '~> 3.0.5'
   # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
-  gem 'spring'
-  gem 'spring-watcher-listen', '~> 2.0.0'
+  #gem 'spring'
+  #gem 'spring-watcher-listen', '~> 2.0.0'
+  gem 'hyper-rails'
 end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
 
+gem 'opal-rails'
+gem 'opal-browser'
 gem 'hyper-react'
-gem 'react-rails', '>= 1.3.0'
-gem 'opal-rails', '>= 0.8.1'
 gem 'therubyracer', platforms: :ruby
 gem 'react-router-rails', '~> 0.13.3'
-gem 'reactrb-router'
-gem 'reactive-record', '>= 0.8.0'
-gem 'synchromesh', path: '../..'
+gem 'hyper-router'
+gem 'hyper-mesh'

data/examples/action-cable/Gemfile.lock

@@ -1,10 +1,3 @@
-PATH
-  remote: ../..
-  specs:
-    synchromesh (0.4.0)
-      activerecord (>= 0.3.0)
-      reactive-record (>= 0.7.43)
-
 GEM
   remote: https://rubygems.org/
   specs:
@@ -45,13 +38,13 @@ GEM
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (7.1.2)
+    arel (7.1.4)
     babel-source (5.8.35)
     babel-transpiler (0.7.0)
       babel-source (>= 4.0, < 6)
       execjs (~> 2.0)
     builder (3.2.2)
-    byebug (9.0.5)
+    byebug (9.0.6)
     coffee-rails (4.2.1)
       coffee-script (>= 2.2.0)
       railties (>= 4.0.0, < 5.2.x)
@@ -60,7 +53,7 @@ GEM
       execjs
     coffee-script-source (1.10.0)
     concurrent-ruby (1.0.2)
-    connection_pool (2.2.0)
+    connection_pool (2.2.1)
     debug_inspector (0.0.2)
     erubis (2.7.0)
     execjs (2.7.0)
@@ -68,6 +61,18 @@ GEM
     globalid (0.3.7)
       activesupport (>= 4.1.0)
     hike (1.2.3)
+    hyper-mesh (0.5.0)
+      activerecord (>= 0.3.0)
+      hyper-react (>= 0.10.0)
+    hyper-rails (0.4.0)
+      rails (>= 4.0.0)
+    hyper-react (0.10.0)
+      opal (>= 0.8.0)
+      opal-activesupport (>= 0.2.0)
+      react-rails
+    hyper-router (2.4.0)
+      hyper-react
+      opal-browser
     i18n (0.7.0)
     jbuilder (2.6.0)
       activesupport (>= 3.0.0, < 5.1)
@@ -89,13 +94,12 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
     mini_portile2 (2.1.0)
-    minitest (5.9.0)
+    minitest (5.9.1)
     multi_json (1.12.1)
     nio4r (1.2.1)
-    nokogiri (1.6.8)
+    nokogiri (1.6.8.1)
       mini_portile2 (~> 2.1.0)
-      pkg-config (~> 1.1.7)
-    opal (0.10.2)
+    opal (0.10.3)
       hike (~> 1.2)
       sourcemap (~> 0.1.0)
       sprockets (~> 3.1)
@@ -115,7 +119,6 @@ GEM
       rails (>= 4.0, < 6.0)
       sprockets-rails (< 3.0)
     paggio (0.2.6)
-    pkg-config (1.1.7)
     puma (3.6.0)
     rack (2.0.1)
     rack-test (0.6.3)
@@ -144,7 +147,7 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (11.3.0)
-    rb-fsevent (0.9.7)
+    rb-fsevent (0.9.8)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
     react-rails (1.4.2)
@@ -157,20 +160,6 @@ GEM
     react-router-rails (0.13.3.2)
       rails (>= 3.1)
       react-rails (~> 1.4.0)
-    reactive-record (0.8.3)
-      opal-browser
-      opal-rails
-      rails (>= 3.2.13)
-      react-rails
-      hyper-react
-    hyper-react (0.8.8)
-      opal (>= 0.8.0)
-      opal-activesupport (>= 0.2.0)
-      opal-browser (= 0.2.0)
-    reactrb-rails-generator (0.2.0)
-      rails (>= 4.0.0)
-    reactrb-router (0.8.2)
-      hyper-react
     ref (2.0.0)
     sass (3.4.22)
     sass-rails (5.0.6)
@@ -180,10 +169,6 @@ GEM
       sprockets-rails (>= 2.0, < 4.0)
       tilt (>= 1.1, < 3)
     sourcemap (0.1.1)
-    spring (1.7.2)
-    spring-watcher-listen (2.0.0)
-      listen (>= 2.7, < 4.0)
-      spring (~> 1.2)
     sprockets (3.7.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -191,7 +176,7 @@ GEM
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       sprockets (>= 2.8, < 4.0)
-    sqlite3 (1.3.11)
+    sqlite3 (1.3.12)
     therubyracer (0.12.2)
       libv8 (~> 3.16.14.0)
       ref
@@ -203,9 +188,9 @@ GEM
     turbolinks-source (5.0.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    uglifier (3.0.2)
+    uglifier (3.0.3)
       execjs (>= 0.3.0, < 3)
-    web-console (3.3.1)
+    web-console (3.4.0)
       actionview (>= 5.0)
       activemodel (>= 5.0)
       debug_inspector
@@ -220,23 +205,20 @@ PLATFORMS
 DEPENDENCIES
   byebug
   coffee-rails (~> 4.2)
+  hyper-mesh
+  hyper-rails
+  hyper-react
+  hyper-router
   jbuilder (~> 2.5)
   jquery-rails
   listen (~> 3.0.5)
-  opal-rails (>= 0.8.1)
+  opal-browser
+  opal-rails
   puma (~> 3.0)
   rails (~> 5.0.0, >= 5.0.0.1)
-  react-rails (>= 1.3.0)
   react-router-rails (~> 0.13.3)
-  reactive-record (>= 0.8.0)
-  hyper-react
-  reactrb-rails-generator
-  reactrb-router
   sass-rails (~> 5.0)
-  spring
-  spring-watcher-listen (~> 2.0.0)
   sqlite3
-  synchromesh!
   therubyracer
   turbolinks (~> 5)
   tzinfo-data

data/examples/action-cable/app/assets/javascripts/application.js

@@ -1,3 +1,6 @@
+// added by hyper-rails:  These lines must preceed other requires especially turbo_links
+//= require 'components'
+//= require 'react_ujs'
 // This is a manifest file that'll be compiled into application.js, which will include all the files
 // listed below.
 //
@@ -9,10 +12,9 @@
 //
 // Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
-//= require 'components'
-//= require 'react_ujs'
 //
 //= require jquery
 //= require jquery_ujs
-//= require action_cable
+//= require turbolinks
+//= require_tree .
 Opal.load('components');

data/examples/action-cable/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/examples/action-cable/app/controllers/test_controller.rb

@@ -1,4 +1,3 @@
-#app/controllers/test_controller.rb
 class TestController < ApplicationController
   def app
     render_component

data/examples/action-cable/app/policies/application_policy.rb

@@ -1,6 +1,14 @@
 # app/policies/application_policy
+
+# Policies regulate access to your public models
+# The following policy will open up full access (but only in development)
+# The policy system is very flexible and powerful.  See the documentation
+# for complete details.
 class ApplicationPolicy
+  # Allow any session to connect:
   always_allow_connection
+  # Send all attributes from all public models
   regulate_all_broadcasts { |policy| policy.send_all }
+  # Allow all changes to public models
   allow_change(to: :all, on: [:create, :update, :destroy]) { true }
-end
+end if Rails.env.development?

data/examples/action-cable/app/views/components.rb

@@ -1,6 +1,6 @@
 # app/views/components.rb
 require 'opal'
-require 'react'
+require 'react/react-source'
 require 'hyper-react'
 if React::IsomorphicHelpers.on_opal_client?
   require 'opal-jquery'
@@ -9,9 +9,8 @@ if React::IsomorphicHelpers.on_opal_client?
   require 'browser/delay'
   # add any additional requires that can ONLY run on client here
 end
-require 'reactrb-router'
+require 'hyper-router'
 require 'react_router'
-require 'reactive-record'
 require 'hyper-mesh'
 require 'models'
 require_tree './components'

data/examples/action-cable/bin/spring

@@ -7,9 +7,10 @@ unless defined?(Spring)
   require 'rubygems'
   require 'bundler'
 
-  if (match = Bundler.default_lockfile.read.match(/^GEM$.*?^    (?:  )*spring \((.*?)\)$.*?^$/m))
-    Gem.paths = { 'GEM_PATH' => [Bundler.bundle_path.to_s, *Gem.path].uniq.join(Gem.path_separator) }
-    gem 'spring', match[1]
+  lockfile = Bundler::LockfileParser.new(Bundler.default_lockfile.read)
+  if spring = lockfile.specs.detect { |spec| spec.name == "spring" }
+    Gem.use_paths Gem.dir, Bundler.bundle_path.to_s, *Gem.path
+    gem 'spring', spring.version
     require 'spring/binstub'
   end
 end

data/examples/action-cable/config/application.rb

@@ -1,16 +1,6 @@
 require_relative 'boot'
 
-require "rails"
-# Pick the frameworks you want:
-require "active_model/railtie"
-require "active_job/railtie"
-require "active_record/railtie"
-require "action_controller/railtie"
-require "action_mailer/railtie"
-require "action_view/railtie"
-require "action_cable/engine"
-require "sprockets/railtie"
-# require "rails/test_unit/railtie"
+require 'rails/all'
 
 # Require the gems listed in Gemfile, including any gems
 # you've limited to :test, :development, or :production.

data/examples/action-cable/config/environments/development.rb

@@ -15,7 +15,18 @@ Rails.application.configure do
   config.consider_all_requests_local = true
 
   # Enable/disable caching. By default caching is disabled.
-  config.cache_store = :file_store, './rails_cache_dir'
+  if Rails.root.join('tmp/caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => 'public, max-age=172800'
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
 
   # Don't care if the mailer can't send.
   config.action_mailer.raise_delivery_errors = false