grape_doc 0.0.2 → 0.1.0

data/CHANGELOG.md

@@ -1,9 +1,11 @@
-## 0.0.2
+# 0.0.2
  
   - Support non-rails apps
 
-## 0.0.1 
+# 0.0.1
 
-  - Rails support only
-  - generate Markdown
+ - markdown formatter
+ - generate single doc file doc/api.md
+ - rails only
+ - generate only parameters documentation
 

data/README.md

@@ -1,5 +1,3 @@
-_Not published yet_
-
 # GrapeDoc
 
 This gem generate API documentation from Grape API.
@@ -69,59 +67,15 @@ _At this time it supports only MarkDown format._
       Tweet.find(params[:id])
     end
 
-### Manual response description
-
-Single entity
-
-    desc "Returns a tweet.", 
-    :response => {
-      :id => 14,
-      :tweet => "FooBarBazz"
-    }
-    get '/show/:id' do
-      Tweet.find(params[:id])
-    end
-
-Array of entities
-
-    desc "Returns a tweets",
-    :response => [
-      {
-        :id => 14,
-        :tweet => "FooBarBazz"
-      },
-      {
-        :id => 14,
-        :tweet => "FooBarBazz"
-      }
-    ]
-    get '/tweets' do
-      Tweet.all
-    end
-
-### Response using Grape::Entity
-
-Single entity
+## TODO
 
-    desc "Returns a tweet.", 
-    :response_with => { :entity => API::Entities::Tweet }
-    get '/show/:id' do
-      Tweet.find(params[:id])
-    end
-
-Array of entities
-
-    desc "Returns a tweet.", 
-    :response_with => { :entities => API::Entities::Tweet }
-    get '/show/:id' do
-      Tweet.find(params[:id])
-    end
-
-Grape::Entity description 
-
-    class Tweet < Grape::Entity
-      expose :tweet, :documentation => {:type => String, :desc => "words go here", :value => "FuuBar"}
-    end
+ - generate plain response
+ - generate response from Grape::Entity
+ - generate response from Grape::Entity with nested entities
+ - other output formats
+ - ~~write docs into separated files~~
+ - add code documentation
+ - and more others features
 
 ## Contributing
 

data/grape_doc.gemspec

@@ -4,9 +4,9 @@ require File.expand_path('../lib/grape_doc/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Alex Denisov"]
   gem.email         = ["1101.debian@gmail.com"]
-  gem.description   = %q{: Write a gem description}
-  gem.summary       = %q{: Write a gem summary}
-  gem.homepage      = ""
+  gem.description   = %q{Documentation generator for Grape API}
+  gem.summary       = %q{Documentation generator for Grape API}
+  gem.homepage      = "https://github.com/AlexDenisov/grape_doc"
   gem.files         = `git ls-files`.split($\)
   gem.executables << "grape_doc"
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})

data/lib/grape_doc/doc_generator.rb

@@ -29,14 +29,12 @@ module GrapeDoc
 
     def generate
       doc_formatter = init_formatter
-      generated_resources = self.resources.map do | resource |
-        doc_formatter.generate_resource_doc resource
-      end.join
       doc_dir = "#{Dir.pwd}/grape_doc"
-      doc_path = "#{doc_dir}/api.md"
-      Dir::mkdir(doc_dir)
-      output = File.open(doc_path, "w")
-      output << generated_resources
+      FileUtils.mkdir_p(doc_dir)
+
+      self.resources.each do | resource |
+        File.open(File.join(doc_dir, "#{resource.resource_name}.md"), 'w') {|f| f.write doc_formatter.generate_resource_doc(resource) }
+      end
     end
   end
 end

data/lib/grape_doc/version.rb

@@ -1,3 +1,3 @@
 module GrapeDoc
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-10 00:00:00.000000000 Z
+date: 2013-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -87,7 +87,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.11'
-description: ': Write a gem description'
+description: Documentation generator for Grape API
 email:
 - 1101.debian@gmail.com
 executables:
@@ -123,7 +123,7 @@ files:
 - spec/test_classes/api.rb
 - spec/test_classes/projects.rb
 - spec/test_classes/users.rb
-homepage: ''
+homepage: https://github.com/AlexDenisov/grape_doc
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -143,10 +143,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: ': Write a gem summary'
+summary: Documentation generator for Grape API
 test_files:
 - spec/api_document_spec.rb
 - spec/api_parameter_spec.rb
@@ -158,3 +158,4 @@ test_files:
 - spec/test_classes/api.rb
 - spec/test_classes/projects.rb
 - spec/test_classes/users.rb
+has_rdoc: