lib/test_ids.rb in test_ids-0.8.2 vs lib/test_ids.rb in test_ids-1.0.0

@@ -22,16 +22,61 @@
     #
     # Use the same arguments as you would normally pass to flow.test, the numbers
     # returned will be the same as would be injected into flow.test.
     def allocate(instance, options = {})
       opts = options.dup
+      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]
       }
     end
 
+    # Similar to allocate, but allocates a test number only, i.e. no bin or softbin
+    def allocate_number(instance, options = {})
+      opts = options.dup
+      opts[:bin] = :none
+      opts[:softbin] = :none
+      inject_flow_id(opts)
+      current_configuration.allocator.allocate(instance, opts)
+      {
+        number: opts[:number], number_size: opts[:number_size]
+      }
+    end
+
+    # Similar to allocate, but allocates a softbin number only, i.e. no bin or test number
+    def allocate_softbin(instance, options = {})
+      opts = options.dup
+      opts[:bin] = :none
+      opts[:number] = :none
+      inject_flow_id(opts)
+      current_configuration.allocator.allocate(instance, opts)
+      {
+        softbin: opts[:softbin], softbin_size: opts[:softbin_size]
+      }
+    end
+    alias_method :allocate_soft_bin, :allocate_softbin
+
+    # Similar to allocate, but allocates a bin number only, i.e. no softbin or test number
+    def allocate_bin(instance, options = {})
+      opts = options.dup
+      opts[:softbin] = :none
+      opts[:number] = :none
+      inject_flow_id(opts)
+      current_configuration.allocator.allocate(instance, opts)
+      {
+        softbin: opts[:bin], softbin_size: opts[:bin_size]
+      }
+    end
+
+    # @api private
+    def inject_flow_id(options)
+      if Origen.interface_loaded?
+        options[:test_ids_flow_id] = Origen.interface.flow.id
+      end
+    end
+
     # Load an existing allocator, which will be loaded with a configuration based on what has
     # been serialized into the database if present, otherwise it will have an empty configuration.
     # Returns nil if the given database can not be found.
     # @api internal
     def load_allocator(id = nil)
@@ -45,13 +90,15 @@
 
     def current_configuration
       configuration(@configuration_id)
     end
 
-    def configuration(id)
+    def configuration(id, fail_on_missing = true)
       return @configuration[id] if @configuration && @configuration[id]
-      fail('You have to create the configuration first before you can access it')
+      if fail_on_missing
+        fail('You have to create the configuration first before you can access it')
+      end
     end
     alias_method :config, :configuration
 
     def configure(id = nil, options = {})
       id, options = nil, id if id.is_a?(Hash)
@@ -71,31 +118,51 @@
       config.validate!
 
       initialize_git
     end
 
-    ## Can be called in place of TestIDs.configure to change the configuration from
-    ## the one that was originally supplied.
-    ## It is expected that this is mainly useful for testing purposes only.
-    # def reconfigure(id = nil, options = {}, &block)
-    #  id, options = nil, id if id.is_a?(Hash)
+    # 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
+      @configuration_id = id
+    end
 
-    #  @configuration_id = id || options[:id] || :not_specified
+    def bin_config=(id)
+      @bin_config = id
+    end
 
-    #  @configuration ||= {}
+    def bin_config
+      @bin_config ? configuration(@bin_config, false) : current_configuration
+    end
 
-    #  old = @configuration[@configuration_id]
-    #  new = Configuration.new(@configuration_id)
-    #  new.instance_variable_set('@allocator', old.allocator)
-    #  new.allocator.instance_variable_set('@config', new)
-    #  @configuration[@configuration_id] =  new
+    def softbin_config=(id)
+      @softbin_config = id
+    end
 
-    #  yield new
+    def softbin_config
+      @softbin_config ? configuration(@softbin_config, false) : current_configuration
+    end
 
-    #  new.validate!
-    # end
+    def number_config=(id)
+      @number_config = id
+    end
 
+    def number_config
+      @number_config ? configuration(@number_config, false) : current_configuration
+    end
+
+    # Temporarily switches the current configuration to the given ID for the
+    # duration of the given block, then switches it back to what it was
+    def with_config(id)
+      orig = @configuration_id
+      @configuration_id = id
+      yield
+      @configuration_id = orig
+    end
+
     def configured?
       !!@configuration_id
     end
 
     def initialize_git
@@ -203,9 +270,12 @@
       @configuration = nil
     end
 
     def clear_configuration_id
       @configuration_id = nil
+      @bin_config = nil
+      @softbin_config = nil
+      @number_config = nil
     end
 
     def testing=(val)
       @testing = val
     end