yard-api 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57a2787c3ce762f1d68efe7aba2d1407443a7fb0
-  data.tar.gz: 9abaebf7932f1dffbaa3f84fe8c43cce1cf7c266
+  metadata.gz: da18e5c099f63291990732b6b8641f9b3d6588a4
+  data.tar.gz: 697447ab5b213e1322e37888fd4ef9bc49c89fef
 SHA512:
-  metadata.gz: b41c9b4518e06b4a772b846004c9f8b849526091604e6d3051d855d14caaf6ebc5ec34b557e83c4b1edd3e9b60242c670d4e345204a18a42b80a397a0930c17a
-  data.tar.gz: ec814f8e0e70e29a2ec528f08a1f434def22383fc41f159e25cd31eda57cd67496b1b0f8e4565c424c59125a9a75b2d6296ae33235b19a2f0ca827e027b5c98c
+  metadata.gz: 2912e45619e1199eebb28422298e380155795978e62966c168af494e3ce98e058ef6f748495df012359692033573c213be34d7e2da5589837d5090d46bee5f91
+  data.tar.gz: a721d465aa53ab6e817bbb7485c9f75dff2ce6c193c3a8a1746115393b963bd97d132c05cdcd9bdc1bb38aab1af54a429333689d665d9a5b1a31069399743b19

data/lib/yard-api/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module APIPlugin
-    VERSION = "0.3.1"
+    VERSION = "0.3.2"
   end
 end

data/lib/yard-api/yardoc_task.rb

@@ -23,6 +23,8 @@ module YARD::APIPlugin
       config['debug'] ||= ENV['DEBUG']
       config['verbose'] ||= ENV['VERBOSE']
 
+      config['output'].sub!('$format', config['format'])
+
       set_option('template', 'api')
       set_option('no-yardopts')
       set_option('no-document')

data/templates/api/fulldoc/json/setup.rb

@@ -5,6 +5,7 @@ include YARD::Templates::Helpers::FilterHelper
 include YARD::Templates::Helpers::HtmlHelper
 
 RouteHelper = YARD::Templates::Helpers::RouteHelper
+ArgumentTag = YARD::APIPlugin::Tags::ArgumentTag
 
 def init
   resources = options[:objects]
@@ -15,17 +16,17 @@ end
 
 def serialize_resource(resource, controllers)
   Templates::Engine.with_serializer("#{topicize resource}.json", options[:serializer]) do
-    JSON.pretty_generate({
-      object: resource,
-      api_objects: controllers.map do |controller|
-        dump_api_objects(controller)
-      end.flatten,
-      methods: method_details_list(controllers)
-    })
+    {
+      id: topicize(resource),
+      title: resource,
+      text: controllers.map { |c| c.docstring }.join("\n\n"),
+      objects: controllers.map { |c| dump_controller_objects(c) }.flatten,
+      endpoints: dump_resource_endpoints(controllers)
+    }.to_json
   end
 end
 
-def method_details_list(controllers)
+def dump_resource_endpoints(controllers)
   meths = controllers.map do |controller|
     controller.meths(:inherited => false, :included => false)
   end.flatten
@@ -33,40 +34,58 @@ def method_details_list(controllers)
   meths = run_verifier(meths)
 
   meths.map do |object, i|
-    dump_object(object).tap do |object_info|
+    dump_endpoint(object).tap do |object_info|
       object_info[:tags] = dump_object_tags(object)
     end
   end
 end
 
-def dump_api_objects(controller)
+def dump_controller_objects(controller)
   (controller.tags(:object) + controller.tags(:model)).map do |obj|
-    name, schema = obj.text.split(%r{\n+}, 2).map(&:strip)
+    dump_object(obj)
+  end
+end
 
-    {
-      controller: controller.name,
-      name: name,
-      schema: schema
-    }
+def dump_object(obj)
+  title, spec = obj.text.split(%r{\n+}, 2).map(&:strip)
+  spec = JSON.parse(spec)
+  schema = spec.has_key?('properties') ? spec['properties'] : spec
+
+  schema_tags = schema.map do |(prop_name, prop)|
+    is_required = prop.has_key?('required') ? prop['required'] : false
+    is_required_str = is_required ? 'Required' : 'Optional'
+
+    ArgumentTag.new(nil, "[#{is_required_str}, #{prop['type']}] #{prop_name}\n #{prop['description']}")
   end
+
+  {
+    id: topicize("#{obj.object.path}::#{title}"),
+    scoped_id: topicize(title),
+    title: title,
+    text: spec['description'] || '',
+    controller: obj.object.path,
+    schema: schema_tags.as_json.map { |e| e.delete('tag_name'); e }
+  }
 end
 
-def dump_object(object)
+def dump_endpoint(endpoint)
+  title = endpoint.tag(:API).text
+
   {
-    name: object.name,
-    route: get_route(object),
-    title: object.title,
-    type: object.type,
-    path: object.path,
-    namespace: object.namespace.path,
-    source: object.source,
-    source_type: object.source_type,
-    signature: object.signature,
-    files: object.files,
-    docstring: object.base_docstring,
-    dynamic: object.dynamic,
-    group: object.group,
-    visibility: object.visibility
+    id: topicize(endpoint.path),
+    scoped_id: topicize(title),
+    title: title,
+    text: endpoint.base_docstring,
+    controller: endpoint.namespace.path,
+    route: get_route(endpoint),
+    type: endpoint.type,
+    source: endpoint.source,
+    source_type: endpoint.source_type,
+    signature: endpoint.signature,
+    files: endpoint.files,
+    dynamic: endpoint.dynamic,
+    group: endpoint.group,
+    visibility: endpoint.visibility
   }
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Ahmad Amireh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-03 00:00:00.000000000 Z
+date: 2015-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard