swee 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6d3fb00b524dff4a95f163d99ce8de1499007de
+  data.tar.gz: 64cf3eb2bfe632c48dcf730daf801516590cdfbc
+SHA512:
+  metadata.gz: 1d61382816067f99614e37f005f91df500e50381323de38e8c469157b05d809ab01d8f62e61d8f0bf636d6b702ac8f3c4686c88a9bfe21dbe7ed15c3a60fd537
+  data.tar.gz: af69221ebecf0aec1211765ec80ec7bfc782c2f2f64e6367e7bfff21316a68c46e65b1693e2f34b39af276aca84c0b2d3cf5767103cdcc1acac38710dbfba8a9

data/README.md

@@ -0,0 +1,212 @@
+# Swee
+
+Swee 是一个轻量级的 ruby web 框架, 包含一个http服务器。
+目前还是demo阶段, 供学习和参考使用
+
+## 特性 和 实现方式
+
+1. 底层接受http请求 基于 EventMachine 的 event loop
+2. 内部一些特性都是基于 event loop 如: 服务器重启, 以及代码reload等特性
+3. 处理请求并包装为 request 结构暂时使用的是 Thin 的 http_parser
+4. 应用层轻量级包装 实现 route 和 controller 目前支持 rails 的一些特性
+5. 使用部分 rack 的 middlewaves 和 一些自己实现的 middlewaves
+
+## 安装
+
+请使用ruby2.1.0或以上版本, 然后安装 swee 的Gem
+
+```ruby
+gem 'swee'
+```
+
+## 使用方法
+
+生成项目
+生成以后会创建一个项目目录和一些项目必须的文件
+随后会贴心的自动开启一个服务器
+打开您最喜欢的浏览器输入 http://localhost:3000
+可以看到一个 hello 的欢迎页面
+
+```console
+swee new myproj
+```
+
+运行swee命令行
+
+```console
+swee c
+```
+
+启动服务器
+
+```console
+swee s
+```
+
+端口和环境参数
+
+```console
+swee s -p 8080 -e production
+```
+
+## 配置服务器
+
+打开项目下的 config.rb 并配置它
+
+先配置 server_config 部分
+
+配置日志文件格式: [日志文件位置,文件保留数量,每个文件的大小]
+```ruby
+  cfg.log_file     = [ "./logs/development.log", 10, 10240000 ]
+```
+
+配置日志等级
+```ruby
+  cfg.logger_level = :debug
+```
+
+配置重启模式
+:touch => 请配置 touch_file, 并指定 restart.txt 文件位置
+:pid   => 请配置 pid_file, 并制定 pid 文件位置
+```ruby
+  cfg.restart_mode = :touch
+  cfg.touch_file   = "./tmp/restart.txt"
+  cfg.pid_file     = "./tmp/pid"
+```
+
+是否改变代码立刻reload(重载)
+```ruby
+  cfg.code_reload  = true
+```
+
+最大连接数
+```ruby
+  cfg.max_connections = 1024
+```
+
+是否后台运行(守护进程模式)
+```ruby
+  cfg.run_background = false
+```
+
+重启服务器
+仅支持后台运行的服务器
+
+touch 方式
+```console
+  touch tmp/restart.txt
+```
+
+pid 方式
+```console
+  kill -USR2 `cat tmp/pid`
+```
+
+## 配置路由
+暂时支持 rails 方式的路由 path_info 映射为 controller#action
+
+打开项目下的 routes.rb 并配置它
+
+get 请求路径为/, 对应 controllers 目录下的 HomeController 已经 index 方法 (rails里的action)
+
+```ruby
+  get "/", "home#index"
+```
+
+post 请求路径为/items/buy, 对应 controllers 目录下的 ItemsController 已经 buy 方法 (rails里的action)
+
+```ruby
+  post "/items/buy", "items#buy"
+```
+
+match 请求路径为/items, 对应 controllers 目录下的 ItemsController 已经 new 方法 (rails里的action)
+via 配置为 请求方法, 目前可用 :get, :post 两种
+```ruby
+  match "/items", "items#new", via: [:get, :post]
+```
+
+## controller 特性
+
+过滤器
+支持 rails 方式的过滤器
+before_filter, after_filter 和 round_filter
+接受参数类型  :only 和 :except
+
+```ruby
+  before_filter :set_variable, :only => [:index]
+  before_filter :set_variable, :except => [:index,:create]
+  round_filter  :set_variable, :only => [:index]
+```
+
+request 方法
+会获取一个 对浏览器请求的request包装对象
+```ruby
+  request.url
+  request.method
+  ....
+```
+params 方法
+得到一个 Hash 对象,包含请求的参数以 和 controller , action 参数
+```ruby
+  params[:controller]
+  params[:action]
+  ....
+```
+
+render 方法
+支持 rails 的 render 方式
+
+render方法(可省略)
+默认会寻找当前 controller#action 所对应寻找好 views目录下 controller 目录 action 的erb文件
+
+渲染一个text文本
+```ruby
+  render :text => "foobar"
+```
+
+渲染一个json
+```ruby
+  render :json => { foo: "bar" }
+```
+
+## 关于 Gemfile
+
+关于 Gemfile
+
+用户可以自行安装所需的gem
+
+先安装 bundler
+
+```ruby
+  gem install bundler
+```
+然后在项目目录下创建一个 Gemfile
+
+添加您所需要的 gem 然后执行
+
+```ruby
+  bundle install
+```
+
+## 关于model 和 数据库
+
+当前版本还未完成 model 的封装
+暂时推荐用户自己选择, 推荐使用 active_record 或者 mongoid
+自行添加对应的gem 到 Gemfile 中
+
+## 测试
+
+执行 rspec 测试
+暂时测试覆盖不全
+
+```ruby
+  rspec spec/*
+```
+
+## 贡献代码
+
+1. Fork it ( https://github.com/[my-github-username]/swee/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new

data/bin/swee

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+# argv = ARGV
+
+# _cmd  = argv.shift
+
+# # 简单解析命令行参数 启动服务 和 设置环境
+
+# ENV["start_port"] = "3000"
+# ENV["app_env"] = "development"
+
+# case _cmd
+# when "s"
+#   while !argv.empty?
+#     _cmd = argv.shift
+#     s = argv.shift
+#     raise "命令#{_cmd}缺少参数" if s.nil?
+#     case _cmd
+#     when "-p"
+#       ENV["start_port"] = s if s =~ /[0-9]+/
+#     when "-e"
+#       ENV["app_env"] = s if s =~ /[a-z]+/
+#     end
+#   end
+#   require 'swee'
+#   Swee::Server.boot!
+# when "c"
+#   require 'irb'
+#   require 'swee'
+
+#   IRB.start
+# else
+#   p "help"
+# end
+
+require 'swee'
+
+Swee::Engine.boot! ARGV

data/doc/tmp.rb

@@ -0,0 +1,77 @@
+
+    # attr_accessor :config
+    # def initialize
+    #   @port,@env = ENV["start_port"], ENV["app_env"]
+    #   @config = Swee::Application.config
+    #   @middlewares = []
+    # end
+
+    # def use(middleware_class,*options, &block)
+    #   @middlewares << lambda {|app| middleware_class.new(app,*options, &block)}
+    # end
+
+    # def use_lambda _lambda
+    #   @middlewares << _lambda
+    # end
+
+    # def run(app)
+    #   @app = app
+    # end
+
+    # def to_app
+    #   @middlewares.reverse.inject(@app) { |app, middleware| middleware.call(app)}
+    # end
+
+    # def load_default_middlewares
+    #   use Rack::ContentLength
+    #   # use Rack::ContentType,"text/plain"
+    #   use Rack::CommonLogger, $stder   # => 记录日志
+
+    #   use Rack::Chunked                # => 分块传输 (很多服务器自动use了该中间件)
+
+    #   use Rack::ConditionalGet         # => get资源缓存控制
+    #   # use Rack::Etag                   # => 判断计算url对象是否改变 和 ConditionalGet 中间件一起使用
+    #   use Rack::Deflater               # => http 传输内容编码(压缩)
+
+    #   # use Rack::Head                 # => RFC2616要求HEAD请求的响应体必须为空这就是Rack::HEAD所做的事情
+
+    #   use Rack::MethodOverride         # => 用 post 模拟 put 和 delete
+    #                                    # => 需要表单中加入了一个隐含字段“_method” 把它的值设为“put 或 delete“
+    #   # use Rack::Lint                 # => 检查请求和响应是否符合Rack规格
+
+    #   use Rack::Reloader, 2            # => 开发环境用 修改代码不重启服务器
+    #   # use Rack::Runtime              # => header中加入一个 请求的处理时间 X-Runtime
+
+    #   # use Rack::Sendfile               # => 传送文件
+
+    #   # apps = [lambda {|env| [404, {}, ["File doesn't exists"]]}, lambda {|env| [200, {}, ["I'm ok"]]}]
+    #   # use Rack::Cascade                # => 挂载多个应用程序 它会尝试所有这些应用程序，直到某一个应用程序返回的代码不是404
+
+    #   # use Rack::Lock                   # => 不支持多线程框架 将互锁 
+
+    #   # use Rack::Session::Cookie, :key => 'rack.session',       # => key, 缺省为 rack.session
+    #   #                            :domain => 'example.com',     # => 域名
+    #   #                            :path => '/',                 # => 路径
+    #   #                            :expire_after => 2592000,     # => 过期时间
+    #   #                            :secret => 'any_secret_key'   # => cookie 加密
+      
+    #   # default_options = {
+    #   #   :path => '/',
+    #   #   :domain => nil,
+    #   #   :expire_after => nil,
+    #   #   :secure => false,
+    #   #   :httponly => true,
+    #   #   :defer => false,       # => 如果设置defer为true,那么响应头中将不会设置cookie(暂时还不知道有什么用处)
+    #   #   :renew => false,       # => 如果设置此选项为true,那么在具体的会话管理实现中不应该把原先客户端通过请求发送的session_id,
+    #   #                          # => 而是每次生成一个新的session_id,并把原先session_id对应的会话数据和这个新的session_id对应。
+    #   #                          # 注意renew的优先级高于defer,也就是即使defer设置为true,
+    #   #                          # 只要设置了renew为true,那么cookie也会被写入到响应头中
+    #   #   :sidbits => 128        # => 生成的session_id长度为多少个bit, ID类提供了一个实用的generate_sid方法可以供你的具体实现使用
+    #   # }
+    #   # use Rack::Session::Abstract::ID,default_options
+
+    #   # default_options = Rack::Session::Abstract::ID::DEFAULT_OPTIONS.merge ({ 
+    #   #   :namespace => 'rack:session', :memcache_server => 'localhost:11211'
+    #   # })
+    #   # use Rack::Session::Memcache, DEFAULT_OPTIONS
+    # end

data/lib/swee.rb

@@ -0,0 +1,5 @@
+require "swee/version"
+require "swee/engine"
+
+# module Swee
+# end

data/lib/swee/app_executor.rb

@@ -0,0 +1,152 @@
+module Swee
+  class AppExecutor
+
+    class << self
+      # 启动 app 渲染器
+      # app_path 转路由
+      # 执行 app controller 方法
+      # 渲染 filter (:before, :after, :round)
+      # 生成 View
+      def run env
+        route = path_to_route(env)
+        request_method = env["REQUEST_METHOD"].downcase.to_sym
+        if route.nil? || !route.request_methods.include?(request_method)
+          return View.render_404
+        end
+        controller_intance = route_to_controller route, env
+        render_view controller_intance, route
+      end
+
+      # app_path转路由
+      # 获取 路由结构
+      def path_to_route env
+        _path_info = env["PATH_INFO"]
+        Routes.tables[_path_info.to_s]
+      end
+
+      # 执行 app controller 方法
+      def route_to_controller route, env
+        controller = route.controller
+        controller_intance = route.create_controller_instance
+        controller_intance.warp_request env,route
+        controller_intance
+      end
+
+      # 渲染视图
+      # 渲染 -> 前置 后置 环绕控制器
+      def render_view controller_intance, route
+        execute_before_filter controller_intance, route
+        result = execute_controller controller_intance, route.action
+        execute_after_filter controller_intance, route
+        return !rack_responsed?(result) ? controller_intance.render : result
+      end
+
+      # 执行前置过滤器
+      def execute_before_filter controller_intance,route
+        execute_filter :before, controller_intance, route
+      end
+
+      # 执行后置过滤器
+      def execute_after_filter controller_intance,route
+        execute_filter :after, controller_intance, route
+      end
+
+      # 执行控制器
+      def execute_controller controller_intance,action
+        result = controller_intance.send(action)
+        result.freeze
+        result
+      end
+
+      # 执行过滤器
+      def execute_filter _type, controller_intance,route
+        _filter_actions = Controller.find_filter_methods route.controller_name,_type,route.action
+        _filter_actions.each do |_action|
+          controller_intance.send _action
+        end
+      end
+
+      # 检测是否为 rack 格式得响应
+      # rack标准格式: [status,headers,[body]]
+      def rack_responsed? result
+        if result.is_a?(Array) && result.size == 3
+           status =  result[0]
+          headers =  result[1]
+             body =  result[2]
+          if status.is_a?(Integer) && headers.is_a?(Hash) && body.respond_to?(:each)
+            return true
+          end
+        end
+        return false
+      end
+    end
+
+    DEFAULT_THTEADS = 20
+
+    # TODO: 多线程处理控制器和路由
+    class ExeThread
+      DEFAULT_SLEEP = 0.5
+      @t = nil
+      def initialize
+        @mission_queue = []
+      end
+
+      def run
+        while true
+          if @mission_queue.empty?
+            wait
+          else
+            @mission_queue.shift.call()
+          end
+        end
+      end
+
+      def create!
+        @t = Thread.new { run }
+      end
+
+      def busy?
+        !@mission_queue.empty?
+      end
+
+      def << mission
+        @mission_queue << mission
+        create! if @t.dead?
+      end
+
+      def wait
+        sleep DEFAULT_SLEEP
+      end
+    end
+
+    def initialize
+      @queue = []
+      @threadpoll = Array.new
+      DEFAULT_THTEADS.times do
+        @threadpoll << ExeThread.new
+      end
+    end
+
+    def current_thread
+      _current_thread = @threadpoll.select { |t| !t.busy? }
+    end
+
+    def run
+      f = Fiber.new do
+        while true
+          Fiber.yield
+        end
+      end
+    end
+
+    def wait
+      while exist_alive_thread?
+        sleep 0.1
+      end
+    end
+
+    def <<()
+      @queue.push()
+    end
+  end
+end