grape-doc 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed25962e6e4c2190d9b0025d60404ea8752aa84e
-  data.tar.gz: f589a478394e5edd40c0dd9abb6c4741c06c4a8a
+  metadata.gz: 2663f1be3ceff0b795fab8fd8b6b7ade751ae9b9
+  data.tar.gz: 0a3c33f2094b71b751ab3b7e6b03a42cbcfeb92a
 SHA512:
-  metadata.gz: e3e6b4778c0e4636d5e5ead23a8cbe58c265ad44b34d5c3d587b12df1a475a95a7794d5cfad39881f0d59a775bcd2402f25fc0a04a9231e46759ec8461956af7
-  data.tar.gz: f45c66227bf5767eb0dafca6026cd071a7c16b560e9b288cbf6b7a8a73969ce9346e2f6e767fba525d99b2deaf77c9fb23faddfa9d45cc11a90b61c4016d3198
+  metadata.gz: 4ac309e0dca87872ad31477a9bd2c9009c7b556165a99b9d07911f334b7594fc146b78b895460a23fcb260f07f3e1794ba88f8069945dad0796dbb21811cb6e8
+  data.tar.gz: 7b2d9c0e55d506ba5101b58f601da249895265ae450c672e5370d5b8c1bedbd53d5d5d3b885ce309136c13be71fe0745a7ec1c0eca8d05e0b8d8b40b96b88afa

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.6.0

data/grape-doc.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'loader'
   spec.add_dependency 'RedCloth'
   spec.add_dependency 'rack-test'
-  spec.add_dependency 'rack-test-poc','1.1.0'
+  spec.add_dependency 'rack-test-poc','>= 3.0.0'
 
 end

data/lib/grape/doc/doc_class/header.rb

@@ -1,25 +1,34 @@
 module GrapeDoc
   class ApiDocParts
 
-    module TOC
-      class << self
-
-        def add_header(header_obj)
-          if [H1,H2].include? header_obj.class
-            (@headers ||= []).push(header_obj)
-          end
-        end
-
-        def create_toc
-          @headers.map { |header_obj|
-            [
-                '*' * header_obj.markdown.scan(/\d+$/)[0].to_i,
-                " \"#{header_obj.to_s}\":##{header_obj.instance_variable_get(:@opts)['id']}"
-            ].join
-          }.join("\n") + "\n\n"
-        end
+    class TOC
 
+      def headers
+        @headers ||= []
       end
+
+      def initialize(*args)
+        headers.push(*args)
+      end
+
+      def add_header(header_obj)
+        headers.push(header_obj)
+      end
+
+      def to_textile
+        headers.map { |header_obj|
+          [
+              '*' * header_obj.markdown.scan(/\d+$/)[0].to_i,
+              " \"#{header_obj.to_s}\":##{header_obj.instance_variable_get(:@opts)['id']}"
+          ].join
+        }.join("\n") + "\n\n"
+      end
+
+      def clear
+        headers.clear
+      end
+
+
     end
 
     class H1 < StringObject
@@ -27,7 +36,6 @@ module GrapeDoc
       def initialize(*args)
         super
         @opts['id']= SecureRandom.uuid
-        TOC.add_header(self)
       end
 
     end

data/lib/grape/doc/doc_class.rb

@@ -11,6 +11,16 @@ module GrapeDoc
       self.push(create(type,*args))
     end
 
+    def add_toc(*args)
+      @toc_added ||= ->{
+
+        args.map!{|e| Helpers.constantize("GrapeDoc::ApiDocParts::#{Helpers.camelize(e)}") }
+        self.insert(1,ApiDocParts::TOC.new(*self.select{|e| args.any?{|klass| e.class == klass }}))
+        true
+
+      }.call
+    end
+
     def to_textile
       require 'RedCloth'
       RedCloth.new(self.map{|e| e.respond_to?(:to_textile) ? e.to_textile : e.to_s }.join("\n\n"))

data/lib/grape/doc/generator.rb

@@ -4,11 +4,11 @@ module GrapeDoc
 
     attr_reader :options
     def initialize(opts={})
-      
+
       raise(ArgumentError,'invalid options given') unless opts.class <= Hash
       @options = {
-        'format' => 'html',
-		    'path'   => File.join(Helpers.doc_folder_path,'api_doc')
+          'format' => '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(/\..*$/,'')
 
@@ -18,10 +18,6 @@ module GrapeDoc
 
     end
 
-    def document
-      @api_doc ||= ApiDocumentation.new
-    end
-
     def save
 
       case @options['format'].to_s.downcase
@@ -42,103 +38,123 @@ module GrapeDoc
 
     private
 
+    def document
+      @api_doc ||= ApiDocumentation.new
+    end
+
     def process_head
       document.add :h1, "Rest Api Documentation (#{RackTestPoc.root.split(File::Separator)[-1]})"
     end
 
     def process_table_of_content
-      #TODO: Table of content here!
-      document.insert 1, ApiDocParts::TOC.create_toc
+      document.add_toc :h1,:h2
     end
 
     def process_endpoints
 
+      routes_var = []
+
       # Iterates over all subclasses (direct and indirect)
       Helpers.each_grape_class do |rest_api_model|
         rest_api_model.routes.each do |route|
-
           next if route.route_path =~ /\(\.:format\)\(\.:format\)$/
+          routes_var.push(route)
+        end
+      end
 
-          document.add :h2, "#{route.route_method.to_s.upcase}: #{route.route_path}"
-          document.add :h3, 'Request'
-          document.add :h4, 'description'
-          var = case route.route_description
+      routes_var.uniq.each do |route|
 
-                  when Hash
-                    (route.route_description.find{ |k,v| k == 'desc' || k == :desc } || [])[1] || ''
+        document.add :h2, "#{route.route_method.to_s.upcase}: #{route.route_path}"
+        document.add :h3, 'Request'
+        document.add :h4, 'description'
+        var = case route.route_description
 
-                  when Array
-                    route.route_description
+                when Hash
+                  (route.route_description.find{ |k,v| k == 'desc' || k == :desc } || [])[1] || ''
 
-                  else
-                    route.route_description.to_s
+                when Array
+                  route.route_description
 
-                end
+                else
+                  route.route_description.to_s
 
-          document.add :list,[*var]
+              end
 
-          if route.route_params.length > 0
-            document.add :h4, 'params'
+        document.add :list,[*var]
 
-            route.route_params.each do |key,value|
-              document.add :list,[
-                  document.create(:text,key.to_s,:bold),
-                  document.create(:list,value.map{ |k,v| "#{k}: #{v}" })
-              ]
+        if route.route_params.length > 0
+          document.add :h4, 'params'
 
-            end
+          route.route_params.each do |key,value|
+            document.add :list,[
+                document.create(:text,key.to_s,:bold),
+                document.create(:list,value.map{ |k,v| "#{k}: #{v}" })
+            ]
 
           end
 
-          route_path_var = route.route_path.to_s.sub(/\(\.:format\)$/,'')
-          @poc_data ||= Helpers.poc_data
-          if @poc_data && @poc_data.find{|k,v| k =~ /^#{route_path_var}/ }
-            route_method_var = route.route_method.to_s.upcase
+        end
 
-            poc_cases = @poc_data.select{|k,v|
-              k =~ /^#{route_path_var}\.?/ && v.keys.include?(route_method_var)
-            }
+        route_path_var = route.route_path.to_s.sub(/\(\.:format\)$/,'')
+        @poc_data ||= Helpers.poc_data
+        if @poc_data && @poc_data.find{|k,v| k =~ /^#{route_path_var}/ }
+          route_method_var = route.route_method.to_s.upcase
 
-            document.add :h3,'Response'
-            document.add :h4,'example'
+          poc_cases = @poc_data.select{|k,v|
+            k =~ /^#{route_path_var}\.?/ && v.keys.include?(route_method_var)
+          }
 
-            poc_cases.each do |poc_path,poc_data|
-              poc_opts = poc_data[route_method_var] || next
+          document.add :h3,'Response'
+          document.add :h4,'Example(s)'
 
-              document.add :h5,"curl sample with #{poc_path}"
-              document.add :raw,[
-                  "$ curl ",
-                  "-X #{route_method_var} ",
-                  "\"http://#{ -> { poc_opts['response']['headers']['HTTP_HOST'] rescue 'example.org' }.call}",
-                  "#{poc_path}?","#{poc_opts['request']['query']['raw']}\" ",
-                  poc_opts['request']['headers'].map{|k,v| "-H \"#{k}: #{v}\"" }.join(' ')
-              ].join
+          poc_cases.each do |poc_path,poc_data|
+            poc_examples = poc_data[route_method_var] || next
+            poc_examples.each_with_index do |poc_opts,i|
+              i = i + 1
+              begin
 
-              document.add :list,[
-                  "status code: #{poc_opts['response']['status']}",
-                  "format type: #{poc_opts['response']['format']}"
-              ]
+                document.add :h5,"#{i}. curl sample"
+                document.add :raw,[
+                    "$ curl ",
+                    "-X #{route_method_var} ",
+                    "\"http://#{ -> { poc_opts['response']['headers']['HTTP_HOST'] rescue 'example.org' }.call}",
+                    "#{poc_path}?","#{poc_opts['request']['query']['raw']}\" ",
+                    poc_opts['request']['headers'].map{|k,v| "-H \"#{k}: #{v}\"" }.join(' ')
+                ].join
 
-              document.add :h6,'raw response body'
-              document.add :raw,poc_opts['response']['raw_body']
+                document.add :list,[
+                    "status code: #{poc_opts['response']['status']}",
+                    "format type: #{poc_opts['response']['format']}"
+                ]
 
-              if JSON.respond_to?(:pretty_generate)
+                document.add :h5,'Response Body'
 
-                document.add :h6,'json formatted body with Class types'
-                pretty_object = JSON.pretty_generate(
-                                 Parser.typer(poc_opts['response']['body'])
-                             ) rescue Parser.typer(poc_opts['response']['body'])
+                document.add(:h6,'Raw version')
+                document.add(:raw,poc_opts['response']['body']['raw'])
 
-                document.add :raw,pretty_object
+                if JSON.respond_to?(:pretty_generate)
 
+                  document.add(:h6,'json formatted body with Class types')
+                  pretty_object = JSON.pretty_generate(
+                      Parser.typer(poc_opts['response']['body']['object'])
+                  ) rescue Parser.typer(poc_opts['response']['body']['object'])
 
-              end
+                  document.add(:raw,pretty_object)
+
+                end
 
+                if poc_opts['response']['body']['description']
+                  document.add(:h6,'Yaml formatted body with descriptions')
+                  document.add(:raw,poc_opts['response']['body']['description'].to_yaml)
+                end
 
+              rescue
+              end
             end
-
           end
+
         end
+
       end
 
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-doc
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Adam Luzsi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-14 00:00:00.000000000 Z
+date: 2014-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,16 +98,16 @@ dependencies:
   name: rack-test-poc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 3.0.0
 description: " Documentation generator for Grape module compatible with Redmine/textile
   and Html formats "
 email: