RubyGems - nyny - Versions diffs - 1.0.0.pre1 → 1.0.0 - Mend

nyny 1.0.0.pre1 → 1.0.0

Files changed (38) hide show

checksums.yaml +4 -4
data/.gitignore +1 -0
data/.travis.yml +12 -0
data/Gemfile +5 -0
data/Performance.md +8 -6
data/README.md +116 -55
data/Rakefile +5 -0
data/benchmarks/filters/{frankie.rb → nyny.rb} +2 -2
data/benchmarks/helpers/{frankie.rb → nyny.rb} +2 -2
data/benchmarks/simple/{frankie.rb → nyny.rb} +2 -2
data/benchmarks/url_pattern/{frankie.rb → nyny.rb} +2 -2
data/examples/active_record/server.rb +2 -2
data/examples/data_mapper/Gemfile +7 -0
data/examples/data_mapper/database.rb +7 -0
data/examples/data_mapper/models/shout.rb +7 -0
data/examples/data_mapper/server.rb +41 -0
data/examples/json_api.rb +2 -2
data/examples/templates/server.rb +5 -4
data/examples/web_sockets/server.rb +4 -4
data/lib/nyny.rb +4 -2
data/lib/nyny/app.rb +46 -47
data/lib/nyny/middleware_chain.rb +14 -0
data/lib/nyny/request_scope.rb +3 -9
data/lib/nyny/route_signature.rb +11 -11
data/lib/nyny/router.rb +44 -0
data/lib/nyny/runner.rb +18 -0
data/lib/nyny/version.rb +1 -1
data/nyny.gemspec +2 -2
data/spec/app_spec.rb +34 -24
data/spec/primitives_spec.rb +11 -4
data/spec/request_scope_spec.rb +12 -2
data/spec/route_signature_spec.rb +9 -0
data/spec/runner_spec.rb +23 -0
data/spec/spec_helper.rb +14 -3
metadata +23 -15
data/.ruby-gemset +0 -1
data/lib/nyny/class_level_api.rb +0 -40
data/spec/class_level_api_spec.rb +0 -39

data/examples/data_mapper/server.rb ADDED

@@ -0,0 +1,41 @@
+#!ruby -I ../../lib -I lib
+ENV['RACK_ENV'] ||= 'development'
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, ENV['RACK_ENV'].to_sym)
+require 'nyny'
+require_relative 'database'
+TEMPLATE = DATA.read.freeze
+class App < NYNY::App
+  get '/' do
+    shouts = Shout.all.reverse
+    ERB.new(TEMPLATE).result(binding)
+  end
+  post '/shouts' do
+    Shout.create :body => params[:body]
+    redirect_to '/'
+  end
+end
+App.run! 9000
+__END__
+<html>
+<body>
+  <form action="/shouts" method="post">
+    <input type="text" name="body"></input>
+    <input type="submit" value="SHOUT"></input>
+  </form>
+  <ul>
+    <% shouts.each do |shout| %>
+      <li><%= shout.body %>
+    <% end %>
+  </ul>
+</body>
+</html>

data/examples/json_api.rb CHANGED

@@ -1,11 +1,11 @@
 #!ruby -I ../lib -I lib
-require 'frankie'
+require 'nyny'
 require 'json'
 #
 # Every response of this app will be automatically converted to json
 #
-class App < Frankie::App
+class App < NYNY::App
   before { headers 'Content-Type' => 'application/json' }
   after do

data/examples/templates/server.rb CHANGED

@@ -1,9 +1,10 @@
-#!ruby -I ../lib -I lib
-require 'frankie'
+#!ruby -I ../../lib -I lib
+require 'nyny'
 require 'sinatra'
 require 'ostruct'
 module Views
+  CACHE = Tilt::Cache.new
   include ::Sinatra::Templates
   def settings
@@ -11,12 +12,12 @@ module Views
   end
   def template_cache
-    @template_cache = Tilt::Cache.new
+    CACHE
   end
 end
-class App < Frankie::App
+class App < NYNY::App
   helpers Views
   get '/' do

data/examples/web_sockets/server.rb CHANGED

@@ -1,5 +1,5 @@
 #!ruby -I ../../lib -I lib
-require 'frankie'
+require 'nyny'
 require 'faye/websocket'
 #
@@ -37,7 +37,7 @@ class WebSockets
   end
 end
-class App < Frankie::App
+class App < NYNY::App
   #Serve static assets from public folder
   use Rack::Static, :urls => ["/public"]
@@ -52,8 +52,8 @@ class App < Frankie::App
     end
   end
-  get '/frankie' do
-    'yep, you can still use frankie'
+  get '/nyny' do
+    'yep, you can still use nyny'
   end
 end

data/lib/nyny.rb CHANGED

@@ -1,9 +1,11 @@
 require 'uri'
 require 'rack'
-require "nyny/version"
+require 'nyny/version'
 require 'nyny/primitives'
 require 'nyny/request_scope'
 require 'nyny/route_signature'
-require 'nyny/class_level_api'
+require 'nyny/runner'
+require 'nyny/middleware_chain'
+require 'nyny/router'
 require 'nyny/app'

data/lib/nyny/app.rb CHANGED

@@ -1,66 +1,65 @@
 module NYNY
   class App
-    extend ClassLevelApi
-    RouteNotFoundError = Class.new StandardError
+    HTTP_VERBS = [:delete, :get, :head, :options, :patch, :post, :put, :trace]
+    extend Runner
+    attr_reader :middleware_chain, :router
     def initialize app=nil
-      @app = app || lambda {|env| Response.new '', 404 }
-      build_middleware_chain
+      @router = Router.new({
+        :routes => self.class.routes,
+        :fallback => (app || lambda {|env| Response.new '', 404 }),
+        :before_hooks => self.class.before_hooks,
+        :after_hooks => self.class.after_hooks
+      })
+      @middleware_chain = MiddlewareChain.new(self.class.middlewares,
+                                              lambda {|env| _call(env)})
     end
-    def build_middleware_chain
-      @top = self.class.middlewares.reverse.reduce (self) do |prev, entry|
-        klass, args, blk = entry
-        klass.new prev, *args, &blk
-      end
+    def _call env
+      router.call env
     end
-    def self.run! port=9292
-      middlewares.unshift Rack::ShowExceptions, Rack::CommonLogger
-      begin
-        Rack::Handler::Thin
-      rescue LoadError
-        Rack::Handler::WEBrick
-      end.run new, :Port => port
+    def call env
+      middleware_chain.call env
     end
-    def handler_for_path method, path
-      self.class.routes.fetch(method.downcase.to_sym).each do |sig, h|
-        params = sig.match path
-        return [h, params] if params
+    #class methods
+    class << self
+      HTTP_VERBS.each do |method|
+        define_method method do |str, &blk|
+          (routes[method] ||= {})[RouteSignature.new(str)] = Proc.new &blk
+        end
       end
-      raise RouteNotFoundError
-    end
+      def middlewares;  @middlewares  ||= []  end
+      def routes;       @routes       ||= {}  end
+      def before_hooks; @before_hooks ||= []  end
+      def after_hooks;  @after_hooks  ||= []  end
-    def route req
-      begin
-        handler, params = handler_for_path req.request_method, req.path
-        req.params.merge! params
-        RequestScope.new(self, req).apply_to &handler
-      rescue KeyError, RouteNotFoundError
-        @app.call req.env
+      def use_protection! args={}
+        begin
+          require 'rack/protection'
+          middlewares.unshift [Rack::Protection, args]
+        rescue LoadError
+          puts "WARN: to use protection, you must install 'rack-protection' gem"
+        end
       end
-    end
-    def _call env
-      route Request.new(env)
-    end
+      def before &blk
+        before_hooks << Proc.new(&blk)
+      end
-    def call env
-      if @top == self
-        _call env
-      else
-        if not @initialized_chain
-          @initialized_chain = true
-          @top.call(env)
-        else
-          @initialized_chain = false
-          _call env
-        end
+      def after &blk
+        after_hooks << Proc.new(&blk)
       end
