origen 0.33.0 → 0.33.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bbe04ff06fc71620ec53701cfda0b4ea651b44a
-  data.tar.gz: 3515abaaad4c9e9779dd3064182d17b62abb9990
+  metadata.gz: ea3de179e5091905ff3b66188f8401c3cfff2188
+  data.tar.gz: 6e3c6bd9aba7ef3b6708c808c23698e26b9eb09a
 SHA512:
-  metadata.gz: fe7b6df198be766746adfdd12d9c2fb2c49d7808f20c595785adf03816929376bbbd5252efaec7edd5d8db70905187fdc79229ab76c4eb4ea8a37606edf8e436
-  data.tar.gz: 1d27cf5f647ab632461e78c45ab91fb572d06ac80a6cdccb066f34e5b7136355fb77b76163526212cd98c4f28e782045ed2c9dfc7b0c7335086594d77c0bf9e2
+  metadata.gz: a1e8f905773712b62081c45d718b2cf73eea2b2658b33e5d01bea258454ba913286992ccf9253f15c5accc37981d0a44a2e7479f5c76c566e89ae7f0cba7aa49
+  data.tar.gz: 089977506d24231885841260a7d6b5610b9e6b2db41bda63940b14f930cbfc7869f1c22c7ab8cd8b1cc2271f89cbce160e1a324aad3537db7481eb17eafc941c

data/config/version.rb

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

data/lib/origen/commands.rb

@@ -26,6 +26,9 @@ ORIGEN_COMMAND_ALIASES = {
 @command = ORIGEN_COMMAND_ALIASES[@command] || @command
 @global_commands = []
 
+# Moved here so boot.rb file can know the current command
+Origen.send :current_command=, @command
+
 # Don't log to file during the save command since we need to preserve the last log,
 # this is done as early in the process as possible so any deprecation warnings during
 # load don't trigger a new log
@@ -91,7 +94,6 @@ require 'origen/global_methods'
 include Origen::GlobalMethods
 
 Origen.lsf.current_command = @command
-Origen.send :current_command=, @command
 
 if ARGV.delete('-d') || ARGV.delete('--debug')
   begin

data/lib/origen/componentable.rb

@@ -384,11 +384,7 @@ module Origen
           opts = {}
 
           # merge the given options with any that are overriden with the block.
-          if block_given?
-            collector = Origen::Utility::Collector.new
-            yield collector
-            options.merge!(collector.store)
-          end
+          options = Origen::Utility.collector(hash: options, merge_method: :keep_hash, &block).to_h
 
           # go through the options one by one now and make sure that each element is either an array to be split
           # by the instances, or is a single object. If not one of these two, complain.
@@ -417,11 +413,7 @@ module Origen
         end
         instances
       else
-        if block_given?
-          collector = Origen::Utility::Collector.new
-          yield collector
-          options.merge!(collector.store)
-        end
+        options = Origen::Utility.collector(hash: options, merge_method: :keep_hash, &block).to_h
         { name => options }
       end
     end
@@ -443,11 +435,7 @@ module Origen
         parent: parent
       }.merge(options)
 
-      if block_given?
-        collector = Origen::Utility::Collector.new
-        yield collector
-        options.merge!(collector.store)
-      end
+      options = Origen::Utility.collector(hash: options, merge_method: :keep_hash, &block).to_h
 
       # Instantiate the class. This will place the object in the @_componentable_container at the indicated name
       _instantiate_class(name, options)

data/lib/origen/generator/flow.rb

@@ -4,6 +4,7 @@ module Origen
       attr_accessor :top_level
 
       def create(options = {}, &block)
+        Origen.deprecated 'Origen core will no longer support program generation in v1, add the origen_testers plugin to your application to fix this warning'
         # Refresh the target to start all settings from scratch each time
         # This is an easy way to reset all registered values
         Origen.app.reload_target!

data/lib/origen/model.rb

@@ -219,7 +219,7 @@ module Origen
     def current_mode=(id)
       @current_mode = id.is_a?(ChipMode) ? id.id : id
       Origen.app.listeners_for(:on_mode_changed).each do |listener|
-        listener.on_mode_changed(mode: @current_mode)
+        listener.on_mode_changed(mode: @current_mode, instance: self)
       end
       @current_mode
     end

data/lib/origen/registers.rb

@@ -93,7 +93,7 @@ module Origen
         if block_given?
           collector = Origen::Utility::Collector.new
           yield collector
-          Origen::Registers.reg_metadata[:global].merge!(collector.store)
+          Origen::Registers.reg_metadata[:global].merge!(collector.to_h)
         end
         Origen::Registers.reg_metadata[:global]
       end
@@ -109,7 +109,7 @@ module Origen
         if block_given?
           collector = Origen::Utility::Collector.new
           yield collector
-          Origen::Registers.bit_metadata[:global].merge!(collector.store)
+          Origen::Registers.bit_metadata[:global].merge!(collector.to_h)
         end
         Origen::Registers.bit_metadata[:global]
       end
@@ -424,7 +424,7 @@ module Origen
       if block_given?
         collector = Origen::Utility::Collector.new
         yield collector
-        Origen::Registers.reg_metadata[self.class].merge!(collector.store)
+        Origen::Registers.reg_metadata[self.class].merge!(collector.to_h)
       end
       Origen::Registers.reg_metadata[self.class]
     end
@@ -435,7 +435,7 @@ module Origen
       if block_given?
         collector = Origen::Utility::Collector.new
         yield collector
-        Origen::Registers.bit_metadata[self.class].merge!(collector.store)
+        Origen::Registers.bit_metadata[self.class].merge!(collector.to_h)
       end
       Origen::Registers.bit_metadata[self.class]
     end

data/lib/origen/utility.rb

@@ -96,5 +96,9 @@ module Origen
         end
       end
     end
+
+    def self.collector(options = {}, &block)
+      Origen::Utility::Collector.new(options, &block)
+    end
   end
 end

data/lib/origen/utility/collector.rb

@@ -1,14 +1,78 @@
 module Origen
   module Utility
     class Collector
-      attr_reader :store
+      attr_reader :_hash_
+      attr_reader :merge_method
 
-      def initialize
-        @store = {}
+      # Need to keep a seperate methods list so we know what's been added by method missing instead of what's
+      # been added either by the hash or by method missing.
+      # Only overwriting a value in the block should cause an error. Overriding a value from the hash depends on
+      # the merge method's setting.
+      attr_reader :_methods_
+
+      def initialize(options = {}, &block)
+        @merge_method = options[:merge_method] || :keep_hash
+        @fail_on_empty_args = options[:fail_on_empty_args]
+        unless [:keep_hash, :keep_block, :fail].include?(@merge_method)
+          fail Origen::OrigenError, "Origen::Utility::Collector cannot merge with method :#{@merge_method} (of class #{@merge_method.class}). Known merge methods are :keep_hash (default), :keep_block, or :fail"
+        end
+
+        @_hash_ = options.key?(:hash) ? options[:hash].clone : {}
+        @_methods_ = []
+
+        if block_given?
+          yield self
+        end
+      end
+
+      # Legacy store method.
+      def store
+        Origen.log.deprecate 'Collector::store method was used. Please use the Ruby-centric Collector::to_h or Collector::to_hash method instead' \
+                             " Called from: #{caller[0]}"
+        @_hash_
+      end
+
+      def to_hash
+        @_hash_
       end
+      alias_method :to_h, :to_hash
 
       def method_missing(method, *args, &_block)
-        @store[method.to_s.sub('=', '').to_sym] = args.first
+        key = method.to_s.sub('=', '').to_sym
+
+        # Check that the arguments are correct
+        if block_given? && !args.empty?
+          # raise Origen::OrigenError, "Origen::Utility::Collector detected both the hash and block attempting to set :#{key} (merge_method set to :fail)"
+          fail ArgumentError, "Origen::Utility::Collector cannot accept both an argument list and block simultaneously for :#{key}. Please use one or the other."
+        elsif block_given?
+          val = _block
+        elsif args.size == 0
+          # Set any empty argument to nil
+          val = nil
+        elsif args.size > 1
+          fail ArgumentError, "Origen::Utility::Collector does not allow method :#{key} more than 1 argument. Received 3 arguments."
+        else
+          val = args.first
+        end
+
+        # Check if we've already added this key via a method
+        if _methods_.include?(key)
+          fail Origen::OrigenError, "Origen::Utility::Collector does not allow method :#{key} to be set more than a single time. :#{key} is set to #{_hash_[key]}, tried to set it again to #{val}"
+        end
+
+        # indicate that we've seen this method, and decide whether or not to add the new value
+        _methods_ << key
+
+        # Merge the value (or don't, depending on what is set)
+        if merge_method == :keep_block || !_hash_.key?(key)
+          _hash_[key] = val
+        elsif merge_method == :fail
+          fail Origen::OrigenError, "Origen::Utility::Collector detected both the hash and block attempting to set :#{key} (merge_method set to :fail)"
+        end
+        # store[key] = val if !store.key?(key) || (store.key?(key) && merge_method == :keep_block)
+
+        # Return self instead of the key value to allow for one-line collector statements
+        self
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.33.1
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-19 00:00:00.000000000 Z
+date: 2018-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -352,6 +352,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.2
 description: 
 email:
 - stephen.f.mcginty@gmail.com