grape-doc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78159d4d2d7852fadb62e8caf6b7aad1dbd0f772
-  data.tar.gz: 4fcba1b40c4a766cfb9d2d06e48e2563c75bd6b1
+  metadata.gz: 3f00e6cadd228f64cd7fb2099ade14e6492f3089
+  data.tar.gz: 9996410f37a28e87a478bdafb9cb0ff75b65debb
 SHA512:
-  metadata.gz: b7780a35011633490200162fda618beb50ff8e82052c631690b99927fd82c4380d21d05a2fca12080373e32fc39b0041aaba4f2c067c8cc0142371c183991f22
-  data.tar.gz: 193c15ecde4b52289c5148b1b84aa4859f5561319b84c55ffcc7e40f1d2189962fb6e8632f0b62feab0c65e86ed54b2911be75fa3c2d64c6997f45ec4bfa1cf6
+  metadata.gz: 488d1cf71281297eb741814477060490592ca15d58ed1b9590eae3516ca6a841f2ab4b2179a5325dea6ff25677e54ff22d1e22f43bd32223138ae2db912bb0d9
+  data.tar.gz: 21333f8855c6ffb17cae84e5d86903a7fc31f148ee4121136cee56ecd76e087015d3204d831861ba7b5e10a6a9785abbdc96624951febf58ed8731c1191f88ed

data/README.md

@@ -1,4 +1,18 @@
 Grape-Doc
 ========
 
-Grape documentation generator, it's in alpha stage!
+Grape documentation generator
+
+install:
+
+  gem install grape-doc
+  
+Gemfile:
+
+gem 'grape-doc'
+
+Simple Use:
+
+  GrapeDoc.generate
+
+#> this will create an api_doc.html in the project folder/doc

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/grape/doc/generator.rb

@@ -1,6 +1,7 @@
 module GrapeDoc
   class Generator
 
+    attr_accessor :file_path
     def initialize(opts={})
       
       raise(ArgumentError,'invalid options given') unless opts.class <= Hash
@@ -10,6 +11,8 @@ module GrapeDoc
           }.merge(opts)
       )
 
+      self.file_path= opts[:path] || opts['path'] || File.join(Helpers.doc_folder_path,'api_doc.html')
+
       process_head
       process_table_of_content
       process_endpoints
@@ -21,9 +24,11 @@ module GrapeDoc
     end
 
     def save
-      File.write File.join(Helpers.doc_folder_path,'api_doc.html'),
-                 RedCloth.new(document.to_textile).to_html
 
+      File.write self.file_path,
+                 document.to_textile.to_html
+
+      true;rescue;false
     end;alias save! save
 
     private
@@ -120,7 +125,11 @@ module GrapeDoc
 
     def new(*args)
       Generator.new(*args)
-    end;alias generate new
+    end
+
+    def generate(*args)
+      Generator.new(*args).save
+    end;alias save generate
 
   end
 

data/lib/grape/doc/helper.rb

@@ -12,7 +12,7 @@ module GrapeDoc
       def doc_folder_path
         @doc_folder_path ||= -> {
           doc_folder_path = File.join(RackTestPoc.root,'doc')
-          File.mkdir doc_folder_path unless File.exist?(doc_folder_path)
+          Dir.mkdir doc_folder_path unless File.exist?(doc_folder_path)
           return doc_folder_path
 
         }.call

data/test/test_doc_gen.rb

@@ -8,6 +8,8 @@ describe 'Doc generating' do
     File.write File.join(RackTestPoc.root,'test','sample.html'),
                var.document.to_textile.to_html
 
+    GrapeDoc.generate
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-doc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Adam Luzsi