uberdoc 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8e2f48319d33e62088a40fb92d43408e77aafe4
-  data.tar.gz: edbb98fc2d2e953d0eca33ecf5c644c75949da92
+  metadata.gz: 8db80f0fb41de31a5ce0fbc61899c3ddef1b4827
+  data.tar.gz: 7fafea493c93c3b4b06f480a7da933b93a7dbf23
 SHA512:
-  metadata.gz: f4e415cd02224b34f67364c75d43f972e71b593143386394c2061c509aab97eee5a3297f745358b17d9458135e4f19d9835f26a1cea6f25fe11cd8a2357d9c10
-  data.tar.gz: ccfa99de0981ff73e3f7cd76c2f49b79afe009278ac38ab641d22570820639fd9393c821407a508b022d79e6b65de7a811101d9d0878e4220ec956490a0a1738
+  metadata.gz: cf3fa0676a41fec0460f666d6b6a6b2400fe342589a7db9779bf437a0b974f225c651dae5f0cbc57f407cb17516fd5178684ae74af1598540817fbf6ea6a8704
+  data.tar.gz: a27264fcb0cd0d9cfb8a69f8e35c04cf823f62759697ad9be8e0cae89bc7636cf8aa405e36379718a2f90d651ef0f9300805d55cc2bb0d7da9601836aec8c590

data/Gemfile

@@ -5,6 +5,8 @@ source "http://rubygems.org"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
+gem "colorize"
+
 group :development do
   gem "shoulda", ">= 0"
   gem "rdoc", "~> 3.12"

data/Gemfile.lock

@@ -9,6 +9,7 @@ GEM
       tzinfo (~> 1.1)
     addressable (2.3.6)
     builder (3.2.2)
+    colorize (0.7.5)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     docile (1.1.5)
@@ -74,6 +75,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.0)
+  colorize
   jeweler (~> 2.0.1)
   rdoc (~> 3.12)
   shoulda

data/README.md

@@ -3,16 +3,27 @@ UberDoc
 
 A Documentation Generator
 
-```
-Usage: uberdoc [options]
-
-Available Options:
-    -d, --directory DIRECTORY        Looks for all UberDocMe files in the 
-                                     specified directory
-    -v, --verbose                    Verbosely print all commands and their
-                                     output
-    -g, --generate                   Generate the base UberDocMe template
-                                     file in the current directory
-    -h                               Show help
-
-```
+Installation
+------------
+
+ * Initial Install: `gem install uberdoc`
+ * Update to latest: `gem update uberdoc`
+
+Prepend `sudo` to each command if you are using the system Ruby on Mac.
+
+Post Install
+------------
+
+Run `uberdoc --doctor` to run diagnostics for missing dependencies on your system
+
+Help on Available Command
+-------------------------
+
+ * `uberdoc -h`
+
+Adding Custom Tasks
+-------------------
+
+ * If your task needs custom switches and command line options, add the same to the options parser
+ * Create a new `UberDoc::Task` subclass in the `lib/tasks` folder and name it `<your_task_name>_task.rb`
+ * Your custom subclass will be automatically picked up and asked to perform its task on the appropriate switches

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/uberdoc/options.rb

@@ -15,6 +15,7 @@ module UberDoc
             options.verbose = false
             options.generate = false
             options.doctor = false
+            options.docset = false
 
             parser = OptionParser.new do |opts|
 
@@ -42,6 +43,11 @@ module UberDoc
                     options.doctor = true
                 end
 
+                opts.on("--docset",
+                        "Generate Docsets as well as HTML docs") do |docset|
+                    options.docset = true
+                end
+
             end # OptionParser
 
             parser.parse!(args)

data/lib/uberdoc/tasks/doxygen_task.rb

@@ -36,27 +36,29 @@ module UberDoc
 
             File.open(composite_doxyfile_path, 'w') {|f| f.write(composite_doxyfile_contents) }
 
-            puts "Generating docset for #{project_name}"
+            if @options.docset
+                puts "Generating docset for #{project_name}"
 
-            # Change into the directory and invoke doxygen
-            FileUtils.cd(project_dir) do
-                UberDoc::Util::execute_command("#{DOXYGEN_BIN} #{composite_doxyfile_path}", @options.verbose)
-            end
+                # Change into the directory and invoke doxygen
+                FileUtils.cd(project_dir) do
+                    UberDoc::Util::execute_command("#{DOXYGEN_BIN} #{composite_doxyfile_path}", @options.verbose)
+                end
 
-            # Change into the HTML directory and make the docset
-            html_output_directory = File.join(absolute_out_dir, "html")
+                # Change into the HTML directory and make the docset
+                html_output_directory = File.join(absolute_out_dir, "html")
 
-            FileUtils.cd(html_output_directory) do
-                UberDoc::Util::execute_command("make", @options.verbose)
-            end
+                FileUtils.cd(html_output_directory) do
+                    UberDoc::Util::execute_command("make", @options.verbose)
+                end
 
-            # Find the docset file in the directory and move it one level up
-            docset_directory = File.join(absolute_out_dir, "docset") 
+                # Find the docset file in the directory and move it one level up
+                docset_directory = File.join(absolute_out_dir, "docset") 
 
-            FileUtils.mkdir_p(docset_directory)
+                FileUtils.mkdir_p(docset_directory)
 
-            Dir["#{html_output_directory}/**/*.docset"].each do |docset|
-                FileUtils.mv(docset, docset_directory)
+                Dir["#{html_output_directory}/**/*.docset"].each do |docset|
+                    FileUtils.mv(docset, docset_directory)
+                end
             end
 
             # Generate the docset again but this time with treeview

data/lib/uberdoc/utils.rb

@@ -2,6 +2,7 @@
 require 'open3'
 require 'fileutils'
 require 'pp'
+require 'colorize'
 
 module UberDoc
     module Util
@@ -13,20 +14,40 @@ module UberDoc
         #  Exectues the given command and optionally dumps the command and its output
         #
         def self.execute_command(command, verbose)
-            stdin, stdout, stderr, wait_thr = Open3.popen3(command)
-
-            res = stdout.read
 
             if verbose
-                puts ">>>>>>>>>>>>>>>>>>>>>>>>>"
-                puts "Command '#{command}'"
-                puts res
-                puts "<<<<<<<<<<<<<<<<<<<<<<<<<"
+                puts ">>>>>>>>>>>>>>>>>>>>>>>>>".green
+                puts "Command '#{command}'".green
             end
 
-            stdin.close
-            stdout.close
-            stderr.close
+            res = ""
+            Open3.popen3(command) do |stdin, stdout, stderr, thread|
+
+                {:out => stdout, :err => stderr}.each do |key, stream|
+                    Thread.new do
+                        until (line = stream.gets).nil? do
+                            if key == :out
+                                res += line
+                            end
+
+                            if verbose
+                                case key
+                                when :out
+                                    puts line
+                                when :err
+                                    puts line.red                                    
+                                end
+                            end
+                        end
+                    end
+                end
+
+                thread.join
+            end
+            
+            if verbose
+                puts "<<<<<<<<<<<<<<<<<<<<<<<<<".green
+            end
 
             return res
         end

data/uberdoc.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: uberdoc 0.3.0 ruby lib
+# stub: uberdoc 0.3.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "uberdoc"
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
@@ -50,12 +50,14 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<colorize>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
     else
+      s.add_dependency(%q<colorize>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
@@ -63,6 +65,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<simplecov>, [">= 0"])
     end
   else
+    s.add_dependency(%q<colorize>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uberdoc
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Chinmay Garde
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2015-02-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement