message_bus 2.1.6 → 2.2.0.pre

data/Rakefile

@@ -8,6 +8,17 @@ require 'jasmine'
 ENV['JASMINE_CONFIG_PATH'] ||= File.join(Dir.pwd, 'spec', 'assets', 'support', 'jasmine.yml')
 load 'jasmine/tasks/jasmine.rake'
 
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+desc "Generate documentation for Yard, and fail if there are any warnings"
+task :test_doc do
+  sh "yard --fail-on-warning #{'--no-progress' if ENV['CI']}"
+end
+
 Bundler.require(:default, :test)
 
 task default: :spec
@@ -34,7 +45,7 @@ run_spec = proc do |backend|
   end
 end
 
-task spec: [:spec_redis, :spec_postgres, :spec_memory, :spec_client_js]
+task spec: [:spec_memory, :spec_redis, :spec_postgres, :spec_client_js, :rubocop, :test_doc]
 
 task spec_client_js: 'jasmine:ci'
 

data/assets/message-bus.js

@@ -440,7 +440,7 @@
 
     // Subscribe to a channel
     // if lastId is 0 or larger, it will recieve messages AFTER that id
-    // if lastId is nagative it will perform lookbehind"
+    // if lastId is negative it will perform lookbehind
     // -1 will subscribe to all new messages
     // -2 will recieve last message + all new messages
     // -3 will recieve last 2 messages + all new messages

data/docker-compose.yml

@@ -0,0 +1,46 @@
+version: '3'
+volumes:
+  bundle_config:
+  bundle:
+  redis_data:
+  postgres_data:
+services:
+  tests:
+    build:
+      context: .
+    environment:
+      BUNDLE_TO: /usr/local/bundle
+      REDISURL: redis://redis:6379
+      PGHOST: postgres
+      PGUSER: postgres
+      PGPASSWORD: "1234"
+    volumes:
+      - .:/usr/src/app
+      - bundle_config:/home/src/app/.bundle
+      - bundle:/usr/local/bundle
+    depends_on:
+      - postgres
+      - redis
+  docs:
+    build:
+      context: .
+    command: yard server --bind 0.0.0.0 --reload
+    environment:
+      BUNDLE_TO: /usr/local/bundle
+    volumes:
+      - .:/usr/src/app
+      - bundle_config:/home/src/app/.bundle
+      - bundle:/usr/local/bundle
+    ports:
+      - 8808:8808
+  redis:
+    image: redis:5.0
+    volumes:
+      - redis_data:/data
+  postgres:
+    image: postgres:11.0
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    environment:
+      - POSTGRES_PASSWORD=1234
+      - POSTGRES_DB=message_bus_test

data/examples/bench/config.ru

@@ -4,17 +4,16 @@ require 'message_bus'
 require 'stackprof'
 
 if defined?(PhusionPassenger)
-    PhusionPassenger.on_event(:starting_worker_process) do |forked|
-        if forked
-            # We're in smart spawning mode.
-            MessageBus.after_fork
-        else
-            # We're in conservative spawning mode. We don't need to do anything.
-        end
+  PhusionPassenger.on_event(:starting_worker_process) do |forked|
+    if forked
+      # We're in smart spawning mode.
+      MessageBus.after_fork
+    else
+      # We're in conservative spawning mode. We don't need to do anything.
     end
+  end
 end
 
-
 # require 'rack-mini-profiler'
 
 # Rack::MiniProfiler.config.storage = Rack::MiniProfiler::MemoryStore
@@ -30,4 +29,4 @@ end
 MessageBus.long_polling_interval = 1000 * 2
 MessageBus.max_active_clients = 10000
 use MessageBus::Rack::Middleware
-run lambda { |env| [200, {"Content-Type" => "text/html"}, ["Howdy"]]  }
+run lambda { |_env| [200, { "Content-Type" => "text/html" }, ["Howdy"]] }

data/examples/bench/unicorn.conf.rb

@@ -1,4 +1,4 @@
 require 'message_bus'
-after_fork do |server, worker|
+after_fork do |_server, _worker|
   MessageBus.after_fork
 end

data/examples/chat/chat.rb

@@ -7,13 +7,12 @@ require 'json'
 
 $online = Hash.new
 
-
 MessageBus.subscribe "/presence" do |msg|
   if user = msg.data["enter"]
-     $online[user] = Time.now
+    $online[user] = Time.now
   end
   if user = msg.data["leave"]
-     $online.delete user
+    $online.delete user
   end
 end
 
@@ -22,7 +21,7 @@ MessageBus.user_id_lookup do |env|
   name = env["HTTP_X_NAME"]
   if name
     unless $online[name]
-      MessageBus.publish "/presence", {enter: name}
+      MessageBus.publish "/presence", enter: name
     end
     $online[name] = Time.now
   end
@@ -30,10 +29,10 @@ MessageBus.user_id_lookup do |env|
 end
 
 def expire_old_sessions
-  $online.each do |name,time|
-    if (Time.now - (5*60)) > time
-       puts "forcing leave for #{name} session timed out"
-       MessageBus.publish "/presence", {leave: name}
+  $online.each do |name, time|
+    if (Time.now - (5 * 60)) > time
+      puts "forcing leave for #{name} session timed out"
+      MessageBus.publish "/presence", leave: name
     end
   end
 rescue => e
@@ -48,8 +47,7 @@ Thread.new do
 end
 
 class Chat < Sinatra::Base
-
-  set :public_folder,  File.expand_path('../../../assets',__FILE__)
+  set :public_folder, File.expand_path('../../../assets', __FILE__)
 
   use MessageBus::Rack::Middleware
 
@@ -60,166 +58,165 @@ class Chat < Sinatra::Base
       name = "#{params["name"]}#{i}"
       i += 1
     end
-    MessageBus.publish '/presence', {enter: name}
-    {users: $online.keys, name: name}.to_json
+    MessageBus.publish '/presence', enter: name
+    { users: $online.keys, name: name }.to_json
   end
 
   post '/leave' do
-    #puts "Got leave for #{params["name"]}"
-    MessageBus.publish '/presence', {leave: params["name"]}
+    # puts "Got leave for #{params["name"]}"
+    MessageBus.publish '/presence', leave: params["name"]
   end
 
   post '/message' do
-    msg = {data: params["data"][0..500], name: params["name"][0..100]}
+    msg = { data: params["data"][0..500], name: params["name"][0..100] }
     MessageBus.publish '/message', msg
 
     "OK"
   end
 
   get '/' do
-
-<<HTML
-
-<html>
-  <head>
-    <script src="/jquery-1.8.2.js"></script>
-    <script src="/message-bus.js"></script>
-    <style>
-        #panel { position: fixed; bottom: 0; background-color: #FFFFFF; }
-        #panel form { margin-bottom: 4px; }
-        #panel button, #panel textarea { height: 40px }
-        #panel button { width: 100px; vertical-align: top; }
-        #messages { padding-bottom: 40px; }
-        .hidden { display: none; }
-        #users {
-         position: fixed; top: 0; right: 0; width: 160px; background-color: #fafafa; height: 100%;
-         border-left: 1px solid #dfdfdf;
-         padding: 5px;
-        }
-        #users ul li {  margin: 0; padding: 0; }
-        #users ul li.me { font-weight: bold; }
-        #users ul { list-style: none; margin 0; padding: 0; }
-        body { padding-right: 160px; }
-    </style>
-  </head>
-  <body>
-    <p>This is a trivial chat demo... It is implemented as a <a href="https://github.com/SamSaffron/message_bus/blob/master/examples/chat/chat.rb">Sinatra app</a>. The <a href="https://github.com/SamSaffron/message_bus">message_bus</a> can easily be added to any Rails/Rack app. <small>This app can be deployed with <a href="https://github.com/discourse/discourse_docker">Discourse Docker</a> using <a href="https://github.com/SamSaffron/message_bus/blob/master/examples/chat/docker_container/chat.yml">this template</a>.</small></p>
-    <div id='messages' class="hidden"></div>
-    <div id='users' class="hidden">
-      <h3>Online</h3>
-      <ul></ul>
-    </div>
-    <div id='panel' class="hidden">
-      <form>
-        <textarea cols=80 rows=2></textarea>
-        <button id="send">send</button>
-      </form>
-    </div>
-    <div id='your-name'>Enter your name: <input type='text'/>
-
-    <script>
-      $(function() {
-        var name;
-
-        MessageBus.headers["X-NAME"] = name;
-
-        var enter = function(name, opts) {
-           if (opts && opts.check) {
-             var found = false;
-             $('#users ul li').each(function(){
-                found = found || ($(this).text().trim() === name.trim());
-                if (found && opts.me) {
-                  $(this).remove();
-                  found = false;
+    <<~HTML
+
+      <html>
+        <head>
+          <script src="/jquery-1.8.2.js"></script>
+          <script src="/message-bus.js"></script>
+          <style>
+              #panel { position: fixed; bottom: 0; background-color: #FFFFFF; }
+              #panel form { margin-bottom: 4px; }
+              #panel button, #panel textarea { height: 40px }
+              #panel button { width: 100px; vertical-align: top; }
+              #messages { padding-bottom: 40px; }
+              .hidden { display: none; }
+              #users {
+               position: fixed; top: 0; right: 0; width: 160px; background-color: #fafafa; height: 100%;
+               border-left: 1px solid #dfdfdf;
+               padding: 5px;
+              }
+              #users ul li {  margin: 0; padding: 0; }
+              #users ul li.me { font-weight: bold; }
+              #users ul { list-style: none; margin 0; padding: 0; }
+              body { padding-right: 160px; }
+          </style>
+        </head>
+        <body>
+          <p>This is a trivial chat demo... It is implemented as a <a href="https://github.com/SamSaffron/message_bus/blob/master/examples/chat/chat.rb">Sinatra app</a>. The <a href="https://github.com/SamSaffron/message_bus">message_bus</a> can easily be added to any Rails/Rack app. <small>This app can be deployed with <a href="https://github.com/discourse/discourse_docker">Discourse Docker</a> using <a href="https://github.com/SamSaffron/message_bus/blob/master/examples/chat/docker_container/chat.yml">this template</a>.</small></p>
+          <div id='messages' class="hidden"></div>
+          <div id='users' class="hidden">
+            <h3>Online</h3>
+            <ul></ul>
+          </div>
+          <div id='panel' class="hidden">
+            <form>
+              <textarea cols=80 rows=2></textarea>
+              <button id="send">send</button>
+            </form>
+          </div>
+          <div id='your-name'>Enter your name: <input type='text'/>
+
+          <script>
+            $(function() {
+              var name;
+
+              MessageBus.headers["X-NAME"] = name;
+
+              var enter = function(name, opts) {
+                 if (opts && opts.check) {
+                   var found = false;
+                   $('#users ul li').each(function(){
+                      found = found || ($(this).text().trim() === name.trim());
+                      if (found && opts.me) {
+                        $(this).remove();
+                        found = false;
+                      }
+                      return !found;
+                   });
+                   if (found) { return; }
+                 }
+
+                 var li = $('<li></li>');
+                 li.text(name);
+                 if (opts && opts.me) {
+                   li.addClass("me");
+                   $('#users ul').prepend(li);
+                 } else {
+                   $('#users ul').append(li);
+                 }
+              };
+
+              $('#messages, #panel').addClass('hidden');
+
+              $('#your-name input').keyup(function(e){
+                if(e.keyCode == 13) {
+                  name = $(this).val();
+                  $.post("/enter", { name: name}, null, "json" ).success(function(data){
+                    $.each(data.users,function(idx, name){
+                      enter(name);
+                    });
+                    name = data.name;
+                    enter(name, {check: true, me: true});
+                  });
+                  $('#your-name').addClass('hidden');
+                  $('#messages, #panel, #users').removeClass('hidden');
+                  $(document.body).scrollTop(document.body.scrollHeight);
+
+                  window.onbeforeunload = function(){
+                    $.post("/leave", { name: name });
+                  };
+
+                  MessageBus.subscribe("/presence", function(msg){
+                    if (msg.enter) {
+                       enter(msg.enter, {check: true});
+                    }
+                    if (msg.leave) {
+                     $('#users ul li').each(function(){
+                        if ($(this).text() === msg.leave) {
+                          $(this).remove()
+                        }
+                     });
+                    }
+                  });
                 }
-                return !found;
-             });
-             if (found) { return; }
-           }
-
-           var li = $('<li></li>');
-           li.text(name);
-           if (opts && opts.me) {
-             li.addClass("me");
-             $('#users ul').prepend(li);
-           } else {
-             $('#users ul').append(li);
-           }
-        };
-
-        $('#messages, #panel').addClass('hidden');
-
-        $('#your-name input').keyup(function(e){
-          if(e.keyCode == 13) {
-            name = $(this).val();
-            $.post("/enter", { name: name}, null, "json" ).success(function(data){
-              $.each(data.users,function(idx, name){
-                enter(name);
               });
-              name = data.name;
-              enter(name, {check: true, me: true});
-            });
-            $('#your-name').addClass('hidden');
-            $('#messages, #panel, #users').removeClass('hidden');
-            $(document.body).scrollTop(document.body.scrollHeight);
 
-            window.onbeforeunload = function(){
-              $.post("/leave", { name: name });
-            };
+              var safe = function(html){
+                 return String(html).replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
+              };
+
+              MessageBus.subscribe("/message", function(msg){
+                $('#messages').append("<p>"+ safe(msg.name) + " said: " + safe(msg.data) + "</p>");
+                $(document.body).scrollTop(document.body.scrollHeight);
+              }, 0); // last id is zero, so getting backlog
+
+              var submit = function(){
+                var val = $('form textarea').val().trim();
+                if (val.length === 0) {
+                  return;
+                }
+
+                if (val.length > 500) {
+                  alert("message too long");
+                  return false;
+                } else {
+                  $.post("/message", { data: val, name: name} );
+                }
+                $('textarea').val("");
+              };
+
+              $('#send').click(function(){submit(); return false;});
+
+              $('textarea').keyup(function(e){
+                if(e.keyCode == 13) {
+                  submit();
+                }
+              });
 
-            MessageBus.subscribe("/presence", function(msg){
-              if (msg.enter) {
-                 enter(msg.enter, {check: true});
-              }
-              if (msg.leave) {
-               $('#users ul li').each(function(){
-                  if ($(this).text() === msg.leave) {
-                    $(this).remove()
-                  }
-               });
-              }
             });
-          }
-        });
-
-        var safe = function(html){
-           return String(html).replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
-        };
-
-        MessageBus.subscribe("/message", function(msg){
-          $('#messages').append("<p>"+ safe(msg.name) + " said: " + safe(msg.data) + "</p>");
-          $(document.body).scrollTop(document.body.scrollHeight);
-        }, 0); // last id is zero, so getting backlog
-
-        var submit = function(){
-          var val = $('form textarea').val().trim();
-          if (val.length === 0) {
-            return;
-          }
-
-          if (val.length > 500) {
-            alert("message too long");
-            return false;
-          } else {
-            $.post("/message", { data: val, name: name} );
-          }
-          $('textarea').val("");
-        };
-
-        $('#send').click(function(){submit(); return false;});
-
-        $('textarea').keyup(function(e){
-          if(e.keyCode == 13) {
-            submit();
-          }
-        });
-
-      });
-    </script>
-  </body>
-</html>
-
-HTML
+          </script>
+        </body>
+      </html>
+
+    HTML
   end
 
   run! if app_file == $0