plezi 0.12.21 → 0.12.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 393d101919837f0ce957673f30cf4afa858977bb
-  data.tar.gz: 5e23ca2e9ddd479fefd37c0747c246a924f6c755
+  metadata.gz: 8eab38fb8e80a3c148bfcc217f44e3ade73f9adc
+  data.tar.gz: 5bcdd05f5c30e0cf177b983d757f21e6c13b7bf8
 SHA512:
-  metadata.gz: 855bc07cedb86d69f9787f6740a8f3397140487d9f00d5eb7fbfbafbc7bf912e8a9719b44ed0d683ea1370a115984f83c6097abda71b3fc6a10a83d68226498d
-  data.tar.gz: 1ca4b13dd3ca651514b5822c1265bff122d1b0d791cab76a841926139b8b93c655b2107611781408399c9b224ce0fdc892f392da1bb0db2f1f96a44a5de40963
+  metadata.gz: 60bfb7361f4f50d380f6db994795959ddb611e421e42a1f09ea4a9cd1dcc36c7eac1a5c5edd094ae5bffe52f4176f8ca2cb46af134f718b18ceb6e1725bb5ce4
+  data.tar.gz: d8ecf48b40a0feacec0cc0b86dae87a00cd19f0523e58a829d0d9d1f19eaf9d82816fea4d4e7f2ae85d407786075f032ccf8c267162f9d8b11465f755f1debc1

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 #Change Log
 
