track 0.0.2 → 0.1.0

data/README.md

@@ -1,3 +1,73 @@
 # Track
 
-A nano framework for server applications based on rack and ruby 1.9
+A nano framework for server applications based on rack and ruby 1.9 named capture groups.
+
+## What Track does
+
+- modularize your rack app through controllers
+- routes paths to methods inside of your controllers via the `route` method
+- define before filters via the `pre` method
+
+## What Track does *not*
+
+- support any template engines, your actions have to return low level rack responses
+- support any ORM framework
+
+## Install
+
+add the following to your Gemfile
+
+`gem 'track'`
+
+or install it via rubygems
+
+`gem install track`
+
+## Usage
+
+Subclass the `Track::Controller` class to define controllers:
+
+### Example
+
+```ruby
+class UsersController < Track::Controller
+
+  route '/',                      :index, :get
+  route '/show/:id',              :show,  :get
+  route '/update/(?<id> [^\/]+)', :show,  [:post, :put]
+  
+  pre :find_user, :show
+  
+  def index
+    [200, { "Content-Type" => 'text/plain' }, StringIO.new('hello from index')]
+  end
+  
+  def show
+    [200, { "Content-Type" => 'text/plain' }, StringIO.new(@user.name)]
+  end
+  
+  private
+  
+  def find_user
+    @user = User.find(params['id'])
+    fail [404, { "Content-Type" => 'text/plain' }, StringIO.new('user not found')] unless @user
+  end
+end
+```
+
+The `route` method maps a route to an action in your controller. You can define named parameters by appending a : or by using a named capture group.
+
+You can build arbitrary path match patterns by using regaular expressions.
+
+The `pre` method calls a method prior to the action. If `fail` is called in before filter method the action will not get called and the given response will be returned.
+
+## Author
+
+[Lars Kuhnt](http://www.github.com/larskuhnt)
+Copyright (c) 2011
+
+## License
+
+Published under the MIT License.
+
+See [LICENSE](LICENSE) for details.

data/lib/track.rb

@@ -1,8 +1,6 @@
-module Track
-  VERSION = '0.0.2'
-end
-
 require 'rack'
-require 'track/application'
-require 'track/config'
+require 'track/controller'
 
+module Track
+  VERSION = '0.1.0'  
+end

data/lib/track/{application.rb → controller.rb}

@@ -3,18 +3,17 @@ require_relative 'route_map'
 require_relative 'filter_map'
 
 module Track
-  class Application
-  
+  class Controller
+    
     @@route_map  = RouteMap.new
     @@filter_map = FilterMap.new
-  
+    
     attr_accessor :params
-  
-    def initialize(routing_error_response = [404, { 'Content-Type' => 'text/plain' }, ['route not found']])
-      @routing_error_response = routing_error_response
+    
+    def initialize
       @params = {}
     end
-  
+    
     def call(env)
       req = Rack::Request.new(env)
       @params.merge!(req.params)
@@ -22,28 +21,36 @@ module Track
         @params.merge!(route[:matches])
         response_for(route)
       else
-        @routing_error_response
+        routing_error
       end
     end
-  
+    
     protected
-  
+    
+    def routing_error
+      [404, { 'Content-Type' => 'text/plain' }, ['route not found']]
+    end
+    
     def response_for(route)
       if filters = @@filter_map.scan(self.class.name, route[:action])
         filters.each do |m|
-          response = send(m)
-          return response if response
+          send(m)
+          return @_response if @_response
         end
       end
       send(route[:action])
     end
-  
+    
+    def fail(response = [404, { 'Content-Type' => 'text/plain' }, ['']])
+      @_response = response
+    end
+    
     def self.route(pattern, action, methods = nil)
       @@route_map.add self.name, pattern, action, methods
     end
-  
-    def self.before(action, method)
-      @@filter_map.add self.name, action, method
+    
+    def self.pre(method, actions)
+      @@filter_map.add self.name, method, actions
     end
   
   end

data/lib/track/filter_map.rb

@@ -3,14 +3,21 @@
 module Track
   class FilterMap < Hash
     
-    def add(clazz, action, method)
-      self[clazz] ||= {}
-      self[clazz][action.to_sym] ||= []
-      self[clazz][action.to_sym] << method.to_sym
+    def add(key, method, actions)
+      self[key] ||= {}
+      actions = actions.is_a?(Array) ? actions.map(&:to_sym) : [actions.to_sym]
+      actions.each do |action|
+        self[key][action.to_sym] ||= []
+        self[key][action.to_sym] << method.to_sym
+      end
     end
     
-    def scan(clazz, action)
-      self[clazz] && self[clazz][action.to_sym] ? self[clazz][action.to_sym] : nil
+    def scan(key, action)
+      if self[key]
+        self[key][action.to_sym] ? self[key][action.to_sym] : []
+      else
+        []
+      end
     end
     
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: track
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-07 00:00:00.000000000Z
+date: 2011-12-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70217309920280 !ruby/object:Gem::Requirement
+  requirement: &70191469044140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70217309920280
+  version_requirements: *70191469044140
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70217309919780 !ruby/object:Gem::Requirement
+  requirement: &70191469043600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70217309919780
+  version_requirements: *70191469043600
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70217309919340 !ruby/object:Gem::Requirement
+  requirement: &70191469043180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70217309919340
+  version_requirements: *70191469043180
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70217309918920 !ruby/object:Gem::Requirement
+  requirement: &70191469042760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70217309918920
+  version_requirements: *70191469042760
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70217309918500 !ruby/object:Gem::Requirement
+  requirement: &70191469042300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70217309918500
+  version_requirements: *70191469042300
 description: Nano framework to build small server applications based on rack and ruby
   1.9
 email:
@@ -74,8 +74,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/track/application.rb
-- lib/track/config.rb
+- lib/track/controller.rb
 - lib/track/filter_map.rb
 - lib/track/route_map.rb
 - lib/track.rb

data/lib/track/config.rb

@@ -1,7 +0,0 @@
-# encoding: utf-8
-
-module Track
-  class Config
-    
-  end
-end