uberdoc 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f500f42f8dfb03896ce8d69c911d0a0888dc7515
-  data.tar.gz: 1c49cf88c27562c693a8b525451f03b2c7003c37
+  metadata.gz: a8e2f48319d33e62088a40fb92d43408e77aafe4
+  data.tar.gz: edbb98fc2d2e953d0eca33ecf5c644c75949da92
 SHA512:
-  metadata.gz: 7697dbedef4d4d292c50ba2dc7c8680de83ca3608d8bf2eb6c68ed20507d9c0bca2dd32636758f48f49a31b7170639c34e6c1be23d4e9c1ef645268f5da735c7
-  data.tar.gz: b271546ec78b1c9d6d0077f4764f4df04eb5b096468cc8c0e038afe24f3296cc13868f0f02463ed250be22fb198c3e496f0dd96bd06e24a77184af0ef87a8d2d
+  metadata.gz: f4e415cd02224b34f67364c75d43f972e71b593143386394c2061c509aab97eee5a3297f745358b17d9458135e4f19d9835f26a1cea6f25fe11cd8a2357d9c10
+  data.tar.gz: ccfa99de0981ff73e3f7cd76c2f49b79afe009278ac38ab641d22570820639fd9393c821407a508b022d79e6b65de7a811101d9d0878e4220ec956490a0a1738

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/bin/uberdoc

@@ -1,193 +1,8 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
 
-require 'open3'
-require 'fileutils'
-require 'optparse'
-require 'optparse/time'
-require 'ostruct'
-require 'pp'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
+require 'uberdoc'
 
-#
-#  Parses command line options passed in to Uberdoc
-#
-class UberdocOptions
-    def self.parse(args)
-        
-        options = OpenStruct.new
-        
-        options.source_directories = []
-        options.verbose = false
-        options.generate = false
-
-        parser = OptionParser.new do |opts|
-
-            opts.banner = "Usage: uberdoc [options]"
-            opts.separator ""
-            opts.separator "Available Options:"
-            
-            opts.on("-d", "--directory DIRECTORY", "Looks for all UberDocMe files in the specified directory")  do |dir|
-                options.source_directories << dir
-            end
-
-            opts.on("-v", "--verbose", "Verbosely print all commands and their output") do |verbose|
-                options.verbose = true
-            end
-
-            opts.on("-g", "--generate", "Generate the base UberDocMe template file in the current directory") do |gen|
-                options.generate = true
-            end
-
-        end # OptionParser
-
-        parser.parse!(args)
-
-        return options
-
-    end # parse
-
-end # UberdocOptions
-
-#
-#  Exectues the given command and optionally dumps the command and its output
-#
-def execute_command(command, verbose)
-    stdin, stdout, stderr, wait_thr = Open3.popen3(command)
-
-    res = stdout.read
-
-    if verbose
-        puts ">>>>>>>>>>>>>>>>>>>>>>>>>"
-        puts "Command '#{command}'"
-        puts res
-        puts "<<<<<<<<<<<<<<<<<<<<<<<<<"
-    end
-    
-    stdin.close
-    stdout.close
-    stderr.close
-
-    return res
-end
-
-#
-#  Returns the absolute path of a template
-#
-def template_file_path(file)
-    File.absolute_path("#{File.dirname(File.dirname(__FILE__))}/templates/#{file}") 
-end
-
-DOC_PREF_FILE_NAME = "UberDocMe"
-DOC_OUTPUT_DIR = "Docs"
-DOXYGEN_BIN = "doxygen"
-DOXYGEN_REDIRECT_KEY = "OUTPUT_DIRECTORY"
-BASE_UBERDOCME = template_file_path("UberDocMe.Base")
-BASE_DOXYFILE = template_file_path("Doxyfile.Base")
-
-#
-#  Generates Doxyfile variants from the template create the docset or HTML doc
-#  FIXME: This needs a little DRYing and OOing up
-#
-def generate_project(docfile, verbose)
-    project_name = File.basename(File.dirname(docfile))
-    project_dir = File.dirname(docfile)
-
-    puts "~~~~~~~~~~~~~~~~~~~~~"
-    puts "Found #{project_name}"
-
-    absolute_out_dir = File.join(File.absolute_path(DOC_OUTPUT_DIR), project_name)
-    FileUtils.mkdir_p absolute_out_dir
-    
-    # Generate the composite Doxyfile
-    
-    base_doxyfile = File.open(BASE_DOXYFILE, 'rb') { |file| file.read }
-    doxyfile_addition = File.open(docfile, 'rb') { |file| file.read }
-    
-    composite_doxyfile_contents = base_doxyfile + doxyfile_addition + "\n#{DOXYGEN_REDIRECT_KEY} = #{absolute_out_dir}\n"
-    composite_doxyfile_path = File.join(absolute_out_dir, "Doxyfile")
-    
-    File.open(composite_doxyfile_path, 'w') {|f| f.write(composite_doxyfile_contents) }
-
-    puts "Generating docset for #{project_name}"
-
-    # Change into the directory and invoke doxygen
-    FileUtils.cd(project_dir) do
-        execute_command("#{DOXYGEN_BIN} #{composite_doxyfile_path}", verbose)
-    end
-    
-    # Change into the HTML directory and make the docset
-    html_output_directory = File.join(absolute_out_dir, "html")
-
-    FileUtils.cd(html_output_directory) do
-        execute_command("make", verbose)
-    end
-
-    # 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)
-    
-    Dir["#{html_output_directory}/**/*.docset"].each do |docset|
-        FileUtils.mv(docset, docset_directory)
-    end
-
-    # Generate the docset again but this time with treeview
-
-    composite_doxyfile_contents += "\nGENERATE_TREEVIEW = YES\n"
-    File.open(composite_doxyfile_path, 'w') {|f| f.write(composite_doxyfile_contents) }
-
-    puts "Generating HTML Documentation for #{project_name}"
-
-    # Change again into the directory and invoke doxygen
-    FileUtils.cd(project_dir) do
-        execute_command("#{DOXYGEN_BIN} #{composite_doxyfile_path}", verbose)
-    end
-
-end # generate_project
-
-#
-#  Generates documentation for a single directory
-#
-def generate_documentation(directory, verbose)
-    puts "Generating Documentation for '#{directory}'"
-
-    FileUtils.rm_rf DOC_OUTPUT_DIR
-    FileUtils.mkdir_p DOC_OUTPUT_DIR
-    
-    Dir["#{directory}/**/#{DOC_PREF_FILE_NAME}"].each do |file|
-        generate_project(file, verbose)
-    end
-end # generate_documentation
-
-#
-#  Generate the base UberDocMe in the current directory
-#
-def generate_base_manifest(verbose)
-
-    file_path = File.join(Dir.pwd, "UberDocMe")
-
-    if File.exists?(file_path)
-        abort "There is already an UberDocMe file in this directory"
-        return
-    end
-
-    base_uberdocme = File.open(BASE_UBERDOCME, 'rb') { |file| file.read }
-    File.open(file_path, 'w') {|f| f.write(base_uberdocme) }
-end
-
-options = UberdocOptions.parse(ARGV)
-
-if options.generate
-    generate_base_manifest(options.verbose)
-end
-
-options.source_directories.each do |dir|
-    file = File.absolute_path(dir)
-    
-    if File.exists?(file) and File.directory?(file)
-        generate_documentation(file, options.verbose)
-    else
-        abort "#{dir} is not a directory. Skipping..."
-    end
-end
+UberDoc.find_and_perform_tasks(UberDoc::Options::parse(ARGV))

data/lib/uberdoc.rb

@@ -0,0 +1,4 @@
+
+require 'uberdoc/options'
+require 'uberdoc/task'
+require 'uberdoc/utils'

data/lib/uberdoc/options.rb

@@ -0,0 +1,55 @@
+
+require 'optparse'
+require 'optparse/time'
+require 'ostruct'
+
+module UberDoc
+
+    module Options
+
+        def self.parse(args)
+            
+            options = OpenStruct.new
+            
+            options.source_directories = []
+            options.verbose = false
+            options.generate = false
+            options.doctor = false
+
+            parser = OptionParser.new do |opts|
+
+                opts.banner = "Usage: uberdoc [options]"
+                opts.separator ""
+                opts.separator "Available Options:"
+                
+                opts.on("-d", "--directory DIRECTORY",
+                        "Looks for all UberDocMe files in the specified directory")  do |dir|
+                    options.source_directories << dir
+                end
+
+                opts.on("-v", "--verbose",
+                        "Verbosely print all commands and their output") do |verbose|
+                    options.verbose = true
+                end
+
+                opts.on("-g", "--generate",
+                        "Generate the base UberDocMe template file in the current directory") do |gen|
+                    options.generate = true
+                end
+
+                opts.on("--doctor",
+                        "Diagnoses the system to find missing dependencies") do |doc|
+                    options.doctor = true
+                end
+
+            end # OptionParser
+
+            parser.parse!(args)
+
+            return options
+
+        end # parse
+
+    end # Options
+
+end # UberDoc

