test_ids 1.2.3 → 1.2.4

data/lib/test_ids/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TestIds
   class Configuration
     class Item
@@ -33,9 +35,8 @@ module TestIds
       end
 
       def valid?(number)
-        if function?
-          fail 'valid? is not supported for algorithm or callback-based assignments'
-        end
+        fail 'valid? is not supported for algorithm or callback-based assignments' if function?
+
         number = number.to_i
         include.include?(number) && !exclude.include?(number)
       end
@@ -85,22 +86,16 @@ module TestIds
       end
     end
 
-    attr_reader :allocator
+    attr_reader :allocator, :id
 
     def initialize(id)
       @id = id
       @allocator = Allocator.new(self)
     end
 
-    def id
-      @id
-    end
-
     def bins(options = {}, &block)
       @bins ||= Item.new
-      if block_given?
-        @bins.callback(options, &block)
-      end
+      @bins.callback(options, &block) if block_given?
       @bins
     end
 
@@ -111,9 +106,7 @@ module TestIds
 
     def softbins(options = {}, &block)
       @softbins ||= Item.new
-      if block_given?
-        @softbins.callback(options, &block)
-      end
+      @softbins.callback(options, &block) if block_given?
       @softbins
     end
 
@@ -124,9 +117,7 @@ module TestIds
 
     def numbers(options = {}, &block)
       @numbers ||= Item.new
-      if block_given?
-        @numbers.callback(options, &block)
-      end
+      @numbers.callback(options, &block) if block_given?
       @numbers
     end
 
@@ -152,10 +143,10 @@ module TestIds
     end
 
     def validate!
-      unless validated?
-        @validated = true
-        freeze
-      end
+      return if validated?
+
+      @validated = true
+      freeze
     end
 
     def empty?

data/lib/test_ids/git.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'git'
 module TestIds
@@ -20,7 +22,7 @@ module TestIds
 
       def find
         repos = Dir.glob("#{Origen.app.imports_dir}/test_ids/*.git")
-        if repos.size == 0
+        if repos.empty?
           puts 'No TestIds repositories were found in this application'
         elsif repos.size > 1
           puts
@@ -29,12 +31,10 @@ module TestIds
           repos.each_with_index do |repo, i|
             puts "  #{i} - #{Pathname.new(repo).basename}"
           end
-          accept = repos.map.with_index { |r, i| i }
+          accept = repos.map.with_index { |_r, i| i }
           puts
           selection = repos.size + 1
-          until repos[selection]
-            selection = get_text(single: true, accept: accept).to_i
-          end
+          selection = get_text(single: true, accept: accept).to_i until repos[selection]
         else
           selection = 0
         end
@@ -50,28 +50,28 @@ module TestIds
     end
 
     def initialize(options)
-      if !(TestIds.lsf_manual_init_shutdown) && Origen.running_locally?
-        unless File.exist?("#{options[:local]}/.git")
-          FileUtils.rm_rf(options[:local]) if File.exist?(options[:local])
-          FileUtils.mkdir_p(options[:local])
-          Dir.chdir options[:local] do
-            `git clone #{options[:remote]} .`
-            unless File.exist?('lock.json')
-              # Should really try to use the Git driver for this
-              exec 'touch lock.json'
-              exec 'git add lock.json'
-              exec 'git commit -m "Initial commit"'
-              exec 'git push'
-            end
+      return unless !TestIds.lsf_manual_init_shutdown && Origen.running_locally?
+
+      unless File.exist?("#{options[:local]}/.git")
+        FileUtils.rm_rf(options[:local]) if File.exist?(options[:local])
+        FileUtils.mkdir_p(options[:local])
+        Dir.chdir options[:local] do
+          `git clone #{options[:remote]} .`
+          unless File.exist?('lock.json')
+            # Should really try to use the Git driver for this
+            exec 'touch lock.json'
+            exec 'git add lock.json'
+            exec 'git commit -m "Initial commit"'
+            exec 'git push'
           end
         end
-        @local = options[:local]
-        @repo = ::Git.open(options[:local])
-        # Get rid of any local edits coming in here, this is only called once at the start
-        # of the program generation run.
-        # No need to pull latest as that will be done when we obtain a lock.
-        @repo.reset_hard
       end
+      @local = options[:local]
+      @repo = ::Git.open(options[:local])
+      # Get rid of any local edits coming in here, this is only called once at the start
+      # of the program generation run.
+      # No need to pull latest as that will be done when we obtain a lock.
+      @repo.reset_hard
     end
 
     # Roll the repo back to the given commit ID
@@ -104,19 +104,19 @@ module TestIds
 
     def exec(cmd)
       r = system(cmd)
-      unless r
-        fail "Something went wrong running command: #{cmd}"
-      end
+      return if r
+
+      fail "Something went wrong running command: #{cmd}"
     end
 
     def publish
-      if !(TestIds.lsf_manual_init_shutdown) && Origen.running_locally?
-        Origen.profile 'Publishing the test IDs store' do
-          release_lock
-          repo.add  # Checkin everything
-          repo.commit('Publishing latest store')
-          repo.push('origin', 'master', force: true)
-        end
+      return unless !TestIds.lsf_manual_init_shutdown && Origen.running_locally?
+
+      Origen.profile 'Publishing the test IDs store' do
+        release_lock
+        repo.add # Checkin everything
+        repo.commit('Publishing latest store')
+        repo.push('origin', 'master', force: true)
       end
     end
 
@@ -128,25 +128,25 @@ module TestIds
     end
 
     def get_lock
-      if !(TestIds.lsf_manual_init_shutdown) && Origen.running_locally?
-        return if @lock_open
-        Origen.profile 'Obtaining test IDs lock' do
-          until available_to_lock?(@repo)
-            puts
-            puts "Waiting for lock, currently locked by #{lock_user} (the lock will expire in less than #{lock_minutes_remaining} #{'minute'.pluralize(lock_minutes_remaining)} if not released before that)"
-            puts
-            sleep 5
-          end
-          data = {
-            'user'    => User.current.name,
-            'expires' => (Time.now + minutes(5)).to_f
-          }
-          write('lock.json', JSON.pretty_generate(data))
-          repo.commit('Obtaining lock')
-          repo.push('origin')
+      return unless !TestIds.lsf_manual_init_shutdown && Origen.running_locally?
+      return if @lock_open
+
+      Origen.profile 'Obtaining test IDs lock' do
+        until available_to_lock?(@repo)
+          puts
+          puts "Waiting for lock, currently locked by #{lock_user} (the lock will expire in less than #{lock_minutes_remaining} #{'minute'.pluralize(lock_minutes_remaining)} if not released before that)"
+          puts
+          sleep 5
         end
-        @lock_open = true
+        data = {
+          'user'    => User.current.name,
+          'expires' => (Time.now + minutes(5)).to_f
+        }
+        write('lock.json', JSON.pretty_generate(data))
+        repo.commit('Obtaining lock')
+        repo.push('origin')
       end
+      @lock_open = true
     end
 
     def release_lock
@@ -162,11 +162,11 @@ module TestIds
       Origen.profile 'Checking for lock' do
         repo_to_use.fetch
         repo_to_use.reset_hard('origin/master')
-        if lock_content && lock_user && lock_user != User.current.name
-          result = Time.now.to_f > lock_expires
-        else
-          result = true
-        end
+        result = if lock_content && lock_user && lock_user != User.current.name
+                   Time.now.to_f > lock_expires
+                 else
+                   true
+                 end
       end
       result
     end
@@ -185,7 +185,7 @@ module TestIds
 
     def lock_content
       f = File.join(local, 'lock.json')
-      JSON.load(File.read(f)) if File.exist?(f)
+      JSON.parse(File.read(f)) if File.exist?(f)
     end
 
     def minutes(number)

data/lib/test_ids/origen/origen.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'origen'
 module Origen
-  class <<self
+  class << self
     # Override the Origen.reset_interface method to clear out the TestIds
     # configuration, so that it doesn't carry over from one flow to the next
     alias_method :_orig_reset_interface, :reset_interface

data/lib/test_ids/origen_testers/flow.rb

@@ -1,22 +1,22 @@
+# frozen_string_literal: true
+
 require 'origen_testers/flow'
 module OrigenTesters
   module Flow
-    BIN_OPTS = [:bin, :softbin, :bin_size, :softbin_size, :number, :number_size]
+    BIN_OPTS = %i(bin softbin bin_size softbin_size number number_size).freeze
 
     # Override the flow.test method to inject our generated bin and
     # test numbers
     alias_method :_orig_test, :test
     def test(instance, options = {})
-      if TestIds.configured?
-        unless options[:test_ids] == :notrack
-          options[:test_ids_flow_id] = try(:top_level).try(:id) || id
+      if TestIds.configured? && options[:test_ids] != :notrack
+        options[:test_ids_flow_id] = try(:top_level).try(:id) || id
 
-          TestIds.current_configuration.allocator.allocate(instance, options)
+        TestIds.current_configuration.allocator.allocate(instance, options)
 
-          unless TestIds.current_configuration.send_to_ate?
-            BIN_OPTS.each do |opt|
-              options.delete(opt)
-            end
+        unless TestIds.current_configuration.send_to_ate?
+          BIN_OPTS.each do |opt|
+            options.delete(opt)
           end
         end
       end

data/lib/test_ids/shutdown_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TestIds
   class ShutdownHandler
     include Origen::PersistentCallbacks

data/lib/test_ids.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require 'origen'
-require_relative '../config/application.rb'
+require_relative '../config/application'
 require 'origen_testers'
 
 module TestIds
@@ -14,7 +16,7 @@ module TestIds
   require 'test_ids/origen/origen'
   require 'test_ids/origen_testers/flow'
 
-  class <<self
+  class << self
     # Allocates a number to the given test and returns a new hash containing
     # :bin, :softbin and :number keys.
     #
@@ -27,8 +29,7 @@ module TestIds
       inject_flow_id(opts)
       current_configuration.allocator.allocate(instance, opts)
       { bin: opts[:bin], bin_size: opts[:bin_size], softbin: opts[:softbin], softbin_size: opts[:softbin_size],
-        number: opts[:number], number_size: opts[:number_size]
-      }
+        number: opts[:number], number_size: opts[:number_size] }
     end
 
     # Similar to allocate, but allocates a test number only, i.e. no bin or softbin
@@ -70,10 +71,10 @@ module TestIds
 
     # @api private
     def inject_flow_id(options)
-      if Origen.interface_loaded?
-        flow = Origen.interface.flow
-        options[:test_ids_flow_id] = flow.try(:top_level).try(:id) || flow.id
-      end
+      return unless Origen.interface_loaded?
+
+      flow = Origen.interface.flow
+      options[:test_ids_flow_id] = flow.try(:top_level).try(:id) || flow.id
     end
 
     # Load an existing allocator, which will be loaded with a configuration based on what has
@@ -82,11 +83,11 @@ module TestIds
     # @api internal
     def load_allocator(id = nil)
       f = TestIds.database_file(id)
-      if File.exist?(f)
-        a = Configuration.new(id).allocator
-        a.load_configuration_from_store
-        a
-      end
+      return unless File.exist?(f)
+
+      a = Configuration.new(id).allocator
+      a.load_configuration_from_store
+      a
     end
 
     def current_configuration
@@ -95,14 +96,17 @@ module TestIds
 
     def configuration(id, fail_on_missing = true)
       return @configuration[id] if @configuration && @configuration[id]
-      if fail_on_missing
-        fail('You have to create the configuration first before you can access it')
-      end
+      return unless fail_on_missing
+
+      fail('You have to create the configuration first before you can access it')
     end
     alias_method :config, :configuration
 
     def configure(id = nil, options = {})
-      id, options = nil, id if id.is_a?(Hash)
+      if id.is_a?(Hash)
+        options = id
+        id = nil
+      end
 
       @configuration_id = id || options[:id] || :not_specified
 
@@ -123,9 +127,8 @@ module TestIds
 
     # Switch the current configuration to the given ID
     def config=(id)
-      unless @configuration[id]
-        fail "The TestIds configuration '#{id}' has not been defined yet!"
-      end
+      fail "The TestIds configuration '#{id}' has not been defined yet!" unless @configuration[id]
+
       @configuration_id = id
     end
 
@@ -134,26 +137,16 @@ module TestIds
       @configuration.ids
     end
 
-    def bin_config=(id)
-      @bin_config = id
-    end
+    attr_writer :bin_config, :softbin_config, :number_config
 
     def bin_config
       @bin_config ? configuration(@bin_config, false) : current_configuration
     end
 
-    def softbin_config=(id)
-      @softbin_config = id
-    end
-
     def softbin_config
       @softbin_config ? configuration(@softbin_config, false) : current_configuration
     end
 
-    def number_config=(id)
-      @number_config = id
-    end
-
     def number_config
       @number_config ? configuration(@number_config, false) : current_configuration
     end
@@ -184,14 +177,14 @@ module TestIds
     # Returns a full path to the database file for the given id, returns nil if
     # git storage has not been enabled
     def database_file(id)
-      if repo
-        if id == :not_specified || !id || id == ''
-          f = 'store.json'
-        else
-          f = "store_#{id.to_s.downcase}.json"
-        end
-        "#{git_database_dir}/#{f}"
-      end
+      return unless repo
+
+      f = if id == :not_specified || !id || id == ''
+            'store.json'
+          else
+            "store_#{id.to_s.downcase}.json"
+          end
+      "#{git_database_dir}/#{f}"
     end
 
     def git_database_dir
@@ -202,23 +195,16 @@ module TestIds
       end
     end
 
-    def git
-      @git
-    end
+    attr_reader :git, :repo
 
     def repo=(val)
       return if @repo && @repo == val
       if @repo && @repo != val
         fail 'You can only use a single test ids repository per program generation run, one per application is recommended'
       end
-      if @configuration
-        fail 'TestIds.repo must be set before creating the first configuration'
-      end
-      @repo = val
-    end
+      fail 'TestIds.repo must be set before creating the first configuration' if @configuration
 
-    def repo
-      @repo
+      @repo = val
     end
 
     def publish?
@@ -227,22 +213,15 @@ module TestIds
 
     def publish=(val)
       return if @publish && publish? == val
-      if @publish && publish? != val
-        fail 'You can only use a single setting for publish per program generation run'
-      end
-      if @configuration
-        fail 'TestIds.publish must be set before creating the first configuration'
-      end
-      unless [true, false].include?(val)
-        fail 'TestIds.publish must be set to either true or false'
-      end
+      fail 'You can only use a single setting for publish per program generation run' if @publish && publish? != val
+      fail 'TestIds.publish must be set before creating the first configuration' if @configuration
+      fail 'TestIds.publish must be set to either true or false' unless [true, false].include?(val)
+
       @publish = val ? :save : :dont_save
     end
 
     def lsf_manual_init_shutdown
-      if @lsf_manual_init_shutdown
-        true
-      end
+      true if @lsf_manual_init_shutdown
       false
     end
 
@@ -275,39 +254,39 @@ module TestIds
       # No need to pull latest as that will be done when we obtain a lock.
       @repo.reset_hard
       @git = Git.new(local: local_var_git_database_dir, remote: @repo)
-      if lsf_publish
-        return if @lock_open
-        Origen.profile 'Obtaining test IDs lock' do
-          until @git.available_to_lock?(@repo)
-            puts
-            puts "Waiting for lock, currently locked by #{@git.lock_user} (the lock will expire in less than #{@git.lock_minutes_remaining} #{'minute'.pluralize(@git.lock_minutes_remaining)} if not released before that)"
-            puts
-            sleep 5
-          end
-          data = {
-            'user'    => User.current.name,
-            'expires' => (Time.now + @git.minutes(5)).to_f
-          }
-          @git.write('lock.json', JSON.pretty_generate(data))
-          repo.commit('Obtaining lock')
-          repo.push('origin')
+      return unless lsf_publish
+      return if @lock_open
+
+      Origen.profile 'Obtaining test IDs lock' do
+        until @git.available_to_lock?(@repo)
+          puts
+          puts "Waiting for lock, currently locked by #{@git.lock_user} (the lock will expire in less than #{@git.lock_minutes_remaining} #{'minute'.pluralize(@git.lock_minutes_remaining)} if not released before that)"
+          puts
+          sleep 5
         end
-        @lock_open = true
+        data = {
+          'user'    => User.current.name,
+          'expires' => (Time.now + @git.minutes(5)).to_f
+        }
+        @git.write('lock.json', JSON.pretty_generate(data))
+        repo.commit('Obtaining lock')
+        repo.push('origin')
       end
+      @lock_open = true
     end
 
     def lsf_shutdown(lsf_publish)
-      if lsf_publish
-        Origen.profile 'Publishing the test IDs store' do
-          data = {
-            'user'    => nil,
-            'expires' => nil
-          }
-          @git.write('lock.json', JSON.pretty_generate(data))
-          repo.add  # Checkin everything
-          repo.commit('Publishing latest store')
-          repo.push('origin', 'master', force: true)
-        end
+      return unless lsf_publish
+
+      Origen.profile 'Publishing the test IDs store' do
+        data = {
+          'user'    => nil,
+          'expires' => nil
+        }
+        @git.write('lock.json', JSON.pretty_generate(data))
+        repo.add # Checkin everything
+        repo.commit('Publishing latest store')
+        repo.push('origin', 'master', force: true)
       end
     end
 
@@ -329,31 +308,30 @@ module TestIds
     # only needed for cases where running several targets
     # back to back, e.g. for regression testing
     def reset_everything(are_you_sure: false)
-      if are_you_sure
-        @repo = nil   # accessor
-        @git = nil   # accessor
-        @git_database_dir = nil
-        @git_initialized = nil
-        @configuration = nil
-        @configuration_id = nil
-        @bin_config = nil
-        @softbin_config = nil
-        @number_config = nil
-        @publish = nil
-      end
+      return unless are_you_sure
+
+      @repo = nil # accessor
+      @git = nil # accessor
+      @git_database_dir = nil
+      @git_initialized = nil
+      @configuration = nil
+      @configuration_id = nil
+      @bin_config = nil
+      @softbin_config = nil
+      @number_config = nil
+      @publish = nil
     end
 
     private
 
     def on_origen_shutdown
-      if !testing? && @configuration
-        if repo
-          @configuration.each do |id, config|
-            config.allocator.save
-          end
-          git.publish if publish?
-        end
+      return unless !testing? && @configuration
+      return unless repo
+
+      @configuration.each do |_id, config|
+        config.allocator.save
       end
+      git.publish if publish?
     end
 
     # For testing, clears all instances including the configuration
@@ -369,9 +347,7 @@ module TestIds
       @number_config = nil
     end
 
-    def testing=(val)
-      @testing = val
-    end
+    attr_writer :testing
 
     def testing?
       !!@testing

data/lib/test_ids_dev/dut.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module TestIdsDev
   class DUT
     include Origen::TopLevel

data/lib/test_ids_dev/interface.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module TestIdsDev
   class Interface
     include OrigenTesters::ProgramGenerators
 
-    def initialize(options = {})
+    def initialize(_options = {})
       case dut.test_ids
       when 1
         TestIds.configure id: :cfg1 do |config|

data/program/prb1.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Flow.create do
   if dut.test_ids == 2
     func :t1, bin: 11