fastr 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,6 +1,85 @@
 = fastr
 
-Description goes here.
+Micro web framework for Ruby. Should be used with an EventMachine rack server.
+
+== Getting Started
+
+  $ sudo gem install fastr
+  $ fastr init helloworld
+  $ cd helloworld
+  $ thin -p 5000 start
+
+== Directory Structure
+
+The directory structure is similar to rails:
+
+* app/(config/controller/views/models)
+* lib
+* test
+
+== Routes
+
+The routes are configured in app/config/routes.rb
+
+  router.draw do |route|
+  	route.for '/:controller/:action'
+  	#route.for '/home/:action', :action => '[A-Za-z]+'
+  	#route.for '/test', :to => 'home#index'
+  end
+  
+== Controller
+  
+  class HomeController < Fastr::Controller
+    def index
+      render(:text, "Hello, world!")
+    end
+  end
+
+== Return a view in a controller
+
+The return for a controller is just a rack response, i.e [200, {"Content-Type" => "text/plain"}, "Hello, World!"]
+
+You can also use the following render methods:
+
+  render(:text, "My text")
+  
+With HAML, the template is rendered and any instance variables in your controller are available in the template.
+
+  render(:haml, :template => "index") # this searches for index.haml in your app/views/ folder
+
+== Deferred Responses
+
+fastr also lets you return a deferred response. This is useful if you want to chunk the response back to the client, or have a long running operation that you want to perform without blocking EventMachine.
+
+The following is an example of a deferred response. It executes a sleep which normally would block EventMachine, but by using response.task, we tell EventMachine to run this code in its internal thread pool and when finished the callback is executed.
+
+The following is an example of a controller action.
+
+  def long_running_task
+    defer_response(200, {"Content-Type" => "text/plain"}) do |response|
+      puts "in our deferred response...now we can do cool stuff!"
+      response.send_data("hey\n")
+      
+      long_task = proc {
+        log.debug "Sleeping for 5 seconds...but this won't block other requests"
+        sleep(5)
+        log.debug "Finished sleeping, returning response to client."
+        return "finished"
+      }
+      
+      callback = proc { |result|
+        log.debug "Callback result: #{result}"
+        response.send_data("#{result}\n")
+        response.succeed
+      }
+      
+      response.task(long_task, callback)
+    end
+  end
+
+== Current Status
+
+Right now just the base is done. The controller supports a very basic render method.
 
 == Note on Patches/Pull Requests
  

data/bin/fastr

@@ -2,11 +2,6 @@
 
 require 'fileutils'
 
-if ARGV.size == 0
-  Fastr.usage
-  exit(0)
-end
-
 module Fastr
   def self.init_app(app_name)
     if File.directory? app_name
@@ -63,6 +58,11 @@ module Fastr
   end
 end
 
+if ARGV.size == 0
+  Fastr.usage
+  exit(0)
+end
+
 command = ARGV[0]
 
 if command == 'init' and ARGV.length == 2

data/lib/fastr.rb

@@ -7,4 +7,5 @@ module Fastr
   autoload :Error,            "#{ROOT}/fastr/exception"
   autoload :Controller,       "#{ROOT}/fastr/controller"
   autoload :Template,         "#{ROOT}/fastr/template"
+  autoload :Deferrable,       "#{ROOT}/fastr/deferrable"
 end

data/lib/fastr/application.rb

@@ -43,6 +43,7 @@ module Fastr
         log.info "Routing to controller: #{klass}, action: #{action}"
         
         obj = Module.const_get(klass).new
+        obj.env = env
         
         ret = obj.send(action)
         

data/lib/fastr/controller.rb

@@ -1,6 +1,12 @@
 module Fastr
   class Controller
+    attr_accessor :env
+    
     include Fastr::Template
+    include Fastr::Deferrable
     
+    def self.inherited(kls)
+      kls.instance_eval('include Fastr::Log')
+    end
   end
 end

data/lib/fastr/deferrable.rb

@@ -0,0 +1,34 @@
+module Fastr
+  module Deferrable
+    def defer_response(code, headers, &block)
+      response = DeferrableResponse.new
+      
+      EM.next_tick do
+        env['async.callback'].call([code, headers, response])
+        block.call(response)
+      end
+      
+      [-1, {}, []].freeze
+    end
+  end
+  
+  class DeferrableResponse
+    include EventMachine::Deferrable
+    
+    def send_data(data)
+      @callback.call(data)
+    end
+    
+    def task(operation, callback)
+      EM.defer(operation, callback)
+    end
+    
+    def finish
+      self.succeed
+    end
+    
+    def each(&cb)
+      @callback = cb
+    end
+  end
+end

data/lib/fastr/logger.rb

@@ -1,16 +1,25 @@
 require 'logger'
 
 module Fastr
-  module Log    
+  module Log   
     def self.included(kls)
-      logger = Logger.new(STDOUT)
-      logger.level = Logger::DEBUG
-      logger.formatter = Fastr::Log::Formatter.new(kls)
-      define_method :log do
-        logger
+      kls.instance_eval do
+        @logger = Logger.new(STDOUT)
+        @logger.level = Logger::DEBUG
+        @logger.formatter = Fastr::Log::Formatter.new(kls)
+        
+        def logger
+          @logger
+        end
+      end
+      
+      kls.class_eval do
+        def log
+          self.class.logger
+        end
       end
     end
-        
+
     class Formatter < Logger::Formatter
       attr_accessor :progname
       

data/lib/fastr/template.rb

@@ -36,9 +36,8 @@ module Fastr
         haml_engine = Haml::Engine.new(tpl_data)
         @@tpl_cache[tpl] = haml_engine
       end
-      
-      
-      resp = haml_engine.render
+
+      resp = haml_engine.render(self)
       
       [200, {"Content-Type" => "text/html"}, resp]
     end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: fastr
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Chris Moos
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-19 00:00:00 -07:00
+date: 2010-06-08 00:00:00 -07:00
 default_executable: fastr
 dependencies: []
 
@@ -31,12 +32,16 @@ files:
 - lib/fastr.rb
 - lib/fastr/application.rb
 - lib/fastr/controller.rb
+- lib/fastr/deferrable.rb
 - lib/fastr/exception.rb
 - lib/fastr/logger.rb
 - lib/fastr/router.rb
 - lib/fastr/template.rb
 - LICENSE
 - README.rdoc
+- test/helper.rb
+- test/test_fastr.rb
+- bin/fastr
 has_rdoc: true
 homepage: http://github.com/chrismoos/fastr
 licenses: []
@@ -47,23 +52,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Another rack web framework for Ruby.