yard-grape 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9db053d1be54cb6d7e09e27ba1cc39fb34f2ac5
+  data.tar.gz: 31889a545f7aa7ec854541253b88decfd6596117
+SHA512:
+  metadata.gz: 56360ca28d50381beb8bc572e8f629a1a527a05c633c6e0641f384ba88b8be46e3966d66ea30728d7144e440548e827d8c0d2f17d0e31de006aeb7d8b70b975f
+  data.tar.gz: 8075830cfa1a5b047881f9afc569c96c0aa7cb9a6c8bf5bb6993d43d0ab00e80a41a91ca4cc05eec338c40a3d442c8fdc6b7400c026f973e08b74a190b740c10

data/lib/yard-grape.rb

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

data/lib/yard/grape.rb

@@ -0,0 +1,137 @@
+require "yard"
+
+module YARD
+
+  module Grape
+    def self.routes
+      YARD::Handlers::Grape::AbstractRouteHandler.routes
+    end
+
+    def self.error_handlers
+      YARD::Handlers::Grape::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::Grape::AbstractRouteHandler#register_route
+      # @see #name
+      def show_real_name?
+        real_name and caller[1] =~ /`signature'/
+      end
+    end
+  end
+
+  module Handlers
+
+    # Displays Grape routes in YARD documentation.
+    # Can also be used to parse routes from files without executing those files.
+    module Grape
+      YARD::Tags::Library.define_tag("A Sample Tag", :real_name)
+
+      # 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
+
+      class ResourceHandler < YARD::Handlers::Ruby::Base
+        handles method_call(:resource)
+        namespace_only
+
+        def process
+          name = statement.parameters.first.jump(:tstring_content, :ident).source.capitalize
+          object = YARD::CodeObjects::ClassObject.new(namespace, name)
+          register(object)
+          if object.tags(:real_name).any?
+            object.name = object.tags(:real_name).first.text
+            object.path = [object.namespace, object.name].join('::')
+          end
+          p statement.last.last
+          parse_block(statement.last.last, :namespace => object)
+          register(object)
+        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
+
+    end
+  end
+end

data/spec/example_app.rb

@@ -0,0 +1,46 @@
+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") { }
+
+  namespace "/nested" do
+    # root
+    get do
+      "this is a route at the root of the namespace"
+    end
+
+    # nested route
+    get("/route") {"this is a nested route!"}
+
+		namespace "/double" do
+			# double nested route
+			get("/route") { }
+		end
+  end
+
+end

data/spec/yard/sinatra_spec.rb

@@ -0,0 +1,52 @@
+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 == 8
+  end
+
+  it "sets properties correctly" do
+    settings_routes = YARD::Sinatra.routes.find_all {|r| r.http_path == "/settings" }
+    settings_routes.length.should == 5
+    settings_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
+
+  it "recognizes namespaced routes" do
+    nested_routes = YARD::Sinatra.routes.find_all {|r| r.http_path[0..6] == "/nested" }
+    nested_routes.length.should == 3
+    nested_routes.each do |route|
+      if route.http_path == "/nested"
+        route.docstring.should == "root"
+      elsif route.http_path == "/nested/double/route"
+        route.docstring.should == "double nested route"
+      elsif route.http_path == "/nested/route"
+        route.docstring.should == "nested route"
+      else
+          raise "unknown route: #{route.http_path}!"
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: yard-grape
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- nobody
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Displays Grape routes (including comments) in YARD output.
+email: Jianfeng@revibe.fm
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/yard/grape.rb
+- lib/yard-grape.rb
+- spec/example_app.rb
+- spec/yard/sinatra_spec.rb
+- README.md
+- LICENSE
+homepage: http://github.com/winfield/yard-grape
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Displays Grape routes (including comments) in YARD output.
+test_files: []
+has_rdoc: