plezi 0.10.8 → 0.10.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c504b33f40bbc1d8235c5d48101abab00a0facac
-  data.tar.gz: 5fad18c3d52af38f9ecc94cb899c337b54a3afdd
+  metadata.gz: ef2d6297c599601166b2e26a419ad02b89b10ecb
+  data.tar.gz: e5f255998404493dff97e3d5ab4e17583b391d10
 SHA512:
-  metadata.gz: c4f6a25bfa2846fd8ea384b741ee754673c3ecc6384402b9bd8c0766dea71ab0cc9711723ccaf38f20934fbf0b0f05c3c409850aa427a9d87f26775467b7382e
-  data.tar.gz: db2844de88d6dae7a1e019b4ec46fde5f33f4342484e38d5dc03f9aa9e5cc70c897ace96b4fed46f92bfd7e8c4d572f2e4bdc4952caa7dc0b283d93a01c1aaea
+  metadata.gz: a8a372f2af85a2f3c24985ea15db19c1b4ab7f96f31a10c0dda71a0b4f7697c934aeabfb7738877bc39d3319dc4e9d058dfd798847c745cd7d858f19837a1da9
+  data.tar.gz: 09c07532144ab34453cde96ba66d7b2650b85722f62aac4b724365ccfde4b010c2296e8b704021d41baeda84745a739e0ddf50f01a04d90a30e1c73998349309

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ***
 
+Change log v.0.10.9
+
+**Minor**: minor update to the cache system, might improve performance somewhat and might fix rare issues related to some binary files. Updated GRHttp server version required.
+
+**Fix**: fixed an issue with Placebo listeners where they might be thrown from the IO stack and thereby stop listening ()or, alternatively, consume CPU) . This issue was caused by GReactor's 'BasicIO#clear?' code enforcing two-way connectivity.
+
+***
+
 Change log v.0.10.8
 
 **Fix**: Fixed an issue with the new websocket upgrade handler. It is unclear how come the issue did not show up during the testing.

data/README.md

@@ -1,10 +1,10 @@
 # Plezi, The Rack Free Ruby framework for realtime web-apps
 [![Gem Version](https://badge.fury.io/rb/plezi.svg)](http://badge.fury.io/rb/plezi)
-[![Inline docs](http://inch-ci.org/github/boazsegev/plezi.svg?branch=master)](http://www.rubydoc.info/gems/plezi/)
+[![Inline docs](http://inch-ci.org/github/boazsegev/plezi.svg?branch=master)](http://www.rubydoc.info/github/boazsegev/plezi/master)
 
 > People who are serious about their frameworks, should write their own servers...
 
-Find more info on [Plezi's framework documentation](http://www.rubydoc.info/gems/plezi/)
+Find more info on [Plezi's framework documentation](http://www.rubydoc.info/github/boazsegev/plezi/master)
 
 ## About the Plezi framework
 

data/lib/plezi/common/cache.rb

@@ -2,11 +2,15 @@
 module Plezi
 
 	# File and Object Caching for Plezi
+	#
+	# Be aware that the cache is local, per process. It's possible to limit file caching by limiting the supported_types in Plezi::Cache::CACHABLE.
+	#
+	# Template rendering engines are always cached.
 	module Cache
 		# contains the cached data, in the format: CACHE_STORE["filename"] = CacheObject
 		CACHE_STORE = {}
 		CACHE_LOCK = Mutex.new
-		CACHABLE = %w{cache object slim haml css map js html scss sass coffee txt xml json yaml rb}
+		CACHABLE = (%w{cache object slim haml css map js html scss sass coffee txt xml json yaml rb}).to_set
 
 		@cache_to_disk = true
 
@@ -17,7 +21,8 @@ module Plezi
 
 			# initialize a Cached object
 			def initialize d = nil, t = Time.now
-				@data, @mtime = d, t
+				@data = t
+				@mtime = d
 			end
 		end
 
@@ -34,16 +39,16 @@ module Plezi
 		# force a file onto the cache (only if it is cachable - otherwise will load the file but will not cache it).
 		def reload_file filename
 			if CACHABLE.include? filename.match(/\.([^\.]+)$/)[1]
-				return cache_data filename, IO.read(filename), File.mtime(filename)
+				return cache_data filename, IO.binread(filename), File.mtime(filename)
 			else
-				return IO.read(filename)
+				return IO.binread(filename)
 			end
 		end
 		# places data into the cache, and attempts to save the data to a file name.
 		def save_file filename, data, save_to_disk = false
 			cache_data filename, data if CACHABLE.include? filename.match(/\.([^\.]+)$/)[1]
 			begin
-				IO.write filename, data if save_to_disk
+				IO.binwrite filename, data if save_to_disk
 			rescue Exception => e
 				Plezi.warn("File couldn't be written (#{filename}) - file system error?")
 			end

data/lib/plezi/common/dsl.rb

@@ -14,7 +14,6 @@ module Plezi
 			#
 			# use the`listen`, `host` and `route` functions rather then accessing this object.
 			#
-			@servers = {}
 			@active_router = nil
 
 
@@ -98,8 +97,7 @@ module Plezi
 
 			# adds a host to the last server created
 			#
-			# accepts the same parameter(s) as the `listen` command (see Plezi.add_service), except :protocol and :handler are ignored:
-			# alias:: a String or an Array of Strings which represent alternative host names (i.e. `alias: ["admin.google.com", "admin.gmail.com"]`).
+			# accepts a host name and a parameter(s) Hash which are the same parameter(s) as {Plezi.listen} accepts:
 			def host(host_name, params)
 				raise "Must define a listener before adding a route - use `Plezi.listen`." unless @active_router
 				@active_router.add_host host_name, params

data/lib/plezi/handlers/controller_magic.rb

@@ -26,10 +26,10 @@ module Plezi
 			# the request object, class: HTTPRequest.
 			attr_reader :request
 
-			# the ::params variable contains all the parameters set by the request (/path?locale=he  => params["locale"] == "he").
+			# the :params variable contains all the parameters set by the request (/path?locale=he  => params ["locale"] == "he").
 			attr_reader :params
 
-			# a cookie-jar to get and set cookies (set: `cookie\[:name] = data` or get: `cookie\[:name]`).
+			# a cookie-jar to get and set cookies (set: `cookie [:name] = data` or get: `cookie [ :name ]`).
 			#
 			# Cookies and some other data must be set BEFORE the response's headers are sent.
 			attr_reader :cookies
@@ -37,7 +37,7 @@ module Plezi
 			# the HTTPResponse **OR** the WSResponse object that formats the response and sends it. use `response << data`. This object can be used to send partial data (such as headers, or partial html content) in blocking mode as well as sending data in the default non-blocking mode.
 			attr_reader :response
 
-			# the ::flash is a little bit of a magic hash that sets and reads temporary cookies.
+			# the :flash is a little bit of a magic hash that sets and reads temporary cookies.
 			# these cookies will live for one successful request to a Controller and will then be removed.
 			attr_reader :flash
 
@@ -166,11 +166,11 @@ module Plezi
 				I18n.locale = options[:locale] || I18n.default_locale if defined?(I18n) # sets the locale to nil for default behavior even if the locale was set by a previous action - removed: # && options[:locale]
 				# find template and create template object
 				filename = template.is_a?(String) ? File.join( host_params[:templates].to_s, template) : (File.join( host_params[:templates].to_s, *template.to_s.split('_')) + (options[:type].empty? ? '': ".#{options[:type]}") + '.slim')
-				return ( Plezi.cache_needs_update?(filename) ? Plezi.cache_data( filename, ( Slim::Template.new() { IO.read filename } ) )  : (Plezi.get_cached filename) ).render(self, &block) if defined?(::Slim) && Plezi.file_exists?(filename)
+				return ( Plezi.cache_needs_update?(filename) ? Plezi.cache_data( filename, ( Slim::Template.new() { IO.binread filename } ) )  : (Plezi.get_cached filename) ).render(self, &block) if defined?(::Slim) && Plezi.file_exists?(filename)
 				filename.gsub! /\.slim$/, '.haml'
-				return ( Plezi.cache_needs_update?(filename) ? Plezi.cache_data( filename, ( Haml::Engine.new( IO.read(filename) ) ) )  : (Plezi.get_cached filename) ).render(self, &block) if defined?(::Haml) && Plezi.file_exists?(filename)
+				return ( Plezi.cache_needs_update?(filename) ? Plezi.cache_data( filename, ( Haml::Engine.new( IO.binread(filename) ) ) )  : (Plezi.get_cached filename) ).render(self, &block) if defined?(::Haml) && Plezi.file_exists?(filename)
 				filename.gsub! /\.haml$/, '.erb'
-				return ( Plezi.cache_needs_update?(filename) ? Plezi.cache_data( filename, ( ERB.new( IO.read(filename) ) ) )  : (Plezi.get_cached filename) ).result(binding, &block) if defined?(::ERB) && Plezi.file_exists?(filename)
+				return ( Plezi.cache_needs_update?(filename) ? Plezi.cache_data( filename, ( ERB.new( IO.binread(filename) ) ) )  : (Plezi.get_cached filename) ).result(binding, &block) if defined?(::ERB) && Plezi.file_exists?(filename)
 				return false
 			end
 

data/lib/plezi/handlers/http_router.rb

@@ -38,7 +38,7 @@ module Plezi
 				@sass_cache = Sass::CacheStores::Memory.new if defined?(::Sass)
 			end
 
-			# adds a host to the router (or activates an existing host to add new routes). accepts a host name and any parameters not related to the service (see `Plezi.add_service`)
+			# adds a host to the router (or activates an existing host to add new routes). accepts a host name and any parameters not related to the actual connection (ssl etc') (see {Plezi.listen})
 			def add_host host_name, params = {}
 				host_name = (host_name ? host_name.to_s.downcase : :default)
 				@active_host = get_host(host_name) || ( @hosts[host_name] = Host.new(params) )
@@ -142,7 +142,7 @@ module Plezi
 					if defined?(::CoffeeScript) && Plezi.cache_needs_update?(coffee)
 						# render coffee to cache
 						Plezi.cache_data coffee, nil
-						Plezi.save_file target_file, CoffeeScript.compile(IO.read coffee), params[:save_assets]
+						Plezi.save_file target_file, CoffeeScript.compile(IO.binread coffee), params[:save_assets]
 					end
 					# try to send the cached js file which started the request.
 					return Base::HTTPSender.send_file request, response, target_file

data/lib/plezi/handlers/placebo.rb

@@ -40,6 +40,12 @@ module Plezi
 						@io[:websocket_handler] = self
 						super()
 					end
+					# notice of disconnect
+					def on_close
+						return super() if defined? super
+						GR.warn "Placebo #{self.class.superclass.name} disconnected. Ignore if this message appears during shutdown."
+					end
+
 					# handles broadcasts / unicasts
 					def on_broadcast ws
 						data = ws.data
@@ -91,6 +97,19 @@ module Plezi
 					end
 				end
 			end
+			class PlaceboIO < GReactor::BasicIO
+				def clear?
+					io.closed?
+				end
+				def call
+					self.read
+					GR.warn "Placebo IO recieved IO signal - this is unexpected..."
+				end
+				def on_disconnect
+					@params[:out].close rescue nil
+					@cache[:websocket_handler].on_close if @cache[:websocket_handler]
+				end
+			end
 		end
 		module_function
 		def new placebo_class
@@ -104,8 +123,8 @@ module Plezi
 				Object.const_set(new_class_name, new_class)
 			end
 			i, o = IO.pipe
-			o.close
-			io = GReactor.add_io i, handler: (Proc.new {|io| io.read })
+			io = Placebo::Base::PlaceboIO.new i, out: o
+			io = GReactor.add_raw_io i, io
 			new_class.new(io)
 		end
 	end

data/lib/plezi/helpers/http_sender.rb

@@ -12,12 +12,12 @@ module Plezi
 			# sends a response for an error code, rendering the relevent file (if exists).
 			def send_by_code request, response, code, headers = {}
 				begin
-					base_code_path = request.io[:params][:templates] || File.expand_path('.')
+					base_code_path = request.io.params[:templates] || File.expand_path('.')
 					if defined?(::Slim) && Plezi.file_exists?(fn = File.join(base_code_path, "#{code}.html.slim"))
 						Plezi.cache_data fn, Slim::Template.new( fn ) unless Plezi.cached? fn
 						return send_raw_data request, response, Plezi.get_cached( fn ).render( self, request: request ), 'text/html', code, headers
 					elsif defined?(::Haml) && Plezi.file_exists?(fn = File.join(base_code_path, "#{code}.html.haml"))
-						Plezi.cache_data fn, Haml::Engine.new( IO.read( fn ) ) unless Plezi.cached? fn
+						Plezi.cache_data fn, Haml::Engine.new( IO.binread( fn ) ) unless Plezi.cached? fn
 						return send_raw_data request, response, Plezi.get_cached( File.join(base_code_path, "#{code}.html.haml") ).render( self ), 'text/html', code, headers
 					elsif defined?(::ERB) && Plezi.file_exists?(fn = File.join(base_code_path, "#{code}.html.erb"))
 						return send_raw_data request, response, ERB.new( Plezi.load_file( fn ) ).result(binding), 'text/html', code, headers

data/lib/plezi/version.rb

@@ -1,3 +1,3 @@
 module Plezi
-    VERSION = "0.10.8"
+    VERSION = "0.10.9"
 end

data/plezi.gemspec

@@ -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 "grhttp", "~> 0.0.11"
+  spec.add_dependency "grhttp", "~> 0.0.12"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 

data/resources/plezi_websockets.html

@@ -14,7 +14,7 @@
   </style>
   <script>
   	var websocket = NaN;
-  	function connect() { websocket = new WebSocket('ws://' + window.location.hostname + (window.location.port == '' ? '' : (':' + window.location.port) ) + "/" ); }
+  	function connect() { websocket = new WebSocket( (window.location.protocol.match(/https/) ? 'wws' : 'ws') + '://' + window.location.hostname + (window.location.port == '' ? '' : (':' + window.location.port) ) + "/" ); }
 	function init()
 	{
 		connect()

data/resources/welcome_page.html

@@ -175,7 +175,7 @@ input[type=submit]:active
 </style>
 <script type="text/javascript">
 // Your websocket URI should be an absolute path. The following sets the base URI.
-var ws_uri = 'ws://' + window.location.hostname + (window.location.port == '' ? '' : (':' + window.location.port) );
+var ws_uri = (window.location.protocol.match(/https/) ? 'wss' : 'ws') + '://' + window.location.hostname + (window.location.port == '' ? '' : (':' + window.location.port) );
 // remember to add the specific controller's path to your websocket URI.
 ws_uri += "/";
 // websocket variable.

data/test/plezi_tests.rb

@@ -246,6 +246,7 @@ module PleziTestTasks
 		ws = GRHttp::WSClient.connect_to("ws://localhost:3000/ws/placebo") {|ws| 'ME?'}
 		ws << "    * Placebo WS connected."
 		sleep 2
+		ws.close
 		rescue => e
 		puts "    **** Placebo test FAILED TO RUN!!!"
 		puts e
@@ -387,7 +388,7 @@ end
 r = Plezi::Placebo.new PlaceboCtrl
 puts "    * Create Placebo test: #{PleziTestTasks::RESULTS[r && true]}"
 
-PL.create_logger '/dev/null'
+PL.create_logger nil
 # PL::Settings.max_threads = 4
 
 listen port: 3000

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plezi
 version: !ruby/object:Gem::Version
-  version: 0.10.8
+  version: 0.10.9
 platform: ruby
 authors:
 - Boaz Segev
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.11
+        version: 0.0.12
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.11
+        version: 0.0.12
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement