yard-sinatra 0.2.5 → 0.4.0

data/README.md

@@ -0,0 +1,59 @@
+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
+    
+    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

data/lib/yard/sinatra.rb

@@ -0,0 +1,105 @@
+require "yard"
+
+module YARD
+
+  module Sinatra
+    def self.routes
+      YARD::Handlers::Sinatra::AbstractRouteHandler.routes
+    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 process
+          path = http_path
+          path = $1 if path =~ /^"(.*)"$/
+          register_route(http_verb, path)
+          register_route('HEAD', path) if http_verb == 'GET'
+        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
+      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)
+
+        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
+          include AbstractRouteHandler
+          handles /\A(get|post|put|delete|head)[\s\(].*/m
+
+          def http_verb
+            statement.tokens.first.text.upcase
+          end
+
+          def http_path
+            statement.tokens[2].text
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/example_app.rb

@@ -0,0 +1,26 @@
+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
+  
+  put("/settings") { }
+  delete("/settings") { }
+  post("/settings") { }
+  head("/settings") { }
+
+end

data/spec/yard/sinatra_spec.rb

@@ -0,0 +1,21 @@
+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
+
+  it "reads sinatra routes" do
+    YARD::Sinatra.routes.size.should == 6
+  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
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: yard-sinatra
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Konstantin Haase
@@ -9,20 +14,38 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-24 00:00:00 +01:00
+date: 2010-03-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: big_band
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 3
+        version: 0.5.3
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.5
-    version: 
-description: YARD plugin for parsing sinatra routes See README.rdoc for more infos.
+        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: konstantin.mailinglists@googlemail.com
 executables: []
 
@@ -31,11 +54,12 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- yard-sinatra.gemspec
-- lib/yard-sinatra.rb
-- lib/big_band/version.rb
-has_rdoc: false
-homepage: http://github.com/rkh/big_band
+- lib/yard/sinatra.rb
+- spec/example_app.rb
+- spec/yard/sinatra_spec.rb
+- README.md
+has_rdoc: yard
+homepage: http://github.com/rkh/yard-sinatra
 licenses: []
 
 post_install_message: 
@@ -47,20 +71,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
-specification_version: 2
-summary: YARD plugin for parsing sinatra routes
+specification_version: 3
+summary: Displays Sinatra routes (including comments) in YARD output (part of BigBand).
 test_files: []
 

data/lib/big_band/version.rb

@@ -1,3 +0,0 @@
-require "big_band/integration" unless defined? BigBand
-BigBand::VERSION = "0.2.5"
-BigBand::DATE    = "2010-01-24"

data/lib/yard-sinatra.rb

@@ -1,2 +0,0 @@
-# This is a dummy file to hook into YARD.load_plugins
-require "big_band/integration/yard"

data/yard-sinatra.gemspec

@@ -1,24 +0,0 @@
-$LOAD_PATH.unshift "lib"
-require "lib/big_band/version"
-
-YARD_SINATRA_SPEC = Gem::Specification.new do |s|
-
-  s.name          = "yard-sinatra"
-  s.version       = BigBand::VERSION
-  s.date          = BigBand::DATE
-  s.author        = "Konstantin Haase"
-  s.email         = "konstantin.mailinglists@googlemail.com"
-  s.homepage      = "http://github.com/rkh/big_band"
-  s.platform      = Gem::Platform::RUBY
-  s.summary       = "YARD plugin for parsing sinatra routes" 
-  s.files         = ["yard-sinatra.gemspec", "lib/yard-sinatra.rb", "lib/big_band/version.rb"]
-  s.require_paths = ['lib']
-  s.description   = s.summary + " See README.rdoc for more infos."
-  s.has_rdoc      = false
-
-  s.add_dependency "big_band", "= #{BigBand::VERSION}"
-
-  s.specification_version = 2 if s.respond_to? :specification_version=
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-
-end