cachafla-yard-sinatra 0.6.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

@@ -0,0 +1,71 @@
+YARD::Sinatra
+=============
+
+This plugin adds [Sinatra](http://sinatrarb.com) routes to [YARD](http://yardoc.org/) output.
+
+BigBand
+-------
+
+YARD::Sinatra is part of the [BigBand](http://github.com/rkh/big_band) stack.
+Check it out if you are looking for fancy Sinatra extensions.
+
+Usage
+-----
+
+Install via gemcutter:
+
+    gem install yard-sinatra
+
+Add comments to your routes (well, that's optional):
+
+    require "sinatra/base"
+    require "user"
+    
+    class ExampleApp < Sinatra::Base
+    
+      # Settings for a given user
+      #
+      # @param [User] some user
+      # @return [Hash] settings for that user
+      def settings(some_user)
+        raise NotImplementedMethod
+      end
+      
+      # Displays a settings page for the current user
+      #
+      # @see ExampleApp#settings
+      get "/settings" do
+        haml :settings, {}, :settings => settings(current_user)
+      end
+      
+      # Error 404 Page Not Found
+      not_found do
+        haml :'404'
+      end
+    
+    end
+
+The you're ready to go:
+
+    yardoc example_app.rb
+
+YARD will automatically detect the yard-sinatra plugin and load it.
+
+Other use cases
+---------------
+
+As with yard, this can be used for other means besides documentation.
+For instance, you might want a list of all routes defined in a given list of files without executing those files:
+
+    require "yard/sinatra"
+    YARD::Registry.load Dir.glob("lib/**/*.rb")
+    YARD::Sinatra.routes.each do |route|
+      puts route.http_verb, route.http_path, route.file, route.docstring
+    end
+
+Thanks
+------
+
+* Ryan Sobol for implementing `not_found` documentation.
+* Loren Segal for making it seamlessly work as YARD plugin.
+  Well, and for YARD.

data/lib/yard/sinatra.rb

@@ -0,0 +1,151 @@
+require "yard"
+
+module YARD
+
+  module Sinatra
+    def self.routes
+      YARD::Handlers::Sinatra::AbstractRouteHandler.routes
+    end
+
+    def self.error_handlers
+      YARD::Handlers::Sinatra::AbstractRouteHandler.error_handlers
+    end
+  end
+
+  module CodeObjects
+    class RouteObject < MethodObject
+      attr_accessor :http_verb, :http_path, :real_name
+
+      def name(prefix = false)
+        return super unless show_real_name?
+        prefix ? (sep == ISEP ? "#{sep}#{real_name}" : real_name.to_s) : real_name.to_sym
+      end
+
+      # @see YARD::Handlers::Sinatra::AbstractRouteHandler#register_route
+      # @see #name
+      def show_real_name?
+        real_name and caller[1] =~ /`signature'/
+      end
+    end
+  end
+
+  module Handlers
+
+    # Displays Sinatra routes in YARD documentation.
+    # Can also be used to parse routes from files without executing those files.
+    module Sinatra
+
+      # Logic both handlers have in common.
+      module AbstractRouteHandler
+        def self.routes
+          @routes ||= []
+        end
+
+        def self.error_handlers
+          @error_handlers ||= []
+        end
+
+        def process
+          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)
+          # HACK: Removing some illegal letters.
+          method_name = "" << verb << "_" << path.gsub(/[^\w_]/, "_")
+          real_name   = "" << verb << " " << path
+          route = register CodeObjects::RouteObject.new(namespace, method_name, :instance) do |o|
+            o.visibility = "public"
+            o.source     = statement.source
+            o.signature  = real_name
+            o.explicit   = true
+            o.scope      = scope
+            o.docstring  = statement.comments
+            o.http_verb  = verb
+            o.http_path  = path
+            o.real_name  = real_name
+            o.add_file(parser.file, statement.line)
+          end
+          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.
+      class RouteHandler < Ruby::Base
+        include AbstractRouteHandler
+
+        handles method_call(:get)
+        handles method_call(:post)
+        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
+        end
+
+        def http_path
+          statement.parameters.first.source
+        end
+      end
+
+      # Route handler for YARD's legacy parser.
+      module Legacy
+        class RouteHandler < Ruby::Legacy::Base
+          VERBS = %w[get head post put delete not_found]
+          include AbstractRouteHandler
+          handles /\A.*(get|post|put|delete|head|not_found.*)[\s\(].*/m
+
+          def http_verb
+            method_call_string = ''
+            space  = YARD::Parser::Ruby::Legacy::RubyToken::TkSPACE
+            lparen = YARD::Parser::Ruby::Legacy::RubyToken::TkLPAREN
+
+            for token in statement.tokens
+              if token.is_a?(space) || token.is_a?(lparen)
+                break
+              else
+                method_call_string << token.text
+              end
+            end
+
+            VERBS.detect{|v| method_call_string.include?(v)}.upcase
+          end
+
+          def http_path
+            path = statement.tokens.detect do |t|
+              t.is_a?(YARD::Parser::Ruby::Legacy::RubyToken::TkSTRING)
+            end
+
+            path.text
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/yard-sinatra.rb

@@ -0,0 +1 @@
+require 'yard/sinatra'

data/spec/example_app.rb

@@ -0,0 +1,31 @@
+require "sinatra/base"
+require "user"
+
+class ExampleApp < Sinatra::Base
+
+  # Settings for a given user
+  #
+  # @param [User] some user
+  # @return [Hash] settings for that user
+  def settings(some_user)
+    raise NotImplementedMethod
+  end
+  
+  # Displays a settings page for the current user
+  #
+  # @see ExampleApp#settings
+  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") { }
+  head("/settings") { }
+
+end

data/spec/example_extension.rb

@@ -0,0 +1,42 @@
+require 'sinatra/base'
+
+module Sinatra
+  module SessionAuth
+
+    def self.registered(app)
+      app.set :username, 'frank'
+      app.set :password, 'changeme'
+
+      # Displays a login form for the user
+      app.get '/login' do
+        "<form method='POST' action='/login'>" +
+        "<input type='text' name='user'>" +
+        "<input type='text' name='pass'>" +
+        "</form>"
+      end
+
+      # POST /login
+      app.post '/login' do
+        if params[:user] == options.username && params[:pass] == options.password
+          session[:authorized] = true
+          redirect '/'
+        else
+          session[:authorized] = false
+          redirect '/login'
+        end
+      end
+
+      # Error 404 Page Not Found
+      app.not_found '/test' do
+        haml :'404'
+      end
+
+    end
+  end
+
+  register SessionAuth
+end
+
+class MyApp < Sinatra::Base
+  register Sinatra::SessionAuth
+end

data/spec/yard/sinatra_extension_spec.rb

@@ -0,0 +1,38 @@
+require "yard/sinatra"
+
+describe YARD::Sinatra do
+
+  before(:all) do
+    $NO_CONTINUATION_WARNING = true
+    YARD::Registry.load [File.expand_path("../../example_extension.rb", __FILE__)], true
+  end
+
+  describe "Sinatra Extensions" do
+
+    it "reads sinatra routes" do
+      YARD::Sinatra.routes.size.should == 2
+    end
+
+    it "sets properties correctly" do
+      YARD::Sinatra.routes.each do |route|
+        %w[GET HEAD POST PUT DELETE].should include(route.http_verb)
+        route.http_path.should =~ /login/
+        route.file.should =~ /example_extension\.rb$/
+        route.docstring.should =~ /Displays a login form for the 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_extension\.rb$/
+        error_handler.docstring.should =~ /Error 404 Page Not Found/ if error_handler.http_verb == "NOT_FOUND"
+      end
+    end
+  end
+
+end

data/spec/yard/sinatra_spec.rb

@@ -0,0 +1,38 @@
+require "yard/sinatra"
+
+describe YARD::Sinatra do
+
+  before(:all) do
+    $NO_CONTINUATION_WARNING = true
+    YARD::Registry.load [File.expand_path("../../example_app.rb", __FILE__)], true
+  end
+
+  describe "Sinatra Apps" do
+
+    it "reads sinatra routes" do
+      YARD::Sinatra.routes.size.should == 5
+    end
+
+    it "sets properties correctly" do
+      YARD::Sinatra.routes.each do |route|
+        %w[GET HEAD POST PUT DELETE].should include(route.http_verb)
+        route.http_path.should =~ /settings/
+        route.file.should =~ /example_app\.rb$/
+        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
+
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: cachafla-yard-sinatra
+version: !ruby/object:Gem::Version 
+  hash: 7
+  prerelease: false
+  segments: 
+  - 0
+  - 6
+  - 0
+  version: 0.6.0
+platform: ruby
+authors: 
+- Konstantin Haase
+- Andres Rodriguez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-14 00:00:00 -08: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: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id002
+description: Displays Sinatra routes (including comments) in YARD output (part of BigBand).
+email: andres@joyent.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/yard/sinatra.rb
+- lib/yard-sinatra.rb
+- spec/example_app.rb
+- spec/example_extension.rb
+- spec/yard/sinatra_extension_spec.rb
+- spec/yard/sinatra_spec.rb
+- README.md
+- LICENSE
+has_rdoc: yard
+homepage: http://github.com/cachafla/cachafla-yard-sinatra
+licenses: []
+
+post_install_message: 
+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.7
+signing_key: 
+specification_version: 3
+summary: Displays Sinatra routes (including comments) in YARD output (part of BigBand).
+test_files: []
+