grape-doc 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3ef112f1cfda8c0f2aeaea8a6e6bf31ec205c70
-  data.tar.gz: 3e3ba46f60a0a3f42e323d84335ab4e56ebf850e
+  metadata.gz: caa394eadde9afd947824250ce504efef851025d
+  data.tar.gz: 30a65e747ab167f41d4c4ac5b11aa54092d981fc
 SHA512:
-  metadata.gz: 610f14fea4beb9067955f13308491583cbb101d1984dff76c536b565cc93c26152ad4db64938e8549b83b32829784676900ca9a5d679f33765f28328e822a81a
-  data.tar.gz: ce10b1cbd6fed21329bf10e21f50b73da442262bb916adc0ee38a0a1f951149f530396db725ec7697253207d589b2121030196fbe87f18ef24c856cabe66d573
+  metadata.gz: 3b95bb7efabc6e93a542d38440af9fda0dee90b5e0020e6ca95753f932ce3ab7ceb37df72d0369c0369d27b75a3756dfa7b5a57ce22c43dfc4c14a071c162091
+  data.tar.gz: c676d58047822cd7148de315b84838b25db853568c01581e197a67581ace8da1c36a41d63074bd2a685c799bb88f46e5bfda14a6cb1f2a3a37541f07b49dbeaf

data/README.md

@@ -1,18 +1,58 @@
 Grape-Doc
 ========
 
-Grape documentation generator
+### Description
 
-install:
+It's a Grape documentation generator for lazy developers. 
+The main goal is to make as clean and useful documentation
+as possible for 3. party developers to your application without
+sharing anything from the code.
 
-  gem install grape-doc
+The Documentation generator it self is a little evil because
+it not force but really count on it, that you make test for 
+your api endpoints. For now it's all based on rack-test,
+but support will be given for other testing frameworks too.
+
+But dont misunderstand this, it can live without it, 
+you just have to do more support for the others,
+because the documentation will lack curl samples and sample 
+response body and stuffs like that.
+
+#### Install
+
+    $ gem install grape-doc
   
-Gemfile:
+#### Gemfile
+
+    gem 'grape-doc'
+
+#### Simple Use
+
+```ruby
+
+    GrapeDoc.generate
+    #> this will create an api_doc.html in the project_folder/doc
+    
+```
+
+I Would suggest run minitests first,
+with including all the test in the test folder that touch anything with your grape api classes.
+Because a rack-test-poc , there will be generated yaml files in the test/poc folder
+
+#### Complex Use
+
+```ruby
 
-gem 'grape-doc'
+    GrapeDoc.generate   format: 'redmine', # or textile, or html
+                        path: File.join(__dir__,'..........')
+                        
 
-Simple Use:
+```
+   
+well that was complex! right?
 
-  GrapeDoc.generate
+#### After words
 
-#> this will create an api_doc.html in the project folder/doc
+I would strongly suggest using Grape build in desc method for api endpoints,
+and define every parameters ahead, so they will be included in the documentation,
+and validated on request!

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/lib/grape/doc/generator.rb

@@ -8,8 +8,9 @@ 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')
       }.merge(opts.reduce({}){|m,o| m.merge!(o[0].to_s => o[1]) ;m})
+      self.options['path'] = self.options['path'].to_s.sub(/\..*$/,'')
 
       process_head
       process_table_of_content
@@ -26,11 +27,11 @@ module GrapeDoc
       case @options['format'].to_s.downcase
 
         when /redmine/,/textile/
-          File.write self.options['path'].sub(/\..*$/,'.textile'),
+          File.write self.options['path'] + '.textile',
                      document.to_textile
 
         else
-          File.write self.options['path'].sub(/\..*$/,'.html'),
+          File.write self.options['path'] + '.html',
                      document.to_textile.to_html
 
 

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'),format: 'redmine'
+    GrapeDoc.generate path: File.join(__dir__,'sample'),format: 'redmine'
 
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-doc
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Adam Luzsi
@@ -135,7 +135,6 @@ files:
 - lib/grape/doc/helper.rb
 - lib/grape/doc/parser.rb
 - lib/grape/doc/prototype.rb
-- test/sample.html
 - test/sample.textile
 - test/test_all.rb
 - test/test_collector.rb
@@ -166,7 +165,6 @@ signing_key:
 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

data/test/sample.html

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