phari_doc_gen 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25a089731181cdd74ef5e329ebea21ca0c76f470
-  data.tar.gz: 3bcb65a77bca2679904cc4cf4133a5d9b0fadbc9
+  metadata.gz: 9cfc4375dfeebfedbc72b6c1d72606e1bd785956
+  data.tar.gz: 2af9ab2a967951d392116b56ff6bc994a00c09f7
 SHA512:
-  metadata.gz: 96346210049485630f6a468ef809b4346d0cd1cb5037dcbb701ebd9fcc9571a5a8df8a8aff937eea6064c91cd3b90651d7b82cb226243eb75e3c5faff221a43f
-  data.tar.gz: 4183130f49d48de9f04e29fca8f6e2f3bdf1b8e505997f864ff3cb2c46e4e3c363ca80f654be546637ca68f79fc1c7278274e66efe3f45f9056adc786371c61c
+  metadata.gz: 227d7265a65225e844dc144faa4a43481c534aad13c8ad296a5f9980ecfc8a4b9b8ac1d8c0ffab85a52b93ba627ff14190211533f4dc0768c37947445f1cc527
+  data.tar.gz: 2b30ebe10d48fbfbad635019205c972235a0c3dcdb082b01dd570ebd237e16ac48dcf6c90970eb2a1e84be60f43efacb024ed069c32b4f1d5977884ef658804e

data/lib/phari_doc_gen/fileHandler.rb

@@ -5,19 +5,18 @@
 # Luiz Philippe.
 #--------------------------------------------------------------------------------------------
 
+require 'erubis'
 require_relative 'modelo.rb'
 require_relative 'rota.rb'
 require_relative 'metodo.rb'
 require_relative 'methodParam.rb'
 require_relative 'meta.rb'
-require 'erubis'
 
 class FileHandler
     # Reading files
     # Find a folder with the project name
     def packageExistis?(packageName)
         found = false
-        package = ''
         puts'Finding project'
         puts'It may take some time...'
         packageName += '/' unless packageName.end_with?('/')
@@ -481,7 +480,9 @@ class FileHandler
               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"
+            isObject = type.downcase == "object"
+            isCollection = type.downcase == "array"
+            # Inserting attributes inside objects
             if name.include?(">")
               isChild = true
               path = []
@@ -492,17 +493,23 @@ class FileHandler
               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}"]
+                if (fatherObject.nil? || fatherObject.isObject)
+                  raise ArgumentError, "Object #{object} does not exists!" unless objects.has_key?(object) && (objects["#{object}"].isObject || objects["#{object}"].isCollection)
+                  fatherObject = objects["#{object}"]
+                elsif (fatherObject.isCollection)
+                  raise ArgumentError, "Object #{object} is not a position of #{fatherObject.name}!" unless (objects["content"].isObject || objects["content"].isCollection)
+                  fatherObject = objects["content"]
+                end
                 objects = fatherObject.childAttributes
               end
             end
-            data = MethodParam.new(name, type, notNull, isObject, isChild, example)
-            fatherObject.addField data unless fatherObject.nil?
+            data = MethodParam.new(name, type, notNull, isObject, isCollection, isChild, example)
+            fatherObject.addField data unless (fatherObject.nil? || fatherObject.isCollection)
+            fatherObject.setContent data unless (fatherObject.nil? || fatherObject.isObject)
             # Return the data
             return data
         elsif argument.include? "nil"
-            data = MethodParam.new('', 'nil', nil, nil, nil, nil)
+            data = MethodParam.new('', 'nil', false, false, false, false, nil)
             return data
         end
         argumentText = argument.slice(0, argument.index("\n"))
@@ -545,8 +552,7 @@ class FileHandler
     # Write the css content
     def writeCSS(file)
       css_file = gem_libdir+'/templates/style.css'
-      css = File.read(css_file)
-      file.write(css)
+      file.write(File.read(css_file))
     end
 
     #Write the main project HTML content
@@ -588,7 +594,9 @@ class FileHandler
     def gem_libdir
       t = ["#{File.dirname(File.expand_path($0))}/../lib/#{Meta::NAME}",
            "#{Gem.dir}/gems/#{Meta::NAME}-#{Meta::VERSION}/lib/#{Meta::NAME}"]
-      t.each {|i| return i if File.readable?(i) }
+      t.each do |i|
+        return i if File.readable?(i)
+      end
       raise "both paths are invalid: #{t}"
     end
 end

data/lib/phari_doc_gen/meta.rb

@@ -1,4 +1,4 @@
 module Meta
   NAME = 'phari_doc_gen'
-  VERSION = '3.1.0'
+  VERSION = '3.1.1'
 end

data/lib/phari_doc_gen/methodParam.rb

@@ -6,44 +6,56 @@
 #--------------------------------------------------------------------------------------------
 
 class MethodParam
-    attr_accessor :name, :type, :notNull, :isObject, :isChild, :example, :childAttributes, :serial
+    attr_accessor :name, :type, :notNull, :isObject, :isCollection, :isChild, :example, :childAttributes, :serial
 
-    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
+    def initialize(name = "", type = "", notNull = true, isObject = false, isCollection = false, isChild = false, example = nil)
+      @name = name
+      @type = type
+      @notNull = notNull
+      @isObject = isObject
+      @isCollection = isCollection
+      @isChild = isChild
+      @example = example
+      @childAttributes = {} if (@isObject || @isCollection)
     end
 
     def addField attribute
-        @childAttributes["#{attribute.name}"] = attribute
-        @serial = self.serialize
+      raise ArgumentError, "Cannot add field to no object param" unless @isObject
+      @childAttributes["#{attribute.name}"] = attribute
+    end
+
+    def setContent attribute
+      raise ArgumentError, "Cannot set content of no array param" unless @isCollection
+      @childAttributes["content"] = attribute
     end
 
     def serialize
-        if @type == 'nil'
-          serialized = "Null"
-        elsif @isObject
-          serialized = "#{@name}: {<br><ul>"
-          @childAttributes.each do |attribute|
-            serialized = serialized + "<li>#{attribute[1].serialize}</li>"
-          end
-          serialized = serialized + "</ul>}"
+      if @type == 'nil'
+        serialized = "Null"
+      elsif @isObject
+        serialized = "#{@name}: {<br><ul>"
+        @childAttributes.each do |attribute|
+          serialized = serialized + "<li>#{attribute[1].serialize}</li>"
+        end
+        serialized = serialized + "</ul>}"
+      elsif @isCollection
+        if @childAttributes['content'].nil?
+          serialized = "#{@name}: [<br><ul><li>Null</li><li>...</li></ul>"
+        else
+          # puts "child attributes: #{@childAttributes['content'].type}"
+          serialized = "#{@name}: [<br><ul><li>#{@childAttributes['content'].serialize},</li><li>...</li>]</ul>"
+        end
+      else
+        unless @example.nil?
+          serialized = "#{@name}: #{@example}"
         else
-          unless @example.nil?
-            serialized = "#{@name}: #{@example}"
-          else
-            serialized = "#{@name}: #{@type}"
-          end
+          serialized = "#{@name}: #{@type}"
         end
-        serialized
+      end
+      serialized
     end
 
-    def printSelf
+    def dump
       puts self.serialize
     end
 end

data/lib/phari_doc_gen/templates/model.html.erb

@@ -54,25 +54,33 @@
             <%description = method.description%>
             <div class='list-group-item'>
             <h4 class='list-group-item-heading'>CRUD: <%=type%><br>Name: <%name%></h4>
-            <p><br>Inputs:<br><ul>
-            <%unless inputs.nil?%>
-              <%for input in inputs%>
-                <%input = input[1]%>
-                <li><%=input.serialize%></li>
-              <%end%>
-            <%end%>
-            </ul><br>Outputs:<br><ul>
-            <%unless outputs.nil?%>
-              <% for output in outputs%>
-                  <%output = output[1]%>
-                  <%if output != 'nil'%>
-                      <li><%=output.serialize%></li>
-                  <%else%>
-                      <li>Null</li>
+            <p>
+              <br>Inputs:
+              <br>
+              <ul>
+                <%unless inputs.nil?%>
+                  <%for input in inputs%>
+                    <%input = input[1]%>
+                    <li><%=input.serialize%></li>
                   <%end%>
-              <%end%>
-            <%end%>
-          </ul><br>Description: <%=description%></p>
+                <%end%>
+              </ul>
+              <br>Outputs:
+              <br>
+              <ul>
+                <%unless outputs.nil?%>
+                  <% for output in outputs%>
+                      <%output = output[1]%>
+                      <%if output != 'nil'%>
+                          <li><%=output.serialize%></li>
+                      <%else%>
+                          <li>Null</li>
+                      <%end%>
+                  <%end%>
+                <%end%>
+              </ul>
+              <br>Description: <%=description%>
+            </p>
             </div>
           <%end%>
         <%end%>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phari_doc_gen
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Phari Solutions
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-21 00:00:00.000000000 Z
+date: 2018-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport