origen 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e99939b78d9b7a1a5b792938910f001791e9721
-  data.tar.gz: 39ffafc59ef48c446ebefb60e792102a0b92e48f
+  metadata.gz: 412394863afdfd32cdb344c17126129b8c499329
+  data.tar.gz: 1baa897bcf1e764d3a131d6f827ec0552c9ed662
 SHA512:
-  metadata.gz: 48cd1e06b4a31837292e84392a07488e8592a6fe8560280ecb40bffcbf25c2e696a98a89712f173aee4f01594f3b4550185926be845236f777ed538af139957f
-  data.tar.gz: 46507aebdf7041b89312fd07d6f18156c965842cbf736d091014ca4bb02abef6b92f9b52216426bd5ead3df8f0e4c73a088bf4e5894776e5ec93106a3fa50e61
+  metadata.gz: 649434cf50cbe409e0e03ee825262500d97c14bfe6357c8c190bea675c04901acfd5cbc311db7f096cf93409ea3f54bd62daffcf46ec4aa88c27cf6b5558eeb9
+  data.tar.gz: 0b964eb7b8cd58ab5ceb99d2b13cea2b6eb3b8f698248fc34c005a24d82d425f864ffc976aabc6e3bf89ad0809832a157e37510f243d808cac24f03d2b638a9a

data/config/version.rb

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

data/lib/origen/application/runner.rb

@@ -15,83 +15,85 @@ module Origen
       # Originally this method was called generate but that is now deprecated in favour
       # of the more generic 'launch' as the Origen feature set has expanded.
       def launch(options = {})
-        # Clean up the input from legacy code
-        options[:action] = extract_action(options)
-        options[:files] = extract_files(options)
-        @options = options
-        prepare_and_validate_workspace(options)
-        if options[:lsf]
-          record_invocation(options) do
-            prepare_for_lsf
-            Origen.app.listeners_for(:before_lsf_submission).each(&:before_lsf_submission)
-            expand_lists_and_directories(options[:files], options).each do |file|
-              Origen.app.lsf_manager.submit_origen_job(file, options)
-            end
-          end
-          Origen.log.info ''
-          Origen.log.info 'Monitor status of remote jobs via:'
-          Origen.log.info '  origen l'
-        else
-          Origen.log.info '*' * 70 unless options[:quiet]
-          Origen.app.listeners_for(:before_generate).each do |listener|
-            if listener.class.instance_method(:before_generate).arity == 0
-              listener.before_generate
-            else
-              listener.before_generate(options)
-            end
-          end
-          if Origen.running_remotely?
-            Origen.app.listeners_for(:before_generate_remote).each do |listener|
-              if listener.class.instance_method(:before_generate_remote).arity == 0
-                listener.before_generate_remote
-              else
-                listener.before_generate_remote(options)
+        Origen.file_handler.preserve_state do
+          # Clean up the input from legacy code
+          options[:action] = extract_action(options)
+          options[:files] = extract_files(options)
+          @options = options
+          prepare_and_validate_workspace(options)
+          if options[:lsf]
+            record_invocation(options) do
+              prepare_for_lsf
+              Origen.app.listeners_for(:before_lsf_submission).each(&:before_lsf_submission)
+              expand_lists_and_directories(options[:files], options).each do |file|
+                Origen.app.lsf_manager.submit_origen_job(file, options)
               end
             end
+            Origen.log.info ''
+            Origen.log.info 'Monitor status of remote jobs via:'
+            Origen.log.info '  origen l'
           else
-            Origen.app.listeners_for(:before_generate_local).each do |listener|
-              if listener.class.instance_method(:before_generate_local).arity == 0
-                listener.before_generate_local
+            Origen.log.info '*' * 70 unless options[:quiet]
+            Origen.app.listeners_for(:before_generate).each do |listener|
+              if listener.class.instance_method(:before_generate).arity == 0
+                listener.before_generate
               else
-                listener.before_generate_local(options)
+                listener.before_generate(options)
               end
             end
-          end
-
-          record_invocation(options) do
-            case options[:action]
-            when :forecast_test_time
-              Origen.time.forecast_test_time(options)
+            if Origen.running_remotely?
+              Origen.app.listeners_for(:before_generate_remote).each do |listener|
+                if listener.class.instance_method(:before_generate_remote).arity == 0
+                  listener.before_generate_remote
+                else
+                  listener.before_generate_remote(options)
+                end
+              end
             else
-              if options[:action] == :program
-                Origen.generator.generate_program(expand_lists_and_directories(options[:files], options), options)
+              Origen.app.listeners_for(:before_generate_local).each do |listener|
+                if listener.class.instance_method(:before_generate_local).arity == 0
+                  listener.before_generate_local
+                else
+                  listener.before_generate_local(options)
+                end
+              end
+            end
+
+            record_invocation(options) do
+              case options[:action]
+              when :forecast_test_time
+                Origen.time.forecast_test_time(options)
               else
