grape_doc 0.0.1 → 0.0.2

data/CHANGELOG.md

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

data/Gemfile

@@ -7,3 +7,4 @@ gem 'rspec'
 gem 'grape'
 gem 'json'
 gem 'rake'
+gem 'trollop'

data/README.md

@@ -1,3 +1,5 @@
+_Not published yet_
+
 # GrapeDoc
 
 This gem generate API documentation from Grape API.
@@ -18,19 +20,22 @@ Or install it yourself as:
 
 ## Usage
 
-To generate API documentation you should cd to rails app directory
-
-    $ cd rails_app
+To generate API documentation you should cd to your app directory
 
-Then run 
+    $ cd app_dir
 
+    # rails
     $ grape_doc
 
-It'll generate documentation for each Grape::API subclass and place it into **doc** directory. Each API subclass were placed as separated file.   
+    # non-rails
+    $ grape_doc --path sinatra_app.rb # for example
+
+
+It'll generate documentation for each Grape::API subclass and place it into **grape_doc** directory. Each API subclass were placed as separated file.   
 
 You can pass a doc formatter as parameter
 
-    $ grape_doc markdown
+    $ grape_doc
 
 _At this time it supports only MarkDown format._
 
@@ -64,15 +69,59 @@ _At this time it supports only MarkDown format._
       Tweet.find(params[:id])
     end
 
-## TODO
+### 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
 
- - 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
+### Response using Grape::Entity
+
+Single entity
+
+    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
 
 ## 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{Documentation generator for Grape API}
-  gem.summary       = %q{Documentation generator for Grape API}
-  gem.homepage      = "https://github.com/AlexDenisov/grape_doc"
+  gem.description   = %q{: Write a gem description}
+  gem.summary       = %q{: Write a gem summary}
+  gem.homepage      = ""
   gem.files         = `git ls-files`.split($\)
   gem.executables << "grape_doc"
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
@@ -14,6 +14,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = GrapeDoc::VERSION
   gem.add_runtime_dependency 'grape', '~> 0.2', '>= 0.2.1'
+  gem.add_runtime_dependency 'trollop', '~> 2.0'
   gem.add_runtime_dependency 'json', '~> 1.7', '>= 1.7.4'
   gem.add_development_dependency 'rspec', '~> 2.11'
 end

data/lib/grape_doc.rb

@@ -6,16 +6,22 @@ require 'grape_doc/api_parameter'
 require 'grape_doc/api_resource'
 require 'grape_doc/doc_generator'
 require 'grape_doc/formatters/markdown_formatter'
+require 'trollop'
 
-begin
-require File.expand_path(Dir.pwd + "/config/environment")
-rescue LoadError => ex
-  puts "#{ex}"
-end
+#begin
+#require File.expand_path(Dir.pwd + "/config/environment")
+#rescue LoadError => ex
+#  puts "#{ex}"
+#end
 
 module GrapeDoc
   def self.generate_doc
-    generator = DOCGenerator.new
+    opts = Trollop::options do
+      opt :path, "Resource path", 
+          :type => :string, 
+          :default => File.expand_path(Dir.pwd + "/config/environment") 
+    end
+    generator = DOCGenerator.new opts[:path]
     generator.generate
   end
 end

data/lib/grape_doc/doc_generator.rb

@@ -3,7 +3,20 @@ module GrapeDoc
     attr_accessor :resources, 
                   :formatter, 
                   :single_file
-    def initialize
+    def initialize(resource_path)
+      begin
+        require resource_path
+        self.load
+      rescue LoadError => ex
+        puts "#{ex}"
+      end
+    end
+
+    def init_formatter
+      return GrapeDoc::MarkdownFormatter.new if self.formatter.nil?
+    end
+
+    def load
       self.resources = Grape::API.subclasses.map do |klass|
         resource = APIResource.new(klass)
         if resource.documents.nil? or resource.documents.count.zero?
@@ -14,17 +27,15 @@ module GrapeDoc
       end.compact.sort_by{ |res| res.resource_name }
     end
 
-    def init_formatter
-      return GrapeDoc::MarkdownFormatter.new self.formatter.nil?
-      
-    end
-
     def generate
       doc_formatter = init_formatter
       generated_resources = self.resources.map do | resource |
         doc_formatter.generate_resource_doc resource
       end.join
-      output = File.open("#{Dir.pwd}/doc/api.md", "w")
+      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
     end
   end

data/lib/grape_doc/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-15 00:00:00.000000000 Z
+date: 2012-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -33,6 +33,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -71,7 +87,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.11'
-description: Documentation generator for Grape API
+description: ': Write a gem description'
 email:
 - 1101.debian@gmail.com
 executables:
@@ -107,7 +123,7 @@ files:
 - spec/test_classes/api.rb
 - spec/test_classes/projects.rb
 - spec/test_classes/users.rb
-homepage: https://github.com/AlexDenisov/grape_doc
+homepage: ''
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -130,7 +146,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Documentation generator for Grape API
+summary: ': Write a gem summary'
 test_files:
 - spec/api_document_spec.rb
 - spec/api_parameter_spec.rb