em-midori 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d890861f5486fd8c8ecd3dff2a3780a26af42340
-  data.tar.gz: 1d6ddf047c3534998eb6637cfbe387d56f1e86f2
+  metadata.gz: e5a62c03f0e31bd0ea7466d2ddda81f2fbdd8efd
+  data.tar.gz: c16d4d64ce2fd066ccd7bef0546bd07a816a7ac0
 SHA512:
-  metadata.gz: 2664bb10cda5ab00f264bd91e633315ab2f05fb44218050597fc61c34890fa00bf042d3a476e24711415b9eb8d28e2a4b94f2225bb307f1f1e77c1fffde468d6
-  data.tar.gz: 884cce78c3c28f9014823b45d03529082d7ff4c6832be0bfaa490265a08a7a05ad2b3ed7d5447074edbb6d3e06d32a0006004116afece1b442511f417583d33e
+  metadata.gz: d8c6e274f821b8f2f4f3ef746e98b1b5efe2d1774d67a55e7083271ab5fb51928e71cdb2df4f19fe2a7e5d7ac62293ce728525b87b3d76ff2ac37e4f6b95d18c
+  data.tar.gz: ce6a571451d2a7647872135c2546fc097fb86667b4888b5ddfe6cd54374989964bcc5530c58d8466401956ed4959bba6634bbb298b32ce63cedf88b852f63c78

data/lib/midori/api.rb

@@ -303,6 +303,7 @@ class Midori::API
 
     # Add EVENTSOURCE method as a DSL for route definition
     # @param [String] path Accepts as part of path in route definition
+    # @yield what to run when route matched
     # @return [nil] nil
     # @example String as router
     #   eventsource '/' do

data/lib/midori/connection.rb

@@ -1,8 +1,14 @@
+##
+# States of a connection
 class Midori::Connection
   include Midori::Server
 
+  # @!attribute data
+  #   @return [String] string buffer of data to send
   attr_accessor :data
 
+  # Init Connection with socket
+  # @param [IO] socket raw socket
   def initialize(socket)
     @registered = false
     @socket = socket
@@ -12,6 +18,8 @@ class Midori::Connection
     listen(socket)
   end
 
+  # Register events of connection
+  # @param [IO] socket raw socket
   def listen(socket)
     EventLoop.register(socket, :rw) do |monitor|
       @monitor = monitor
@@ -32,18 +40,20 @@ class Midori::Connection
     end
   end
 
+  # Send message to client
+  # @param [String] data data to send
   def send_data(data)
     @monitor.writable? ? @socket.write_nonblock(data) : @data << data
   end
 
+  # Close the connection
   def close_connection
     EventLoop.deregister @socket
     @socket.close
-  rescue Errno::EBADF
-    # Connection finished in advance
   end
 
+  # Close the connection after writing
   def close_connection_after_writing
     @close_flag = true
   end
-end
+end

data/lib/midori/const.rb

@@ -85,6 +85,7 @@ module Midori::Const
     'Connection' => 'Upgrade'
   }
 
