origen 0.60.7 → 0.60.9

data/lib/origen/specs.rb

@@ -14,7 +14,7 @@ module Origen
     require 'origen/specs/checkers'
     include Checkers
 
-    attr_accessor :_specs, :_notes, :_exhibits, :_doc_resources, :_overrides, :_power_supplies, :_mode_selects, :_version_history, :_creation_info, :_spec_features, :_documentation
+    attr_writer :_specs, :_notes, :_exhibits, :_doc_resources, :_overrides, :_power_supplies, :_mode_selects, :_version_history, :_creation_info, :_spec_features, :_documentation
 
     # Detailed description for the ip block
     attr_accessor :description
@@ -53,15 +53,15 @@ module Origen
       }.update(options || {})
       _specs
       if s.nil?
-        return show_specs(options)
+        show_specs(options)
       elsif s.is_a? Hash
         # no spec was passed but some option was passed
         options.update(s)
-        return show_specs(options)
+        show_specs(options)
       else
         # a spec was passed
         options[:spec] = s
-        return show_specs(options)
+        show_specs(options)
       end
     end
 
@@ -69,14 +69,16 @@ module Origen
     def spec(name, type = nil, mode = nil, &block)
       return specs(name, type) unless block_given?
       fail 'A type argument is required when defining a spec!' unless type
+
       _specs
       name = name_audit(name)
       fail 'Specification names must be of SPEC_TYPES Symbol or String and cannot start with a number' if name.nil?
       fail "Spec type must be one of #{SPEC_TYPES.join(', ')}" unless SPEC_TYPES.include? type
+
       type = type
       mode = get_mode if mode.nil?
       owner_name = ''
-      if self.respond_to?(:name) && send(:name)
+      if respond_to?(:name) && send(:name)
         owner_name = self.name.to_s.downcase.to_sym
       elsif self == Origen.top_level
         owner_name = self.class.to_s.split('::').last.downcase.to_sym
@@ -91,6 +93,7 @@ module Origen
         # 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
     end
 
@@ -107,9 +110,9 @@ module Origen
         creating_spec: false
       }.update(options)
       if @_specs.nil? || @_specs == {}
-        return false
+        false
       else
-        return !!show_specs(options)
+        !!show_specs(options)
       end
     end
 
@@ -228,6 +231,7 @@ module Origen
       }.update(options)
       return nil if @_notes.nil?
       return nil if @_notes.empty?
+
       # 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
@@ -243,11 +247,11 @@ module Origen
         end
       end
       if notes_found.empty?
-        return nil
+        nil
       elsif notes_found.size == 1
         notes_found.values.first.values.first
       else
-        return notes_found
+        notes_found
       end
     end
 
@@ -259,6 +263,7 @@ module Origen
       return @_spec_features if options[:id].nil? && options[:device].nil?
       return nil if @_spec_features.nil?
       return nil if @_spec_features.empty?
+
       features_found = Hash.new do |h, k|
         h[k] = {}
       end
@@ -268,11 +273,11 @@ module Origen
         end
       end
       if features_found.empty?
-        return nil
+        nil
       elsif features_found.size == 1
         features_found.values.first.values.first
       else
-        return features_found
+        features_found
       end
     end
 
@@ -284,6 +289,7 @@ module Origen
       }.update(options)
       return nil if @_exhibits.nil?
       return nil if @_exhibits.empty?
+
       ex_found = Hash.new do |h, k|
         h[k] = Hash.new do |hh, kk|
           hh[kk] = {}
@@ -297,9 +303,9 @@ module Origen
         end
       end
       if ex_found.empty?
-        return nil
+        nil
       else
-        return ex_found
+        ex_found
       end
     end
 
@@ -312,6 +318,7 @@ module Origen
       }.update(options)
       return nil if @_doc_resources.nil?
       return nil if @_doc_resources.empty?
+
       dr_found = Hash.new do |h, k|
         h[k] = Hash.new do |hh, kk|
           hh[kk] = Hash.new do |hhh, kkk|
@@ -329,9 +336,9 @@ module Origen
         end
       end
       if dr_found.empty?
-        return nil
+        nil
       else
-        return dr_found
+        dr_found
       end
     end
 
@@ -347,6 +354,7 @@ module Origen
       }.update(options)
       return nil if @_documentation.nil?
       return nil if @_documentation.empty?
+
       doc_found = Hash.new do |h, k|
         h[k] = Hash.new do |hh, kk|
           hh[kk] = Hash.new do |hhh, kkk|
@@ -376,9 +384,9 @@ module Origen
         end
       end
       if doc_found.empty?
-        return nil
+        nil
       else
-        return doc_found
+        doc_found
       end
     end
 
@@ -392,6 +400,7 @@ module Origen
       }.update(options)
       return nil if @_overrides.nil?
       return nil if @_overrides.empty?
+
       overrides_found = Hash.new do |h, k|
         h[k] = Hash.new do |hh, kk|
           hh[kk] = Hash.new do |hhh, kkk|
@@ -413,9 +422,9 @@ module Origen
         end
       end
       if overrides_found.empty?
-        return nil
+        nil
       else
-        return overrides_found
+        overrides_found
       end
     end
 
@@ -426,7 +435,8 @@ module Origen
       }.update(options)
       return nil if @_mode_selects.nil?
       return nil if @_mode_selects.empty?
-      modes_found = Hash.new do|h, k|
+
+      modes_found = Hash.new do |h, k|
         h[k] = {}
       end
       filter_hash(@_mode_selects, options[:block]).each do |block, hash|
@@ -435,9 +445,9 @@ module Origen
         end
       end
       if modes_found.empty?
-        return nil
+        nil
       else
-        return modes_found
+        modes_found
       end
     end
 
@@ -446,20 +456,21 @@ module Origen
         gen: nil,
         act: nil
       }.update(options)
-      ps_found = Hash.new do|h, k|
+      ps_found = Hash.new do |h, k|
         h[k] = {}
       end
       return nil if @_power_supplies.nil?
       return nil if @_power_supplies.empty?
+
       filter_hash(@_power_supplies, options[:gen]).each do |gen, hash|
         filter_hash(hash, options[:act]).each do |act, sel|
           ps_found[gen][act] = sel
         end
       end
       if ps_found.empty?
-        return nil
+        nil
       else
-        return ps_found
+        ps_found
       end
     end
 
@@ -476,6 +487,7 @@ module Origen
       end
       return nil if @_version_history.nil?
       return nil if @_version_history.empty?
+
       filter_hash(@_version_history, options[:date]).each do |date, hash|
         filter_hash(hash, options[:author]).each do |author, hash1|
           filter_hash(hash1, options[:label]).each do |label, ver|
@@ -484,9 +496,9 @@ module Origen
         end
       end
       if vh_found.empty?
-        return nil
+        nil
       else
-        return vh_found
+        vh_found
       end
     end
 
@@ -644,6 +656,7 @@ module Origen
     # Return a hash based on the filter provided
     def filter_hash(hash, filter, debug = false)
       fail 'Hash argument is not a Hash!' unless hash.is_a? Hash
+
       filtered_hash = {}
       select_logic = case filter
         when String then 'k.nil? ? false : k[Regexp.new(filter)] && k.length == filter.length'
@@ -653,8 +666,7 @@ module Origen
           'k == filter'
         when NilClass then true # Return all specs if a filter is set to nil (i.e. user doesn't care about this filter)
         else true
-      end
-      # rubocop:disable UnusedBlockArgument
+                     end
       filtered_hash = hash.select do |k, v|
         # binding.pry if filter == 'SubSection A'
         [TrueClass, FalseClass].include?(select_logic.class) ? select_logic : eval(select_logic)
@@ -711,14 +723,14 @@ module Origen
           end
         end
         Origen.log.debug "Returning no specs for options #{options}"
-        return nil
+        nil
       elsif specs_to_be_shown.size == 1
         print_to_console(specs_to_be_shown) if options[:verbose] == true
         Origen.log.debug "returning one spec #{specs_to_be_shown.first.name}"
-        return specs_to_be_shown.first
+        specs_to_be_shown.first
       else
         Origen.log.debug "returning an array of specs during initial search: #{specs_to_be_shown}"
-        return specs_to_be_shown
+        specs_to_be_shown
       end
     end
 
@@ -727,18 +739,18 @@ module Origen
       whitespace_padding = 3
       table = []
       attrs_to_be_shown = {
-        name:        SpecTableAttr.new('Name',      true,  'Name'.length + whitespace_padding),
-        symbol:      SpecTableAttr.new('Symbol',    false, 'Symbol'.length + whitespace_padding),
+        name:        SpecTableAttr.new('Name', true, 'Name'.length + whitespace_padding),
+        symbol:      SpecTableAttr.new('Symbol', false, 'Symbol'.length + whitespace_padding),
         mode:        SpecTableAttr.new('Mode',      true,  'Mode'.length + whitespace_padding),
         type:        SpecTableAttr.new('Type',      true,  'Type'.length + whitespace_padding),
-        sub_type:    SpecTableAttr.new('Sub-Type',  false, 'Sub-Type'.length + whitespace_padding),
+        sub_type:    SpecTableAttr.new('Sub-Type', false, 'Sub-Type'.length + whitespace_padding),
         # spec SpecTableAttribute :description is called parameter in the spec table output to match historical docs
         description: SpecTableAttr.new('Parameter', false, 'Parameter'.length + whitespace_padding),
         min:         SpecTableAttr.new('Min',       false, 'Min'.length + whitespace_padding),
         typ:         SpecTableAttr.new('Typ',       false, 'Typ'.length + whitespace_padding),
         max:         SpecTableAttr.new('Max',       false, 'Max'.length + whitespace_padding),
-        unit:        SpecTableAttr.new('Unit',      false, 'Unit'.length + whitespace_padding),
-        audience:    SpecTableAttr.new('Audience',  false, 'Audience'.length + whitespace_padding)
+        unit:        SpecTableAttr.new('Unit', false, 'Unit'.length + whitespace_padding),
+        audience:    SpecTableAttr.new('Audience', false, 'Audience'.length + whitespace_padding)
         # notes:       SpecTableAttr.new('Notes',     false, 'Notes'.length + whitespace_padding)
       }
       # Calculate the padding needed in the spec table for the longest attr of all specs
@@ -747,6 +759,7 @@ module Origen
           unless spec.send(attr_name).nil?
             if spec.send(attr_name).class == Origen::Specs::Spec::Limit
               next if spec.send(attr_name).value.nil?
+
               current_padding = spec.send(attr_name).value.to_s.length + whitespace_padding
             else
               current_padding = spec.send(attr_name).to_s.length + whitespace_padding
@@ -760,6 +773,7 @@ module Origen
       header = ''
       attrs_to_be_shown.each do |_attr_name, attr_struct|
         next if attr_struct.show == false
+
         header += "| #{attr_struct.table_text}".ljust(attr_struct.padding)
       end
       header += '|'
@@ -775,6 +789,7 @@ module Origen
         data = ''
         attrs_to_be_shown.each do |attr_name, attr_struct|
           next if attr_struct.show == false
+
           if spec.send(attr_name).class == Origen::Specs::Spec::Limit
             data += "| #{spec.send(attr_name).value}".ljust(attr_struct.padding)
           else

data/lib/origen/sub_blocks.rb

@@ -17,7 +17,7 @@ module Origen
         # address API, but will accept any of these
         @reg_base_address = options.delete(:reg_base_address) ||
                             options.delete(:base_address) || options.delete(:base) || 0
-        if options[:_instance]                # to be deprecated as part of multi-instance removal below
+        if options[:_instance] # to be deprecated as part of multi-instance removal below
           if @reg_base_address.is_a?(Array)
             @reg_base_address = @reg_base_address[options[:_instance]]
           elsif options[:base_address_step]
@@ -179,6 +179,7 @@ module Origen
 
       def path(options = {})
         return abs_path if abs_path
+
         if is_a?(Origen::Registers::BitCollection)
           # Special case where path relative to the register has been requested
           if options[:relative_to] == parent
@@ -264,9 +265,7 @@ module Origen
     # Note that this returns an array instead of a hash since there could be naming collisions in the
     # hash keys
     def all_sub_blocks
-      @all_sub_blocks ||= begin
-        (sub_blocks_array + sub_blocks_array.map(&:all_sub_blocks)).flatten
-      end
+      @all_sub_blocks ||= (sub_blocks_array + sub_blocks_array.map(&:all_sub_blocks)).flatten
     end
 
     # Returns true if the given sub block owns at least one register
@@ -301,7 +300,7 @@ module Origen
         # permit creating multiple instances of a particular sub_block class
         # can pass array for base_address, which will be processed above
         Origen.deprecate 'instances: option to sub_block is deprecated, use sub_block_groups instead'
-        group_name = name =~ /s$/ ? name : "#{name}s"  # take care if name already with 's' is passed
+        group_name = name =~ /s$/ ? name : "#{name}s" # take care if name already with 's' is passed
         unless respond_to?(group_name)
           sub_block_groups group_name do
             i.times do |j|
@@ -341,6 +340,7 @@ module Origen
               skip_require_files = options[:skip_require_files] || %w(attributes parameters pins registers sub_blocks timesets)
               Dir.glob("#{block_dir}/*.rb").each do |file|
                 next if skip_require_files.include?(Pathname.new(file).basename('.rb').to_s)
+
                 require file
               end
             end
@@ -362,7 +362,7 @@ module Origen
         else
           sub_blocks[name] = block
         end
-        unless @current_group.nil?  # a group is currently open, store sub_block id only
+        unless @current_group.nil? # a group is currently open, store sub_block id only
           @current_group << name
         end
         if options.key?(:lazy)
@@ -417,14 +417,14 @@ module Origen
       if options[:class_name]
         b = Object.const_get(options[:class_name]).new
       else
-        b = []             # Will use Array if no class defined
+        b = [] # Will use Array if no class defined
       end
       # Add sub_blocks to group
       my_group.each do |group_id|
         b << send(group_id)
       end
       sub_block_groups[id] = b
-      @current_group = nil   # close group
+      @current_group = nil # close group
     end
     alias_method :sub_blocks_group, :sub_block_group
 
@@ -442,18 +442,18 @@ module Origen
       current_namespace = remaining_namespace.shift
       if current_namespace
         if current_path.join(current_namespace).exist?
-          return _find_block_dir(options, current_path.join(current_namespace), remaining_namespace)
+          _find_block_dir(options, current_path.join(current_namespace), remaining_namespace)
         elsif current_path.join("derivatives/#{current_namespace}").exist?
-          return _find_block_dir(options, current_path.join("derivatives/#{current_namespace}"), remaining_namespace)
+          _find_block_dir(options, current_path.join("derivatives/#{current_namespace}"), remaining_namespace)
         elsif current_path.join("sub_blocks/#{current_namespace}").exist?
-          return _find_block_dir(options, current_path.join("sub_blocks/#{current_namespace}"), remaining_namespace)
+          _find_block_dir(options, current_path.join("sub_blocks/#{current_namespace}"), remaining_namespace)
         else
           Origen.log.error "Could not find block dir for namespace #{options[:class_name]}!"
           fail
         end
       else
         if current_path.join('model.rb').exist?
-          return current_path.to_s
+          current_path.to_s
         else
           Origen.log.error "Could not find block dir for namespace #{options[:class_name]}!"
           fail
@@ -463,6 +463,7 @@ module Origen
 
     def instantiate_sub_block(name, klass, options)
       return sub_blocks[name] unless sub_blocks[name].is_a?(Placeholder)
+
       sub_blocks[name] = klass.new(options.merge(parent: self, name: name))
     end
 
@@ -491,6 +492,7 @@ module Origen
         # looking up and loaded by the autoload system straight away, especially if the sub-block
         # has been specified to lazy load
         return false if klass == Hash || klass == Array
+
         klass == self.klass || klass == Placeholder
       end
 
@@ -557,16 +559,19 @@ module Origen
               klass = eval(tmp_class)
             rescue NameError => e
               raise if e.message !~ /^uninitialized constant (.*)$/ || tmp_class !~ /#{Regexp.last_match(1)}/
+
               begin
                 tmp_class = "::#{class_name}"
                 klass = eval(tmp_class)
               rescue NameError => e
                 raise if e.message !~ /^uninitialized constant (.*)$/ || tmp_class !~ /#{Regexp.last_match(1)}/
+
                 begin
                   tmp_class = "#{owner.class}::#{class_name}"
                   klass = eval(tmp_class)
                 rescue NameError => e
                   raise if e.message !~ /^uninitialized constant (.*)$/ || tmp_class !~ /#{Regexp.last_match(1)}/
+
                   puts "Could not find class: #{class_name}"
                   raise 'Unknown sub block class!'
                 end
@@ -609,8 +614,9 @@ module Origen
     def method_missing(method, *args, &block)
       super
     rescue NoMethodError
-      return regs(method) if self.has_reg?(method)
-      return ports(method) if self.has_port?(method)
+      return regs(method) if has_reg?(method)
+      return ports(method) if has_port?(method)
+
       if method.to_s =~ /=$/
         define_singleton_method(method) do |val|
           instance_variable_set("@#{method.to_s.sub('=', '')}", val)

data/lib/origen/top_level.rb

@@ -79,7 +79,7 @@ module Origen
         val.id
       else
         packages.include?(val) ? val : nil
-      end
+                            end
     end
     alias_method :package=, :current_package=
 
@@ -88,6 +88,7 @@ module Origen
     def current_package(_options = {})
       if @current_package_id
         return _packages[@current_package_id] if _packages[@current_package_id]
+
         fail "The package #{@current_package_id} of #{self.class} has not been defined!"
       end
     end

data/lib/origen/users/user.rb

@@ -87,11 +87,10 @@ module Origen
             end
           end
         else
-          @email ||= begin
-            if Origen.site_config.email_domain
-              "#{id}@#{Origen.site_config.email_domain}"
-            end
-          end
+          @email ||= if Origen.site_config.email_domain
+                       "#{id}@#{Origen.site_config.email_domain}"
+                     end
+
         end
       end
 

data/lib/origen/utility/csv_data.rb

@@ -34,7 +34,7 @@ module Origen
       #   end
       def parse(options = {})
         csv_data = extract_csv_data(options)
-        if block_given?  # doesn't do much at this point
+        if block_given? # doesn't do much at this point
           csv_data.each do |dataset|
             yield dataset
           end
@@ -69,9 +69,11 @@ module Origen
 
       # Returns an array containing all data from given CSV file
       def extract_csv_data(options = {}) # :nodoc:
-        options = { field_names_only: false,  # whether to obtain field names only
-                    comment_char:     '#',        # ignore lines that start with comment character
+        # rubocop:disable Layout/MultilineHashBraceLayout
+        options = { field_names_only: false, # whether to obtain field names only
+                    comment_char:     '#' # ignore lines that start with comment character
                   }.merge(options)
+        # rubocop:enable Layout/MultilineHashBraceLayout
 
         field_names = []
         field_values = []
@@ -87,7 +89,7 @@ module Origen
           end
           if line_no == 1 # Field names
             field_names = line.split(',')
-          else  # Field values
+          else # Field values
             field_values = line.split(',')
             if field_names.length != field_values.length
               abort "ERROR! Invalid number of fields (#{field_values.length}) in CVS file on line # #{line_no}. Should be #{field_names.length}.\n"

data/lib/origen/utility/diff.rb

@@ -48,14 +48,14 @@ module Origen
         lines_remaining = true
 
         while lines_remaining
-          a = get_next_line_a(content_a)   # Get the next vectors
+          a = get_next_line_a(content_a) # Get the next vectors
           b = get_next_line_b(content_b)
           if !a && !b       # If both patterns finished
             lines_remaining = false
           elsif !a || !b    # If only 1 pattern finished
             lines_remaining = false
-            changes = true unless @suspend_diff     # There are extra vectors in one of the patterns
-          elsif a != b      # If the vectors don't match
+            changes = true unless @suspend_diff # There are extra vectors in one of the patterns
+          elsif a != b # If the vectors don't match
             changes = true unless @suspend_diff
           end
           if @resume_diff # resume checking diffs for subsequent lines
@@ -112,8 +112,8 @@ module Origen
               end
             # This rescue is a crude way to guard against non-ASCII files that find
             # their way in here
-          rescue
-            return line
+            rescue
+              line
             end
           else
             line.strip
@@ -144,10 +144,10 @@ module Origen
             else
               matched = true
             end
-        # This rescue is a crude way to guard against non-ASCII files that find
-        # there way in here
-        rescue
-          matched = true
+          # This rescue is a crude way to guard against non-ASCII files that find
+          # there way in here
+          rescue
+            matched = true
           end
         end
         ix

data/lib/origen/utility/file_diff.rb

@@ -25,9 +25,11 @@ module Origen
       class OutputFile < Array
         class Line < String
           attr_accessor :type, :original_number
+
           def initialize(type, input_file)
             self.type = type
             return unless input_file
+
             replace(input_file.current_line)
             self.original_number = input_file.pointer + 1
             input_file.advance_pointer!
@@ -59,6 +61,7 @@ module Origen
       class Processor
         attr_accessor :source, :target
         attr_accessor :source_output, :target_output
+
         def initialize(source_file_name, target_file_name)
           self.source = InputFile.new
           self.target = InputFile.new
@@ -125,6 +128,7 @@ module Origen
       module Formatter
         class Base
           attr_accessor :source_output, :target_output, :file
+
           def initialize(processed_diff, output_file_name)
             self.source_output = processed_diff.source_output
             self.target_output = processed_diff.target_output

data/lib/origen/utility/input_capture.rb

@@ -5,14 +5,16 @@ module Origen
       # Gets text input from the user
       # Supply an optional default value in the event that the user enters nothing
       def get_text(options = {})
+        # rubocop:disable Layout/MultilineHashBraceLayout
         options = { default:        false,
-                    single:         false,     # Set if only a single line entry is expected
+                    single:         false, # Set if only a single line entry is expected
                     confirm:        false,
-                    accept:         false,         # Supply and array of entries you are willing to accept
+                    accept:         false, # Supply and array of entries you are willing to accept
                     case_sensitive: false, # If accept values are supplied they will be treated as case
                     # in-sensitive by default
-                    wrap:           true,   # Automatically split long lines
+                    wrap:           true # Automatically split long lines
         }.merge(options)
+        # rubocop:enable Layout/MultilineHashBraceLayout
         if options[:confirm]
           puts "Type 'yes' or 'no' to confirm or 'quit' to abort."
         elsif options[:accept]
@@ -65,9 +67,7 @@ module Origen
           end
           if confirm == 'yes' || confirm == 'y'
             if options[:confirm] == :return_boolean
-              return true
-            else
-              return
+              true
             end
           else
             get_text(options)

data/lib/origen/utility/mailer.rb

@@ -18,8 +18,7 @@ module Origen
                     domain:         (Origen.site_config.email_domain || ''),
 
                     auth_user:      (Origen.site_config.email_auth_user || current_user.email),
-                    auth_password:  (Origen.site_config.email_auth_password || current_user.password)
-                  }.merge(options)
+                    auth_password:  (Origen.site_config.email_auth_password || current_user.password) }.merge(options)
 
         # Force to an array
         to = options[:to].respond_to?('each') ? options[:to] : [options[:to]]
@@ -52,15 +51,13 @@ END_OF_MESSAGE
             smtp = Net::SMTP.new(options[:server], options[:port])
             smtp.enable_starttls if options[:authentication] != :none
 
-            opts = begin
-              if options[:authentication] == :none
-                # Trying to add username and password if there's no authentication will actually be rejected by
-                # the server.
-                [options[:domain]]
-              else
-                [options[:domain], options[:auth_user], options[:auth_password], options[:authentication]]
-              end
-            end
+            opts = if options[:authentication] == :none
+                     # Trying to add username and password if there's no authentication will actually be rejected by
+                     # the server.
+                     [options[:domain]]
+                   else
+                     [options[:domain], options[:auth_user], options[:auth_password], options[:authentication]]
+                   end
 
             smtp.start(*opts) do |m|
               m.send_message(msg, options[:from], addr)