origen 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 649e449c295842f6dcd2381fd17eb485e4932b65
-  data.tar.gz: 136869fb9cf4ba5006e3db33e055f64c01cf23e0
+  metadata.gz: c03ed69b554f6d924ac5fcffe87d9c18724a9606
+  data.tar.gz: 8f1c2964ce925f3ccb176bd3ee9a3c0c0e6e7841
 SHA512:
-  metadata.gz: eb114bdf1e8531c675f99b4d9f0507b13d6b7cba858e38972a3a7f78ba99d3435e47985234fb4d875de1d23c185d1450a52cc2c6a35c6aa968f78aac4ac09904
-  data.tar.gz: 1ea70aaeca94170041b27a088b1a5933506546ae2a9b134e00ca41b2b23ed77da253936ba1854cb9e2cc81a781e297cbdb2d2baba18b311f8809e54020a298e6
+  metadata.gz: 254950fe29f7941f9eb65a1e2ac37e4dcac85dc141a5825c93ae96c13db1cea0d26520a5043281f664f0ca3c93ea2157801b29616fc6460bcd30aa2e14b9a194
+  data.tar.gz: b2aaac13da19297800d4301b275d91f201b7e92e02483fa59b852718580afa15c051da52422d73da621403c6a7d2cd0b9a067530767ada7b5dd97de461411fcb

data/config/version.rb

@@ -1,7 +1,7 @@
 module Origen
   MAJOR = 0
-  MINOR = 1
-  BUGFIX = 3
+  MINOR = 2
+  BUGFIX = 0
   DEV = nil
 
   VERSION = [MAJOR, MINOR, BUGFIX].join(".") + (DEV ? ".pre#{DEV}" : '')

data/lib/origen/application/deployer.rb

@@ -157,21 +157,22 @@ module Origen
       end
 
       def deploy_file(file)
-        if deploy_to_git?
-          fail 'File based deploy has is not support for Git yet :-('
-        else
-          remote_dir = live_remote_directory
-          if remote_dir
-            file = Origen.file_handler.clean_path_to(file)
-            sub_dir = Origen.file_handler.sub_dir_of(file, "#{Origen.root}/templates/web") .to_s
-            page = file.basename.to_s.sub(/\..*/, '')
-            # Special case for the main index page
-            if page == 'index' && sub_dir == '.'
-              FileUtils.cp "#{Origen.root}/web/output/index.html", remote_dir
-            else
-              FileUtils.mkdir_p("#{remote_dir}/#{sub_dir}/#{page}")
-              FileUtils.cp "#{Origen.root}/web/output/#{sub_dir}/#{page}/index.html", "#{remote_dir}/#{sub_dir}/#{page}"
-            end
+        remote_dir = deploy_to_git? ? "#{git_repo.local}/#{git_sub_dir}" : live_remote_directory
+        if remote_dir
+          file = Origen.file_handler.clean_path_to(file)
+          sub_dir = Origen.file_handler.sub_dir_of(file, "#{Origen.root}/templates/web") .to_s
+          page = file.basename.to_s.sub(/\..*/, '')
+          # Special case for the main index page
+          if page == 'index' && sub_dir == '.'
+            FileUtils.cp "#{Origen.root}/web/output/index.html", remote_dir
+            file = "#{remote_dir}/index.html"
+          else
+            FileUtils.mkdir_p("#{remote_dir}/#{sub_dir}/#{page}")
+            file = "#{remote_dir}/#{sub_dir}/#{page}/index.html"
+            FileUtils.cp "#{Origen.root}/web/output/#{sub_dir}/#{page}/index.html", file
+          end
+          if deploy_to_git?
+            git_repo.checkin file, unmanaged: true, comment: @commit_message
           end
         end
       end
@@ -237,8 +238,6 @@ module Origen
               FileUtils.cp_r Dir.glob("#{Origen.root}/templates/nanoc/*").sort, dir, remove_destination: true
             end
           end
-          # Remove the .SYNCs
-          system "find #{dir} -name \".SYNC\" | xargs rm -fr"
           @nanoc_dir = dir
         end
       end

data/lib/origen/application/plugins_manager.rb

@@ -151,7 +151,7 @@ module Origen
         printf(format, 'Origen_Name', 'Name', 'Version')
         printf(format, '---------', '----', '-------')
 
-        Origen.plugins.each do |plugin|
+        Origen.plugins.sort_by { |p| p.name.to_s }.each do |plugin|
           printf(format, plugin.name, plugin.config.name, plugin.version)
         end
         puts ''

data/lib/origen/commands.rb

@@ -159,15 +159,47 @@ end
 # prevent Origen from then having a go.
 # This order is preferable to allowing Origen to go first since it allows
 # overloading of Origen commands by the application.
+@application_options = []
+@plugin_commands = []
+@application_commands = []
+app_id = @application_options.object_id
+plugin_id = @plugin_commands.object_id
+app_cmd_id = @application_commands.object_id
+app_opt_err = false
+plugin_opt_err = false
+app_cmd_err = false
 if File.exist? "#{Origen.root}/config/commands.rb"
   require "#{Origen.root}/config/commands"
+  if @application_options.object_id != app_id
+    Origen.log.warning "Don't assign @application_options to a value in config/commands.rb!"
+    Origen.log.warning 'Do something like this instead:'
+    Origen.log.warning '  @application_options << ["-v", "--vector_comments", "Add the vector and cycle number to the vector comments"]'
+    app_opt_err = true
+  end
+  if @plugin_commands.object_id != plugin_id
+    Origen.log.warning "Don't assign @plugin_commands to a new value in config/commands.rb!"
+    Origen.log.warning 'Do something like this instead:'
+    Origen.log.warning '  @plugin_commands << " testers:build   Build a test program from a collection of sub-programs"'
+    plugin_opt_err = true
+  end
 end
 
 shared_commands = Origen.import_manager.command_launcher
-@plugin_commands ||= []
 if shared_commands && shared_commands.size != 0
   shared_commands.each do |file|
     require file
+    if @application_options.object_id != app_id && !app_opt_err
+      Origen.log.warning "Don't assign @application_options to a new value in #{file}!"
+      Origen.log.warning 'Do something like this instead:'
+      Origen.log.warning '  @application_options << ["-v", "--vector_comments", "Add the vector and cycle number to the vector comments"]'
+      app_opt_err = true
+    end
+    if @plugin_commands.object_id != plugin_id && !plugin_opt_err
+      Origen.log.warning "Don't assign @plugin_commands to a new value in #{file}!"
+      Origen.log.warning 'Do something like this instead:'
+      Origen.log.warning '  @plugin_commands << " testers:build   Build a test program from a collection of sub-programs"'
+      plugin_opt_err = true
+    end
   end
 end
 

data/lib/origen/commands/interactive.rb

@@ -11,9 +11,17 @@ module Origen
   # Methods available to the command line in a console session, split this to a
   # separate file if it gets large over time
   module ConsoleMethods
-    def j750
-      @_j750 ||= Origen::Tester::J750.new
-      @_j750.parser
+    def ls
+      `ls`.split("\n")
+    end
+
+    def cd(dir)
+      Dir.chdir(dir)
+      Dir.pwd
+    end
+
+    def pwd
+      Dir.pwd
     end
   end
 

data/lib/origen/commands/rc.rb

@@ -350,7 +350,11 @@ The following options are available:
         else
           puts 'The following files have been modified:'
           changes.flatten.each do |file|
-            puts "  #{Origen.app.rc.diff_cmd(file, Origen.app.version)}"
+            if Origen.app.rc.git?
+              puts "  #{Origen.app.rc.diff_cmd(file)}"
+            else
+              puts "  #{Origen.app.rc.diff_cmd(file, Origen.app.version)}"
+            end
           end
         end
       end

data/lib/origen/commands/web.rb

@@ -197,6 +197,7 @@ The following options are available:
     when 'deploy'
       Origen.app.load_target!
       _require_web_directory
+      _deployer.prepare!(options)
       if ARGV.empty?
         _deployer.deploy_site
       else
@@ -211,6 +212,7 @@ The following options are available:
     when 'archive'
       Origen.app.load_target!
       _require_web_directory
+      _deployer.prepare!(options)
       unless ARGV[0]
         puts 'You must supply an ID argument to create an archive'
       end

data/lib/origen/generator/pattern.rb

@@ -224,13 +224,36 @@ module Origen
         c2 '*' * 75
         c2 'ENVIRONMENT:'
         c2 '  Application'
-        c2 "    Source:    #{Origen.config.rc_url}"
+        if Origen.app.rc.git?
+          c2 "    Source:    #{Origen.config.rc_url}"
+        else
+          c2 "    Vault:     #{Origen.config.vault}"
+        end
         c2 "    Version:   #{Origen.app.version}"
         c2 "    Workspace: #{Origen.root}"
+        if Origen.app.rc.git?
+          begin
+            status = "#{Origen.app.rc.current_branch}(#{Origen.app.rc.current_commit})"
+            status += ' (+local edits)' unless Origen.app.rc.local_modifications.empty?
+            c2 "    Branch:    #{status}"
+          rescue
+            # No problem, we did our best
+          end
+        end
         c2 '  Origen'
-        c2 '    Source:    https://github.com/Origen-SDK/origen'
+        if Origen.app.rc.git?
+          c2 '    Source:    https://github.com/Origen-SDK/origen'
+        else
+          c2 "    Vault:     #{Origen.config.vault}"
+        end
         c2 "    Version:   #{Origen.version}"
         c2 "    Workspace: #{Origen.top}"
+        unless Origen.plugins.empty?
+          c2 '  Plugins'
+          Origen.plugins.sort_by { |p| p.name.to_s }.each do |plugin|
+            c2 "    #{plugin.name}:".ljust(30) + plugin.version
+          end
+        end
         c2 '*' * 75
         if Origen.config.pattern_header
           c2 '*' * 75

data/lib/origen/regression_manager.rb

@@ -219,7 +219,11 @@ module Origen
       puts ''
       puts 'WHAT VERSION DO YOU WANT TO COMPARE AGAINST?'
       puts ''
-      puts "Valid values are 'latest', 'last' (production release), or a tag."
+      if Origen.app.rc.git?
+        puts "Valid values are 'latest', 'last' (production release), a tag, a commit or a branch."
+      else
+        puts "Valid values are 'latest', 'last' (production release), or a tag."
+      end
       puts ''
       get_text(default: Origen.app.version, single: true)
     end
@@ -230,11 +234,8 @@ module Origen
         Origen.app.version_tracker.versions.last
       elsif version.downcase == 'latest'
         version
-      elsif VersionString.new(version).valid?
-        version
       else
-        puts 'Sorry but that version tag looks to be invalid!'
-        exit 1
+        version
       end
     end
 

data/lib/origen/revision_control/git.rb

@@ -25,9 +25,14 @@ module Origen
         end
 
         if options[:force]
-          git 'reset HEAD'
-          git 'pull', options
-          git "checkout #{version} #{paths.join(' ')}", options
+          version = "origin/#{version}" if remote_branch?(version)
+          if paths == [local.to_s]
+            git "reset --hard #{version}"
+          else
+            git 'reset HEAD'
+            git 'pull', options
+            git "checkout #{version} #{paths.join(' ')}", options
+          end
         else
           if paths.size > 1 || paths.first != local.to_s
             fail 'The Git driver does not support partial merge checkout, it has to be the whole workspace'
@@ -63,8 +68,8 @@ module Origen
         # Can't check in unless we have the latest
         if options[:force] && !options[:initial]
           # Locally check in the given files
-          checkin(paths.join(' '), local: true, verbose: false, comment: options[:comment])
-          local_rev = current_commit
+          checkin(paths.join(' '), no_push: true, verbose: false, comment: options[:comment])
+          local_rev = current_commit(short: false)
           # Pull latest
           checkout
           # Restore the given files to our previous version
@@ -103,7 +108,7 @@ module Origen
           end
           git cmd, options
         end
-        git "push origin #{current_branch}" unless options[:local]
+        git "push origin #{current_branch}" unless options[:no_push]
         paths
       end
 
@@ -161,8 +166,12 @@ module Origen
         git(cmd, options).map(&:strip)
       end
 
-      def diff_cmd(file, version)
-        "git difftool --tool tkdiff -y #{prefix_tag(version)} #{file}"
+      def diff_cmd(file, version = nil)
+        if version
+          "git difftool --tool tkdiff -y #{prefix_tag(version)} #{file}"
+        else
+          "git difftool --tool tkdiff -y #{file}"
+        end
       end
 
       def tag(id, options = {})
@@ -184,6 +193,18 @@ module Origen
         git('rev-parse --abbrev-ref HEAD', verbose: false).first
       end
 
+      def current_commit(options = {})
+        options = {
+          short: true
+        }.merge(options)
+        commit = git('rev-parse HEAD', verbose: false).first
+        if options[:short]
+          commit[0, 11]
+        else
+          commit
+        end
+      end
+
       # Returns true if the given tag already exists
       def tag_exists?(tag)
         git('fetch', verbose: false) unless @all_tags_fetched
@@ -191,9 +212,24 @@ module Origen
         git('tag', verbose: false).include?(tag.to_s)
       end
 
+      # Returns true if the given string matches a branch name in the remote repo
+      #   Origen.app.rc.remote_branch?("master")                 # => true
+      #   Origen.app.rc.remote_branch?("feature/exists")         # => true
+      #   Origen.app.rc.remote_branch?("feature/does_not_exist") # => false
+      def remote_branch?(str)
+        # Github doesn't like the ssh:// for this command, whereas Stash seems
+        # to require it.
+        if github?
+          rem = remote_without_protocol
+        else
+          rem = remote
+        end
+        !git("ls-remote --heads #{rem} #{str}", verbose: false).empty?
+      end
+
       def initialized?
         File.exist?("#{local}/.git") &&
-          git('remote -v', verbose: false).any? { |r| r =~ /#{remote_without_protocol}/ } &&
+          git('remote -v', verbose: false).any? { |r| r =~ /#{remote_without_protocol_and_user}/ || r =~ /#{remote_without_protocol_and_user.to_s.gsub(':', "\/")}/ } &&
           !git('status', verbose: false).any? { |l| l =~ /^#? ?Initial commit$/ }
       end
 
@@ -204,12 +240,45 @@ module Origen
         FileUtils.rm_f files
       end
 
+      # A class method is provided to fetch the user name since it is useful to have access
+      # to this when outside of an application workspace, e.g. when creating a new app
+      def self.user_name
+        git('config user.name', verbose: false).first
+      rescue
+        nil
+      end
+
+      # A class method is provided to fetch the user email since it is useful to have access
+      # to this when outside of an application workspace, e.g. when creating a new app
+      def self.user_email
+        git('config user.email', verbose: false).first
+      rescue
+        nil
+      end
+
+      def user_name
+        self.class.user_name
+      end
+
+      def user_email
+        self.class.user_email
+      end
+
+      # Returns true if the remote points to a github url
+      def github?
+        !!(remote.to_s =~ /github.com/)
+      end
+
       private
 
       def remote_without_protocol
         Pathname.new(remote.sub(/^.*:\/\//, ''))
       end
 
+      def remote_without_protocol_and_user
+        Pathname.new(remote_without_protocol.to_s.sub(/^.*@/, ''))
+      end
+
       def create_gitignore
         c = Origen::Generator::Compiler.new
         c.compile "#{Origen.top}/templates/git/gitignore.erb",
@@ -223,10 +292,6 @@ module Origen
         !(git('status --verbose', verbose: false).last =~ /^(no changes|nothing to commit)/)
       end
 
-      def current_commit
-        git('rev-parse HEAD', verbose: false).first
-      end
-
       def initialize_local_dir
         super
         unless initialized?
@@ -236,8 +301,13 @@ module Origen
         end
       end
 
-      # Execute a git operation, the resultant output is returned in an array
       def git(command, options = {})
+        options[:local] = local
+        self.class.git(command, options)
+      end
+
+      # Execute a git operation, the resultant output is returned in an array
+      def self.git(command, options = {})
         options = {
           check_errors: true,
           verbose:      true
@@ -247,7 +317,7 @@ module Origen
           Origen.log.info "git #{command}"
           Origen.log.info ''
         end
-        Dir.chdir local do
+        chdir options[:local] do
           Open3.popen2e("git #{command}") do |_stdin, stdout_err, wait_thr|
             while line = stdout_err.gets
               Origen.log.info line.strip if options[:verbose]
@@ -266,6 +336,16 @@ module Origen
         end
         output
       end
+
+      def self.chdir(dir)
+        if dir
+          Dir.chdir dir do
+            yield
+          end
+        else
+          yield
+        end
+      end
     end
   end
 end

data/lib/origen/specs.rb

@@ -9,7 +9,8 @@ module Origen
     autoload :Mode_Select, 'origen/specs/mode_select.rb'
     autoload :Version_History, 'origen/specs/version_history.rb'
     autoload :Creation_Info, 'origen/specs/creation_info.rb'
-    require_relative 'specs/checkers'
+    require 'origen/specs/checkers'
+    include Checkers
 
     attr_accessor :_specs, :_notes, :_exhibits, :_doc_resources, :_overrides, :_power_supplies, :_mode_selects, :_version_history, :_creation_info
 
@@ -19,6 +20,14 @@ module Origen
 
     SpecTableAttr = Struct.new(:table_text, :show, :padding)
 
+    # A regular Array but print specs to the console via their ID for brevity and
+    # consistency with other APIs (e.g. $dut.regs  # => [:reg1, :reg2])
+    class SpecArray < Array
+      def inspect
+        map(&:name).inspect
+      end
+    end
+
     # Returns a hash of hash containing all specs/modes
     # If no spec is specified then all specs are returned via inspect
     # If a spec is specified, a spec object will be returned if found
@@ -31,9 +40,8 @@ module Origen
         sub_type:      nil,
         mode:          current_mode.nil? ? nil : current_mode.name,
         spec:          nil,
-        verbose:       false,
         creating_spec: false
-      }.update(options)
+      }.update(options || {})
       _specs
       if s.nil?
         return show_specs(options)
@@ -47,7 +55,9 @@ module Origen
     end
 
     # Define and instantiate a Spec object
-    def spec(name, type, mode = nil, &block)
+    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?
@@ -80,7 +90,6 @@ module Origen
         sub_type:      nil,
         mode:          current_mode.nil? ? nil : current_mode.name,
         spec:          nil,
-        verbose:       false,
         creating_spec: false
       }.update(options)
       if @_specs.nil? || @_specs == {}
@@ -102,7 +111,6 @@ module Origen
         sub_type:      nil,
         mode:          current_mode.nil? ? nil : current_mode.name,
         spec:          nil,
-        verbose:       false,
         creating_spec: false
       }.update(options)
       options[:spec] = s
@@ -157,8 +165,8 @@ module Origen
       end
     end
 
-    def creation_info(author, date, src_info = {}, tool_info = {})
-      @_creation_info = Creation_Info.new(author, date, src_info, tool_info)
+    def creation_info(author, date, version, src_info = {}, tool_info = {})
+      @_creation_info = Creation_Info.new(author, date, version, src_info, tool_info)
     end
 
     # Returns a Note object from the notes hash
@@ -434,8 +442,7 @@ module Origen
         spec:              nil,
         type:              nil,
         sub_type:          nil,
-        verbose:           false,
-        specs_to_be_shown: [],
+        specs_to_be_shown: SpecArray.new,
         owner:             nil,
         creating_spec:     false
       }.update(options)
@@ -476,13 +483,12 @@ module Origen
         return specs_to_be_shown.first
       else
         Origen.log.debug "returning an array of specs during initial search: #{specs_to_be_shown}"
-        print_to_console(specs_to_be_shown) if options[:verbose] == true
         return specs_to_be_shown
       end
     end
 
     # Method to print a spec table to the console
-    def print_to_console(specs_to_be_shown)
+    def specs_to_table_string(specs_to_be_shown)
       whitespace_padding = 3
       table = []
       attrs_to_be_shown = {
@@ -543,7 +549,7 @@ module Origen
         table << data += '|'
       end
       table << '-' * header.length
-      puts table.flatten.join("\n")
+      table.flatten.join("\n")
     end
   end
 end