code_terminator 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb222ada4193c60d08123b1900f179726f553925
-  data.tar.gz: fc52fc8bf422eecbecbd7280cde9112bb1f74d5a
+  metadata.gz: f709b570130343716bc93ce9ad74de6d0a2bfaeb
+  data.tar.gz: af32895544dd05949969cd09f79b6c743ef156e5
 SHA512:
-  metadata.gz: 6570122173a590de2f18728120685cc9714309e704f125f0b9753cccd0b24aecce99bd7b61f804a3b8eb0bb41a0353827ad243f4fe0ddbccc51f1a60a126319b
-  data.tar.gz: 9d1b5f40d43e1bac788a4dcdf0ce59c25720a6c61a9808c0782a0a6af8ad79776adb93b159d4125832473e50c847ef3b135b9f43865abfb38cb3395b3b128529
+  metadata.gz: a01842f4e2424e9389e71bde81fee7f8adacee5880e4f4737eed63b7c18ed16f35af02636656c1f4db8434164e9970e64030252cf1f875690a5f591334124df2
+  data.tar.gz: d40385534ee5461634abfc4bb542cff6f1f4a11d532e77883b4a75395fb7b524950d587d7e673db7c5bdf16076888e85194b2cf94d63febc44ffbb80c134635d

data/Gemfile

@@ -10,6 +10,8 @@ gem 'rails', '4.2.6'
 # gem 'therubyracer', platforms: :ruby
 gem  'html5_validator'
 gem  'nokogiri'
+gem  'crass'
+gem  'css_parser'
 
 # Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
 gem 'jbuilder', '~> 2.0'

data/README.md

