origen_updater 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22a2000f0e9389ed2f408708e5ad0f72cfa6186c
-  data.tar.gz: 6d2f0410c262f3fdfc58f3201b885592b5ad782e
+  metadata.gz: f207701accc963a830a6e1434b4cce3f127819bc
+  data.tar.gz: 58de6275daf1f7d8e470c4ddb1ea3bc9f5a6ed65
 SHA512:
-  metadata.gz: 906ddd63491534139aa3d32349af5d10db238ba4f1ebbaf2a31718bf67a431eed536c872db2ddbd318cffd626aa9ac0337ef38f551776c6a358113c6274da36e
-  data.tar.gz: 321db3e7048916b77ca8fcef3213ff1bbffc5b4dfd96b77f0be8bac2a0da7c7b7d6412dd92b00e8b6e1accc703666907b78d7acd884d07026636787b09a0cdd6
+  metadata.gz: b5aa8946acd330747e3cb9e394fecc8ae3eda974c14e174d1c9a581b667730e65e8bafdcbd4f6f6002e83b6dc86b3a73a5ea10a82f7f3d86496a50fa2144e9e5
+  data.tar.gz: 6a36803945b5ae7e08f649aa89ab4a3fbb3dc6cc001517cb522a59c7d5b9ffc6029b3eb9e164e88ed364d159dac081dc347f06d938780a6f86292123a3f9f980

data/bin/fix_my_workspace

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+$VERBOSE = nil  # Don't care about world writable dir warnings and the like
+
+if $_fix_my_workspace_version_check
+  $_fix_my_workspace_version = '0.3.0'
+else
+  require 'origen'
+
+  if !Origen.site_config.gem_manage_bundler
+    puts 'Sorry but you have opted to manage Bundler yourself via your Origen site config, and this means'
+    puts 'that I cannot make certain assumptions about how your workspace is configured.'
+    puts 'You will need to either resolve this problem yourself, or else change the value of'
+    puts 'gem_mange_bundler to true.'
+    puts 'See here for more details on how to do that: http://origen-sdk.org/origen/guides/starting/company/'
+
+  else
+    ENV['BUNDLE_GEMFILE'] = File.join(Origen.root, 'Gemfile')
+    ENV['BUNDLE_PATH'] = File.expand_path(Origen.site_config.gem_install_dir)
+    ENV['BUNDLE_BIN'] = File.join(Origen.root, 'lbin')
+
+    # Force copy system gems to local gems
+    if Origen.site_config.gem_use_from_system
+      local_gem_dir = "#{ENV['BUNDLE_PATH']}/ruby/#{Pathname.new(Gem.dir).basename}"
+      gem_dir = Pathname.new(Gem.dir)
+
+      Origen.site_config.gem_use_from_system.each do |gem, version|
+        begin
+          # This will raise an error if the system doesn't have this gem installed, that
+          # will be rescued below
+          spec = Gem::Specification.find_by_name(gem, version)
+
+          local_dir = File.join(local_gem_dir, Pathname.new(spec.gem_dir).relative_path_from(gem_dir))
+          FileUtils.mkdir_p local_dir
+          FileUtils.cp_r(spec.gem_dir, local_dir)
+
+          local_file = Pathname.new(File.join(local_gem_dir, Pathname.new(spec.cache_file).relative_path_from(gem_dir)))
+          FileUtils.mkdir_p local_file.dirname
+          FileUtils.cp(spec.cache_file, local_file)
+
+          if spec.extension_dir && File.exist?(spec.extension_dir)
+            local_dir = File.join(local_gem_dir, Pathname.new(spec.extension_dir).relative_path_from(gem_dir))
+            FileUtils.mkdir_p local_dir
+            FileUtils.cp_r(spec.extension_dir, local_dir)
+          end
+
+          local_file = Pathname.new(File.join(local_gem_dir, Pathname.new(spec.spec_file).relative_path_from(gem_dir)))
+          FileUtils.mkdir_p local_file.dirname
+          FileUtils.cp(spec.spec_file, local_file)
+
+        rescue Gem::LoadError
+          # This just means that one of the gems that should be copied from the system
+          # was not actually installed in the system, so nothing we can do about that here
+        end
+      end
+    end
+
+    # Delete lbin
+    FileUtils.rm_rf(ENV['BUNDLE_BIN']) if File.exist?(ENV['BUNDLE_BIN'])
+
+    # Run bundler with correct switches
+    cmd = "bundle install --gemfile #{ENV['BUNDLE_GEMFILE']} --binstubs #{ENV['BUNDLE_BIN']} --path #{ENV['BUNDLE_PATH']}"
+    `chmod o-w #{Origen.root}` # Stops some annoying world writable warnings during install
+    `chmod o-w #{Origen.root}/bin` if File.exist?("#{Origen.root}/bin")
+    `chmod o-w #{Origen.root}/.bin` if File.exist?("#{Origen.root}/.bin")
+
+    # Try again, this time updating the bundle
+    if system(cmd)
+      fixed = true
+    elsif system 'bundle update'
+      fixed = true
+    end
+
+    `chmod o-w #{ENV['BUNDLE_BIN']}` if File.exist?(ENV['BUNDLE_BIN'])
+
+    system 'origen -v' if fixed
+
+  end
+end

data/config/application.rb

@@ -1,94 +1,101 @@
 require 'origen'
 class OrigenUpdaterApplication < Origen::Application
-
   # See http://origen-sdk.org/origen/api/Origen/Application/Configuration.html
   # for a full list of the configuration options available
 
   # These attributes should never be changed, the duplication here will be resolved in future
   # by condensing these attributes that do similar things
-  self.name       = "origen_updater"
-  self.namespace  = "OrigenUpdater"
-  config.name     = "origen_updater"
-  config.initials = "OrigenUpdater"
-  config.rc_url   = "git@github.com:Origen-SDK/origen_updater.git"
+  self.name       = 'origen_updater'
+  self.namespace  = 'OrigenUpdater'
+  config.name     = 'origen_updater'
+  config.initials = 'OrigenUpdater'
+  config.rc_url   = 'git@github.com:Origen-SDK/origen_updater.git'
   config.release_externally = true
 
   # To enable deployment of your documentation to a web server (via the 'origen web'
   # command) fill in these attributes.
-  #config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/origen_updater"
-  #config.web_domain = "http://origen-sdk.org/origen_updater"
+  # config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/origen_updater"
+  # config.web_domain = "http://origen-sdk.org/origen_updater"
 
   # When false Origen will be less strict about checking for some common coding errors,
   # it is recommended that you leave this to true for better feedback and easier debug.
   # This will be the default setting in Origen v3.
   config.strict_errors = true
 
-  config.shared = {
-    command_launcher: "config/shared_commands.rb"
-  }
-
   # See: http://origen-sdk.org/origen/latest/guides/utilities/lint/
   config.lint_test = {
     # Require the lint tests to pass before allowing a release to proceed
-    run_on_tag: true,
+    run_on_tag:   true,
     # Auto correct violations where possible whenever 'origen lint' is run
-    auto_correct: true, 
+    auto_correct: true,
     # Limit the testing for large legacy applications
-    #level: :easy,
+    # level: :easy,
     # Run on these directories/files by default
-    #files: ["lib", "config/application.rb"],
+    files:        ['lib', 'config/application.rb', 'bin']
   }
 
   config.semantically_version = true
 
+  def before_release_tag(identifier, note, type, selector, options)
+    v = Origen::VersionString.new(identifier)
+    # Update the version in the command files
+    f = "#{Origen.root}/bin/fix_my_workspace"
+    data = File.read(f)
+    filtered_data = data.sub(/\$_fix_my_workspace_version = '\d+\.\d+\.\d+'/, "$_fix_my_workspace_version = '#{v}'")
+    File.open(f, 'w') do |f|
+      f.write(filtered_data)
+    end
+    Origen.app.rc.checkin f, comment: 'Wrote new version in command code'
+  end
+
   # An example of how to set application specific LSF parameters
-  #config.lsf.project = "msg.te"
-  
+  # config.lsf.project = "msg.te"
+
   # An example of how to specify a prefix to add to all generated patterns
