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

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

Last synced: 20 days ago
JSON representation

Display sinatra routes in yard documentation.

• Host: GitHub
• URL: https://github.com/rkh/yard-sinatra
• Owner: rkh
• License: ncsa
• Created: 2010-02-15T10:46:25.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2023-12-08T20:51:08.000Z (11 months ago)
• Last Synced: 2024-10-14T19:42:48.458Z (about 1 month ago)
• Language: Ruby
• Homepage:
• Size: 30.3 KB
• Stars: 67
• Watchers: 4
• Forks: 32
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
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):

```ruby

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

Old versions of YARD (before 0.6.2) will automatically detect the yard-sinatra plugin and load it. In newer versions you must use the `--plugin yard-sinatra` parameter, or add it to a .yardopts file.

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:

```ruby

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.