origen 0.34.3 → 0.52.0

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]
+        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]
@@ -271,37 +271,47 @@ module Origen
       tests.empty? ? false : true
     end
 
-    def sub_block(name, options = {})
+    def sub_block(name = nil, options = {})
+      name, options = nil, name if name.is_a?(Hash)
+      return sub_blocks unless name
       if i = options.delete(:instances)
-        a = []
-        options[:_instance] = i
-        i.times do |j|
-          o = options.dup
-          o[:_instance] = j
-          a << sub_block("#{name}#{j}", o)
-        end
-        define_singleton_method "#{name}s" do
-          a
+        # 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
+        unless respond_to?(group_name)
+          sub_block_groups group_name do
+            i.times do |j|
+              o = options.dup
+              o[:_instance] = j
+              sub_block("#{name}#{j}", o)
+            end
+          end
         end
-        a
       else
         block = Placeholder.new(self, name, options)
-        if sub_blocks[name]
-          # Allow additional attributes to be added to an existing sub-block if it hasn't
-          # been instantiated yet. This is not supported yet for instantiated sub-blocks since
-          # there are probably a lot more corner-cases to consider, and hopefully no one will
-          # really need this anyway.
-          if sub_blocks[name].is_a?(Placeholder)
-            sub_blocks[name].add_attributes(options)
-          else
-            fail "You have already defined a sub-block named #{name} within class #{self.class}"
-          end
-        else
-          sub_blocks[name] = block
+        # Allow additional attributes to be added to an existing sub-block if it hasn't
+        # been instantiated yet. This is not supported yet for instantiated sub-blocks since
+        # there are probably a lot more corner-cases to consider, and hopefully no one will
+        # really need this anyway.
+        if sub_blocks[name] && !sub_blocks[name].is_a?(Placeholder)
+          fail "You have already defined a sub-block named #{name} within class #{self.class}"
+        end
+        if respond_to?(name)
+          callers = Origen.split_caller_line caller[0]
+          Origen.log.warning "The sub_block defined at #{Pathname.new(callers[0]).relative_path_from(Pathname.pwd)}:#{callers[1]} is overriding an existing method called #{name}"
         end
         define_singleton_method name do
           get_sub_block(name)
         end
+        if sub_blocks[name] && sub_blocks[name].is_a?(Placeholder)
+          sub_blocks[name].add_attributes(options)
+        else
+          sub_blocks[name] = block
+        end
+        unless @current_group.nil?  # a group is currently open, store sub_block id only
+          @current_group << name
+        end
         if options.key?(:lazy)
           lazy = options[:lazy]
         else
@@ -311,6 +321,57 @@ module Origen
       end
     end
 
+    # Create a group of associated sub_blocks under a group name
+    # permits each sub_block to be of a different class
+    # e.g.
+    # sub_block_group :my_ip_group do
+    #   sub_block :ip0, class_name: 'IP0', base_address: 0x000000
+    #   sub_block :ip1, class_name: 'IP1', base_address: 0x000200
+    #   sub_block :ip2, class_name: 'IP2', base_address: 0x000400
+    #   sub_block :ip3, class_name: 'IP3', base_address: 0x000600
+    # end
+    #
+    # creates an array referenced by method called 'my_ip_group'
+    # which contains the sub_blocks 'ip0', 'ip1', 'ip2', 'ip3'.
+    #
+    # Can also indicate a custom class container to hold these.
+    # This custom class container MUST support a '<<' method in
+    # order to add new sub_blocks to the container instance.
+    #
+    # e.g.
+    # sub_block_group :my_ip_group, class_name: 'MYGRP' do
+    #   sub_block :ip0, class_name: 'IP0', base_address: 0x000000
+    #   sub_block :ip1, class_name: 'IP1', base_address: 0x000200
+    #   sub_block :ip2, class_name: 'IP2', base_address: 0x000400
+    #   sub_block :ip3, class_name: 'IP3', base_address: 0x000600
+    # end
+    #
+    #
+    def sub_block_group(id, options = {})
+      @current_group = []    # open group
+      yield                  # any sub_block calls within this block will have their ID added to @current_group
+      my_group = @current_group.dup
+      if respond_to?(id)
+        callers = Origen.split_caller_line caller[0]
+        Origen.log.warning "The sub_block_group defined at #{Pathname.new(callers[0]).relative_path_from(Pathname.pwd)}:#{callers[1]} is overriding an existing method called #{id}"
+      end
+      define_singleton_method "#{id}" do
+        if options[:class_name]
+          b = Object.const_get(options[:class_name]).new
+        else
+          b = []
+        end
+        my_group.each do |group_id|
+          b << send(group_id)
+        end
+        b                         # return array inside new singleton method
+      end
+      @current_group = nil   # close group
+    end
+    alias_method :sub_block_groups, :sub_block_group
+    alias_method :sub_blocks_groups, :sub_block_group
+    alias_method :sub_blocks_group, :sub_block_group
+
     def namespace
       self.class.to_s.sub(/::[^:]*$/, '')
     end
