grape-doc 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f091b08c9891f653ccf8135a7ed2acd82b9aab73
-  data.tar.gz: abde91cc6fdf56b1a98a0a3d57f8cbdc50c70b5a
+  metadata.gz: 20c49ea385aee4168b325d4df3d75843c5fcd505
+  data.tar.gz: 7dfb74e1f420d008dc8ad3b66c7d262b026b8321
 SHA512:
-  metadata.gz: 55f9cbb99cd28cef5a1de3ed71d3e644b41cef3d3aa3e843cb3205a08e8aeedf8375bdcea6d122289603f296ee22202b9a605a76d57a09d9eb77ddd245cf65dd
-  data.tar.gz: 12dc7014a7b4022bffbd1bff1fb20929e1f2fe817d3010eec43858da5a1053c8d9b2ade4fad3558fe92d913928af3e32c2c5c7b3d4ba8fef56df6db88922cd41
+  metadata.gz: dd034ca8b87b1b77d87d5ae2f9db763babf1205d875722b975672155ef62ed1f318a09a61feb4a303ae7598392dad2885f4507872acab521c722ac991c998c3f
+  data.tar.gz: cedebfb30692dfe07801696fd2e65e567ae9c7f469ffb5ab8e1830ca19c04a2426f46fd99adf1f4e60013811fe49f58d309b280bf794fbd80785783479daedad

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.5.0

data/grape-doc.gemspec

@@ -2,27 +2,27 @@
 
 Gem::Specification.new do |spec|
 
-  spec.name          = "grape-doc"
-  spec.version       = File.open(File.join(File.dirname(__FILE__),"VERSION")).read.split("\n")[0].chomp.gsub(' ','')
-  spec.authors       = ["Adam Luzsi"]
-  spec.email         = ["adamluzsi@gmail.com"]
+  spec.name          = 'grape-doc'
+  spec.version       = File.open(File.join(File.dirname(__FILE__),'VERSION')).read.split("\n")[0].chomp.gsub(' ','')
+  spec.authors       = ['Adam Luzsi']
+  spec.email         = ['adamluzsi@gmail.com']
 
-  spec.description   = %q{ Documentation generator for Grape module compatible with Redmine and Github formats }
+  spec.description   = %q{ Documentation generator for Grape module compatible with Redmine/textile and Html formats }
   spec.summary       = %q{ Documentation generator for Grape module }
 
   spec.homepage      = "https://github.com/adamluzsi/#{__FILE__.split(File::Separator).last.split('.').first}"
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
 
-  spec.add_dependency "grape"
-  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 'grape'
+  spec.add_dependency 'loader'
+  spec.add_dependency 'RedCloth'
+  spec.add_dependency 'rack-test'
+  spec.add_dependency 'rack-test-poc','>= 1.1.0'
 
 end

data/lib/grape-doc.rb

@@ -1,3 +1,4 @@
 require 'loader'
+require 'securerandom'
 require 'rack-test-poc'
 require_relative_directory_r 'grape/doc'

data/lib/grape/doc/doc_class.rb

@@ -13,7 +13,7 @@ module GrapeDoc
 
     def to_textile
       require 'RedCloth'
-      RedCloth.new(self.map{|e| e.to_textile }.join("\n\n"))
+      RedCloth.new(self.map{|e| e.respond_to?(:to_textile) ? e.to_textile : e.to_s }.join("\n\n"))
     end;alias to_s to_textile
 
   end

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

@@ -1,7 +1,35 @@
 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
+
+      end
+    end
+
     class H1 < StringObject
+
+      def initialize(*args)
+        super
+        @opts['id']= SecureRandom.uuid
+        TOC.add_header(self)
+      end
+
     end
 
     class H2 < H1

data/lib/grape/doc/generator.rb

@@ -13,8 +13,8 @@ module GrapeDoc
       self.options['path'] = self.options['path'].to_s.sub(/\..*$/,'')
 
       process_head
-      process_table_of_content
       process_endpoints
+      process_table_of_content
 
     end
 
@@ -48,6 +48,7 @@ module GrapeDoc
 
     def process_table_of_content
       #TODO: Table of content here!
+      document.insert 1, ApiDocParts::TOC.create_toc
     end
 
     def process_endpoints

data/lib/grape/doc/helper.rb

@@ -21,7 +21,7 @@ module GrapeDoc
 
       def poc_file_path
         return Dir.glob(
-            File.join(RackTestPoc.root,'test','poc','*.{yml,yaml}')
+            File.join(::RackTestPoc.root,'test','poc','*.{yml,yaml}')
         ).max_by(&File.method(:ctime))
       end
 

data/lib/grape/doc/prototype.rb

@@ -13,6 +13,12 @@ module GrapeDoc
       end
 
       def initialize(*args)
+
+        @opts = args.select{|e| e.class <= ::Hash }
+        args -= @opts
+
+        @opts = @opts.reduce({}){|m,o| m.merge!(o[0].to_s => o[1]) ;m}
+
         args[0] = Parser.parse(args[0])
         self.replace(args[0].to_s)
       end
@@ -21,27 +27,49 @@ module GrapeDoc
         self.class.markdown
       end
 
-      alias to_textile to_s
+      def to_textile
+        case @opts['style'].to_s.downcase
 
-    end
+          when /^mirror/
+            "#{markdown}#{self}#{markdown}"
 
-    class StringObject < StringBasic
+          when /^start/,/^begin/
 
-      def to_textile
-        "#{markdown}. #{self.to_s}"
+            options = [
+                @opts['class']  ? "#{@opts['class']}" : nil,
+                @opts['id']     ? "##{@opts['id']}" : nil
+            ].compact
+
+            [
+                markdown,
+                options.empty? ? nil : "(#{options.join(' ')})",
+                '. ',
+                self.to_s
+            ].compact.join
+
+          else
+            self.to_s
+
+        end
       end
 
     end
 
-    class StringObjectEnded < StringObject
-
-      def to_textile
-        "#{markdown}#{self}#{markdown}"
+    class StringObject < StringBasic
+      def initialize(*args)
+        super
+        @opts['style']= 'start'
       end
+    end
 
+    class StringObjectEnded < StringObject
+      def initialize(*args)
+        super
+        @opts['style']= 'mirror'
+      end
     end
 
-    class ArrayObject < Array
+    class ArrayBasic < Array
 
       class << self
         def markdown=(obj)
@@ -87,5 +115,8 @@ module GrapeDoc
 
     end
 
+    class ArrayObject < ArrayBasic
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-doc
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Adam Luzsi
@@ -108,8 +108,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
-description: " Documentation generator for Grape module compatible with Redmine and
-  Github formats "
+description: " Documentation generator for Grape module compatible with Redmine/textile
+  and Html formats "
 email:
 - adamluzsi@gmail.com
 executables: []