docme 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 535988f3869af86e1142e545be0593b3cbff4ac8
-  data.tar.gz: 91b8568aeb7aa035f238fb9f07e1e9c062f8cdb6
+  metadata.gz: 0d33d597f12ed9d841234cedd2ce1c36a7a7c1eb
+  data.tar.gz: f70136bd3a009b72107a70b3c23ae4969e9ae2ec
 SHA512:
-  metadata.gz: d4a8643fc461feb294b83c5cbf7111742e9aaa12772571f6c9eb33432ca87c42b37115c60cb47fb105435767029eadabc52e65aa7dc2f828ce5504681773418f
-  data.tar.gz: 80387085cc592d87dcc8b3e93a0c9c3c9974ef969056d7247df55471bf9e140f2421990673b09132b3f758af56863b8216634f4cbf029488c8bf98a1e7b90fd1
+  metadata.gz: ebd174751b8cf1847a44ec123572dbba5d7832a1370b1fea5c52378bbfc03b01823e4b67a0e23cb4f584e3568225890e5c411d23c56857a4f1e9989e0d7e7920
+  data.tar.gz: 0324861098261957dd3580682757ae0a38c61856aace13c56192f3a31df825ab16aae857da2fcd5461e20767bc2aff901e014f3792f36b151a00afa65b0a8373

data/lib/docme.rb

@@ -4,6 +4,7 @@
 require 'docme/utils'
 require 'erb'
 require 'fileutils'
+require 'rainbow/ext/string'
 
 class Docme
 
@@ -15,7 +16,7 @@ class Docme
         @index = index
         @page_erb = page_erb
 
-        puts '+ docme will parse: ' + @path if @is_verbose
+        puts '+ docme will parse: '.color(:cyan) + @path if @is_verbose
 
         make_home
     end
@@ -33,7 +34,7 @@ class Docme
         if Dir.exist?('docme_site')
             clean_directory('docme_site', @is_verbose)
         else
-            puts "+ Setting up docme's living arrangements." if @is_verbose
+            puts "+ Setting up docme's living arrangements.".color(:cyan) if @is_verbose
             Dir.mkdir('docme_site')
             puts ' - Woohoo! docme has a home!' if @is_verbose
         end
@@ -41,7 +42,7 @@ class Docme
 
     def scan_docs
 
-        puts '+ docme scanning: ' + @path if @is_verbose
+        puts '+ docme scanning: '.color(:cyan) + @path if @is_verbose
 
         # if a directory was provided
         if File.directory?(@path)
@@ -56,7 +57,7 @@ class Docme
     end
 
     def render_docs
-        puts '+ docme generated the following pages: ' if @is_verbose
+        puts '+ docme generated the following pages: '.color(:cyan) if @is_verbose
         @pages.each do |page_object|
             page_object.render_site(@pages, @page_erb)
             puts ' - ' + page_object.name if @is_verbose
@@ -65,7 +66,7 @@ class Docme
 
     def render_index
 
-        puts '+ docme is creating the index' if @is_verbose
+        puts '+ docme is creating the index'.color(:cyan) if @is_verbose
 
         if @index.nil?
             template = File.read(File.join(File.dirname(__FILE__), 'templates/index.erb'))
@@ -82,11 +83,11 @@ class Docme
         # add page to docme dir
         FileUtils.mv('site_index.html', 'docme_site/site_index.html')
 
-        puts '+ index created' if @is_verbose
+        puts '+ index created'.color(:cyan) if @is_verbose
     end
 
     def render_css
-        puts '+ docme is styling' if @is_verbose
+        puts '+ docme is styling'.color(:cyan) if @is_verbose
 
         if @style.nil?
             template = File.read(File.join(File.dirname(__FILE__), 'templates/style.erb'))
@@ -103,7 +104,7 @@ class Docme
         # add page to docme dir
         FileUtils.mv('style.css', 'docme_site/style.css')
 
