origen 0.5.11 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4006eb1955bcda32be05ba4d50c2705a61063532
-  data.tar.gz: 32c48da60f72ff9fb98eac8fb08eb814f4be1e54
+  metadata.gz: 2e99939b78d9b7a1a5b792938910f001791e9721
+  data.tar.gz: 39ffafc59ef48c446ebefb60e792102a0b92e48f
 SHA512:
-  metadata.gz: d231d2c1fe01fafcae2c8c065c9158391ab82fb4bb70fd9614715cd07066c6008dbf0f85b06e0dc2f617dbfde769f5b8377c965de49aa104265019284e5ab021
-  data.tar.gz: 53a718b06dcf0fd886752361a3624005775feb52cdc9db31419129c324e4348bfd9b2be653da1294b6cb09ce283d392063045c517955037b6143f156535c50a0
+  metadata.gz: 48cd1e06b4a31837292e84392a07488e8592a6fe8560280ecb40bffcbf25c2e696a98a89712f173aee4f01594f3b4550185926be845236f777ed538af139957f
+  data.tar.gz: 46507aebdf7041b89312fd07d6f18156c965842cbf736d091014ca4bb02abef6b92f9b52216426bd5ead3df8f0e4c73a088bf4e5894776e5ec93106a3fa50e61

data/config/version.rb

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

data/lib/origen/application/runner.rb

@@ -110,30 +110,30 @@ module Origen
       #
       # @api private
       def record_invocation(options)
-        record_invocation = false
-        begin
-          # Only record user invocations at this time, also bypass windows since it seems
-          # that threads can't be trusted not to block
-          unless Origen.running_remotely? # || Origen.running_on_windows?
-            record_invocation = Thread.new do
-              Origen.client.record_invocation(options[:action]) if options[:action]
-            end
-          end
-        rescue
-          # Don't allow this to kill an origen command
-        end
+        # record_invocation = false
+        # begin
+        #  # Only record user invocations at this time, also bypass windows since it seems
+        #  # that threads can't be trusted not to block
+        #  unless Origen.running_remotely? # || Origen.running_on_windows?
+        #    record_invocation = Thread.new do
+        #      Origen.client.record_invocation(options[:action]) if options[:action]
+        #    end
+        #  end
+        # rescue
+        #  # Don't allow this to kill an origen command
+        # end
         yield
-        begin
-          unless Origen.running_remotely?
-            # Wait for a server response, ideally would like to not wait here, but it seems if not
-            # then invocation postings can be dropped, especially on windows
-            Origen.profile 'waiting for recording invocation' do
-              record_invocation.value
-            end
-          end
-        rescue
-          # Don't allow this to kill an origen command
-        end
+        # begin
+        #  unless Origen.running_remotely?
+        #    # Wait for a server response, ideally would like to not wait here, but it seems if not
+        #    # then invocation postings can be dropped, especially on windows
+        #    Origen.profile 'waiting for recording invocation' do
+        #      record_invocation.value
+        #    end
+        #  end
+        # rescue
+        #  # Don't allow this to kill an origen command
+        # end
       end
 
       # The action to take should be set by the action option, but legacy code will pass

data/lib/origen/client.rb

@@ -21,7 +21,7 @@ module Origen
     end
 
     def url
-      "http://origen-hub.am.freescale.net:#{port}/api"
+      'http://hub.origen-sdk.org/api'
     end
 
     def port

data/lib/origen/specs.rb

@@ -9,10 +9,11 @@ module Origen
     autoload :Mode_Select, 'origen/specs/mode_select.rb'
     autoload :Version_History, 'origen/specs/version_history.rb'
     autoload :Creation_Info, 'origen/specs/creation_info.rb'
+    autoload :Spec_Features, 'origen/specs/spec_features.rb'
     require 'origen/specs/checkers'
     include Checkers
 
-    attr_accessor :_specs, :_notes, :_exhibits, :_doc_resources, :_overrides, :_power_supplies, :_mode_selects, :_version_history, :_creation_info
+    attr_accessor :_specs, :_notes, :_exhibits, :_doc_resources, :_overrides, :_power_supplies, :_mode_selects, :_version_history, :_creation_info, :_spec_features
 
     # Detailed description for the ip block
     attr_accessor :description
@@ -22,6 +23,8 @@ module Origen
 
     NOTE_TYPES = [:spec, :doc, :mode, :feature, :sighting]
 
+    FEATURE_TYPES = [:intro, :feature, :subfeature]
+
     SpecTableAttr = Struct.new(:table_text, :show, :padding)
 
     # A regular Array but print specs to the console via their ID for brevity and
@@ -49,10 +52,12 @@ module Origen
       _specs
       if s.nil?
         return show_specs(options)
-      elsif s.is_a? Hash # no spec was passed but some option was passed
+      elsif s.is_a? Hash
+        # no spec was passed but some option was passed
         options.update(s)
         return show_specs(options)
-      else # a spec was passed
+      else
+        # a spec was passed
         options[:spec] = s
         return show_specs(options)
       end
@@ -80,6 +85,8 @@ module Origen
                          .new(name, type, mode, owner_name, &block)
       # Check if the spec already exists
       if has_spec?(name, type: type, mode: mode, sub_type: spec_placeholder.sub_type, creating_spec: true)
+        # Spec already exists.  Go ahead flag error and drop processing.
+        # This is a fatal error.
         fail "Spec already exists for name: #{name}, type: #{type}, mode: #{mode} for object #{self}"
       end
       @_specs[name][mode][type][spec_placeholder.sub_type] = spec_placeholder
@@ -103,6 +110,7 @@ module Origen
       end
     end
 
+    # Returns the modes for this block
     def get_modes
       @_modes
     end
@@ -121,69 +129,99 @@ module Origen
       !!show_specs(options)
     end
 
+    # Adds a new feature to the block
+    def spec_feature(id, attrs, device, text, internal_comment)
+      # Welguisz:  No idea why this is here, but keeping it here because it follows other blocks
+      _spec_features
+      # Create a new feature and place it in the features 2-D Hash
+      @_spec_features[id][device] = Spec_Features.new(id, attrs, device, text, internal_comment)
+    end
+
     # Define and instantiate a Note object
     def note(id, type, options = {})
+      # Welguisz:  No idea why this is here, but keeping it here because it follows other blocks
       _notes
+      # Create a new note and place it in the notes 2-D Hash
       @_notes[id][type] = Note.new(id, type, options)
     end
 
     def exhibit(id, type, 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)
     end
 
     def doc_resource(selector = {}, table_title = {}, text = {}, options = {})
+      # Welguisz:  No idea why this is here, but keeping it here because it follows other blocks
       _doc_resources
       mode = selector[:mode]
       type = selector[:type]
       sub_type = selector[:sub_type]
       audience = selector[:audience]
+      # Create a new Document Resource and place it in the Doc Resources 4-D Hash
       @_doc_resources[mode][type][sub_type][audience] = Doc_Resource.new(selector, table_title, text, options)
     end
 
     def version_history(date, author, changes)
+      # Welguisz:  No idea why this is here, but keeping it here because it follows other blocks
       _version_history
+      # Create a new Version History and place it in the version history 2-D Hash
       tmp_ver_history = Version_History.new(date, author, changes)
       @_version_history[date][author] = tmp_ver_history
     end
 
     def override(block_options = {}, find_spec = {}, values = {}, options = {})
+      # Welguisz:  No idea why this is here, but keeping it here because it follows other blocks
       _overrides
       block = block_options[:block]
       spec_ref = find_spec[:spec_id]
       mode_ref = find_spec[:mode_ref]
       sub_type = find_spec[:sub_type]
       audience = find_spec[:audience]
+      # Create a new Override and place it in the overrides 5-D Hash
       @_overrides[block][spec_ref][mode_ref][sub_type][audience] = Override.new(block_options, find_spec, values, options)
     end
 
     def power_supply(gen, act)
+      # Welguisz:  No idea why this is here, but keeping it here because it follows other blocks
       _power_supplies
+      # Create a new Power Supply and place it in the power supplies 2-D Hash
       @_power_supplies[gen][act] = Power_Supply.new(gen, act)
     end
 
     def mode_select(block_information, mode_usage, power_information)
+      # Welguisz:  No idea why this is here, but keeping it here because it follows other blocks
       _mode_selects
+      # See if the mode will be used.  If so, create a new Mode Select and place it in mode_selects 2-D Hash
       if block_information[:usage]
         @_mode_selects[block_information[:name]][mode_usage[:mode]] = Mode_Select.new(block_information, mode_usage, power_information)
       end
     end
 
     def creation_info(author, date, version, src_info = {}, tool_info = {})
+      # Create a new Information Information.  Should only be one.
       @_creation_info = Creation_Info.new(author, date, version, src_info, tool_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
       options = {
         id:   nil,
         type: nil
       }.update(options)
+      # Empty 2-D Hash to be used for notes found based on id and type
       notes_found = Hash.new do |h, k|
+        # h is the id portion of the hash
+        # k is the type portion of the hash
         h[k] = {}
       end
-      _notes.filter(options[:id]).each do |id, hash|
+      # Filter @notes based off of the id
+      @_notes.filter(options[:id]).each do |id, hash|
+        # Filter hash based off of the type
         hash.filter(options[:type]).each do |type, note|
+          # Store the note into note_found
           notes_found[id][type] = note
         end
       end
@@ -196,6 +234,29 @@ module Origen
       end
     end
 
+    def spec_features(options = {})
+      options = {
+        id:     nil,
+        device: nil
+      }.update(options)
+      return @_spec_features if options[:id].nil? && options[:device].nil?
+      features_found = Hash.new do |h, k|
+        h[k] = {}
+      end
+      @_spec_features.filter(options[:id]).each do |id, hash|
+        hash.filter(options[:device]).each do |device, feat|
+          features_found[id][device] = feat
+        end
+      end
+      if features_found.empty?
+        return nil
+      elsif features_found.size == 1
+        features_found.values.first.values.first
+      else
+        return features_found
+      end
+    end
+
     def exhibits(options = {})
       options = {
         block:                nil,
@@ -348,6 +409,10 @@ module Origen
       @_creation_info = nil
     end
 
+    def delete_spec_features
+      @_spec_features = nil
+    end
+
     private
 
     def _specs
@@ -368,6 +433,12 @@ module Origen
       end
     end
 
+    def _spec_features
+      @_spec_features ||= Hash.new do |h, k|
+        h[k] = {}
+      end
+    end
+
     def _exhibits
       @_exhibits ||= Hash.new do |h, k|
         h[k] = Hash.new do |hh, kk|

data/lib/origen/specs/spec_features.rb

@@ -0,0 +1,46 @@
+module Origen
+  module Specs
+    # Ruby Data Class that contains Creation Information for the IP Block
+    class Spec_Features
+      # This is the Id of the Feature that will be referenced
+      # Future goal is to be able to tie this ID to a specification in a Product Requirements Document
+      attr_accessor :id
+
+      # Feature Type
+      # Current supported types are
+      #   intro :: Intro Paragraph for the Features Page
+      #   feature :: Main Feature (e.g. Additional peripherals include)
+      #   subfeature :: Sub Feature that will be a sub-bullet to feature.  (e.g. Four I2C controllers)
+      attr_accessor :type
+
+      # Feature Reference
+      #  To be used for sub-feature so that they can be linked easily
+      attr_accessor :feature_ref
+
+      # Applicable Devices for this feature.  This allows for multiple devices from one piece of silicon
+      #  If this feature is on Part B and Part D, then applicable devices will include Part B and Part D, but no other parts
+      attr_accessor :applicable_devices
+
+      # The actual text of the feature
+      attr_accessor :text
+
+      # Internal comments about this feature.  Why was this feature included here?  Any changes from the
+      # Product Requirements Document
+      attr_accessor :internal_comments
+
+      # Intended Audience for this feature. Internal or External?
+      attr_accessor :audience
+
+      # Initialize the Feature to be used
+      def initialize(id, attrs, applicable_devices, text, internal_comments)
+        @id = id
+        @type = attrs[:type]
+        @feature_ref = attrs[:feature_ref]
+        @audience = attrs[:audience]
+        @applicable_devices = applicable_devices
+        @text = text
+        @internal_comments = internal_comments
+      end
+    end # module Features
+  end # module Specs
+end # module Origen

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen
 version: !ruby/object:Gem::Version
-  version: 0.5.11
+  version: 0.6.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-02 00:00:00.000000000 Z
+date: 2016-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -582,6 +582,7 @@ files:
 - lib/origen/specs/override.rb
 - lib/origen/specs/power_supply.rb
 - lib/origen/specs/spec.rb
+- lib/origen/specs/spec_features.rb
 - lib/origen/specs/version_history.rb
 - lib/origen/sub_blocks.rb
 - lib/origen/top_level.rb