Class: CodeTerminator::Html

Inherits:
Object
  • Object
show all
Defined in:
lib/code_terminator/html.rb,
lib/code_terminator/html2.rb

Instance Method Summary collapse

Constructor Details

#initialize(args = {}) ⇒ Html

Returns a new instance of Html.



5
6
7
8
9
10
11
12
13
 
# File 'lib/code_terminator/html.rb', line 5

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

Instance Method Details

#get_elements(source) ⇒ Object

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)



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/code_terminator/html.rb', line 49

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

#get_instructions(source) ⇒ Object

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)



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/code_terminator/html.rb', line 252

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(source, code) ⇒ Object

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)



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/code_terminator/html.rb', line 289

def match(source, code)
  @html_errors = Array.new
  html_errors = @html_errors

  code = Nokogiri::HTML(code)

  elements = get_elements(source)


  exist_in_body = Array.new

  error_elements = Array.new

  elements_count = Array.new

  error333 = nil

  #lista de relaciones entre tags y elementos
  css_code_checked = Array.new


  elements.each do |e|

    if elements_count.select {|element| element[:parent_pointer].to_s == e[:parent_pointer].to_s && element[:tag].to_s == e[:tag]}.count < 1
      error_element = Hash.new
      error_element[:tag] = e[:tag]
      error_element[:pointer] = e[:pointer]
      error_element[:parent_pointer] = e[:parent_pointer]
      error_element[:count] = 0
      elements_count << error_element
    end

    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

    code.css(e[:tag]).each do |tag|
      tag_element = nil
      e_check = css_code_checked.select {|element| element[:original_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 }

      #original_pointer es el pointer del elemento e[]
      #busca si el original_pointer esta en la lista de relaciones
      #busca si el pointer del tag esta en la lista de relaciones
      #cuando un original pointer o un pointer esta en la lista de relaciones, ya no puede volver a ser ingresado en la lista
      #si el original pointer ya esta en la lista de relaciones, ya no es necesario volver a checarlo
      check_original_pointer = css_code_checked.select {|element| element[:original_pointer].to_s == e[:pointer].to_s }

      check_add_pointer = css_code_checked.select {|element| element[:pointer].to_s == tag.pointer_id.to_s }

      #look for same tags in code
      if check_original_pointer.count == 0
        if check_add_pointer.count < 1
          element_checked = Hash.new
          element_checked[:pointer] = tag.pointer_id
          element_checked[:tag] = e[:tag]
          element_checked[:original_pointer] = e[:pointer]
          element_checked[:original_parent_pointer] = e[:parent_pointer]
          css_code_checked << element_checked

          error_element = elements_count.select {|element| element[:tag].to_s == e[:tag].to_s && element[:parent_pointer].to_s == e[:parent_pointer].to_s}.first
          error_element[:count] += 1
        end
      end
     #  end
     # p "checked = " + elements_count.to_s

    if code.css(e[:tag]).length > 0

      #tag es el elemento reccorrido en el codigo
      #e es el elemento original
      #elementscount son los elementos que existen en codigo y original

     #  if tag_element
      if e[:attribute]

       #  p "e --- " + e[:tag].to_s
       #  p "e pt--- " + e[:pointer].to_s
       #  p "e parent pt--- " + e[:parent_pointer].to_s
       #  p "e attribute --- " + e[:attribute].to_s


       #  if tag.attribute(e[:attribute])
         #  p "elements count = " + css_code_checked.to_s
          tag_element = css_code_checked.select {|element| element[:pointer].to_s == tag.pointer_id.to_s && element[:original_pointer] == e[:pointer] }.first
         #  p "tag --" + tag.name.to_s
         #  p "tag --" + tag.to_s
         #  p "tag parent -- " + tag.parent.name.to_s
         #  p "tag pointer -- " + tag.pointer_id.to_s
         #  p "tag parent pointer -- " + tag.parent.pointer_id.to_s
         #  p "tag attribute -- " + tag.attribute(e[:attribute]).to_s
         #   p "parent_element --- " + tag_element.to_s
       #  else
         # end

       #  Check the tag's attributes
       if tag.attribute(e[:attribute]).nil?
         if tag_element
         #  p "attribute element " + e[:attribute].to_s
         #  p "attribute tag " + tag.attribute(e[:attribute]).name.to_s
         #  if e[:attribute] != tag.attribute(e[:attribute]).name
            html_errors << new_error(element: e, type: 334, description: "`<#{e[:tag]}>` should have an attribute named #{e[:attribute]}")
         #  end
        end
        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


     #  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)
        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

   end

 end

   # end #end tag


    if exist_in_body && !exist_in_body.include?(true) && error333
      html_errors << error333
    end
    exist_in_body = []

   end

  end

 #  p elements_count.to_s

  elements_count.each do |x|
    #filtrar por parent
    # tag_count = code.css(x[:tag]).length
    tag_count = elements.select {|element| element[:parent_pointer].to_s == x[:parent_pointer].to_s && element[:tag].to_s == x[:tag]}.count
   #  p x[:tag]!="body"
    if tag_count >= 1 && !(x[:tag]=="body" || x[:tag]=="head" || x[:tag]=="text" || x[:tag]=="comment" || x[:tag]=="img")
   # if tag_count >= 1 && !(x[:tag]!="div")
      if x[:count] < tag_count
        html_errors << new_error(element: x[:tag], type: 404, description:  "Remember to add the `<#{x[:tag]}>` tag")
      end
    end
  end

  html_errors

end

#new_file(source, code) ⇒ Object

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)



25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/code_terminator/html.rb', line 25

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

#print_elements(elements) ⇒ Object

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)



230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/code_terminator/html.rb', line 230

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

#read_file(source) ⇒ Object

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)



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/code_terminator/html.rb', line 199

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

#validate_syntax(code) ⇒ Object

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)



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/code_terminator/html.rb', line 162

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