yard-api 0.3.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3af67e45e3ab8fd41ef0ec5cb1578e1978361579796e4d2720f9a09907ded38
-  data.tar.gz: 488360b56b9a807e8e6a8671b3aeae13b83f3400d01cf6f826b0cbdf9881337b
+  metadata.gz: 031c5ccb5ac18f138c9853c00ac39135cbc8f5fa744a5fd7a0c1c31370202904
+  data.tar.gz: 71a71e187577a8797d7d41b726b3b3aa64a7effbbfebb8fc4410d41fd3169cd0
 SHA512:
-  metadata.gz: b1dfd66a16c6e4a1d76a121b2fc74ab9cd813e1336bb51ef36b6c54d9baea7e39fff89cb125759f784cb18d629259d340e655010a32f4709b85e43f92529f936
-  data.tar.gz: 85b89092da99271aad2c5b09b77ee32d5b1b93e25493ed16682263bed6cd3175c24c8ff21a4d3507fad9e3a5414b09079bae5c4bb095c3db4c0675a5a27bffdb
+  metadata.gz: f484a14b069cacfd7d96af521c68ca11bcf4304348ea83b80e0f19ce966c143a3fcea2e0c16ab639a5769bb91358ef1ebb3e4bc131e5369dcb940f8ba37f8d3e
+  data.tar.gz: e8e20607a65b8ed3a432a21d1e08e7a5db512707f3d6dca37b1acf1c8285661f2afa7acae812c9543cb211df29d10e83803511a66322de16c9797cee8b006df1

data/README.md

@@ -40,65 +40,7 @@ Read that file to view all the available options.
 
 ## Changelog
 
-**6/9/2015 [0.3.5]**
-
-- In JSON format, an API resource endpoint now contains the name as well.
-- Changed the `topicize()` helper in a way that makes the IDs (and URLs of
-  some sections) much more readable
-
-**23/8/2015 [0.3.4]**
-
-- Fixed an issue that prevented overriding the Rake task's options at runtime.
-- Updated `config/yard_api.yml` to reflect the recently added options.
-
-**17/8/2015 [0.3.3]**
-
-- Improved the JSON format's output to be more concise and consistent.
-
-**30/7/2015 [0.3.1]**
-
-- Fixed a bug that was listing all the endpoints of a certain controller even if they do not have a route defined. Now, YARD-API will warn about endpoints that have an `@API` tag but could not be routed.
-- Greatly improved the performance of generating the Quicklinks table.
-
-**29/7/2015 [0.3.0]**
-
-- major rework of the linking logic, much improvements but some stuff is broken now
-
-**28/7/2015 [0.2.3]**
-
-- dropped the `@argument_scope` tag
-- JSON is available as an output format now
-- added usage documentation, found at [http://amireh.github.io/yard-api]
-- added an example app
-- various style improvements
-- `@example_request` is now able to output a sample cURL command.
-
-**0.1.7**
-
-- new compatibility option `leading_argument_name_fix`
-
-**15/9/2014**
-
-- `@argument` tags can now be formatted in a table by setting the `tabular_arguments` option to true
-- `@argument_scope`: a new tag that improves the formatting of endpoint arguments that are scoped by a common prefix (e.g, nested inside a json object), like `user[name]` => `name`
-- `@argument` can now parse accepted values in two formats; inline within the types array, or by explicitly writing it in the tag text using any of `Accepted values: [...]`, `Accepts: [...]`, or `Possible values: [...]`
-- A new option: `strict_arguments` that provides a default for the `is_required` property of `@argument` tags. This default is used if the tag does not explicitly state `Optional` or `Required` in its type specifier.
-- Support for dynamic javascript and style code based on options. See `templates/layout/setup.rb#inline_{javascripts,stylesheets}`
-- A new set of options for customizing layout: `content_width`, `sidebar_width` and `spacer`
-- `github_url` and `github_branch` options for tuning api endpoint source links
-
-**14/9/2014**
-
-- Support for single-page output through the `one_file` option
-- Support for resource index generation ("All Resources") through the `resource_index` option
-
-**10/9/2014**
-
-- Support for github-flavored markdown when you're using Markdown as a markup, and `redcarpet` as the provider
-- Syntax highlighting for multiple languages (with auto-detection) using [highlight.js](https://highlightjs.org/)
-- `@example_response` and `@example_request` tags now support a title for the response
-- A new option: `copyright` for displaying a copyright in the footer of every page
-- A new option: `footer_note` for displaying a custom note, like linking to the project's source code, in the footer of every page
+See CHANGES.md.
 
 ## License
 

data/lib/yard-api/templates/helpers/route_helper.rb

@@ -31,8 +31,17 @@ module YARD::Templates::Helpers
       end
 
       def get_route_verb(route)
-        route.verb.source =~ /\^?(\w*)\$/ ? $1.upcase : route.verb.source
+        verb = route.verb
+
+        case verb
+        when Regexp
+          verb.source =~ /\^?(\w*)\$/ ? $1.upcase : verb.source
+        when String
+          verb
+        else
+          "???"
+        end
       end
     end
   end
-end
+end

data/lib/yard-api/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module APIPlugin
-    VERSION = "0.3.7"
+    VERSION = "1.0.0"
   end
 end

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

@@ -55,7 +55,22 @@ def dump_object(obj)
     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']}")
+    {
+      "name" => prop_name,
+      "types" => Array(prop["type"]),
+      "is_required" => !!prop["required"],
+      "text" => prop.fetch('description', ''),
+      "example" => prop['example'],
+      "accepted_values" => Array(
+        first_in([
+          "accepted values",
+          "accepted_values",
+          "accepts",
+          "accepted",
+          "acceptable values",
+        ], prop)
+      )
+    }
   end
 
   {
@@ -64,7 +79,7 @@ def dump_object(obj)
     title: title,
     text: spec['description'] || '',
     controller: obj.object.path,
-    schema: schema_tags.as_json.map { |e| e.delete('tag_name'); e }
+    schema: schema_tags
   }
 end
 
@@ -126,3 +141,7 @@ def get_route(object)
     }
   end
 end
+
+def first_in(keys, obj)
+  obj[keys.detect { |k| obj.key?(k) }]
+end

data/yard-api.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
                   ['LICENSE', 'README.md', '.rspec', __FILE__]
   s.has_rdoc    = 'yard'
   s.license     = 'AGPL-3.0'
-  s.add_dependency 'yard', '0.8.7'
+  s.add_dependency 'yard', '~> 0.9.15'
   s.add_dependency 'yard-appendix', '~> 0.1.8'
   s.add_development_dependency 'rspec', '~> 3.3'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: yard-api
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Ahmad Amireh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-25 00:00:00.000000000 Z
+date: 2018-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.9.15
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.9.15
 - !ruby/object:Gem::Dependency
   name: yard-appendix
   requirement: !ruby/object:Gem::Requirement