-                temporary_plugin_from_options = options[:current_plugin]
-                expand_lists_and_directories(options[:files], options).each do |file|
-                  if temporary_plugin_from_options
-                    Origen.app.plugins.temporary = temporary_plugin_from_options
-                  end
-                  case options[:action]
-                  when :compile
-                    Origen.generator.compile_file_or_directory(file, options)
-                  when :merge
-                    Origen.generator.merge_file_or_directory(file, options)
-                  when :import_test_time
-                    Origen.time.import_test_time(file, options)
-                  when :import_test_flow
-                    Origen.time.import_test_flow(file, options)
-                  else
-                    Origen.generator.generate_pattern(file, options)
+                if options[:action] == :program
+                  Origen.generator.generate_program(expand_lists_and_directories(options[:files], options), options)
+                else
+                  temporary_plugin_from_options = options[:current_plugin]
+                  expand_lists_and_directories(options[:files], options).each do |file|
+                    if temporary_plugin_from_options
+                      Origen.app.plugins.temporary = temporary_plugin_from_options
+                    end
+                    case options[:action]
+                    when :compile
+                      Origen.generator.compile_file_or_directory(file, options)
+                    when :merge
+                      Origen.generator.merge_file_or_directory(file, options)
+                    when :import_test_time
+                      Origen.time.import_test_time(file, options)
+                    when :import_test_flow
+                      Origen.time.import_test_flow(file, options)
+                    else
+                      Origen.generator.generate_pattern(file, options)
+                    end
+                    Origen.app.plugins.temporary = nil if temporary_plugin_from_options
                   end
-                  Origen.app.plugins.temporary = nil if temporary_plugin_from_options
                 end
               end
             end
-          end
 
-          unless options[:quiet]
-            Origen.log.info '*' * 70
-            stats.print_summary unless options[:action] == :merge
+            unless options[:quiet]
+              Origen.log.info '*' * 70
+              stats.print_summary unless options[:action] == :merge
+            end
           end
         end
       end

data/lib/origen/file_handler.rb

@@ -388,11 +388,13 @@ module Origen
       dir = base_directory
       output = output_directory
       ref = reference_directory
+      ext = default_extension
       yield
       self.base_directory = dir if dir
       self.current_file = file if file
       set_output_directory(output: output) if output
       set_reference_directory(reference: ref) if ref
+      self.default_extension = ext
     end
 
     def preserve_and_clear_state
@@ -400,6 +402,7 @@ module Origen
       dir = base_directory
       output = output_directory
       ref = reference_directory
+      ext = default_extension
       current_file = nil
       base_directory = nil
       output_directory = nil
@@ -409,6 +412,7 @@ module Origen
       self.current_file = file if file
       set_output_directory(output: output) if output
       set_reference_directory(reference: ref) if ref
+      self.default_extension = ext
     end
 
     # Returns the sub directory of the current base directory that the

data/lib/origen/specs.rb

@@ -145,11 +145,11 @@ module Origen
       @_notes[id][type] = Note.new(id, type, options)
     end
 
-    def exhibit(id, type, options = {})
+    def exhibit(id, type, overrides = {}, options = {})
       # Welguisz:  No idea why this is here, but keeping it here because it follows other blocks
       _exhibits
       # Create a new Exhibit and place it in the exhibits 3-D Hash
-      @_exhibits[options[:block_id]][id][type] = Exhibit.new(id, type, options)
+      @_exhibits[options[:block_id]][id][type] = Exhibit.new(id, type, overrides, options)
     end
 
     def doc_resource(selector = {}, table_title = {}, text = {}, options = {})
@@ -204,6 +204,10 @@ module Origen
       @_creation_info = Creation_Info.new(author, date, version, src_info, tool_info)
     end
 
+    def get_creation_info
+      @_creation_info
+    end
+
     # Returns a Note object from the notes hash
     def notes(options = {})
       # Create a default 2 item hash and update if options is supplied
@@ -259,63 +263,92 @@ module Origen
 
     def exhibits(options = {})
       options = {
-        block:                nil,
-        id:                   nil,
-        type:                 nil,
-        exhibits_to_be_shown: []
+        block: nil,
+        id:    nil,
+        type:  nil
       }.update(options)
-      exhibits_to_be_shown = options[:exhibits_to_be_shown]
-      filter_hash(_exhibits, options[:block]).each do |_exhibit, hash|
-        filter_hash(hash, options[:id]).each do |id, hash_|
-          filter_hash(hash_, options[:type]).each do |type, hash__|
-            exhibits_to_be_shown << hash__
+      ex_found = Hash.new do |h, k|
+        h[k] = Hash.new do |hh, kk|
+          hh[kk] = {}
+        end
+      end
+      filter_hash(_exhibits, options[:block]).each do |_block, hash|
+        filter_hash(hash, options[:id]).each do |_id, hash_|
+          filter_hash(hash_, options[:type]).each do |_type, exh|
+            ex_found[_block][_id][_type] = exh
           end
         end
       end
-      exhibits_to_be_shown
+      if ex_found.empty?
+        return nil
+      else
+        return ex_found
+      end
     end
 
     def doc_resources(options = {})
       options = {
-        mode:                      nil,
-        type:                      nil,
-        sub_type:                  nil,
-        audience:                  nil,
-        doc_resources_to_be_shown: []
+        mode:     nil,
+        type:     nil,
+        sub_type: nil,
+        audience: nil
       }.update(options)
-      doc_resources_to_be_shown = options[:doc_resources_to_be_shown]
-      filter_hash(_doc_resources, options[:mode]).each do |_doc_resource, hash|
+      dr_found = Hash.new do |h, k|
+        h[k] = Hash.new do |hh, kk|
+          hh[kk] = Hash.new do |hhh, kkk|
+            hhh[kkk] = {}
+          end
+        end
+      end
+      filter_hash(_doc_resources, options[:mode]).each do |_mode, hash|
         filter_hash(hash, options[:type]).each do |_type, hash_|
           filter_hash(hash_, options[:sub_type]).each do |_sub_type, hash__|
             filter_hash(hash__, options[:audience]).each do |_audience, spec|
-              doc_resources_to_be_shown << spec
+              dr_found[_mode][_type][_sub_type][_audience] = spec
             end
           end
         end
       end
+      if dr_found.empty?
+        return nil
+      else
+        return dr_found
+      end
     end
 
     def overrides(options = {})
       options = {
-        block:     nil,
-        spec_ref:  nil,
-        mode_ref:  nil,
-        sub_type:  nil,
-        audience:  nil,
-        overrides: []
+        block:    nil,
+        spec_ref: nil,
+        mode_ref: nil,
+        sub_type: nil,
+        audience: nil
       }.update(options)
-      overrides = options[:overrides]
-      filter_hash(_overrides, options[:block]).each do |_override, hash|
+      overrides_found = Hash.new do |h, k|
+        h[k] = Hash.new do |hh, kk|
+          hh[kk] = Hash.new do |hhh, kkk|
+            hhh[kkk] = Hash.new do |hhhh, kkkk|
+              hhhh[kkkk] = {}
+            end
+          end
+        end
+      end
+      filter_hash(_overrides, options[:block]).each do |_block, hash|
         filter_hash(hash, options[:spec_ref]).each do |_spec_ref, hash_|
           filter_hash(hash_, options[:mode_ref]).each do |_mode_ref, hash__|
             filter_hash(hash__, options[:sub_type]).each do |_sub_type, hash___|
               filter_hash(hash___, options[:audience]).each do |_audience, override|
-                overrides << override
+                overrides_found[_block][_spec_ref][_mode_ref][_sub_type][_audience] = override
               end
             end
           end
         end
       end
+      if overrides_found.empty?
+        return nil
+      else
+        return overrides_found
+      end
     end
 
     def mode_selects(options = {})
@@ -333,8 +366,6 @@ module Origen
       end
       if modes_found.empty?
         return nil
-      elsif modes_found.size == 1
-        return modes_found.values.first.values.first
       else
         return modes_found
       end
@@ -355,8 +386,6 @@ module Origen
       end
       if ps_found.empty?
         return nil
-      elsif ps_found.size == 1
-        return ps_found.values.first.values.first
       else
         return ps_found
       end

data/lib/origen/specs/exhibit.rb

@@ -2,14 +2,48 @@ module Origen
   module Specs
     # This class is used to store spec exhibit information used to document IP
     class Exhibit
-      attr_accessor :id, :type, :title, :description, :reference, :markup, :include_exhibit, :block_id
+      # ID for the exhibit.  This allows the exhibit to reference easier
+      attr_accessor :id
 
-      def initialize(id, type, options = {})
+      # Type of exhibit.  Currently only :fig is supported.  In the future, this could be :topic or :table or anything else
+      attr_accessor :type
+
+      # Title for the Exhibit.
+      attr_accessor :title
+
+      # Description for the Exhibit
+      attr_accessor :description
+
+      # Reference link
+      attr_accessor :reference
+
+      # Markup needed for the exhibit
+      attr_accessor :markup
+
+      # Do we include the exhibit in this block
+      attr_accessor :include_exhibit
+
+      # Block ID that this exhibit is being used in.
+      attr_accessor :block_id
+
+      # Title Override.  Allows for the SoC to override the title so that it makes more sense
+      attr_accessor :title_override
+
+      # Reference Override.  This allows for the SoC to use a different figure (e.g. Power Supplies are different)
+      attr_accessor :reference_override
+
+      # Description Override.  This allows for the SoC to use a different description
+      attr_accessor :description_override
+
+      def initialize(id, type, overrides, options = {})
         @id = id
         @type = type
         @title = options[:title]
         @description = options[:description]
         @reference = options[:reference]
+        @title_override = overrides[:title]
+        @reference_override = overrides[:reference]
+        @description_override = overrides[:description]
         @markup = options[:markup]
         @include_exhibit = true
         @include_exhibit = options[:include_exhibit] unless options[:include_exhibit].nil?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-09 00:00:00.000000000 Z
+date: 2016-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport