track 0.3.0 → 0.4.0

data/CHANGELOG.md

@@ -1 +1,6 @@
+# Changelog
+
+## v 0.4.0
+
+- complete rewrite
 

data/README.md

@@ -1,17 +1,17 @@
 # Track
 
-A nano framework for server applications based on rack and ruby 1.9 named capture groups.
+A nano framework for server applications based on rack.
 
 ## 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
-- ActiveRecord initializer through `require 'track/orm/active_record'`
+- modularize your rack app with controllers
+- routes paths to methods of controllers via `Track::Routes.define` in `config/routes.rb`
+- lets you define before- and after-filters in your controllers
 
 ## What Track does *not*
 
 - support any template engines, your actions have to return low level rack responses
+- no security layer
 
 ## Install
 
@@ -23,7 +23,11 @@ or install it via rubygems
 
 `gem install track`
 
-## Install example application
+## Usage
+
+Have a look at the example application. I will provide documentation and more examples in the future.
+
+### Install example application
 
 Clone the [http://github.com/larskuhnt/track-example](track-example) project:
 
@@ -37,44 +41,6 @@ or install it via the gem executable
 track new my_track_project
 ```
 
-## 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.
-
 ## Plugins
 
 Currently available:

data/ROADMAP.md

@@ -0,0 +1,8 @@
+# Track
+
+- add logging
+
+# FilterMap
+
+- add controller/action cache
+

data/lib/track.rb

@@ -1,8 +1,14 @@
 require 'rack'
+require 'track/application'
+require 'track/routes'
 require 'track/controller'
 
 module Track
   
+  @@responses = {
+    :routing_error => [404, { 'Content-Type' => 'text/plain'}, ['Route not found']],
+    :not_found     => [404, { 'Content-Type' => 'text/plain'}, ['Resource not found']]
+  }
   @@env     = ENV['RACK_ENV'].to_sym.freeze
   @@config  = nil
   @@root    = nil
@@ -13,6 +19,7 @@ module Track
       @@root   = root
       @@config = load_config_file!(:config)
       boot_plugins!
+      Routes.load! File.join(root, 'config', 'routes')
     end
   
     def [](key)
@@ -39,17 +46,16 @@ module Track
       VERSION
     end
     
-    def use(plugin)
+    def plugin(plugin)
       @@plugins << plugin
     end
     
+    def responses
+      @@responses
+    end
+    
     def load_config_file!(filename)
-      begin
-        YAML.load(File.open(File.join(root, 'config', "#{filename}.yml")))[env.to_s]
-      rescue
-        raise "Config file config/config.yml is missing!" if env?(:production)
-        YAML.load(File.open(File.join(root, 'config', "#{filename}.example.yml")))[env.to_s]
-      end
+      YAML.load(File.open(File.join(root, 'config', "#{filename}.yml")))[env.to_s]
     end
     
     def boot_plugins!

data/lib/track/application.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Track
+  class Application
+    
+    def call(env)
+      req = Rack::Request.new(env)
+      if route = Routes.find(req.request_method, req.path_info)
+        controller = route[:class].new(env, req.params.merge(route[:matches]))
+        if response = controller.run_filters(:before, route[:action])
+          return response
+        else
+          response = controller.send(route[:action])
+          controller.run_filters(:after, route[:action])
+          response
+        end
+      else
+        Track.responses[:routing_error]
+      end
+    end
+    
+  end
+end

data/lib/track/controller.rb

@@ -1,57 +1,45 @@
 # encoding: utf-8
-require_relative 'route_map'
 require_relative 'filter_map'
 
 module Track
   class Controller
     
-    @@route_map  = RouteMap.new
-    @@filter_map = FilterMap.new
+    @@filters = FilterMap.new
     
-    attr_accessor :params
+    attr_reader :env, :params
     
-    def initialize
-      @params = {}
+    def initialize(env, params)
+      @env    = env
+      @params = params
     end
     
-    def call(env)
-      req = Rack::Request.new(env)
-      @params.merge!(req.params)
-      if route = @@route_map.scan(self.class.name, req)
-        @params.merge!(route[:matches])
-        response_for(route)
-      else
-        routing_error
+    def run_filters(kind, action)
+      @@filters.scan(self.class, kind, action).each do |filter_method|
+        self.send(filter_method)
+        return @_response if @_response
       end
+      nil
     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|
-          send(m)
-          return @_response if @_response
-        end
-      end
-      send(route[:action])
-    end
-    
-    def fail(response = [404, { 'Content-Type' => 'text/plain' }, ['']])
+    def respond(response)
       @_response = response
     end
     
-    def self.route(pattern, action, methods = nil)
-      @@route_map.add self.name, pattern, action, methods
+    class << self
+      
+      def filters
+        @@filters
+      end
+      
+      def before_filter(method, options = {})
+        @@filters.add(self, :before, method, options)
+      end
+      
+      def after_filter(method, options = {})
+        @@filters.add(self, :after, method, options)
+      end
+      
     end
     
-    def self.pre(method, actions)
-      @@filter_map.add self.name, method, actions
-    end
-  
   end
 end

data/lib/track/filter_map.rb

@@ -1,23 +1,36 @@
 # encoding: utf-8
 
 module Track
-  class FilterMap < Hash
+  class FilterMap
     
-    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
+    def initialize
+      @filters = {}
+    end
+    
+    def add(klass, kind, method, options = {})
+      @filters[kind] ||= []
+      @filters[kind] << [method, options, klass]
     end
     
-    def scan(key, action)
-      if self[key]
-        self[key][action.to_sym] ? self[key][action.to_sym] : []
-      else
-        []
+    def scan(klass, kind, action)
+      filters = []
+      if @filters[kind]
+        @filters[kind].each do |method, options, k|
+          next if contains?(options[:except], action) || !(klass <= k)
+          filters << method if contains?(options[:only], action) || blank?(options[:only])
+        end
       end
+      filters
+    end
+    
+    private
+    
+    def contains?(a, k)
+      a == k || (Array === a && a.include?(k)) ? true : false
+    end
+    
+    def blank?(a)
+      a.nil? || a.size == 0
     end
     
   end

data/lib/track/route_map.rb

@@ -1,25 +1,36 @@
-# encoding: utf-8
 
 module Track
-  class RouteMap < Hash
+  class RouteMap
     
-    def add(clazz, pattern, action, methods)
+    def initialize
+      @routes = []
+    end
+    
+    def add(pattern, klass, action, methods = nil)
+      raise "#{klass} is not a subclass of Track::Controller" unless klass <= Track::Controller
       methods = methods.is_a?(Array) ? methods : [methods] if methods
-      self[clazz] ||= []
-      self[clazz].push(
-        :pattern => compile_regexp(pattern),
+      regex, keys = compile_regexp(pattern)
+      @routes.push(
+        :pattern => regex,
+        :keys    => keys,
+        :class   => klass,
         :action  => action.to_sym,
         :methods => methods
       )
     end
+    alias_method :route, :add
     
-    def scan(clazz, req)
-      method = req.request_method.downcase.to_sym
-      self[clazz].each do |route|
-        md = req.path_info.match(route[:pattern])
-        return route.merge(:matches => match_hash(md)) if md && allowed_method?(route, method)
+    def scan(path, method)
+      @routes.each do |route|
+        md = path.match(route[:pattern])
+        if md && allowed_method?(route, method)
+          keys = route[:keys]
+          matches = {}
+          (1..md.size-1).each { |i| matches[keys[i-1]] = md[i] }
+          return route.merge(:matches => matches)
+        end
       end
-      false
+      nil
     end
     
     private
@@ -28,18 +39,14 @@ module Track
       route[:methods].nil? ? true : route[:methods].include?(method)
     end
     
-    def match_hash(md)
-      params = {}
-      md.names.each do |key|
-        params[key.to_s] = md[key]
-      end
-      params
-    end
-    
     def compile_regexp(pattern)
       pattern = (pattern[-1,1] == '/' ? pattern.chop : pattern) << '/?'
-      pattern.gsub!(/:([^\/]+)/i, '(?<\1> [^/]+)')
-      Regexp.new('\A'+pattern+'\z', Regexp::EXTENDED)
+      keys = []
+      pattern.gsub!(/:(\w+)/) do |m|
+        keys << $1
+        '([^\/#\?]+)'
+      end
+      [Regexp.new("^#{pattern}$"), keys]
     end
   end
 end

data/lib/track/routes.rb

@@ -0,0 +1,27 @@
+require_relative 'route_map'
+
+module Track
+  
+  class Routes
+    
+    @@route_map = RouteMap.new
+    
+    class << self
+      
+      def load!(route_file)
+        require route_file
+      end
+      
+      def define(&block)
+        @@route_map.instance_eval &block
+      end
+      
+      def find(method, path)
+        @@route_map.scan(path, method.downcase.to_sym)
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/track/version.rb

@@ -1,3 +1,3 @@
 module Track
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: track
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-10 00:00:00.000000000Z
+date: 2012-01-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70223625727700 !ruby/object:Gem::Requirement
+  requirement: &70210397017080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70223625727700
+  version_requirements: *70210397017080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70223625725260 !ruby/object:Gem::Requirement
+  requirement: &70210397015520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70223625725260
+  version_requirements: *70210397015520
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70223625719580 !ruby/object:Gem::Requirement
+  requirement: &70210397014500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,31 +43,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70223625719580
-- !ruby/object:Gem::Dependency
-  name: active_record
-  requirement: &70223625717640 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70223625717640
-- !ruby/object:Gem::Dependency
-  name: thor
-  requirement: &70223625715720 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70223625715720
-description: Nano framework to build small server applications based on rack and ruby
-  1.9
+  version_requirements: *70210397014500
+description: Nano framework to build small and fast server applications based on rack
 email:
 - lars.kuhnt@gmail.com
 executables:
@@ -75,9 +52,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/track/application.rb
 - lib/track/controller.rb
 - lib/track/filter_map.rb
 - lib/track/route_map.rb
+- lib/track/routes.rb
 - lib/track/version.rb
 - lib/track.rb
 - LICENSE
@@ -96,7 +75,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -108,6 +87,5 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Nano framework to build small server applications based on rack and ruby
-  1.9
+summary: Nano framework to build small server applications based on rack
 test_files: []