html_cs_run_parse 0.0.6 → 0.1.1

data/lib/html_compilation/classes/setup/output_generation.rb

@@ -0,0 +1,21 @@
+$:.unshift File.dirname(__FILE__) + '/../../modules'
+$:.unshift File.dirname(__FILE__) + '/../builders'
+require 'image_interaction'
+require 'html_builder'
+require 'page_html'
+require 'app_html'
+require 'row_html'
+class OutputGeneration
+  include ImageInteraction
+
+  def initialize(app, ddl = "./data/output/files/")
+    app.graph.populate_graph
+    app.pages.each do |page|
+      place_image_content(ddl + page.page, page.image)
+    end
+    app_html = AppHTML.new(app)
+    html = app_html.build
+    place_image_content(ddl.split("files/")[0] + "pa11y_" + app.application_name + '_' + app.env, html, ".html")
+    #put html in the output folder need to remove files from ddl
+  end
+end

data/lib/html_compilation/classes/setup/retrieval.rb

@@ -0,0 +1,90 @@
+$:.unshift File.dirname(__FILE__) + '/../../modules'
+require 'image_interaction'
+class Retrieval
+  include ImageInteraction
+  attr_accessor(:ddl)
+
+  def initialize(ddl)
+    @ddl = ddl
+  end
+
+  def retrieve_csv_collection
+    output = []
+    file_locations = return_all_files(ddl, 'csv')
+    file_locations.each do |file_location|
+      t_output = []
+      File.open(file_location, 'r') { |file|
+        content = file.read
+        split = content.split("\n")
+        split.delete_at(0)
+        split.each do |row|
+          components = row.split(',')
+          csv_o = CSVObject.new(components[0].tr('"', ''), components[1], components[2], components[3], components[4])
+          t_output.push(csv_o)
+        end
+        output.push(t_output)
+      }
+    end
+    output
+  end
+
+  def retrieve_url_collection
+    output = []
+    file_locations = return_all_files(ddl, 'txt')
+    file_locations.each do |file_location|
+      File.open(file_location, 'r') { |file|
+        output.push(file.read) }
+    end
+    output
+  end
+
+  def retrieve_image_collection
+    output = []
+    file_locations = return_all_files(ddl, 'png')
+    file_locations.each do |file_location|
+      File.open(file_location, 'r') { |file|
+        output.push(retrieve_image_content(file)) }
+    end
+    output
+  end
+
+  def retrieve_app_name
+    file = return_all_files(ddl, 'csv')[0]
+    split = split_on_underscores(file)
+    split[0]
+  end
+
+  def retrieve_page_names
+    files = return_all_files(ddl, 'csv')
+    output = []
+    files.each do |file|
+      output.push(split_on_underscores(file)[1])
+    end
+    output
+  end
+
+  def retrieve_env
+    file = return_all_files(ddl, 'csv')[0]
+    split = split_on_underscores(file)
+    split[2].split('.')[0]
+  end
+
+  private
+
+  def split_on_underscores(file)
+    file.split('/').last.split('_')
+  end
+
+end
+
+class CSVObject
+  attr_accessor(:error_warning, :guideline, :error_description, :html_path, :content)
+
+  def initialize(error_warning, guideline, error_description, content, html_path)
+    @error_warning = error_warning
+    @guideline = guideline
+    @error_description = error_description
+    @content = content
+    @html_path = html_path
+  end
+end

data/lib/html_compilation/classes/setup/setup.rb

@@ -0,0 +1,83 @@
+$:.unshift File.dirname(__FILE__) + '/../struct_classes'
+$:.unshift File.dirname(__FILE__) + '/../setup'
+$:.unshift File.dirname(__FILE__) + '/../objects'
+require 'score_collection'
+require 'retrieval'
+require 'page'
+require 'row'
+class Setup
+  attr_accessor(:csv_collection, :url_collection, :image_collection, :app_name, :page_name_collection, :env, :score_collection)
+
+  def initialize(file_location = "./data/input")
+    rt = Retrieval.new(file_location)
+    @csv_collection = rt.retrieve_csv_collection
+    @url_collection = rt.retrieve_url_collection
+    @image_collection = rt.retrieve_image_collection
+    @app_name = rt.retrieve_app_name
+    @page_name_collection = rt.retrieve_page_names
+    @env = rt.retrieve_env
+  end
+
+  def main_setup(app, file_prefix = "./data")
+    app_initial_setup(app)
+    pages = page_initial_setup
+    app_additional_setup(app, pages)
+    pages.each_with_index do |page, index|
+      rows = row_initial_setup(index)
+      row_additional_setup(rows, file_prefix + "/scores.yaml")
+      page_additional_setup(app, page, rows, file_prefix + "/suppressed_rules.yaml")
+    end
+  end
+
+  def row_initial_setup(index)
+    output = []
+    @csv_collection[index].each do |csv|
+      @row = Row.new
+      @row.set_value("error_warning", csv.error_warning)
+      @row.set_value("guideline", csv.guideline)
+      @row.set_value("error_description", csv.error_description)
+      @row.set_value("html_path", csv.html_path)
+      @row.set_value("content", csv.content)
+      output.push(@row)
+    end
+    output
+  end
+
+  def app_initial_setup(app)
+    app.set_value("application_name", app_name)
+    app.set_value("env", env)
+  end
+
+  def page_initial_setup
+    counter = 0
+    output = page_name_collection.map do |page_name|
+      page = Page.new
+      page.set_value("page", page_name)
+      page.set_value("url", url_collection[counter])
+      page.set_value("image", image_collection[counter])
+      counter += 1
+      page
+    end
+    output
+  end
+
+  def row_additional_setup(rows, ddl = "./data/scores.yaml")
+    @score_collection = ScoreCollection.new(ddl)
+    rows.each do |row|
+      row.calculate_score_value(@score_collection)
+    end
+  end
+
+  def app_additional_setup(app, pages)
+    app.set_value("pages", pages)
+  end
+
+  def page_additional_setup(app, page, rows, psr_location = "./data/suppressed_rules.yaml")
+    page.set_value("rows", rows)
+    score = page.calc_page_score
+    page.set_value("score", score)
+    page.set_value("app", app)
+    page.access_spr(psr_location)
+  end
+
+end

data/lib/html_compilation/classes/struct_classes/score_collection.rb

@@ -0,0 +1,33 @@
+$:.unshift File.dirname(__FILE__) + '/../../modules'
+require 'yaml_interaction'
+class ScoreCollection
+  include YAMLInteraction
+  attr_accessor(:guidelines)
+
+  def initialize(ddl="./data/scores.yaml")
+    send("guidelines=", get_guidelines(ddl))
+  end
+
+  def get_guidelines(ddl)
+    output = []
+    collections = read_yaml(ddl, "GUIDELINES")
+    collections.each do |key, value|
+      score = read_yaml(ddl, "SCORES")[key]
+      value.each do |guideline|
+        temp = ScoreElement.new(key, score, guideline)
+        output.push(temp)
+      end
+    end
+    output
+  end
+end
+
+class ScoreElement
+  attr_accessor(:guideline, :score, :categorization)
+
+  def initialize(categorization, score, guideline)
+    send("guideline=", guideline)
+    send("categorization=", categorization)
+    send("score=", score)
+  end
+end

data/lib/html_compilation/classes/struct_classes/suppressed_page_rules.rb

@@ -0,0 +1,8 @@
+class SuppressedPageRules
+  attr_accessor(:guideline, :content)
+
+  def initialize(guideline, content)
+    send("guideline=", guideline)
+    send("content=", content)
+  end
+end

data/lib/html_compilation/data/html_data/app_data.yaml

@@ -0,0 +1,39 @@
+APPLICATION:
+
+#includes everything
+HTML: "<html>sample</html>"
+
+# Style sheet goes here
+
+#goes in HTML
+APPLICATION_TITLE_SECTION: "<h1 id=\"page_header\">sample</h1>"
+
+#goes in HTML, holds all other content. including page content
+HTML_BODY: "<body id=\"whole body\">sample</body>"
+
+#goes in HTML body
+APPLICATION_OVERVIEW_SECTION: "<div id=\"application_overview_section\">sample</div>"
+
+#goes in application overview section
+CHART_IMAGE: '<img src=".\files\chart.png" alt="tracking chart" id="chart_image">'
+
+#goes in application overview section
+APPLICATION_OVERVIEW_TABLE_SECTION: "<div id=\"application_overview_table_section\">sample</div>"
+
+#goes in application overview table section
+APPLICATION_DATA_SECTION: "<table id=\"application_overview_information_table\">
+                                         <tbody id=\"application_overview_information_table_body\">
+                                         <tr>
+                                             <th>Application Score</th>
+                                             <th>Number of Errors</th>
+                                             <th>Number of Pages</th>
+                                         </tr>
+
+                                             sample
+
+                                         </tbody>
+                                     </table>"
+
+
+
+APPLICATION_DATA_ROW: "<td>sample</td>"

data/lib/html_compilation/data/html_data/page_data.yaml

@@ -0,0 +1,37 @@
+##OPTIONAL VALUES
+PAGE_IMAGE: '<img src=".\files\sample.png" class="content_image">'
+PAGE_URL: "<h1 class=\"url-for-page\">URL: sample</h1>"
+PAGE_SUPPRESSED_RULES_AREA: "<table class=\"page_suppressed_rules_table\">
+                                               <tbody class=\"page_suppressed_rules_table_body\">
+                                               <tr>
+                                                   <th><strong>Suppressed Page Rules</strong></th>
+                                               </tr>
+                                               sample
+                                               </tbody> </table>"
+PAGE_SUPPRESSED_RULES_TABLE_VALUES: "<tr><td>sample</td></tr>"
+
+
+##LIST SECTION
+COLLAPSIBLE_LIST_SECTION: "<div class=\"collapsible-list\">sample</div>"
+COLLAPSIBLE_BUTTON: "<button class=\"collapsible\">
+                               <Strong>Sample Page Name</Strong>
+                               <strong>Total Number of Errors = </strong> sample total number of errors
+                               <strong>Page Score = </strong>sample page score
+                           </button>"
+
+
+CONTENT: "<div class=\"content\"> sample </div>"
+PAGE_INFO: "<div class=\"content_image_and_suppressed_rules_area\"> sample </div>"
+
+WARNING_LIST_AREA: "<div class=\"warning_list_area_div\">
+                               <table class=\"warning_list_item_table\">
+                                   <tbody class=\"warning_list_table_body\">
+                                   <tr>
+                                    header_sample
+                                   </tr>
+                                   rows_sample
+                                   </tbody>
+                               </table>
+                           </div>"
+
+WARNING_LIST_HEADERS: "<th>sample</th>"