+  # Array of Route Methods
   ROUTE_METHODS = %i(
     DELETE
     GET

data/lib/midori/core_ext/configurable.rb

@@ -6,6 +6,7 @@ module Configurable
   # @param [Symbol] option the name of config
   # @param [Object] value value to the name
   # @param [Boolean] read_only Generate option= method or not
+  # @return [nil] nil
   def set(option, value = (not_set = true), read_only = false)
     raise ArgumentError if not_set
 
@@ -22,6 +23,9 @@ module Configurable
   private
 
   # Dynamically defines a method on settings.
+  # @param [String] name method name
+  # @param [Proc] content method content
+  # @return [nil] nil
   def define_singleton(name, content = Proc.new)
     singleton_class.class_eval do
       undef_method(name) if method_defined? name

data/lib/midori/core_ext/event_loop.rb

@@ -1,59 +1,75 @@
-require 'timeout'
-
+##
+# EventLoop Module, providing main loop for events
 module EventLoop
   class << self
+    # Raw NIO Selector
     SELECTOR = NIO::Selector.new
+    # Array of active timers
     TIMERS = []
+    # Hash of io and its callback
     IOS = Hash.new
+    # IO queue
     QUEUE = Hash.new
 
+    # Add timer in event loop
+    # @param [EventLoop::Timer] timer timer to insert
+    # @return [nil] nil
     def add_timer(timer)
       timer.start_time = Time.now.to_f + timer.time
       TIMERS << timer
+      nil
     end
 
-    def register(io, interest=(:rw), timeout=nil, resolve=nil, &callback)
+    # Register I/O event with queue protection
+    # @param [IO] io io to register
+    # @param [Symbol] interest :r for read only, :w for write only, and :rw for both
+    # @yield what to run when io callbacks
+    # @return [nil] nil
+    def register(io, interest=(:rw), &callback)
       if QUEUE[io.to_i].nil?
         QUEUE[io.to_i] = Array.new
-        register_raw(io, interest, timeout, resolve, callback)
+        register_raw(io, interest, callback)
       else
-        QUEUE[io.to_i] << [io, interest, timeout, resolve, callback]
+        QUEUE[io.to_i] << [io, interest, callback]
       end
+      nil
     end
 
-    def register_raw(io, interest=(:rw), timeout=nil, resolve=nil, callback)
+    # Register I/O event directly, without any queue protection
+    # @param [IO] io io to register
+    # @param [Symbol] interest :r for read only, :w for write only, and :rw for both
+    # @param [Proc] callback what to run when io callbacks
+    # @return [nil] nil
+    def register_raw(io, interest=(:rw), callback)
       SELECTOR.register(io, interest)
-      timer = nil
-      unless timeout.nil?
-        timer = EventLoop::Timer.new(timeout) do
-          EventLoop.deregister(io)
-          resolve.call(TimeoutError) unless resolve.nil?
-        end
-        EventLoop.add_timer(timer)
-      end
-
-      IOS[io] = {
-          timer: timer ? timer : nil,
-          callback: callback,
-      }
+      IOS[io] = { callback: callback }
+      nil
     end
 
+    # Deregister I/O event
+    # @param [IO] io io to deregister
+    # @return [nil] nil
     def deregister(io)
       fd = io.to_i
       SELECTOR.deregister(io)
       IOS.delete(io)
       next_register = QUEUE[fd].shift
       next_register.nil? ? QUEUE.delete(fd) : register_raw(*next_register)
+      nil
     end
 
+    # Run I/O selector once
+    # @return [nil] nil
     def run_once
       SELECTOR.select(0.2) do |monitor| # Timeout for 0.2 secs
-        TIMERS.delete(IOS[monitor.io][:timer]) unless IOS[monitor.io][:timer].nil?
         IOS[monitor.io][:callback].call(monitor)
       end
       EventLoop.timer_once
+      nil
     end
 
+    # Run timer once
+    # @return [nil] nil
     def timer_once
       now_time = Time.now.to_f
       TIMERS.delete_if do |timer|
@@ -62,8 +78,11 @@ module EventLoop
           true
         end
       end
+      nil
     end
 
+    # Start the event loop
+    # @return [nil] nil
     def start
       return if running?
       @stop = false
@@ -73,10 +92,15 @@ module EventLoop
       @stop = nil
     end
 
+    # Set the stop flag
+    # @return [nil] nil
     def stop
       @stop = true
+      nil
     end
 
+    # Detect the stop flag
+    # @return [Boolean] return if eventloop is set to be stopped
     def running?
       @stop = true if @stop.nil?
       !@stop

data/lib/midori/core_ext/promise.rb

@@ -17,6 +17,8 @@ class Promise
 end
 
 module Kernel
+  # Make fiber as async chain
+  # @param [Fiber] fiber root of async chain
   def async_fiber(fiber)
     chain = proc do |result|
       next unless result.is_a? Promise
@@ -53,9 +55,16 @@ module Kernel
   end
 end
 
+
+##
+# Exceptions for Promises
+# @!attribute [r] payload
+#   @return [Exception] raw execption
 class PromiseException < Exception
   attr_reader :payload
+  # Init PromiseException with existed Exception
+  # @param [Exception] payload raw execption
   def initialize(payload)
     @payload = payload
   end
-end
+end

data/lib/midori/core_ext/safe_require.rb

@@ -2,6 +2,7 @@ module Kernel
   # Raise error if Load Failed
   # @param [String] file file to Load
   # @param [String] prompt To prompt what when load error
+  # @return [Boolean] whether it has been required already
   def safe_require(file, prompt)
     begin
       require file

data/lib/midori/core_ext/timer.rb

@@ -1,10 +1,22 @@
+##
+# Timer Object in EventLoop
+# @!attribute [r] time
+#   @return [Float] timeout length
+# @!attribute [r] callback
+#   @return [Proc] proc to call when callbacks
+# @!attribute start_time
+#   @return [Float] when timer should callbacks
 class EventLoop::Timer
-  attr_reader :time, :start_time, :callback
+
+  attr_reader :time, :callback
   attr_accessor :start_time
 
+  # Init a timer with a time period and callback
+  # @param [Float] time timeout length
+  # @yield proc to call when callbacks
   def initialize(time, &callback)
     @time = time
     @callback = callback
     @start_time = Float::INFINITY
   end
-end
+end

data/lib/midori/extension/file.rb

@@ -1,8 +1,14 @@
+##
+# Midori Extension of File reading and writing
 class Midori::File
+  # Init File object
+  # @param [Array] args same args like File.new
   def initialize(*args)
     @file = File.new(*args)
   end
 
+  # read file
+  # @return [String] string readed
   def read
     await(Promise.new do |resolve|
       data = ''
@@ -17,6 +23,8 @@ class Midori::File
     end)
   end
 
+  # write file
+  # @param [String] data string to be written
   def write(data)
     await(Promise.new do |resolve|
       written = 0
@@ -30,11 +38,14 @@ class Midori::File
     end)
   end
 
+  # raw file object
+  # @return [File] file
   def raw
     @file
   end
 
+  # Close the file
   def close
     @file.close
   end
-end
+end

data/lib/midori/extension/hiredis.rb

@@ -1,15 +1,25 @@
+##
+# Meta-programming hiredis for redis async extension
 module Hiredis
   require 'hiredis/connection'
   # Overwrite with ruby implementation to hook IO
   require 'hiredis/ruby/connection'
   require 'hiredis/ruby/reader'
+  # Redis Connection
   Connection = Ruby::Connection
+  # Redis Result Reader
   Reader = Ruby::Reader
-end
 
-module Hiredis
+  ##
+  # Meta-programming hiredis for redis async extension
   module Ruby
+    ##
+    # Meta-programming hiredis for redis async extension
     class Connection
+      # write message directly
+      # @param [IO] _sock raw socket
+      # @param [String] data generated string data
+      # @param [Float] _timeout operation timeout
       def _write(_sock, data, _timeout)
         await(Promise.new do |resolve|
           data.force_encoding('binary') if data.respond_to?(:force_encoding)
@@ -24,6 +34,8 @@ module Hiredis
         end)
       end
 
+      # read from redis socket
+      # @return [String] reply
       def read
         raise 'not connected' unless connected?
         await(Promise.new do |resolve|
@@ -44,4 +56,4 @@ module Hiredis
       end
     end
   end
-end
+end

data/lib/midori/extension/net.rb

@@ -1,6 +1,10 @@
 require 'net/protocol'
 
+##
+# Meta programming Net class for async HTTP and FTP connection
 class Net::BufferedIO
+  # Wait till io finishes
+  # @param [Symbol] interest
   def wait_io(interest)
     await(Promise.new do |resolve|
       io = @io.to_io
@@ -11,6 +15,7 @@ class Net::BufferedIO
     end)
   end
 
+  # Fill until the operation finishes
   def rbuf_fill
     loop do
       case rv = @io.read_nonblock(BUFSIZE, exception: false)
@@ -34,4 +39,4 @@ class Net::BufferedIO
       end
     end
   end
-end
+end

data/lib/midori/extension/sequel/mysql2.rb

@@ -1,14 +1,23 @@
 safe_require 'sequel', 'gem install sequel'
 require 'sequel/adapters/mysql2'
 
+# Management of MySQL Sockets
 MYSQL_SOCKETS = {}
 
+##
+# Meta-programming Sequel for async extensions
 module Sequel
+  # Midori Extension of sequel MySQL through meta programming
   module Mysql2
+    # Midori Extension of sequel MySQL through meta programming
     class Database
       # Execute the given SQL on the given connection.  If the :type
       # option is :select, yield the result of the query, otherwise
       # yield the connection if a block is given.
+      # @param [Mysql2::Client] conn connection to database
+      # @param [String] sql sql query
+      # @param [Hash] opts optional options
+      # @return [Mysql2::Result] MySQL results
       def _execute(conn, sql, opts) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
         begin
           # :nocov:
@@ -44,15 +53,15 @@ module Sequel
               socket = MYSQL_SOCKETS[conn.socket]
               await(Promise.new do |resolve|
                 count = 0
-                EventLoop.register(socket, :rw, 2, resolve) do
+                EventLoop.register(socket, :rw) do
                   if (count == 0)
                     # Writable
                     count += 1
                     conn.query(sql,
-                               database_timezone: timezone,
-                               application_timezone: Sequel.application_timezone,
-                               stream: stream,
-                               async: true)
+                              database_timezone: timezone,
+                              application_timezone: Sequel.application_timezone,
+                              stream: stream,
+                              async: true)
                   else
                     # Readable
                     begin

data/lib/midori/extension/sequel/postgres.rb

@@ -1,6 +1,7 @@
 safe_require 'sequel', 'gem install sequel'
 require 'sequel/adapters/postgres'
 
+# Management of Postgres Sockets
 POSTGRES_SOCKETS = {}
 
 ##
@@ -11,31 +12,31 @@ class Sequel::Postgres::Adapter
   # @param [Array] args args to send
   # @return [Array] sql query result
   def execute_query(sql, args)
-      @db.log_connection_yield(sql, self, args) do
-        if POSTGRES_SOCKETS[self].nil?
-          POSTGRES_SOCKETS[self] = IO::open(socket)
-        end
-        socket_object = POSTGRES_SOCKETS[self]
-        result = await(Promise.new do |resolve|
-          count = 0
-          EventLoop.register(socket_object, :rw) do
-            begin
-              if (count == 0)
-                # Writable
-                unless is_busy
-                  send_query(sql)
-                  count += 1
-                end
-              else
-                # Readable
-                EventLoop.deregister(socket_object)
-                resolve.call(get_result)
+    @db.log_connection_yield(sql, self, args) do
+      if POSTGRES_SOCKETS[self].nil?
+        POSTGRES_SOCKETS[self] = IO::open(socket)
+      end
+      socket_object = POSTGRES_SOCKETS[self]
+      await(Promise.new do |resolve|
+        count = 0
+        EventLoop.register(socket_object, :rw) do
+          begin
+            if (count == 0)
+              # Writable
+              unless is_busy
+                send_query(sql)
+                count += 1
               end
-            rescue => e
-              resolve.call(PromiseException.new(e))
+            else
+              # Readable
+              EventLoop.deregister(socket_object)
+              resolve.call(get_result)
             end
+          rescue => e
+            resolve.call(PromiseException.new(e))
           end
-        end)
-      end
+        end
+      end)
+    end
   end
 end

data/lib/midori/version.rb

@@ -1,5 +1,5 @@
 # Midori Module
 module Midori
   # Current Version Code
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

data/tutorial/README.md

@@ -8,4 +8,4 @@ If you want to know how midori compares to other libraries/frameworks, checkout
 
 ## Note
 
-The official guide assumes intermediate level knowledge of Ruby and backend development. If you are totally new , it might not be the best idea to jump right into a framework as your first step - grasp the basics then come back! Prior experience with other frameworks like Rails helps, but is not required.
+The official guide assumes intermediate level knowledge of Ruby and backend development. If you are totally new , it might not be the best idea to jump right into a framework as your first step - grasp the basics then come back! Prior experience with other frameworks like Rails helps, but is not required.

data/tutorial/SUMMARY.md

@@ -25,4 +25,4 @@
 
 - [Comparison with Other Frameworks](meta/comparison_with_other_frameworks.md)
 - [Next Steps](meta/next_steps.md)
-- [Join the Midori Community](meta/join_the_midori_community.md)
+- [Join the Midori Community](meta/join_the_midori_community.md)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: em-midori
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - HeckPsi Lab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-01 00:00:00.000000000 Z
+date: 2017-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r