origen 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c1a7f85be5cd25a3d273bc9a39282fb14632bfc
-  data.tar.gz: c84c92c248d688ed484c4ac535ec1d0fc865e44c
+  metadata.gz: 6d2449785c5161644ff8da66aa8403aae62f4d08
+  data.tar.gz: 8ee9264e19480135516b1c47a8a493d2cb748036
 SHA512:
-  metadata.gz: eee9d18be7061f9e5035d3f6011680b33531fa778d6e9284fdacb45e81c42e0fd3a8001097b86f9ee419e83b418783b99bec356a2b2b910f19b1e2e3c028b3c8
-  data.tar.gz: 1f76efe0acc7e6170fbddcca2802dda39070926a7fba0b398e22e95773c1dae3dc94cfcb43d701bfd07038e29b1d181c7e715d6d0e1ece106bf2f4836c07eff6
+  metadata.gz: 4de43c9c9c3f8dd7b31e8deea1036dcd4ca91ffd2cfa81081747b2b327805f992be7d08e758279caff1769f0a0ce76dc2b0ab0adbce05fa5ded120339839006b
+  data.tar.gz: df12a88ed32d574088e91c7cdf4e189bdabff2aa285961845c62c2cfdc784c42755f83b75ce703707488655f0144ed5f5e92264277b3527cce558752e14002cc

data/config/application.rb

@@ -109,15 +109,15 @@ class OrigenCoreApplication < Origen::Application
     end
   end
 
-  def before_deploy_site
-    Dir.chdir Origen.root do
-      system "origen specs -c"
-      system "origen examples -c"
-      dir = "#{Origen.root}/web/output/coverage"       
-      FileUtils.remove_dir(dir, true) if File.exists?(dir) 
-      system "mv #{Origen.root}/coverage #{dir}"
-    end
-  end
+  #def before_deploy_site
+  #  Dir.chdir Origen.root do
+  #    system "origen specs -c"
+  #    system "origen examples -c"
+  #    dir = "#{Origen.root}/web/output/coverage"       
+  #    FileUtils.remove_dir(dir, true) if File.exists?(dir) 
+  #    system "mv #{Origen.root}/coverage #{dir}"
+  #  end
+  #end
 
   def after_release_email(tag, note, type, selector, options)
     begin

data/config/boot.rb

@@ -5,3 +5,5 @@ require "c99/doc_interface"
 # this is to test that the importing application can override and
 # extend imported classes.
 require_relative "../lib/c99/nvm"
+
+require_relative "../helpers/guides"

data/config/version.rb

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

data/helpers/guides.rb

@@ -0,0 +1,14 @@
+class Origen::Generator::Compiler
+
+  def origen_core_frontmatter(options={})
+<<END    
+analytics: UA-64455560-1
+url: #{current_url}
+facebook: origensdk
+twitter: origensdk
+author_url: https://plus.google.com/u/1/b/106463981272125989995/106463981272125989 
+site_name: Origen - The Semiconductor Developer's Kit
+END
+  end
+
+end

data/lib/origen/application.rb

@@ -115,7 +115,7 @@ module Origen
             )
 
           end
-        else
+        elsif config.vault
           @revision_controller ||= RevisionControl::DesignSync.new(
             local:  root,
             remote: config.vault

data/lib/origen/pins.rb

@@ -276,7 +276,7 @@ module Origen
     end
     alias_method :add_ground_pins, :add_ground_pin
 
-    # Specifiy the order that pins will appear in the output pattern, unspecified
+    # Specify the order that pins will appear in the output pattern, unspecified
     # pins will appear in an arbitrary order at the end
     #
     # API v2, deprecated
@@ -296,7 +296,7 @@ module Origen
       Origen.app.pin_pattern_order << options unless options.empty?
     end
 
-    # Specifiy the pins will not appear in the output pattern
+    # Specify the pins will not appear in the output pattern
     def pin_pattern_exclude(*pin_ids)
       if pin_ids.last.is_a?(Hash)
         options = pin_ids.pop

data/lib/origen/revision_control/git.rb

@@ -293,7 +293,7 @@ module Origen
       end
 
       def changes_pending_commit?
-        !(git('status --verbose', verbose: false).last =~ /^(no changes|nothing to commit)/)
+        !(git('status --verbose', verbose: false).last =~ /^(no changes|nothing to commit|nothing added to commit but untracked files present)/)
       end
 
       def initialize_local_dir

data/lib/origen/specs/doc_resource.rb

@@ -2,9 +2,44 @@ module Origen
   module Specs
     # This class is used to store text information to help with documentation processes
     class Doc_Resource
-      attr_accessor :mode, :type, :sub_type, :audience, :table_title
-      attr_accessor :note_refs, :exhibit_refs, :before_table, :after_table, :doc_options
+      # Mode is part of the 4-D Hash for the Tables.  Corresponds to Spec 4-D Hash
+      attr_accessor :mode
 
+      # Type is part of the 4-D Hash for the Tables.  Corresponds to Spec 4-D Hash
+      # Usual values
+      #
+      # * DC -> Direct Current
+      # * AC -> Alternate Current
+      # * Temp -> Temperature
+      # * Supply -> Supply
+      attr_accessor :type
+
+      # SubType is part of the 4-D Hash for the Tables. Corresponds to Spec 4-D Hash
+      attr_accessor :sub_type
+
+      # Audience is part of the 4-D Hash for the Tables.  Corresponds to Spec 4-D Hash
+      attr_accessor :audience
+
+      # Table Title that should appear for the table.  If blank, generic Table Title will be used
+      # Hash is created from mode, type, sub_type, and audience.
+      attr_accessor :table_title
+
+      # Note References that should be referenced within the table title
+      attr_accessor :note_refs
+
+      # Exhibit References that should be referenced within the table title
+      attr_accessor :exhibit_refs
+
+      # DITA Formatted Text that appears before the table
+      attr_accessor :before_table
+
+      # DITA Formatted Text that appears after the table
+      attr_accessor :after_table
+
+      # Documentation Options that will change the appearance of the output.
+      attr_accessor :doc_options
+
+      # Initialize the Class
       def initialize(selector = {}, table_title = {}, text = {}, options = {})
         @mode = selector[:mode]
         @type = selector[:type]
@@ -18,6 +53,7 @@ module Origen
         @doc_options = options
       end
 
+      # Converts to an XML file.
       def to_xml
         tmp = {}
         tmp['mode'] = @mode unless @mode.nil?
@@ -67,15 +103,27 @@ module Origen
             unless @before_table.nil? && @after_table.nil?
               xml.paragraphs do
                 unless @before_table.nil?
-                  if @before_table.is_a? Nokogiri::XML::Node
-                    xml.before_table @before_table.inner_html
+                  if (@before_table.is_a? Nokogiri::XML::Node) || (@before_table.is_a? Nokogiri::XML::Element)
+                    xml.before_table do
+                      if @before_table.name == 'body'
+                        xml << @before_table.children.to_xml
+                      else
+                        xml << @before_table.to_xml
+                      end
+                    end
                   else
                     xml.before_table @before_table
                   end
                 end
                 unless @after_table.nil?
-                  if @after_table.is_a? Nokogiri::XML::Node
-                    xml.after_table after_table.inner_html
+                  if (@after_table.is_a? Nokogiri::XML::Node) || (@after_table.is_a? Nokogiri::XML::Element)
+                    xml.after_table do
+                      if @after_table.name == 'body'
+                        xml << @after_table.children.to_xml
+                      else
+                        xml << @after_table.to_xml
+                      end
+                    end
                   else
                     xml.after_table @after_table
                   end

data/lib/origen/specs/note.rb

@@ -2,8 +2,42 @@ module Origen
   module Specs
     # This class is used to store spec note information used to document IP
     class Note
-      attr_accessor :id, :type, :mode, :audience, :text, :markup, :internal_comment
+      # id is the id for the note.  The goal for the id is to allow multiple specs to reference one note.
+      # spec.notes = [id1, id2, id3]
+      # spec1.notes = [id1, id4, id5]
+      attr_accessor :id
 
+      # Type should be :ac or :dc, but this might have been phased out.
+      #  TODO:  Check to see if :type has been deprecated or is still needed
+      attr_accessor :type
+
+      # Mode will match the mode that this note belongs to.
+      #  TODO:  Check to see if :mode has been deprecated or is still needed
+      attr_accessor :mode
+
+      # Audience should be :ac or :dc, but this might have been phased out.
+      #  TODO:  Check to see if :type has been deprecated or is still needed
+      attr_accessor :audience
+
+      # Plain text of the note.  No Mark-up allowed in this field.
+      attr_accessor :text
+
+      # Markup of the text field.  Currently markup has been tested with
+      #
+      # * DITA
+      # * XML
+      # * HTML
+      #
+      # Need to test the following markup
+      #
+      # * Markdown
+      attr_accessor :markup
+
+      # Internal comment that could be used to know why the note was needed. Think of this as a breadcrumb
+      # to find out about more information on the note.
+      attr_accessor :internal_comment
+
+      # Initialize the class
       def initialize(id, type, options = {})
         @id = id
         @type = type

data/templates/nanoc/layouts/bootstrap.html.erb

@@ -5,14 +5,44 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
+    <meta property="og:locale" content="en_US">
+    <meta name="content-language" content="en_US">
 
-    <title><%= @item[:title] %></title>
-    <% if @item[:description] %>
-      <meta name="description" content="<%= @item[:description] %>">
-    <% end %>    
-    <% if @item[:author] %>
-      <meta name="author" content="<%= @item[:author] %>">
-    <% end %>
+    <% title = @item[:title] || "Origen, The Semiconductor Developer's Kit" %>
+    <title><%= title %></title>
+    <meta property="og:title" content="<%= title %>">
+    <meta name="twitter:title" content="<%= title %>">
+    <meta itemprop="name" content="<%= title %>">
+  <% if @item[:description] %>
+    <meta name="description" content="<%= @item[:description] %>">
+    <meta name="twitter:description" content="<%= @item[:description] %>">
+    <meta property="og:description" content="<%= @item[:description] %>">
+    <meta itemprop="description" content="<%= @item[:description] %>">
+  <% end %>    
+  <% if @item[:author] %>
+    <meta name="author" content="<%= @item[:author] %>">
+  <% end %>
+  <% if @item[:author_url] %>
+    <link rel="author" href="<%= @item[:author_url] %>">
+  <% end %>
+  <% if @item[:url] %>
+    <meta property="og:url" content="<%= @item[:url] %>">
+    <meta name="twitter:url" content="<%= @item[:url] %>">
+  <% end %>
+  <% image = @item[:image] || "http://origen-sdk.org/favicon-260x260.png" %>
+    <meta property="og:image" content="<%= image %>">
+    <meta name="twitter:image" content="<%= image %>">
+    <meta itemprop="image" content="<%= image %>">
+    <meta name="twitter:card" content="summary">
+  <% if @item[:site_name] %>
+    <meta property="og:site_name" content="<%= @item[:site_name] %>">
+  <% end %>
+  <% if @item[:facebook] %>
+    <meta property="fb:admins" content="<%= @item[:facebook] %>">
+  <% end %>
+  <% if @item[:twitter] %>
+    <meta name="twitter:site" content="@<%= @item[:twitter] %>">
+  <% end %>
 
     <!-- Bootstrap core CSS -->
     <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-14 00:00:00.000000000 Z
+date: 2015-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -427,6 +427,7 @@ files:
 - config/rubocop/strict_disabled.yml
 - config/rubocop/strict_enabled.yml
 - config/version.rb
+- helpers/guides.rb
 - helpers/url.rb
 - lib/c99/ate_interface.rb
 - lib/c99/doc_interface.rb