phari_doc_gen 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32a910fca9b0a5e880ad92810b525d2bbb660c68
-  data.tar.gz: ca0cd94ddd0d1c937e0e38c7d74dd2f4b5cb0d3d
+  metadata.gz: 9ad8f025c300abb25064da2bf9ac3ddcabf231ed
+  data.tar.gz: 49927b12a5443efbb62cde2b7828493c8f7f0210
 SHA512:
-  metadata.gz: db63b3191a9da9f8aa928ba7900cffdb2f6559a307dc7b164b0662a2dd63a9449a0ee707ee8d7d18249080b02683f6940e2900af4c79bc5122ec4aa97d0dcc7a
-  data.tar.gz: 89a6db34e44842535846b0e030e3efb225589eae398e5165d467437e1ea79fae892fac9c5f67711e6b6c72541886acd38ae3762a0b8a7a9d43b6a47d12282ae3
+  metadata.gz: b09c3af0a867d263c21fe8d1ff4f3f3991046773ce043a848c7f95386cd858f3da5d1d0b59444ef8f3e877191b79ea9549918ed6b3e285ee63851550f47a14b7
+  data.tar.gz: 37f6ac303ca59dc6cf544c5fe9d5b3367b3a6316c9105d59da118286b1f47f80eedb73ee7055dd9020af9f7f5b2675d28e865c953ea77159f7dfbc463a95716b

data/lib/phari_doc_gen/FileHandler.rb

@@ -6,6 +6,7 @@
 #--------------------------------------------------------------------------------------------
 
 require 'fileutils'
+require 'active_support/inflector'
 require_relative 'Modelo.rb'
 require_relative 'Rota.rb'
 require_relative 'Metodo.rb'
@@ -55,29 +56,44 @@ class FileHandler
         Dir.glob(path + 'api/models/*.rb') do |file|
             filename = file.to_s
             inputFile = File.new(filename)
+            modelFile = File.new(filename, 'r')
             modelname = File.basename(inputFile, '.rb')
-            modelPath = path + 'api/models/' + modelname + '.rb'
             helpername = path + 'api/app/helpers/' + modelname + '_helper.rb'
             controllername = path + 'api/app/controllers/' + modelname + '.rb'
-            if File.exist?(helpername) && File.exist?(controllername)
-                # Call the necessary methods for each helper, model and controller
-                modelFile = File.new(modelPath, 'r')
+            modelname = nameFormat(modelname)
+            # Call the necessary methods for each helper, model and controller
+            relations = readRelations(modelFile, modelname, filename)
+            modelFile.close
+            if File.exist?(helpername)
                 modelHelper = File.new(helpername, 'r')
-                modelController = File.new(controllername, 'r')
-                relations = readRelations(modelFile, modelname, modelPath)
                 methods = readMethods(modelHelper, helpername)
-                routes = readRoutes(modelController, controllername)
-                currentModel = Modelo.new(modelname, methods, routes, relations)
-                models << currentModel
-                modelFile.close
                 modelHelper.close
+            end
+            if File.exist?(controllername)
+                modelController = File.new(controllername, 'r')
+                routes = readRoutes(modelController, controllername)
                 modelController.close
             end
+            currentModel = Modelo.new(modelname, methods, routes, relations)
+            models << currentModel
+            methods = nil
+            routes = nil
+            relations = nil
         end
         # Return models
         models
     end
 
+    def nameFormat(name)
+        name = name.capitalize
+        if name.include?("_")
+            prefix = name.slice(0, name.index("_"))
+            sulfix = name.slice(name.index("_")+1, name.length - name.index("_"))
+            name = "#{prefix.capitalize} #{sulfix.capitalize}"
+        end
+        name
+    end
+
     # Auxiliary methods of reading
 
     # Generate project descriprion based on 'README.md'
@@ -166,31 +182,37 @@ class FileHandler
     def readRelations(modelFile, modelname, modelPath)
         lineIndex = 0
         relations = []
