autodoc 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 211a5ff3f6ccc9f726606ff6bbcc4f5e91ce3d63
-  data.tar.gz: 5cfb3d9454634c57926801f517725f84fd4450c1
+  metadata.gz: 7b959243c809886f4e1933c89600e19549fb7bdd
+  data.tar.gz: 8c6413d2c36bf8e717601e4472d160ef09df28b3
 SHA512:
-  metadata.gz: f6fe471073e53e8284c14675bcf874dcf68330b5bbb1b1ba52767ba52afba88861f48bf62fec51b4ff7bced45a9753b516e1857b6afb8a00e9f95e5f324293d6
-  data.tar.gz: 5c8934214f5501857a38a0b3123bfb40aae6f1e15d1ed300923bc4cdb44db8f7391793d94d4dd21de3ed17ed3bfea4a16203b821339f4fab7811704a95e18f20
+  metadata.gz: 7e37eda35bed6135a209aa11eb6858173509908bbf4a5c7f3e9ca3a5d79f84d6570739189fc1061c004af3b394d48a8a7288c6ef5c7ea2095b2457152b4bb628
+  data.tar.gz: 03dbc7218c2cc2bc93d30d67c6abc0d10d45b4c36d4c6ae303516971f782d7bc42b92720509e75f4925e7086dd38f4f8d6f2c25e55be24e7a0043f42583a07c4

data/lib/autodoc/document.rb

@@ -40,9 +40,7 @@ module Autodoc
     end
 
     def parameters
-      validators.map do |validator|
-        "* `#{validator.key}` #{validator.type}#{' (required)' if validator.required?}"
-      end.join("\n")
+      validators.map {|validator| Parameter.new(validator) }.join("\n")
     end
 
     def has_validators?
@@ -58,6 +56,44 @@ module Autodoc
         "\n#{header}: #{response.headers[header]}" if response.headers[header]
       end.compact.join
     end
+
+    class Parameter
+      attr_reader :validator
+
+      def initialize(validator)
+        @validator = validator
+      end
+
+      def to_s
+        "#{body}#{payload}"
+      end
+
+      private
+
+      def body
+        "* `#{validator.key}` #{validator.type}"
+      end
+
+      def payload
+        " (#{assets.join(', ')})" if assets.any?
+      end
+
+      def assets
+        @assets ||= [required, only, except].compact
+      end
+
+      def required
+        "required" if validator.required?
+      end
+
+      def only
+        "only: `#{validator.options[:only].inspect}`" if validator.options[:only]
+      end
+
+      def except
+        "except: `#{validator.options[:except].inspect}`" if validator.options[:except]
+      end
+    end
   end
 end
 

data/lib/autodoc/version.rb

@@ -1,3 +1,3 @@
 module Autodoc
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/dummy/app/controllers/recipes_controller.rb

@@ -1,7 +1,7 @@
 class RecipesController < ApplicationController
   validates :create do
-    string :name, required: true
-    integer :type
+    string :name, required: true, except: %w[alice bob]
+    integer :type, only: "1".."3"
   end
 
   def show

data/spec/dummy/doc/recipes.md

@@ -6,8 +6,8 @@ POST /recipes
 ```
 
 ### parameters
-* `name` string (required)
-* `type` integer
+* `name` string (required, except: `["alice", "bob"]`)
+* `type` integer (only: `"1".."3"`)
 
 ### response
 ```ruby
@@ -15,10 +15,10 @@ Status: 201
 location: http://www.example.com/recipes/1
 response: 
 {
-  "created_at" => "2013-06-14T01:11:34Z",
+  "created_at" => "2013-06-18T06:33:40Z",
   "id"         => 1,
   "name"       => "name",
-  "updated_at" => "2013-06-14T01:11:34Z"
+  "updated_at" => "2013-06-18T06:33:40Z"
 }
 ```
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autodoc
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-14 00:00:00.000000000 Z
+date: 2013-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print