phari_doc_gen 2.1.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 002bb604bd3cf81fed17ca3cbde3c7c31fef6ece
-  data.tar.gz: a2ae0188c765f3f41496df7cb5d8e7b0d5b248ff
+  metadata.gz: 06152ff667c5bad361dcb49f7b6b231412085756
+  data.tar.gz: 87836418be3a511c0b5c2ff51c73bf3f2e5070dd
 SHA512:
-  metadata.gz: feb186e59daeb1f237014415117d2122a13b232f22c4bf73c544133ef7c9ea3c179741211e86b44bc4703ac4af727a1ecd645cb133f39ba3179db73fd295e011
-  data.tar.gz: 2c8c355e1e0bedc1c89c927bbd8c5b60f6bdef3d90173daf855b7cd01951ea265146a219e2832baf8f802a2cdff294d7ced0452af98997812e180ddc7aa150bf
+  metadata.gz: 9417a4c37cecc2b2559b28c9eb944288c8cf39932b4f9a928b91375a6d87b4245215bdba0c7a1e187f873c6ca654612caf028a4bc77220d00e1cc46cc7a3c3a4
+  data.tar.gz: bc9d64040b03b4c3a45dc10e8136d912b14615890ca5a9603e06b6818d95f0f6b94dfc1151f63ca24b43ff26659619ff2f628893cc1f9bccd04374b1dbe5257a

data/bin/phari_doc_gen

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
 
 require 'phari_doc_gen'
-docGen = PhariDocGen.new()
-docGen.generate(ARGV[0], ARGV[1])
+PhariDocGen.generate(ARGV[0], ARGV[1])

data/lib/phari_doc_gen.rb

@@ -14,7 +14,7 @@ require_relative 'phari_doc_gen/FileHandler.rb'
 
 class PhariDocGen
   # Generate documentation for standard projects
-  def generate (project, outputPath)
+  def self.generate (project, outputPath)
       generate = FileHandler.new
       # Ask for project name if nil
       if project.nil?

data/lib/phari_doc_gen/FileHandler.rb

@@ -5,8 +5,6 @@
 # Luiz Philippe.
 #--------------------------------------------------------------------------------------------
 
-require 'fileutils'
-require 'active_support/inflector'
 require_relative 'Modelo.rb'
 require_relative 'Rota.rb'
 require_relative 'Metodo.rb'
@@ -44,8 +42,13 @@ class FileHandler
             projectDescription = readProjectDescription(readme)
             readme.close
             projectDescription
+        elsif File.exists?(path + 'readme.md')
+            readme = File.new(path + 'readme.md')
+            projectDescription = readProjectDescription(readme)
+            readme.close
+            projectDescription
         else
-          puts 'Warning: No README.md file found.'
+          puts 'Warning: No readme.md file found.'
         end
     end
 
@@ -232,56 +235,56 @@ class FileHandler
         tipo = ''
         nome = ''
         descricao = ''
-        inputs = []
-        outputs = []
+        inputs = {}
+        outputs = {}
         methods = []
         toSent = true
