skyline 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b25fcdb34d4247c357b5afe84c808c3c48d72b33
-  data.tar.gz: 8ddeac202861cadf9cabfca65cf05f9615f8600b
+  metadata.gz: 2b00ff6f35a17d706ed0a7f323bc732d9c6c4e6f
+  data.tar.gz: 85b6accc874c6d82e51eec06aa11f91f79cb2caa
 SHA512:
-  metadata.gz: 5c74c05ac8012b47e43d09d575114d8b733c75a98380a4093ae5806953929b3043b336987020979c4a75621cfd72ca75ecbaac66edac885ed30a6f0cb8f93b24
-  data.tar.gz: f813bd8323d5a9cc2a05f75ab51c0c8454b804ee5a9501ea33c98c7a3f2ee0f5e0467bc69ea22ec49cfe3292ae46a77b521ca6d0c9b8e7aa7ef23041d0fdfafe
+  metadata.gz: 1f4cafee8c8ba8049832a674817b195495a3b28b6b3fcf28cc593bdd4acbfb0244044769258dc01e4f72fa40122f5bb6ce6c5c6d7202b8bbba5fcfda636c60b8
+  data.tar.gz: 1ffb68c85be9dd95b16ed3018c5afed1542dd9a1b03846f70372e8587a63ea4000c0a19f9d336fdf3b0f384a3b00986da931d672d4b00635ce7eec6ce91caaa9

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 sickate
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -1,6 +1,5 @@
 # Skyline
-
-TODO: Write a gem description
+A minimal Event-Driven HTTP server which stolen from Cramp. (https://github.com/lifo/cramp)
 
 ## Installation
 
@@ -19,8 +18,7 @@ Or install it yourself as:
     $ gem install skyline
 
 ## Usage
-
-TODO: Write usage instructions here
+TODO
 
 ## Contributing
 

data/lib/skyline.rb

@@ -1,5 +1,33 @@
 require "skyline/version"
 
+require 'eventmachine'
+require 'active_support'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/class/attribute_accessors'
+require 'active_support/core_ext/module/aliasing'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/kernel/reporting'
+require 'active_support/concern'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/hash/except'
+require 'rack'
+require 'faye/websocket'
+
+EM.epoll
+
+begin
+  require 'fiber'
+  require File.join(File.dirname(__FILE__), 'fiber_pool')
+rescue LoadError
+  # No fibers available!
+end
+
 module Skyline
-  # Your code goes here...
+  mattr_accessor :logger
+
+  autoload :AbstractAction, 'skyline/action'
+  autoload :Body, 'skyline/body'
+  autoload :Callbacks, 'skyline/callbacks'
+  autoload :FiberPool, 'skyline/fiber_pool'
+  autoload :ExceptionHandler, 'skyline/exception_handler'
 end

data/lib/skyline/abstract_action.rb

@@ -0,0 +1,114 @@
+require 'active_support/core_ext/hash/keys'
+
+module Skyline
+  class AbstractAction
+    include Callbacks
+    include FiberPool
+
+    AsyncResponse = [-1, {}, []].freeze
+
+    class_attribute :transport
+    class_attribute :logger
+
+    self.transport = :regular
+
+    class << self
+      def call(env)
+        new(env).process
+      end
+    end
+
+    def initialize(env)
+      @env = env
+      @finished = false
+
+      @_state = :init
+    end
+
+    def process
+      EM.next_tick { before_start }
+      AsyncResponse
+    end
+
+    protected
+
+    def render(body, *args)
+      @body.call(body)
+    end
+
+    def encode(string, encoding = 'UTF-8')
+      string.respond_to?(:force_encoding) ? string.force_encoding(encoding) : string
+    end
+
+    def continue
+      init_async_body
+      send_headers
+
+      @_state = :started
+      EM.next_tick { on_start }
+    end
+
+    def send_headers
+      status, headers = build_headers
+      send_initial_response(status, headers, @body)
+    rescue StandardError, LoadError, SyntaxError => exception
+      handle_exception(exception)
+    end
+
+    def build_headers
+      status, headers = respond_to?(:respond_with, true) ? respond_with.dup : [200, {'Content-Type' => 'text/html'}]
+      headers['Connection'] ||= 'keep-alive'
+      [status, headers]
+    end
+
+    def init_async_body
+      @body = Body.new
+
+      if self.class.on_finish_callbacks.any?
+        @body.callback { on_finish }
+        @body.errback { on_finish }
+      end
+    end
+
+    def finished?
+      !!@finished
+    end
+
+    def finish
+      @_state = :finishing
+      @body.succeed if is_finishable?
+    ensure
+      @_state = :finished
+      @finished = true
+    end
+
+    def send_initial_response(response_status, response_headers, response_body)
+      send_response(response_status, response_headers, response_body)
+    end
+
+    def halt(status, headers = {}, halt_body = '')
+      send_response(status, headers, [halt_body])
+    end
+
+    def send_response(response_status, response_headers, response_body)
+      @env['async.callback'].call [response_status, response_headers, response_body]
+    end
+
+    def request
+      @request ||= Rack::Request.new(@env)
+    end
+
+    def params
+      @params ||= request.params.update(route_params).symbolize_keys
+    end
+
+    def route_params
+      @env['router.params'] || {}
+    end
+
+    def is_finishable?
+      !finished? && @body && !@body.closed?
+    end
+
+  end
+end

data/lib/skyline/body.rb

@@ -0,0 +1,46 @@
+module Skyline
+  class Body
+    include EventMachine::Deferrable
+
+    def initialize
+      @queue = []
+
+      # Make sure to flush out the queue before closing the connection
+      callback { flush }
+    end
+
+    def call(body)
+      @queue << body
+      schedule_dequeue
+    end
+
+    def each &blk
+      @body_callback = blk
+      schedule_dequeue
+    end
+
+    def closed?
+      @deferred_status != :unknown
+    end
+
+    def flush
+      return unless @body_callback
+
+      until @queue.empty?
+        Array(@queue.shift).each {|chunk| @body_callback.call(chunk) }
+      end
+    end
+
+    def schedule_dequeue
+      return unless @body_callback
+
+      EventMachine.next_tick do
+        next unless body = @queue.shift
+
+        Array(body).each {|chunk| @body_callback.call(chunk) }
+        schedule_dequeue unless @queue.empty?
+      end
+    end
+
+  end
+end

data/lib/skyline/callbacks.rb

@@ -0,0 +1,91 @@
+module Skyline
+  module Callbacks
+
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :before_start_callbacks, :on_finish_callbacks, :on_start_callback, :on_data_callbacks, :instance_reader => false
+
+      self.before_start_callbacks = []
+      self.on_finish_callbacks = []
+      self.on_start_callback = []
+      self.on_data_callbacks = []
+    end
+
+    module ClassMethods
+      def before_start(*methods)
+        self.before_start_callbacks += methods
+      end
+
+      def on_finish(*methods)
+        self.on_finish_callbacks += methods
+      end
+
+      def on_start(*methods)
+        self.on_start_callback += methods
+      end
+
+      def on_data(*methods)
+        self.on_data_callbacks += methods
+      end
+    end
+
+    def before_start(n = 0)
+      if callback = self.class.before_start_callbacks[n]
+        callback_wrapper { send(callback) { before_start(n+1) } }
+      else
+        continue
+      end
+    end
+
+    def on_start
+      callback_wrapper { start } if respond_to?(:start)
+
+      self.class.on_start_callback.each do |callback|
+        callback_wrapper { send(callback) unless @finished }
+      end
+    end
+
+    def on_finish
+      self.class.on_finish_callbacks.each do |callback|
+        callback_wrapper { send(callback) }
+      end
+    end
+
+    def callback_wrapper
+      EM.next_tick do
+        begin
+          yield
+        rescue StandardError, LoadError, SyntaxError => exception
+          handle_exception(exception)
+        end
+      end
+    end
+
+    protected
+
+    def _invoke_data_callbacks(message)
+      self.class.on_data_callbacks.each do |callback|
+        callback_wrapper { send(callback, message) }
+      end
+    end
+
+    def handle_exception(exception)
+      handler = ExceptionHandler.new(@env, exception)
+
+      # Log the exception
+      exception_body = handler.dump_exception
+      Skyline.logger ? Skyline.logger.error(exception_body) : $stderr.puts(exception_body)
+
+      case @_state
+      when :init
+        halt 500, {"Content-Type" => 'text/html'}, ENV['RACK_ENV'] == 'development' ? handler.pretty : 'Something went wrong'
+      when :started
+        halt 500, {"Content-Type" => 'text/html'}, ENV['RACK_ENV'] == 'development' ? handler.pretty : 'Something went wrong'
+      else
+        finish
+      end
+    end
+
+  end
+end

data/lib/skyline/exception_handler.rb

@@ -0,0 +1,25 @@
+module Skyline
+  class ExceptionHandler
+
+    attr_reader :env, :exception
+
+    def initialize(env, exception)
+      @env = env
+      @exception = exception
+    end
+
+    def dump_exception
+      string = "#{exception.class}: #{exception.message}\n"
+      string << exception.backtrace.map { |l| "\t#{l}" }.join("\n")
+      string
+    end
+
+    def pretty
+      dump_exception
+    end
+
+    def h
+      dump_exception
+    end
+  end
+end

data/lib/skyline/fiber_pool.rb

@@ -0,0 +1,47 @@
+module Skyline
+  module FiberPool
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :fiber_pool
+    end
+
+    module ClassMethods
+      def use_fiber_pool(options = {})
+        unless defined?(::FiberPool)
+          raise "Fiber support is only available for Rubies >= 1.9.2"
+        end
+
+        self.fiber_pool = ::FiberPool.new(options[:size] || 100)
+        yield self.fiber_pool if block_given?
+        include UsesFiberPool
+      end
+    end
+
+    module UsesFiberPool
+      # Overrides wrapper methods to run callbacks in a fiber
+
+      def callback_wrapper
+        self.fiber_pool.spawn do
+          begin
+            yield
+          rescue StandardError, LoadError, SyntaxError => exception
+            handle_exception(exception)
+          end
+        end
+      end
+
+      def timer_method_wrapper(method)
+        self.fiber_pool.spawn do
+          begin
+            send(method)
+          rescue StandardError, LoadError, SyntaxError => exception
+            handle_exception(exception)
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/skyline/version.rb

@@ -1,3 +1,3 @@
 module Skyline
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/vendor/fiber_pool.rb

@@ -0,0 +1,85 @@
+# Author::    Mohammad A. Ali  (mailto:oldmoe@gmail.com)
+# Copyright:: Copyright (c) 2008 eSpace, Inc.
+# License::   Distributes under the same terms as Ruby
+
+require 'fiber'
+
+class Fiber
+
+  #Attribute Reference--Returns the value of a fiber-local variable, using
+  #either a symbol or a string name. If the specified variable does not exist,
+  #returns nil.
+  def [](key)
+    local_fiber_variables[key]
+  end
+
+  #Attribute Assignment--Sets or creates the value of a fiber-local variable,
+  #using either a symbol or a string. See also Fiber#[].
+  def []=(key,value)
+    local_fiber_variables[key] = value
+  end
+
+  protected
+
+  def local_fiber_variables
+    @local_fiber_variables ||= {}
+  end
+end
+
+class FiberPool
+
+  # gives access to the currently free fibers
+  attr_reader :fibers
+  attr_reader :busy_fibers
+
+  # Code can register a proc with this FiberPool to be called
+  # every time a Fiber is finished.  Good for releasing resources
+  # like ActiveRecord database connections.
+  attr_accessor :generic_callbacks
+
+  # Prepare a list of fibers that are able to run different blocks of code
+  # every time. Once a fiber is done with its block, it attempts to fetch
+  # another one from the queue
+  def initialize(count = 100)
+    @fibers,@busy_fibers,@queue,@generic_callbacks = [],{},[],[]
+    count.times do |i|
+      fiber = Fiber.new do |block|
+        loop do
+          block.call
+
+          # callbacks are called in a reverse order, much like c++ destructor
+          Fiber.current[:callbacks].pop.call while Fiber.current[:callbacks].length > 0
+          generic_callbacks.each do |cb|
+            cb.call
+          end
+
+          if @queue.any?
+            block = @queue.shift
+          else
+            @busy_fibers.delete(Fiber.current.object_id)
+            @fibers.unshift Fiber.current
+            block = Fiber.yield
+          end
+
+        end
+      end
+      fiber[:callbacks] = []
+      fiber[:em_keys] = []
+      @fibers << fiber
+    end
+  end
+
+  # If there is an available fiber use it, otherwise, leave it to linger
+  # in a queue
+  def spawn(&block)
+    if fiber = @fibers.shift
+      fiber[:callbacks] = []
+      @busy_fibers[fiber.object_id] = fiber
+      fiber.resume(block)
+    else
+      @queue << block
+    end
+    self # we are keen on hiding our queue
+  end
+
+end

data/skyline.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skyline
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - sickcate
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: It's mainly stolen from Rack server "Cramp".
 email:
 - iamzhutuo@gmail.com
@@ -47,11 +61,17 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - lib/skyline.rb
+- lib/skyline/abstract_action.rb
+- lib/skyline/body.rb
+- lib/skyline/callbacks.rb
+- lib/skyline/exception_handler.rb
+- lib/skyline/fiber_pool.rb
 - lib/skyline/version.rb
+- lib/vendor/fiber_pool.rb
 - skyline.gemspec
 homepage: ''
 licenses:

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2015 sickcate
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.