@@ -1,8 +1,12 @@
 # CodeTerminator
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/code_terminator`. To experiment with that code, run `bin/console` for an interactive prompt.
+CodeTerminator is a gem that helps to <strike>exterminate Sarah Connor</strike> parse, evaluate and compare html code. Also is useful when you need to check html code syntaxis.
 
-TODO: Delete this and the text above, and describe your gem
+##Features
+<ul>
+<li>HTML parser </li>
+<li>CSS parser (Coming soon)</li>
+</ul>
 
 ## Installation
 
@@ -20,9 +24,88 @@ Or install it yourself as:
 
     $ gem install code_terminator
 
-## Usage
+## Quick Start
+
+To parse HTML and match the file with html code you just need to do:
+```ruby
+    # code = code get from an editor
+    # source = Source of the file you want to compare with
+    
+    # First, validate syntasis of the code
+    ct = CodeTerminator::Html.new
+    errors = ct.validate_syntax(code)
+    result << errors[0]
+    
+    # If code do't have errors, match the code with your html file
+    if errors.empty?
+      result = ct.match(source, code)
+    end
+```
+If the code and the source mismatch,  `ct.match()`  will return an array with the differences between code and source file.
+You will know that the code and the source file have the same html elements when the `ct.match()` return a nil array.
+
+```ruby
+	# hola_mundo.html
+	# 	<h1>Hola Mundo!</h1>
+	#
+    >> CodeTerminator::Html.match("hola_mundo.html","<h2>Hola Mundo!</h2>")
+    #   => ["h1 not exist"]
+```
+
+##Cheat Sheet
+
+###match(source, code)
+Match if the code have the same elements than the exercise. Return an array with the mismatches.
+
+```ruby
+   #   hola_mundo.html
+   # => <h1>Hola Mundo!</h1>
+```
+```ruby
+   CodeTerminator::Html.match("hola_mundo.html","<h2>Hola Mundo!</h2>")
+   #   => ["h1 not exist"]
+   #
+```
+###new_file(source, code)
+Create a Html file with the code of the editor. Return a boolean that indicate if the file was created or not.
+```ruby
+    CodeTerminator::Html.new_file("hola_mundo.html", "<h1>Hola Mundo!</h1>")
+    #   => true
+```
+###read_file(source)
+Read a html file. Return the text of the file.
+```ruby
+    CodeTerminator::Html.read_file("hola_mundo.html")
+     #   => "<h1>Hola Mundo!</h1>"
+```
+
+###validate_syntax(code)
+Validate if the syntax is correct. Return an array with Nokogiri errors.
+```ruby
+   CodeTerminator::Html.validate_syntax("<h1>Hola Mundo!</h1")
+     #   => [#<Nokogiri::XML::SyntaxError: expected '>'>]
+```
+  
+###get_elements(source)
+Get html elements of a html file. Return a list of Nokogiri XML objects.
+```ruby
+    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!">]
+```
+
+###print_elements(Elements Array)
+Get the elements of the code in html format. Return a string with elements in html.
+<br>
+**Get 'Elements Array' calling 'get_elements()'
+```ruby
+     CodeTerminator::Html.print_elements([#<Nokogiri::XML::Element:0x3fe31dc42bfc name="h1" children=[#<Nokogiri::XML::Text:0x3fe31dc42b70 "hola mundo">]>, #<Nokogiri::XML::Text:0x3fe31dc42b70 "hola mundo">])
+     #   => "name = h1<br><hr>name = text<br>content = hola mundo<br><hr>"
+     #
+```
+
+##Example
+An example of an editor using CodeTerminator is available at https://github.com/eponce19/editor_terminator.git
 
-TODO: Write usage instructions here
 
 ## Development
 
@@ -32,7 +115,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/code_terminator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/eponce19/code_terminator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License

data/code_terminator.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Evelin Ponce"]
   spec.email         = ["eponce19@gmail.com"]
 
-  spec.summary       = "Validate syntaxis and instructions of html code"
-  spec.description   = "Helps to evaluate and parse html code."
+  spec.summary       = "Validate syntaxis and instructions of html and css code"
+  spec.description   = "Helps to evaluate and parse html and css code."
   spec.homepage      = 'http://rubygems.org/gems/code_terminator'
   spec.license       = "MIT"
 
@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest"
+
 end

data/exercises/test.css

@@ -0,0 +1,2 @@
+body {
+    background-color: lightblue; }

data/lib/code_terminator/css.rb

@@ -0,0 +1,196 @@
+require 'Nokogiri'
+require 'Crass'
+require 'css_parser'
+require 'active_support/core_ext/string/filters'
+
+class CodeTerminator::Css
+
+  def initialize(args = {})
+    @code = args[:code]
+    @source = args[:source]
+    @tags = Array.new
+  end
+
+    # Create a CSS file with the code of the editor. Return a boolean that indicate if the file was created or not.
+    #
+    # Example:
+    #   >> CodeTerminator::Css.new_file("test.css", "<style> body { background-color: lightblue; }</style>")
+    #   => true
+    #
+    # Arguments:
+    #   source: (String)
+    #   code: (String)
+
+   def new_file(source,code)
+     fileCss = File.new(source, "w+")
+     result = true
+     begin
+       fileCss.puts code
+     rescue
+       result = false
+     ensure
+       fileCss.close unless fileCss.nil?
+     end
+     #return true if file was succesfully created
+     result
+   end
+
+
+     # Get html elements of a css file. Return a array of selectors with their properties and values.
+     #
+     # Example:
+     #   >> CodeTerminator::Css.get_elements("test.css")
+     #   => [{:selector=>"body"}, {:selector=>"body", :property=>"background-color", :value=>"lightblue"}, {:selector=>"body", :property=>"color", :value=>"green"}]
+     #
+     # Arguments:
+     #   source: (String)
+     #
+     # Fixes:
+     #   IMPORTANT DELETE <STYLE> tag from the source
+
+
+   def get_elements(source)
+      reader = read_file(source)
+      parser = Crass.parse(reader)
+      errors = parser.pop
+      p errors
+      elements = Array.new
+      selector = ""
+
+      parser.each do |node|
+        if !node[:selector].nil?
+          selector = node[:selector][:value]
+          elements << {:selector => selector}
+        end
+        if !node[:children].nil?
+          node[:children].each do |children|
+            if children.has_value?(:property)
+              elements << {:selector => selector, :property => children[:name], :value => children[:value]}
+            end
+          end
+        end
+      end
+      elements
+   end
+
+     # Validate if the syntax is correct. If is valid return boolean true.
+     #
+     # Example:
+     #   >> CodeTerminator::Html.validate_syntax("body { background-color: lightblue; }")
+     #   => true
+     #
+     # Arguments:
+     #   code: (String)
+     #
+     # Fixes:
+     #   IMPORTANT Method not validate <STYLE> tag from the code
+
+   def validate_syntax(code)
+     valid = true
+     tree = Crass.parse(code)
+      last = tree.length
+       tree[last-1][:children].each do |children|
+        if children[:node].to_s == "error"
+         valid = false
+        end
+       end
+      valid
+   end
+
+     # Read a css file. Return a string with the text of the file.
+     #
+     # Example:
+     #   >> CodeTerminator::Css.read_file("test.css")
+     #   => "body { background-color: lightblue; }"
+     #
+     # Arguments:
+     #   source: (String)
+
+   def read_file(source)
+     fileCss = File.open(source, "r")
+     text = ""
+     begin
+       fileCss.each_line do |line|
+         text << line
+       end
+       fileCss.close
+     rescue
+       text = false
+     ensure
+       #fileHtml.close unless fileHtml.nil?
+     end
+
+     text
+   end
+
+     # Get the elements of the code in css format. Return a string with elements in css.
+     #
+     # Example:
+     #   >> CodeTerminator::Css.print_elements([{:selector=>"body"}, {:selector=>"body", :property=>"background-color", :value=>"lightblue"}] )
+     #   => "selector = body<br><hr>selector = body<br>property = background-color<br>value = lightblue<br><hr>"
+     #
+     # Arguments:
+     #   elements: (Array)
+
+
+   def print_elements(elements)
+     text = ""
+     elements.each do |child|
+       text << "selector = " + child[:selector] + "<br>"
+       text << "property = " + child[:property] + "<br>" if !child[:property].nil?
+       text << "value = " + child[:value] + "<br>" if !child[:value].nil?
+       text << "<hr>"
+     end
+     text
+   end
+
+
+   # Match if the code have the same elements than the exercise. Return an array with the mismatches.
+
+   # Example:
+   #
+   #   test.css
+   #   => body { background-color: lightblue; }
+   #
+   #   >> CodeTerminator::Css.match("test.css","body {background-color: blue; }")
+   #   => ["not the same property background-color in selector body "]
+   #
+   # Arguments:
+   #   source: (String)
+   #   code: (String)
+   #
+   # Fix: Add <style> tag in the compare
+
+   def match(source,code)
+     #source = "exercises/test.css"
+     #code = " a.hover { color: yellow; } body { background-color: lightblue; color: blue; } "
+     elements = get_elements(source)
+     css_errors = Array.new
+     parser = CssParser::Parser.new
+
+     parser.load_string!(code)
+     elements.each do |e|
+       item = e[:selector]
+       if !e[:property].nil?
+         property = e[:property] + ": " + e[:value]
+         parser_array = parser.find_by_selector(item)
+         if parser_array.any?
+           parser_property = parser_array[0].split(";")
+           parser_property.each {|a| a.strip! if a.respond_to? :strip! }
+           if !parser_property.include?(property)
+             css_errors << "not the same property " + property + " in selector " + item
+           end
+         else
+          css_errors << "property "+ property + " not found in " + item
+         end
+       end
+     end
+     css_errors
+   end
+
+   private
+
+
+  #end
+
+end

data/lib/code_terminator/html.rb

@@ -119,8 +119,8 @@ class CodeTerminator::Html
      # Get the elements of the code in html format. Return a string with elements in html.
      #
      # Example:
-     #   >> CodeTerminator::Html.print_elements([#<Nokogiri::XML::Element:0x3fe31dc42bfc name="h1" children=[#<Nokogiri::XML::Text:0x3fe31dc42b70 "hola evelin">]>, #<Nokogiri::XML::Text:0x3fe31dc42b70 "hola evelin">])
-     #   => "name = h1<br><hr>name = text<br>content = hola evelin<br><hr>"
+     #   >> CodeTerminator::Html.print_elements([#<Nokogiri::XML::Element:0x3fe31dc42bfc name="h1" children=[#<Nokogiri::XML::Text:0x3fe31dc42b70 "hola mundo">]>, #<Nokogiri::XML::Text:0x3fe31dc42b70 "hola mundo">])
+     #   => "name = h1<br><hr>name = text<br>content = hola mundo<br><hr>"
      #
      # Arguments:
      #   elements: (Array)

data/lib/code_terminator/version.rb

@@ -1,3 +1,3 @@
 module CodeTerminator
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/code_terminator.rb

@@ -1,5 +1,6 @@
 require "code_terminator/version"
 require "code_terminator/html"
+require "code_terminator/css"
 
 module CodeTerminator
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_terminator
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Evelin Ponce
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-17 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Helps to evaluate and parse html code.
+description: Helps to evaluate and parse html and css code.
 email:
 - eponce19@gmail.com
 executables:
@@ -73,12 +73,15 @@ files:
 - code_terminator-0.1.0.gem
 - code_terminator-0.1.1.gem
 - code_terminator-0.1.2.gem
+- code_terminator-0.1.3.gem
 - code_terminator.gemspec
 - exe/code_terminator
 - exercises/new.html
 - exercises/new2.html
+- exercises/test.css
 - exercises/test.html
 - lib/code_terminator.rb
+- lib/code_terminator/css.rb
 - lib/code_terminator/html.rb
 - lib/code_terminator/version.rb
 homepage: http://rubygems.org/gems/code_terminator
@@ -104,5 +107,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Validate syntaxis and instructions of html code
+summary: Validate syntaxis and instructions of html and css code
 test_files: []