-  #config.pattern_prefix = "nvm"
+  # config.pattern_prefix = "nvm"
 
   # An example of how to add header comments to all generated patterns
-  #config.pattern_header do
+  # config.pattern_header do
   #  cc "This is a pattern created by the example origen application"
-  #end
+  # end
 
   # By default all generated output will end up in ./output.
   # Here you can specify an alternative directory entirely, or make it dynamic such that
-  # the output ends up in a setup specific directory. 
-  #config.output_directory do
+  # the output ends up in a setup specific directory.
+  # config.output_directory do
   #  "#{Origen.root}/output/#{$dut.class}"
-  #end
+  # end
 
   # Similarly for the reference files, generally you want to setup the reference directory
   # structure to mirror that of your output directory structure.
-  #config.reference_directory do
+  # config.reference_directory do
   #  "#{Origen.root}/.ref/#{$dut.class}"
-  #end
- 
+  # end
+
   # This will automatically deploy your documentation after every tag
-  #def after_release_email(tag, note, type, selector, options)
+  # def after_release_email(tag, note, type, selector, options)
   #  command = "origen web compile --remote --api"
   #  Dir.chdir Origen.root do
   #    system command
   #  end
-  #end
+  # end
 
   # Ensure that all tests pass before allowing a release to continue
-  #def validate_release
+  # def validate_release
   #  if !system("origen specs") || !system("origen examples")
   #    puts "Sorry but you can't release with failing tests, please fix them and try again."
   #    exit 1
   #  else
   #    puts "All tests passing, proceeding with release process!"
   #  end
-  #end
+  # end
 
   # To enabled source-less pattern generation create a class (for example PatternDispatcher)
   # to generate the pattern. This should return false if the requested pattern has been
   # dispatched, otherwise Origen will proceed with looking up a pattern source as normal.
-  #def before_pattern_lookup(requested_pattern)
+  # def before_pattern_lookup(requested_pattern)
   #  PatternDispatcher.new.dispatch_or_return(requested_pattern)
-  #end
+  # end
 
   # If you use pattern iterators you may come across the case where you request a pattern
   # like this:
@@ -96,11 +103,10 @@ class OrigenUpdaterApplication < Origen::Application
   #
   # However it cannot be found by Origen since the pattern name is actually example_pat_bx.atp
   # In the case where the pattern cannot be found Origen will pass the name to this translator
-  # if it exists, and here you can make any substitutions to help Origen find the file you 
+  # if it exists, and here you can make any substitutions to help Origen find the file you
   # want. In this example any instances of _b\d, where \d means a number, are replaced by
   # _bx.
-  #config.pattern_name_translator do |name|
+  # config.pattern_name_translator do |name|
   #  name.gsub(/_b\d/, "_bx")
-  #end
-
+  # end
 end

data/config/version.rb

@@ -1,6 +1,6 @@
 module OrigenUpdater
   MAJOR = 0
-  MINOR = 2
+  MINOR = 3
   BUGFIX = 0
   DEV = nil
 

data/lib/origen_updater.rb

@@ -1,6 +1,18 @@
 require 'origen'
 require_relative '../config/application.rb'
-module OrigenUpdater
-  # Don't load anything from here, everything must load from the update command and with
-  # no dependencies
+
+# Ensure the app always has the latest version of the updater scripts
+app_fix_my_workspace = "#{Origen.root}/bin/fix_my_workspace"
+if File.exist?(app_fix_my_workspace)
+  $_fix_my_workspace_version_check = true
+  load app_fix_my_workspace
+end
+
+if $_fix_my_workspace_version != Origen.app!.version
+  master_fix_my_workspace = File.expand_path('../../bin/fix_my_workspace', __FILE__)
+  FileUtils.mkdir_p "#{Origen.root}/bin" unless File.exist?("#{Origen.root}/bin")
+  # When running standalone
+  unless master_fix_my_workspace == app_fix_my_workspace
+    FileUtils.cp master_fix_my_workspace, app_fix_my_workspace
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: origen_updater
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Stephen McGinty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-23 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: origen
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0'
 description: 
 email:
 - stephen.f.mcginty@gmail.com
@@ -31,14 +31,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/fix_my_workspace
 - config/application.rb
 - config/boot.rb
 - config/commands.rb
-- config/shared_commands.rb
 - config/version.rb
 - lib/origen_updater.rb
-- lib/origen_updater/on_updated.rb
-- lib/origen_updater/update.rb
 - lib/tasks/origen_updater.rake
 - templates/web/index.md.erb
 - templates/web/layouts/_basic.html.erb

data/config/shared_commands.rb

@@ -1,18 +0,0 @@
-# The requested command is passed in here as @command
-case @command
-
-when "update"
-  require "#{Origen.root!}/lib/origen_updater/update"
-  # Important to exit when a command has been fulfilled or else Origen core will try and execute it
-  exit 0
-
-# Always leave an else clause to allow control to fall back through to the Origen command handler.
-# You probably want to also add the command details to the help shown via 'origen -h',
-# you can do this bb adding the required text to @plugin_commands before handing control back to
-# Origen.
-else
-  @plugin_commands << <<-EOT
- update        Update your app environment based on your Gemfile
-  EOT
-
-end

data/lib/origen_updater/on_updated.rb

@@ -1 +0,0 @@
-puts 'Updated!!'

data/lib/origen_updater/update.rb

@@ -1,62 +0,0 @@
-require 'fileutils'
-# require 'byebug' # Un-comment to debug this file
-
-if Origen.site_config.gem_manage_bundler && Origen.site_config.gem_use_from_system
-  Origen.site_config.gem_use_from_system.each do |gem, version|
-    begin
-      spec = Gem::Specification.find_by_name(gem, version)
-      begin
-        (spec.executables || []).each do |bin|
-          unless File.exist?("#{local_gem_dir}/bin/#{bin}")
-            FileUtils.cp("#{spec.bin_dir}/#{bin}", "#{local_gem_dir}/bin")
-          end
-        end
-        p = Pathname.new(spec.cache_file)
-        unless File.exist?("#{local_gem_dir}/cache/#{p.basename}")
-          FileUtils.cp(spec.cache_file, "#{local_gem_dir}/cache")
-        end
-        if spec.extension_dir && File.exist?(spec.extension_dir)
-          spec.extension_dir =~ /.*extensions(.*)/
-          sub_dir = Pathname.new(Regexp.last_match(1)).dirname.to_s
-          local_ext_dir = "#{local_gem_dir}/extensions/#{sub_dir}"
-          FileUtils.mkdir_p(local_ext_dir) unless File.exist?(local_ext_dir)
-
-          # If the file exists in the extensions directory, skip copying it over.
-          p = Pathname.new(spec.extension_dir)
-          unless File.exist?("#{local_ext_dir}/#{p.basename}")
-            FileUtils.cp_r(spec.extension_dir, local_ext_dir)
-          end
-        end
-
-        # If the file exists in the gem directory, skip copying it over.
-        p = Pathname.new(spec.gem_dir)
-        unless File.exist?("#{local_gem_dir}/gems/#{p.basename}")
-          FileUtils.cp_r(spec.gem_dir, "#{local_gem_dir}/gems")
-        end
-        # If the file exists in the specifications directory, skip copying it over.
-        p = Pathname.new(spec.spec_file)
-        unless File.exist?("#{local_gem_dir}/specifications/#{p.basename}")
-          FileUtils.cp(spec.spec_file, "#{local_gem_dir}/specifications")
-        end
-      rescue
-        puts "Had problems installing #{spec.name} from your system Ruby, proceeding with fingers crossed..."
-      end
-
-    rescue Gem::LoadError
-      # This just means that one of the gems that should be copied from the system
-      # was not actually installed in the system, so nothing we can do about that here
-    end
-  end
-end
-
-if ENV['BUNDLE_BIN']
-  FileUtils.rm_rf(ENV['BUNDLE_BIN'])
-
-  if ARGV.first == 'all'
-    system 'bundle update'
-  elsif ARGV.empty?
-    system 'bundle'
-  else
-    system "bundle update #{ARGV.join(' ')}"
-  end
-end