origen 0.60.7 → 0.60.9

data/lib/origen/registers/reg.rb

@@ -127,6 +127,7 @@ module Origen
         unless live_parameter.respond_to?(:is_a_live_parameter?) && live_parameter.is_a_live_parameter?
           fail 'Only live updating parameters should be bound, make sure you have not missed .live in the path to the parameter!'
         end
+
         @parameter_bound_bits ||= {}
         @parameter_bound_bits[bitname] = live_parameter
       end
@@ -381,7 +382,8 @@ module Origen
       # this register specifically however, use the meta method to get that.
       def default_reg_metadata
         Origen::Registers.default_reg_metadata.merge(
-          Origen::Registers.reg_metadata[owner.class] || {})
+          Origen::Registers.reg_metadata[owner.class] || {}
+        )
       end
 
       def bit_value_descriptions(bitname, options = {})
@@ -479,6 +481,7 @@ module Origen
         unless File.exist?(define_file)
           return desc
         end
+
         File.readlines(define_file).each do |line|
           if line =~ /^\s*#(.*)/
             desc << Regexp.last_match[1].strip
@@ -527,7 +530,7 @@ module Origen
             bit_params[:res] = bit_params[:data] if bit_params[:data]
             bit_params[:res] = bit_params[:reset] if bit_params[:reset]
             if num_bits == 1
-              add_bit(bit_id, position, bit_params)   # and add the new one
+              add_bit(bit_id, position, bit_params) # and add the new one
             else
               add_bus(bit_id, position, num_bits, bit_params)
             end
@@ -975,14 +978,16 @@ module Origen
       alias_method :has_bit, :has_bit?
       alias_method :has_bits, :has_bit?
 
+      # rubocop:disable Layout/MultilineHashBraceLayout
+
       # Add a bit to the register, should only be called internally
       def add_bit(id, position, options = {}) # :nodoc:
-        options = { data: @bits[position].data,  # If undefined preserve any data/reset value that has
-                    res:  @bits[position].data,   # already been applied at reg level
+        options = { data: @bits[position].data, # If undefined preserve any data/reset value that has
+                    res:  @bits[position].data # already been applied at reg level
                   }.merge(options)
 
         @lookup[id] = { pos: position, bits: 1, feature: options[:feature] }
-        @bits.delete_at(position)    # Remove the initial bit from this position
+        @bits.delete_at(position) # Remove the initial bit from this position
 
         @bits.insert(position, Bit.new(self, position, options))
         self
@@ -994,8 +999,8 @@ module Origen
         size.times do |n|
           default_data |= @bits[position + n].data << n
         end
-        options = { data: default_data,  # If undefined preserve any data/reset value that has
-                    res:  default_data,   # already been applied at reg level
+        options = { data: default_data, # If undefined preserve any data/reset value that has
+                    res:  default_data # already been applied at reg level
                   }.merge(options)
 
         @lookup[id] = { pos: position, bits: size }
@@ -1025,8 +1030,8 @@ module Origen
           size.times do |n|
             default_data |= @bits[position + n].data << n
           end
-          options = { data: default_data,  # If undefined preserve any data/reset value that has
-                      res:  default_data,   # already been applied at reg level
+          options = { data: default_data, # If undefined preserve any data/reset value that has
+                      res:  default_data # already been applied at reg level
                     }.merge(options)
 
           @lookup[id] = [] if @lookup[id].nil?
@@ -1038,9 +1043,10 @@ module Origen
             @bits.delete_at(position + n)
             @bits.insert(position + n, Bit.new(self, position + n, bit_options))
           end
-          self
+          self    # rubocop:disable Lint/Void
         end
       end
+      # rubocop:enable Layout/MultilineHashBraceLayout
 
       # Delete the bits in the collection from the register
       def delete_bit(collection)
@@ -1048,7 +1054,7 @@ module Origen
           @lookup.delete(name)
         end
         collection.each do |bit|
-          @bits.delete_at(bit.position)    # Remove the bit
+          @bits.delete_at(bit.position) # Remove the bit
           @bits.insert(bit.position, Bit.new(self, bit.position, writable: @init_as_writable))
         end
         self
@@ -1163,6 +1169,7 @@ module Origen
         end
 
         return nil unless @bits[number]
+
         if (params == :default || !params) && @bits[number].enabled?
           @bits[number]
         elsif params == :none && !@bits[number].has_feature_constraint?
@@ -1174,12 +1181,13 @@ module Origen
             unless @bits[number].enabled_by_feature?(param)
               return nil
             end
+
             @bits[number]
           end
         elsif @bits[number].enabled_by_feature?(params)
           @bits[number]
         else
-          return Bit.new(self, number, writable: false)
+          Bit.new(self, number, writable: false)
         end
       end
 
@@ -1211,19 +1219,19 @@ module Origen
                 return collection
               end
             end
-            return BitCollection.dummy(self, bit_name, size: collection.size, pos: @lookup[bit_name][:pos])
+            BitCollection.dummy(self, bit_name, size: collection.size, pos: @lookup[bit_name][:pos])
           else
-            return []
+            []
           end
 
         elsif split_group_reg == true # if this registers has split bits in its range
           if @lookup.is_a?(Hash) # && @lookup.include?(bit_name)
             collection = false
-            @lookup.each do |k, v|  # k is the bitname, v is the hash of bit data
+            @lookup.each do |k, v| # k is the bitname, v is the hash of bit data
               if k == bit_name
                 collection ||= BitCollection.new(self, k)
                 if v.is_a?(Array)
-                  v.reverse_each do |pb|  # loop each piece of bit group data
+                  v.reverse_each do |pb| # loop each piece of bit group data
                     (pb[:bits]).times do |i|
                       collection << @bits[pb[:pos] + i]
                     end
@@ -1255,12 +1263,12 @@ module Origen
               end
             end
             if @lookup.is_a?(Hash) && @lookup[bit_name].is_a?(Array)
-              return BitCollection.dummy(self, bit_name, size: collection.size, pos: @lookup[bit_name][0][:pos])
+              BitCollection.dummy(self, bit_name, size: collection.size, pos: @lookup[bit_name][0][:pos])
             else
-              return BitCollection.dummy(self, bit_name, size: collection.size, pos: @lookup[bit_name[:pos]])
+              BitCollection.dummy(self, bit_name, size: collection.size, pos: @lookup[bit_name[:pos]])
             end
           else
-            return []
+            []
           end
         end
       end
@@ -1274,9 +1282,7 @@ module Origen
         end
 
         if params
-          return params[:enabled_features] || params[:enabled_feature]
-        else
-          return nil
+          params[:enabled_features] || params[:enabled_feature]
         end
       end
 
@@ -1401,7 +1407,7 @@ module Origen
       # Cleans an input value, in some cases it could be a register object, or an explicit value.
       # This will return an explicit value in either case.
       def self.clean_value(value) # :nodoc:
-        value = value.val if value.respond_to?('val')  # Pull out the data value if a reg object has been passed in
+        value = value.val if value.respond_to?('val') # Pull out the data value if a reg object has been passed in
         value
       end
 
@@ -1439,9 +1445,9 @@ module Origen
                 return true
               end
             end
-            return false
+            false
           else
-            return feature == name
+            feature == name
           end
         end
       end
@@ -1483,7 +1489,7 @@ module Origen
                 break # break if feature not found and return false
               end
             end # iterated through all features in array
-            return value
+            value
           else # if feature.class != Array
             loop do
               if current_owner.respond_to?(:owner)
@@ -1506,10 +1512,10 @@ module Origen
                 value = true
               end
             end
-            return value
+            value
           end
         else
-          return true
+          true
         end
       end
 

data/lib/origen/registers.rb

@@ -20,7 +20,7 @@ module Origen
     included do
       include Origen::ModelInitializer
       include Origen::SubBlocks
-      include Origen::Callbacks  # Required for global register reset
+      include Origen::Callbacks # Required for global register reset
 
       attr_accessor :owner
       attr_accessor :name
@@ -31,13 +31,11 @@ module Origen
     # not explicitly defined on this model it will be inherited from the parent
     # and will default to :lsb0 at the top-level
     def bit_order
-      @bit_order ||= begin
-        if parent
-          parent.bit_order
-        else
-          :lsb0
-        end
-      end
+      @bit_order ||= if parent
+                       parent.bit_order
+                     else
+                       :lsb0
+                     end
     end
 
     def method_missing(method, *args, &block) # :nodoc:
@@ -189,7 +187,7 @@ module Origen
                 break # break if feature not found and return false
               end
             end # iterated through all features in array
-            return value
+            value
           else # if feature.class != Array
             loop do
               if current_owner.respond_to?(:owner)
@@ -212,10 +210,10 @@ module Origen
                 value = true
               end
             end
-            return value
+            value
           end
         else
-          return true
+          true
         end
       end
 
@@ -230,9 +228,9 @@ module Origen
                 return true
               end
             end
-            return false
+            false
           else
-            return feature == name
+            feature == name
           end
         end
       end
@@ -311,6 +309,7 @@ module Origen
       if address.is_a?(Hash)
         fail 'add_reg requires the address to be supplied as the 2nd argument, e.g. add_reg :my_reg, 0x1000'
       end
+
       size, bit_info = nil, size if size.is_a?(Hash)
       size ||= bit_info.delete(:size) || 32
       description = bit_info.delete(:description)
@@ -328,7 +327,7 @@ module Origen
       @max_reg_address ||= address
       # Must set an initial value, otherwise max_address_reg_size will be nil if a sub_block contains only
       # a single register.
-      @max_address_reg_size = size unless @max_address_reg_size
+      @max_address_reg_size ||= size
       @min_reg_address = address if address < @min_reg_address
       if address > @max_reg_address
         @max_address_reg_size = size
@@ -409,11 +408,11 @@ module Origen
         @new_reg_attrs[name] = attrs
       else
         if @new_reg_attrs[name].is_a? Hash
-          temparray = temparray.push(@new_reg_attrs[name])
+          temparray.push(@new_reg_attrs[name])
         else
           temparray = @new_reg_attrs[name]
         end
-        temparray = temparray.push(attrs)
+        temparray.push(attrs)
         # added the sort so that the order the registers bits is described is not important
         @new_reg_attrs[name] = temparray.sort { |a, b| b[:pos] <=> a[:pos] }
 
@@ -449,6 +448,7 @@ module Origen
     # @api private
     def instantiate_reg(id, attrs)
       return _registers[id] unless _registers[id].is_a?(Origen::Registers::Placeholder)
+
       attributes = {
         define_file: attrs[:define_file],
         description: attrs[:description]
@@ -493,10 +493,10 @@ module Origen
         test_for_true_false: true
       }.update(params)
       if params.key?(:enabled_features) || params.key?(:enabled_feature)
-        return !!get_registers(params).include?(name)
+        !!get_registers(params).include?(name)
       else
         params[:enabled_features] = :default
-        return !!get_registers(params).include?(name)
+        !!get_registers(params).include?(name)
       end
     end
     alias_method :has_reg, :has_reg?
@@ -520,13 +520,14 @@ module Origen
         if !args.empty? && args.size == 1 && (args[0].class != Hash || (args[0].key?(:name) && args[0].size == 1))
           if args[0].class == Hash
             name = args[0][:name]
-          else name = args.first
+          else
+            name = args.first
           end
           if has_reg(name)
-            return _registers[name]
+            _registers[name]
           elsif name =~ /\/(.+)\//
             regex = Regexp.last_match(1)
-            return match_registers(regex)
+            match_registers(regex)
           else
             if Origen.config.strict_errors
               puts ''
@@ -560,7 +561,7 @@ module Origen
           # Example use case:
           # reg(:enabled_features =>[:fac, fac2])
           elsif params.size == 1 && params.key?(:enabled_features)
-            return get_registers(enabled_features: params[:enabled_features])
+            get_registers(enabled_features: params[:enabled_features])
           end
 
         # Example use case:
@@ -578,9 +579,9 @@ module Origen
           end
         elsif args.empty?
           if _registers.empty?
-            return _registers
+            _registers
           else
-            return get_registers(enabled_features: :default)
+            get_registers(enabled_features: :default)
           end
         else
           if Origen.config.strict_errors

data/lib/origen/remote_manager.rb

@@ -57,6 +57,7 @@ module Origen
           if remote[:path]
             fail "The following remote is defined as a path, but that is not allowed in production: #{remote}"
           end
+
           version = Origen::VersionString.new(remote[:version])
           unless version.valid?
             fail "The following remote version is not in a valid format: #{remote}"
@@ -269,7 +270,7 @@ module Origen
     end
 
     def top_level_remotes
-      Origen.app.config.remotes    #+ Origen.app.config.remotes_dev (there are no core remotes at this time)
+      Origen.app.config.remotes #+ Origen.app.config.remotes_dev (there are no core remotes at this time)
     end
 
     def remotes
@@ -353,7 +354,7 @@ module Origen
                 f.write tag
               end
             end
-          rescue Origen::GitError, Origen::DesignSyncError, Origen::PerforceError  => e
+          rescue Origen::GitError, Origen::DesignSyncError, Origen::PerforceError => e
             # If Git failed in the remote, its usually easy to see what the problem is, but now *where* it is.
             # This will prepend the failing remote along with the error from the revision control system,
             # then rethrow the error

data/lib/origen/revision_control/base.rb

@@ -19,14 +19,13 @@ module Origen
       # Method to use by Origen::RemoteManager to handle fetching a remote file
       attr_reader :remotes_method
 
-      # rubocop:disable Lint/UnusedMethodArgument
-
       # All revision control instances represent a remote server mapping
       # to a local directory, :remote and :local options are required
       def initialize(options = {})
         unless options[:remote] && options[:local]
           fail ':remote and :local options must be supplied when instantiating a new RevisionControl object'
         end
+
         @remote = Pathname.new(options[:remote])
         @local = Pathname.new(options[:local]).expand_path
         @remotes_method = :checkout
@@ -207,8 +206,6 @@ module Origen
       end
       alias_method :subversion?, :svn?
 
-      # rubocop:enable Lint/UnusedMethodArgument
-
       private
 
       def clean_path(path = nil, options = {})

data/lib/origen/revision_control/design_sync.rb

@@ -24,6 +24,7 @@ module Origen
         fail "Directory does not exist: #{dir}" unless dir.exist?
         fail "Only directories are supported by remote_check_in, this is not a directory: #{dir}" unless dir.directory?
         fail 'No vault option supplied to remote_check_in!' unless options[:vault]
+
         scratch = Pathname.new("#{Origen.app.workspace_manager.imports_directory}/design_sync/scratch")
         FileUtils.rm_rf(scratch) if scratch.exist?
         FileUtils.mkdir_p(scratch)
@@ -77,6 +78,7 @@ module Origen
         dir = Pathname.new(dir)
         fail "Directory does not exist: #{dir}" unless dir.exist?
         fail "Only directories are supported by remove_dot_syncs, this is not a directory: #{dir}" unless dir.directory?
+
         Dir.glob("#{dir}/**/.SYNC").sort.each do |dot_sync|
           FileUtils.rm_rf(dot_sync)
         end
@@ -180,10 +182,10 @@ module Origen
 
         files = dssc(cmd, options).reject do |item|
           item.strip.empty? ||
-          item =~ /^(Name|Directory|---)/
+            item =~ /^(Name|Directory|---)/
         end
         files.map! do |file|
-          file.strip!  # Strip off any whitespace from all objects
+          file.strip! # Strip off any whitespace from all objects
           file.sub!(/^#{full_path_prefix}/, '')
           file.sub('|', ':')
           file.sub!(/^/, "#{paths.first}/")
@@ -202,7 +204,7 @@ module Origen
           item =~ /^(Name|Directory|---)/ || item.strip.empty?
         end
         files.map! do |file|
-          file.strip!  # Strip off any whitespace from all objects
+          file.strip! # Strip off any whitespace from all objects
           file.sub!(/^#{full_path_prefix}/, '')
           file.sub('|', ':')
         end
@@ -276,13 +278,11 @@ module Origen
       private
 
       def full_path_prefix
-        @full_path_prefix ||= begin
-          if Origen.running_on_windows?
-            'file:///'
-          else
-            'file://'
-          end
-        end
+        @full_path_prefix ||= if Origen.running_on_windows?
+                                'file:///'
+                              else
+                                'file://'
+                              end
       end
 
       def initialize_local_dir(options = {})

data/lib/origen/revision_control/git.rb

@@ -66,6 +66,7 @@ module Origen
           if paths.size > 1 || paths.first != local.to_s
             fail 'The Git driver does not support partial merge checkout, it has to be the whole workspace'
           end
+
           git 'reset HEAD'
           res = git 'stash', options
           stashed = !res.any? { |l| l =~ /^No local changes to save/ }
@@ -122,11 +123,11 @@ module Origen
           if options[:comment] && !options[:comment].strip.empty?
             cmd += " -m \"#{options[:comment].strip}\""
           else
-            cmd += " -m \"No comment!\""
+            cmd += ' -m "No comment!"'
           end
           if options[:author]
             if options[:author].respond_to?(:name_and_email)
-              author =  options[:author].name_and_email
+              author = options[:author].name_and_email
             else
               author = "#{options[:author]} <>"
             end
@@ -346,6 +347,7 @@ module Origen
 
       def initialize_local_dir(options = {})
         return if options[:build_method] == :clone
+
         super
         unless initialized?(options)
           Origen.log.debug "Initializing Git workspace at #{local}"

data/lib/origen/site_config/config.rb

@@ -86,7 +86,6 @@ module Origen
             File.open(cached_file, 'w+') do |f|
               f.write(text)
             end
-
           rescue SocketError => e
             puts red("Origen: Site Config: Unable to connect to #{path}")
             puts red('Origen: Site Config: Failed to retrieve centralized site config!')
@@ -125,6 +124,8 @@ module Origen
           ERB.new(File.read(erb), 0, '%<>')
         end
 
+        # YAML.safe_load is prefered
+        # rubocop:disable Security/YAMLLoad
         if centralized?
           if !cached?
             if fetch
@@ -147,6 +148,7 @@ module Origen
             @values = (YAML.load_file(path) || {})
           end
         end
+        # rubocop:enable Security/YAMLLoad
 
         unless @values.is_a?(Hash)
           puts red("Origen: Site Config: The config at #{path} was not parsed as a Hash, but as a #{@values.class}")

data/lib/origen/site_config.rb

@@ -243,11 +243,14 @@ module Origen
       ENV.key?(val)
     end
 
+    # rubocop:disable Lint/DuplicateMethods
+
     def env(val)
       if env_contains?(val)
         ENV[val]
       end
     end
+    # rubocop:enable Lint/DuplicateMethods
 
     def inspect_variable(*vars)
       vars.each do |var|

data/lib/origen/specs/checkers.rb

@@ -5,6 +5,7 @@ module Origen
       def name_audit(name)
         return name if name.nil?
         return nil unless name.is_a?(Symbol) || name.is_a?(String)
+
         if name == :inspect
           Origen.log.debug ':inspect is a reserved spec name'
           return nil
@@ -28,6 +29,7 @@ module Origen
         if (@min.exp.to_s.include? '/') || (@max.exp.to_s.include? '/')
           return status
         end
+
         if @min.exp.nil? ^ @max.exp.nil?
           @limit_type = :single_sided
           if @typ.exp
@@ -72,6 +74,7 @@ module Origen
       def evaluate_limit(limit)
         return limit if limit.is_a?(Numeric)
         return nil if limit.nil?
+
         if limit.is_a? Symbol
           limit = ':' + limit.to_s
         else
@@ -129,18 +132,19 @@ module Origen
           begin
             result = eval(limit)
             return result.round(4) if result.is_a? Numeric
-            rescue ::SyntaxError, ::NameError, ::TypeError
-              Origen.log.debug "Limit '#{limit}' had to be rescued, storing it as a #{limit.class}"
-              if limit.is_a? Symbol
-                return limit
-              else
-                return "#{limit}"
-              end
+          rescue ::SyntaxError, ::NameError, ::TypeError
+            Origen.log.debug "Limit '#{limit}' had to be rescued, storing it as a #{limit.class}"
+            if limit.is_a? Symbol
+              limit
+            else
+              "#{limit}"
+            end
           end
         else
-          return result
+          result
         end
       end
+      # rubocop:enable Style/RescueModifier:
     end
   end
 end

data/lib/origen/specs/doc_resource.rb

@@ -62,9 +62,8 @@ module Origen
         tmp['audience'] = @audience unless @audience.nil?
         doc_resource_ml = Nokogiri::XML::Builder.new do |xml|
           xml.doc_resource(tmp.each do |t, d|
-            "#{t}=\"#{d}\""
-          end
-                          ) do
+            "#{t}=\"#{d}\""     # rubocop:disable Lint/Void
+          end) do
             unless @table_title.nil? && @note_refs.size == 0 && @exhibit_refs.size == 0
               unless @note_refs.first.to_s.size == 0
                 unless @exhibit_refs.first.to_s.size == 0
@@ -98,7 +97,7 @@ module Origen
                     end # unless @exhibit_refs.size == 0
                   end # xml.title.done
                 end # unless @exhibit_refs.to_s.size == 0
-              end  # unless @note_refs.to_s.size == 0
+              end # unless @note_refs.to_s.size == 0
             end # unless @table_title.nil? && @note_refs.size == 0 && @exhibit_refs.size == 0
             unless @before_table.nil? && @after_table.nil?
               xml.paragraphs do

data/lib/origen/specs/spec.rb

@@ -83,6 +83,7 @@ module Origen
       def initialize(name, type, mode, owner_name, &block)
         @name = name_audit(name)
         fail 'Specification names must be of types Symbol or String and cannot start with a number' if @name.nil?
+
         @type = type
         @sub_type = nil # not necessary to be able to find a unique spec, but required for some specs
         @mode = mode
@@ -98,6 +99,7 @@ module Origen
         @guardband = nil
         (block.arity < 1 ? (instance_eval(&block)) : block.call(self)) if block_given?
         fail "Spec type must be one of #{TYPES.join(', ')}" unless TYPES.include? type
+
         @min = Limit.new(@min)
         @max = Limit.new(@max)
         @typ = Limit.new(@typ)
@@ -206,6 +208,7 @@ module Origen
         instance_variables.each do |ivar|
           ivar_sym = ivar.to_s.gsub('@', '').to_sym
           next if ivar_sym == :notes # temporarily disable until notes diff method written
+
           ivar_str = ivar.to_s.gsub('@', '')
           if compare_spec.respond_to? ivar_sym
             # Check if the instance variable is a Limit and if so then find
@@ -261,6 +264,7 @@ module Origen
       # Returns a Note object from the notes hash
       def notes(id = nil)
         return nil if @notes.nil?
+
         @notes.filter(id)
       end
 
@@ -310,7 +314,7 @@ module Origen
         name_set += 4 unless @type.nil?
         name_set += 2 unless @sub_type.nil?
         unless @mode.nil?
-          unless  (@mode.to_s.include? 'local') || (@mode.to_s.include? 'global')
+          unless (@mode.to_s.include? 'local') || (@mode.to_s.include? 'global')
             name_set += 1
           end
         end

data/lib/origen/specs/version_history.rb

@@ -4,7 +4,7 @@ module Origen
     class Version_History
       attr_accessor :label, :date, :author, :changes, :external_changes_internal
 
-      def initialize(date, author, changes, label = nil, external_changes_internal =  nil)
+      def initialize(date, author, changes, label = nil, external_changes_internal = nil)
         @date = date
         @author = author
         @changes = changes