-    end
+      def use middleware, *args, &block
+        middlewares << [middleware, args, block]
+      end
+      def helpers *args
+        args.each {|m| RequestScope.add_helper_module m }
+      end
+    end #class methods
   end
 end

data/lib/nyny/middleware_chain.rb ADDED

@@ -0,0 +1,14 @@
+module NYNY
+  class MiddlewareChain
+    def initialize middlewares, proxy
+      @top = middlewares.reverse.reduce (proxy) do |prev, entry|
+        klass, args, blk = entry
+        klass.new prev, *args, &blk
+      end
+    end
+    def call env
+      @top.call(env)
+    end
+  end
+end

data/lib/nyny/request_scope.rb CHANGED

@@ -1,16 +1,15 @@
 module NYNY
   class RequestScope
-    attr_reader :request, :app, :response
+    attr_reader :request, :response
     def self.add_helper_module m
       include m
     end
-    def initialize app, req
-      @app = app
+    def initialize request
       @headers = {'Content-Type' => 'text/html'}
       @status = 200
-      @request = req
+      @request = request
     end
     def params
@@ -42,17 +41,12 @@ module NYNY
     end
     def apply_to &handler
-      params.default_proc = proc {|h,k| h[k.to_s] || h[k.to_sym]}
-      app.class.before_hooks.each {|h| instance_eval &h }
       @response = @halt_response || begin
         Response.new instance_eval(&handler), @status, @headers
       end
       cookies.each {|k,v| @response.set_cookie k,v }
       @response.redirect(@redirect) if @redirect
-      app.class.after_hooks.each {|h| instance_eval &h }
       @response.finish
       @response
     end

data/lib/nyny/route_signature.rb CHANGED

@@ -3,27 +3,27 @@ module NYNY
     NAME_PATTERN = /:(\S+)/
     attr_reader :pattern
-    def initialize route
-      @pattern = if route.is_a? Regexp
-                   route
-                 else
-                   pattern_for route.dup
-                 end
+    def initialize signature
+      @pattern = pattern_for signature
     end
     def pattern_for string
+      return string if string.is_a? Regexp
       return string unless string.include? ':'
-      string = "/#{string}" unless string.start_with? '/'
-      parts = string.split '/'
-      groups = parts.map do |part|
+      signature = string.start_with?('/') ? string : "/#{string}"
+      build_regex signature
+    end
+    def build_regex signature
+      groups = signature.split('/').map do |part|
         next part if part.empty?
         next part unless part.start_with? ':'
         name = NAME_PATTERN.match(part)[1]
         %Q{(?<#{name}>\\S+)}
-      end.select {|s| !s.empty? }
+      end.select {|s| !s.empty? }.join('\/')
-      %r(\/#{groups.join('\/')})
+      %r(\/#{groups})
     end
     def match path

data/lib/nyny/router.rb ADDED

@@ -0,0 +1,44 @@
+module NYNY
+  class Router
+    NullHandler = Class.new
+    attr_reader :fallback, :routes, :before_hooks, :after_hooks
+    def initialize options
+      @fallback     = options[:fallback]
+      @routes       = options[:routes]
+      @before_hooks = options[:before_hooks]
+      @after_hooks  = options[:after_hooks]
+    end
+    def find_handler request
+      routes.fetch(request.request_method.downcase.to_sym, []).each do |sig, h|
+        params = sig.match request.path
+        return [h, params] if params
+      end
+      [NullHandler, {}]
+    end
+    def call env
+      req = Request.new(env)
+      handler, params = find_handler req
+      if handler != NullHandler
+        process req, handler, params
+      else
+        fallback.call env
+      end
+    end
+    def process request, handler, url_params
+      request.params.merge! url_params
+      request.params.default_proc = proc {|h,k| h[k.to_s] || h[k.to_sym]}
+      scope = RequestScope.new(request)
+      before_hooks.each {|h| scope.instance_eval &h }
+      response = scope.apply_to &handler
+      after_hooks.each {|h| scope.instance_eval &h }
+      response
+    end
+  end
+end

data/lib/nyny/runner.rb ADDED

@@ -0,0 +1,18 @@
+module NYNY
+  module Runner
+    def optimal_runner
+      return Rack::Handler::WEBrick if RUBY_PLATFORM == 'java'
+      begin
+        Rack::Handler::Thin
+      rescue LoadError
+        Rack::Handler::WEBrick
+      end
+    end
+    def run! port=9292
+      middlewares.unshift Rack::ShowExceptions, Rack::CommonLogger
+      optimal_runner.run new, :Port => port
+    end
+  end
+end

data/lib/nyny/version.rb CHANGED

@@ -1,3 +1,3 @@
 module NYNY
-  VERSION = "1.0.0.pre1"
+  VERSION = "1.0.0"
 end

data/nyny.gemspec CHANGED

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = NYNY::VERSION
   spec.authors       = ["Andrei Lisnic"]
   spec.email         = ["andrei.lisnic@gmail.com"]
-  spec.description   = %q{New York, New York.}
-  spec.summary       = %q{sinatra's little brother}
+  spec.description   = %q{New York, New York - (very) small Sinatra clone.}
+  spec.summary       = %q{New York, New York.}
   spec.homepage      = "https://github.com/alisnic/nyny"
   spec.license       = "MIT"

data/spec/app_spec.rb CHANGED

@@ -1,16 +1,8 @@
-require_relative 'spec_helper'
+require 'spec_helper'
 describe App do
   let (:app) { mock_app {} }
-  describe '.run!' do
-    #
-  end
-  it 'should have the class methods included' do
-    extended_modules_for(App).should include(ClassLevelApi)
-  end
   it 'should return a rack response on call' do
     response = app.get '/'
     response.should be_a(Rack::Response)
@@ -21,9 +13,17 @@ describe App do
     response.status.should == 404
   end
+  it '.use_protection! should add protection middleware on top' do
+    app_class = mock_app_class do
+      use_protection!
+    end
+    app_class.middlewares.first.should == [Rack::Protection, {}]
+  end
   it 'should match a route for any supported verbs' do
     url = random_url
-    verb = ClassLevelApi::HTTP_VERBS.sample
+    verb = App::HTTP_VERBS.sample
     app = mock_app do
       send verb, url do
@@ -82,7 +82,7 @@ describe App do
       [210, {}, ['Hello from downstream']]
     end
-    app_class = frankie_app do
+    app_class = mock_app_class do
       get '/' do
         'hello'
       end
@@ -122,23 +122,33 @@ describe App do
     res.headers['Set-Cookie'].should == 'foo=bar'
   end
-  describe '.run!' do
-    before do
-      handler = begin
-                  Rack::Handler::Thin
-                rescue LoadError
-                  Rack::Handler::WEBrick
-                end
-      handler.stub :run
+  describe 'Class level api' do
+    let (:app_class) { Class.new(App) }
+    describe 'middlewares' do
+      let (:app_class) do
+        mock_app_class do
+          use NullMiddleware
+        end
+      end
+      it 'should allow to add a middleware' do
+        app_class.middlewares.last.first.should == NullMiddleware
+      end
     end
-    it 'should include the default middleware on top' do
-      kls = frankie_app do
+    describe 'helpers' do
+      it 'should allow to include a helper in request scope' do
+        app_class.helpers NullHelper
+        RequestScope.ancestors.should include(NullHelper)
       end
-      kls.run!
-      kls.middlewares.first.should == Rack::ShowExceptions
-      kls.middlewares[1].should == Rack::CommonLogger
+      it 'should allow to include multiple helpers modules' do
+        module NullHelper2
+        end
+        app_class.helpers NullHelper, NullHelper2
+        RequestScope.ancestors.should include(NullHelper, NullHelper2)
+      end
     end
   end
 end