yard-sinatra 0.4.0.1 → 0.5.0

data/LICENSE

@@ -0,0 +1,27 @@
+copyright (c) 2010 Konstantin Haase.  All rights reserved.
+
+Developed by: Konstantin Haase
+              http://github.com/rkh/big_band
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal with 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:
+  1. Redistributions of source code must retain the above copyright notice,
+     this list of conditions and the following disclaimers.
+  2. Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimers in the
+     documentation and/or other materials provided with the distribution.
+  3. Neither the name of Konstantin Haase, nor the names of other contributors
+     may be used to endorse or promote products derived from this Software without
+     specific prior written permission.
+
+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
+CONTRIBUTORS 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
+WITH THE SOFTWARE.

data/README.md

@@ -37,6 +37,11 @@ Add comments to your routes (well, that's optional):
       get "/settings" do
         haml :settings, {}, :settings => settings(current_user)
       end
+      
+      # Error 404 Page Not Found
+      not_found do
+        haml :'404'
+      end
     
     end
 

data/lib/yard/sinatra.rb

@@ -6,6 +6,10 @@ module YARD
     def self.routes
       YARD::Handlers::Sinatra::AbstractRouteHandler.routes
     end
+
+    def self.error_handlers
+      YARD::Handlers::Sinatra::AbstractRouteHandler.error_handlers
+    end
   end
 
   module CodeObjects
@@ -37,11 +41,19 @@ module YARD
           @routes ||= []
         end
 
+        def self.error_handlers
+          @error_handlers ||= []
+        end
+
         def process
-          path = http_path
-          path = $1 if path =~ /^"(.*)"$/
-          register_route(http_verb, path)
-          register_route('HEAD', path) if http_verb == 'GET'
+          case http_verb
+          when 'NOT_FOUND'
+            register_error_handler(http_verb)
+          else
+            path = http_path
+            path = $1 if path =~ /^"(.*)"$/
+            register_route(http_verb, path)
+          end
         end
 
         def register_route(verb, path, doc = nil)
@@ -63,6 +75,22 @@ module YARD
           AbstractRouteHandler.routes << route
           yield(route) if block_given?
         end
+
+        def register_error_handler(verb, doc = nil)
+          error_handler = register CodeObjects::RouteObject.new(namespace, verb, :instance) do |o|
+            o.visibility = "public"
+            o.source     = statement.source
+            o.signature  = verb
+            o.explicit   = true
+            o.scope      = scope
+            o.docstring  = statement.comments
+            o.http_verb  = verb
+            o.real_name  = verb
+            o.add_file(parser.file, statement.line)
+          end
+          AbstractRouteHandler.error_handlers << error_handler
+          yield(error_handler) if block_given?
+        end
       end
 
       # Route handler for YARD's source parser.
@@ -74,6 +102,7 @@ module YARD
         handles method_call(:put)
         handles method_call(:delete)
         handles method_call(:head)
+        handles method_call(:not_found)
 
         def http_verb
           statement.method_name(true).to_s.upcase
@@ -88,7 +117,7 @@ module YARD
       module Legacy
         class RouteHandler < Ruby::Legacy::Base
           include AbstractRouteHandler
-          handles /\A(get|post|put|delete|head)[\s\(].*/m
+          handles /\A(get|post|put|delete|head|not_found)[\s\(].*/m
 
           def http_verb
             statement.tokens.first.text.upcase

data/spec/example_app.rb

@@ -17,7 +17,12 @@ class ExampleApp < Sinatra::Base
   get "/settings" do
     haml :settings, {}, :settings => settings(current_user)
   end
-  
+
+  # Error 404 Page Not Found
+  not_found do
+    haml :'404'
+  end
+
   put("/settings") { }
   delete("/settings") { }
   post("/settings") { }

data/spec/yard/sinatra_spec.rb

@@ -7,7 +7,7 @@ describe YARD::Sinatra do
   end
 
   it "reads sinatra routes" do
-    YARD::Sinatra.routes.size.should == 6
+    YARD::Sinatra.routes.size.should == 5
   end
 
   it "sets properties correctly" do
@@ -18,4 +18,17 @@ describe YARD::Sinatra do
       route.docstring.should =~ /Displays a settings page for the current user/ if route.http_verb == "GET"
     end
   end
+
+  it "reads sinatra error handlers" do
+    YARD::Sinatra.error_handlers.size.should == 1
+  end
+
+  it "sets error handlers correctly" do
+    YARD::Sinatra.error_handlers.each do |error_handler|
+      %w[NOT_FOUND].should include(error_handler.http_verb)
+      error_handler.file.should =~ /example_app\.rb$/
+      error_handler.docstring.should =~ /Error 404 Page Not Found/ if error_handler.http_verb == "NOT_FOUND"
+    end
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: yard-sinatra
 version: !ruby/object:Gem::Version 
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  - 1
-  version: 0.4.0.1
+  version: 0.5.0
 platform: ruby
 authors: 
 - Konstantin Haase
@@ -15,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-05 00:00:00 +01:00
+date: 2010-07-09 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: yard
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 0
         - 5
@@ -36,9 +38,11 @@ dependencies:
   name: rspec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 1
         - 3
@@ -60,6 +64,7 @@ files:
 - spec/example_app.rb
 - spec/yard/sinatra_spec.rb
 - README.md
+- LICENSE
 has_rdoc: yard
 homepage: http://github.com/rkh/yard-sinatra
 licenses: []
@@ -70,23 +75,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Displays Sinatra routes (including comments) in YARD output (part of BigBand).