happy 0.1.0.pre21 → 0.1.0.pre22

data/README.md

@@ -6,105 +6,45 @@
 
 Happy is a toolkit for developing web applications using Ruby. Inspired by both Sinatra and Rails, it sits somewhere in the middle, trying to offer the super-light-weight attitude and flexibility of Sinatra, the comfort and power of Rails, and adding a big chunk of extensibility and modularity that any lover of object-oriented application design will enjoy.
 
-Furthermore, the way Happy handles incoming requests is vastly different from how most of the other frameworks do it, offering a new, extremely flexible and, yes, fun way of building your application.
+Furthermore, the way Happy handles incoming requests is vastly different from how most of the other frameworks do it, offering a new, extremely flexible and suspiciously fun way of building your application.
 
-### Examples
+## Installing
 
-"Hello world" with Happy:
+Happy is available as a RubyGem, so just install it through `gem install happy` (or add it to your project's `Gemfile`. You know the drill.)
 
-```ruby
-# config.ru
-require 'happy'
 
-Happy.route do
-  'Hello world'
-end
 
-run Happy
-```
+## Tutorial: The Basics
 
-How about something a little bit closer to reality?
+### Hello world
 
-```ruby
-# config.ru
-require 'happy'
+TODO
 
-Happy.route do
-  # Set a default layout for all responses!
-  layout 'application.erb'
+### Dealing with paths
 
-  # Happily deal with sub-paths!
-  path 'hello' do
-    # Let's use a different layout here.
-    layout 'hello_layout.erb'
+TODO
 
-    # Happily deal with parameters contained in paths!
-    path :name do
-      # Just return a string to happily render it!
-      "Hello, #{params['name']}"!
-    end
+### Rendering templates
 
-    "Silly user, didn't provide a name!"
-  end
+TODO
 
-  # Now let's do something a little bit more exciting!
-  #
-  # How about passing control to another controller? In this instance,
-  # we're invoking an instance of ResourceMounter, a controller class
-  # that serves a model resource RESTful-Rails-style. We'll save a 
-  # reference to the controller for later.
 
-  articles = ResourceMounter.new(:class => Article)
-  articles.perform
 
-  # Or use the shortcut: invoke :resource_mounter, :class => Article
+## Tutorial: Working with Controllers
 
-  # This block of code is executed for every request, so you can do
-  # some crazy stuff here, including only defining specific paths
-  # when certain conditions are given. Just write Ruby! :)
-  
-  if context.user_is_admin?
-    path 'delete_everything' do
-      Article.delete_all
+### Invoking another controller
 
-      # How about rendering a view template and passing
-      # variables to it?
-      render 'admin_message.erb',
-        :message => 'You just deleted everything. Grats!'
-    end
-  end
+TODO
 
-  # If we reach this point, the request still hasn't been handled, so
-  # the user must by trying to access the root URL. How about a redirect
-  # to the URL of the previously invoked controller?
-  
-  redirect! articles.root_url
-end
+### Setting controller options
 
-run Happy
-```
+TODO
 
 
-### The Basic Building Blocks
 
-Each and every web application built with Happy revolves around two core building blocks: the **context** and one or more **controllers**.
 
-The **context** is a wrapper around the request currently being handled by your application. It holds information about the request itself, the response being rendered, and any piece of application logic that's scoped to individual requests (like authentication or authorization related code.) Happy doesn't have view helpers (like Rails); instead, view templates are rendered within the scope of the current context.
-
-**Controllers** are building blocks that mostly deal with routing and acting on request URLs. Unlike controllers in Rails, instead of deciding on what controller to run depending on the requested URL, each request is immediately passed to a **root controller** which then decides how to continue. Controllers can serve content, parse the URL for paths, or even pass on control over the request to a different controller.
-
-Controllers are the magic behind Happy; they're essentially **re-useable, self-contained, easily testable** web application classes that can be mounted at any URL you require. They can be as simple as serving a single response or as complex as a complete admin backend or blog engine. And finally, Happy Controllers are also **Rack applications**, so you can even use them anywhere you can mount Rack apps!
-
-
-### More Happy Features
-
-In addition to its fun and flexible approach to writing web applications, Happy boasts the following features, among others:
-
-* Optional run-time permission management provided by [Allowance](https://github.com/hmans/allowance).
-* A set of Happy Controllers making you super-productive, from serving static files to minifying JavaScript assets or even serving complete RESTful resources.
-* A set of view helpers including [simple_form](https://github.com/plataformatec/simple_form) inspired forms on auto-pilot, with full support for translations and localization through [I18n](https://github.com/svenfuchs/i18n).
-* Happy _loves_ Rack. You can mount Rack Middleware as well as pass control to another Rack application, just like that. Or use Happy Controllers from within other applications -- they're just Rack apps. And, of course, serve your Happy application through any Rack-compliant Rack server.
 
+# Additional Information
 
 ## Current Status
 

data/example/config.ru

@@ -17,7 +17,7 @@ class TestApp < Happy::Controller
   #
   # This method can be as simple or complex as you like. In this example
   # application, it wraps around a couple of annotated Happy examples.
-  # Usually, you'd use the #path method to specify code to be executed if
+  # Usually, you'd use the #path? method to specify code to be executed if
   # a certain path was requested; in this app, we're using a custom #example
   # method, that does the same thing but also records the example in a hash
   # so we can generated a "table of contents" in index.erb.
@@ -38,8 +38,8 @@ class TestApp < Happy::Controller
     end
 
     example 'Path parameters' do
-      path 'hello' do
-        path :name do
+      path? 'hello' do
+        path? :name do
           "Hello, #{params['name']}!"
         end
       end
@@ -48,7 +48,7 @@ class TestApp < Happy::Controller
     end
 
     example 'Inline path parameters' do
-      path 'hello-:name' do
+      path? 'hello-:name' do
         "Hello, #{params['name']}!"
       end
 
@@ -59,7 +59,7 @@ class TestApp < Happy::Controller
       # set up permissions ;-)
       can.dance!
 
-      path 'dance' do
+      path? 'dance' do
         if can.dance?
           "You can dance."
         else
@@ -71,10 +71,10 @@ class TestApp < Happy::Controller
     end
 
     example 'Layouts' do
-      path 'with-layout' do
+      path? 'with-layout' do
         layout 'layout.erb'
 
-        path 'changed-my-mind' do
+        path? 'changed-my-mind' do
           layout false
           "This should render without a layout."
         end
@@ -120,7 +120,7 @@ class TestApp < Happy::Controller
     examples[name] = path_name
 
     # Create a path containing the example's code block
-    path(path_name, &blk)
+    path?(path_name, &blk)
   end
 end
 

data/lib/happy/controller/rackable.rb

@@ -24,7 +24,7 @@ module Happy
 
       module ClassMethods
         def call(env)
-          new(env).handle_request
+          new(env).handle_request.to_a
         end
       end
     end

data/lib/happy/controller/routing.rb

@@ -7,7 +7,7 @@ module Happy
         Regexp.compile('^'+path.gsub(/\)/, ')?').gsub(/\//, '\/').gsub(/\./, '\.').gsub(/:(\w+)/, '(.+)')+'$')
       end
 
-      def path(*args, &blk)
+      def path?(*args, &blk)
         options = (args.pop if args.last.is_a?(Hash)) || {}
         args = [nil] if args.empty?
 
@@ -40,9 +40,9 @@ module Happy
       end
 
       [:get, :post, :put, :delete].each do |method|
-        define_method(method) do |*args, &blk|
+        define_method("#{method}?") do |*args, &blk|
           args.last.is_a?(Hash) ? args.last.merge(:method => method) : args.push(:method => method)
-          path(*args, &blk)
+          path?(*args, &blk)
         end
       end
     end

data/lib/happy/extras/resources.rb

@@ -95,17 +95,17 @@ module Happy
           options[:singular_name] ||= options[:class].to_s.tableize.singularize
           options[:plural_name]   ||= options[:class].to_s.tableize.pluralize
 
-          path options[:plural_name] do
-            get('new') { do_new }
+          path? options[:plural_name] do
+            get?('new') { do_new }
 
-            path :id do
-              get         { do_show }
-              post        { do_update }
-              get('edit') { do_edit }
+            path? :id do
+              get?         { do_show }
+              post?        { do_update }
+              get?('edit') { do_edit }
             end
 
-            post { do_create }
-            get  { do_index }
+            post? { do_create }
+            get?  { do_index }
           end
         end
       end

data/lib/happy/version.rb

@@ -1,3 +1,3 @@
 module Happy
-  VERSION = "0.1.0.pre21"
+  VERSION = "0.1.0.pre22"
 end

data/spec/controller/actions_spec.rb

@@ -7,10 +7,10 @@ module Happy
     describe '#serve!' do
       def app
         build_controller do
-          path('simple') { serve! "Simple response" }
-          path('with_headers') { serve! "body { color: red }", :content_type => 'text/css' }
-          path('with_status')  { serve! "Not Allowed", :status => 401 }
-          path('with_layout')  { serve! "content", :layout => 'layout.erb' }
+          path?('simple') { serve! "Simple response" }
+          path?('with_headers') { serve! "body { color: red }", :content_type => 'text/css' }
+          path?('with_status')  { serve! "Not Allowed", :status => 401 }
+          path?('with_layout')  { serve! "content", :layout => 'layout.erb' }
         end
       end
 
@@ -45,7 +45,7 @@ module Happy
         def app
           Happy.route do
             serve! "This should not render"
-            path 'test' do
+            path? 'test' do
               serve! "But this should render"
             end
           end
@@ -80,7 +80,7 @@ module Happy
           Happy.route do
             redirect! "http://mans.de"
 
-            path 'test' do
+            path? 'test' do
               redirect! "http://schnitzelpress.org"
             end
           end

data/spec/controller/cascadable_spec.rb

@@ -7,11 +7,11 @@ module Happy
       it "passes on all method calls to a parent if there is one" do
         class Inner < Controller
           def route
-            path 'one' do
+            path? 'one' do
               some_helper
             end
 
-            path 'two' do
+            path? 'two' do
               some_unknown_helper
             end
           end

data/spec/controller/routing_spec.rb

@@ -5,17 +5,17 @@ module Happy
     describe '#path' do
       subject do
         Happy.route do
-          path('foo') { serve! 'bar' }
-          path('one', 'two') { serve! 'onetwo' }
-          path('hello') do
-            path(:name) { serve! "Hello #{params['name']}" }
+          path?('foo') { serve! 'bar' }
+          path?('one', 'two') { serve! 'onetwo' }
+          path?('hello') do
+            path?(:name) { serve! "Hello #{params['name']}" }
             serve! "Please provide a name."
           end
-          path('number-:num') { serve! "num = #{params['num']}" }
-          path('return-value') { 'moo?' }
-          path('resource') do
-            get { 'GET resource' }
-            post { 'POST resource' }
+          path?('number-:num') { serve! "num = #{params['num']}" }
+          path?('return-value') { 'moo?' }
+          path?('resource') do
+            get? { 'GET resource' }
+            post? { 'POST resource' }
           end
           serve! "root"
         end
@@ -62,12 +62,12 @@ module Happy
     end
 
     %w(get post put delete).each do |what|
-      describe "##{what}" do
+      describe "##{what}?" do
         subject { Controller.new }
 
-        it "merely invokes #path with the :method => :#{what} option" do
-          subject.should_receive(:path).with('path', :method => what.to_sym)
-          subject.send(what, 'path')
+        it "merely invokes #path? with the :method => :#{what} option" do
+          subject.should_receive(:path?).with('path', :method => what.to_sym)
+          subject.send("#{what}?", 'path')
         end
       end
     end

data/spec/controller_spec.rb

@@ -22,8 +22,8 @@ module Happy
       it "returns the current URL" do
         def app
           build_controller do
-            path 'foo' do
-              path 'bar' do
+            path? 'foo' do
+              path? 'bar' do
                 "My URL is #{current_url}"
               end
 
@@ -42,7 +42,7 @@ module Happy
       it "appends extra paths to the URL if provided" do
         def app
           build_controller do
-            path 'foo' do
+            path? 'foo' do
               current_url('bar', 'moo')
             end
           end
@@ -56,7 +56,7 @@ module Happy
       it "returns the controller's root URL" do
         def app
           root_url_printer = build_controller do
-            path 'bar' do
+            path? 'bar' do
               "My root URL is still #{root_url}"
             end
 
@@ -64,7 +64,7 @@ module Happy
           end
 
           build_controller do
-            path 'foo' do
+            path? 'foo' do
               run root_url_printer
             end
 
@@ -84,7 +84,7 @@ module Happy
           end
 
           build_controller do
-            path 'foo' do
+            path? 'foo' do
               run some_controller
             end
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: happy
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre21
+  version: 0.1.0.pre22
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-12 00:00:00.000000000 Z
+date: 2012-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70146774651160 !ruby/object:Gem::Requirement
+  requirement: &70226632793780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70146774651160
+  version_requirements: *70226632793780
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70146774650120 !ruby/object:Gem::Requirement
+  requirement: &70226632793280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70146774650120
+  version_requirements: *70226632793280
 - !ruby/object:Gem::Dependency
   name: happy-helpers
-  requirement: &70146774648720 !ruby/object:Gem::Requirement
+  requirement: &70226632792820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.1.0.pre11
   type: :runtime
   prerelease: false
-  version_requirements: *70146774648720
+  version_requirements: *70226632792820
 - !ruby/object:Gem::Dependency
   name: allowance
-  requirement: &70146774646980 !ruby/object:Gem::Requirement
+  requirement: &70226632792360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *70146774646980
+  version_requirements: *70226632792360
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70146774662260 !ruby/object:Gem::Requirement
+  requirement: &70226632791980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70146774662260
+  version_requirements: *70226632791980
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70146774660060 !ruby/object:Gem::Requirement
+  requirement: &70226632791440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *70146774660060
+  version_requirements: *70226632791440
 - !ruby/object:Gem::Dependency
   name: rspec-html-matchers
-  requirement: &70146774658460 !ruby/object:Gem::Requirement
+  requirement: &70226632791020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70146774658460
+  version_requirements: *70226632791020
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70146774657580 !ruby/object:Gem::Requirement
+  requirement: &70226632790560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70146774657580
+  version_requirements: *70226632790560
 - !ruby/object:Gem::Dependency
   name: watchr
-  requirement: &70146774656440 !ruby/object:Gem::Requirement
+  requirement: &70226632790140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70146774656440
+  version_requirements: *70226632790140
 description: A happy little toolkit for writing web applications.
 email:
 - hendrik@mans.de