plezi 0.14.4 → 0.14.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42876c61ff855afd7f6385ec7e6d28c3eb5f245c
-  data.tar.gz: 433b879ffe3e66d914926c08146218478e8a25bb
+  metadata.gz: 7f914fd397c3ff4c119da17c2a97ad294813e7a1
+  data.tar.gz: c8cce257a36d1ee92512ef4a38cd1432f847a4fa
 SHA512:
-  metadata.gz: 7ae7db10a005e2751b253f404c5d1e45bc6971c869a33047ab95a7980e45a9ad721f45c3c0ee168cb698e029d05448d1e8d3aed3c40a2f9bc5e8ba1ab77f0903
-  data.tar.gz: 9e9e96ed337490cb82a8ffb1416fc88ef5e210a65c43b49335d3d9898e50291564b6b99342214f5f0c1e18a1ea1329ec58c4b2b1aa78d94116aea926b61fab9d
+  metadata.gz: 7bdfdb162d587f8ab5f79267180d2395ca46491de8cb10d95f3db8749b4b00b2f5106229854b53cd6c3b06edf91f6f8432eb38ed212d547d7f9c3c2f208b8184
+  data.tar.gz: 3bb3173130fa9c20e26aecb4fbae2417ba3cfd1627b35974f0b216f3fb54997bf4d418f148eea9307f07e09e8971b33b38130cf7da53d18031e03ee093386b4a

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ***
 
+Change log v.0.14.5
+
+**Fix**: Fixed Plezi client issues related to the code beautifier moving things around.
+
+**Fix**: Fixed a possible issue with unicasting (sending a message to a specific connection).
+
+**Styling**: styling updated and some indentation fixed with the help of Rubocop.
+
+**Misc**: minor refactoring of our message dispatch logic and other minor prevents temporary empty arrays from being created when possible.
+
+***
+
 Change log v.0.14.4
 
 **Fix**: fixed an issue were scaling using `fork` or server workers would break the automatic scaling feature. The issue was caused by the pub/Sub channel ID of the new processes being identical to the origin process. Credit to Vladimir Dementyev (@palkan) for exposing this issue. This did not seem to effect applications that scaled up with independent processes / machines, such as applications that scaled up using "dynos" on Heroku.

data/bin/ws_shootout

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+# # Uncomment and set Redis URL for automatic scalling across proccesses and machines:
+# require 'redis'
+# ENV['PL_REDIS_URL'] ||= "redis://localhost:7777/0"
+# ENV['PL_REDIS_URL'] ||= "redis://:password@my.host:6389/0"
+
+Dir.chdir(File.expand_path(File.join('..', '..', 'lib'), __FILE__))
+require 'bundler/setup'
+require 'plezi'
+class ShootoutApp
+  # the default HTTP response
+  def index
+    "This application should be used with the websocket-shootout benchmark utility."
+  end
+  # we won't be using AutoDispatch, but directly using the `on_message` callback.
+  def on_message data
+    cmd, payload = JSON(data).values_at('type', 'payload')
+    if cmd == 'echo'
+      write({type: 'echo', payload: payload}.to_json)
+    else
+      ShootoutApp.write2everyone({type: 'broadcast', payload: payload}.to_json)
+      write({type: "broadcastResult", payload: payload}.to_json)
+    end
+  rescue
+    puts "Incoming message format error - not JSON?"
+  end
+end
+
+Plezi.route '*', ShootoutApp

data/exe/plezi

@@ -6,106 +6,106 @@ require 'securerandom'
 ######################################################################
 # tweek the string class for termial coloring options
 class String
-  # colorization
-  def colorize(color_code)
-    "\e[#{color_code}m#{self}\e[0m"
-  end
+   # colorization
+   def colorize(color_code)
+      "\e[#{color_code}m#{self}\e[0m"
+   end
 
-  def red
-    colorize(31)
-  end
+   def red
+      colorize(31)
+   end
 
-  def green
-    colorize(32)
-  end
+   def green
+      colorize(32)
+   end
 
-  def yellow
-    colorize(33)
-  end
+   def yellow
+      colorize(33)
+   end
 
-  def pink
-    colorize(35)
-  end
+   def pink
+      colorize(35)
+   end
 end
 
 module Builder
-  Root ||= Pathname.new(File.dirname(__FILE__)).expand_path.join('..')
+   Root ||= Pathname.new(File.dirname(__FILE__)).expand_path.join('..')
 
-  def self.app_tree
-    @app_tree ||= {}.dup
-  end
+   def self.app_tree
+      @app_tree ||= {}.dup
+   end
 
-  def self.write_files(files, parent = '.')
-    if files.is_a? Hash
-      files.each do |k, v|
-        if v.is_a? Hash
-          begin
-            Dir.mkdir k
-            puts "    created #{parent}/#{k}".green
-          rescue => e
-            puts "    exists #{parent}/#{k}".red
-          end
-          Dir.chdir k
-          write_files v, (parent + '/' + k)
-          Dir.chdir '..'
-        elsif v.is_a? String
-          if ::File.exist? k
-            puts "    EXISTS(!) #{parent}/#{k}".red
-          else
-            IO.write k, v
-            puts "    wrote #{parent}/#{k}".yellow
-          end
-        end
+   def self.write_files(files, parent = '.')
+      if files.is_a? Hash
+         files.each do |k, v|
+            if v.is_a? Hash
+               begin
+                  Dir.mkdir k
+                  puts "    created #{parent}/#{k}".green
+               rescue => e
+                  puts "    exists #{parent}/#{k}".red
+               end
+               Dir.chdir k
+               write_files v, (parent + '/' + k)
+               Dir.chdir '..'
+            elsif v.is_a? String
+               if ::File.exist? k
+                  puts "    EXISTS(!) #{parent}/#{k}".red
+               else
+                  IO.write k, v
+                  puts "    wrote #{parent}/#{k}".yellow
+               end
+            end
+         end
       end
-    end
-  end
+   end
 
-  def self.create_app(app_name = ARGV[1])
-    require Root.join('lib', 'plezi', 'version')
-    app_tree[app_name.to_s] ||= IO.read(Root.join('resources', 'mini_exec')).gsub('appname', app_name)
-    app_tree["#{app_name}.rb"] ||= IO.read(Root.join('resources', 'mini_app.rb')).gsub('appname', app_name).gsub('appsecret', "#{app_name}_#{SecureRandom.hex}")
-    app_tree['routes.rb'] ||= IO.read(Root.join('resources', 'routes.rb')).gsub('appname', app_name)
-    app_tree['config.ru'] ||= IO.read(Root.join('resources', 'config.ru')).gsub('appname', app_name)
-    app_tree['Procfile'] ||=  IO.read(Root.join('resources', 'procfile')).gsub('appname', app_name)
-    app_tree['Gemfile'] ||= ''
-    app_tree['Gemfile'] << "source 'https://rubygems.org'\n\n# include the basic plezi framework and server\ngem 'plezi', '~> #{Plezi::VERSION}'\n"
-    app_tree['Gemfile'] << IO.read(Root.join('resources', 'gemfile'))
-    app_tree['Gemfile'] << "\n\nruby '#{RUBY_VERSION}'\n"
-    app_tree['rakefile'] ||= IO.read(Root.join('resources', 'rakefile'))
-    app_tree['app'] ||= {}
-    app_tree['app']['my_controler.rb'] ||= IO.read(Root.join('resources', 'ctrlr.rb')).gsub('appname', app_name)
-    app_tree['views'] ||= {}
-    app_tree['views']['welcome.html.erb'] ||= IO.read(Root.join('resources', 'mini_welcome_page.html')).gsub('appname', app_name)
-    app_tree['views']['404.html.erb'] ||= IO.read(Root.join('resources', '404.erb'))
-    app_tree['views']['500.html.erb'] ||= IO.read(Root.join('resources', '500.erb'))
-    app_tree['views']['503.html'] ||= IO.read(Root.join('resources', '503.html'))
-    app_tree['public'] ||= {}
-    app_tree['public']['javascripts'] ||= {}
-    app_tree['public']['javascripts']['client.js'] ||= IO.read(Root.join('resources', 'client.js')).gsub('appname', app_name)
-    app_tree['public']['javascripts']['simple-client.js'] ||= IO.read(Root.join('resources', 'simple-client.js')).gsub('appname', app_name)
+   def self.create_app(app_name = ARGV[1])
+      require Root.join('lib', 'plezi', 'version')
+      app_tree[app_name.to_s] ||= IO.read(Root.join('resources', 'mini_exec')).gsub('appname', app_name)
+      app_tree["#{app_name}.rb"] ||= IO.read(Root.join('resources', 'mini_app.rb')).gsub('appname', app_name).gsub('appsecret', "#{app_name}_#{SecureRandom.hex}")
+      app_tree['routes.rb'] ||= IO.read(Root.join('resources', 'routes.rb')).gsub('appname', app_name)
+      app_tree['config.ru'] ||= IO.read(Root.join('resources', 'config.ru')).gsub('appname', app_name)
+      app_tree['Procfile'] ||=  IO.read(Root.join('resources', 'procfile')).gsub('appname', app_name)
+      app_tree['Gemfile'] ||= ''
+      app_tree['Gemfile'] << "source 'https://rubygems.org'\n\n# include the basic plezi framework and server\ngem 'plezi', '~> #{Plezi::VERSION}'\n"
+      app_tree['Gemfile'] << IO.read(Root.join('resources', 'gemfile'))
+      app_tree['Gemfile'] << "\n\nruby '#{RUBY_VERSION}'\n"
+      app_tree['rakefile'] ||= IO.read(Root.join('resources', 'rakefile'))
+      app_tree['app'] ||= {}
+      app_tree['app']['my_controler.rb'] ||= IO.read(Root.join('resources', 'ctrlr.rb')).gsub('appname', app_name)
+      app_tree['views'] ||= {}
+      app_tree['views']['welcome.html.erb'] ||= IO.read(Root.join('resources', 'mini_welcome_page.html')).gsub('appname', app_name)
+      app_tree['views']['404.html.erb'] ||= IO.read(Root.join('resources', '404.erb'))
+      app_tree['views']['500.html.erb'] ||= IO.read(Root.join('resources', '500.erb'))
+      app_tree['views']['503.html'] ||= IO.read(Root.join('resources', '503.html'))
+      app_tree['public'] ||= {}
+      app_tree['public']['javascripts'] ||= {}
+      app_tree['public']['javascripts']['client.js'] ||= IO.read(Root.join('resources', 'client.js')).gsub('appname', app_name)
+      app_tree['public']['javascripts']['simple-client.js'] ||= IO.read(Root.join('resources', 'simple-client.js')).gsub('appname', app_name)
 
-    begin
-      Dir.mkdir app_name
-      puts "created the #{app_name} application directory.".green
-    rescue => e
-      puts "the #{app_name} application directory exists - trying to rebuild (no overwrite).".pink
-    end
-    Dir.chdir app_name
-    puts 'starting to write template data...'.red
-    puts ''
-    Builder.write_files app_tree
-    begin
-      File.chmod 0o775, app_name.to_s
-    rescue
-      true
-    end
-    puts 'done.'
-    puts ''
-    puts "please change directory into the app directory: cd #{app_name}"
-    puts ''
-    puts "run the #{app_name} app using: ./#{app_name} or using the iodine / rackup commands."
-    puts ''
-  end
+      begin
+         Dir.mkdir app_name
+         puts "created the #{app_name} application directory.".green
+      rescue => e
+         puts "the #{app_name} application directory exists - trying to rebuild (no overwrite).".pink
+      end
+      Dir.chdir app_name
+      puts 'starting to write template data...'.red
+      puts ''
+      Builder.write_files app_tree
+      begin
+         File.chmod 0o775, app_name.to_s
+      rescue
+         true
+      end
+      puts 'done.'
+      puts ''
+      puts "please change directory into the app directory: cd #{app_name}"
+      puts ''
+      puts "run the #{app_name} app using: ./#{app_name} or using the iodine / rackup commands."
+      puts ''
+   end
 end
 
 ######################################################################
@@ -121,25 +121,25 @@ end
 # require 'optparser'
 
 if ARGV[0] == 'new' || ARGV[0] == 'n' || ARGV[0] == 'force'
-  #########
-  ## set up building environment
-  ARGV[1] = ARGV[1].gsub(/[^a-zA-Z0-9]/, '_')
-  ARGV[1].downcase!
-  if Dir.exist?(ARGV[1]) && ARGV[0] != 'force'
-    puts ''
-    puts "WARNING: app/folder alread exists, use `plezi fource #{ARGV[1]}` to attempt rebuild (no files will be overwritten).".red
-    puts ''
-    exit
-  end
-  Builder.create_app
+   #########
+   ## set up building environment
+   ARGV[1] = ARGV[1].gsub(/[^a-zA-Z0-9]/, '_')
+   ARGV[1].downcase!
+   if Dir.exist?(ARGV[1]) && ARGV[0] != 'force'
+      puts ''
+      puts "WARNING: app/folder alread exists, use `plezi fource #{ARGV[1]}` to attempt rebuild (no files will be overwritten).".red
+      puts ''
+      exit
+   end
+   Builder.create_app
 else
-  puts ''
-  puts 'Plezi fast web app starter.'.pink
-  puts 'use: plezi new appname'
-  puts 'or: plezi n appname'
-  puts ''
-  puts "Run the app using the app's script with an optional: -p {port number}. i.e."
-  puts '    cd ./appname'.pink
-  puts '    ./appname -p 8080'.pink
-  puts ''
+   puts ''
+   puts 'Plezi fast web app starter.'.pink
+   puts 'use: plezi new appname'
+   puts 'or: plezi n appname'
+   puts ''
+   puts "Run the app using the app's script with an optional: -p {port number}. i.e."
+   puts '    cd ./appname'.pink
+   puts '    ./appname -p 8080'.pink
+   puts ''
 end

data/lib/plezi.rb

@@ -1,34 +1,26 @@
-require 'plezi/version'
+# standard library used by Plezi
+require 'json'
+require 'erb'
+require 'thread'
+require 'fileutils'
+require 'set'
+require 'securerandom'
+require 'yaml'
+
+require 'rack'
+require 'rack/query_parser.rb'
 require 'iodine'
 
+require 'plezi/version'
 require 'plezi/api'
 require 'plezi/controller/controller'
 
 # Plezi is amazing. Read the {README}
 module Plezi
-  # Shhh... the modules and classes defined under the {Base} namespace are sleeping...
-  #
-  # The namespace signifies that Plezi uses these modules and classes internally.
-  # We don't need to worry about these unless we're monkey-patching stuff or contributing to the Plezi project.
-  module Base
-  end
+   # Shhh... the modules and classes defined under the {Base} namespace are sleeping...
+   #
+   # The namespace signifies that Plezi uses these modules and classes internally.
+   # We don't need to worry about these unless we're monkey-patching stuff or contributing to the Plezi project.
+   module Base
+   end
 end
-
-###############
-## Dev notes.
-###############
-#
-# Plezi 0.13.0 is heaviliy Rack based. Whenever Possible, Rack middleware was preffered.
-# The is a list of available Rack middleware:
-# * https://github.com/rack/rack/wiki/List-of-Middleware
-#
-#
-#
-#
-#
-# def uuid
-#   @uuid ||= SecureRandom.uuid
-# end
-# def redis_channel_name
-# 		@redis_channel_name ||= "#{File.basename($0, '.*')}_redis_channel"
-# end

data/lib/plezi/activation.rb

@@ -1,28 +1,28 @@
 require 'plezi/websockets/message_dispatch' unless defined?(::Plezi::Base::MessageDispatch)
 
 module Plezi
-  protected
+   protected
 
   @plezi_finalize = nil
   def plezi_finalize
-    if @plezi_finalize.nil?
-      @plezi_finalize = true
-      @plezi_finalize = 1
-    end
+     if @plezi_finalize.nil?
+        @plezi_finalize = true
+        @plezi_finalize = 1
+     end
   end
   @plezi_initialize = nil
   def self.plezi_initialize
-    if @plezi_initialize.nil?
-      @plezi_initialize = true
-      @plezi_autostart = true if @plezi_autostart.nil?
-      puts "WARNNING: auto-scaling with redis is set using ENV['PL_REDIS_URL'.freeze]\r\n           but the Redis gem isn't included! - SCALING IS IGNORED!" if ENV['PL_REDIS_URL'.freeze] && !defined?(::Redis)
-      at_exit do
-        next if @plezi_autostart == false
-        ::Iodine::Rack.app = ::Plezi.app
-        ::Iodine.start
-      end
-    end
-    true
+     if @plezi_initialize.nil?
+        @plezi_initialize = true
+        @plezi_autostart = true if @plezi_autostart.nil?
+        puts "WARNNING: auto-scaling with redis is set using ENV['PL_REDIS_URL'.freeze]\r\n           but the Redis gem isn't included! - SCALING IS IGNORED!" if ENV['PL_REDIS_URL'.freeze] && !defined?(::Redis)
+        at_exit do
+           next if @plezi_autostart == false
+           ::Iodine::Rack.app = ::Plezi.app
+           ::Iodine.start
+        end
+     end
+     true
   end
 end
 

data/lib/plezi/api.rb

@@ -3,60 +3,61 @@ require 'plezi/helpers'
 require 'plezi/router/router'
 
 module Plezi
-  class << self
-    # Get / set the template folder for the {Controller#render} function.
-    attr_accessor :templates
-    # Get / set the assets folder for the `:assets` route (the root for `Plezi.route '/assets/path'`, :assets).
-    attr_accessor :assets
-    # Get / set the application name, which is used to create and identify the application's global pub/sub channel when using Redis.
-    attr_accessor :app_name
-  end
-  @app_name = "#{File.basename($PROGRAM_NAME, '.*')}_app"
-  @templates = File.expand_path(File.join(File.dirname($PROGRAM_NAME), 'views'.freeze))
-  @assets = File.expand_path(File.join(File.dirname($PROGRAM_NAME), 'assets'.freeze))
-  @plezi_autostart = nil
+   # Plezi is amazing. Read the {README}
+   class << self
+     # Get / set the template folder for the {Controller#render} function.
+     attr_accessor :templates
+     # Get / set the assets folder for the `:assets` route (the root for `Plezi.route '/assets/path'`, :assets).
+     attr_accessor :assets
+     # Get / set the application name, which is used to create and identify the application's global pub/sub channel when using Redis.
+     attr_accessor :app_name
+   end
+   @app_name = "#{File.basename($PROGRAM_NAME, '.*')}_app"
+   @templates = File.expand_path(File.join(File.dirname($PROGRAM_NAME), 'views'.freeze))
+   @assets = File.expand_path(File.join(File.dirname($PROGRAM_NAME), 'assets'.freeze))
+   @plezi_autostart = nil
 
-  module_function
+   module_function
 
-  # Disables the autostart feature
-  def no_autostart
-    @plezi_autostart = false
-  end
+   # Disables the autostart feature
+   def no_autostart
+      @plezi_autostart = false
+   end
 
-  # @private
-  # Allows Plezi to be used as middleware.
-  def new(app, *_args)
-    Plezi::Base::Router.new(app)
-  end
+   # @private
+   # Allows Plezi to be used as middleware.
+   def new(app, *_args)
+      Plezi::Base::Router.new(app)
+   end
 
-  # Returns the Plezi Rack application
-  def app
-    no_autostart
-    puts "Running Plezi version: #{::Plezi::VERSION}"
-    Plezi::Base::Router.call_method
-  end
+   # Returns the Plezi Rack application
+   def app
+      no_autostart
+      puts "Running Plezi version: #{::Plezi::VERSION}"
+      Plezi::Base::Router.call_method
+   end
 
-  # Will add a route to the Plezi application.
-  #
-  # The order of route creation is the order of precedence.
-  #
-  # path:: the HTTP path for the route. Inline parameters and optional parameters are supported. i.e.
-  #
-  #                Plezi.route '/fixed/path', controller
-  #                Plezi.route '/fixed/path/:required_param/(:optional_param)', controller
-  #                Plezi.route '/(:format)', /^(html|json|xml)$/ # a rewrite route, usally on top.
-  #                Plezi.route '*', controller # catch all
-  #
-  #
-  # controller:: A Controller class or one of the included controllers: `false` for rewrite routes; `:client` for the Javascript Auto Dispatch client; `:assets` for a missing asset baker controller (bakes any unbaked assets into the public folder file).
-  def route(path, controller)
-    plezi_initialize
-    Plezi::Base::Router.route path, controller
-  end
+   # Will add a route to the Plezi application.
+   #
+   # The order of route creation is the order of precedence.
+   #
+   # path:: the HTTP path for the route. Inline parameters and optional parameters are supported. i.e.
+   #
+   #                Plezi.route '/fixed/path', controller
+   #                Plezi.route '/fixed/path/:required_param/(:optional_param)', controller
+   #                Plezi.route '/(:format)', /^(html|json|xml)$/ # a rewrite route, usally on top.
+   #                Plezi.route '*', controller # catch all
+   #
+   #
+   # controller:: A Controller class or one of the included controllers: `false` for rewrite routes; `:client` for the Javascript Auto Dispatch client; `:assets` for a missing asset baker controller (bakes any unbaked assets into the public folder file).
+   def route(path, controller)
+      plezi_initialize
+      Plezi::Base::Router.route path, controller
+   end
 
-  # Will make a weak attempt to retrive a string representing a valid URL for the requested Controller's function.
-  # False positives (invalid URL strings) are possible (i.e., when requesting a URL of a method that doesn't exist).
-  def url_for(controller, method_sym, params = {})
-    Plezi::Base::Router.url_for controller, method_sym, params
-  end
+   # Will make a weak attempt to retrive a string representing a valid URL for the requested Controller's function.
+   # False positives (invalid URL strings) are possible (i.e., when requesting a URL of a method that doesn't exist).
+   def url_for(controller, method_sym, params = {})
+      Plezi::Base::Router.url_for controller, method_sym, params
+   end
 end