nyny 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4590f5f6c66d42152fecc4f0749bfe4f198d6987
-  data.tar.gz: 799af0e6c6f79f90fa6ecf627a83d7e7f40e64bc
+  metadata.gz: fa8bdccd5f35a66eaa05e512117950e230350185
+  data.tar.gz: 9932d345a2b696477bb9eef615671ce9db598de1
 SHA512:
-  metadata.gz: 1605466f98f71349ea745155617b54bcf91d245b92f878931457ffdffe7e44c55b348d280c20eeb84f73f6efbb4e4ee64bc4cbd203172d7ed6b8803b8930c31e
-  data.tar.gz: 28bb352a548d9eb62b759284c3cb153a624db86b640029fc318263c21ae5b1bc6f91df4c593895f32f7afb15d8588a2711c262db2a62b39a363e021ac418841d
+  metadata.gz: 941652c537350c79204235b9d62af1dd7a55f0e2074a4c75043fad5f793c5ec87c1f85f6d02ec28d7df3286ac56270b1f2d7aaef07f272d5480ae6f13db3ea27
+  data.tar.gz: a4a63feaf107bc95a0981f7b087c2a1e03d918bcf63fc1fbe23d3bf3e059a39b3124f3f8c5582fc03563deb4ca3866e3542f1803d6ca58186e03a36954aafb6f

data/CHANGELOG

@@ -0,0 +1,9 @@
+2.0.0
+  - Simplified and improved RouteSignature implementation
+  - Simplified and improved RequestScope implementation
+  - Made response object available in RequestScope
+  - removed .use_protection! (the rack-protection) middleware can be easily
+    used manually
+  - add .register, which registers an extension (works the same way as in sinatra)
+
+1.0.0 Initial release

data/README.md

@@ -4,6 +4,8 @@
 [![Build Status](https://api.travis-ci.org/alisnic/nyny.png)](https://travis-ci.org/alisnic/nyny)
 [![Coverage Status](https://coveralls.io/repos/alisnic/nyny/badge.png)](https://coveralls.io/r/alisnic/nyny)
 [![Code Climate](https://codeclimate.com/repos/521b7ee513d637348712864a/badges/60e3637788bbac94f1cb/gpa.png)](https://codeclimate.com/repos/521b7ee513d637348712864a/feed)
+[![Dependency Status](https://gemnasium.com/alisnic/nyny.png)](https://gemnasium.com/alisnic/nyny)
+[![Gem Version](https://badge.fury.io/rb/nyny.png)](http://badge.fury.io/rb/nyny)
 
     # myapp.rb
 
@@ -37,6 +39,7 @@ Open the browser at [http://localhost:9292](http://localhost:9292)
     - [Filters](#filters)
     - [Middleware](#middleware)
     - [Helpers](#helpers)
+    - [Extensions](#extensions)
 - [FAQ](#f-a-q)
 - [Contributing](#contributing)
 
@@ -138,8 +141,9 @@ As was said above, when you pass a block to a route definition,
 that block is evaluated in the context of a [RequestScope][2].
 This means that several methods/objects available inside that block:
 
-- `request` - A `Rack::Request` object which encapsulates the request 
+- `request` - A `Rack::Request` object which encapsulates the request
   to that route. (see [Rack::Request documentation][3] for more info)
+- `response` - A `Rack::Response` object which encapsulates the response
 - `params` - a hash which contains both POST body params and GET querystring params.
 - `headers` - allows you to read/add headers to the response
   (ex: `headers 'Content-Type' => 'text/html'`)
@@ -175,10 +179,6 @@ if the request.path matches a pattern.
       end
     end
 
-Before and after filters are also evaluated in a RequestScope context.
-A little exception are the after filters, which can access
-the __response__ object ([Rack::Response][4]).
-
 ## Middleware
 
 A NYNY app is a Rack middleware, which means that it can be used inside 
@@ -211,6 +211,60 @@ Using a helper implies that the helper module is included in the [RequestScope][
 and that all the methods in that module will be available inside a route
 definition block.
 
+## Extensions
+
+Since version 2.0.0, NYNY added support for extensions.
+This makes possible to include helpers, middlewares and custom app class
+methods inside a single module:
+
+    module MyKewlExtension
+      class Middleware
+        def initialize app
+          @app = app
+        end
+
+        def call env
+          env['KEWL'] = true
+          @app.call(env) if @app
+        end
+      end
+
+      module Helpers
+        def the_ultimate_answer
+          42
+        end
+      end
+
+      def get_or_post route, &block
+        get route, &block
+        post route, &block
+      end
+
+      def self.registered app
+        app.use Middleware
+        app.helpers Helpers
+
+        app.get_or_post '/' do
+          "After many years of hard computation, the answer is #{the_ultimate_answer}"
+        end
+      end
+    end
+
+    class App < NYNY::App
+      register MyKewlExtension
+    end
+
+    App.run!
+
+By default, the App class will `extend` the provided extension module.
+Optionally, an extension can add a `registered` method, which will be invoked
+once the extension is registered. That method will be called with the app class
+as a parameter.
+
+Since NYNY has the same extension interface as Sinatra, some Sinatra extensions
+might work with NYNY, although that is not guaranteed. However, an extension
+written for NYNY will always work with Sinatra. (Forward compatible)
+
 # F. A. Q.
 TBD.
 

data/examples/active_record/Gemfile

@@ -4,6 +4,7 @@ gem 'activerecord', :require => 'active_record'
 gem 'sqlite3'
 gem 'rack'
 gem 'thin'
+gem 'protected_attributes'
 
 group :development do
   #

data/examples/active_record/database.rb

@@ -1,3 +1,4 @@
+require 'protected_attributes'
 require 'active_record'
 
 ENV['RACK_ENV'] ||= 'development'

data/examples/data_mapper/database.rb

@@ -1,6 +1,6 @@
 require 'data_mapper'
 
-DataMapper.setup(:default, "sqlite:///#{Dir.pwd}/db/database.sqlite3")
+DataMapper.setup(:default, "sqlite3://#{Dir.pwd}/db/database.sqlite3")
 Dir[File.dirname(__FILE__) + "/models/*.rb"].each {|f| require f }
 
 DataMapper.finalize

data/examples/data_mapper/db/.gitignore

@@ -0,0 +1 @@
+*.sqlite3

data/examples/web_sockets/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'faye-websocket'
+

data/lib/nyny/app.rb

@@ -1,7 +1,6 @@
 module NYNY
   class App
     HTTP_VERBS = [:delete, :get, :head, :options, :patch, :post, :put, :trace]
-    extend Runner
 
     attr_reader :middleware_chain, :router
     def initialize app=nil
@@ -36,12 +35,11 @@ module NYNY
       def before_hooks; @before_hooks ||= []  end
       def after_hooks;  @after_hooks  ||= []  end
 
-      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"
+      # move middleware chain and runner to core-ext
+      def register *extensions
+        extensions.each do |ext|
+          extend ext
+          ext.registered(self) if ext.respond_to?(:registered)
         end
       end
 

data/lib/nyny/request_scope.rb

@@ -7,9 +7,8 @@ module NYNY
     end
 
     def initialize request
-      @headers = {'Content-Type' => 'text/html'}
-      @status = 200
       @request = request
+      @response = Response.new '', 200, {'Content-Type' => 'text/html'}
     end
 
     def params
@@ -17,7 +16,7 @@ module NYNY
     end
 
     def headers hash={}
-      @headers.merge! hash
+      response.headers.merge! hash
     end
 
     def session
@@ -29,11 +28,14 @@ module NYNY
     end
 
     def status code
-      @status = code
+      response.status = code
     end
 
     def halt status, headers={}, body=''
-      throw :halt, Response.new(body, status, @headers.merge(headers))
+      response.status = status
+      response.headers.merge! headers
+      response.body = body
+      throw :halt, response
     end
 
     def redirect_to uri, status=302
@@ -42,9 +44,9 @@ module NYNY
     alias_method :redirect, :redirect_to
 
     def apply_to &handler
-      @response = Response.new instance_eval(&handler), @status, @headers
-      cookies.each {|k,v| @response.set_cookie k,v }
-      @response
+      response.body = instance_eval(&handler)
+      cookies.each {|k,v| response.set_cookie k,v }
+      response
     end
   end
 end

data/lib/nyny/route_signature.rb

@@ -7,15 +7,14 @@ module NYNY
       @pattern = pattern_for signature
     end
 
-    def pattern_for string
-      return string if string.is_a? Regexp
-      return string unless string.include? ':'
-
-      signature = string.start_with?('/') ? string : "/#{string}"
-      build_regex signature
+    def pattern_for signature
+      return signature if signature.is_a? Regexp
+      build_regex(signature.start_with?('/') ? signature : "/#{signature}")
     end
 
     def build_regex signature
+      return %r(^#{signature}$) unless signature.include?(':')
+
       groups = signature.split('/').map do |part|
         next part if part.empty?
         next part unless part.start_with? ':'
@@ -23,21 +22,13 @@ module NYNY
         %Q{(?<#{name}>\\S+)}
       end.select {|s| !s.empty? }.join('\/')
 
-      %r(\/#{groups})
+      %r(^\/#{groups}$)
     end
 
     def match path
-      return (pattern == path ? {} : nil) if pattern.is_a?(String)
       data = pattern.match path
-
       if data
-        if pattern.respond_to? :names
-          Hash[data.names.map {|n| [n.to_sym, URI.unescape(data[n])]}]
-        else
-          {}
-        end
-      else
-        nil
+        Hash[data.names.map {|n| [n.to_sym, URI.unescape(data[n])]}]
       end
     end
   end

data/lib/nyny/version.rb

@@ -1,3 +1,3 @@
 module NYNY
-  VERSION = "1.0.2"
+  VERSION = "2.0.0"
 end

data/lib/nyny.rb

@@ -5,7 +5,14 @@ require 'nyny/version'
 require 'nyny/primitives'
 require 'nyny/request_scope'
 require 'nyny/route_signature'
-require 'nyny/runner'
 require 'nyny/middleware_chain'
-require 'nyny/router'
 require 'nyny/app'
+require 'nyny/router'
+
+
+# Register core extensions
+require 'nyny/core-ext/runner'
+
+module NYNY
+  App.register NYNY::Runner
+end

data/spec/app_spec.rb

@@ -13,12 +13,29 @@ 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!
+  it 'should able to register a extension' do
+    module Foo
+      def foo
+      end
+    end
+
+    kls = mock_app_class {}
+    kls.register(Foo)
+    kls.should respond_to(:foo)
+  end
+
+  it 'should call registered method on extension' do
+    module Foo
+      def self.registered app
+        #
+      end
+    end
+
+    class SomeApp < NYNY::App
     end
 
-    app_class.middlewares.first.should == [Rack::Protection, {}]
+    Foo.should_receive(:registered).with(SomeApp)
+    SomeApp.register(Foo)
   end
 
   it 'should match a route for any supported verbs' do
@@ -37,6 +54,10 @@ describe App do
 
   it 'should support route patterns' do
     app = mock_app do
+      get '/some/:name' do
+        'foo'
+      end
+
       get '/:name' do
         "hello #{params[:name]}"
       end

data/spec/runner_spec.rb

@@ -1,23 +1,16 @@
 require 'spec_helper'
 
 describe Runner do
-  describe '.run!' do
-    before do
-      handler = begin
-                  Rack::Handler::Thin
-                rescue LoadError
-                  Rack::Handler::WEBrick
-                end
-      handler.stub :run
-    end
+  let (:kls) { mock_app_class {} }
 
-    it 'should include the default middleware on top' do
-      kls = mock_app_class do
-      end
+  before do
+    kls.optimal_runner.stub :run
+  end
 
-      kls.run!
-      kls.middlewares.first.should == Rack::ShowExceptions
-      kls.middlewares[1].should == Rack::CommonLogger
-    end
+  it 'should include the default middleware on top' do
+    kls.run!
+    kls.middlewares.first.should == Rack::ShowExceptions
+    kls.middlewares[1].should == Rack::CommonLogger
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nyny
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Andrei Lisnic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-19 00:00:00.000000000 Z
+date: 2013-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -77,6 +77,7 @@ files:
 - .rspec
 - .ruby-version
 - .travis.yml
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - Performance.md
@@ -100,11 +101,13 @@ files:
 - examples/active_record/server.rb
 - examples/data_mapper/Gemfile
 - examples/data_mapper/database.rb
+- examples/data_mapper/db/.gitignore
 - examples/data_mapper/models/shout.rb
 - examples/data_mapper/server.rb
 - examples/json_api.rb
 - examples/templates/server.rb
 - examples/templates/views/index.haml
+- examples/web_sockets/Gemfile
 - examples/web_sockets/public/FABridge.js
 - examples/web_sockets/public/WebSocketMain.swf
 - examples/web_sockets/public/index.html
@@ -113,12 +116,12 @@ files:
 - examples/web_sockets/server.rb
 - lib/nyny.rb
 - lib/nyny/app.rb
+- lib/nyny/core-ext/runner.rb
 - lib/nyny/middleware_chain.rb
 - lib/nyny/primitives.rb
 - lib/nyny/request_scope.rb
 - lib/nyny/route_signature.rb
 - lib/nyny/router.rb
-- lib/nyny/runner.rb
 - lib/nyny/version.rb
 - nyny.gemspec
 - spec/app_spec.rb