markdown_ruby_documentation 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e4deabd18fa1afabe6abc4c3a9375341807ef22
-  data.tar.gz: db358d7299865548126c931f9756f4fff5534c5a
+  metadata.gz: 00ade506279b6b5d39ffa42bb4fc50b61d255222
+  data.tar.gz: c8426d9d8b851257d312552e13b6c84198b972b5
 SHA512:
-  metadata.gz: 1918c0b06612f8d663c2af76471ced722d1b3310f565fe3c4fdc611e8eb73417d58d19e9686238f10a691ef3a545bc871bf09ea250076562ac4d1adbadb24d46
-  data.tar.gz: 06248e8a5a0cd48486d3e7fd290f412c8ad0be54523d9537474e55d9784da06c75298612c0166c6bb5cc15f361e1255512678f7cd4bbaf83f76ed181d6c001f4
+  metadata.gz: 1473d3b33e26b1b26b818281d8d9c15112aa63840bad2c0e1b56de1413ddad1166c3f954acf2b41f1ab402d865c5bb6616943ad1609b1df69c2cfc0106b896ac
+  data.tar.gz: c41fc56eee17895ec7ee5f156ab3481b0ea6557aea8ddec81f55116fe67de990f099e684f2f1a5010f7b661c285a61b46a478e5b89a078c30dab190b71d2cc76

data/lib/markdown_ruby_documentation/generate.rb

@@ -4,42 +4,57 @@ module MarkdownRubyDocumentation
     # @param [Module] erb_methods must contain #link_to_markdown and contain any additional methods for comment ERB
     # @param [Proc] output_object given name: and text: for use in saving the the files.
     # @param [String] load_path
-    def self.run(
-      subjects:,
+    # @param [Hash] parallel_config - example { in_threads: 7 } - defaults to 2
+    class << self
+      def run(
+        subjects:,
         erb_methods: DefaultErbMethods,
         output_object:,
-        load_path:
-    )
-      self.output_object = output_object
-      self.load_path     = load_path
-      erb_methods_class  = Class.new
-      erb_methods_class.extend TemplateParser::CommentMacros
-      erb_methods_class.extend erb_methods
-      TemplateParser::CommentMacros.include erb_methods
-      left_padding = subjects.map(&:name).group_by(&:size).max.first
-      progressbar  = ProgressBar.create(title: "Compiling Markdown".ljust(left_padding), total: subjects.count+ 1)
-      pages        = subjects.map do |subject|
-        progressbar.title = subject.name.ljust(left_padding)
-        Page.new(subject:           subject,
-                 output_object:     output_object,
-                 erb_methods_class: erb_methods_class,
-                 load_path:         load_path).call.tap { progressbar.increment }
+        load_path:,
+        parallel_config: {})
+        self.output_object = output_object
+        self.load_path     = load_path
+        erb_methods_class  = Class.new
+        erb_methods_class.extend TemplateParser::CommentMacros
+        erb_methods_class.extend erb_methods
+        TemplateParser::CommentMacros.include erb_methods
+        left_padding(subjects)
+        progressbar(subjects)
+        progressbar.title = "Compiling Markdown".ljust(left_padding)
+        batches           = subjects.each_slice(parallel_config.fetch(:in_threads, 2))
+        threads           = []
+        batches.each do |batch|
+          threads << Thread.new(batch) do |(_batch)|
+          Array[_batch].flatten.map do |subject|
+              progressbar.title = subject.name.ljust(left_padding)
+              Page.new(subject:           subject,
+                       output_object:     output_object,
+                       erb_methods_class: erb_methods_class,
+                       load_path:         load_path).call.tap { progressbar.increment }
+            end
+          end
+        end
+        pages             = threads.flat_map(&:value)
+        return_value      = pages.each_with_object({}) do |page, hash|
+          name_parts      = page.subject.name.split("::")
+          name            = name_parts.pop
+          namespace       = name_parts.join("::")
+          hash[namespace] ||= {}
+          hash[namespace].merge!({ name => page })
+          hash
+        end
+        progressbar.title = "Markdown Documentation Compilation Complete".ljust(left_padding)
+        progressbar.finish
+        return_value
       end
 
-      return_value      = pages.each_with_object({}) do |page, hash|
-        name_parts      = page.subject.name.split("::")
-        name            = name_parts.pop
-        namespace       = name_parts.join("::")
-        hash[namespace] ||= {}
-        hash[namespace].merge!({ name => page })
-        hash
+      def progressbar(subjects=nil)
+        @progressbar ||= ProgressBar.create(title: "Compiling Markdown".ljust(left_padding(subjects)), total: subjects.count+ 1)
       end
-      progressbar.title = "Markdown Documentation Compilation Complete".ljust(left_padding)
-      progressbar.finish
-      return_value
-    end
 
-    class << self
+      def left_padding(subjects=nil)
+        @left_padding ||= subjects.map(&:name).group_by(&:size).max.first
+      end
       attr_accessor :load_path, :output_object
     end
 
@@ -79,8 +94,8 @@ module MarkdownRubyDocumentation
 
       def all_instance_and_class_methods(methods, subject)
         native_instance_methods = (subject.instance_methods(false) - Object.instance_methods(false)).concat(subject.private_instance_methods(false) - Object.private_instance_methods(false))
-        super_instance_methods = (subject.instance_methods(true) - Object.instance_methods(true)).concat(subject.private_instance_methods(true) - Object.private_instance_methods(true)) - native_instance_methods
-          klass_m    = subject.methods(false).concat(subject.private_methods(false)) - Object.methods
+        super_instance_methods  = (subject.instance_methods(true) - Object.instance_methods(true)).concat(subject.private_instance_methods(true) - Object.private_instance_methods(true)) - native_instance_methods
+        klass_m                 = subject.methods(false).concat(subject.private_methods(false)) - Object.methods
         methods.concat super_instance_methods.reverse.map { |method| InstanceMethod.new("#{subject.name}##{method}", context: subject, visibility: :super) }
         methods.concat native_instance_methods.map { |method| InstanceMethod.new("#{subject.name}##{method}", context: subject, visibility: :native) }
         methods.concat klass_m.map { |method| ClassMethod.new("#{subject.name}.#{method}", context: subject) }

data/lib/markdown_ruby_documentation/version.rb

@@ -1,3 +1,3 @@
 module MarkdownRubyDocumentation
-  VERSION = "0.4.4"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_ruby_documentation
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Dustin Zeisler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-18 00:00:00.000000000 Z
+date: 2016-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -163,3 +163,4 @@ specification_version: 4
 summary: Gem provides the ability to use markdown and ruby ERB with some helper methods
   inside of comments
 test_files: []
+has_rdoc: