renee 0.3.11 → 0.4.0.pre1

data/Gemfile

@@ -0,0 +1,17 @@
+source :rubygems
+
+gemspec :name => 'renee'
+gemspec :name => 'renee-core'
+gemspec :name => 'renee-render'
+
+gem 'rdiscount'
+gem 'haml'
+gem 'rack-codehighlighter'
+gem 'rack-google-analytics'
+gem 'coderay'
+
+group :development do
+  gem 'shotgun'
+  gem 'rake'
+  gem 'yard', '~> 0.7.4'
+end

data/Gemfile-renee

@@ -0,0 +1,8 @@
+source :rubygems
+
+gemspec :name => 'renee'
+
+group :development do
+  gem 'rdiscount'
+  gem 'rake'
+end

data/Gemfile-renee-core

@@ -0,0 +1,8 @@
+source :rubygems
+
+gemspec :name => 'renee-core'
+
+group :development do
+  gem 'rdiscount'
+  gem 'rake'
+end

data/Gemfile-renee-render

@@ -0,0 +1,9 @@
+source :rubygems
+
+gemspec :name => 'renee-core'
+gemspec :name => 'renee-render'
+
+group :development do
+  gem 'rdiscount'
+  gem 'rake'
+end

data/Gemfile-renee-session

@@ -0,0 +1,9 @@
+source :rubygems
+
+gemspec :name => 'renee-core'
+gemspec :name => 'renee-session'
+
+group :development do
+  gem 'rdiscount'
+  gem 'rake'
+end

data/Gemfile-renee-url-generation

@@ -0,0 +1,8 @@
+source :rubygems
+
+gemspec :name => 'renee-url-generation'
+
+group :development do
+  gem 'rdiscount'
+  gem 'rake'
+end

data/MIT-LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Joshua Hull, Nathan Esquenazi, Arthur Chiu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README-renee-core.md