data/lib/uberdoc/task.rb

@@ -0,0 +1,66 @@
+
+require 'uberdoc'
+
+module UberDoc
+    
+    class Task
+
+        def initialize(options)
+            @options = options
+        end
+
+        #
+        #  Indicates if this task needs to run based on the options
+        #
+        def self.should_run?(options)
+            true
+        end
+
+        #
+        #  Performs the task
+        #
+        def perform
+            puts "Subclass Responsibility"
+        end # perform
+
+        def self.known_tasks
+            ObjectSpace.each_object(Class).select { |klass| klass < self }
+        end
+
+    end # Task
+
+    #
+    #  Returns a list of all known tasks
+    #
+    def self.find_all_tasks
+
+
+        $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'tasks'))
+        Dir["#{File.dirname(__FILE__)}/tasks/**/*_task.rb"].each do |task|
+            require task
+        end
+        
+        Task.known_tasks
+
+    end # find_all_tasks
+
+    #
+    #  Performs the specified tasks
+    #
+    def self.perform_tasks(tasks, options)
+        tasks.each do |task|
+            if task.should_run?(options)
+                new_task = task.new(options)
+                new_task.perform
+            end
+        end
+    end # perform_tasks
+
+    #
+    #  Finds all appropriate tasks and performs them if necessary
+    #
+    def self.find_and_perform_tasks(options)
+        self.perform_tasks(self.find_all_tasks, options)
+    end
+
+end # UberDoc

data/lib/uberdoc/tasks/doctor_task.rb

@@ -0,0 +1,33 @@
+
+require 'uberdoc'
+
+module UberDoc
+    
+    class DoctorTask < Task
+
+        def self.should_run?(options)
+            options.doctor
+        end
+
+        def check_doxygen
+            
+            out = UberDoc::Util::execute_command("which doxygen", @options.verbose)
+
+            if not out.match("doxygen")
+                puts "doxygen - Could not find doxygen on your system. Install it using your package manager or from doxygen.org"
+            end
+        end
+
+        def perform
+            
+            check_doxygen
+
+            # Add mode here
+
+            puts "All checks performed"
+            
+        end # perform
+
+    end # DoctorTask
+
+end # UberDoc

data/lib/uberdoc/tasks/doxygen_task.rb

@@ -0,0 +1,98 @@
+
+require 'uberdoc'
+
+module UberDoc
+    class DoxygenTask < Task
+        
+        def self.should_run?(options)
+            options.source_directories.count > 0
+        end
+
+        DOC_PREF_FILE_NAME = "UberDocMe"
+        DOC_OUTPUT_DIR = "Docs"
+        DOXYGEN_BIN = "doxygen"
+        DOXYGEN_REDIRECT_KEY = "OUTPUT_DIRECTORY"
+        BASE_DOXYFILE = UberDoc::Util::template_file_path("Doxyfile.Base")
+
+        #
+        #  Generates Doxyfile variants from the template create the docset or HTML doc
+        #
+        def generate_project(docfile)
+            project_name = File.basename(File.dirname(docfile))
+            project_dir = File.dirname(docfile)
+
+            puts "Found #{project_name}"
+
+            absolute_out_dir = File.join(File.absolute_path(DOC_OUTPUT_DIR), project_name)
+            FileUtils.mkdir_p absolute_out_dir
+
+            # Generate the composite Doxyfile
+
+            base_doxyfile = File.open(BASE_DOXYFILE, 'rb') { |file| file.read }
+            doxyfile_addition = File.open(docfile, 'rb') { |file| file.read }
+
+            composite_doxyfile_contents = base_doxyfile + doxyfile_addition + "\n#{DOXYGEN_REDIRECT_KEY} = #{absolute_out_dir}\n"
+            composite_doxyfile_path = File.join(absolute_out_dir, "Doxyfile")
+
+            File.open(composite_doxyfile_path, 'w') {|f| f.write(composite_doxyfile_contents) }
+
+            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 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
+
+            # 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)
+
+            Dir["#{html_output_directory}/**/*.docset"].each do |docset|
+                FileUtils.mv(docset, docset_directory)
+            end
+
+            # Generate the docset again but this time with treeview
+
+            composite_doxyfile_contents += "\nGENERATE_TREEVIEW = YES\n"
+            File.open(composite_doxyfile_path, 'w') {|f| f.write(composite_doxyfile_contents) }
+
+            puts "Generating HTML Documentation for #{project_name}"
+
+            # Change again into the directory and invoke doxygen
+            FileUtils.cd(project_dir) do
+                UberDoc::Util::execute_command("#{DOXYGEN_BIN} #{composite_doxyfile_path}", @options.verbose)
+            end
+
+        end # generate_project
+
+        #
+        #  Generates documentation for a single directory
+        #
+        def generate_documentation(directory)
+            puts "Generating Documentation for '#{directory}'"
+
+            FileUtils.rm_rf DOC_OUTPUT_DIR
+            FileUtils.mkdir_p DOC_OUTPUT_DIR
+
+            Dir["#{directory}/**/#{DOC_PREF_FILE_NAME}"].each do |file|
+                generate_project(file)
+            end
+        end # generate_documentation
+
+        def perform
+            @options.source_directories.each do |dir|
+                generate_documentation(dir)
+            end
+        end
+
+    end # DoxygenTask
+
+end # UberDoc

data/lib/uberdoc/tasks/generate_task.rb

@@ -0,0 +1,29 @@
+
+require 'uberdoc'
+
+module UberDoc
+    class Generate < Task
+
+        def self.should_run?(options)
+            options.generate
+        end # should_run?
+
+        def perform
+
+            # Check if there already a doc file in this directory
+            file_path = File.join(Dir.pwd, "UberDocMe")
+
+            if File.exists?(file_path)
+                puts "There is already an UberDocMe file in this directory"
+                return
+            end
+
+            # Write the template file
+            base_uberdocme = File.open(UberDoc::Util::template_file_path('UberDocMe.Base'), 'rb') { |file| file.read }
+            File.open(file_path, 'w') {|f| f.write(base_uberdocme) }
+
+        end # perform
+
+    end # Generate
+
+end # UberDoc

data/lib/uberdoc/utils.rb

@@ -0,0 +1,35 @@
+
+require 'open3'
+require 'fileutils'
+require 'pp'
+
+module UberDoc
+    module Util
+        def self.template_file_path(file)
+            File.absolute_path("#{File.dirname(File.dirname(File.dirname(__FILE__)))}/templates/#{file}") 
+        end
+
+        #
+        #  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 "<<<<<<<<<<<<<<<<<<<<<<<<<"
+            end
+
+            stdin.close
+            stdout.close
+            stderr.close
+
+            return res
+        end
+    end
+
+end

data/uberdoc.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: uberdoc 0.2.0 ruby lib
+# stub: uberdoc 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "uberdoc"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Chinmay Garde"]
-  s.date = "2015-02-17"
+  s.date = "2015-02-18"
   s.description = "UberDoc Documentation Generator"
   s.email = "chinmay@apportable.com"
   s.executables = ["uberdoc"]
@@ -29,6 +29,12 @@ Gem::Specification.new do |s|
     "VERSION",
     "bin/uberdoc",
     "lib/uberdoc.rb",
+    "lib/uberdoc/options.rb",
+    "lib/uberdoc/task.rb",
+    "lib/uberdoc/tasks/doctor_task.rb",
+    "lib/uberdoc/tasks/doxygen_task.rb",
+    "lib/uberdoc/tasks/generate_task.rb",
+    "lib/uberdoc/utils.rb",
     "templates/Doxyfile.Base",
     "templates/UberDocMe.Base",
     "test/helper.rb",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uberdoc
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chinmay Garde
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-17 00:00:00.000000000 Z
+date: 2015-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -98,6 +98,12 @@ files:
 - VERSION
 - bin/uberdoc
 - lib/uberdoc.rb
+- lib/uberdoc/options.rb
+- lib/uberdoc/task.rb
+- lib/uberdoc/tasks/doctor_task.rb
+- lib/uberdoc/tasks/doxygen_task.rb
+- lib/uberdoc/tasks/generate_task.rb
+- lib/uberdoc/utils.rb
 - templates/Doxyfile.Base
 - templates/UberDocMe.Base
 - test/helper.rb