phari_doc_gen 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 179bf4069abbf822ef6259e2d3670c76b9a69dca
-  data.tar.gz: 46037dafd0c71328f06ad65bfec310a39afc3b92
+  metadata.gz: 32a910fca9b0a5e880ad92810b525d2bbb660c68
+  data.tar.gz: ca0cd94ddd0d1c937e0e38c7d74dd2f4b5cb0d3d
 SHA512:
-  metadata.gz: 2389fd25d4f70245c5ce3a0acf0e2fdb846eb2b35712953f83cd1f381ad1981c36a2a59ae4a06e2bb634cd1d43666a5bcebf43ee477e0bc1f7d0591a3cab1e4c
-  data.tar.gz: 75a78882b877ea080f3e2bc44dd34996731a18a770f6a893bd253a4512c5037fe42ae132583dfe30537125b99b1aaa737d4f225d2f608b1f49be8daa1909f63a
+  metadata.gz: db63b3191a9da9f8aa928ba7900cffdb2f6559a307dc7b164b0662a2dd63a9449a0ee707ee8d7d18249080b02683f6940e2900af4c79bc5122ec4aa97d0dcc7a
+  data.tar.gz: 89a6db34e44842535846b0e030e3efb225589eae398e5165d467437e1ea79fae892fac9c5f67711e6b6c72541886acd38ae3762a0b8a7a9d43b6a47d12282ae3

data/lib/phari_doc_gen/FileHandler.rb

@@ -20,8 +20,9 @@ class FileHandler
         puts'Finding project'
         puts'It may take some time...'
         Dir.glob('/**/' + packageName + '/') do |folder|
-            package = folder unless found
+            package = folder
             found = true
+            break
         end
         packagePath = package.to_s
         if found
@@ -40,6 +41,7 @@ class FileHandler
         if 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.'
@@ -54,16 +56,22 @@ class FileHandler
             filename = file.to_s
             inputFile = File.new(filename)
             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 and controller
+                # Call the necessary methods for each helper, model and controller
+                modelFile = File.new(modelPath, 'r')
                 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)
+                currentModel = Modelo.new(modelname, methods, routes, relations)
                 models << currentModel
+                modelFile.close
+                modelHelper.close
+                modelController.close
             end
         end
         # Return models
@@ -72,7 +80,7 @@ class FileHandler
 
     # Auxiliary methods of reading
 
-    #Generate project descriprion based on 'README.md'
+    # Generate project descriprion based on 'README.md'
     def readProjectDescription(readme)
         isCode = false
         @projectDescription = ''
@@ -154,6 +162,39 @@ class FileHandler
         line
     end
 
+    # Read relations from model file
+    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
+                end
+            end
+        end
+        relations
+    end
+
     # Read all methods from a helper file; helper = file, helpername = file path
     def readMethods(helper, helpername)
         lineIndex = 0
@@ -554,6 +595,7 @@ class FileHandler
     # Write a model HTML page content
     def writeModelPage(file, model, project)
         name = model.name.capitalize
+        relations = model.relations
         file.write("<div class='container panel panel-default'>
           <div class='row'>
             <div class='panel panel-default'>
@@ -562,6 +604,11 @@ class FileHandler
               </div>
               <div class='panel-body'>
                 <h2>#{name} Model</h2>
+                <h4>")
+                relations.each do |relation|
+                    file.write('<br>'+relation)
+                end
+                file.write("</h4>
               </div>
             </div>
           </div>

data/lib/phari_doc_gen/Modelo.rb

@@ -8,12 +8,14 @@
 class Modelo
     @methods = []
     @routes = []
+    @relations = []
     @name = ''
 
-    def initialize(givenName, methodList, routeList)
+    def initialize(givenName, methodList, routeList, relationsList)
         @name = givenName
         @methods = methodList
         @routes = routeList
+        @relations = relationsList
     end
 
     def printSelf
@@ -35,4 +37,8 @@ class Modelo
     def routes
         @routes
     end
+
+    def relations
+        @relations
+    end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phari_doc_gen
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Phari Solutions
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-29 00:00:00.000000000 Z
+date: 2017-06-01 00:00:00.000000000 Z
 dependencies: []
 description: |2-
    Hi there buddy! I've heard you've been looking for a simple
@@ -56,7 +56,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="