data/lib/html_compilation/data/html_data/row_data.yaml

@@ -0,0 +1,4 @@
+TR: "<tr>sample</tr>"
+TD: "<td>sample</td>"
+
+

data/lib/html_compilation/data/html_data/style_script.yaml

@@ -0,0 +1,167 @@
+SCRIPT: "<script>
+                 var coll = document.getElementsByClassName(\"collapsible\");
+                 var i;
+
+                 for (i = 0; i < coll.length; i++) {
+                     coll[i].addEventListener(\"click\", function () {
+                         this.classList.toggle(\"active\");
+                         var content = this.nextElementSibling;
+                         if (content.style.display === \"block\") {
+                             content.style.display = \"none\";
+                         } else {
+                             content.style.display = \"block\";
+                         }
+                     });
+                 }
+
+                 </script>"
+
+STYLE: "<style>
+               /*page header section*/
+               #page_header {
+                   display: block;
+                   text-align: center;
+                   font-family: Apex New Bold, sans-serif;
+                   font-weight: bold
+               }
+
+               /*application overview section*/
+               #application_overview_section {
+                   display: block;
+                   padding-top: 10px
+               }
+
+               #chart_image {
+                   margin-left: auto;
+                   margin-right: auto;
+                   display: inline-block;
+                   width: 47%;
+                   padding-bottom: 10px
+               }
+
+               #application_overview_table_section {
+                   display: inline;
+                   margin-bottom: 10px;
+                   font-family: Apex New Bold, sans-serif;
+               }
+
+               #suppressed_application_errors_table {
+                   border-color: #5ba63c;
+                   display: inline-block;
+                   padding-top: 10px;
+                   width: 49%;
+                   vertical-align: top;
+               }
+
+               #suppressed_application_errors_table_body {
+                   display: block;
+                   overflow-y: scroll;
+                   height: 70px
+               }
+
+               #application_overview_information_table {
+                   display: inline-block;
+                   border-color: #5ba63c;
+                   padding-top: 10px;
+                   width: 49%;
+                   vertical-align: top;
+               }
+
+               #application_overview_information_table_body {
+                   display: inline-block;
+                   height: 70px;
+               }
+               /*Collapsible Section*/
+               .collapsible {
+                   background-color: #ffffff;
+                   color: black;
+                   cursor: pointer;
+                   padding: 18px;
+                   width: 100%;
+                   text-align: left;
+                   outline: none;
+                   font-size: 15px;
+                   font-family: Apex New Bold, sans-serif;
+               }
+
+               .active, .collapsible:hover {
+                   background-color: #ADEFD1FF;
+               }
+
+               .collapsible-list {
+                   position: static;
+                   font-family: Apex New Bold, sans-serif;
+                   border-color: #F0EAD6;
+                   border-style: solid;
+                   border-width: thick;
+                   border-collapse: collapse;
+               }
+               /*Collapsible Content Section*/
+               .content {
+                   padding: 18px;
+                   display: none;
+                   overflow: hidden;
+                   background-color: #F0EAD6;
+               }
+               /*Collapsible Content image and suppressed rules Section*/
+               .content_image_and_suppressed_rules_area {
+                   width: 100%;
+                   display: block;
+               }
+
+               .url-for-page {
+                   font-size: 18px;
+                   font-family: Apex New Bold, sans-serif;
+               }
+
+               .content_image {
+                   display: inline-block;
+                   margin-left: auto;
+                   margin-right: auto;
+                   width: 100%;
+               }
+
+               .page_suppressed_rules_table {
+                   display: inline-block;
+                   vertical-align: top;
+                   border-collapse: collapse;
+                   padding-left: 1%;
+                   width: 50%
+
+               }
+
+               .page_suppressed_rules_table_body {
+                   display: block;
+                   width: 100%
+               }
+
+               .warning_list_area_div {
+                   display: block;
+                   width: 100%;
+                   overflow-x: scroll;
+               }
+
+               .warning_list_table_body {
+                   display: block;
+                   border-collapse: collapse;
+
+               }
+
+               .warning_list_item_table {
+               table-layout:fixed;
+               }
+
+
+               .warning_list_table_body > tr {
+                   border-style: solid;
+             }
+
+
+               .warning_list_table_body > tr > td {
+                   border-style: solid;}
+
+
+               </style>"
+
+
+