-        arr = IO.readlines(modelFile)
-        # Read each line from model
-        arr.each do |line|
-            # Verify presence of any clause
-            if hasKeyword?(line, lineIndex, modelname)
-                # If it does, identify which clause it is
-                arg = decodeArgument(line)
-                keyword = arg[0]
-                argument = arg[1]
-                # Execute clause
-                case keyword
-                when 'belongs_to'
-                  relation = modelname.capitalize + ' belongs to ' + argument
-                  relations << relation
-                when 'has_one'
-                    relation = modelname.capitalize + ' has one ' + argument
-                    relations << relation
-                when 'has_many'
-                    relation = modelname.capitalize + ' has many ' + argument
-                    relations << relation
-                when 'has_and_belongs_to_many'
-                    relation = modelname.capitalize + ' has and belongs to many ' + argument
-                    relations << relation
+        begin
+            arr = IO.readlines(modelFile)
+            # Read each line from model
+            arr.each do |line|
+                lineIndex += 1
+                # Verify presence of any clause
+                if hasKeyword?(line, lineIndex, modelname)
+                    # If it does, identify which clause it is
+                    arg = decodeArgument(line)
+                    keyword = arg[0]
+                    argument = arg[1]
+                    # Execute clause
+                    case keyword
+                    when 'belongs_to'
+                      relation = modelname + ' belongs to ' + argument
+                      relations << relation
+                    when 'has_one'
+                        relation = modelname + ' has one ' + argument
+                        relations << relation
+                    when 'has_many'
+                        relation = modelname + ' has many ' + argument.pluralize
+                        relations << relation
+                    when 'has_and_belongs_to_many'
+                        relation = modelname + ' has and belongs to many ' + argument.pluralize
+                        relations << relation
+                    end
                 end
             end
+        rescue ArgumentError => e
+            # If a syntax error is found, it raises an Argument Error informing the file and line
+            puts "Warning: #{modelPath}:#{lineIndex} " + e.message
         end
         relations
     end
@@ -249,9 +271,8 @@ class FileHandler
                 descricao = decodeDescription(line) if hasDescription?(line, lineIndex, helpername)
             end
         rescue ArgumentError => e
-            # If a syntax error is found, it rais an Argument Error informing the file and line
-            puts "ERROR: #{helpername}:#{lineIndex}: in #{nome}"
-            puts e.message
+            # 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
         methods << Metodo.new(nome, tipo, inputs, outputs, descricao)
         # Return a methods array
@@ -345,9 +366,8 @@ class FileHandler
               end
           end
         rescue ArgumentError => e
-            # If a syntax error is found, it raise an Argument Error informing the file and line
-            puts "ERROR: #{controllername}:#{lineIndex}: in #{nome}"
-            puts e.message
+            # 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
@@ -408,23 +428,30 @@ class FileHandler
     def decodeArgument(line)
         args = []
         initialIndex = line.index('@') + 1
+        sentence = line.slice(initialIndex, line.length - initialIndex)
+        # Raises an Argument Error if some error is found
+        raise ArgumentError.new("Sytanx error: expected 2 arguments (none given)") unless hasSomething?(sentence)
+        raise ArgumentError.new("Sytanx error: expected 2 arguments (one given)") unless sentence.include?("\s")
         finalIndex = line.index("\s", line.index('@'))
-        if finalIndex == nil || initialIndex == nil
-          if line.index('@')+1 == /^[[:alpha:]]$/
-            # Raises an Argument Error if some error is found
-            raise ArgumentError.new("Sytanx error: expected 2 arguments (one given)")
-          else raise ArgumentError.new("Sytanx error: expected 2 arguments (none given)")
-          end
-        end
         lenght = finalIndex - initialIndex
         keyword = line.slice(initialIndex, lenght)
         argument = line.slice(finalIndex + 1, line.size - finalIndex)
+        raise ArgumentError.new("Sytanx error: expected 2 arguments (one given)") unless hasSomething?(argument)
         args << keyword
         args << argument
         # Return array with clause and arguments
         args
     end
 
+    def hasSomething?(line)
+        for i in 0..line.length-1
+            if line[i].match(/^[[:alpha:]]$/)
+              return true
+            end
+        end
+        false
+    end
+
     # If the clause is a param or return value, decode the name and datatype
     def dataValue(argument)
         if argument.include? "\s"
@@ -576,11 +603,13 @@ class FileHandler
           <div class='row'>
             <div class='col-md-4'>
               <ul class='list-group'>")
