documentize 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f0ac87e2115d413689eb60d6aca2eaad42e1efe
-  data.tar.gz: 458eac724e6f5de5806ff591154e8ee2f290b417
+  metadata.gz: 57965ec4586ab232786be61504d5fd0df5a7e535
+  data.tar.gz: b370f41a42b553ff961b96b1f572e01c8b51b75d
 SHA512:
-  metadata.gz: 8372c263379106c63a2739a1e0532841cb6ef19e75e4290f30c4a4c112c32f7d638407251e8fda00cbcfebdd1fa59d06994e2078f73f500f6369a63142f868c5
-  data.tar.gz: 4978c512666b8ffeb0be77e72096a99331d11bc14056d96f7026d3e790ce5c6d21ab29df0f42746108416b7b7f2d581606990ed2d0b24467af34d554ab19ecab
+  metadata.gz: e5df7647a8775c153dc7380d759135907524cd1fef87873688b7274c81c2c4dc2d664e70b164b9750a98845399dc59a63e089bd4a7bbb8d4cfd9d6fd4ee59190
+  data.tar.gz: a9b4995a2a0b259f7ffcf4ddf08e3053782ab72916dd87c6782ee944fd6fb962d8ec05f5ae4566c705c60a1d4f76f6635e6a848b0c3d7658a857fce6909f27ad

data/exe/documentize

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'documentize'
+
+
+doc = Documentize::Documentize.new(ARGV[0])
+ARGV.clear
+
+doc.run

data/lib/documentize.rb

@@ -1,6 +1,9 @@
 require "documentize/version"
+require "documentize/printer"
+require "documentize/builder"
 require "documentize/collector"
-require "documentize/generator"
+require "documentize/informator"
+
 
 
 module Documentize
@@ -10,12 +13,12 @@ module Documentize
       shbang:      /^#!.*?ruby$/
     }
 
-    attr_reader :collector, :file, :header, :tree
+    attr_reader :collector, :file, :informator, :header, :tree
 
     def initialize(file_name)
       @file = load_file(file_name)
       @collector = Collector.new
-      @generator = Generator.new
+      @informator = Informator.new
     end
 
     def load_file(file_name)
@@ -26,7 +29,9 @@ module Documentize
 
     def run
       @tree, @header = collector.run(@file)
-      # generator.gen_docs(tree)
+      informator.gen_info(tree)
+      informator.clear_screen
+      Printer.print_with_docs(tree)
     end
 
     private

data/lib/documentize/builder.rb

@@ -0,0 +1,64 @@
+module Documentize
+  class Builder
+
+    REGEX = {
+      bad_do_block:  /\sdo.*?end/,
+      do_block:      /\sdo[\s\|.*]/
+    }
+
+    def self.build_docs(branch)
+      doc_str = ""
+      doc_str << "# Public: #{branch[:desc]}\n#\n"
+      if branch[:args]
+        branch[:args].each do |arg|
+          doc_str << "# #{arg[:name]} - #{arg[:type]}: #{arg[:desc]}\n"
+        end
+        doc_str << "# \n"
+      end
+      doc_str
+    end
+
+
+    def self.build_args(args)
+      str = ""
+      str << "("
+      args.each do |arg|
+        str << "#{arg[:name]}"
+        str << " = #{arg[:default]}" if arg[:default]
+        str << ", " unless arg == args[-1]
+      end
+      str << ")"
+    end
+
+    def self.build_code(code, indent = 0)
+      str = ""
+      str << build_docs(code) if code[:doc]
+      str << "  "*indent
+      str << "#{code[:type]} #{code[:name]}"
+      str << build_args(code[:args]) if code[:args]
+      str << "\n\n"
+
+      code[:content].each do |item|
+        if item.is_a?(Hash)
+
+          str << build_code(item, indent+1)
+
+        else
+
+          indent -= 1 if item =~ /end/ && item !~ REGEX[:bad]
+
+          str << "  "*(indent+1) + "#{item} \n"
+          str << "\n" if item =~ /end/ && item !~ REGEX[:bad]
+
+          indent += 1 if item =~ REGEX[:do_block] && item !~ REGEX[:bad]
+
+        end
+      end
+
+      str << "  "*indent
+      str << "end\n"
+      indent -= 1
+      str << "\n"
+    end
+  end
+end

data/lib/documentize/collector.rb

@@ -68,7 +68,9 @@ module Documentize
           items = arg.split("=").map{ |item| item.strip }
           {
             name: items[0],
-            default: items[1]
+            default: items[1],
+            type: nil,
+            test: nil
           }
         end
       end
@@ -83,12 +85,13 @@ module Documentize
           cmd = breakup[1]
         end
         {
-            type: type,
-            name: cmd,
-            args: args,
-            content: [],
-            doc: nil
-          }
+          type: type,
+          name: cmd,
+          desc: nil,
+          doc: nil,
+          args: args,
+          content: [],
+        }
       end
 
       def remove_headers(file)

data/lib/documentize/informator.rb

@@ -0,0 +1,93 @@
+module Documentize
+  class Informator
+
+    
+
+    def clear_screen
+      system("cls") || system("tput reset") || system("clear") || puts("\e[H\e[2J")
+    end
+
+    def branch_info(branch, parent = nil)
+
+      display_branch(branch, parent)
+
+      branch[:desc] = get_desc(branch[:type])
+
+      get_args(branch) if branch[:args]
+
+      branch[:content].each do |item|
+        branch_info(item, [branch[:name], branch[:type]]) if item.is_a?(Hash)
+      end
+
+    end
+
+    def display_branch(branch, parent = nil)
+      clear_screen unless parent
+
+      puts line_break
+
+      print "Describing: #{branch[:name]} #{branch[:type]}"
+      print " of #{parent[0]} #{parent[1]}" if parent
+      puts
+
+      puts line_break
+
+      puts Builder.build_code(branch)
+    end
+
+    def gen_doc(branch)
+      branch[:content].each do |item|
+        gen_doc(item) if item.is_a?(Hash)
+      end
+      branch[:doc] = Builder.build_docs(branch)
+    end
+
+    def gen_info(tree)
+
+      tree.each do |branch|
+        branch_info(branch)
+        gen_doc(branch)
+      end
+
+    end
+
+    def get_args(branch)
+
+      print "#{branch[:type]} #{branch[:name]}"
+      print Builder.build_args(branch[:args])
+      puts
+
+      branch[:args].each do |arg|
+
+        puts "Please enter a brief description of argument: #{arg[:name]}"
+        arg[:desc] = gets.strip
+
+        puts "What input Type should be entered for agument: #{arg[:name]}"
+        arg[:type] = gets.strip
+
+        if arg[:default] == nil
+          puts "Please enter a default 'testing' value for Rspec:"
+          arg[:test] = gets.strip
+        end
+
+      end
+
+      branch[:args]
+    end
+
+    def get_desc(type)
+
+      puts "please enter a description of the above #{type}\n\n"
+      gets.strip
+
+    end
+
+    
+
+    def line_break
+      puts
+      puts "--------------------------------------------------"
+    end
+
+  end
+end

data/lib/documentize/printer.rb

@@ -0,0 +1,9 @@
+module Documentize
+  class Printer
+    def self.print_with_docs(tree)
+      tree.each do |branch|
+        puts Builder.build_code(branch)
+      end
+    end
+  end
+end

data/lib/documentize/version.rb

@@ -1,3 +1,3 @@
 module Documentize
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: documentize
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Sampson Crowley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2016-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,7 +70,8 @@ description: Pass in a cluttered, or just undocumented ruby file and get back a
   file with a TomDoc Skeleton for easy doc writing
 email:
 - sampsonsprojects@gmail.com
-executables: []
+executables:
+- documentize
 extensions: []
 extra_rdoc_files: []
 files:
@@ -85,9 +86,12 @@ files:
 - bin/console
 - bin/setup
 - documentize.gemspec
+- exe/documentize
 - lib/documentize.rb
+- lib/documentize/builder.rb
 - lib/documentize/collector.rb
-- lib/documentize/generator.rb
+- lib/documentize/informator.rb
+- lib/documentize/printer.rb
 - lib/documentize/version.rb
 - tasks/rspec.rake
 homepage: https://github.com/SampsonCrowley/documentize

data/lib/documentize/generator.rb

@@ -1,4 +0,0 @@
-module Documentize
-  class Generator
-  end
-end