-        begin
-            arr = IO.readlines(helper)
-            # Read each line from helper
-            arr.each do |line|
-                lineIndex += 1
-                # Verify if it has a clause
-                if hasKeyword?(line, lineIndex, helpername)
-                    # If it does, identify which clause it is
-                    arg = decodeArgument(line)
-                    keyword = arg[0]
-                    argument = arg[1]
-                    # Execute clause
-                    case keyword
-                    when 'methods'
-                        if nome != ''
-                            methods << Metodo.new(nome, tipo, inputs, outputs, descricao)
-                            inputs = []
-                            outputs = []
-                            toSent = false
-                        end
-                        tipo = argument
-                    when 'name'
-                        if nome != '' && toSent
-                            methods << Metodo.new(nome, tipo, inputs, outputs, descricao)
-                            inputs = []
-                            outputs = []
-                        else
-                            toSent = true
-                        end
-                        nome = argument
-                    when 'param'
-                        data = dataValue(argument)
-                        inputs << data
-                    when 'return'
-                        data = dataValue(argument)
-                        outputs << data
+        arr = IO.readlines(helper)
+        # Read each line from helper
+        arr.each do |line|
+          lineIndex += 1
+          begin
+            # Verify if it has a clause
+            if hasKeyword?(line, lineIndex, helpername)
+                # If it does, identify which clause it is
+                arg = decodeArgument(line)
+                keyword = arg[0]
+                argument = arg[1]
+                # Execute clause
+                case keyword
+                when 'methods'
+                    if nome != ''
+                        methods << Metodo.new(nome, tipo, inputs, outputs, descricao)
+                        inputs = {}
+                        outputs = {}
+                        toSent = false
+                    end
+                    tipo = argument
+                when 'name'
+                    if nome != '' && toSent
+                        methods << Metodo.new(nome, tipo, inputs, outputs, descricao)
+                        inputs = {}
+                        outputs = {}
                     else
-                        # If a possible syntax error is found, a warning is sent informing file and linne
-                        puts "Warning: in #{helpername}:#{lineIndex}: #{keyword} is not a keyword" if keyword != 'namespace'
+                        toSent = true
                     end
+                    nome = argument
+                when 'param'
+                    data = dataValue(argument, inputs)
+                    inputs["#{data.name}"] = data unless data.isChild
+                when 'return'
+                    data = dataValue(argument, outputs)
+                    outputs["#{data.name}"] = data unless data.isChild
+                else
+                    # If a possible syntax error is found, a warning is sent informing file and linne
+                    puts "Warning: in #{helpername}:#{lineIndex}: #{keyword} is not a keyword" if keyword != 'namespace'
                 end
-                descricao = decodeDescription(line) if hasDescription?(line, lineIndex, helpername)
             end
-        rescue ArgumentError => e
-            # If a syntax error is found, it raises an Argument Error informing the file and line
-            puts "Warning: #{helpername}:#{lineIndex}: in #{nome} " + e.message
+            descricao = decodeDescription(line) if hasDescription?(line, lineIndex, helpername)
+          rescue ArgumentError => e
+              # If a syntax error is found, it raises an Argument Error informing the file and line
+              puts "Warning: #{helpername}:#{lineIndex}: in #{nome} " + e.message
+          end
         end
         methods << Metodo.new(nome, tipo, inputs, outputs, descricao)
         # Return a methods array
@@ -295,88 +298,88 @@ class FileHandler
         requisicao = ''
         dataInput = ''
         nome = ''
-        inputs = []
-        outputs = []
+        inputs = {}
+        outputs = {}
         routes = []
         toSent = true