-        models.each do |model|
-            link = model.name.downcase
-            name = model.name.capitalize
-            file.write("\t\t<a href='models/#{link}.html' class='list-indexes list-group-item'>#{name}</a>
-            ")
+        unless models.nil?
+            models.each do |model|
+                link = model.name.downcase
+                name = model.name
+                file.write("\t\t<a href='models/#{link}.html' class='list-indexes list-group-item'>#{name}</a>
+                ")
+            end
         end
         file.write("\t</ul>
           </div>
@@ -594,8 +623,10 @@ class FileHandler
 
     # Write a model HTML page content
     def writeModelPage(file, model, project)
-        name = model.name.capitalize
+        name = model.name
         relations = model.relations
+        methods = model.methods
+        routes = model.routes
         file.write("<div class='container panel panel-default'>
           <div class='row'>
             <div class='panel panel-default'>
@@ -605,8 +636,10 @@ class FileHandler
               <div class='panel-body'>
                 <h2>#{name} Model</h2>
                 <h4>")
-                relations.each do |relation|
-                    file.write('<br>'+relation)
+                unless relations.nil?
+                    relations.each do |relation|
+                        file.write('<br>'+relation)
+                    end
                 end
                 file.write("</h4>
               </div>
@@ -620,35 +653,40 @@ class FileHandler
                 </div>
               </div>
               <ul class='list-group'>")
-        methods = model.methods
-        methods.each do |method|
-            type = method.type
-            name = method.name
-            inputs = method.inputs
-            outputs = method.outputs
-            description = method.description
-            file.write("            <div class='list-group-item'>
-                          <h4 class='list-group-item-heading'>CRUD: #{type}<br>Name: #{name}</h4>
-                          <p><br>Inputs:<br>
-                          <ul>")
-            inputs.each do |input|
-                type = input.type
-                name = input.name
-                file.write("<li>#{type}: #{name}</li>")
-            end
-            file.write("</ul><br>Outputs:<br>
+        unless methods.nil?
+            methods.each do |method|
+                type = method.type
+                name = method.name
+                inputs = method.inputs
+                outputs = method.outputs
+                description = method.description
+                file.write("            <div class='list-group-item'>
+                              <h4 class='list-group-item-heading'>CRUD: #{type}<br>Name: #{name}</h4>
+                              <p><br>Inputs:<br>
                               <ul>")
-            outputs.each do |output|
-                if output != 'nil'
-                    type = output.type
-                    name = output.name
-                    file.write("<li>#{type}: #{name}</li>")
-                else
-                    file.write('<li>Null</li>')
+                unless inputs.nil?
+                    inputs.each do |input|
+                        type = input.type
+                        name = input.name
+                        file.write("<li>#{type}: #{name}</li>")
+                    end
                 end
+                file.write("</ul><br>Outputs:<br>
+                                  <ul>")
+                unless outputs.nil?
+                    outputs.each do |output|
+                        if output != 'nil'
+                            type = output.type
+                            name = output.name
+                            file.write("<li>#{type}: #{name}</li>")
+                        else
+                            file.write('<li>Null</li>')
+                        end
+                    end
+                end
+                file.write("</ul><br>Description: #{description}</p>
+                            </div>")
             end
-            file.write("</ul><br>Description: #{description}</p>
-                        </div>")
         end
         file.write("</ul>
       </div>
@@ -659,38 +697,43 @@ class FileHandler
           </div>
         </div>
         <ul class='list-group'>")
-        routes = model.routes
-        routes.each do |route|
-            type = route.type
-            name = route.name
-            request = route.request
-            dataInput = route.dataInput
-            inputs = route.inputs
-            outputs = route.outputs
-            file.write("            <div class='list-group-item'>
-                          <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>")
-            inputs.each do |input|
-                type = input.type
-                name = input.name
-                file.write("<li>#{type}: #{name}</li>")
-            end
-            file.write("</ul><br>Outputs:<br>
+        unless routes.nil?
+            routes.each do |route|
+                type = route.type
+                name = route.name
+                request = route.request
+                dataInput = route.dataInput
+                inputs = route.inputs
+                outputs = route.outputs
+                file.write("            <div class='list-group-item'>
+                              <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>")
-            outputs.each do |output|
-                if output != 'nil'
-                    type = output.type
-                    name = output.name
-                    file.write("<li>#{type}: #{name}</li>")
-                else
-                    file.write('<li>Null</li>')
+                unless inputs.nil?
+                    inputs.each do |input|
+                        type = input.type
+                        name = input.name
+                        file.write("<li>#{type}: #{name}</li>")
+                    end
+                end
+                file.write("</ul><br>Outputs:<br>
+                                  <ul>")
+                unless outputs.nil?
+                    outputs.each do |output|
+                        if output != 'nil'
+                            type = output.type
+                            name = output.name
+                            file.write("<li>#{type}: #{name}</li>")
+                        else
+                            file.write('<li>Null</li>')
+                        end
+                    end
                 end
+                file.write("</ul></p>
+                            </div>")
             end
-            file.write("</ul></p>
-                        </div>")
         end
         file.write("</ul>
       </div>

metadata

@@ -1,32 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: phari_doc_gen
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Phari Solutions
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2017-06-09 00:00:00.000000000 Z
 dependencies: []
 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. So here goes a brief tutorial on how to use this
-                      little gem developed by Phari Solutions. First things first.
-                      To use this gem, you will need to be following the sinatra/padrino
-                      patterns. If you're using these frameworks probably you already
-                      matched the requisites, otherwise, organize your folders properly.
-                      Your project tree has to be organized in a main directory called
-                      'api' that must contain another folder 'app' with three other
-                      directories 'models', 'helpers' and 'controllers' within. The files will
-                      also have to be especifically named. But we'll look further into it
-                      later. Now, requisites aside, Phari Doc Generator will provide you
-                      an easy way to generate documentation for your projects. The result
+                      of yours. Phari Doc 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
-                      Class will have it's own page especifying it's helper methods and controller
+                      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