code_terminator 0.5.2 → 0.5.3

data/lib/code_terminator/html2.rb

@@ -0,0 +1,657 @@
+require 'active_support/core_ext/string/filters'
+
+class CodeTerminator::Html
+
+  def initialize(args = {})
+    @code = args[:code]
+    @source = args[:source]
+    @tags = Array.new
+    @elements = Array.new
+
+    args[:source_type] ||= "file"
+    @source_type = args[:source_type]
+  end
+
+    # Create a Html file with the code of the editor. Return a boolean that indicate if the file was created or not.
+    #
+    # Example:
+    #   >> CodeTerminator::Html.new_file("hola_mundo.html", "<h1>Hola Mundo!</h1>")
+    #   => true
+    #
+    # Arguments:
+    #   source: (String)
+    #   code: (String)
+
+   def new_file(source,code)
+     fileHtml = File.new(source, "w+")
+     result = true
+     begin
+       fileHtml.puts code
+     rescue
+       result = false
+     ensure
+       fileHtml.close unless fileHtml.nil?
+     end
+     #return true if file was succesfully created
+     result
+   end
+
+
+     # Get html elements of a html file. Return a list of Nokogiri XML objects.
+     #
+     # Example:
+     #   >> CodeTerminator::Html.get_elements("hola_mundo.html")
+     #   => [#<Nokogiri::XML::Element:0x3fe3391547d8 name="h1" children=[#<Nokogiri::XML::Text:0x3fe33915474c "Hola Mundo!">]>, #<Nokogiri::XML::Text:0x3fe33915474c "Hola Mundo!">]
+     #
+     # Arguments:
+     #   source: (String)
+
+   def get_elements(source)
+     @elements = Array.new
+     #How to read if is an url
+     if @source_type == "url"
+       reader = Nokogiri::HTML(open(source).read)
+     else
+       reader = Nokogiri::HTML(File.open(source))
+     end
+     #remove empty spaces from reader
+     reader = remove_empty_text(reader)
+     node = Hash.new
+     node[:parent] = ""
+     node[:tag] = "html"
+     @elements << node
+
+     #search elements from body section
+       if reader.at('body')
+         node = Hash.new
+         node[:parent] = "html"
+         node[:tag] = "body"
+         @elements << node
+
+         reader.at('body').attribute_nodes.each do |element_attribute|
+           node = Hash.new
+           node[:parent] = "html"
+           node[:tag] = "body"
+           node[:attribute] = element_attribute.name if element_attribute.name
+           node[:value] = element_attribute.value if element_attribute.value
+           node[:pointer] = element_attribute.pointer_id
+           @elements << node
+         end
+      end
+      #end search
+
+      #search elements from head section
+     if reader.at('head')
+       node = Hash.new
+       node[:parent] = "html"
+       node[:tag] = "head"
+       @elements << node
+       reader.at('head').children.each do |child|
+         if child.attribute_nodes.empty?
+           node = Hash.new
+           node[:parent] = "head"
+           node[:tag] = child.name
+           node[:content] = child.text if child.text or child.comment?
+           node[:pointer] = child.pointer_id
+           node[:parent_pointer] = child.parent.pointer_id
+
+           @elements << node
+         else
+           child.attribute_nodes.each do |element_attribute|
+             node = Hash.new
+             node[:parent] = "head"
+             if child.name == "#cdata-section"
+               node[:tag] = "text"
+             else
+               node[:tag] = child.name
+             end
+             # node[:tag] = ( ? "text", child.name)
+             node[:content] = child.text if !child.text.nil?
+             node[:attribute] = element_attribute.name if element_attribute.name
+             node[:value] = element_attribute.value if element_attribute.value
+             node[:pointer] = element_attribute.pointer_id
+             node[:parent_pointer] = child.pointer_id
+             @elements << node
+           end
+         end
+         add_children(child) if child.children.any?
+       end
+    end
+    #end search elements
+
+    #search elements inside body (children)
+    if reader.at('body')
+      reader.at('body').children.each do |child|
+        if child.attribute_nodes.empty?
+          node = Hash.new
+          node[:parent] = "body"
+          node[:tag] = child.name
+          node[:content] = child.text if child.text? or child.comment?
+          node[:pointer] = child.pointer_id
+          node[:parent_pointer] = child.parent.pointer_id
+          @elements << node
+        else
+          child.attribute_nodes.each do |element_attribute|
+            node = Hash.new
+            node[:parent] = "body"
+            node[:tag] = child.name
+            node[:attribute] = element_attribute.name if element_attribute.name
+            node[:value] = element_attribute.value if element_attribute.value
+            node[:pointer] = element_attribute.pointer_id
+            node[:parent_pointer] = child.pointer_id
+            @elements << node
+          end
+        end
+        add_children(child) if child.children.any?
+      end
+     end
+     #end search elements
+
+     @elements
+   end
+
+     # Validate if the syntax is correct. Return an array with Nokogiri errors.
+     #
+     # Example:
+     #   >> CodeTerminator::Html.validate_syntax("<h1>Hola Mundo!</h1")
+     #   => [#<Nokogiri::XML::SyntaxError: expected '>'>]
+     #
+     # Arguments:
+     #   code: (String)
+
+   def validate_syntax(code)
+     errors = Array.new
+
+     begin
+       Nokogiri::XML(code) { |config| config.strict }
+
+       #validate if html follow w3, uncomment when check all the page
+         #"<!DOCTYPE html>
+         # <html>
+         #   <head>
+         #     <h1>asdasd</h1>
+         #     <title>asdasd</title>
+         #   </head>
+         #   <body>
+         #     <h1>hola</h1>
+         #   </body>
+         # </html>"
+       # @validator = Html5Validator::Validator.new
+       # @validator.validate_text(@html)
+
+     rescue Nokogiri::XML::SyntaxError => e
+       #errors[0] = "Check if you close your tags"
+       errors[0] = e
+     end
+
+     errors
+   end
+
+     # Read a html file. Return the text of the file.
+     #
+     # Example:
+     #   >> CodeTerminator::Html.read_file("hola_mundo.html")
+     #   => "<h1>Hola Mundo!</h1>\n"
+     #
+     # Arguments:
+     #   source: (String)
+
+   def read_file(source)
+     if @source_type == "url"
+       fileHtml = open(source).read
+     else
+       fileHtml = File.open(source, "r")
+     end
+
+     text = ""
+     begin
+       fileHtml.each_line do |line|
+         text << line
+       end
+       fileHtml.close
+     rescue
+       text = false
+     ensure
+       #fileHtml.close unless fileHtml.nil?
+     end
+
+     text
+   end
+
+     # Get the elements of the code in html format. Return a string with elements in html.
+     #
+     # Example:
+     #   >> CodeTerminator::Html.print_elements("exercises/hola_mundo.html" )
+     #   => "name = h1<br><hr>name = text<br>content = hola mundo<br><hr>"
+     #
+     # Arguments:
+     #   elements: (Array)
+
+   def print_elements(elements)
+     text = ""
+     elements.each do |child|
+       text << "parent = " + child[:parent] + "<br>" if child[:parent]
+       text << "tag = " + child[:tag] + "<br>" if child[:tag]
+       text << "attribute = " + child[:attribute] + "<br>" if child[:attribute]
+       text << "value = " + child[:value] + "<br>" if child[:value]
+       text << "content = " + child[:content] + "<br>" if child[:content]
+       text << "<hr>"
+     end
+     text
+   end
+
+   # Get the instructions to recreate the html code. Return an array with strings .
+   #
+   # Example:
+   #   >> CodeTerminator::Html.get_instructions(file.get_elements("exercises/test.html"))
+   #   => ["Add the tag h2 in body", "Add the tag text in h2 with content 'hola test' ", "Add the tag p in body"]
+   #
+   # Arguments:
+   #   instructions: (Array)
+
+   def get_instructions(source)
+     elements = get_elements(source)
+     text = ""
+     instructions = Array.new
+     elements.each do |child|
+       if child[:tag]!="text"
+         text << "Add the tag " + child[:tag]
+         text << " in "  + child[:parent]  if !child[:parent].nil?
+         text << " with an attribute '" + child[:attribute] + "' " if !child[:attribute].nil?
+         text << " with value '" + child[:value] + "' " if !child[:value].nil?
+       elsif child[:tag] == "comment"
+        text << " In " + child[:tag]+ " add the text '" + child[:content]  + "' "  if !child[:content].nil?
+       else
+         text << " In " + child[:parent]+ " add the text '" + child[:content]  + "' "  if !child[:content].nil?
+       end
+       instructions.push(text)
+       text = ""
+     end
+     instructions
+   end
+
+
+
+   # Match if the code have the same elements than the exercise. Return an array with the mismatches.
+   #
+   # Example:
+   #
+   #   hola_mundo.html
+   # => <h1>Hola Mundo!</h1>
+   #
+   #   >> CodeTerminator::Html.match("hola_mundo.html","<h2>Hola Mundo!</h2>")
+   #   => ["h1 not exist"]
+   #
+   # Arguments:
+   #   source: (String)
+   #   code: (String)
+
+   def match(source, code)
+     @html_errors = Array.new
+     html_errors = @html_errors
+
+     code = Nokogiri::HTML(code)
+
+     elements = get_elements(source)
+
+     css_code_checked = Array.new
+
+     exist_in_body = Array.new
+
+     error_elements = Array.new
+
+
+     error333 = nil
+
+     elements.each do |e|
+       error_count = 0
+
+       item = e[:tag]
+
+       if item == "text" or item == "comment"
+        #  Check the text
+         if e[:content]
+           if code.css(e[:parent]).count < 2
+             if code.css(e[:parent]).class == Nokogiri::XML::NodeSet
+               #look for children elements with texts or comments
+               look_comment_or_text(code,e)
+             end
+           else
+             #check if parent tag of the user code has text apart from the children tags
+             look_parent_text(code,e)
+           end
+         end
+         #end if content is null
+
+       else
+       #item class is different to text or comment
+
+       if code.css(e[:tag]).length > 0
+
+        # error_elements = Array.new
+
+        code.css(e[:tag]).each do |tag|
+
+          p "code original css + " + e[:tag].to_s
+          p "pointer original element " + e[:pointer].to_s
+          p "pointer element code " + tag.pointer_id.to_s
+
+          e_check = css_code_checked.select {|element| element[:target_pointer].to_s == e[:pointer].to_s }
+          p "echeck " + e_check.to_s
+          e_check2 = css_code_checked.select {|element| element[:pointer].to_s == tag.pointer_id.to_s }
+          #e_check3 = css_code_checked.select {|element| element[:target_parent_pointer].to_s == e[:parent_pointer].to_s }
+
+          # e_check_exist = css_code_checked.select {|element| element[:pointer].to_s == tag.pointer_id.to_s && element[:target_pointer].to_s == e[:pointer]}
+          # e_check_2_exist = css_code_checked.select {|element| element[:pointer].to_s == tag.pointer_id.to_s && element[:target_pointer].to_s != e[:pointer]}
+          # e_check_3_exist = css_code_checked.select {|element| element[:pointer].to_s == tag.pointer_id.to_s && element[:target_pointer].to_s != e[:pointer]}
+
+          # p "check1 " + e_check_exist.to_s
+          # p "check2 " + e_check_2_exist.to_s
+          #si el target pointer- pointer no esta en la lista de check agregar,
+          #si es target-pointer que ya existe + otro pointer da error,
+          #si es target-pointer y si esta, hacer nada.
+          #si pointer ya esta en la lista hacer nada
+          #look for same tags in code
+          # p elements.select {|x| x[:tag].to_s == e[:tag].to_s }
+          if css_code_checked.select {|element| element[:target_pointer].to_s == e[:pointer].to_s }.count == 0
+            if elements.select {|x| x[:tag].to_s == e[:tag].to_s }.count > 1
+              if e_check.count == 0 && e_check2.count == 0
+                element_checked = Hash.new
+                element_checked[:pointer] = tag.pointer_id
+                element_checked[:tag] = e[:tag]
+                element_checked[:target_pointer] = e[:pointer]
+                element_checked[:target_parent_pointer] = e[:parent_pointer]
+                css_code_checked << element_checked
+                p "code_checked " + css_code_checked
+              elsif (e_check.count == 1) || (e_check2.count == 1 && e_check.count == 0)
+                error_count += 1
+
+                # html_errors << new_error(element: e, type: 440, description: "Remember to add the `<#{e[:tag]}>` tag inside `<#{e[:parent]}>`")
+                # p "css code list " + css_code_checked.to_s
+                # if css_code_checked.select {|element| element[:pointer].to_s == tag.pointer_id.to_s }
+                #
+                # end
+              # elsif e_check_exist.count == 1
+              #   html_errors << new_error(element: e, type: 440, description: "Remember to add the `<#{e[:tag]}>` tag inside `<#{e[:parent]}>`")
+              end
+            end
+            # e_check_exist = nil
+          end
+          # if tag
+          # if tag.respond_to? :parent
+          #   p  "check if exists in parent tags"
+          #   p e_check4 = css_code_checked.select {|element| element[:pointer].to_s == e[:pointer].to_s }
+          #   p e_check5 = css_code_checked.select {|element| element[:target_parent_pointer].to_s == e[:parent_pointer].to_s }
+          #  if (tag.count < 2 && tag.first) or (e_check4.count < 1 && e_check5.count < 1)
+          #    if tag.parent.name != e[:parent]
+          #      html_errors << new_error(element: e, type: 440, description: "Remember to add the `<#{e[:tag]}>` tag inside `<#{e[:parent]}>`")
+          #    end
+          #  else
+          #    exist_in_parent = false
+          #    tag.each do |code_css|
+          #      exist_in_parent = true if code_css.parent.name == e[:parent]
+          #    end
+          #    html_errors << new_error(element: e, type: 440, description: "Remember to add the `<#{e[:tag]}>` tag inside `<#{e[:parent]}>`") if !exist_in_parent
+          #   end
+          # end
+          # end
+
+
+          if e_check.count < 1 and e_check2.count < 1
+
+          element_checked = Hash.new
+          element_checked[:pointer] = tag.pointer_id
+          element_checked[:tag] = e[:tag]
+          element_checked[:target_pointer] = e[:pointer]
+          element_checked[:target_parent_pointer] = e[:parent_pointer]
+
+
+         if e[:attribute]
+          #  Check the tag's attributes
+           if tag.attribute(e[:attribute]).nil?
+             html_errors << new_error(element: e, type: 334, description: "`<#{e[:tag]}>` should have an attribute named #{e[:attribute]}")
+           else
+             if tag.attribute(e[:attribute]).value != e[:value]
+                 exist_in_body << false
+                #  p "type " + e[:tag] + " with attribute " + e[:attribute] + " value " + e[:value]
+                # Check if the img have attribute src and value is null, the user can write whatever image he wants
+                 if !(e[:tag] == "img" && e[:attribute] == "src" && e[:value] == "")
+                   error333 = new_error(element: e, type: 333, description: "Make sure that the attribute #{e[:attribute]} in `<#{e[:tag]}>` has the value #{e[:value]}")
+                 end
+             else
+               p "add code_checked"
+               css_code_checked << element_checked
+               exist_in_body << true
+             end
+
+           end
+
+          end #if element checked
+
+         end
+
+
+        #  p "respond" + tag.parent.to_s
+        #  Check that tags exist within parent tags
+        if tag.first.respond_to? :parent
+
+          p  "check if exists in parent tags"
+
+          e_check4 = css_code_checked.select {|element| element[:pointer].to_s == e[:pointer].to_s }
+          e_check5 = css_code_checked.select {|element| element[:target_parent_pointer].to_s == e[:parent_pointer].to_s }
+
+         if (tag.count < 2 && tag.first) or (e_check4.count < 1 && e_check5.count < 1)
+           if tag.first.parent.name != e[:parent]
+             html_errors << new_error(element: e, type: 440, description: "Remember to add the `<#{e[:tag]}>` tag inside `<#{e[:parent]}>`")
+           end
+         else
+           exist_in_parent = false
+           tag.each do |code_css|
+             exist_in_parent = true if code_css.parent.name == e[:parent]
+           end
+           html_errors << new_error(element: e, type: 440, description: "Remember to add the `<#{e[:tag]}>` tag inside `<#{e[:parent]}>`") if !exist_in_parent
+          end
+        end
+
+
+        end
+
+
+       else
+         "pasa else"
+         #  Check that the tag is present
+        #  p "check if exists in parent"
+         e_check4 = css_code_checked.select {|element| element[:pointer].to_s == e[:pointer].to_s }
+         e_check5 = css_code_checked.select {|element| element[:target_parent_pointer].to_s == e[:parent_pointer].to_s }
+          if code.at_css(e[:tag]).nil? or e_check4.count < 1 and e_check5.count < 1
+            html_errors << new_error(element: e, type: 404, description:  "Remember to add the `<#{e[:tag]}>` tag")
+          end
+       end
+
+       if exist_in_body && !exist_in_body.include?(true) && error333
+         html_errors << error333
+       end
+       exist_in_body = []
+
+      end
+      # p "code checked" + css_code_checked.to_s
+      # p "errors = " + error_elements.to_s
+      # # errors_x = error_elements.group_by{|k,v| v}
+      # error_elements.each do |error|
+      #   p error.to_s
+      #   e_check_errors = css_code_checked.select {|element| element[:pointer].to_s == error[:pointer].to_s}
+      #   # p e_check_errors = css_code_checked.select {|element| element[:pointer].to_s == error[:pointer].to_s && element[:target_pointer].to_s == error[:e][:pointer].to_s}
+      #
+      #   # e_check2_errors = css_code_checked.select {|element| element[:target_pointer].to_s == error[:e][:pointer].to_s }
+      #   if e_check_errors.count < 1
+      #     html_errors << new_error(element: error[:e], type: 404, description:  "Remember to add the `<#{error[:e][:tag]}>` tag")
+      #    end
+      # end
+
+      p "count " + error_count.to_s
+     end
+     html_errors
+
+   end
+
+   private
+
+   def add_children(parent)
+     parent.children.each do |child|
+       if child.attribute_nodes.empty?
+          node = Hash.new
+          node[:parent] = parent.name
+          # node[:tag] = child.name
+          if child.name == "#cdata-section"
+            node[:tag] = "text"
+          else
+            node[:tag] = child.name
+          end
+          node[:content] = child.text if !child.text.nil? and child.class!=Nokogiri::XML::Element
+          node[:pointer] = child.pointer_id
+          node[:parent_pointer] = child.parent.pointer_id
+          @elements << node
+       else
+         child.attribute_nodes.each do |element_attribute|
+           node = Hash.new
+           node[:parent] = parent.name
+          #  node[:tag] = child.namecode
+           if element_attribute.name == "#cdata-section"
+             node[:tag] = "text"
+           elsif element_attribute.name == "href"
+             node[:tag] = child.name
+           else
+             node[:tag] = element_attribute.name
+           end
+           node[:attribute] = element_attribute.name if !element_attribute.name.nil?
+           node[:value] = element_attribute.value if !element_attribute.value.nil?
+           node[:pointer] = element_attribute.pointer_id
+           node[:parent_pointer] = child.pointer_id
+           @elements << node
+         end
+       end
+
+       add_children(child) if child.children.any?
+     end
+   end
+
+   def remove_empty_text (reader)
+     if reader.at('head')
+     reader.at('head').children.each do |child|
+       if child.text
+         child.remove if child.content.to_s.squish.empty? && child.class == Nokogiri::XML::Text
+       end
+        check_children(child) if child.children.any?
+     end
+    end
+      if reader.at('body')
+     reader.at('body').children.each do |child|
+       if child.text
+         child.remove if child.content.to_s.squish.empty? && child.class == Nokogiri::XML::Text
+       end
+        check_children(child) if child.children.any?
+     end
+    end
+     reader
+   end
+
+   def check_children(parent)
+     parent.children.each do |child|
+       if child.text
+         child.remove if child.content.to_s.squish.empty? && child.class == Nokogiri::XML::Text
+       end
+       check_children(child) if child.children.any?
+     end
+   end
+
+   def new_error(args = {})
+     element = args[:element]
+     type = args[:type]
+     description = args[:description]
+     node = Hash.new
+     node[:element] = element
+     node[:type] = type
+     node[:description] =  description
+     node
+   end
+
+
+#methods of match
+   def look_comment_or_text(code,e)
+     error330 = nil
+     text_found = false
+     @comment_found = false if e[:tag] == "comment"
+
+     #look for comments or text in code
+     #code, e
+     if code.css(e[:parent]).children.any?
+      #look for comments and text in children of body
+      # code, e
+      #save
+      #return
+      code.css(e[:parent]).children.each do |node_child|
+        #if class of the node is a comment, look in the code
+        # @e, node_child
+        #save error330
+        #return true (flag)
+        if node_child.class == Nokogiri::XML::Comment
+          error330 = new_error(element: e, type: 330, description: "The text inside the comment should be #{e[:content]}") if e[:content].strip != "" && node_child.text.strip! != e[:content].strip!
+          @comment_found = true
+        end
+
+        #if class of node is text and element is not a comment
+        #@e, node_child
+        #save a error330, text_found
+        #return true (flag)
+        if node_child.class == Nokogiri::XML::Text && e[:content] != "comment"
+          node_child.text.strip != e[:content].strip ? error330 = new_error(element: e, type: 330, description: "The text inside `<#{e[:parent]}>` should be #{e[:content]}") : text_found = true
+        end
+      end #each
+
+      else
+         #validate if comment exist and has the expected content in body
+         #code, @e
+         #save @comment_found, text_found
+         if code.css(e[:parent]).text.strip != e[:content].strip
+           if e[:tag] == "comment"
+             error330 = new_error(element: e, type: 330, description: "The text inside the comment should be #{e[:content]}")
+             @comment_found = true
+           else
+             error330 = new_error(element: e, type: 330, description: "The text inside `<#{e[:parent]}>` should be #{e[:content]}")
+           end
+          else
+            text_found = true
+          end
+       end #end if parent has children
+
+       #throw errors of comment or text
+       #if comment not found, throw error
+        if (defined? @comment_found) && !@comment_found
+          @html_errors << new_error(element: e, type: 404, description:  "Remember to add the comment tag")
+          remove_instance_variable(:@comment_found) if !@comment_found
+        end
+
+       if !text_found && error330
+         @html_errors << error330
+         error330 = nil
+       end
+       #end throw errors
+   end #end look_comment_or_text
+
+   def look_parent_text(code,e)
+     exist = false
+     #look for text in parent, if found check flag true
+     code.css(e[:parent]).each do |code_css|
+       if code_css.text == e[:content]
+         exist = true
+       end
+     end
+     if !exist
+      @html_errors << new_error(element: e, type: 330, description: "The text inside `<#{e[:parent]}>` should be #{e[:content]}")
+     end
+   end
+
+
+  #end
+
+end

data/lib/code_terminator/version.rb

@@ -1,3 +1,3 @@
 module CodeTerminator
-  VERSION = "0.5.2"
+  VERSION = "0.5.3"
 end