yardbird 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c462a82143467e59909e2bb11fd44140f059fe78
-  data.tar.gz: e56a4d6754f264b887dd544b9d2d447b48375796
+  metadata.gz: 68304b7d6a0c9879c7aa5ed3026679874899f9f7
+  data.tar.gz: 35ab902484d2c65999e35c0ceed295626b6d4513
 SHA512:
-  metadata.gz: 9dcf3f085302c37755dea9461ef4ff6f6839c2e3bbc0a0fda15ea0b706f7d47f9bced024dabefe8935a85165142e7de668d01055a995650edf19b339e4d10c1f
-  data.tar.gz: 71349277759eec01bf424df58bf4b19aaf6dfae1f736c1ccebc8e206a126a2848ac41ad3dada9c4892600dcc802a22c1103a1c9bb81953cc5fda953e2823e75e
+  metadata.gz: 3579091f35233db6ccbd1d94f7680056c8543e8c941d3c2f8682b934bab9da212d247ffa7695a4b7e003676d08b85336df99b6b0365db666ff094a064c3abd26
+  data.tar.gz: 33d69dc586b51fa992e29ba50a53856456b39ccd623632f212b0e3a8fb82d2482f56b95da7ff529846b075450df19ffbdc809f9e6fa971bec5935d0eecd6d95a

data/bin/yardbird

@@ -14,7 +14,9 @@ Mercenary.program(:yardbird) do |p|
     c.description "Generates from PATH"
     c.option :outfile, '-o TARGET', '--out TARGET', 'Write to TARGET. Defaults to standard output.'
     c.option :section_level, '--start-section LEVEL', 'Begin sections at level LEVEL. Default is 0.', Integer
-
+    c.option :toc, '--toc', 'Include table of contents.', TrueClass
+    c.option :title, '--title TITLE', 'Set a title'
+    c.option :yaml, '--yaml KEY=VALUE[,KEY=VALUE...]', 'Add YAML headers (for use with Jekyll)', Array
     c.action do |args, options|
       abort "Specify a path." if args.empty?
       if (file = options[:outfile])
@@ -23,7 +25,14 @@ Mercenary.program(:yardbird) do |p|
         stream = $stdout
       end
       generator = Yardbird::Generator.new
+      generator.title = options[:title]
       generator.section_level = options[:section_level]
+      generator.table_of_contents = options[:toc]
+      [options[:yaml]].flatten.each do |s|
+        if s =~ /\A(.*)=(.*)\z/
+          generator.yaml_headers[$1] = $2
+        end
+      end
       generator.paths |= args
       generator.generate(stream)
     end

data/lib/yardbird/generator.rb

@@ -10,11 +10,14 @@ module Yardbird
   class Generator
 
     attr_accessor :paths
-    attr_accessor :options
     attr_accessor :section_level
+    attr_accessor :table_of_contents
+    attr_accessor :title
+    attr_reader :yaml_headers
 
     def initialize(options = {})
       @paths = []
+      @yaml_headers = {}
     end
 
     def generate(stream)
@@ -22,77 +25,91 @@ module Yardbird
 
       grouped_by_category = endpoints.group_by { |e| e.category }
 
-      writer = Writer.new(stream, section_level: @section_level)
+      if @yaml_headers.any?
+        stream.puts "---"
+        @yaml_headers.each do |k, v|
+          stream.puts "#{k}: #{v}"
+        end
+        if @title and not @yaml_headers['title']
+          stream.puts "title: #{@title}"
+        end
+        stream.puts "---"
+      end
 
-      writer.line "<section id='toc'>"
-      writer.section "Table of Contents" do
-        categories = grouped_by_category.keys.uniq.sort_by { |s| s.downcase }
-        categories.each do |category|
-          writer.bullet "[#{category}](##{category_anchor_name(category)})"
-          writer.indent(2) do
-            eps = grouped_by_category[category]
-            eps.each do |ep|
-              writer.bullet "[`#{ep.method} #{ep.path}`](##{endpoint_anchor_name(ep)})"
+      writer = Writer.new(stream, section_level: @section_level)
+      writer.section @title do
+        if @table_of_contents
+          writer.section "Table of Contents" do
+            categories = grouped_by_category.keys.uniq.sort_by { |s| s.downcase }
+            categories.each do |category|
+              writer.bullet "[#{category}](##{category_anchor_name(category)})"
+              writer.indent(2) do
+                eps = grouped_by_category[category]
+                eps.each do |ep|
+                  writer.bullet "[`#{ep.method} #{ep.path}`](##{endpoint_anchor_name(ep)})"
+                end
+              end
             end
           end
         end
-      end
-      writer.line "</section>"
-
-      grouped_by_category.each do |category, eps|
-        writer.heading category, anchor: category_anchor_name(category)
-        writer.section do
-          eps.each do |ep|
-            writer.heading "`#{ep.method} #{ep.path}`", anchor: endpoint_anchor_name(ep)
-            writer.section do
-              writer.line ep.docstring
-              if ep.params.any?
-                writer.heading "Parameters"
-                writer.section do
-                  ep.params.each do |param|
-                    writer.line "`#{param[:name]}` (",
-                      [param[:types]].flatten.join(', '),
-                      param[:type] == 'required' ? ", **required**" : '',
-                      ")<br/>#{param[:doc]}"
-                    writer.blank
+
+        grouped_by_category.each do |category, eps|
+          writer.section category, anchor: category_anchor_name(category) do
+            eps.each do |ep|
+              writer.section "`#{ep.method} #{ep.path}`", anchor: endpoint_anchor_name(ep) do
+                writer.line ep.docstring
+                if ep.params.any?
+                  writer.section "Parameters" do
+                    ep.params.each do |param|
+                      writer.line "`#{param[:name]}` (",
+                        [param[:types]].flatten.join(', '),
+                        param[:type] == 'required' ? ", **required**" : '',
+                        ")<br/>#{param[:doc]}"
+                      writer.blank
+                    end
                   end
                 end
-              end
-              if ep.status.present?
-                writer.heading "Status Codes"
-                writer.section do
-                  ep.status.each do |s|
-                    writer.line "**#{s[:code]}** — #{s[:doc]}"
-                    writer.blank
+                if ep.status.present?
+                  writer.section "Status Codes" do
+                    ep.status.each do |s|
+                      writer.line "**#{s[:code]}** — #{s[:doc]}"
+                      writer.blank
+                    end
                   end
                 end
-              end
-              if ep.example.present?
-                writer.heading "Example"
-                writer.code_block do
-                  writer.line "#{ep.method} #{ep.example} HTTP/1.1"
+                if ep.example.present?
+                  writer.section "Example" do
+                    writer.code_block do
+                      writer.line "#{ep.method} #{ep.example} HTTP/1.1"
+                    end
+                  end
                 end
               end
             end
           end
         end
       end
-
       writer.flush
+
       stream
     end
 
     private
 
       def category_anchor_name(category)
-        category.downcase
+        if @table_of_contents
+          category.downcase
+        end
       end
 
       def endpoint_anchor_name(endpoint)
-        [endpoint.category, endpoint.method, endpoint.path.gsub(/[\/:]/, '-')].
-          join('-').
-          gsub(/-+/, '-').
-          downcase
+        if @endpoint_anchor_name
+          [endpoint.category, endpoint.method, endpoint.path.gsub(/[\/:]/, '-')].
+            join('-').
+            gsub(/-+/, '-').
+            downcase
+
+        end
       end
 
   end

data/lib/yardbird/version.rb

@@ -1,3 +1,3 @@
 module Yardbird
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/yardbird/writer.rb

@@ -21,12 +21,15 @@ module Yardbird
       @stream.write("\n")
     end
 
-    def section(title = nil, &block)
-      heading(title) if title
-
-      @section_level += 1
-      yield
-      @section_level -= 1
+    def section(title, options = {}, &block)
+      if title
+        heading(title, options)
+        @section_level += 1
+        yield
+        @section_level -= 1
+      else
+        yield
+      end
     end
 
     def blank

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yardbird
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alexander Staubo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard