yard-rest-plugin 0.2.3 → 0.2.4

data/README.markdown

@@ -54,20 +54,6 @@ The rationale here is that you are documenting external services (as represented
     # @argument ["@assigned"|"@complete"|"!@complete"] search Return samples that are assigned, complete, or
     #   uncomplete.
     #
-    # @example_request
-    #   <samples type="array">
-    #     <sample>
-    #       <id>961</id>
-    #       <name>My Sample</name>
-    #       <state>complete</state>
-    #       <last_unassigned_user_id type="integer"></last_unassigned_user_id>
-    #       <resource_id type="integer">127</resource_id>
-    #       <notes></notes>
-    #       <updated_at type="datetime">2010-03-09T20:43:29Z</updated_at>
-    #       <created_at type="datetime">2010-03-09T20:43:16Z</created_at>
-    #     </interval>
-    #   <intervals>
-    #
     # @example_response
     #   <samples type="array">
     #     <sample>
@@ -79,15 +65,15 @@ The rationale here is that you are documenting external services (as represented
     #       <notes></notes>
     #       <updated_at type="datetime">2010-03-09T20:43:29Z</updated_at>
     #       <created_at type="datetime">2010-03-09T20:43:16Z</created_at>
-    #     </interval>
-    #   <intervals>
+    #     </sample>
+    #   <samples>
     # 
-    # @response_field id A unique ID identifying the Sample
-    # @response_field name The name of the sample
-    # @response_field state The current status of the Sample. Can be complete, uncomplete, etc.
-    # @response_field notes Any notes given for the sample
-    # @response_field updated_at The Date/Time (in ISO8601) that the Sample was last updated
-    # @response_field created_at The Date/Time (in ISO8601) that the Sample was created
+    # @response_field [Integer] id A unique ID identifying the Sample
+    # @response_field [String] name The name of the sample
+    # @response_field [String] state The current status of the Sample. Can be complete, uncomplete, etc.
+    # @response_field [String] notes Any notes given for the sample
+    # @response_field [DateTime] updated_at The Date/Time (in ISO8601) that the Sample was last updated
+    # @response_field [DateTime] created_at The Date/Time (in ISO8601) that the Sample was created
     # 
     def index
     end
@@ -116,12 +102,12 @@ The rationale here is that you are documenting external services (as represented
     #     <created_at type="datetime">2010-03-09T20:43:16Z</created_at>
     #   </sample>
     #
-    # @request_field id A unique ID identifying the Sample
-    # @request_field name The name of the sample
-    # @request_field state The current status of the Sample. Can be complete, uncomplete, etc.
-    # @request_field note_attributes Any notes given for the sample that will be created
-    # @request_field updated_at The Date/Time (in ISO8601) that the Sample was last updated
-    # @request_field created_at The Date/Time (in ISO8601) that the Sample was created
+    # @request_field [Integer] id A unique ID identifying the Sample
+    # @request_field [String] name The name of the sample
+    # @request_field [String] state The current status of the Sample. Can be complete, uncomplete, etc.
+    # @request_field [String] note_attributes Any notes given for the sample that will be created
+    # @request_field [DateTime] updated_at The Date/Time (in ISO8601) that the Sample was last updated
+    # @request_field [DateTime] created_at The Date/Time (in ISO8601) that the Sample was created
     #
     # @example_response
     #   <sample>
@@ -139,12 +125,12 @@ The rationale here is that you are documenting external services (as represented
     #     <created_at type="datetime">2010-03-09T20:43:16Z</created_at>
     #   </sample>
     # 
-    # @response_field id A unique ID identifying the Sample
-    # @response_field name The name of the sample
-    # @response_field state The current status of the Sample. Can be complete, uncomplete, etc.
-    # @response_field notes Any notes given for the sample
-    # @response_field updated_at The Date/Time (in ISO8601) that the Sample was last updated
-    # @response_field created_at The Date/Time (in ISO8601) that the Sample was created
+    # @response_field [Integer] id A unique ID identifying the Sample
+    # @response_field [String] name The name of the sample
+    # @response_field [String] state The current status of the Sample. Can be complete, uncomplete, etc.
+    # @response_field [String] notes Any notes given for the sample
+    # @response_field [DateTime] updated_at The Date/Time (in ISO8601) that the Sample was last updated
+    # @response_field [DateTime] created_at The Date/Time (in ISO8601) that the Sample was created
     #
     def create
     end

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.2.4

data/example/SampleController.rb

@@ -11,7 +11,7 @@ class SampleController
   # @url [GET] /samples/index.[format]?[arguments]
   # @url [GET] /samples.[format]?[arguments]
   # 
-  # @argument [String] format Only "xml" is support at this time.
+  # @argument [String] format Only "xml" is supported at this time.
   # @argument [String] name The name of the sample
   # @argument [String] reource The resource that sample belongs to
   # @argument ["@assigned"|"@complete"|"!@complete"] search Return jobs that are assigned, complete, or
@@ -28,15 +28,15 @@ class SampleController
   #       <notes></notes>
   #       <updated_at type="datetime">2010-03-09T20:43:29Z</updated_at>
   #       <created_at type="datetime">2010-03-09T20:43:16Z</created_at>
-  #     </interval>
-  #   <intervals>
+  #     </sample>
+  #   <samples>
   # 
-  # @response_field id A unique ID identifying the Sample
-  # @response_field name The name of the sample
-  # @response_field state The current status of the Sample. Can be complete, uncomplete, etc.
-  # @response_field notes Any notes given for the sample
-  # @response_field updated_at The Date/Time (in ISO8601) that the Sample was last updated
-  # @response_field created_at The Date/Time (in ISO8601) that the Sample was created
+  # @response_field [Integer] id A unique ID identifying the Sample
+  # @response_field [String] name The name of the sample
+  # @response_field [String] state The current status of the Sample. Can be complete, uncomplete, etc.
+  # @response_field [String] notes Any notes given for the sample
+  # @response_field [DateTime] updated_at The Date/Time (in ISO8601) that the Sample was last updated
+  # @response_field [DateTime] created_at The Date/Time (in ISO8601) that the Sample was created
   # 
   def index
   end
@@ -52,7 +52,7 @@ class SampleController
   # 
   # @url [POST] /samples.[format]?[arguments]
   # 
-  # @argument [String] format Only "xml" is support at this time.
+  # @argument [String] format Only "xml" is supported at this time.
   #
   # @example_request
   #   <sample>
@@ -71,12 +71,12 @@ class SampleController
   #     <created_at type="datetime">2010-03-09T20:43:16Z</created_at>
   #   </sample>
   #
-  # @request_field id A unique ID identifying the Sample
-  # @request_field name The name of the sample
-  # @request_field state The current status of the Sample. Can be complete, uncomplete, etc.
-  # @request_field note_attributes Any notes given for the sample that will be created
-  # @request_field updated_at The Date/Time (in ISO8601) that the Sample was last updated
-  # @request_field created_at The Date/Time (in ISO8601) that the Sample was created
+  # @request_field [Integer] id A unique ID identifying the Sample
+  # @request_field [String] name The name of the sample
+  # @request_field [String] state The current status of the Sample. Can be complete, uncomplete, etc.
+  # @request_field [String] note_attributes Any notes given for the sample that will be created
+  # @request_field [DateTime] updated_at The Date/Time (in ISO8601) that the Sample was last updated
+  # @request_field [DateTime] created_at The Date/Time (in ISO8601) that the Sample was created
   #
   # @example_response
   #   <sample>
@@ -94,12 +94,12 @@ class SampleController
   #     <created_at type="datetime">2010-03-09T20:43:16Z</created_at>
   #   </sample>
   # 
-  # @response_field id A unique ID identifying the Sample
-  # @response_field name The name of the sample
-  # @response_field state The current status of the Sample. Can be complete, uncomplete, etc.
-  # @response_field notes Any notes given for the sample
-  # @response_field updated_at The Date/Time (in ISO8601) that the Sample was last updated
-  # @response_field created_at The Date/Time (in ISO8601) that the Sample was created
+  # @response_field [Integer] id A unique ID identifying the Sample
+  # @response_field [String] name The name of the sample
+  # @response_field [String] state The current status of the Sample. Can be complete, uncomplete, etc.
+  # @response_field [String] notes Any notes given for the sample
+  # @response_field [DateTime] updated_at The Date/Time (in ISO8601) that the Sample was last updated
+  # @response_field [DateTime] created_at The Date/Time (in ISO8601) that the Sample was created
   #
   def create
   end

data/lib/yard-rest-plugin.rb

@@ -13,7 +13,11 @@ YARD::Tags::Library.define_tag("URL for Service", :url)
 YARD::Tags::Library.define_tag("Topic for Service", :topic)
 YARD::Tags::Library.define_tag("Arguments", :argument, :with_types_and_name)
 YARD::Tags::Library.define_tag("Example Request", :example_request)
-YARD::Tags::Library.define_tag("Request Fields", :request_field, :with_name)
+YARD::Tags::Library.define_tag("Request Fields", :request_field, :with_types_and_name)
 YARD::Tags::Library.define_tag("Example Response", :example_response)
-YARD::Tags::Library.define_tag("Response Fields", :response_field, :with_name)
+YARD::Tags::Library.define_tag("Response Fields", :response_field, :with_types_and_name)
+YARD::Tags::Library.define_tag("Headers", :header, :with_name)
+YARD::Tags::Library.define_tag("Response codes", :response_code, :with_name)
+YARD::Tags::Library.define_tag("Image", :image)
+YARD::Tags::Library.define_tag("Overall", :overall)
 

data/lib/yard-rest-plugin/base_helper.rb

@@ -5,29 +5,37 @@ module YARD::Templates::Helpers
 
     # Adds additional test that only includes Objects that contain a URL tag
     def run_verifier(list)
-        
+
       if options[:verifier]
-        list.reject! {|item| options[:verifier].call(item).is_a?(FalseClass) }
+        list.reject! { |item| options[:verifier].call(item).is_a?(FalseClass) }
       end
 
-	    reject_module(list)
-      reject_without_url(list)
-      reject_without_topic(list)
-      
-      list
+      index_objects(list)
+    end
+
+    def index_objects(list)
+      res = reject_module(list)
+      res = reject_without_url(res)
+      res = reject_without_topic(res)
+      res = reject_overall(res)
+
+      res
     end
 
     def reject_module(list)
-    	list.reject! { |object| [:root, :module].include?(object.type) }
-  	end
-	
+      list.reject { |object| [:root, :module].include?(object.type) }
+    end
+
     def reject_without_url(list)
-      list.reject!  { |object| [:class,:method].include?(object.type) and object.tags("url").empty? }
+      list.reject { |object| [:class, :method].include?(object.type) and object.tags("url").empty? }
     end
 
     def reject_without_topic(list)
-      list.reject!  { |object| [:class].include?(object.type) and object.tags("topic").empty? }
+      list.reject { |object| [:class].include?(object.type) and object.tags("topic").empty? }
+    end
+
+    def reject_overall(list)
+      list.reject { |object| object.has_tag?('overall') }
     end
-    
   end
 end

data/templates/rest/fulldoc/html/setup.rb

@@ -3,20 +3,20 @@ include Helpers::FilterHelper
 
 def init
   options[:objects] = objects = run_verifier(options[:objects])
-  options[:files] = ([options[:readme]] + options[:files]).compact.map {|t| t.to_s }
+  options[:files] = ([options[:readme]] + options[:files]).compact.map { |t| t.to_s }
   options[:readme] = options[:files].first
   options[:title] ||= "Documentation by YARD #{YARD::VERSION}"
-  
+
   generate_assets
   serialize('_index.html')
-  options[:files].each_with_index do |file, i| 
-    serialize_file(file, i == 0 ? options[:title] : nil) 
+  options[:files].each_with_index do |file, i|
+    serialize_file(file, i == 0 ? options[:title] : nil)
   end
 
   options.delete(:objects)
   options.delete(:files)
-  
-  objects.each do |object| 
+
+  objects.each do |object|
     begin
       serialize(object)
     rescue => e
@@ -61,11 +61,11 @@ def asset(path, content)
 end
 
 def generate_assets
-  %w( js/jquery.js js/app.js js/full_list.js 
-      css/style.css css/full_list.css css/common.css ).each do |file|
+  %w(js/jquery.js js/app.js js/full_list.js
+      css/style.css css/full_list.css css/common.css).each do |file|
     asset(file, file(file, true))
   end
-  
+
   @object = Registry.root
   generate_resource_list
   generate_topic_list
@@ -73,21 +73,20 @@ def generate_assets
 end
 
 def generate_topic_list
-  topic_objects = options[:objects].reject {|o| o.root? || !is_class?(o) || o.tags('url').empty? || o.tags('topic').empty? }
+  topic_objects = index_objects(options[:objects]).reject { |o| o.root? }
   @topics = {}
-  
+
   topic_objects.each do |object|
     object.tags('topic').each { |topic| (@topics[topic.text] ||= []) << object }
   end
 
-
   @list_title = "Topic List"
   @list_type = "topic"
   asset('topic_list.html', erb(:full_list))
 end
 
 def generate_resource_list
-  @items = options[:objects]
+  @items = index_objects(options[:objects])
   @list_title = "Resource List"
   @list_type = "resource"
   asset('resource_list.html', erb(:full_list))

data/templates/rest/layout/html/setup.rb

@@ -12,10 +12,9 @@ def init
   elsif object
     case object
     when '_index.html'
-      sections :layout, [:index]
+      sections :layout, [:index, [T('class')]]
     when CodeObjects::Base
       type = object.root? ? :module : object.type
-      #sections :layout, [T(type), T('disqus')]
       sections :layout, [T(type)]
     end
   else
@@ -29,16 +28,17 @@ end
 
 def index
 
-  legitimate_objects = @objects.reject {|o| o.root? || !is_class?(o) || o.tags('url').empty?}
-  topic_objects = legitimate_objects.reject{|o| o.tags('topic').empty? }
+  legitimate_objects = index_objects(@objects).reject {|o| o.root? }
   @topics = {}
-  
-  topic_objects.each do |object|
+
+  legitimate_objects.each do |object|
     object.tags('topic').each { |topic| (@topics[topic.text] ||= []) << object }
   end
 
   @resources = legitimate_objects.sort_by {|o| o.tags('url').first.text }
-  
+
+  @overall_objects = @objects.find_all {|o| o.has_tag?('overall')}.sort_by {|o| o.tag('overall').text}
+
   erb(:index)
 end
 

data/templates/rest/tags/setup.rb

@@ -1,6 +1,12 @@
 def init
   super
-  sections.place([:argument, :example_request, :request_field, :example_response, :response_field]).before(:index)
+  sections :index, [:argument,
+                    :example_request,
+                    :request_field,
+                    :example_response,
+                    :response_field,
+                    :header,
+                    :response_code]
 end
 
 def request_field
@@ -15,6 +21,14 @@ def argument
   generic_tag :argument, :no_types => false
 end
 
+def header
+  generic_tag :header
+end
+
+def response_code
+  generic_tag :response_code
+end
+
 def generic_tag(name, opts = {})
   return unless object.has_tag?(name)
   @no_names = true if opts[:no_names]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: yard-rest-plugin
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - Aisha Fenton
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-08 00:00:00 +13:00
+date: 2010-11-19 00:00:00 +13:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,8 +63,8 @@ homepage: http://github.com/visfleet/yard-rest-plugin
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement