origen 0.60.7 → 0.60.8

data/lib/origen/features.rb

@@ -27,7 +27,7 @@ module Origen
             options[:description] = fetch_description(name)
           end
           features[name] = Feature.new(name, options)
-        else          # if feature with given name already exists
+        else # if feature with given name already exists
           fail "Feature #{name} already added!"
         end
       end
@@ -72,17 +72,15 @@ module Origen
       end
     end
 
-    public
-
     def has_features?(name = nil)
       if !name
         if feature.size == 0
-          return false
+          false
         else
-          return true
+          true
         end
       else
-        return feature.include?(name)
+        feature.include?(name)
       end
     end
     alias_method :has_feature?, :has_features?

data/lib/origen/file_handler.rb

@@ -133,14 +133,14 @@ module Origen
           Pathname.new(m)
         else
           if options[:allow_missing]
-            return nil
+            nil
           else
             fail "Can't find: #{file}"
           end
         end
       else
         if options[:allow_missing]
-          return nil
+          nil
         else
           fail "Can't find: #{file}"
         end
@@ -152,17 +152,17 @@ module Origen
       if file_plugin
         if Origen.app.plugins.current
           if file_plugin == Origen.app.plugins.current.name
-            return path
+            path
           else
             puts "The requested file is from plugin #{file_plugin} and current system plugin is set to plugin #{Origen.app.plugins.current.name}!"
             fail 'Incorrect plugin error!'
           end
         else
           Origen.app.plugins.temporary = file_plugin
-          return path
+          path
         end
       else
-        return path
+        path
       end
     end
 
@@ -184,13 +184,13 @@ module Origen
       end
 
       if matches.size == 0
-        return nil
+        nil
       elsif matches.size > 1
         puts 'The following matches were found:'
         puts matches
         fail "Ambiguous file #{file}"
       else
-        return check(matches.first)
+        check(matches.first)
       end
     end
 
@@ -380,6 +380,7 @@ module Origen
 
     def current_directory
       return @current_directory if @current_directory
+
       @current_directory = clean_path_to(current_file).dirname if current_file
     end
 

data/lib/origen/fuses/fuse_field.rb

@@ -33,11 +33,11 @@ module Origen
         end
 
         def reprogrammeable?
-          self.respond_to?(:reprogrammeable) ? reprogrammeable : true
+          respond_to?(:reprogrammeable) ? reprogrammeable : true
         end
 
         def customer_visible?
-          self.respond_to?(:customer_visible) ? customer_visible : false
+          respond_to?(:customer_visible) ? customer_visible : false
         end
       end
     end

data/lib/origen/generator/compiler.rb

@@ -119,7 +119,7 @@ module Origen
           else
             File.open(f, 'w') { |out| out.puts output }
           end
-        else  # Just copy it across
+        else # Just copy it across
           out = output_file(file, options)
           # Delete the target if it already exists, this prevents permission denied errors when copying
           FileUtils.rm_f(out.to_s) if File.exist?(out.to_s)
@@ -131,7 +131,7 @@ module Origen
           if @check_for_changes
             check_for_changes(output_file(file, options), reference_file(file, options),
                               comment_char: Origen.app.tester ? Origen.app.tester.program_comment_char : nil,
-                              compile_job:  true, ignore_blank_lines: options[:ignore_blank_lines])
+                              compile_job: true, ignore_blank_lines: options[:ignore_blank_lines])
           end
         end
       end
@@ -179,9 +179,7 @@ module Origen
         # to get a hold of its internal scope
         unless b.is_a?(Binding)
           b.define_singleton_method :_get_binding do |local_opts, &_block|
-            # rubocop:disable Lint/UselessAssignment
             options = local_opts
-            # rubocop:enable Lint/UselessAssignment
             binding
           end
           # Here the global options, the ones visible right now, are passed to into the method defined above,

data/lib/origen/generator/job.rb

@@ -54,6 +54,7 @@ module Origen
         if !@pattern && !@output_file_body
           fail 'Sorry the output_pattern is not available until the job has been run'
         end
+
         body = @output_file_body ? @output_file_body : File.basename(@pattern, '.rb')
         output_prefix + body + output_postfix + split_number + output_extension
       end
@@ -155,7 +156,7 @@ module Origen
             else
               Origen.log.start_job(strip_dir_and_ext(@requested_pattern), :pattern_generator)
             end
-            Origen.generator.pattern.reset      # Resets the pattern controller ready for a new pattern
+            Origen.generator.pattern.reset # Resets the pattern controller ready for a new pattern
             # Give the app a chance to handle pattern dispatch
             skip = false
             Origen.app.listeners_for(:before_pattern_lookup).each do |listener|
@@ -190,7 +191,7 @@ module Origen
                   @output_file_body = @pattern[:output]
                   @pattern = @pattern[:pattern]
                 end
-                load @pattern unless @pattern == :skip  # Run the pattern
+                load @pattern unless @pattern == :skip # Run the pattern
               end
             end
           end

data/lib/origen/generator/pattern.rb

@@ -245,7 +245,7 @@ module Origen
       #
       # @api private
       def reset
-        $desc = nil  # Clear the description
+        $desc = nil # Clear the description
       end
 
       private
@@ -267,7 +267,7 @@ module Origen
       # Creates a header and footer for the pattern based on the current tester and any supplied options
       def pattern_wrapper(iterators, args, options = {})
         pattern_open(options.merge(iterators: iterators, args: args))
-        yield      # Pass control back to the pattern source
+        yield # Pass control back to the pattern source
         pattern_close(options)
       end
 
@@ -400,7 +400,7 @@ module Origen
         injection = config_loc.config.send(scope).call({})
         if injection.nil?
           # Do nothing. It is assumed in this acase that the pattern header has not comments to add at this scope.
-          return
+          nil
         elsif injection.is_a?(String)
           c2(' ' * message_spacing + message)
           c2(' ' * line_spacing + injection.to_s)

data/lib/origen/generator/pattern_finder.rb

@@ -11,7 +11,7 @@ module Origen
         end
 
         name = File.basename(name)
-        @requested_pattern = name   # Remember what was originally asked for in case
+        @requested_pattern = name # Remember what was originally asked for in case
         # it needs to be output in an error message
 
         # Strip the prefix if exists
@@ -56,6 +56,7 @@ module Origen
             end
           end
           return :skip unless proceed_with_pattern?(name) # The application has elected not to run this pattern
+
           pats = matching_patterns(name)
           if pats.size == 0
             pats = all_matches(name)
@@ -132,20 +133,20 @@ module Origen
         if file_plugin
           if Origen.app.plugins.current
             if file_plugin == Origen.app.plugins.current.name
-              return proceed_with_pattern?(path) ? path : :skip
+              proceed_with_pattern?(path) ? path : :skip
             elsif !options[:current_plugin]
               Origen.app.plugins.current.temporary = file_plugin
-              return proceed_with_pattern?(path) ? path : :skip
+              proceed_with_pattern?(path) ? path : :skip
             else
               puts "The requested pattern is from plugin #{file_plugin} and current system plugin is set to plugin #{Origen.app.plugins.current.name}!"
               fail 'Incorrect plugin error!'
             end
           else
             Origen.app.plugins.current.temporary = file_plugin
-            return proceed_with_pattern?(path) ? path : :skip
+            proceed_with_pattern?(path) ? path : :skip
           end
         else
-          return proceed_with_pattern?(path) ? path : :skip
+          proceed_with_pattern?(path) ? path : :skip
         end
       end
 

data/lib/origen/generator/pattern_sequence.rb

@@ -89,6 +89,7 @@ module Origen
         end
         # Just continue if this thread is not in the list
         return unless ids.include?(current_thread.id)
+
         # If we have entered the same sync up point after having previously completed it,
         # then clear it and start again
         if @sync_ups[location] && @sync_ups[location][:completed]
@@ -139,6 +140,7 @@ module Origen
           # It should be possible to get an execution profile in these cases if someone were to invest the
           # time in it to workout why this variable is not set upstream in these cases.
           return unless @cycle_count_stop
+
           cycles_per_tick = (@cycle_count_stop / (line_size * 1.0)).ceil
           if tester.try(:sim?)
             execution_time = tester.execution_time_in_ns / 1_000_000_000.0
@@ -193,6 +195,7 @@ module Origen
 
       def pretty_time(time, number_decimal_places = 0)
         return '0' if time == 0
+
         if time < 1.us
           "%.#{number_decimal_places}fns" % (time * 1_000_000_000)
         elsif time < 1.ms

data/lib/origen/generator/renderer.rb

@@ -5,11 +5,11 @@ module Origen
     module Renderer
       def render(file, options = {}, &block)
         fail 'File argument is nil' unless file
+
         file = Origen.file_handler.clean_path_to_sub_template(file)
         current_pipeline << { file: file, options: options,
                               placeholder: placeholder, block: block,
-                              indent: options[:indent] || 0
-                            }
+                              indent: options[:indent] || 0 }
         if block_given?
           self.current_buffer += current_pipeline.last[:placeholder] + "\n"
         end
@@ -47,8 +47,7 @@ module Origen
           output = compile(current[:file],
                            sub_template: true,
                            block:        current[:block],
-                           scope:        @scope
-                          )
+                           scope:        @scope)
           if current[:indent] && current[:indent] > 0
             indent = ' ' * current[:indent]
             output = output.split("\n").map { |l| indent + l }.join("\n")

data/lib/origen/generator/resources.rb

@@ -9,7 +9,7 @@ module Origen
         Origen.app.reload_target!
         Origen.tester.generating = :program
         sub_flow = @top_level
-        @top_level = true unless @top_level
+        @top_level ||= true
         job.output_file_body = options.delete(:name).to_s if options[:name]
         if sub_flow
           interface = Origen.interface

data/lib/origen/generator/stage.rb

@@ -19,8 +19,10 @@ module Origen
         i = current_bank.size - 1
         while offset >= 0
           return nil if i < 0
+
           unless current_bank[i].is_a?(String)
             return current_bank[i] if offset == 0
+
             offset -= 1
           end
           i -= 1
@@ -74,6 +76,7 @@ module Origen
 
       def current_bank
         return @vault[@bank] if @vault[@bank]
+
         @vault[@bank] = []
       end
 

data/lib/origen/limits/limit.rb

@@ -1,7 +1,8 @@
 module Origen
   module Limits
     class Limit
-      attr_accessor :expr, :value, :owner, :type
+      attr_accessor :expr, :owner, :type
+      attr_writer :value
 
       def initialize(expr, type, owner, options = {})
         @expr = expr
@@ -35,6 +36,7 @@ module Origen
           return owner.limits(ref).send(type).value
           # Check if the reference is to a power domain
         end
+
         if Origen.top_level.respond_to? :power_domains
           if Origen.top_level.power_domains.include? ref
             # Need to check the limit type and retrieve the appropriate value
@@ -52,9 +54,9 @@ module Origen
             # Need to check the limit type and retrieve the appropriate value
             case @type.to_s
             when /target|typ/
-              return Origen.top_level.clocks(ref).freq_target
+              Origen.top_level.clocks(ref).freq_target
             else
-              return Origen.top_level.clocks(ref).send(@type)
+              Origen.top_level.clocks(ref).send(@type)
             end
           end
         end
@@ -63,6 +65,7 @@ module Origen
       def evaluate_expr
         return @expr if @expr.is_a?(Numeric)
         return nil if @expr.nil?
+
         if @expr.is_a? Symbol
           @expr = ':' + @expr.to_s
         else
@@ -109,16 +112,16 @@ module Origen
           begin
             result = eval(@expr)
             return result.round(4) if result.is_a? Numeric
-            rescue ::SyntaxError, ::NameError, ::TypeError
-              Origen.log.debug "Limit '#{@expr}' had to be rescued, storing it as a #{@expr.class}"
-              if @expr.is_a? Symbol
-                return @expr
-              else
-                return "#{@expr}"
-              end
+          rescue ::SyntaxError, ::NameError, ::TypeError
+            Origen.log.debug "Limit '#{@expr}' had to be rescued, storing it as a #{@expr.class}"
+            if @expr.is_a? Symbol
+              @expr
+            else
+              "#{@expr}"
+            end
           end
         else
-          return result
+          result
         end
       end
     end

data/lib/origen/limits/limit_set.rb

@@ -2,7 +2,8 @@ require_relative './limit'
 module Origen
   module Limits
     class LimitSet