@@ -346,6 +407,11 @@ module Origen
 
       # Make this appear like a sub-block to any application code
       def is_a?(klass)
+        # Because sub_blocks are stored in a hash.with_indifferent_access, the value is tested
+        # against being a Hash or Array when it is added to the hash. This prevents the class being
+        # 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
 
@@ -363,13 +429,16 @@ module Origen
       end
 
       def materialize
+        block = nil
         file = attributes.delete(:file)
+        load_block = attributes.delete(:load_block)
         dir = attributes.delete(:dir) || owner.send(:export_dir)
         block = owner.send(:instantiate_sub_block, name, klass, attributes)
         if file
           require File.join(dir, file)
           block.extend owner.send(:export_module_names_from_path, file).join('::').constantize
         end
+        block.load_block(load_block) if load_block
         block.owner = owner
         block
       end
@@ -403,17 +472,17 @@ module Origen
         @klass ||= begin
           class_name = attributes.delete(:class_name)
           if class_name
-            if eval("defined? ::#{owner.namespace}::#{class_name}")
+            begin
               klass = eval("::#{owner.namespace}::#{class_name}")
-            else
-              if eval("defined? #{class_name}")
+            rescue NameError
+              begin
                 klass = eval(class_name)
-              else
-                if eval("defined? #{owner.class}::#{class_name}")
+              rescue NameError
+                begin
                   klass = eval("#{owner.class}::#{class_name}")
-                else
+                rescue NameError
                   puts "Could not find class: #{class_name}"
-                  fail 'Unknown sub block class!'
+                  raise 'Unknown sub block class!'
                 end
               end
             end
@@ -441,6 +510,12 @@ module Origen
   class SubBlock
     include Origen::Model
 
+    # Since no application defined this sub-block class, consider its parent's app to be
+    # the owning application
+    def app
+      parent.app
+    end
+
     # Used to create attribute accessors on the fly.
     #
     # On first call of a missing method a method is generated to avoid the missing lookup

data/lib/origen/top_level.rb

@@ -24,6 +24,17 @@ module Origen
       include Origen::Model
     end
 
+    # Unloads all modules class defined by the application and reloads the target, use
+    # this in the console to pick up changes made to files since you opened it.
+    # It will only work if your application uses Origen auto-loading from the app/dir,
+    # any files that you have manually required will not be re-loaded and may generally
+    # cause problems with the use of this method.
+    def reload!
+      Loader.unload
+      Origen.app.reload_target!
+      true
+    end
+
     # Top-level timing manager/API, returns an instance of Origen::Pins::Timing
     def timing
       @timing ||= Pins::Timing.new

data/lib/origen/users/user.rb

@@ -44,10 +44,11 @@ module Origen
         Origen.mailer.send_email(options)
       end
 
-      def id
+      def id(options = {})
         @id.to_s.downcase
       end
       alias_method :core_id, :id
+      alias_method :username, :id
 
       # Returns true if the user is an admin for the current application
       def admin?
@@ -73,7 +74,7 @@ module Origen
         RevisionControl::Git.user_name
       end
 
-      def email
+      def email(options = {})
         if current?
           @email ||= ENV['ORIGEN_EMAIL'] || email_from_rc || begin
             if Origen.site_config.email_domain

data/lib/origen/utility/mailer.rb

@@ -7,13 +7,18 @@ module Origen
       # Generic method to send an email, alternatively use one of the
       # pre-defined mail types using the other methods.
       def send_email(options = {})
-        options = { server:     Origen.site_config.email_server,
-                    port:       Origen.site_config.email_port,
-                    from:       current_user.email,
-                    from_alias: current_user.name,
-                    subject:    'Hello',
-                    body:       'Hello from Origen!',
-                    to:         'Stephen McGinty <stephen.mcginty@freescale.com>'
+        options = { server:         Origen.site_config.email_server,
+                    port:           Origen.site_config.email_port,
+                    from:           current_user.email,
+                    from_alias:     current_user.name,
+                    subject:        'Hello',
+                    body:           'Hello from Origen!',
+                    to:             current_user.email,
+                    authentication: (Origen.site_config.email_authentication || :none).to_sym,
+                    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)
 
         # Force to an array
@@ -32,10 +37,38 @@ Subject: #{options[:subject]}
 END_OF_MESSAGE
 
           begin
+            Origen.log.debug('Origen::Utility::Mailer Setup:')
+            options.each { |k, v| Origen.log.debug("  #{k}: #{v}") }
+
+            # Net::SMTP.start(options[:server], options[:port]) do |smtp|
+            #  smtp.send_message msg, options[:from], addr
+            # end
+
             # Exceptions raised here will be caught by rescue clause
-            Net::SMTP.start(options[:server], options[:port]) do |smtp|
-              smtp.send_message msg, options[:from], addr
+            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
+
+            smtp.start(*opts) do |m|
+              m.send_message(msg, options[:from], addr)
             end
+
+            # Exceptions raised here will be caught by rescue clause
+            # smtp = Net::SMTP.new(options[:server], options[:port])
+            # smtp.enable_starttls
+
+            # smtp.start (options[:domain], options[:auth_user], options[:auth_password], options[:authentication]) do |smtp|
+            #  smtp.send_message(msg, options[:from], addr)
+            # end
           rescue
             warn "Email not able to be sent to address '#{addr}'"
           end

data/lib/origen/value/bin_str_val.rb

@@ -64,7 +64,7 @@ module Origen
         if val =~ /^[01_xXzZ]+$/
           true
         else
-          fail Origen::SyntaxError, 'Binary string values can only contain: 0, 1, _, x, X, z, Z'
+          fail Origen::BinStrValError, "Binary string values can only contain: 0, 1, _, x, X, z, Z, this is invalid: #{val}"
         end
       end
     end

data/lib/origen/value/hex_str_val.rb

@@ -92,7 +92,7 @@ module Origen
         if val =~ /^[0-9a-fA-F_xXzZ]+$/
           true
         else
-          fail Origen::SyntaxError, 'Hex string values can only contain: 0-9, a-f, A-F, _, x, X, z, Z'
+          fail Origen::HexStrValError, "Hex string values can only contain: 0-9, a-f, A-F, _, x, X, z, Z, this is invalid: #{val}"
         end
       end
     end

data/lib/origen/version_string.rb

@@ -32,7 +32,12 @@ module Origen
     alias_method :orig_equal?, :==
 
     def equal?(version)
-      condition_met?("== #{version}")
+      # If not a valid version string, compare using regular string comparison
+      if valid?
+        condition_met?("== #{version}")
+      else
+        orig_equal?(version)
+      end
     end
     alias_method :eq?, :equal?
     alias_method :==, :equal?

data/lib/tasks/gem.rake

@@ -24,7 +24,12 @@ namespace 'gem' do
       if Origen.app.config.release_externally
         cmd = "gem push #{built_gem_path}"
       else
-        cmd = "gem inabox --host #{Origen.site_config.gem_server!} #{built_gem_path}"
+        url = Origen.site_config.gem_server_push || Origen.site_config.gem_server!
+        if Origen.site_config.gem_push_cmd
+          cmd = Origen.site_config.gem_push_cmd.gsub('+URL+', url).gsub('+GEM+', built_gem_path)
+        else
+          cmd = "gem push #{built_gem_path} --host #{url}"
+        end
       end
       sh(cmd) do |ok, _res|
         if ok

data/origen_app_generators/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in origen_app_generators.gemspec
+gemspec
+
+# DO NOT ADD ANY RUNTIME GEMS HERE, WHEN THESE GENERATORS ARE INVOKED TO
+# GENERATE A NEW APPLICATION IT WILL NOT BE LAUNCHED FROM WITHIN A BUNDLED
+# ENVIRONMENT.
+#
+# THEREFORE GENERATORS MUST NOT RELY ON ANY 3RD PARTY GEMS THAT ARE NOT
+# PRESENT AS PART OF A STANDARD RGEN INSTALLATION - I.E. YOU CAN ONLY RELY
+# ON THE GEMS THAT RGEN ITSELF DEPENDS ON.
+
+gem 'byebug', '< 9.1.0'
+#gem 'origen'
+#gem 'origen', path: "~/Code/github/origen"
+
+# Lock this version to enable testing on Ruby 2.2
+gem 'nokogiri', '1.8.5'

data/origen_app_generators/Gemfile.lock

@@ -0,0 +1,152 @@
+PATH
+  remote: .
+  specs:
+    origen_app_generators (2.0.0)
+      origen (>= 0.40.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.11.1)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    bootsnap (1.4.4)
+      msgpack (~> 1.0)
+    builder (3.2.3)
+    byebug (9.0.6)
+    coderay (1.1.2)
+    colored (1.2)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.5)
+    cri (2.10.1)
+      colored (~> 1.2)
+    dentaku (2.0.11)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    geminabox (0.12.4)
+      builder
+      faraday
+      httpclient (>= 2.2.7)
+      nesty
+      sinatra (>= 1.2.7)
+    gems (0.8.3)
+    highline (1.7.10)
+    httparty (0.17.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    httpclient (2.8.3)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    json (2.2.0)
+    kramdown (1.17.0)
+    method_source (0.9.2)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    msgpack (1.2.10)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    nanoc (3.7.5)
+      cri (~> 2.3)
+    nesty (1.0.2)
+    net-ldap (0.16.1)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    origen (0.44.0)
+      activesupport (~> 4.1)
+      bootsnap (>= 1.3.2)
+      bundler (~> 1.7)
+      coderay (~> 1.1)
+      colored (~> 1.2)
+      colorize (~> 0.8.1)
+      concurrent-ruby
+      cri (~> 2.10.0)
+      dentaku (~> 2)
+      geminabox (= 0.12.4)
+      gems (~> 0.8)
+      highline (~> 1.7)
+      httparty (~> 0.13)
+      kramdown (~> 1.5)
+      nanoc (~> 3.7.0)
+      net-ldap (~> 0.13)
+      nokogiri (>= 1.7.2)
+      pry (~> 0.10)
+      rake (~> 10)
+      rspec (~> 3)
+      rspec-legacy_formatters (~> 1)
+      rubocop (= 0.30)
+      scrub_rb (~> 1.0)
+      simplecov (~> 0.9)
+      sinatra (~> 1)
+      thor (~> 0.19)
+      yard (~> 0.8)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (1.6.11)
+    rack-protection (1.5.5)
+      rack
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-legacy_formatters (1.0.1)
+      rspec (~> 3.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.30.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.10.0)
+    scrub_rb (1.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sinatra (1.4.8)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tilt (2.0.9)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    yard (0.9.19)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (< 9.1.0)
+  nokogiri (= 1.8.5)
+  origen_app_generators!
+
+BUNDLED WITH
+   1.17.1