https://github.com/github/yard-sinatra

Display sinatra routes in yard documentation.
https://github.com/github/yard-sinatra

Last synced: 8 months ago
JSON representation

Display sinatra routes in yard documentation.

• Host: GitHub
• URL: https://github.com/github/yard-sinatra
• Owner: github
• License: ncsa
• Archived: true
• Fork: true (rkh/yard-sinatra)
• Created: 2012-07-17T19:04:27.000Z (almost 14 years ago)
• Default Branch: master
• Last Pushed: 2015-02-14T23:02:01.000Z (over 11 years ago)
• Last Synced: 2024-09-29T00:21:35.421Z (over 1 year ago)
• Language: Ruby
• Homepage:
• Size: 241 KB
• Stars: 5
• Watchers: 31
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
**NOTE: This is an archived fork and is no longer supported or updated by GitHub. If you wish to continue to develop this code yourself, we recommend you fork it.**

YARD::Sinatra

=============

This plugin adds [Sinatra](http://sinatrarb.com) routes to [YARD](http://yardoc.org/) output.

Usage

-----

Install via rubygems:

    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.