-      attr_accessor :id, :min, :typ, :max, :target, :description, :static, :owner, :type
+      attr_accessor :id, :description, :static, :owner, :type
+      attr_reader :min, :typ, :max, :target
 
       def initialize(id, owner, options)
         @id = id

data/lib/origen/loader.rb

@@ -121,7 +121,7 @@ module Origen
     # as well unless disable_bug_inheritance or disable_feature_inheritance options are passed
     # Returns true if a model is found and loaded, otherwise nil.
     def self.load_block(model, options = {})
-      model = model.model  # Ensure we have a handle on the model and not its controller
+      model = model.model # Ensure we have a handle on the model and not its controller
       loaded = nil
 
       if options[:inherit]
@@ -139,7 +139,7 @@ module Origen
           local_full_paths = Array(options[:path])
         else
           local_full_paths = model.class.to_s.split('::')
-          local_full_paths.shift  # Throw away the app namespace
+          local_full_paths.shift # Throw away the app namespace
           local_full_paths = [local_full_paths.join('/')]
         end
         app_paths_map = { local_app => local_full_paths }
@@ -213,6 +213,7 @@ module Origen
         base.class_eval do
           # Emulate #exclude via an ivar
           return if defined?(@_const_missing) && @_const_missing
+
           @_const_missing = instance_method(:const_missing)
           remove_method(:const_missing)
         end
@@ -256,6 +257,7 @@ module Origen
             name = "#{self}::#{name}"
           end
           return nil if @_checking_name == name
+
           names = name.split('::')
           namespace = names.shift
           if app = Origen::Application.from_namespace(namespace)

data/lib/origen/log.rb

@@ -55,6 +55,7 @@ module Origen
       unless LEVELS.include?(val)
         fail "Unknown log level, valid values are: #{LEVELS}"
       end
+
       # Map the log4r levels to our simplified 3 level system
       # log4r level order is DEBUG < INFO < WARN < ERROR < FATAL
       case val
@@ -291,9 +292,9 @@ module Origen
     def call_interceptor(interceptors, msg, type, options, &original)
       interceptor = interceptors.shift
       if interceptors.empty?
-        func = -> (msg, type, options) { original.call(msg, type, options) }
+        func = ->(msg, type, options) { original.call(msg, type, options) }
       else
-        func = -> (msg, type, options) { call_interceptor(interceptors, msg, type, options, &original) }
+        func = ->(msg, type, options) { call_interceptor(interceptors, msg, type, options, &original) }
       end
       interceptor.call(msg, type, options, func)
     end

data/lib/origen/memory.rb

@@ -41,6 +41,7 @@ module Origen
         if @memory_width
           fail 'The memory width cannot be changed after a memory location has been referenced'
         end
+
         @memory_width = size
       else
         Origen.top_level.memory_width = size

data/lib/origen/model.rb

@@ -114,11 +114,13 @@ module Origen
 
     def write_memory(*args)
       return super if defined?(super)
+
       write_register(*args)
     end
 
     def read_memory(*args)
       return super if defined?(super)
+
       read_register(*args)
     end
 
@@ -128,7 +130,7 @@ module Origen
 
     def wrap_in_controller
       c = Origen.controllers.find do |params|
-        self.is_a?(params[:model_class]) if params[:model_class]
+        is_a?(params[:model_class]) if params[:model_class]
       end
       if c
         c = c[:controller_class].send(:allocate)
@@ -176,7 +178,7 @@ module Origen
     end
 
     def current_configuration
-      if self.respond_to?(:configuration)
+      if respond_to?(:configuration)
         configuration
       end
     end
@@ -222,12 +224,14 @@ module Origen
     def current_mode
       if @current_mode
         return _modes[@current_mode] if _modes[@current_mode]
+
         fail "The mode #{@current_mode} of #{self.class} has not been defined!"
       else
         unless top_level?
           # Need to do this in case a class besides SubBlock includes Origen::Model
           obj_above_self = parent.nil? ? Origen.top_level : parent
           return nil if obj_above_self.nil?
+
           if obj_above_self.current_mode
             _modes[obj_above_self.current_mode.id] if _modes.include? obj_above_self.current_mode.id
           end
@@ -242,7 +246,7 @@ module Origen
       Origen.app.listeners_for(:on_mode_changed).each do |listener|
         listener.on_mode_changed(mode: @current_mode, instance: self)
       end
-      @current_mode
+      @current_mode     # rubocop:disable Lint/Void
     end
     alias_method :mode=, :current_mode=
 
@@ -308,7 +312,7 @@ module Origen
     def find_specs
       specs_found = []
       # Check for specs the object owns
-      if self.respond_to? :specs
+      if respond_to? :specs
         object_specs = specs
         unless object_specs.nil?
           if object_specs.class == Origen::Specs::Spec
@@ -320,6 +324,7 @@ module Origen
       end
       sub_blocks.each do |_name, sb|
         next unless sb.respond_to? :specs
+
         child_specs = sb.specs
         unless child_specs.nil?
           if child_specs.class == Origen::Specs::Spec
@@ -340,6 +345,7 @@ module Origen
       obj.delete_all_exhibits
       obj.children.each do |_name, child|
         next unless child.has_specs?
+
         delete_all_specs_and_notes(child)
       end
     end

data/lib/origen/models.rb

@@ -1,6 +1,6 @@
 module Origen
   module Models
-    autoload :ScanRegister,    'origen/models/scan_register'
-    autoload :Mux,    'origen/models/mux'
+    autoload :ScanRegister, 'origen/models/scan_register'
+    autoload :Mux, 'origen/models/mux'
   end
 end

data/lib/origen/netlist/list.rb

@@ -29,6 +29,7 @@ module Origen
         elsif bits.size == 0
           return undefined
         end
+
         bits.first
       end
 

data/lib/origen/netlist.rb

@@ -4,13 +4,11 @@ module Origen
     autoload :Connectable, 'origen/netlist/connectable'
 
     def netlist
-      @netlist ||= begin
-        if netlist_top_level == self
-          List.new(self)
-        else
-          netlist_top_level.netlist
-        end
-      end
+      @netlist ||= if netlist_top_level == self
+                     List.new(self)
+                   else
+                     netlist_top_level.netlist
+                   end
     end
 
     def netlist_top_level

data/lib/origen/org_file/interceptor.rb

@@ -89,7 +89,7 @@ module Origen
       private
 
       def debugger
-        ::Kernel.debugger
+        ::Kernel.debugger   # rubocop:disable Lint/Debugger
       end
 
       def default_org_file_captures

data/lib/origen/org_file.rb

@@ -8,12 +8,14 @@ module Origen
         if @internal_new
           super
         else
-          open(*args, &block)
+          # Kernel#open is a serious security risk
+          open(*args, &block)   # rubocop:disable Security/Open
         end
       end
 
       def open(id, options = {})
         fail "An org_file is already open with id: #{id}" if open_files[id]
+
         @internal_new = true
         f = OrgFile.new(id, options)
         @internal_new = nil
@@ -28,6 +30,7 @@ module Origen
 
       def close(id, options = {})
         fail "An org_file with this ID has not been opened id: #{id}" unless open_files[id]
+
         open_files[id].close unless options[:_internal_org_file_call_]
         open_files.delete(id)
       end

data/lib/origen/parameters/set.rb

@@ -115,6 +115,7 @@ module Origen
 
       def defining?
         return true if Origen::Parameters.transaction_open
+
         if top_level?
           @defining
         else

data/lib/origen/parameters.rb

@@ -88,6 +88,7 @@ module Origen
           unless valid
             fail 'Invalid parameters context, must be :top or a string path to a model object'
           end
+
           @parameters_context = obj
         else
           @parameters_context
@@ -136,6 +137,7 @@ module Origen
           redefine_children.each { |model, set_name| Origen::Parameters.redefine(model, set_name) }
         end
       end
+
       _parameter_sets[name]
     end
     alias_method :define_parameters, :define_params
@@ -231,7 +233,7 @@ module Origen
         end
       end
       if param_context[:obj]._parameter_sets.key?(param_context[:context])
-        return param_context
+        param_context
       else
         puts "Unknown parameter set :#{param_context[:context]} requested for #{param_context[:obj].class}, these are the valid sets:"
         param_context[:obj]._parameter_sets.keys.each { |k| puts "  :#{k}" }