-        puts '+ styling completed' if @is_verbose
+        puts '+ styling completed'.color(:cyan) if @is_verbose
 
     end
 

data/lib/docme/DocmeCLI.rb

@@ -5,44 +5,45 @@ require 'docme'
 require 'docme/utils'
 require 'fileutils'
 require 'thor'
+require 'rainbow/ext/string'
 
 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.'
+    desc 'default', 'docme'.color(:blue) + ' : 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***"
+        puts "\n  ***Begining docme magix***".color(:green)
 
         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 site_index.html\n\n"
+        puts "\n  ***Finished docme magic!***".color(:green)
+        puts "\n  You can find your docs inside the `docme_site` folder. \n   Hint: look for site_index.html\n\n".color(:green)
 
     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.'
+    desc 'clean', 'docme clean <path>'.color(:blue) + ' : 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')
+        fail 'Please provide a valid path to a directory that contains a `docme_site` folder.'.color(:red) unless Dir.exist?(path + '/docme_site')
 
-        puts '+ docme will clean ' + path if options[:v]
-        puts '+ docme cleaning' if options[:v]
+        puts '+ docme will clean '.color(:cyan) + path if options[:v]
+        puts '+ docme cleaning'.color(:cyan) 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]
+        puts '+ docme_site removed'.color(:cyan) if options[:v]
+        puts '+ docme is now homeless'.color(:cyan) 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.'
+    desc 'parse', 'docme parse <path>'.color(:blue) + ' -- 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
 
@@ -61,13 +62,13 @@ class DocmeCLI < Thor
     option :page, type: :string
     def parse(path)
 
-        puts "\n  ***Begining docme magix***"
+        puts "\n  ***Begining docme magix***".color(:green)
 
         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"
+        puts "\n  ***Finished docme magic!***".color(:green)
+        puts "\n  You can find your docs inside the `docme_site` folder. \n   Hint: look for index.html\n\n".color(:green)
 
     end
 

data/lib/docme/block.rb

@@ -94,7 +94,6 @@ class Block
                 block_content = {}
                 next
             end
-
         end
 
         @is_empty = @attributes.empty?

data/lib/docme/page.rb

@@ -19,14 +19,14 @@ class Page
         @name = clean_filename(file)
         @source_file = File.open(file).read
         @page_erb = '../templates/page.erb'
-        @blocks  = []
+        @blocks = []
         @is_empty = true
     end
 
     def parse_blocks
         block = []
 
-        @source_file.each_line  do |line|
+        @source_file.each_line do |line|
             strip_line = line.lstrip
 
             # if this is the begining of a comment block then start a new function doc

data/lib/docme/rake_task.rb

@@ -62,5 +62,4 @@ module DocmeTask
         end
 
     end
-
 end

data/lib/docme/utils.rb

@@ -57,8 +57,7 @@ def parse_directory(path, is_verbose = nil)
 
     # for each file in the sub directory
     Dir.foreach(path) do |f|
-
-        next if f == '.' || f == '..' || f.rindex('.', 0) || unsupported_encoding(f) ||  unsupported_extension(f)
+        next if f == '.' || f == '..' || f.rindex('.', 0) || unsupported_encoding(f) || unsupported_extension(f)
 
         # if another directory then go inside
         if File.directory?(path + '/' + f)
@@ -80,26 +79,23 @@ def parse_directory(path, is_verbose = nil)
 end
 
 def parse_file(file, is_verbose = nil)
+    return unless File.file?(file)
+    return unless File.exist?(file)
+    return if file.rindex('.', 0)
+    return if unsupported_encoding(file)
+    return if unsupported_extension(file)
 
-    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
+    puts ' - docme parsing page: ' + file if is_verbose
 
-        page
-
-    else
-        nil
-    end
+    page = Page.new(file)
+    page.parse_blocks
+    page
 
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docme
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Bailey Belvis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-25 00:00:00.000000000 Z
+date: 2015-08-29 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
@@ -40,17 +40,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A documentation site generator.