plezi 0.14.1 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07be3dac0b13bbf73ca5e0890887e07f41714d04
-  data.tar.gz: 12165bf821d681d1244fe4d66816acd60da1999e
+  metadata.gz: 46dea93c274cc8c463747a8d91e46c4af6852a86
+  data.tar.gz: 56b9726006f702548770d2ea7beebbec6564ad8c
 SHA512:
-  metadata.gz: 7828a5c7a2b81270eedda66063937aa763bfcd363d1c3e20252bd8a781e54a789bae4533705f531087d5a6824a4388e6ea9d0785bf52e50a6a011d82ef986035
-  data.tar.gz: 95c13086f6e6680ea23dad7e76c631a5428a683a330c1ab30bf481b336efbc427b190ccc090c6c5eb9f98f80ff441dadd9c0354d5c99a1af771a5ded4c87d07e
+  metadata.gz: 30312ea6a47f7e8d9dc53a5c8c552046da2c064bdab79f15699507e8bd8628a9ce0c9fc47ea31d19073e271ec9394082e5066f301f5115ffeb10dfe08a31e59f
+  data.tar.gz: 0d275aa94313f9fe2bfe87a29eba26f31ad37ec9226c27a982fb86522404576aa65810f5575f211f160ed7d561de5bf12af3ce694e82f153d03b6e1e4e9212ef

data/.gitignore

@@ -20,3 +20,5 @@ tmp
 *.o
 *.a
 mkmf.log
+
+.DS_Store

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ***
 
+Change log v.0.14.2
+
+**Dependencies**: updates to dependency version requirements.
+
+**Performance**: minor performance updates, i.e.: in the router, moved a `case` statement from the live (app is running) stage to the prep (app is initializing) stage and saved the `call` method extraction result for faster middleware mode performance.
+
+***
+
 Change log v.0.14.1
 
 **Update**: update due to Iodine's 0.2.1 version and the deprecation of the `uuid` method (replaced by `conn_id` to minimize collisions).

data/README.md

@@ -4,11 +4,11 @@
 [![Inline docs](http://inch-ci.org/github/boazsegev/plezi.svg?branch=master)](http://www.rubydoc.info/github/boazsegev/plezi/master/frames)
 [![GitHub](https://img.shields.io/badge/GitHub-Open%20Source-blue.svg)](https://github.com/boazsegev/plezi)
 
-Are microservices on your mind? Do you dream of a an SPA that's easy to scale? Did you wonder if you could write a whole Websockets, RESTful AJAX back-end with just a few lines of code (application logic not included)?
+Are microservices on your mind? Do you dream of a an SPA that's easy to scale? Did you wonder if you could write a whole Websockets, RESTful AJAX back-end with just a few lines of code (business logic not included)?
 
-Welcome to your new home with [plezi.io](http://www.plezi.io), the Ruby real-time framework that assumes the application's logic is *not* part of the web service.
+Welcome to your new home with [plezi.io](http://www.plezi.io), the Ruby real-time framework that assumes the business logic is *seperate* from the web service logic.
 
-**NOTICE**: Plezi 0.14.0 (this branch) is NOT an update, it's a total rewrite. Features were _removed_ as well as altered. For example, Plezi is now a Rack framework, with the limitations of CGI design and the advantages of using existing middleware. API changes abound.
+**NOTICE**: Plezi 0.14.x (this branch) is NOT an update, it's a total rewrite. Features were _removed_ as well as altered. For example, Plezi is now a Rack framework, with the limitations of CGI design and the advantages of using existing middleware. API changes abound.
 
 ## What does Plezi have to offer?
 
@@ -76,7 +76,7 @@ Or install it yourself as:
 
 ## Usage
 
-A new application:
+A new application (default applications include a simple chatroom demo):
 
      $  plezi new app_name
 
@@ -96,17 +96,16 @@ Plezi.route '*', HelloWorld
 exit # <= if running from terminal, this will start the server
 ```
 
-## Development
+## Documentation
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Plezi is fairly well documented.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Documentation is available both in the forms of tutorials and explanations available on the [plezi.io website](http://www.plezi.io) as well as through [the YARD documentation](http://www.rubydoc.info/gems/plezi).
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/boazsegev/plezi.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/plezi/api.rb

@@ -33,7 +33,7 @@ module Plezi
   def app
     no_autostart
     puts "Running Plezi version: #{::Plezi::VERSION}"
-    Plezi::Base::Router.method :call
+    Plezi::Base::Router.call_method
   end
 
   # Will add a route to the Plezi application.

data/lib/plezi/controller/controller.rb

@@ -166,25 +166,25 @@ module Plezi
     #         puts "#{from} is available"
     #       end
     #
-    # Methods invoked using {unicast}, {broadcast} or {multicast} will quitely fail if the connection was lost, the requested method is undefined or the 'target' was invalid.
+    # Methods invoked using {unicast}, {broadcast} or {multicast} will quietly fail if the connection was lost, the requested method is undefined or the 'target' was invalid.
     def unicast(target, event_method, *args)
       ::Plezi::Base::MessageDispatch.unicast(id ? self : self.class, target, event_method, args)
     end
 
-    # Invokes a method on every websocket connection that belongs to this Controller / Type. When using Iodine, the method is invoked asynchronously.
+    # Invokes a method on every websocket connection (except `self`) that belongs to this Controller / Type. When using Iodine, the method is invoked asynchronously.
     #
     #        self.broadcast :my_method, "argument 1", "argument 2", 3
     #
-    # Methods invoked using {unicast}, {broadcast} or {multicast} will quitely fail if the connection was lost, the requested method is undefined or the 'target' was invalid.
+    # Methods invoked using {unicast}, {broadcast} or {multicast} will quietly fail if the connection was lost, the requested method is undefined or the 'target' was invalid.
     def broadcast(event_method, *args)
       ::Plezi::Base::MessageDispatch.broadcast(id ? self : self.class, event_method, args)
     end
 
-    # Invokes a method on every websocket connection in the application.
+    # Invokes a method on every websocket connection in the application (except `self`).
     #
     #        self.multicast :my_method, "argument 1", "argument 2", 3
     #
-    # Methods invoked using {unicast}, {broadcast} or {multicast} will quitely fail if the connection was lost, the requested method is undefined or the 'target' was invalid.
+    # Methods invoked using {unicast}, {broadcast} or {multicast} will quietly fail if the connection was lost, the requested method is undefined or the 'target' was invalid.
     def multicast(event_method, *args)
       ::Plezi::Base::MessageDispatch.multicast(id ? self : self.class, event_method, args)
     end
@@ -239,7 +239,7 @@ module Plezi
     # @private
     # This function is used internally by Plezi, do not call.
     def _pl_ad_httpreview(data)
-      data = data.to_json if self.class._pl_is_ad? && data.is_a?(Hash)
+      return data.to_json if self.class._pl_is_ad? && data.is_a?(Hash)
       data
     end
 

data/lib/plezi/router/route.rb

@@ -22,7 +22,7 @@ module Plezi
         @controller = controller
         @param_names = []
         @origial = path.dup.freeze
-        path2regex(m[2])
+        prep_params(m[2])
         self.class.qp
         case @controller
         when Class
@@ -36,17 +36,8 @@ module Plezi
 
       def call(request, response)
         return nil unless match(request.path_info, request)
-        case @controller
-        when Class
-          c = @controller.new
-          return c._pl_respond(request, response, Thread.current[@route_id])
-        when Regexp
-          params = Thread.current[@route_id]
-          return nil unless controller =~ params[@param_names[0]]
-          request.path_info = "/#{params.delete('*'.freeze).to_a.join '/'}"
-          request.params.update params
-        end
-        nil
+        c = @controller.new
+        c._pl_respond(request, response, Thread.current[@route_id])
       end
 
       def fits_params(path, request)
@@ -70,7 +61,7 @@ module Plezi
         req_path.start_with?(@prefix) && fits_params(req_path, request)
       end
 
-      def path2regex(postfix)
+      def prep_params(postfix)
         pfa = postfix.split '/'.freeze
         start = 0; stop = 0
         optional = false
@@ -108,5 +99,15 @@ module Plezi
         @qp ||= ::Rack::QueryParser.new(Hash, 65_536, 100)
       end
     end
+    class RouteRewrite < Route
+      def call(request, _response)
+        return nil unless match(request.path_info, request)
+        params = Thread.current[@route_id]
+        return nil unless controller =~ params[@param_names[0]]
+        request.path_info = "/#{params.delete('*'.freeze).to_a.join '/'}"
+        request.params.update params
+        nil
+      end
+    end
   end
 end

data/lib/plezi/router/router.rb

@@ -13,8 +13,10 @@ module Plezi
       module_function
 
       def new(app)
-        puts 'Plezi as Middleware'
-        @app = ((app == Plezi.app) ? nil : app)
+        if app && app != call_method
+          puts 'Plezi as Middleware'
+          @app = app
+        end
         Plezi.app
       end
 
@@ -36,6 +38,11 @@ module Plezi
         return response.finish
       end
 
+      # returns the `call` method. Used repeatedly in middleware mode and only once in application mode.
+      def call_method
+        @call_method ||= Plezi::Base::Router.method(:call)
+      end
+
       def route(path, controller)
         path = path.chomp('/'.freeze) unless path == '/'.freeze
         case controller
@@ -46,6 +53,7 @@ module Plezi
           path << '/*'.freeze unless path[-1] == '*'.freeze
         when Regexp
           path << '/*'.freeze unless path[-1] == '*'.freeze
+          return @routes << RouteRewrite.new(path, controller)
         end
         @routes << Route.new(path, controller)
       end
@@ -111,7 +119,7 @@ module Plezi
         while names.any? && params[name[0]]
           url << "/#{Rack::Utils.escape params[names.shift]}"
         end
-        url = '/'.dup if url.empty?
+        url << '/'.freeze if url.empty?
         (url << '?') << Rack::Utils.build_nested_query(params) if params.any?
         url
       end

data/lib/plezi/version.rb

@@ -1,3 +1,3 @@
 module Plezi
-  VERSION = '0.14.1'.freeze
+  VERSION = '0.14.2'.freeze
 end

data/plezi.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'iodine', '~> 0.2.1'
+  spec.add_dependency 'iodine', '~> 0.2', '>= 0.2.1'
   # spec.add_dependency 'redcarpet', '> 3.3.0'
   # spec.add_dependency 'slim', '> 3.0.0'
 

metadata

@@ -1,20 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: plezi
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.14.2
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-29 00:00:00.000000000 Z
+date: 2016-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iodine
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.1
   type: :runtime
@@ -22,6 +25,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.1
 - !ruby/object:Gem::Dependency