grape-doc 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aaecb438259bbda6c0f52ef2d1e7a027cd686b27
-  data.tar.gz: ab25877beee8e7315d34b2fca1f5ca15f2b3743a
+  metadata.gz: b3ef112f1cfda8c0f2aeaea8a6e6bf31ec205c70
+  data.tar.gz: 3e3ba46f60a0a3f42e323d84335ab4e56ebf850e
 SHA512:
-  metadata.gz: fcb4dfccecef9025b1877ab84a12fed26489201d660ac5faf932d8a98eed0a19d01103e6ce48c59153a238bdf728c490c5eeda3d5a6b7787b95680cefbfc401c
-  data.tar.gz: 44205c82703e4b7176fc49255c0d50489c0b4387ffe1e07302b1a793f5ab494cecd45e6f221c7b752bb048cca94332f502f140532ba7a760b7fa8f584509bc09
+  metadata.gz: 610f14fea4beb9067955f13308491583cbb101d1984dff76c536b565cc93c26152ad4db64938e8549b83b32829784676900ca9a5d679f33765f28328e822a81a
+  data.tar.gz: ce10b1cbd6fed21329bf10e21f50b73da442262bb916adc0ee38a0a1f951149f530396db725ec7697253207d589b2121030196fbe87f18ef24c856cabe66d573

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.4.0

data/lib/grape/doc/doc_class.rb

@@ -2,23 +2,18 @@ module GrapeDoc
 
   class ApiDocumentation < Array
 
-    def create(type,*args)
+    def build(type,*args)
       raise(ArgumentError,'invalid type') unless [String,Symbol].any?{ |klass| type.class <= klass }
       return Helpers.constantize("GrapeDoc::ApiDocParts::#{Helpers.camelize(type)}").new(*args)
-    end
+    end;alias create build
 
     def add(type,*args)
       self.push(create(type,*args))
     end
 
-    def br(int=1)
-      raise unless int.class <= Integer
-      int.times{self.push(ApiDocParts::Br.new("\n"))}
-    end
-
     def to_textile
       require 'RedCloth'
-      RedCloth.new(self.map{|e| e.to_textile }.join("\n"))
+      RedCloth.new(self.map{|e| e.to_textile }.join("\n\n"))
     end;alias to_s to_textile
 
   end

data/lib/grape/doc/generator.rb

@@ -8,7 +8,7 @@ module GrapeDoc
       raise(ArgumentError,'invalid options given') unless opts.class <= Hash
       @options = {
         'format' => 'html',
-		'path'   => File.join(Helpers.doc_folder_path,'api_doc.html')
+		    'path'   => File.join(Helpers.doc_folder_path,'api_doc.html')
       }.merge(opts.reduce({}){|m,o| m.merge!(o[0].to_s => o[1]) ;m})
 
       process_head
@@ -23,8 +23,18 @@ module GrapeDoc
 
     def save
 
-      File.write self.options['path'],
-                 document.to_textile.to_html
+      case @options['format'].to_s.downcase
+
+        when /redmine/,/textile/
+          File.write self.options['path'].sub(/\..*$/,'.textile'),
+                     document.to_textile
+
+        else
+          File.write self.options['path'].sub(/\..*$/,'.html'),
+                     document.to_textile.to_html
+
+
+      end
 
       true;rescue;false
     end;alias save! save

data/lib/grape/doc/prototype.rb

@@ -28,7 +28,7 @@ module GrapeDoc
     class StringObject < StringBasic
 
       def to_textile
-        "#{markdown}. #{self.to_s}\n"
+        "#{markdown}. #{self.to_s}"
       end
 
     end
@@ -36,7 +36,7 @@ module GrapeDoc
     class StringObjectEnded < StringObject
 
       def to_textile
-        "#{markdown}#{self}#{markdown}\n"
+        "#{markdown}#{self}#{markdown}"
       end
 
     end
@@ -82,7 +82,7 @@ module GrapeDoc
               "#{markdown} #{e}"
 
           end
-        }.push('').join("\n")
+        }.join("\n")
       end
 
     end

data/test/sample.html

@@ -22,7 +22,7 @@
 	<li>status code: 200</li>
 	<li>format type: json</li>
 </ul>
-<h6>raw body</h6>
+<h6>raw response body</h6>
 <pre>{"hello":"world!"}</pre>
 <h6>json formatted body with Class types</h6>
 <pre>{
@@ -34,7 +34,7 @@
 	<li>status code: 200</li>
 	<li>format type: json</li>
 </ul>
-<h6>raw body</h6>
+<h6>raw response body</h6>
 <pre>{"hello":"world!"}</pre>
 <h6>json formatted body with Class types</h6>
 <pre>{

data/test/sample.textile

@@ -0,0 +1,54 @@
+h1. Rest Api Documentation (grape-doc)
+
+h2. GET: /hello(.:format)
+
+h3. Request
+
+h4. description
+
+* Hello world!
+
+h4. params
+
+* test
+** required: false
+** type: String
+** desc: it's a test string
+
+h3. Response
+
+h4. example
+
+h5. curl sample with /hello
+
+<pre>$ curl -X GET "http://example.org/hello?test=hy" -H "Accept-Version: v1" -H "X-Token: blabla"</pre>
+
+* status code: 200
+* format type: json
+
+h6. raw response body
+
+<pre>{"hello":"world!"}</pre>
+
+h6. json formatted body with Class types
+
+<pre>{
+  "hello": "String"
+}</pre>
+
+h5. curl sample with /hello.json
+
+<pre>$ curl -X GET "http://example.org/hello.json?" -H "Accept-Version: v1" -H "X-Token: blabla"</pre>
+
+* status code: 200
+* format type: json
+
+h6. raw response body
+
+<pre>{"hello":"world!"}</pre>
+
+h6. json formatted body with Class types
+
+<pre>{
+  "hello": "String"
+}</pre>

data/test/test_generator.rb

@@ -4,7 +4,7 @@ describe 'Doc generating' do
   specify 'test documentation generator' do
 
     var = GrapeDoc.new
-    GrapeDoc.generate path: File.join(__dir__,'sample.html')
+    GrapeDoc.generate path: File.join(__dir__,'sample.html'),format: 'redmine'
 
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-doc
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Adam Luzsi
@@ -136,6 +136,7 @@ files:
 - lib/grape/doc/parser.rb
 - lib/grape/doc/prototype.rb
 - test/sample.html
+- test/sample.textile
 - test/test_all.rb
 - test/test_collector.rb
 - test/test_generator.rb
@@ -166,6 +167,7 @@ specification_version: 4
 summary: Documentation generator for Grape module
 test_files:
 - test/sample.html
+- test/sample.textile
 - test/test_all.rb
 - test/test_collector.rb
 - test/test_generator.rb