@@ -0,0 +1,242 @@
+# Renee Core
+
+## Routing
+
+Routing in `Renee` is different from any web framework you are likely to have used in the past. The syntax is most familiar to Sinatra but allows
+for far more flexibility and freedom in the way that routes and actions are defined. In a Renee, routes are defined using the `path`, `var`, `query_string`, `extension`, `remainder` and request methods.
+
+**Request Methods**
+
+The bread and butter of Renee are the request verbs reminiscent of Sinatra:
+
+```ruby
+run Renee.core {
+  get    { halt "a get!"  }
+  post   { halt "a post!" }
+  put    { halt "a put!"  }
+  delete { halt "a delete!" }
+}
+```
+
+These will declare the response to "/" for each of the common request types. Notice the use of the request method to
+specify the http verb and the use of `halt` inside the block to send back the body of the response.
+
+**Path**
+
+Path is how Renee describes the basic uri path for a route:
+
+```ruby
+run Renee.core {
+  path('blog') { ... }
+}
+```
+
+All declarations inside that block will start with `/blog`. Paths can also be nested within one another:
+
+```ruby
+run Renee.core {
+  path('blog') {
+    path('foo') { get { halt "path is /blog/foo" } }
+  }
+}
+```
+
+You can also use `exact_path` for more precise path matching and/or `part` which doesn't look for leading slashes.
+
+**Query String**
+
+In addition to defining paths, you may find yourself wanting to describe the state of the query string for a request within the path:
+
+```ruby
+path 'foo' do
+  query_string 'bar' do
+    get { halt 'BAR!' }
+  end
+
+  query_string 'baz' do
+    get { halt 'BAZ!' }
+  end
+end
+```
+
+This will respond to `/foo?bar` with "BAR!" and `/foo?baz` with "BAZ!". You can also specify query_string in a variety of other ways:
+
+```ruby
+# Check key and value of query param
+query_string 'foo=bar' do
+  post { halt [200,{},'foo'] }
+end
+
+# Declare query params as a hash
+query :foo => "bar" do
+  halt 200
+end
+
+# Switch based on a query parameter
+query :foo do |var|
+  case var
+  when 'bar' then halt 200
+  when 'bar2' then halt 500
+  end
+end
+```
+
+**Variables**
+
+In Renee, you specify parameters for your request as explicit variables. Variables are declared like this:
+
+```ruby
+path('blog') {
+  var { |id| get { halt "path is /blog/#{id}" } }
+}
+```
+
+You can access the variables (passed into the request) using the local variables yielded to the block. Variables are a powerful
+way to express expected parameters for a given set of requests. You can specify variables that match a regex:
+
+```ruby
+path('blog') {
+  var(/\d+/) { |id| get { halt "path is /blog/#{id}" } }
+}
+```
+
+and even explicitly cast your variable types:
+
+```ruby
+path('blog') {
+  var :integer do |id|
+    get { halt "path is /blog/#{id} and id is an integer" }
+  end
+end
+```
+
+**Extensions**
+
+You can also use `extension` as a way to define formats:
+
+```ruby
+path '/test' do
+  extension 'html' do
+    halt 'html'
+  end
+  extension 'json' do
+    halt 'json'
+  end
+end
+```
+
+This will have `test.html` respond with 'html' and `test.json` respond with 'json'.
+
+**Remainder**
+
+In the event that no route has been matched, the `remainder` keyword makes defining the else case rather easy:
+
+```ruby
+path 'foo' do
+  path 'bar' do
+    halt "BAR!"
+  end
+
+  remainder do |rest|
+    halt "Rest was #{rest}"
+  end
+end
+```
+
+Notice this allows you to handle the cases within a particular route scope and manage them based on the "rest" of the uri yielded in the `remainder` block. You
+can handle different remainders in all the different path blocks.
+
+**Named Routes**
+
+Once you have defined your routes, you can then "register" a particular path mapping that to a symbol. This is useful for referencing routes without
+having to specify the entire path:
+
+```ruby
+run Renee.core {
+  register(:test, '/test/time')
+  register(:test_var, '/test/:id')
+}
+```
+
+You can then access these using the `path` method in a route or template:
+
+```ruby
+path(:test) # => '/test/time'
+path(:test_var, :id => 123) # => '/test/123'
+```
+
+Using named routes makes referencing and modifying routes within an application much simpler to manage.
+
+## Responding
+
+Responding to a request within a route can be managed with the `respond`, `halt`, `redirect` commands:
+
+**Respond**
+
+The `respond` command makes returning a rack response very explicit, you can respond as if you were constructing a Rack::Response
+
+```ruby
+run Renee {
+  get { respond!("hello!", 403, "foo" => "bar") }
+}
+```
+
+or use the block DSL for convenience:
+
+```ruby
+run Renee {
+  get { respond! { status 403; headers :foo => "bar"; body "hello!" } }
+}
+```
+
+**Halt**
+
+Halting is the easiest way to render data within a route:
+
+```ruby
+run Renee.core {
+  get { halt 'easy' }
+}
+```
+
+This will return a 200 status code and 'easy' as the body. You can also specify status code and header explicitly in the halt response:
+
+```ruby
+get { halt [200, {}, 'body'] }
+```
+
+This will set the status code to 200, pass no headers and return 'body'. You can also use several variations of halt:
+
+```ruby
+# Return just status code
+halt 200
+
+# Return status with symbol
+halt :not_found
+
+# Return 200 with body
+halt "hello!"
+
+# Return 500 with body
+halt 500, "hello!"
+```
+
+Halt is the most straightforward way to control the response for a request.
+
+**Redirect**
+
+A redirect is a common action within a web route and can be achieved with the convenience method `redirect` command:
+
+```ruby
+get {
+  halt redirect('/hello')
+}
+```
+
+You can also specify the status code for the redirect:
+
+```ruby
+get {
+  halt redirect('/hello', 303)
+}
+```

data/README-renee-render.md

@@ -0,0 +1,38 @@
+# Renee Render
+
+Rendering templates in Renee should be familiar and intuitive using the `render` command:
+
+```ruby
+run Renee.core {
+ path('blog') do
+   get { render! "blogs/index", :haml }
+ end
+}
+```
+
+This above is the standard render syntax, specifying the engine followed by the template. You can also render without specifying an engine:
+
+```ruby
+path('blog') do
+  get { render! "blogs/index" }
+end
+```
+
+This will do a lookup in the views path to find the appropriately named template. You can also pass locals and layout options as you would expect:
+
+```ruby
+path('blog') do
+  get { render! "blogs/index", :locals => { :foo => "bar" }, :layout => :bar }
+end
+```
+
+This will render the "blogs/index.erb" file if it exists, passing the 'foo' local variable
+and wrapping the result in the 'bar.erb' layout file. You can also render without returning the response by using:
+
+```ruby
+path('blog') do
+  get { render "blogs/index" }
+end
+```
+
+This allows you to render the content as a string without immediately responding.

data/README-renee-session.md

@@ -0,0 +1,3 @@
+# Renee Session
+
+Defines methods for accessing the session.

data/README-renee-url-generation.md

@@ -0,0 +1,3 @@
+# Renee URL Generation
+
+The URL generation is pretty nifty.

data/README.md

@@ -1,10 +1,135 @@
 # Renee
 
-For usage of this gem, please checkout [http://reneerb.com](http://reneerb.com)!
+The super friendly rack-based web framework.
 
-## Example
+## Introduction
 
-    # config.ru
-    run Renee {
-      halt "Hello Renee!"
-    }
+Renee is a new Rack-based library for describing web applications. Sinatra delivered a new simple way to think about building web applications. The popularity of Sinatra both as a library and as a concept shows now enduring the concept really was. Sinatra was different from Rails because the entire DSL was lightweight, easy to read and combined routing and actions into a single file. However, let's consider an example from Sinatra to see where we can improve upon this.
+
+Consider:
+
+```ruby
+get '/blog/:id' do
+  Blog.get(params[:id])
+end
+```
+
+This is not too bad so far. The repetition of `:id` is a bit un-DRY, but not bad. Let's keep expanding upon this.
+
+```ruby
+get '/blog/:id' do
+  Blog.get(params[:id])
+end
+
+put '/blog/:id' do
+  Blog.get(params[:id]).update_attributes(params)
+end
+```
+
+Now, we've retrieved blog in two places. Time to refactor. We'd normally create a before filter, with the same path.
+
+```ruby
+before '/blog/:id' do
+  @blog = Blog.get(params[:id])
+end
+
+get '/blog/:id' do
+  @blog
+end
+
+put '/blog/:id' do
+  @blog.update_attributes(params)
+end
+```
+
+Now we've repeated the same path three times. With Renee, we can describe these kind of ideas in a simple, easy-to-read way. Here is the equivalent in Renee.
+
+```ruby
+path 'blog' do
+  var do |id|
+    @blog = Blog.get(id)
+    get { halt @blog }
+    put { @blog.update(request.params); halt :ok}
+  end
+end
+```
+
+This web library is inspired by Sinatra, but offers an approach more inline with Rack itself, and lets you maximize code-reuse within your application.
+
+## Installation
+
+Setup Renee by running:
+
+```
+gem install renee
+```
+
+or by adding `Renee` to your `Gemfile`:
+
+```ruby
+# Gemfile
+gem "renee", "~> 0.0.1"
+```
+
+Now you can start using Renee for your application!
+
+## Usage
+
+In your rackup file, give this a go!
+
+```ruby
+require 'renee'
+
+run Renee.core {
+  path('test') do
+    get { halt "Hey, this is a get!" }
+    post { halt "and .. a post" }
+
+    var do |id|
+      halt "Getting the blog with id #{id}"
+    end
+  end
+}
+```
+
+This rack-app will respond to GET /test with "Hey, this is a get!", POST /test with "and .. a post" and /test/:id with `"Getting the blog with id #{id}"`.
+
+A more complete example might be sample RESTful routing definitions for a blog post resource:
+
+```ruby
+require 'renee'
+
+run Renee.core {
+  path('posts') do
+    @posts = Post.all
+    # GET /posts
+    get  { render! "index" }
+    # POST /posts
+    post { redirect! "/posts/index" }
+
+    path('new') do
+      # GET /posts/new
+      get { render! "new" }
+    end
+
+    var :integer do |id|
+      @post = Post.find(id)
+
+      # GET /posts/5
+      get { render! 'show' }
+      # PUT /posts/5
+      put { halt "update" }
+      # DELETE /posts/5
+      delete { halt "delete" }
+
+      path('edit') do
+        # GET /posts/5/edit
+        get { render! "edit" }
+      end
+    end
+  end
+}
+```
+
+This implements the standard 7 REST actions in a very concise and simple way. The routes and the actions blended together utilizing the various
+Renee routing methods and block syntax. The routing methods are defined below, followed by an explanation of how to respond to a route.