docme 1.1.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83eee48aa7acdbaf189f9df3b5c78df89a543d88
-  data.tar.gz: cd2c845d5fb70b9f6c28600764bfdea5c106053f
+  metadata.gz: a1404bb774b46f9954b5f775667b7ceb30eec584
+  data.tar.gz: ed1fa0f5a8c31d2e3686477dc8b8fa0290feb652
 SHA512:
-  metadata.gz: 98f6b0d9b6048296ef03bc810c8d015b37ef24fe5ae9703129ac97be2c8fc53480287d6a80b330200fcd027be6ee281046b8be00ae95dd4f70f668072e2ea046
-  data.tar.gz: 76fad443ec0745288ba63843d573f3e1932e087fa7a9cd94d1209a7ba7c32070e54c9c69a59cc058cbf34663ef5424afb1eca1e45305317eeb4807bd0f3730e1
+  metadata.gz: 069ab9e0ff1480b64c98f90190538fbfaceed1839c9a742414663b951f1113ac7d536bf39d20802e7705b35fcc00a1628195db08d6813027eb68d03956bfa78b
+  data.tar.gz: 7000581d1e03954e0d398964513f3ef758debb0d819baf91b1b4027c728394dabd7752d44426d50ad861e9447336ec8eef00da95b0b73221152ac10bbed370c2

data/bin/docme

@@ -1,23 +1,7 @@
 #!/usr/bin/env ruby
 # encoding: UTF-8
 
-require 'docme'
-require 'docme/utils'
-require 'fileutils'
+require 'docme/DocmeCLI'
+require 'thor'
 
-if ARGV[0].nil?
-    path = Dir.pwd
-    puts path
-else
-    path = ARGV[0]
-end
-
-puts "\n  ***Begining docme magix***"
-
-docmeer = Docme.new(path)
-docmeer.scan_docs
-docmeer.render_docs
-docmeer.render_index
-
-puts "\n  ***Finished docme magic!***"
-puts "\n  You can find your docs inside the `docme_site` folder. \n   Hint: look for index.html\n\n"
+DocmeCLI.start(ARGV)

data/lib/docme.rb

@@ -7,45 +7,71 @@ require 'fileutils'
 
 class Docme
 
-    def initialize(path)
+    def initialize(path, is_verbose = nil, style = nil, index = nil, page_erb = nil)
         @path = path
         @pages = []
+        @is_verbose = is_verbose
+        @style = style
+        @index = index
+        @page_erb = page_erb
 
+        puts '+ docme will parse: ' + @path if @is_verbose
+
+        make_home
+    end
+
+    def engage
         make_home
+        scan_docs
+        render_docs
+        render_index
+        render_css
     end
 
     def make_home
         # create the directory where the site will be stored
-        return true if File.directory?('docme_site')
-        puts "+ Setting up docme's living arrangements."
-        Dir.mkdir('docme_site')
-        puts ' - Woohoo! docme has a home!'
+        if Dir.exist?('docme_site')
+            clean_directory('docme_site', @is_verbose)
+        else
+            puts "+ Setting up docme's living arrangements." if @is_verbose
+            Dir.mkdir('docme_site')
+            puts ' - Woohoo! docme has a home!' if @is_verbose
+        end
     end
 
     def scan_docs
+
+        puts '+ docme scanning: ' + @path if @is_verbose
+
         # if a directory was provided
         if File.directory?(@path)
 
-            @pages.concat parse_directory(@path)
+            @pages.concat parse_directory(@path, @is_verbose)
 
         else # if a single file was provided
 
-            @pages.push(parse_file(@path))
+            @pages.push(parse_file(@path, @is_verbose))
 
         end
     end
 
     def render_docs
-        puts '+ docme generated the following pages: '
+        puts '+ docme generated the following pages: ' if @is_verbose
         @pages.each do |page_object|
-            page_object.render_site(@pages)
-            puts ' - ' + page_object.name
+            page_object.render_site(@pages, @page_erb)
+            puts ' - ' + page_object.name if @is_verbose
         end
     end
 
     def render_index
 
-        template = File.read(File.join(File.dirname(__FILE__), 'templates/index.erb'))
+        puts '+ docme is creating the index' if @is_verbose
+
+        if @index.nil?
+            template = File.read(File.join(File.dirname(__FILE__), 'templates/index.erb'))
+        else
+            template = File.read(File.join(Dir.pwd, @index))
+        end
 
         renderer = ERB.new(template)
 
@@ -55,6 +81,30 @@ class Docme
 
         # add page to docme dir
         FileUtils.mv('index.html', 'docme_site/index.html')
+
+        puts '+ index created' if @is_verbose
+    end
+
+    def render_css
+        puts '+ docme is styling' if @is_verbose
+
+        if @style.nil?
+            template = File.read(File.join(File.dirname(__FILE__), 'templates/style.erb'))
+        else
+            template = File.read(File.join(Dir.pwd, @style))
+        end
+
+        renderer = ERB.new(template)
+
+        File.open('style.css', 'w+') do |f|
+            f.write(renderer.result(binding))
+        end
+
+        # add page to docme dir
+        FileUtils.mv('style.css', 'docme_site/style.css')
+
+        puts '+ styling completed' if @is_verbose
+
     end
 
 end

data/lib/docme/DocmeCLI.rb

@@ -0,0 +1,76 @@
+# encoding: UTF-8
+# Class DocmeCLI
+
+require 'docme'
+require 'docme/utils'
+require 'fileutils'
+require 'thor'
+
+class DocmeCLI < Thor
+    class_option :v, type: :boolean
+
+    desc 'default', '`docme` When no commands are provided docme will begin the current directory and parse through all eligible folders and files.'
+    option :style, type: :string
+    option :index, type: :string
+    option :page, type: :string
+    def default
+        path = Dir.pwd
+        puts "\n  ***Begining docme magix***"
+
+        docmeer = Docme.new(path, options[:v], options[:style], options[:index], options[:page])
+        docmeer.engage
+
+        puts "\n  ***Finished docme magic!***"
+        puts "\n  You can find your docs inside the `docme_site` folder. \n   Hint: look for index.html\n\n"
+
+    end
+
+    desc 'clean', '`docme clean <path>` Attemtps to empty and remove the docme_site directory.  Path is optional and should point to a directory containing a `docme_site` folder. If an error is returned then you will have to delete the folder manually.'
+    def clean(path = nil)
+        path = Dir.pwd if path.nil?
+
+        fail 'Please provide a valid path to a directory that contains a `docme_site` folder.' unless Dir.exist?(path + '/docme_site')
+
+        puts '+ docme will clean ' + path if options[:v]
+        puts '+ docme cleaning' if options[:v]
+
+        clean_directory(path + '/docme_site', options[:v])
+        Dir.rmdir(path + '/docme_site') if Dir.exist?(path + '/docme_site')
+
+        puts '+ docme_site removed' if options[:v]
+        puts '+ docme is now homeless' if options[:v]
+
+    end
+
+    desc 'parse', '`docme parse <path>` -- Either provide a path to a file or a path to a directory and docme will parse all valid files found.'
+    long_desc <<-LONGDESC
+    `docme parse <path/to/file>` will parse a single file specified
+
+    `docme parse <path/to/folder>` will parse all eligible files in the specified directory
+
+    `docme parse <path/to/folder> --style <path/to/css.erb>` will use your own custom styling options.  This file must contain valid css and be saved as `.erb` file.
+
+    `docme parse <path/to/folder> --index <path/to/index.erb>` will use your own custom html to build the index page of the site.
+
+    `docme parse <path/to/folder> --page <path/to/yourPage.erb>` will use your own custom html to build the pages of the site.
+
+    Use the `-v` flag on any command to recieve verbose output.
+    LONGDESC
+    option :style, type: :string
+    option :index, type: :string
+    option :page, type: :string
+    def parse(path)
+
+        puts "\n  ***Begining docme magix***"
+
+        docmeer = Docme.new(path, options[:v], options[:style], options[:index], options[:page])
+        docmeer.engage
+
+        puts "\n  ***Finished docme magic!***"
+        puts "\n  You can find your docs inside the `docme_site` folder. \n   Hint: look for index.html\n\n"
+
+    end
+
+    default_task :default
+
+end

data/lib/docme/block.rb

@@ -31,7 +31,12 @@ class Block
             if strip_line.rindex('+', 0) == 0
 
                 is_docme = 1
-                parts = strip_line.split(':')
+                parts = strip_line.split(':', 2)
+
+                if parts[0].nil? || parts[1].nil?
+                    is_docme = 0
+                    next
+                end
 
                 # parts[0] == the attribute name
                 attribute = clean_attribute(parts[0])

data/lib/docme/page.rb

@@ -18,6 +18,7 @@ class Page
     def initialize(file)
         @name = clean_filename(file)
         @source_file = File.open(file).read
+        @page_erb = '../templates/page.erb'
         @blocks  = []
         @is_empty = true
     end
@@ -46,16 +47,18 @@ class Page
         @is_empty = @blocks.empty?
     end
 
-    def render_site(index)
+    def render_site(index, page_erb = nil)
         @index = []
 
         index.each do |page|
             @index.push(page.name)
         end
 
-        # puts content
-        renderer = ERB.new(File.read(File.join(File.dirname(__FILE__), '../templates/page.erb'))
-)
+        if page_erb.nil?
+            renderer = ERB.new(File.read(File.join(File.dirname(__FILE__), @page_erb)))
+        else
+            renderer = ERB.new(File.read(File.join(Dir.pwd, page_erb)))
+        end
 
         page = @name + '.html'
 

data/lib/docme/rake_task.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+require 'rake'
+require 'rake/tasklib'
+require 'docme/DocmeCLI'
+
+module DocmeTask
+    #  Provides a custom rake task.
+    #
+    # require 'docme/rake-task'
+    # Docme::RakeTask.new
+    class RakeTask < ::Rake::TaskLib
+
+        attr_accessor :name
+        attr_accessor :parse
+        attr_accessor :index
+        attr_accessor :page
+        attr_accessor :style
+        attr_accessor :verbose
+
+        def initialize(*args, &task_block)
+            @name = args.shift || :docme
+            @parse = nil
+            @index = nil
+            @page = nil
+            @style = nil
+            @verbose = nil
+
+            define(args, &task_block)
+
+        end
+
+        def engage_docme
+
+            input = build_input
+
+            DocmeCLI.start(input)
+
+        end
+
+        def build_input
+            temp = []
+
+            temp.push('parse', @parse) unless @parse.nil?
+            temp.push('--index', @index) unless @index.nil?
+            temp.push('--page', @page) unless @page.nil?
+            temp.push('--style', @style) unless @style.nil?
+            temp.push('-v') unless @verbose.nil?
+
+            temp
+        end
+
+        def define(args, &task_block)
+            desc 'Run docme' unless ::Rake.application.last_comment
+
+            task name, *args do |_, task_args|
+                RakeFileUtils.__send__(:verbose, verbose) do
+                    task_block.call(*[self, task_args].slice(0, task_block.arity)) if task_block
+                    engage_docme
+                end
+            end
+        end
+
+    end
+
+end

data/lib/docme/utils.rb

@@ -36,7 +36,7 @@ end
 def unsupported_extension(file)
     parse = true
 
-    unsupported_extensions = ['.gem', '.jar', '.gemspec', '.zip', '.tar', '.gz', '.tar.gz', '.jpeg', '.jpg', '.png', '.exe']
+    unsupported_extensions = ['.gem', '.jar', '.gemspec', '.zip', '.tar', '.gz', '.tar.gz', '.jpeg', '.jpg', '.png', '.exe', '.md', '.lock']
 
     parse = false unless unsupported_extensions.include?(File.extname(file)) || (File.executable?(file) && !Dir.exist?(file)) || (File.executable_real?(file) && !Dir.exist?(file))
 
@@ -51,7 +51,7 @@ def unsupported_encoding(file)
     parse
 end
 
-def parse_directory(path)
+def parse_directory(path, is_verbose = nil)
 
     files_array = []
 
@@ -63,11 +63,13 @@ def parse_directory(path)
         # if another directory then go inside
         if File.directory?(path + '/' + f)
 
+            puts ' - docme parsing path: ' + f if is_verbose
+
             files_array.concat parse_directory(path + '/' + f)
 
         else # else parse normally
 
-            temp_page = parse_file(path + '/' + f)
+            temp_page = parse_file(path + '/' + f, is_verbose)
             files_array.push(temp_page) unless temp_page.nil? || temp_page.is_empty == true
 
         end
@@ -77,10 +79,12 @@ def parse_directory(path)
 
 end
 
-def parse_file(file)
+def parse_file(file, is_verbose = nil)
 
     if File.file?(file) && File.exist?(file) && !file.rindex('.', 0) && !unsupported_encoding(file) && !unsupported_extension(file)
 
+        puts ' - docme parsing page: ' + file if is_verbose
+
         page = Page.new(file)
         page.parse_blocks
 
@@ -91,3 +95,24 @@ def parse_file(file)
     end
 
 end
+
+def clean_directory(path, is_verbose = nil)
+    # for each file in the directory
+    Dir.foreach(path) do |f|
+
+        next if f == '.' || f == '..'
+
+        # if another directory then go inside
+        if File.directory?(path + '/' + f)
+
+            clean_directory(path + '/' + f)
+
+        else # else delete file
+
+            puts ' - docme removing file: ' + f if is_verbose
+
+            File.delete(path + '/' + f)
+
+        end
+    end
+end

data/lib/templates/index.erb

@@ -1,13 +1,7 @@
 <!DOCTYPE html>
 <html>
 
-    <style type="text/css">
-        #wrapper{
-                width: 70%;
-                padding-left: 30%;
-                font-size:2em;
-            }
-    </style>
+    <link href="style.css" rel="stylesheet">
 
     <link href="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css" rel="stylesheet" media="screen">
 

data/lib/templates/page.erb

@@ -4,35 +4,8 @@
     <head>
         <meta name="viewport" content="width=device-width, initial-scale=1">
 
-        <style type="text/css">
-            body{
-            }
-            #panels-wrapper{
-                width: 80%;
-                float: left;
-                padding-left: 10%;
-            }
-            #side-panel{
-            width: 15%;
-            float: left;
-            padding-left: 10px;
-         }
-         pre-scrollable{
-            overflow-x: scroll;
-            white-space: nowrap;
-         }
+        <link href="style.css" rel="stylesheet">
 
-         p.code{
-            border:1px solid #000000;
-            overflow-x:scroll;
-            white-space: pre;
-            font-family:monospace,monospace;
-            font-size:1em;
-            background-color:#f5f5f5;
-            padding:2em;
-        }
-
-        </style>
     </head>
 
     <link href="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css" rel="stylesheet" media="screen">

data/lib/templates/style.erb

@@ -0,0 +1,29 @@
+#wrapper{
+                width: 70%;
+                padding-left: 30%;
+                font-size:2em;
+            }
+#panels-wrapper{
+                width: 80%;
+                float: left;
+                padding-left: 10%;
+            }
+#side-panel{
+            width: 15%;
+            float: left;
+            padding-left: 10px;
+         }
+pre-scrollable{
+            overflow-x: scroll;
+            white-space: nowrap;
+         }
+
+p.code{
+            border:1px solid #000000;
+            overflow-x:scroll;
+            white-space: pre;
+            font-family:monospace,monospace;
+            font-size:1em;
+            background-color:#f5f5f5;
+            padding:2em;
+        }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docme
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Bailey Belvis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-06 00:00:00.000000000 Z
+date: 2014-06-19 00:00:00.000000000 Z
 dependencies: []
 description: A gem to support easy documentation for any file that recognizes `/*
   */` as a code block.  This gem lets you easily parse multiple files in a directory
@@ -22,11 +22,14 @@ extra_rdoc_files: []
 files:
 - bin/docme
 - lib/docme.rb
+- lib/docme/DocmeCLI.rb
 - lib/docme/block.rb
 - lib/docme/page.rb
+- lib/docme/rake_task.rb
 - lib/docme/utils.rb
 - lib/templates/index.erb
 - lib/templates/page.erb
+- lib/templates/style.erb
 homepage: https://github.com/philosowaffle/docme
 licenses:
 - Mozilla Public License