jdoc 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fc087dc2403a8ae46e6345a6ac7272eed69dde5
-  data.tar.gz: 0d6d68f56b63640504024d927d61db162804f93a
+  metadata.gz: 44f0091a8a36bc9270c3c13de5553c51051b1261
+  data.tar.gz: 69173ed695ea55d08826cefe5c43eff342b81c07
 SHA512:
-  metadata.gz: cd7c71ab68fd9cde88de70bc5b6f1055129120a432683366f207ef9cf8508e611934b9651c036032aaec019fb01eeda4cf707e2ecbfd4378122a406666d14686
-  data.tar.gz: 214d08b958202d211e3824043b4daf9bacc76db34ba049f6585fba364221d6e97f21a62b3cd546b378ef00b836f105596124aaa3d32fb0154c8f7611164f04e8
+  metadata.gz: ed1792568d15ba8d43ea696b417ed3d009a241d8ab4c0c194b9d6794d1bf4007712ab766167097c90f6597daa1d0a7b400b571418173bbc7ff526a8be47acc78
+  data.tar.gz: 71dc0edef70729432ecdfd651b2552ed057d4760f72b1c4ec84833b2cc7bde3d2d7224f70a56c4c63a5ed453e63e5295424e4b86bd072c2c3717ad77fbfa9af5

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.0.9
+* Support array property
+
 ## 0.0.8
 * Fix resource equality
 

data/lib/jdoc/link.rb

@@ -64,7 +64,7 @@ module Jdoc
 
     # @return [String, nil] Example request body in JSON format
     def request_body
-      JSON.pretty_generate(RequestGenerator.call(schema)) + "\n"
+      JSON.pretty_generate(RequestGenerator.call(schema.properties)) + "\n"
     end
 
     # @return [true, false] True if this endpoint must have request body
@@ -98,7 +98,7 @@ module Jdoc
     # @return [Hash]
     # @raise [Rack::Spec::Mock::ExampleNotFound]
     def response_hash
-      ResponseGenerator.call(schema)
+      ResponseGenerator.call(schema.properties)
     end
 
     # @return [Fixnum] Order score, used to sort links by preferred method order
@@ -121,39 +121,24 @@ module Jdoc
 
     class RequestGenerator
       # Generates example request body from given schema
+      # @param properties [Hash]
       # @note Not includes properties that have readOnly property
       # @return [Hash]
       # @example
-      #   Jdoc::Link::RequestGenerator(schema) #=> { "name" => "example", "description" => "foo bar." }
-      def self.call(schema)
-        schema.properties.inject({}) do |result, (key, value)|
-          if value.data["readOnly"]
-            result
-          else
-            result.merge(
-              key => case
-              when !value.properties.empty?
-                call(value)
-              when !value.data["example"].nil?
-                value.data["example"]
-              when value.type.include?("null")
-                nil
-              else
-                raise ExampleNotFound, "No example found for #{schema.pointer}/#{key}"
-              end
-            )
-          end
-        end
+      #   Jdoc::Link::RequestGenerator(schema.properties) #=> { "name" => "example", "description" => "foo bar." }
+      def self.call(properties)
+        ResponseGenerator.call(properties.reject {|key, value| value.data["readOnly"] })
       end
     end
 
     class ResponseGenerator
       # Generates example response Hash from given schema
+      # @param properties [Hash]
       # @return [Hash]
       # @example
-      #   Jdoc::Link::ResponseGenerator(schema) #=> { "id" => 1, "name" => "example" }
-      def self.call(schema)
-        schema.properties.inject({}) do |result, (key, value)|
+      #   Jdoc::Link::ResponseGenerator(schema.properties) #=> { "id" => 1, "name" => "example" }
+      def self.call(properties)
+        properties.inject({}) do |result, (key, value)|
           result.merge(
             key => case
             when !value.properties.empty?
@@ -162,6 +147,8 @@ module Jdoc
               value.data["example"]
             when value.type.include?("null")
               nil
+            when value.type.include?("array")
+              call(value.items.properties)
             else
               raise ExampleNotFound, "No example found for #{schema.pointer}/#{key}"
             end

data/lib/jdoc/version.rb

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

data/spec/fixtures/schema.yml

@@ -82,6 +82,20 @@ definitions:
         "$ref": "#/definitions/app/definitions/private"
       deleted_at:
         "$ref": "#/definitions/app/definitions/deleted_at"
+      users:
+        type: array
+        items:
+          "$ref": "#/definitions/user"
+  user:
+    title: User
+    type: object
+    definitions:
+      name:
+        type: string
+        example: alice
+    properties:
+      name:
+        "$ref": "#/definitions/user/definitions/name"
 properties:
   app:
     "$ref": "#/definitions/app"

data/spec/jdoc/generator_spec.rb

@@ -45,6 +45,8 @@ describe Jdoc::Generator do
         * deleted_at - When this resource was deleted at
          * Example: `nil`
          * Type: null
+        * users - 
+         * Type: array
 
         ### GET /apps
         List existing apps.
@@ -63,7 +65,10 @@ describe Jdoc::Generator do
           "id": "01234567-89ab-cdef-0123-456789abcdef",
           "name": "example",
           "private": false,
-          "deleted_at": null
+          "deleted_at": null,
+          "users": {
+            "name": "alice"
+          }
         }
         ```
 
@@ -78,7 +83,10 @@ describe Jdoc::Generator do
         {
           "name": "example",
           "private": false,
-          "deleted_at": null
+          "deleted_at": null,
+          "users": {
+            "name": "alice"
+          }
         }
         ```
 
@@ -90,7 +98,10 @@ describe Jdoc::Generator do
           "id": "01234567-89ab-cdef-0123-456789abcdef",
           "name": "example",
           "private": false,
-          "deleted_at": null
+          "deleted_at": null,
+          "users": {
+            "name": "alice"
+          }
         }
         ```
 
@@ -111,7 +122,10 @@ describe Jdoc::Generator do
           "id": "01234567-89ab-cdef-0123-456789abcdef",
           "name": "example",
           "private": false,
-          "deleted_at": null
+          "deleted_at": null,
+          "users": {
+            "name": "alice"
+          }
         }
         ```
 
@@ -126,7 +140,10 @@ describe Jdoc::Generator do
         {
           "name": "example",
           "private": false,
-          "deleted_at": null
+          "deleted_at": null,
+          "users": {
+            "name": "alice"
+          }
         }
         ```
 
@@ -138,7 +155,10 @@ describe Jdoc::Generator do
           "id": "01234567-89ab-cdef-0123-456789abcdef",
           "name": "example",
           "private": false,
-          "deleted_at": null
+          "deleted_at": null,
+          "users": {
+            "name": "alice"
+          }
         }
         ```
 
@@ -159,7 +179,10 @@ describe Jdoc::Generator do
           "id": "01234567-89ab-cdef-0123-456789abcdef",
           "name": "example",
           "private": false,
-          "deleted_at": null
+          "deleted_at": null,
+          "users": {
+            "name": "alice"
+          }
         }
         ```
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jdoc
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-15 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis