origen_perforce 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88e1419efbe4cacd0a3f57664b89ea5b6f6bfaad
+  data.tar.gz: 13ac925f81a90a357bda9d853375b0854fdc3e79
+SHA512:
+  metadata.gz: 1b170cb7e3e7bc4592c5274785cba3529d2444b45273c770d3d057f552747d632253aad3eab2aaa75f850992eb4bc5ee54bfc4632c11ff990fe07b9b72d020e9
+  data.tar.gz: 193c27fb083d148178149385d87b0d643476880b9803f5c0ebdbb0bd7f4081f1e96f44f015e92b62f9965d9c913705d836a1813c19f7bcdd38330555657a7b31

data/bin/fix_my_workspace

@@ -0,0 +1,100 @@
+#!/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.7.0'
+else
+  if File.exist?(File.expand_path('../../lib/origen.rb', __FILE__))
+    # If this script is being run from within an origen-core workspace, use that Origen-core,
+    # not the system-installed origen-core version.
+    $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+    require 'origen'
+  else
+    # Use system-installed Origen (the gem in system Ruby)
+    require 'origen'
+  end
+
+  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
+
+    if File.exist?(ENV['BUNDLE_BIN'])
+      `chmod o-w #{ENV['BUNDLE_BIN']}`
+
+      # Make .bat versions of all executables, Bundler should really be doing this when running
+      # on windows
+      if Origen.os.windows?
+        Dir.glob("#{ENV['BUNDLE_BIN']}/*").each do |bin|
+          unless bin =~ /.bat$/
+            bat = "#{bin}.bat"
+            unless File.exist?(bat)
+              File.open(bat, 'w') { |f| f.write('@"ruby.exe" "%~dpn0" %*') }
+            end
+          end
+        end
+      end
+    end
+
+    system 'origen -v' if fixed
+  end
+end

data/config/application.rb

@@ -0,0 +1,103 @@
+require 'origen'
+class OrigenPerforceApplication < 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_perforce"
+  self.namespace  = "OrigenPerforce"
+  config.name     = "origen_perforce"
+  config.initials = "OrigenPerforce"
+  # Change this to point to the revision control repository for this plugin
+  config.rc_url   = "git@github.com:Origen-SDK/origen_perforce.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_perforce"
+  #config.web_domain = "http://origen-sdk.org/origen_perforce"
+
+  # 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
+
+  # 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,
+    # Auto correct violations where possible whenever 'origen lint' is run
+    auto_correct: true, 
+    # Limit the testing for large legacy applications
+    #level: :easy,
+    # Run on these directories/files by default
+    #files: ["lib", "config/application.rb"],
+  }
+
+  config.semantically_version = true
+
+  # An example of how to set application specific LSF parameters
+  #config.lsf.project = "msg.te"
+  
+  # An example of how to specify a prefix to add to all generated patterns
+  #config.pattern_prefix = "nvm"
+
+  # An example of how to add header comments to all generated patterns
+  #config.pattern_header do
+  #  cc "This is a pattern created by the example origen application"
+  #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
+  #  "#{Origen.root}/output/#{$dut.class}"
+  #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
+  #  "#{Origen.root}/.ref/#{$dut.class}"
+  #end
+ 
+  # This will automatically deploy your documentation after every tag
+  #def after_release_email(tag, note, type, selector, options)
+  #  command = "origen web compile --remote --api"
+  #  Dir.chdir Origen.root do
+  #    system command
+  #  end
+  #end
+
+  # Ensure that all tests pass before allowing a release to continue
+  #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
+
+  # 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)
+  #  PatternDispatcher.new.dispatch_or_return(requested_pattern)
+  #end
+
+  # If you use pattern iterators you may come across the case where you request a pattern
+  # like this:
+  #   origen g example_pat_b0.atp
+  #
+  # 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 
+  # want. In this example any instances of _b\d, where \d means a number, are replaced by
+  # _bx.
+  #config.pattern_name_translator do |name|
+  #  name.gsub(/_b\d/, "_bx")
+  #end
+
+end

data/config/boot.rb

@@ -0,0 +1,24 @@
+# This file is used to boot your plugin when it is running in standalone mode
+# from its own workspace - i.e. when the plugin is being developed.
+#
+# It will not be loaded when the plugin is imported by a 3rd party app - in that
+# case only lib/origen_perforce.rb is loaded.
+#
+# Therefore this file can be used to load anything extra that you need to boot
+# the development environment for this app. For example, this is typically used
+# to load some additional test classes to use your plugin APIs so that they can
+# be tested and/or interacted with in the console.
+require "origen_perforce"
+
+module OrigenPerforceDev
+  # Example of how to explicitly require a file
+  # require "origen_perforce_dev/my_file"
+    
+  # Load all files in the lib/origen_perforce_dev directory.
+  # Note that there is no problem from requiring a file twice (Ruby will ignore
+  # the second require), so if you have a file that must be required first, then
+  # explicitly require it up above and then let this take care of the rest.
+  Dir.glob("#{File.dirname(__FILE__)}/../lib/origen_perforce_dev/**/*.rb").sort.each do |file|
+    require file
+  end
+end

data/config/commands.rb

@@ -0,0 +1,79 @@
+# This file should be used to extend the origen with application specific commands
+
+# Map any command aliases here, for example to allow 'origen ex' to refer to a 
+# command called execute you would add a reference as shown below: 
+aliases ={
+#  "ex" => "execute",
+}
+
+# The requested command is passed in here as @command, this checks it against
+# the above alias table and should not be removed.
+@command = aliases[@command] || @command
+
+# Now branch to the specific task code
+case @command
+
+# (Working) example of how to create an application specific comment, here to generate
+# a tags file for you application to enable method definition lookup and similar within
+# editors/IDEs
+when "tags"  
+  # Here the logic is just written in-line, alternatively it could be written in a
+  # dedicated file and required here, e.g.
+  #require "origen_perforce/commands/my_command"    # Would load file lib/origen_perforce/commands/my_command.rb
+  Dir.chdir Origen.root do
+    system("ripper-tags -R")
+  end
+  # You must always exit upon successfully capturing and executing a command to prevent 
+  # control flowing back to Origen
+  exit 0
+
+## Example of how to make a command to run unit tests, this simply invokes RSpec on
+## the spec directory
+#when "specs"
+#  require "rspec"
+#  exit RSpec::Core::Runner.run(['spec'])
+
+## Example of how to make a command to run diff-based tests
+#when "examples", "test"
+#  Origen.load_application
+#  status = 0
+#
+#  # Compiler tests
+#  ARGV = %w(templates/example.txt.erb -t debug -r approved)
+#  load "origen/commands/compile.rb"
+#  # Pattern generator tests
+#  #ARGV = %w(some_pattern -t debug -r approved)
+#  #load "#{Origen.top}/lib/origen/commands/generate.rb"
+#
+#  if Origen.app.stats.changed_files == 0 &&
+#     Origen.app.stats.new_files == 0 &&
+#     Origen.app.stats.changed_patterns == 0 &&
+#     Origen.app.stats.new_patterns == 0
+#
+#    Origen.app.stats.report_pass
+#  else
+#    Origen.app.stats.report_fail
+#    status = 1
+#  end
+#  puts
+#  if @command == "test"
+#    Origen.app.unload_target!
+#    require "rspec"
+#    result = RSpec::Core::Runner.run(['spec'])
+#    status = status == 1 ? 1 : result
+#  end
+#  exit status  # Exit with a 1 on the event of a failure per std unix result codes
+
+# Always leave an else clause to allow control to fall back through to the
+# Origen command handler.
+else
+  # You probably want to also add the your commands to the help shown via
+  # origen -h, you can do this by assigning the required text to @application_commands
+  # before handing control back to Origen.
+  @application_commands = <<-EOT
+ tags         Build a tags file for this app
+  EOT
+# specs        Run the specs (tests), -c will enable coverage
+# examples     Run the examples (tests), -c will enable coverage
+# test         Run both specs and examples, -c will enable coverage
+end 

data/config/version.rb

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

data/lib/origen_perforce.rb

@@ -0,0 +1,5 @@
+require 'origen'
+require_relative '../config/application.rb'
+module OrigenPerforce
+  require 'origen_perforce/origen_ext/revision_control/perforce'
+end

data/lib/origen_perforce/origen_ext/revision_control/perforce.rb

@@ -0,0 +1,109 @@
+require 'P4'
+module Origen
+  module RevisionControl
+    class Perforce < Base
+      # P4 session
+      attr_reader :p4
+
+      # e.g. myfile.txt
+      attr_accessor :remote_file
+
+      def _initialize_(options)
+        @remotes_method = :print
+        @p4 = P4.new
+        @p4.maxresults = 1
+        parse_remote
+        @p4.connect
+        unless @p4.connected?
+          Origen.log.error("Could not connect to port #{@p4.port} on client #{@p4.client}!")
+          fail
+        end
+        @p4.run_login
+      end
+
+      # Downloads a file to a local directory, no workspace/client is created.  Perfect
+      # for read-only access like an application remote
+      def print(options = {})
+        options = {
+          verbose: true,
+          version: 'Latest'
+        }.merge(options)
+        cmd = [__method__.to_s, '-o', "#{@local}/#{@remote_file.to_s.split('/')[-1]}", @remote_file.to_s]
+        run cmd
+      end
+
+      def checkout(path = nil, options = {})
+        not_yet_supported(__method__)
+      end
+
+      def root
+        not_yet_supported(__method__)
+      end
+
+      def current_branch
+        not_yet_supported(__method__)
+      end
+
+      def diff_cmd
+        not_yet_supported(__method__)
+      end
+
+      def unmanaged
+        not_yet_supported(__method__)
+      end
+
+      def local_modifications
+        not_yet_supported(__method__)
+      end
+
+      def changes
+        not_yet_supported(__method__)
+      end
+
+      def checkin
+        not_yet_supported(__method__)
+      end
+
+      def build
+        not_yet_supported(__method__)
+      end
+
+      private
+
+      # Needs to be in the form of an Array with command, as a Sting, as the first argument
+      # e.g. ["print", "-o", "pins/myfile.txt", "//depot/myprod/main/doc/pinout/myfile.txt"]
+      def run(cmd)
+        p4.run cmd
+      end
+
+      def not_yet_supported(m)
+        Origen.log.warn("The method #{m} is not currently supported by the Perforce API")
+        nil
+      end
+
+      def parse_remote
+        (@p4.port, @remote_file) = @remote.to_s.match(/^p4\:\/\/(\S+\:\d+)(.*)/).captures unless @remote.nil?
+      end
+
+      def configure_client(options)
+        unless options.include? :local
+          Origen.log.error('Need options[:local] to know how to configure the Perforce client!')
+          fail
+        end
+        client_name = "#{Origen.app.name}_#{User.current.id}_#{Time.now.to_i}"
+        begin
+          client_spec = @p4.fetch_client
+          client_spec['Root'] = options[:local].to_s
+          client_spec['Client'] = client_name
+          client_spec['View'] = ["#{@remote_file} //#{client_name}/#{@remote_file.split('/')[-1]}"]
+          client_spec['Host'] = nil
+          @p4.save_client(client_spec)
+          @p4.client = client_name
+        rescue P4Exception
+          @p4.errors.each { |e| Origen.log.error e }
+          raise
+        end
+      end
+    end
+  end
+end

data/lib/tasks/origen_perforce.rake

@@ -0,0 +1,6 @@
+# You can define any Rake tasks to support your application here (or in any file
+# ending in .rake in this directory).
+#
+# Rake (Ruby Make) is very useful for creating build scripts, see this short video
+# for a quick introduction:
+# http://railscasts.com/episodes/66-custom-rake-tasks

data/templates/web/index.md.erb

@@ -0,0 +1,37 @@
+% render "layouts/basic.html" do
+
+%# HTML tags can be embedded in mark down files if you want to do specific custom
+%# formatting like this, but in most cases that is not required.
+<h1><%= Origen.app.namespace %> <span style="font-size: 14px">(<%= Origen.app.version %>)</span></h1>
+
+### Purpose
+
+This plugin...
+
+### How To Install
+
+In your Gemfile add:
+
+~~~ruby
+gem "<%= Origen.app.name %>"
+~~~
+
+or if your application is a plugin, then add this to your <code>.gemspec</code>
+
+~~~ruby
+spec.add_runtime_dependency "<%= Origen.app.name %>", ">= <%= Origen.app.version %>"
+~~~
+
+__NOTE:__  In the case of a plugin, you will also need to <code>require '<%= Origen.app.name %>'</code> somewhere in your environment.
+
+
+### How To Use
+
+Add quickstart documentation here...
+
+
+### How To Setup a Development Environment
+
+Describe how a developer would setup a new workspace for this plugin...
+
+% end

data/templates/web/layouts/_basic.html.erb

@@ -0,0 +1,13 @@
+---
+title: <%= options[:title] || Origen.config.name %>
+---
+<%= render "partials/navbar.html", tab: options[:tab] %>
+
+<div class="row">
+%# The markdown attribute is important if you are going to include content written
+%# in markdown, without this is will be included verbatim
+  <div class="span12" markdown="1">
+<%= yield %>    
+
+</div>
+</div>

data/templates/web/partials/_navbar.html.erb

@@ -0,0 +1,20 @@
+<nav class="navbar navbar-inverse navbar-fixed-top">
+  <div class="container">
+    <div class="navbar-header">
+      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
+        <span class="sr-only">Toggle navigation</span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      <a class="navbar-brand" href="<%= path "/" %>">Home</a>
+    </div>
+    <div id="navbar" class="collapse navbar-collapse">
+      <ul class="nav navbar-nav">
+        <li class="<%= options[:tab] == :api ? 'active' : '' %>"><a href="<%= path "/api/" %>">API</a></li>
+        <li class="<%= options[:tab] == :release ? 'active' : '' %>"><a href="<%= path "/release_notes" %>">Release Notes</a></li>
+      </ul>
+      <%= import "origen/web/logo.html" %>
+    </div><!--/.nav-collapse -->
+  </div>
+</nav>

data/templates/web/release_notes.md.erb

@@ -0,0 +1,5 @@
+% render "layouts/basic.html", tab: :release do
+
+<%= render "#{Origen.root}/doc/history" %>
+
+% end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: origen_perforce
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Brian Caquelin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: origen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.32.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.32.0
+- !ruby/object:Gem::Dependency
+  name: p4ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2015.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2015.2.1313860
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2015.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2015.2.1313860
+description: 
+email:
+- brian.caquelin@amd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/fix_my_workspace
+- config/application.rb
+- config/boot.rb
+- config/commands.rb
+- config/version.rb
+- lib/origen_perforce.rb
+- lib/origen_perforce/origen_ext/revision_control/perforce.rb
+- lib/tasks/origen_perforce.rake
+- templates/web/index.md.erb
+- templates/web/layouts/_basic.html.erb
+- templates/web/partials/_navbar.html.erb
+- templates/web/release_notes.md.erb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Origen revision control driver for Perforce
+test_files: []