docme 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8092d5b797a25febaea7f8a5fefceb7d1abcdd6
+  data.tar.gz: de1f4530c2d36f17ae757ba8b41bc17cb51abdbc
+SHA512:
+  metadata.gz: f05590f2bca35a3b51268f7575639d06495e4dff166acc60855f63e5c03595325a66ea4208056ae9c4fe3be0e09b2500d5c13c33acf3d7b9afce8acc128205b0
+  data.tar.gz: 0e67d56038efee0c763e0616afc47b91ed9b63db7b33c8b61ef4d62bc15d0f098da37a21b8c0cb806c76acc59fe3ce3eda8a071d1f68bc220eb7cab22452563b

data/bin/docme

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'docme'
+puts Docme.jsParse(ARGV[0])

data/lib/docme.rb

@@ -0,0 +1,139 @@
+# docme
+
+require 'docme/utils'
+
+class Docme
+
+    def self.jsParse(file)
+        #file = ARGV[0]
+
+
+        #raise exception if no file provided, file does not exsist, the file is not readable, or the file has no content
+        if file== nil || !File.file?(file) || !File.exists?(file)
+            raise "Please provide a path to the file you wish to docme."
+        end
+
+        puts "\n  ***Begining docme magix***"
+
+        #create the directory where the site will be stored
+        if !File::directory?("docme_site")
+            puts "+Setting up docme's living arrangements."
+            Dir.mkdir("docme_site")
+        end
+
+        puts "Woohoo! docme has a home!"
+
+        #GLOBALS
+        sourceFile = File.open(file).read
+        docmeDir = "docme"
+        block_flag = 0
+        code_flag = 0
+
+        sourceFile.each_line do |line|
+            #strip leading whitespaces
+            line = line.lstrip
+
+            #if this is the begining of a comment block then start a new function doc
+            if line.rindex("/*", 1) == 0
+                #logic to add a new function section to the erb file
+                next
+            end
+
+            #if this is the end of a comment block then there is nothing to do
+            if line.rindex("*/", 1) == 0
+                #end the function section of the erb file
+                next
+            end
+
+            #if line begins with '+' then we are defining an attribute
+            if line.rindex("+",0) == 0
+                parts = line.split(":")
+
+                #parts[0] == the attribute name
+                attribute = cleanAttribute(parts[0])
+                #add the attribute to the doc
+
+                content = parts[1].lstrip
+
+                #if the content begins with '{' then we have a block
+                if content.rindex("{",0) == 0
+                    #go to the next line and look for '-', set block flag
+                    #add the attribute to the doc
+                    puts attribute
+                    block_flag = 1
+                    next
+                end
+
+                #add content to the doc
+                puts attribute
+                puts content
+            end
+
+            #if line begins with a '-' then we are in a block
+            if line.rindex("-",0) == 0
+                parts = line.split(":")
+
+                #parts[0] == the attribute name
+                attribute = cleanAttribute(parts[0])
+                #add the attribute to the doc
+
+                 content = parts[1].lstrip
+
+                if attribute == "var"
+                    # look for arrow
+                    content_parts = content.split("->")
+                    var_name = content_parts[0]
+                    var_description = content_parts[1].lstrip
+
+                    #put the var_name in the doc
+                    #put the var_description in the doc
+                    puts var_name
+                    puts var_description
+                    next
+                end
+
+                if attribute == "code"
+                    code_flag = 1
+                    #go ahead and skip to next line and process code
+                    next
+                end
+
+                #if !var and !code, then process as regular attributes
+                #put the attribute name
+                #put the content
+                puts attribute
+                puts content
+                next
+            end
+
+            #if code flag is set and we reached the end of a block, then we reached the end of a code block, unset the flag
+            if code_flag == 1 && line.rindex("}",0) == 0
+                code_flag = 0
+                next
+            end
+
+            #if the block flag is set and we reach the end of a block, then we reached the end of a regular block, unset flag
+            if block_flag == 1 && line.rindex("}",0) == 0
+                block_flag = 0
+            end
+
+            #if we are in a code block, then return lines as is
+            if code_flag == 1
+                puts line
+                next
+            end
+
+
+        end
+
+        def render()
+            ERB.new(@template).result(binding)
+        end
+
+        def save(site)
+            FIle.open(site, "w+") do |f|
+                f.write(render)
+            end
+        end
+    end
+end

data/lib/docme/utils.rb

@@ -0,0 +1,8 @@
+#docem utils
+
+def cleanAttribute(attr)
+    attr = attr.delete("+[")
+    attr = attr.delete("]")
+    attr = attr.delete("-")
+    return attr
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: docme
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Bailey Belvis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-27 00:00:00.000000000 Z
+dependencies: []
+description: A gem to support easy documentation for javascript files.
+email: baileyb622@gmail.com
+executables:
+- docme
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/docme
+- lib/docme.rb
+- lib/docme/utils.rb
+homepage: https://github.com/philosowaffle/docme
+licenses:
+- Mozilla Public License
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: A documentation site generator.
+test_files: []