origen_doc_helpers 0.8.1 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc64bf452050bf339559fae81af5f84ec6a1110b7f961603c01216054544b724
-  data.tar.gz: 339aea6eed91ca04ae9878c588d99d5686dd0bdb7a7782648574e72cf6bf44b4
+  metadata.gz: cc7cf65e39b57505c76fd5c6b1dfc2fa0a8584393a9908969bec3f5f591031a9
+  data.tar.gz: a8047c6ecb51906db3c9ff4ebfeb226f0a4cb737fb8d1cabd96e8933c2699576
 SHA512:
-  metadata.gz: c6fcb507a0332cdb0770b34992d4fcd21f25feafe50f44e6d96232364108edfcb98309e24a1eecb89db31450aad5503d9a14f6dddc120a77172831bfe6f19040
-  data.tar.gz: e88f2858f3a3d9fb6971b64a8b9afd1adf275d326f495213c5bca23d56a0253b8a6fad5c8ef785fc34d4ef78db5b6d2f82236c7e5a91f432c2d754cfec38e4ef
+  metadata.gz: ddae3f5bdd04539284603a0b6cfb479b8bc5d5babf4a2ebdc14a130090b01e0c06a6a0bb93dca4a16b4d913460436b73f9fb99f28435a992abff7b83775d4394
+  data.tar.gz: 3d7d6b437954b67a8b2eaa14b620af2f2b089b94e389f7ef2b1c0e21171efc732a3b2490a091c7e42b8f951a7388149da74ea0999221fd2aa5045647e6af87a4

data/config/application.rb

@@ -8,7 +8,7 @@ class OrigenDocHelpersApplication < Origen::Application
   # To enable deployment of your documentation to a web server (via the 'origen web'
   # command) fill in these attributes.
   config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/doc_helpers"
-  config.web_domain = "http://origen-sdk.org/doc_helpers"
+  config.web_domain = "https://origen-sdk.org/doc_helpers"
   config.disqus_shortname = "origen-sdk"
 
   config.semantically_version = true

data/config/version.rb

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

data/lib/origen_doc_helpers/flow_page_generator.rb

@@ -43,7 +43,7 @@ module OrigenDocHelpers
         File.write(f, t)
       end
 
-      def index_page_template
+      def index_page_template # index page template is in doc helpers, which isn't using app/ dir
         @index_page_template ||= "#{Origen.root!}/templates/flow_index.md.erb"
       end
     end
@@ -99,11 +99,11 @@ module OrigenDocHelpers
       d
     end
 
-    def flow_page_template
+    def flow_page_template # flow page template is in doc helpers, which isn't using app/ dir
       @flow_page_template ||= "#{Origen.root!}/templates/flow_page.md.erb"
     end
 
-    def flow_template
+    def flow_template # flow template is in doc helpers, which isn't using app/ dir
       @flow_template ||= "#{Origen.root!}/templates/shared/test/_flow.md.erb"
     end
   end

data/lib/origen_doc_helpers/guide_index.rb

@@ -1,7 +1,7 @@
 module OrigenDocHelpers
   # Provides an API to programatically construct an index hash as used
   # by the Searchable Documents helper -
-  # http://origen-sdk.org/doc_helpers/helpers/searchable/intro/#The_Document_Index
+  # https://origen-sdk.org/doc_helpers/helpers/searchable/intro/#The_Document_Index
   class GuideIndex
     def initialize
       @index = {}

data/lib/origen_doc_helpers/helpers.rb

@@ -257,7 +257,11 @@ END
             @_doc_root_dirs ||= {}
             return @_doc_root_dirs[f] if @_doc_root_dirs[f]
             unless File.exist?(f)
-              f = Pathname.new("#{Origen.root}/templates/web/#{f}")
+              if File.exist?("#{Origen.root}/app/")
+                f = Pathname.new("#{Origen.root}/app/templates/web/#{f}")
+              else
+                f = Pathname.new("#{Origen.root}/templates/web/#{f}")
+              end
               unless f.exist?
                 fail "#{options[:root]} does not exist!"
               end
@@ -272,7 +276,11 @@ END
             if options[:tab]
               options[:tab]
             else
-              rel = options[:top_level_file].relative_path_from(_doc_root_dir(options)).sub_ext('').sub_ext('').to_s
+              rel = begin
+                  options[:top_level_file].relative_path_from(_doc_root_dir(options)).sub_ext('').sub_ext('').to_s
+                rescue
+                  '..'
+                end
               # If the file lives outside of the current app (e.g. it comes from a plugin), then the above approach
               # doesn't work, so let's just take the last dirname and the filename
               if rel =~ /\.\./
@@ -285,7 +293,11 @@ END
           end
 
           def _root_path(options)
-            root = Pathname.new("#{Origen.root}/templates/web")
+            if File.exist?("#{Origen.root}/app/templates/web")
+              root = Pathname.new("#{Origen.root}/app/templates/web")
+            else
+              root = Pathname.new("#{Origen.root}/templates/web")
+            end
             _doc_root_dir(options).relative_path_from(root)
           end
         end

data/lib/origen_doc_helpers/model_page_generator.rb

@@ -4,6 +4,7 @@ module OrigenDocHelpers
       attr_accessor :layout_options
       attr_accessor :layout
       attr_reader :pages
+      attr_accessor :target_as_id
 
       def run(options)
         @pages = {}
@@ -42,7 +43,7 @@ module OrigenDocHelpers
         File.write(f, t)
       end
 
-      def index_page_template
+      def index_page_template # index page template is in doc helpers, which isn't using app/ dir
         @index_page_template ||= "#{Origen.root!}/templates/model_index.md.erb"
       end
     end
@@ -144,18 +145,26 @@ module OrigenDocHelpers
     end
 
     def id
-      @id ||= model.class.to_s.symbolize.to_s.gsub('::', '_')
+      if :target_as_id
+        @id ||= "#{Origen.target.name.downcase}" # _#{model.class.to_s.symbolize.to_s.gsub('::', '_')}"
+      else
+        @id ||= model.class.to_s.symbolize.to_s.gsub('::', '_')
+      end
     end
 
     def heading
-      model.class.to_s
+      if :target_as_id
+        @id.upcase
+      else
+        model.class.to_s
+      end
     end
 
     def output_path
       "models/#{id}"
     end
 
-    def model_page_template
+    def model_page_template # model page template is in doc helpers, which isn't using app/ dir
       @model_page_template ||= "#{Origen.root!}/templates/model_page.md.erb"
     end
   end

data/lib/origen_doc_helpers/pdf.rb

@@ -25,7 +25,11 @@ module OrigenDocHelpers
       @index = options[:index]
       @root = Pathname.new(options[:root])
       if @root.absolute?
-        @root = @root.relative_path_from(Pathname.new("#{Origen.root}/templates/web"))
+        if File.exist?("#{Origen.root}/app/")
+          @root = @root.relative_path_from(Pathname.new("#{Origen.root}/app/templates/web"))
+        else
+          @root = @root.relative_path_from(Pathname.new("#{Origen.root}/templates/web"))
+        end
       end
       require 'nokogiri'
     end
@@ -116,7 +120,11 @@ module OrigenDocHelpers
     end
 
     def topic_wrapper_string
-      @topic_wrapper_string ||= File.read("#{Origen.root!}/templates/pdf/topic_wrapper.html")
+      if File.exist?("#{Origen.root}/app/")
+        @topic_wrapper_string ||= File.read("#{Origen.root!}/app/templates/pdf/topic_wrapper.html")
+      else
+        @topic_wrapper_string ||= File.read("#{Origen.root!}/templates/pdf/topic_wrapper.html")
+      end
     end
   end
 end

data/templates/model_index.md.erb

@@ -3,7 +3,7 @@
 
 <div class="row" style="margin-top: 10px; margin-bottom: 15px;">
   <div class="col-md-9">
-    <img src="http://origen-sdk.org/img/origen-device.png" style="float: left; height:50px; width: 50px; margin-top: 14px;">
+    <img src="https://origen-sdk.org/img/origen-device.png" style="float: left; height:50px; width: 50px; margin-top: 14px;">
     <h1 style="float: left; margin-left: 10px;">Models</h1>
   </div>
 </div>

data/templates/model_page.md.erb

@@ -20,7 +20,7 @@
 
 <div class="row" style="margin-top: 10px; margin-bottom: 15px;">
   <div class="col-md-9">
-    <img src="http://origen-sdk.org/img/origen-device.png" style="float: left; height:50px; width: 50px; margin-top: 14px;">
+    <img src="https://origen-sdk.org/img/origen-device.png" style="float: left; height:50px; width: 50px; margin-top: 14px;">
     <h1 style="float: left; margin-left: 10px;"><%= opts[:heading] %></h1>
   </div>
 % if opts[:search_box]

data/templates/web/helpers.md.erb

@@ -16,7 +16,7 @@ These helpers will generate complete web pages for you.
 
 The following are components that you can embed within your own web pages.
 
-| [Searchable Documents](<%= path "/helpers/searchable/intro" %>) | Provides a layout for a guides section of your website, complete with search box (the [Origen Guides](http://origen-sdk.org/guides) uses this)
+| [Searchable Documents](<%= path "/helpers/searchable/intro" %>) | Provides a layout for a guides section of your website, complete with search box (the [Origen Guides](https://origen-sdk.org/guides) uses this)
 | [Register Descriptions](<%= path "/helpers/register" %>)        | Create a tabular register view, similar to that used in device reference manuals
 | [Yammer Comments](<%= path "/helpers/yammer" %>)                | Embed a comments section at the bottom of your page using Yammer
 | [Disqus Comments](<%= path "/helpers/disqus" %>)                | Embed a comments section at the bottom of your page using Disqus

data/templates/web/helpers/model.md.erb

@@ -5,9 +5,9 @@
 This helper will build a collection of web pages that document a model's attributes,
 currently this includes its sub-blocks and registers.
 
-[Here is an example](http://origen-sdk.org/link_demo/models/linkdemo_toplevel/).
+[Here is an example](https://origen-sdk.org/link_demo/models/linkdemo_toplevel/).
 
-Multiple models can be supplied and an [index page like this](http://origen-sdk.org/link_demo/models)
+Multiple models can be supplied and an [index page like this](https://origen-sdk.org/link_demo/models)
 is generated to help locate the documentation for a given model.
 
 The collection of pages associated with a particular model is also fully searchable via
@@ -79,6 +79,9 @@ end
 
 * <code>:model</code> - **Required**, supply an instance of the model
 * <code>:group</code> - Optional, a heading to group similar models under on the index page, e.g. "Production", "In Development"
+* <code>:target_as_id</code> - Optional, causes the target name to be used for model page headings instead of the top-level model class name, 
+  e.g. "Eagle" instead of "MyApp::ModelA".  This is particularly useful if multiple targets instantiate the same top-level model with different
+  options or attributes that lead to differentiation.
 
 ## Website Integration
 

data/templates/web/helpers/register.md.erb

@@ -2,7 +2,7 @@
 
 # Register Helpers
 
-Use the [Origen register API](http://origen-sdk.org/origen/guides/models/registers)
+Use the [Origen register API](https://origen-sdk.org/origen/guides/models/registers)
 to define registers in the normal way,
 all of the examples are here are based on this register definition:
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_doc_helpers
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.6
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-24 00:00:00.000000000 Z
+date: 2021-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -76,7 +76,7 @@ files:
 - templates/web/layouts/_helpers.html.erb
 - templates/web/partials/_navbar.html.erb
 - templates/web/release_notes.md.erb
-homepage: http://origen-sdk.org/doc_helpers
+homepage: https://origen-sdk.org/doc_helpers
 licenses:
 - MIT
 metadata: {}
@@ -95,8 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Snippets and helpers for creating Origen web documents