jdoc 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44f0091a8a36bc9270c3c13de5553c51051b1261
-  data.tar.gz: 69173ed695ea55d08826cefe5c43eff342b81c07
+  metadata.gz: ecaf31b4e9cc6005cf7980e77b5f8967a9d1e4a1
+  data.tar.gz: 449ee41071bbf4467556d1150418f32bf686b530
 SHA512:
-  metadata.gz: ed1792568d15ba8d43ea696b417ed3d009a241d8ab4c0c194b9d6794d1bf4007712ab766167097c90f6597daa1d0a7b400b571418173bbc7ff526a8be47acc78
-  data.tar.gz: 71dc0edef70729432ecdfd651b2552ed057d4760f72b1c4ec84833b2cc7bde3d2d7224f70a56c4c63a5ed453e63e5295424e4b86bd072c2c3717ad77fbfa9af5
+  metadata.gz: 6f1bc864b397b9c4bd30ff0a936a5856e2a965d47773a195a91c00267e807231872831b85f4cef362578fce891dfdd00b3bc82312a58c924cd5070fbfb8419cd
+  data.tar.gz: f1788851e9708e9ffc34eb8a8adafc3775f63c1eb789da355e0035a4ae33047e810c9932e22487b7fa073a4900d3e6f2e17f3571193556b7f11147b13c694ef6

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.0
+* Show resources which have no links
+
 ## 0.0.9
 * Support array property
 

data/lib/jdoc/link.rb

@@ -1,7 +1,7 @@
 module Jdoc
   class Link
     # @param link [JsonSchema::Schema::Link]
-    def initialize(link: nil)
+    def initialize(link)
       @raw_link = link
     end
 

data/lib/jdoc/resource.rb

@@ -49,7 +49,19 @@ module Jdoc
 
     # Defined to change uniqueness in Hash key
     def eql?(other)
-      @schema.title == @schema.title
+      @schema.title == other.title
+    end
+
+    def <=>(other)
+      @schema.title <=> other.title
+    end
+
+    def links
+      @links ||= @schema.links.map do |link|
+        if link.method && link.href
+          Link.new(link)
+        end
+      end.compact
     end
   end
 end

data/lib/jdoc/schema.rb

@@ -2,25 +2,16 @@ module Jdoc
   class Schema
     DEFAULT_ENDPOINT = "https://api.example.com"
 
-    # Recursively extracts all links in given JSON schema
-    # @param json_schema [JsonSchema::Schema]
-    # @return [Array] An array of JsonSchema::Schema::Link
-    def self.extract_links(json_schema)
-      links = json_schema.links.select {|link| link.method && link.href }
-      links + json_schema.properties.map {|key, schema| extract_links(schema) }.flatten
-    end
-
     # @param schema [Hash] JSON Schema
     def initialize(schema)
       @json_schema = JsonSchema.parse!(schema).tap(&:expand_references!)
     end
 
-    # @return [Hash{Jdoc::Schema => Array}] Linkes table indexed by their schemata
-    def links_indexed_by_resource
-      @links_indexed_by_schema ||= links.inject(Hash.new {|h, k| h[k] = [] }) do |result, link|
-        result[link.resource] << link
-        result
-      end
+    # @return [Array<Jdoc::Resource>] All top-level properties in its title order
+    def resources
+      @resources ||= @json_schema.properties.map do |key, property|
+        Resource.new(property)
+      end.sort
     end
 
     # @return [String, nil] Title property of this schema
@@ -56,15 +47,6 @@ module Jdoc
       root_uri.host
     end
 
-    # @return [Array] All links defined in given JSON schema
-    # @example
-    #   links #=> [#<JsonSchema::Schema::Link>]
-    def links
-      @links ||= self.class.extract_links(@json_schema).map do |link|
-        Link.new(link: link)
-      end.sort
-    end
-
     # @return [URI::Generic] Root endpoint for the API
     # @example
     #   root_uri #=> "https://api.example.com"

data/lib/jdoc/version.rb

@@ -1,3 +1,3 @@
 module Jdoc
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/spec/fixtures/schema.yml

@@ -99,6 +99,8 @@ definitions:
 properties:
   app:
     "$ref": "#/definitions/app"
+  user:
+    "$ref": "#/definitions/user"
 type:
 - object
 description: A schema for a small example API.

data/spec/jdoc/generator_spec.rb

@@ -20,11 +20,12 @@ describe Jdoc::Generator do
       should == <<-EOS.strip_heredoc
         # Example API
         * [App](#app)
-         * [GET /apps](#get-apps)
          * [POST /apps](#post-apps)
+         * [DELETE /apps/:id](#delete-appsid)
          * [GET /apps/:id](#get-appsid)
+         * [GET /apps](#get-apps)
          * [PATCH /apps/:id](#patch-appsid)
-         * [DELETE /apps/:id](#delete-appsid)
+        * [User](#user)
 
         ## App
         An app is a program to be deployed.
@@ -48,21 +49,15 @@ describe Jdoc::Generator do
         * users - 
          * Type: array
 
-        ### GET /apps
-        List existing apps.
+        ### POST /apps
+        Create a new app.
 
         ```
-        GET /apps HTTP/1.1
+        POST /apps HTTP/1.1
         Content-Type: application/json
         Host: api.example.com
-        ```
-
-        ```
-        HTTP/1.1 200
-        Content-Type: application/json
 
         {
-          "id": "01234567-89ab-cdef-0123-456789abcdef",
           "name": "example",
           "private": false,
           "deleted_at": null,
@@ -72,15 +67,12 @@ describe Jdoc::Generator do
         }
         ```
 
-        ### POST /apps
-        Create a new app.
-
         ```
-        POST /apps HTTP/1.1
+        HTTP/1.1 201
         Content-Type: application/json
-        Host: api.example.com
 
         {
+          "id": "01234567-89ab-cdef-0123-456789abcdef",
           "name": "example",
           "private": false,
           "deleted_at": null,
@@ -90,8 +82,17 @@ describe Jdoc::Generator do
         }
         ```
 
+        ### DELETE /apps/:id
+        Delete an existing app.
+
         ```
-        HTTP/1.1 201
+        DELETE /apps/:id HTTP/1.1
+        Content-Type: application/json
+        Host: api.example.com
+        ```
+
+        ```
+        HTTP/1.1 200
         Content-Type: application/json
 
         {
@@ -129,15 +130,21 @@ describe Jdoc::Generator do
         }
         ```
 
-        ### PATCH /apps/:id
-        Update an existing app.
+        ### GET /apps
+        List existing apps.
 
         ```
-        PATCH /apps/:id HTTP/1.1
+        GET /apps HTTP/1.1
         Content-Type: application/json
         Host: api.example.com
+        ```
+
+        ```
+        HTTP/1.1 200
+        Content-Type: application/json
 
         {
+          "id": "01234567-89ab-cdef-0123-456789abcdef",
           "name": "example",
           "private": false,
           "deleted_at": null,
@@ -147,12 +154,15 @@ describe Jdoc::Generator do
         }
         ```
 
+        ### PATCH /apps/:id
+        Update an existing app.
+
         ```
-        HTTP/1.1 200
+        PATCH /apps/:id HTTP/1.1
         Content-Type: application/json
+        Host: api.example.com
 
         {
-          "id": "01234567-89ab-cdef-0123-456789abcdef",
           "name": "example",
           "private": false,
           "deleted_at": null,
@@ -162,15 +172,6 @@ describe Jdoc::Generator do
         }
         ```
 
-        ### DELETE /apps/:id
-        Delete an existing app.
-
-        ```
-        DELETE /apps/:id HTTP/1.1
-        Content-Type: application/json
-        Host: api.example.com
-        ```
-
         ```
         HTTP/1.1 200
         Content-Type: application/json
@@ -186,6 +187,14 @@ describe Jdoc::Generator do
         }
         ```
 
+        ## User
+
+
+        ### Properties
+        * name - 
+         * Example: `"alice"`
+         * Type: string
+
       EOS
     end
   end

data/template.md.erb

@@ -1,12 +1,12 @@
 # <%= schema.title %>
-<% schema.links_indexed_by_resource.each do |resource, links| %>
+<% schema.resources.each do |resource| %>
 * <%= resource.hyperlink %>
-<% links.each do |link| %>
+<% resource.links.each do |link| %>
  * <%= link.hyperlink %>
 <% end %>
 <% end %>
 
-<% schema.links_indexed_by_resource.each do |resource, links| %>
+<% schema.resources.each do |resource| %>
 ## <%= resource.title %>
 <%= resource.description %>
 
@@ -18,7 +18,7 @@
 <% end %>
 <% end %>
 
-<% links.each do |link| %>
+<% resource.links.each do |link| %>
 ### <%= link.endpoint %>
 <%= link.description %>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jdoc
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryo Nakamura