origen_doc_helpers 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf34c91d486dacbfe803df15a92f61e2ee123721
-  data.tar.gz: 36464708c9f146c5bb996b61fda903fb762835ff
+  metadata.gz: ee3e3f947570dd8db7cd7eeca0321269b048e832
+  data.tar.gz: 3674401952587d0d7a14421b205935b6dcafc44b
 SHA512:
-  metadata.gz: f245397db0e418b8ec7cf6d2d64aead841829301867fffbe4dc38397aa6a3f2d4be23927eb18a6f443b8ae5f8a2d00c0d43c68a5c40876d6b5baedc6710fed53
-  data.tar.gz: 672d1a50f6cbce7a43364de6ea8d84af5cd9b0907f88bf9a552510e4658c287dd32d378a882b5551d42db61eeece9492f349dad356ac64271924c5874fd2b6f8
+  metadata.gz: 2999b9c681e79d2625cb9c4f2c1eccda196573d7a68357d29adad24a25a34cd4d577541d26bef76932ab6d9b4e4ee46f38112973f480cc745b1690e88acd92ee
+  data.tar.gz: bb1b457ffa445709a35f91a05f8d0181c4cab356cbde177dfb803193ec2e5c8dac87ef8b51281be56fbdb4a4dccd11207ca65434e20085f1977f8f12a8f4de74

data/config/environment.rb

@@ -26,5 +26,7 @@
 #require "#{Origen.root}/c90_top_level/p2"
 module OrigenDocHelpers
   autoload :PDF, "origen_doc_helpers/pdf"
+  autoload :HtmlFlowFormatter, "origen_doc_helpers/html_flow_formatter"
+  autoload :ListFlowFormatter, "origen_doc_helpers/list_flow_formatter"
 end
 require "helpers"

data/config/version.rb

@@ -1,7 +1,7 @@
 module OrigenDocHelpers
   MAJOR = 0
-  MINOR = 2
-  BUGFIX = 1
+  MINOR = 3
+  BUGFIX = 0
   DEV = nil
 
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')

data/lib/helpers.rb

@@ -178,29 +178,36 @@ END
             flow[:soft_bin] || flow[:softbin]
           end
 
-          def _start_accordion(heading, _options = {})
+          def _start_accordion(heading, options = {})
+            options = {
+              panel: :default
+            }.merge(options)
             @_accordion_index ||= 0
             @_accordion_index += 1
             <<-END
-<div class="panel panel-default">
-<a href="#_" class="expandcollapse btn btn-xs pull-right btn-default" state="0"><i class='fa fa-plus'></i></a>
-<div class="panel-heading clickable" style="background:whitesmoke" data-toggle="collapse" data-parent="#blah2" href="#collapseAccordion#{@_accordion_index}">
-<a class="no-underline">
+
+
+<div class="panel panel-#{options[:panel]}">
+<a href="#_" class="expand-collapse-switch btn btn-xs pull-right btn-default" state="0"><i class='fa fa-plus'></i></a>
+<div class="panel-heading clickable" data-toggle="collapse" data-parent="#blah2" href="#collapseAccordion#{@_accordion_index}">
 #{heading}
-</a>
 </div>
 <div id="collapseAccordion#{@_accordion_index}" class="panel-collapse collapse">
 <div class="panel-body" markdown="1">
 
+
             END
           end
 
           def _stop_accordion
             <<-END
 
+
 </div>
 </div>
 </div>
+
+
             END
           end
 

data/lib/origen_doc_helpers/html_flow_formatter.rb

@@ -0,0 +1,209 @@
+require 'atp'
+require 'kramdown'
+module OrigenDocHelpers
+  class HtmlFlowFormatter < ATP::Formatter
+    include Origen::Generator::Compiler::DocHelpers::TestFlowHelpers
+
+    attr_reader :html
+
+    def format(node, options = {})
+      @html = ''
+      process(node)
+      html
+    end
+
+    def on_flow(node)
+      @flow ||= 0
+      @flow += 1
+      html << "<div class=\"panel-group\" id=\"test_flow_#{@flow}\">"
+      html << _start_accordion(node.to_a[0].value)
+      if node.description && !node.description.empty?
+        html << to_html(node.description.join("\n"))
+        html << '<hr>'
+      end
+      process_all(node)
+      html << _stop_accordion
+      html << '</div>'
+    end
+
+    def on_group(node)
+      html << "<div class=\"row test-overview\">"
+      html << "  <div class=\"header\">"
+      html << "    <span class=\"pull-right\"><a class=\"top-link\" href=\"#\">back to top</a></span>"
+      html << "    <h4 class=\"no-anchor\">#{node.to_a[0].value}</h4>"
+      html << '  </div>'
+
+      html << "<div class=\"col-md-12\" style=\"margin-bottom: 15px;\">"
+      html << "  <div class=\"col-md-4\">"
+      @within_test = true
+      @object = ''
+      on_fail = node.find(:on_fail)
+      on_pass = node.find(:on_pass)
+      process(on_fail) if on_fail
+      process(on_pass) if on_pass
+      html << @object
+      @within_test = false
+      html << '  </div>'
+      html << "  <div class=\"col-md-8 description-pane\">"
+      html << to_html(node.description.join("\n")) if node.description
+      html << '  </div>'
+      html << '  </div>'
+
+      @group ||= 0
+      @group += 1
+      html << "<div class=\"col-md-12 panel-group\" id=\"test_group_#{@group}\">"
+      html << _start_accordion('Tests')
+      process_all(node.children - [on_fail, on_pass])
+      html << _stop_accordion
+      html << '</div>'
+
+      html << '</div>'
+    end
+
+    def on_flow_flag(node)
+      @flow_flag ||= 0
+      @flow_flag += 1
+      flags = [node.to_a[0]].flatten
+      flags = flags.map do |flag|
+        "<span class=\"label label-info\">#{flag}</span>"
+      end
+      if node.to_a[1]
+        text = "<span class=\"connector\">IF</span>" + flags.join("<span class=\"connector\">OR</span>")
+      else
+        text = "<span class=\"connector\">UNLESS</span>" + flags.join("<span class=\"connector\">OR</span>")
+      end
+      html << "<div class=\"row test-overview\">"
+      html << "<div class=\"panel-group col-md-12\" id=\"flow_flag_#{@flow_flag}\">"
+      html << _start_accordion(text, panel: :warning)
+      process_all(node)
+      html << _stop_accordion
+      html << '</div>'
+      html << '</div>'
+    end
+
+    def on_run_flag(node)
+      @run_flag ||= 0
+      @run_flag += 1
+      flags = [node.to_a[0]].flatten
+      flags = flags.map do |flag|
+        if flag =~ /FAILED/
+          "<span class=\"label label-danger\">#{flag}</span>"
+        elsif flag =~ /PASSED/
+          "<span class=\"label label-success\">#{flag}</span>"
+        else
+          "<span class=\"label label-info\">#{flag}</span>"
+        end
+      end
+      text = "<span class=\"connector\">IF</span>" + flags.join("<span class=\"connector\">OR</span>")
+      html << "<div class=\"row test-overview\">"
+      html << "<div class=\"panel-group col-md-12\" id=\"run_flag_#{@run_flag}\">"
+      html << _start_accordion(text, panel: :info)
+      process_all(node)
+      html << _stop_accordion
+      html << '</div>'
+      html << '</div>'
+    end
+
+    def on_set_result(node)
+      unless @within_continue
+        type, *nodes = *node
+        bin = node.find(:bin).try(:value)
+        sbin = node.find(:softbin).try(:value)
+        unless @within_test
+          html << "<div class=\"row\">"
+          html << "  <div class=\"col-md-4\">"
+          if type == 'fail'
+            html << "    <h4 class=\"no-anchor\">Set Result - FAIL</h4>"
+          else
+            html << "    <h4 class=\"no-anchor\">Set Result - PASS</h4>"
+          end
+        end
+        if type == 'fail'
+          html << "<span class=\"label label-danger\">Bin #{bin}</span>" if bin
+          html << "<span class=\"label label-danger\">Softbin #{sbin}</span>" if sbin
+        else
+          html << "<span class=\"label label-success\">Bin #{bin}</span>" if bin
+          html << "<span class=\"label label-success\">Softbin #{sbin}</span>" if sbin
+        end
+        unless @within_test
+          html << '  </div>'
+          html << "  <div class=\"col-md-8 description-pane\">"
+          html << '  </div>'
+          html << '</div>'
+          html << '<hr>'
+        end
+      end
+    end
+
+    def on_set_run_flag(node)
+      if @within_on_fail
+        html << "<span class=\"label label-danger\">#{node.value}</span>"
+      else
+        html << "<span class=\"label label-success\">#{node.value}</span>"
+      end
+    end
+
+    def on_on_fail(node)
+      @within_continue = !!node.find(:continue)
+      @within_on_fail = true
+      process_all(node.children)
+      @within_continue = false
+      @within_on_fail = false
+    end
+
+    def on_continue(node)
+      if @within_on_fail
+        html << "<span class=\"label label-danger\">Continue</span>"
+      end
+    end
+
+    def on_test(node)
+      id = node.find(:id).value
+      html << "<div class=\"row test-overview\" id=\"flow_#{@flow}_test_#{id}\">"
+      html << "  <a class=\"anchor\" name=\"flow_#{@flow}_test_#{id}\"></a>"
+      html << "  <div class=\"header\">"
+      if n = node.find(:name)
+        name = n.value
+      else
+        name = node.find(:object).value['Test']
+      end
+      number = node.find(:number).try(:value)
+      html << "    <span class=\"pull-right\"><a class=\"list-link\" href=\"#\" data-testid=\"list_#{@flow}_test_#{id}\">view in datalog</a><span> | </span><a class=\"top-link\" href=\"#\">back to top</a></span>"
+      html << "    <h4 class=\"no-anchor\">#{name}<span class=\"test-number\">#{number ? ' - ' + number.to_s : ''}</span></h4>"
+      html << '  </div>'
+      html << "  <div class=\"col-md-4\">"
+      @within_test = true
+      @object = ''
+      process_all(node.children)
+      html << @object
+      @within_test = false
+      html << '  </div>'
+      html << "  <div class=\"col-md-8 description-pane\">"
+      html << to_html(node.description.join("\n")) if node.description
+      html << '  </div>'
+      html << '</div>'
+    end
+
+    def on_object(node)
+      t = node.to_a.first
+      @object << "<hr><div class=\"test-attributes\">"
+      if t.is_a?(String)
+        @object << "<strong>Test: </strong><span>#{t}</span>"
+      elsif t.is_a?(Hash)
+        t.each do |key, value|
+          @object << "<strong>#{key}: </strong><span>#{value}</span><br>"
+        end
+      end
+      @object << '</div>'
+    end
+
+    # Convert the given markdown string to HTML
+    def to_html(string, _options = {})
+      # Escape any " that are not already escaped
+      string.gsub!(/([^\\])"/, '\1\"')
+      # Escape any ' that are not already escaped
+      string.gsub!(/([^\\])'/, %q(\1\\\'))
+      html = Kramdown::Document.new(string, input: :kramdown).to_html
+    end
+  end
+end

data/lib/origen_doc_helpers/list_flow_formatter.rb

@@ -0,0 +1,92 @@
+require 'atp'
+module OrigenDocHelpers
+  class ListFlowFormatter < ATP::Formatter
+    attr_reader :html
+
+    def format(node, options = {})
+      @html = ''
+      process(node)
+      html
+    end
+
+    def open_table
+      str = ''
+      # str << "<table class=\"table table-striped\">"
+      str << "<table class=\"table table-hover\">"
+      str << '<thead><tr>'
+      str << '<th>Number</th>'
+      str << '<th>Result</th>'
+      str << '<th>Name</th>'
+      str << '<th>Test</th>'
+      str << '<th>Bin</th>'
+      str << '<th>Softbin</th>'
+      str << '</tr></thead>'
+      str
+    end
+
+    def close_table
+      '</table>'
+    end
+
+    def on_flow(node)
+      @flow ||= 0
+      @flow += 1
+      process_all(node)
+    end
+
+    def on_log(node)
+      html << "<tr><td colspan=\"6\"><strong>LOG: </strong> #{node.value}</td></tr>"
+    end
+
+    def on_render(node)
+      html << "<tr><td colspan=\"6\"><strong>RENDER: </strong> An expicitly rendered flow snippet occurs here</td></tr>"
+    end
+
+    def on_test(node)
+      id = node.find(:id).value
+      html << "<tr id=\"list_#{@flow}_test_#{id}\" class=\"list-test-line clickable\" data-testid=\"flow_#{@flow}_test_#{id}\">"
+      html << "<td>#{node.find(:number).try(:value)}</td>"
+      if node.find(:failed)
+        html << '<td>FAIL</td>'
+      else
+        html << '<td>PASS</td>'
+      end
+      if n = node.find(:name)
+        name = n.value
+      else
+        name = node.find(:object).value['Test']
+      end
+      html << "<td>#{name}</td>"
+      html << "<td>#{node.find(:object).value['Test']}</td>"
+
+      if (f1 = node.find(:on_fail)) && (r1 = f1.find(:set_result)) && (b1 = r1.find(:bin))
+        html << "<td>B#{b1.value}</td>"
+      else
+        html << '<td></td>'
+      end
+
+      if (f2 = node.find(:on_fail)) && (r2 = f2.find(:set_result)) && (b2 = r2.find(:softbin))
+        html << "<td>S#{b2.value}</td>"
+      else
+        html << '<td></td>'
+      end
+
+      html << '</tr>'
+    end
+
+    def on_set_result(node)
+      html << '<tr>'
+      html << '<td></td>'
+      if node.to_a[0] == 'pass'
+        html << '<td>PASS</td>'
+      else
+        html << '<td>FAIL</td>'
+      end
+      html << '<td></td>'
+      html << '<td></td>'
+      html << "<td>#{node.find(:bin).try(:value)}</td>"
+      html << "<td>#{node.find(:softbin).try(:value)}</td>"
+      html << '</tr>'
+    end
+  end
+end

data/templates/shared/test/_flow.md.erb

@@ -4,6 +4,192 @@
 % flows = options[:flow] || options[:flows] 
 % flows = flows ? [flows].flatten : nil
 
+% if !program
+%   Origen.target.temporary = options[:target]
+%   program =  OrigenTesters.program
+
+<style>
+  .clickable { cursor: pointer }
+  h5 strong { font-size: 12px }
+  .description-pane { border-left: 1px solid #eee }
+  span.label, span.connector { margin-right: 5px; }
+  .test-overview { border-bottom: 2px solid #aaa; margin-bottom: 10px; padding-bottom: 10px; }
+  .test-attributes { font-size: 12px }
+  .test-overview .header { padding: 0 15px 5px 15px; }
+  .test-overview .panel-group { margin-bottom: 0; }
+  h4 .test-number { font-size: 14px; }
+  table tr th { text-align: left !important; }
+</style>
+
+<script type="text/javascript">
+  // Modified from: http://jsfiddle.net/jhfrench/mc4Qd/
+  window.onload = function() {
+    $('.expand-collapse-switch').click(function() {
+
+      var newstate = $(this).attr('state') ^ 1,
+          icon = newstate ? "minus" : "plus";
+
+      // if state=0, show all the accordion divs within the same block (in this case, within the same section)
+      if ( $(this).attr('state')==="0" ) {
+          $(this).parent().find('div.panel-collapse:not(.in)').collapse('show');
+          $(this).parent().find('.expand-collapse-switch').html("<i class=\"fa fa-" + icon + "\"></i>").attr('state', newstate);
+      }
+      // otherwise, collapse all the divs
+      else {
+          $(this).parent().find('div.panel-collapse.in').collapse('hide');
+          $(this).parent().find('.expand-collapse-switch').html("<i class=\"fa fa-" + icon + "\"></i>").attr('state', newstate);
+      }
+
+      $(this).html("<i class=\"fa fa-" + icon + "\"></i>");
+
+      $(this).attr('state',newstate)
+
+      return false;
+    });
+
+    $('.expand-all-link').click(function() {
+      $('div.panel-collapse:not(.in)').collapse('show');
+      $('.expand-collapse-switch').html("<i class=\"fa fa-minus\"></i>").attr('state', 1);
+      return false;
+    });
+
+    $('.collapse-all-link').click(function() {
+      $('div.panel-collapse.in').collapse('hide');
+      $('.expand-collapse-switch').html("<i class=\"fa fa-plus\"></i>").attr('state', 0);
+      return false;
+    });
+
+    var tab = getUrlParameter("tab")
+    if (tab == "flow") {
+      $("#flow-tab-select").tab("show");
+    }
+
+    // When a test line in the flow listing is clicked, show the test in the flow view
+    $('.list-test-line').click(function() {
+      var id = "#" + $(this).data("testid");
+      // Show the flow tab
+      $("#flow-tab-select").tab("show");
+      // Expand the elements wrapping the target test
+      $(id).parents('div.panel-collapse:not(.in)').collapse('show');
+      $(id).parents('.panel').children('.expand-collapse-switch').html("<i class=\"fa fa-minus\"></i>").attr('state', 1);
+      // Then scroll to it
+      jQuery('html,body').animate({scrollTop: jQuery(id).offset().top - 300}, 1000);
+      flashIt($(id), 10);
+      return false;
+    });
+
+    // Links to listing from the flow view of tests
+    $('.list-link').click(function() {
+      var id = "#" + $(this).data("testid");
+      // Show the flow tab
+      $("#list-tab-select").tab("show");
+      // Then scroll to it
+      jQuery('html,body').animate({scrollTop: jQuery(id).offset().top - 350}, 500);
+      flashIt($(id), 10);
+      return false;
+    });
+
+    // Remove any links where the given test is not present
+    $(".list-link").each(function() {
+      var id = "#" + $(this).data("testid");
+      if ($(id).length == 0) {
+        $(this).next().remove() // Remove the separator
+        $(this).remove();
+      }
+    });
+
+    // Links to the top of the page
+    $('.top-link').click(function() {
+      jQuery('html,body').animate({scrollTop: 0}, 500);
+      return false;
+    });
+
+    // Update the +/- icons when a panel is changed manually by clicking it
+    $('.panel-collapse').on('hidden.bs.collapse', function () {
+        if ($(this).hasClass("in") == false) {
+          $(this).parent().children('.expand-collapse-switch').html("<i class=\"fa fa-plus\"></i>").attr('state', 0);
+        }
+    })
+
+    $('.panel-collapse').on('shown.bs.collapse', function () {
+        if ($(this).hasClass("in") == true) {
+          $(this).parent().children('.expand-collapse-switch').html("<i class=\"fa fa-minus\"></i>").attr('state', 1);
+        }
+    })
+  };
+
+  var getUrlParameter = function getUrlParameter(sParam) {
+    var sPageURL = decodeURIComponent(window.location.search.substring(1)),
+        sURLVariables = sPageURL.split('&'),
+        sParameterName,
+        i;
+
+    for (i = 0; i < sURLVariables.length; i++) {
+        sParameterName = sURLVariables[i].split('=');
+
+        if (sParameterName[0] === sParam) {
+            return sParameterName[1] === undefined ? true : sParameterName[1];
+        }
+    }
+  };
+
+  function flashIt(element, times){
+    for (var i=0; i < times; i++){
+      setTimeout(function(){
+        $(element).toggleClass("highlight");
+      }, (300 * i));
+    };
+  };
+</script>
+
+
+<div class="row">
+  <div class="col-md-12">
+
+    <h2><%= options[:heading] %> <span style="font-size: 14px">(generated for target '<%= options[:target] %>')</span></h2>
+
+    <div>
+      <!-- Nav tabs -->
+      <ul id="videoTabs" class="nav nav-tabs" role="tablist">
+        <li role="presentation" class="active"><a href="#listing" id="list-tab-select" aria-controls="listing" role="tab" data-toggle="tab">Datalog</a></li>
+        <li role="presentation"><a href="#flow" id="flow-tab-select" aria-controls="flow" role="tab" data-toggle="tab">Flow View</a></li>
+      </ul>
+
+      <!-- Tab panes -->
+      <div class="tab-content">
+        <div role="tabpanel" class="tab-pane active" id="listing" style="padding-top: 15px">
+
+% formatter = OrigenDocHelpers::ListFlowFormatter.new
+<%= formatter.open_table %>
+% flows.each do |flow|
+<%= formatter.run_and_format(program.flow(flow).ast, options[:context]) %>
+% end
+<%= formatter.close_table %>
+
+        </div>
+
+        <div role="tabpanel" class="tab-pane" id="flow" style="padding-top: 15px">
+          <div style="height: 40px;">
+            <span class="pull-right">
+              <a class="expand-all-link" href="#">expand all</a> |
+              <a class="collapse-all-link" href="#">collapse all</a>
+            </span>
+          </div>
+
+% formatter = OrigenDocHelpers::HtmlFlowFormatter.new
+% flows.each do |flow|
+<%= formatter.run_and_format(program.flow(flow).ast, {evaluate_flow_flags: false, evaluate_run_flags: false, evaluate_set_result: false}.merge(options[:context])) %>
+% end
+
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+
+% # Legacy output based on Doc tester, abandon hope all ye who enter here...
+% else
+
 <div class="row">
 %# The markdown attribute is important if you are going to include content written
 %# in markdown, without this is will be included verbatim
@@ -225,3 +411,5 @@
 </div>
 </div>
 </div>
+
+% end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_doc_helpers
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-23 00:00:00.000000000 Z
+date: 2016-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: origen_testers
   requirement: !ruby/object:Gem::Requirement
@@ -61,6 +55,8 @@ files:
 - lib/origen_doc_helpers.rb
 - lib/origen_doc_helpers/doc_interface.rb
 - lib/origen_doc_helpers/dut.rb
+- lib/origen_doc_helpers/html_flow_formatter.rb
+- lib/origen_doc_helpers/list_flow_formatter.rb
 - lib/origen_doc_helpers/pdf.rb
 - program/_func.rb
 - program/_hvst.rb