-        begin
-          arr = IO.readlines(controller)
-          # Read each line from controller
-          arr.each do |line|
-              lineIndex += 1
-              # Skip to next line if no clause is found
-              next unless hasKeyword?(line, lineIndex, controllername)
-              # If it has any clause, identify which one it is
-              arg = decodeArgument(line)
-              keyword = arg[0]
-              argument = arg[1]
-              case keyword
-              # Then execute clause
-              when 'route'
-                  if nome != ''
-                      routes << Rota.new(nome, tipo, requisicao, dataInput, inputs, outputs)
-                      inputs = []
-                      outputs = []
-                      toSent = false
-                  end
-                  tipo = argument
-              when 'POST'
-                  if nome != '' && toSent
-                      routes << Rota.new(nome, tipo, requisicao, dataInput, inputs, outputs)
-                      inputs = []
-                      outputs = []
-                  else
-                      toSent = true
-                  end
-                  requisicao = keyword
-                  dataInput = argument
-              when 'GET'
-                  if nome != '' && toSent
-                      routes << Rota.new(nome, tipo, requisicao, dataInput, inputs, outputs)
-                      inputs = []
-                      outputs = []
-                  else
-                      toSent = true
-                  end
-                  requisicao = keyword
-                  dataInput = argument
-              when 'PUT'
-                  if nome != '' && toSent
-                      routes << Rota.new(nome, tipo, requisicao, dataInput, inputs, outputs)
-                      inputs = []
-                      outputs = []
-                  else
-                      toSent = true
-                  end
-                  requisicao = keyword
-                  dataInput = argument
-              when 'DELETE'
-                  if nome != '' && toSent
-                      routes << Rota.new(nome, tipo, requisicao, dataInput, inputs, outputs)
-                      inputs = []
-                      outputs = []
-                  else
-                      toSent = true
-                  end
-                  requisicao = keyword
-                  dataInput = argument
-              when 'name'
-                  nome = argument
-              when 'param'
-                  data = dataValue(argument)
-                  inputs << data
-              when 'return'
-                  data = dataValue(argument)
-                  outputs << data
-              else
-                  # If a possible syntax error is found, a warning is sent informing file and linne
-                  # (Here in the namespace comparison, i'm doing a little mcgyver)
-                  puts "Warning: in #{controllername}:#{lineIndex}: #{keyword} is not a keyword" if keyword != 'namespace'
-              end
+        arr = IO.readlines(controller)
+        # Read each line from controller
+        arr.each do |line|
+          begin
+            lineIndex += 1
+            # Skip to next line if no clause is found
+            next unless hasKeyword?(line, lineIndex, controllername)
+            # If it has any clause, identify which one it is
+            arg = decodeArgument(line)
+            keyword = arg[0]
+            argument = arg[1]
+            case keyword
+            # Then execute clause
+            when 'route'
+                if nome != ''
+                    routes << Rota.new(nome, tipo, requisicao, dataInput, inputs, outputs)
+                    inputs = {}
+                    outputs = {}
+                    toSent = false
+                end
+                tipo = argument
+            when 'POST'
+                if nome != '' && toSent
+                    routes << Rota.new(nome, tipo, requisicao, dataInput, inputs, outputs)
+                    inputs = {}
+                    outputs = {}
+                else
+                    toSent = true
+                end
+                requisicao = keyword
+                dataInput = argument
+            when 'GET'
+                if nome != '' && toSent
+                    routes << Rota.new(nome, tipo, requisicao, dataInput, inputs, outputs)
+                    inputs = {}
+                    outputs = {}
+                else
+                    toSent = true
+                end
+                requisicao = keyword
+                dataInput = argument
+            when 'PUT'
+                if nome != '' && toSent
+                    routes << Rota.new(nome, tipo, requisicao, dataInput, inputs, outputs)
+                    inputs = {}
+                    outputs = {}
+                else
+                    toSent = true
+                end
+                requisicao = keyword
+                dataInput = argument
+            when 'DELETE'
+                if nome != '' && toSent
+                    routes << Rota.new(nome, tipo, requisicao, dataInput, inputs, outputs)
+                    inputs = {}
+                    outputs = {}
+                else
+                    toSent = true
+                end
+                requisicao = keyword
+                dataInput = argument
+            when 'name'
+                nome = argument
+            when 'param'
+                data = dataValue(argument, inputs)
+                inputs["#{data.name}"] = data unless data.isChild
+            when 'return'
+                data = dataValue(argument, outputs)
+                outputs["#{data.name}"] = data unless data.isChild
+            else
+                # If a possible syntax error is found, a warning is sent informing file and linne
+                # (Here in the namespace comparison, i'm doing a little mcgyver)
+                puts "Warning: in #{controllername}:#{lineIndex}: #{keyword} is not a keyword" if keyword != 'namespace'
+            end
+          rescue ArgumentError => e
+              # If a syntax error is found, it raises an Argument Error informing the file and line
+              puts "Warning: #{controllername}:#{lineIndex}: in #{nome} " + e.message
           end
-        rescue ArgumentError => e
-            # If a syntax error is found, it raises an Argument Error informing the file and line
-            puts "Warning: #{controllername}:#{lineIndex}: in #{nome} " + e.message
         end
         routes << Rota.new(nome, tipo, requisicao, dataInput, inputs, outputs)
         # Return a routes array
@@ -401,7 +404,7 @@ class FileHandler
                   return false
                 end
             end
-            # Return true if it do
+            # Return true if it does
             true
         else
             # And false if it don't
@@ -462,18 +465,45 @@ class FileHandler
     end
 
     # If the clause is a param or return value, decode the name and datatype
-    def dataValue(argument)
+    def dataValue(argument, objects)
         if argument.include? "\s"
+            notNull = true
+            isObject = false
+            isCollection = false
+            isChild = false
             name = argument.slice(0, argument.index("\s"))
+            if name.end_with?('?')
+              notNull = false
+              name = name.slice(0, name.index('?'))
+            end
             type = argument.slice(argument.index("\s") + 1, argument.size - 2)
-            data = MethodParam.new(name, type)
+            if type.include? "\s"
+              example = type.slice(type.index("\s")+1, type.size-1-type.index("\s"))
+              type = type.slice(0, type.index("\s"))
+            end
+            type = type.slice(0, type.size-1) if type.end_with?("\s") || type.end_with?("\n")
+            isObject = true if type.downcase == "object"
+            if name.include?(">")
+              isChild = true
+              path = []
+              while name.include?(">")
+                prefix = name.slice(0, name.index(">"))
+                name = name.slice(name.index(">")+1, name.size-(name.index(">")+1))
+                path << prefix
+              end
+              fatherObject = nil
+              path.each do |object|
+                raise ArgumentError, "Object #{object} does not exists!" unless objects.has_key?(object) && objects["#{object}"].isObject
+                fatherObject = objects["#{object}"]
+                objects = fatherObject.childAttributes
+              end
+            end
+            data = MethodParam.new(name, type, notNull, isObject, isChild, example)
+            fatherObject.addField data unless fatherObject.nil?
             # Return the data
             return data
         elsif argument.include? "nil"
-            data = MethodParam.new('', 'nil')
-            return data
-        elsif argument.include? "boolean"
-            data = MethodParam.new('', 'boolen')
+            data = MethodParam.new('', 'nil', nil, nil, nil, nil)
             return data
         end
         argumentText = argument.slice(0, argument.index("\n"))
@@ -669,25 +699,21 @@ class FileHandler
                 inputs = method.inputs
                 outputs = method.outputs
                 description = method.description
-                file.write("            <div class='list-group-item'>
+                file.write("  <div class='list-group-item'>
                               <h4 class='list-group-item-heading'>CRUD: #{type}<br>Name: #{name}</h4>
-                              <p><br>Inputs:<br>
-                              <ul>")
+                              <p><br>Inputs:<br><ul>")
                 unless inputs.nil?
                     inputs.each do |input|
-                        type = input.type
-                        name = input.name
-                        file.write("<li>#{type}: #{name}</li>")
+                        input = input[1]
+                        file.write("<li>#{input.serialize}</li>")
                     end
                 end
-                file.write("</ul><br>Outputs:<br>
-                                  <ul>")
+                file.write("</ul><br>Outputs:<br><ul>")
                 unless outputs.nil?
                     outputs.each do |output|
+                        output = output[1]
                         if output != 'nil'
-                            type = output.type
-                            name = output.name
-                            file.write("<li>#{type}: #{name}</li>")
+                            file.write("<li>#{output.serialize}</li>")
                         else
                             file.write('<li>Null</li>')
                         end
@@ -718,23 +744,19 @@ class FileHandler
                               <h4 class='list-group-item-heading'>CRUD: #{type}<br>Name: #{name}</h4>
                               <p><br>Request: #{request}<br>
                               <br>Notation type: #{dataInput}<br>
-                              <br>Inputs:<br>
-                              <ul>")
+                              <br>Inputs:<br><ul>")
                 unless inputs.nil?
                     inputs.each do |input|
-                        type = input.type
-                        name = input.name
-                        file.write("<li>#{type}: #{name}</li>")
+                        input = input[1]
+                        file.write("<li>#{input.serialize}</li>")
                     end
                 end
-                file.write("</ul><br>Outputs:<br>
-                                  <ul>")
+                file.write("</ul><br>Outputs:<br><ul>")
                 unless outputs.nil?
                     outputs.each do |output|
+                        output = output[1]
                         if output != 'nil'
-                            type = output.type
-                            name = output.name
-                            file.write("<li>#{type}: #{name}</li>")
+                            file.write("<li>#{output.serialize}</li>")
                         else
                             file.write('<li>Null</li>')
                         end

data/lib/phari_doc_gen/MethodParam.rb

@@ -6,23 +6,44 @@
 #--------------------------------------------------------------------------------------------
 
 class MethodParam
-    @name = ''
-    @type = ''
+    attr_accessor :name, :type, :notNull, :isObject, :isChild, :example, :childAttributes, :serial
 
-    def initialize(givenName, givenType)
-        @name = givenName
-        @type = givenType
+    def initialize(name = "", type = "", notNull = true, isObject = false, isChild = false, example = nil)
+        @name = name
+        @type = type
+        @notNull = notNull
+        @isObject = isObject
+        @isChild = isChild
+        @example = example
+        @childAttributes = {} if @isObject
+        @serial = self.serialize
     end
 
-    def type
-        @type
+    def addField attribute
+        @childAttributes["#{attribute.name}"] = attribute
+        @serial = self.serialize
     end
 
-    def name
-        @name
+    def serialize
+        if @type == 'nil'
+          serialized = "Null"
+        elsif @isObject
+          serialized = "#{@name}: {<br><ul>"
+          @childAttributes.each do |attribute|
+            serialized = serialized + "<li>#{attribute[1].serial}</li>"
+          end
+          serialized = serialized + "</ul>}"
+        else
+          unless @example.nil?
+            serialized = "#{@name}: #{@example}"
+          else
+            serialized = "#{@name}: #{@type}"
+          end
+        end
+        serialized
     end
 
     def printSelf
-        puts"Nome: #{@name}\t\tTipo: #{@type}"
+      puts self.serialize
     end
 end

metadata

@@ -1,28 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: phari_doc_gen
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Phari Solutions
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-09 00:00:00.000000000 Z
-dependencies: []
+date: 2018-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
 description: |2-
-   Hi there buddy! I've heard you've been looking for a simple
-                      and functional documentation generator for this Ruby web app
-                      of yours. Phari Doc Generator will provide you an easy way
+   Hi there, friend! PhariDoc Generator is a simple
+                      and functional documentation generator for Ruby web aps.
+                      PhariDoc Generator will provide you an easy way
                       to generate documentation for your projects. The result
                       will be a project page with a description that can be written using a simplified
-                      markdown syntax that is going to be explained ahead. Also, each ruby
+                      markdown syntax. Also, each ruby
                       Class will have it's own page especifying it's relatios helper methods and controller
                       routes including their inputs, outputs and descriptions. The gem includes
                       an executable file and the classes that can be used individually,
                       providing the possibility to use the generator for any project
                       structure.
-email: contact@phari.solutions
+email: luiz@phari.solutions
 executables:
 - phari_doc_gen
 extensions: []
@@ -35,7 +55,7 @@ files:
 - lib/phari_doc_gen/Metodo.rb
 - lib/phari_doc_gen/Modelo.rb
 - lib/phari_doc_gen/Rota.rb
-homepage: ''
+homepage: https://gitlab.com/LuizPPA/PhariDocGen
 licenses:
 - Beerware
 metadata: {}