+***
+
+Change log v.0.12.22
+
+**Fix**: fix for issue #17 where unicode characters might cause `erb` rendering to fail. Credit to @davidjuin0519 (Juin Chiu) for reporting the issue and helping resolve it.
+
+* **Deprecation notice**:
+
+     v.0.12.22 will probably be the last one for a pure Ruby implementation. Future versions might be limited to Ruby MRI due to C extensions being used.
+
+     Plezi's server, Iodine, was re-written in C, allowing for a smaller memory footprint, more speed and tens of thousands of concurrent connections (using `kqueue` and `epoll`, instead of Ruby's `select` which is limited to 1024 connections).
+
+     Plezi 0.13.x will be using Iodine's C version (0.2.x) by default.
+
+     Since Iodine 0.2.x is Rack complient, Plezi will be able to work with other Rack servers except when using websockets (which will require Iodine due to it's unique websocket support).
+
+     This means that Plezi will be limited to systems that can run the new version of Iodine (Ruby MRI and Unix based systems, such as Linux and Mac OSX).
+
+
 ***
 
 Change log v.0.12.21
@@ -168,7 +187,7 @@ Change log v.0.12.3
 
 * Websocket Identity API allows you to link a websocket connection with a unique "identity" (i.e., `user.id` or even `session.id`).
 
-     This is called "registering", as the identity "registers" and is henceforth recognized. 
+     This is called "registering", as the identity "registers" and is henceforth recognized.
 
 * Notifications sent to the identidy will persist until the identity's "lifetime" expires.
 
@@ -176,7 +195,7 @@ Change log v.0.12.3
 
 * This allows you to send notifications that will "wait" until a user or visitor reconnects and registers the new connection under their Identity.
 
-* This is an alternative to persistant storage, where either visitors messages that aren't read within a certain timespan 
+* This is an alternative to persistant storage, where either visitors messages that aren't read within a certain timespan
 
 **Fix**: the Placebo API was fixed to correspond with the changes in Iodine's API.
 
@@ -212,7 +231,7 @@ Change log v.0.12.0 - API changes (throwing out dead code and many more changes)
 
 **Feature** The `Controller.failed_unicast(target, method, arguments_array)` callback is here, allowing you to write a class level callback that will be called if `unicast` fails to find it's target (i.e. if the Websocket connection was already closed or the hosting server shutdown).
 
-\* the lack of this callback being called does NOT imply that the unicast was processed without errors, it's only called if the target itself wasn't found (the connection already recognized as closed). Errors can occure within the method originally called by `unicast` when the target was found but the connection was dropped while processing was underway. The `failed_unicast` callback, together with error handling in the original method (i.e. `response << "message"` returning `nil`) should cover any reasonable scenario. 
+\* the lack of this callback being called does NOT imply that the unicast was processed without errors, it's only called if the target itself wasn't found (the connection already recognized as closed). Errors can occure within the method originally called by `unicast` when the target was found but the connection was dropped while processing was underway. The `failed_unicast` callback, together with error handling in the original method (i.e. `response << "message"` returning `nil`) should cover any reasonable scenario.
 
 **Minor**: updated asset pipeline performance; API for the `Plezi.route` methods now auto-creates an empty listening service (no assets, no templates, no public folder...) if one is missing.
 
@@ -248,13 +267,13 @@ Change log v.0.11.0
 
 **Update**: Requires GRHttp server and GReactor version 0.1.0 or above, adjusted to the updated API.
 
-**Update**: Better pinging and timout support courtesy of the updated GRHttp server. 
+**Update**: Better pinging and timout support courtesy of the updated GRHttp server.
 
 **Update**: The default number of threads is now 30. It seems that once we move beyond 1 thread (which is also supported), the added threads are adding more security against blocking code without effecting performance as much. It is expected that advanced users will consider moving away from multi-threading to muli-processing while avoiding blocking code. All these options are supported by Plezi, GRHttp and GReactor.
 
 **Fix**: Fixed an issue where requests for folders within the assets folder (folder indexing) would fail with an internal error message (error 500) instead of a not found message (error 404).
 
-**Fix**: fixed an issue that caused the static file service to fail when using the preferred `:public` vs. the older `:root` option used to set the public folder's path. 
+**Fix**: fixed an issue that caused the static file service to fail when using the preferred `:public` vs. the older `:root` option used to set the public folder's path.
 
 **Minor**: minor adjustments and improvements, such as: auto-setting the `content-type` header when using `render`.
 
@@ -272,7 +291,7 @@ Change log v.0.10.17
 
 Change log v.0.10.16
 
-**Fix**: Requires a newer version of the GRHttp server, which fixs an issue with Firefox's websocket implementation. 
+**Fix**: Requires a newer version of the GRHttp server, which fixs an issue with Firefox's websocket implementation.
 
 **New Feature**: Persistent and synchronized Session data(!) using Redis (if supplied) with a fallback to temporary memory storage. Session lifetime is 5 days.
 
@@ -829,7 +848,7 @@ Change log v.0.6.5
 
 Rack code and Plezi code are NOT fully compatible. for example: Rack's parameters aren't always fully decoded. Also, Rack's file upload contains tmporary files, where Plezi's request object contains the binary data in a binary String object.
 
-Also, Rack does NOT support native WebSocket Controllers (you will need middle ware for that). 
+Also, Rack does NOT support native WebSocket Controllers (you will need middle ware for that).
 
 ***
 
@@ -901,7 +920,7 @@ Change log v.0.5.0
 
 Change log v.0.4.3
 
-**notice!:** v.0.5.0 might break any code using the `listen :vhost => "foo.bar.com"` format. hosts and aliases will be restructured. 
+**notice!:** v.0.5.0 might break any code using the `listen :vhost => "foo.bar.com"` format. hosts and aliases will be restructured.
 
 **fix**: an issue with the router was discovered, where non-RESTful Controller methods weren't called for POST, PUT or DELETE http requests. this issue is now fixed, so that non-RESTful methods will be attempted and will exclude ID's with the same value from being created...
 
@@ -913,7 +932,7 @@ Change log v.0.4.2
 
 **error-detection**: Plezi will check that the same port isn't used for to services and will return a warning. a `listen` call with `RackServer` will return an existing router object if a service is already assigned to the requested port.
 
-**notice!:** v.0.5.0 will break any code using the `listen :vhost => "foo.bar.com"` format. hosts and aliases will be restructured. 
+**notice!:** v.0.5.0 will break any code using the `listen :vhost => "foo.bar.com"` format. hosts and aliases will be restructured.
 
 **fix**: 404 error handler should now be immune to path rewrites (displays originally requested path).
 
@@ -1074,4 +1093,4 @@ some minor bug fixes.
 
 Change log v.0.2.0
 
-First release that actually works well enough to do something with.
+First release that actually works well enough to do something with.

data/README.md

@@ -4,6 +4,28 @@
 [![Inline docs](http://inch-ci.org/github/boazsegev/plezi.svg?branch=master)](http://www.rubydoc.info/github/boazsegev/plezi/master)
 [![GitHub](https://img.shields.io/badge/GitHub-Open%20Source-blue.svg)](https://github.com/boazsegev/plezi)
 
+## Special notice - pre version 13
+
+One of the best compliments Plezi keeps receiving is the feedback about how easy it is to set up a websocket application using Plezi.
+
+On the other hand, Plezi's server, Iodine 0.1.x was written in Ruby and allowed a very fast and easy development...
+
+...but with time and experience we all discovered the Ruby's `select` was limited to ~1024 connections, and that Plezi developers wanted more - more connections, more performance, more ease of deployment and more integration with Rails/Sinatra.
+
+I'm working very hard on rewriting the core server in C. Iodine 0.2.x is written in C and it supports only Unix based systems with `kqueue` or `epoll` support (BSD/Linux/MacOSX).
+
+This means that if your machine has the memory and the resources (open file descriptor limits apply), Iodine could support tens of thousands of concurrent connections.
+
+Also, a lot of the API is changing for better integration with Rack based frameworks (Rails/Sinatra).
+
+This also means that some sacrifices will be made. i.e. more Rack integration means that we loose HTTP streaming (Rack's specifications have their limits).
+
+This is where you come in. **Now** is the time to push those changes you wanted to integrate into Plezi. Send in your thoughts and feedback. You can open an issue or email me. Just write about how you use Plezi and what features you think are super important to keep and which once bother you.
+
+Even if I cannot answer everyone, it will all go into the next version's design and I'll do my best.
+
+## Plezi
+
 Plezi is a Ruby framework for realtime web applications. It's name comes from the word "pleasure", since Plezi is a pleasure to work with.
 
 With Plezi, you can easily:
@@ -16,7 +38,7 @@ With Plezi, you can easily:
 
 ## Guides and documentation
 
-You can find [tutorials and guides at Plezi.io](http://www.plezi.io/guides).
+You can find [tutorials and guides at Plezi.io](http://www.plezi.io/docs).
 
 Plezi leverages Ruby's mixins and meta-programming, so the YARD documentation is hard to navigate... I started writing guides for Plezi and would really appreciate any help you can offer.
 
@@ -36,7 +58,7 @@ Or install it yourself as:
 
 ## Quick start
 
-Plezi is super easy. Please read our [Getting Started guide](http://www.plezi.io/guides/basics) for more information.
+Plezi is super easy. Please read our [Getting Started guide](http://www.plezi.io/docs/basics) for more information.
 
 Here's a super quick intro:
 
@@ -709,7 +731,7 @@ The following is safe:
     Plezi.get_cached :global_hash do |global_hash|
         global_hash[:change] = "safe"
     end
- 
+
 However, the following is unsafe:
 
     # set data
@@ -717,7 +739,7 @@ However, the following is unsafe:
     # manipulate data
     global_hash = Plezi.get_cached :global_hash do |global_hash|
     global_hash[:change] = "NOT safe"
- 
+
 
 \* be aware, if using Plezi in as a multi-process application, that each process has it's own cache and that processes can't share the cache. The different threads in each of the processes will be able to access their process's cache, but each process runs in a different memory space, so they can't share.
 

data/lib/plezi/common/renderer.rb

@@ -62,7 +62,7 @@ module Plezi
 				return true if Plezi.cache_needs_update?(sass)
 				# return false unless Plezi.allow_cache_update? # no meaningful performance boost.
 				mt = Plezi.file_mtime(sass)
-				Plezi.get_cached(sass).each {|e| return true if File.exists?(e.options[:filename]) && (File.mtime(e.options[:filename]) > mt)} # fn = File.join( e.options[:load_paths][0].root, e.options[:filename]) 
+				Plezi.get_cached(sass).each {|e| return true if File.exists?(e.options[:filename]) && (File.mtime(e.options[:filename]) > mt)} # fn = File.join( e.options[:load_paths][0].root, e.options[:filename])
 				false
 			end
 		end
@@ -76,7 +76,7 @@ module Plezi
 		module_function
 		# Registers a rendering extention for a specific asset type (js, css, etc').
 		#
-		# type:: the type of 
+		# type:: the type of
 		# extention:: a Symbol or String representing the extention of the file to be rendered. i.e. 'scss', 'sass', 'coffee', etc'
 		# handler :: a Proc or other object that answers to call(filename, context, &block) and returnes the rendered string. The block accepted by the handler is for chaining rendered actions (allowing for `yield` within templates) and the context is a Binding object which is offered to the rendering (if `binding` handling is supported by the engine).
 		#
@@ -116,22 +116,22 @@ module Plezi
 
 	Renderer.register :erb do |filename, context, &block|
 		next unless defined? ::ERB
-		( Plezi.cache_needs_update?(filename) ? Plezi.cache_data( filename, ( ERB.new( IO.binread(filename) ) ) )  : (Plezi.get_cached filename) ).result((context) , &block)
+		( Plezi.cache_needs_update?(filename) ? Plezi.cache_data( filename, ( ERB.new( Plezi::Base::Helpers.try_utf8! IO.binread(filename) ) ) )  : (Plezi.get_cached filename) ).result((context) , &block)
 	end
 	Renderer.register :slim do |filename, context, &block|
 		next unless defined? ::Slim
-		( Plezi.cache_needs_update?(filename) ? Plezi.cache_data( filename, ( Slim::Template.new() { IO.binread filename } ) )  : (Plezi.get_cached filename) ).render(context.receiver, &block)
+		( Plezi.cache_needs_update?(filename) ? Plezi.cache_data( filename, ( Slim::Template.new() { Plezi::Base::Helpers.try_utf8! IO.binread(filename) } ) )  : (Plezi.get_cached filename) ).render(context.receiver, &block)
 	end
 	Renderer.register :haml do |filename, context, &block|
 		next unless defined? ::Haml
-		( Plezi.cache_needs_update?(filename) ? Plezi.cache_data( filename, ( Haml::Engine.new( IO.binread(filename) ) ) )  : (Plezi.get_cached filename) ).render(context.receiver, &block)
+		( Plezi.cache_needs_update?(filename) ? Plezi.cache_data( filename, ( Haml::Engine.new( Plezi::Base::Helpers.try_utf8! IO.binread(filename) ) ) )  : (Plezi.get_cached filename) ).render(context.receiver, &block)
 	end
 
 	# JavaScript asset rendering
 	AssetManager.register :js, :erb, Renderer.review(:erb)
 	AssetManager.register :js, :coffee do |filename, context, &block|
 		next unless defined? ::CoffeeScript
-		( Plezi.cache_needs_update?(filename) ? Plezi.cache_data( filename, CoffeeScript.compile(IO.binread filename) )  : (Plezi.get_cached filename) )
+		( Plezi.cache_needs_update?(filename) ? Plezi.cache_data( filename, CoffeeScript.compile(Plezi::Base::Helpers.try_utf8!(IO.binread(filename))) )  : (Plezi.get_cached filename) )
 	end
 
 	# CSS asset rendering

data/lib/plezi/handlers/controller_core.rb

@@ -3,6 +3,10 @@ module Plezi
 
 		# the methods defined in this module will be injected into the Controller's Core class (inherited from the controller).
 		module ControllerCore
+			# @!parse include Plezi::Base::WSObject
+			# @!parse include InstanceMethods
+			# @!parse extend ClassMethods
+
 			def self.included base
 				base.send :include, Plezi::Base::WSObject
 				base.send :include, InstanceMethods

data/lib/plezi/handlers/controller_magic.rb

@@ -20,6 +20,10 @@ module Plezi
 	# {include: Plezi::ControllerMagic::InstanceMethods}
 	# 
 	module ControllerMagic
+		# @!parse include Plezi::Base::WSObject
+		# @!parse include InstanceMethods
+		# @!parse extend ClassMethods
+
 		def self.included base
 			base.send :include, InstanceMethods
 			base.extend ClassMethods

data/lib/plezi/version.rb

@@ -1,3 +1,3 @@
 module Plezi
-    VERSION = "0.12.21"
+    VERSION = "0.12.22"
 end

data/plezi.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Plezi::VERSION
   spec.authors       = ["Boaz Segev"]
   spec.email         = ['boaz@2be.co.il']
-  spec.summary       = %q{Plezi - the easy way to add Websockets, RESTful routing and HTTP streaming serviced to Ruby Web-Apps.}
-  spec.description   = %q{Plezi - the easy way to add Websockets, RESTful routing and HTTP streaming serviced to Ruby Web-Apps.}
+  spec.summary       = %q{Plezi - the easy way to add Websockets, RESTful routing and HTTP streaming services to Ruby Web-Apps.}
+  spec.description   = %q{Plezi - the easy way to add Websockets, RESTful routing and HTTP streaming services to Ruby Web-Apps.}
   spec.homepage      = "http://www.plezi.io/"
   spec.license       = "MIT"
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "iodine", "~> 0.1.19"
+  spec.add_dependency "iodine", "~> 0.1.20"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 

data/test/hello_world

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+$LOAD_PATH.unshift File.expand_path(File.join('..', '..', 'lib'), __FILE__ )
+require "plezi"
+
+Iodine.logger = nil
+
+HELLO = 'Hello Plezi'
+Plezi.route('*') { HELLO }
+
+# ab -n 10000 -c 200 -k http://127.0.0.1:3000/
+# ~/ruby/wrk/wrk -c400 -d10 -t12 http://localhost:3000/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plezi
 version: !ruby/object:Gem::Version
-  version: 0.12.21
+  version: 0.12.22
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-08 00:00:00.000000000 Z
+date: 2016-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iodine
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.19
+        version: 0.1.20
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.19
+        version: 0.1.20
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 description: Plezi - the easy way to add Websockets, RESTful routing and HTTP streaming
-  serviced to Ruby Web-Apps.
+  services to Ruby Web-Apps.
 email:
 - boaz@2be.co.il
 executables:
@@ -140,6 +140,7 @@ files:
 - resources/welcome_page.html
 - test/console
 - test/dispatch
+- test/hello_world
 - test/plezi_tests.rb
 homepage: http://www.plezi.io/
 licenses:
@@ -162,13 +163,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Plezi - the easy way to add Websockets, RESTful routing and HTTP streaming
-  serviced to Ruby Web-Apps.
+  services to Ruby Web-Apps.
 test_files:
 - test/console
 - test/dispatch
+- test/hello_world
 - test/plezi_tests.rb
 has_rdoc: