nyny 1.0.0.pre1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46c8a11a01cebb1bd9a45524d3c05a66a3af2262
-  data.tar.gz: 67dd8bb1b90e4e11a273c0debe370fb40a00fd11
+  metadata.gz: 7d06702b70c5c8ae2b5b41dec0c6cdddd867e2cc
+  data.tar.gz: 771e4872192c8727b722181153822df8dd379985
 SHA512:
-  metadata.gz: 5542318ca155709ff482ebe99c3f1ab1896f5fa3183bcee856edd9e38ca581ad8e4b944ae1cb87876110bba084421c461f52aa9042da3e8e6e79c9f9fe48f85d
-  data.tar.gz: 55919c677098f054c192b508db71a92d60475590424815e74f8d33f3c6050181a74064b605707607e457f14683882250a9108f55ca1121470eb0c03c1780e653
+  metadata.gz: 20c1401e48e5dd9a690c084ac040bdf705db169f765ea4203ed7bcc9cc63149f2153d4a1f8a96bb6b0d12d4c3007ed39c36f4e353fcb5da7318814580347e163
+  data.tar.gz: 9bdd755fcd18570974ce27564a605618f8dd3ea944111d74c55268b86879a85e320c9672be7738d1d99a9edcfeb390ee398adcb0a9fcffd1afdcbb40d77c8f7c

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+*.sqlite3
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.travis.yml

@@ -0,0 +1,12 @@
+---
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - rbx-19mode
+  - jruby-19mode
+  - jruby-20mode
+
+branches:
+  only:
+    - master

data/Gemfile

@@ -3,3 +3,8 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rack'
+
+group :test do
+  gem 'coveralls', :require => false
+  gem 'rack-protection'
+end

data/Performance.md

@@ -1,13 +1,15 @@
-# Frankie vs Sinatra performance test
+# NYNY vs Sinatra performance test
 
 Note: all the tests below were made using Thin as a webserver. Httperf was
 choosen as the tool to do that. Bench settings: `--num-conns 10000`
 
 Hardware: Intel(R) Core(TM) i7-2620M CPU @ 2.70GHz, 6 GB DDR3
 
+If you have a clue how to make proper benchmarks (because, frankly, I don't), I am open to suggestions.
+
 ## Results
 
-| Benchmark | Frankie (req/s) | Sinatra (req/s) |
+| Benchmark | NYNY (req/s) | Sinatra (req/s) |
 |-----------|:---------------:|:---------------:|
 | Simple    |__5012__         |2534             |
 | UrlPattern|__4564__         |2338             |
@@ -19,21 +21,21 @@ See below the code for each benchmark
 ## Code
 ### Simple
 
-    class App < Frankie::App #(or Sinatra::Base)
+    class App < NYNY::App #(or Sinatra::Base)
       get '/' do
         'Hello World!'
       end
     end
     
 ### UrlPattern
-    class App < Frankie::App #(or Sinatra::Base)
+    class App < NYNY::App #(or Sinatra::Base)
       get '/hello/:name' do
         "Hello #{params[:name]}!"
       end
     end
 
 ### Filters
-    class App < Frankie::App #(or Sinatra::Base)
+    class App < NYNY::App #(or Sinatra::Base)
       before do
         request
       end
@@ -54,7 +56,7 @@ See below the code for each benchmark
       end
     end
     
-    class App < Frankie::App #(or Sinatra::Base)
+    class App < NYNY::App #(or Sinatra::Base)
       helpers Dude
     
       get '/' do

data/README.md

@@ -1,10 +1,35 @@
 # New York, New York.
-Sinatra's little brother.
+(very) small Sinatra clone.
 
-- [TOP](#frankie)
+![alt text](https://api.travis-ci.org/alisnic/nyny.png "build status")
+[![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)
+
+    # myapp.rb
+
+    require 'nyny'
+    class App < NYNY::App
+      get '/' do
+        'Hello world!'
+      end
+    end
+
+    App.run!
+    
+Install the gem:
+
+    gem install nyny --pre
+    
+Run the file
+    
+    ruby myapp.rb
+    
+Open the browser at [http://localhost:9292]()
+
+- [TOP](#new-york-new-york)
 - [Motivation](#motivation)
 - [Philosophy](#philosophy)
-- [Why use NYNY instead of Sinatra](#why-use-frankie-instead-of-sinatra)
+- [Why use NYNY instead of Sinatra](#why-use-nyny-instead-of-sinatra)
 - [Usage](#usage)
     - [Running](#running)
     - [Defining routes](#defining-routes)
@@ -16,22 +41,27 @@ Sinatra's little brother.
 - [Contributing](#contributing)
 
 # Motivation
-My efforts to write __NYNY__ started when I wanted to understand how __Sinatra__ works, and stumbled upon the [base.rb][0]. The majority of the classes that are used by sinatra are in one single file, which makes it nearly impossible for a new person to grasp.
-
-[I've tried to change the situation][1], but unfortunately, my initiative was premature for the sinatra project (considering their plans).
+My efforts to write __NYNY__ started when I wanted to understand how __Sinatra__
+works, and stumbled upon the [base.rb][0]. The majority of the classes that
+are used by sinatra are in one single file, which makes it nearly impossible
+for a new person to grasp.
 
-I wanted to understand how sinatra works, but the code was pretty challenging. So I decided I should re-implement the basic things sinatra has. Thus, __NYNY__ was born.
+I wanted to understand how sinatra works, but the code was pretty challenging.
+So I decided I should re-implement the basic things Sinatra has.
+Thus, __NYNY__ was born.
 
 # Philosophy
 NYNY should have only the bare minimum to write basic web servers comfortably,
-everything else should be in a extension (see frankie extensions). It is also
-trivial to use frankie to build large and complex app, by writing multiple sub
+everything else should be in a extension. It is also
+trivial to use NYNY to build large and complex apps, by writing multiple sub
 apps and using Rack to mount them, or by using those sub apps in the "main" app
 as middleware.
 
 # Why use NYNY instead of Sinatra
-- It's very small (~250 LOC), which is just a little overhead on top of Rack.
-- Sinatra is a drop-in replacement for NYNY. Anytime you feel that you need more, you can just change your app to inherit from `Sinatra::Base`, your code will still work, and you will be able to use any of the Sinatra features.
+- It's very small (<300 LOC), which is just a little overhead on top of Rack.
+- Sinatra is a drop-in replacement for NYNY. Anytime you feel that you need more,
+  you can just change your app to inherit from `Sinatra::Base`, your code will
+  still work, and you will be able to use any of the Sinatra features.
 - It's __~2 times faster__ than Sinatra (see [Performance][performance] for details)
 - You want to dig into the source code and change to your needs (NYNY's source code is more welcoming)
 - Each NYNY app is a Rack middleware, so it can be used inside of Sinatra, Rails, or any other Rack-based app.
@@ -49,91 +79,120 @@ A NYNY app must _always_ be in a class which inherits from `NYNY::App`.
 ## Running
 There are two ways to run a NYNY app __directly__ [[?]](#middleware):
 
-- be requiring it in a `config.ru` file, and then passing it as argument to the
+- by requiring it in a `config.ru` file, and then passing it as argument to the
 Rack's `run` function:
 
         #config.ru
         require 'app'
         run App.new
-      
+
 - by using the `run!` method directly on the app class:
 
         #app.rb
         #...App class definition...
-      
+
         App.run!
-        
-`run!` takes the port number as optional argument (the default port is 9292). Also the `run!` method will include 2 default middlewares to make the development easier: Rack::CommonLogger and Rack::ShowExceptions. This will show all requests in the log, and will provide useful details in the case a error occurs during a request.
+
+`run!` takes the port number as optional argument (the default port is 9292).
+Also the `run!` method will include 2 default middlewares to make the
+development easier: Rack::CommonLogger and Rack::ShowExceptions.
+This will show all requests in the log, and will provide useful details
+in the case a error occurs during a request.
 
 
 ## Defining routes
 
-NYNY supports the following verbs for defining a route: delete, get, head, options, patch, post, put and trace.
+NYNY supports the following verbs for defining a route: delete, get, head,
+options, patch, post, put and trace.
 
     class App < NYNY::App
-        post '/' do
-            'You Posted, dude!'
-        end
+      post '/' do
+        'You Posted, dude!'
+      end
     end
 
 NYNY also suports basic URL patterns:
 
     class App < NYNY::App
-        get '/greet/:first_name/:last_name' do
-            # The last expression in the block is _always_ considered the response body.
-            "Hello #{params[:first_name]} #{params[:last_name]}!"
-        end
+      get '/greet/:first_name/:last_name' do
+        # The last expression in the block is _always_ considered the response body.
+        "Hello #{params[:first_name]} #{params[:last_name]}!"
+      end
     end
 
-Each block that is passed to a route definition is evaluated in the context of a request scope. See below what methods are available there.
+you can also tell NYNY to match a regex for a path:
+
+    class App < NYNY::App
+      get /html/ do
+        'Your URL contains html!'
+      end
+    end
+
+Each block that is passed to a route definition is evaluated in the context of
+a request scope. See below what methods are available there.
 
 ## Request scope
-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:
+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 to that route. (see [Rack::Request documentation][3] for more info)
+- `request` - A `Rack::Request` object which encapsulates the request 
+  to that route. (see [Rack::Request documentation][3] for more info)
 - `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'`)
+- `headers` - allows you to read/add headers to the response
+  (ex: `headers 'Content-Type' => 'text/html'`)
 - `status` - allows you to set the status of the response (ex: `status 403`)
-- `redirect_to` - sets the response to redirect (ex: `redirect_to 'http://google.com'`)
-- `cookies` - a hash which allows you to access/modify/remove cookies (ex: `cookies[:foo] = 'bar'`)
-- `session` - a hash which allows you to access/modify/remove session variables (ex: `session[:foo] = 'bar'`)
+- `redirect_to` - sets the response to redirect
+  (ex: `redirect_to 'http://google.com'`)
+- `cookies` - a hash which allows you to access/modify/remove cookies
+  (ex: `cookies[:foo] = 'bar'`)
+- `session` - a hash which allows you to access/modify/remove session variables
+  (ex: `session[:foo] = 'bar'`)
 
 ## Filters
 
-Unlike Sinatra, NYNY supports only "generic" before and after filters. This means that you can't execute a filter depending on a URL pattern.
+Unlike Sinatra, NYNY supports only "generic" before and after filters.
+This means that you can't declare a filter to execute depending on a URL pattern.
+However, you can obtain the same effect by calling next in a before block
+if the request.path matches a pattern.
 
     class App < NYNY::App
-        before do
-            headers 'Content-Type' => 'text/html'
-        end
-
-        after do
-            puts response.inspect
-        end
-
-        get '/' do
-            'hello'
-        end
+      before do
+        next unless /html/ =~ request.path
+        headers 'Content-Type' => 'text/html'
+      end
+
+      after do
+        puts response.inspect
+      end
+
+      get '/' do
+        'hello'
+      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]).
+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 Fankie app is a Rack middleware, which means that it can be used inside of Sinatra, Rails, or any other Rack-based app:
+A NYNY app is a Rack middleware, which means that it can be used inside 
+Sinatra, Rails, or any other Rack-based app:
 
     class MyApp < Sinatra::Base
-        use MyNYNYApp
+      use MyNYNYApp
     end
 
-NYNY also supports middleware itself, and that means you can use Rack middleware (or a Sinatra app) inside a NYNY app:
+NYNY also supports middleware itself, and that means you can use Rack middleware
+(or a Sinatra app) inside a NYNY app:
 
     class App < NYNY::App
-        #this will serve all the files in the "public" folder
-        use Rack::Static :url => ['public']
-        use SinatraApp
+      #this will serve all the files in the "public" folder
+      use Rack::Static :url => ['public']
+      use SinatraApp
     end
-    
+
 I recommend looking at [the list of Rack middlewares][rack-middleware]
 
 ## Helpers
@@ -141,10 +200,12 @@ I recommend looking at [the list of Rack middlewares][rack-middleware]
 NYNY supports helpers as Sinatra does:
 
     class App < NYNY::App
-        helpers MyHelperModule
+      helpers MyHelperModule
     end
 
-Using a helper implies that the helper module is included in the [RequestScope][2], and that all the methods in that module will be available inside a route definition block.
+Using a helper implies that the helper module is included in the [RequestScope][2],
+and that all the methods in that module will be available inside a route
+definition block.
 
 # F. A. Q.
 TBD.
@@ -160,8 +221,8 @@ TBD.
 
 [0]: https://github.com/sinatra/sinatra/blob/master/lib/sinatra/base.rb
 [1]: https://github.com/sinatra/sinatra/pull/716
-[2]: https://github.com/alisnic/frankie/blob/master/lib/frankie/request_scope.rb
+[2]: https://github.com/alisnic/nyny/blob/master/lib/nyny/request_scope.rb
 [3]: http://rack.rubyforge.org/doc/classes/Rack/Request.html
 [4]: http://rack.rubyforge.org/doc/classes/Rack/Response.html
-[performance]: https://github.com/alisnic/frankie/blob/master/Performance.md
+[performance]: https://github.com/alisnic/nyny/blob/master/Performance.md
 [rack-middleware]: https://github.com/rack/rack/wiki/List-of-Middleware

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "run all specs"
+RSpec::Core::RakeTask.new(:default)
+

data/benchmarks/filters/{frankie.rb → nyny.rb}

@@ -1,7 +1,7 @@
 #!ruby -I ../../lib -I lib
-require 'frankie'
+require 'nyny'
 
-class App < Frankie::App
+class App < NYNY::App
   before do
     request
   end

data/benchmarks/helpers/{frankie.rb → nyny.rb}

@@ -1,5 +1,5 @@
 #!ruby -I ../../lib -I lib
-require 'frankie'
+require 'nyny'
 
 module Dude
   def da_request_man
@@ -7,7 +7,7 @@ module Dude
   end
 end
 
-class App < Frankie::App
+class App < NYNY::App
   helpers Dude
 
   get '/' do

data/benchmarks/simple/{frankie.rb → nyny.rb}

@@ -1,7 +1,7 @@
 #!ruby -I ../../lib -I lib
-require 'frankie'
+require 'nyny'
 
-class App < Frankie::App
+class App < NYNY::App
   get '/' do
     'Hello World!'
   end

data/benchmarks/url_pattern/{frankie.rb → nyny.rb}

@@ -1,7 +1,7 @@
 #!ruby -I ../../lib -I lib
-require 'frankie'
+require 'nyny'
 
-class App < Frankie::App
+class App < NYNY::App
   get '/hello/:name' do
     "Hello #{params[:name]}!"
   end

data/examples/active_record/server.rb

@@ -6,14 +6,14 @@ require 'rubygems'
 require 'bundler'
 Bundler.setup(:default, ENV['RACK_ENV'].to_sym)
 
-require 'frankie'
+require 'nyny'
 require_relative 'database'
 
 #Require all models
 Dir[File.dirname(__FILE__) + "/models/*.rb"].each {|file| require file }
 TEMPLATE = DATA.read.freeze
 
-class App < Frankie::App
+class App < NYNY::App
   get '/' do
     shouts = Shout.all.reverse
     ERB.new(TEMPLATE).result(binding)

data/examples/data_mapper/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+gem 'sqlite3'
+gem 'rack'
+gem 'thin'
+
+gem 'data_mapper', '~> 1.2.0'
+gem 'dm-sqlite-adapter', '~> 1.2.0'

data/examples/data_mapper/database.rb

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

data/examples/data_mapper/models/shout.rb

@@ -0,0 +1,7 @@
+class Shout
+  include DataMapper::Resource
+
+  property :id,   Serial
+  property :body, String
+end
+