jironimo 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 291b1b99136e1f84d299601e2f1b2a8dc7315d8f
+  data.tar.gz: 1ec46a9f0b2a1416685eb28272c67c323b966c6e
+SHA512:
+  metadata.gz: fcfdbc2124b28e8d8e046555d98c3481071cda53dcd2290983f257bd43a9596c56f456bffae7981033616e7537dea4aeaa200237f5529feebfd45fbc23b35cdc
+  data.tar.gz: 19559507d1107c04da9f08ba981ce0cacd459c143ff9ea5adbc60867927fd49663f95b43a7d46d44364eb76018c9aff827744b10845e6535115f75afb6bebf89

data/config/application.rb

@@ -0,0 +1,106 @@
+require 'origen'
+class JironimoApplication < Origen::Application
+
+  # These attributes should never be changed, the duplication here will be resolved in future
+  # by condensing these attributes that do similar things
+  self.name       = "jironimo"
+  self.namespace  = "Jironimo"
+  config.name     = "jironimo"
+  config.initials = "Jironimo"
+  config.rc_url   = "git@github.com:Origen-SDK/jironimo.git"
+  config.release_externally = true
+
+  config.web_directory = "git@github.com:Origen-SDK/Origen-SDK.github.io.git/jironimo"
+  config.web_domain = "http://origen-sdk.org/jironimo"
+
+  # 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.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 --comment 'Release of #{Origen.app.name} #{Origen.app.version}'"
+    Dir.chdir Origen.root do
+      system command
+    end
+  end
+
+  # Ensure that all tests pass before allowing a release to continue
+  def validate_release
+    unless system("origen specs")
+      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
+
+  def before_deploy_site
+    Dir.chdir Origen.root do
+      #system 'origen examples -c'
+      system 'origen specs -c'
+      dir = "#{Origen.root}/web/output/coverage"
+      FileUtils.remove_dir(dir, true) if File.exist?(dir)
+      system "mv #{Origen.root}/coverage #{dir}"
+    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,4 @@
+# This file will be loaded by Origen to boot your application, just leave it as
+# is and modify lib/jira.rb to load the additional resources that your
+# application requires
+require "jironimo"

data/config/commands.rb

@@ -0,0 +1,104 @@
+# This file should be used to extend the origen command line tool with tasks
+# specific to your application.
+# The comments below should help to get started and you can also refer to
+# lib/origen/commands.rb in your Origen core workspace for more examples and
+# inspiration.
+
+# 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
+
+# Some helper methods to enable test coverage, these will eventually be
+# added to Origen Core, but they need to be here for now and should generally
+# not be modified
+def path_to_coverage_report
+  require 'pathname'
+  Pathname.new("#{Origen.root}/coverage/index.html").relative_path_from(Pathname.pwd)
+end
+
+def enable_coverage(name, merge=true)
+  if ARGV.delete("-c") || ARGV.delete("--coverage")
+    require 'simplecov'
+    SimpleCov.start do
+      command_name name
+      add_filter "DO_NOT_HAND_MODIFY"  # Exclude all imports
+
+      at_exit do
+        SimpleCov.result.format!
+        puts ""
+        puts "To view coverage report:"
+        puts "  firefox #{path_to_coverage_report} &"
+        puts ""
+      end
+    end
+    yield
+  else
+    yield
+  end
+end
+
+# Now branch to the specific task code
+case @command
+
+when "tags"
+  Dir.chdir Origen.root do
+    system "ripper-tags --recursive lib"
+  end
+  exit 0
+
+## Example of how to make a command to run unit tests, this simply invokes RSpec on
+## the spec directory
+when "specs"
+  enable_coverage("specs") do
+    ARGV.unshift "spec"
+    require "rspec"
+    require "rspec/autorun"
+  end
+  exit 0 # This will never be hit on a fail, RSpec will automatically exit 1
+
+## Example of how to make a command to run diff-based tests
+#when "examples"
+#  Origen.load_application
+#  status = 0
+#  enable_coverage("examples") do
+#
+#    # 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 ""
+#  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 be assigning the required text to @application_commands
+  # before handing control back to Origen. Un-comment the example below to get started.
+  @application_commands = <<-EOT
+ specs        Run the specs (tests), -c will enable coverage
+ tags         Generate ctags for this app
+  EOT
+# examples     Run the examples (tests), -c will enable coverage
+
+end

data/config/version.rb

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

data/lib/jironimo.rb

@@ -0,0 +1,489 @@
+require 'origen'
+require 'jira-ruby'
+require_relative '../config/application.rb'
+
+module Jironimo
+  # Hash of all projects
+  attr_accessor :projects
+
+  # Current project selected
+  attr_accessor :current_project
+
+  # JIRA client instance
+  attr_accessor :client
+
+  # JIRA site
+  attr_accessor :site
+
+  # All issues types found in the client instance
+  attr_accessor :issue_types
+
+  # Issues for the currently selected project
+  attr_accessor :issues
+
+  IssuesTableRow = Struct.new(:key, :assignee, :status, :summary)
+
+  MAX_ISSUES = 100_000
+
+  # Issue status types that can be passed as an argument
+  # DEPRECATED, this is project specific
+  STATUS_TYPES = ['Open', 'In Progress', 'Resolved', 'All', 'All Open']
+
+  # JQL events
+  EVENT_TYPES = %w(created resolved updated)
+
+  def self.initialize
+    @client ||= nil
+    @site ||= nil
+    @projects ||= {}
+    @issue_types ||= {}
+    @current_project ||= nil
+    @issues ||= {}
+  end
+
+  # JIRA sites
+  def self.site
+    @site
+  end
+
+  # JIRA client
+  def self.client
+    @client
+  end
+
+  def self.current_status_types(options = {})
+    options = {
+      project: @current_project.key
+    }.update(options)
+    if options[:project].nil?
+      Origen.log.error('Cannot find current status types, no project argument passed!')
+      fail
+    else
+      status_types_found = @projects[options[:project]].issues.map { |issue| issue.status.name }.uniq
+    end
+  end
+
+  # Allows filtering of @issue_types
+  def self.issue_types(filter_arg = nil)
+    if filter_arg.nil?
+      return @issue_types
+    else
+      issue_types_found = case filter_arg
+      when Regexp
+        @issue_types.filter(filter_arg)
+      when String
+        if @issue_types.include? filter_arg
+          @issue_types[filter_arg]
+        else
+          Origen.log.warn "Found no JIRA issue types using the argument '#{filter_arg}', refine your search!"
+          return nil
+        end
+      end
+      if issue_types_found.is_a? Hash
+        if issue_types_found.size > 1
+          issue_types_found
+        else
+          Origen.log.warn "Found no JIRA issue types using the argument '#{filter_arg}', refine your search!"
+          return nil
+        end
+      else
+        issue_types_found
+      end
+    end
+  end
+
+  # Allows filtering of @projects
+  def self.projects(filter_arg = nil)
+    if filter_arg.nil?
+      return @projects
+    else
+      projects_found = @projects.filter(filter_arg)
+      if projects_found.size == 1
+        return projects_found.values.first
+      elsif projects_found > 1
+        Origen.log.warn "Found more than one JIRA project using the argument '#{filter_arg}', refine your search from #{projects_found.keys.join(', ')}"
+        return projects_found.values
+      else
+        Origen.log.warn "Found no JIRA issue types using the argument '#{filter_arg}', refine your search from #{projects_found.keys.join(', ')}"
+        return nil
+      end
+    end
+  end
+
+  # Retrieve a project using a numeric ID or String key
+  def self.project(id)
+    # Try the project key first and then the ID
+    if id.is_a? String
+      return projects(id)
+    elsif id.is_a? Integer
+      # Try the ID
+      projects_found = @projects.select { |key, p| p.id.to_numeric == id }
+      if projects_found.size == 1
+        return projects_found.values.first
+      else
+        Origen.log.warn "Found more than one JIRA project using the argument '#{id}', refine your search from #{projects_found.keys.join(', ')}"
+        return projects_found.values
+      end
+    end
+  end
+
+  # Re-fresh the JIRA client and releated module accessors
+  # Useful after adding, deleting, ormodifying anythign on the JIRA server
+  def self.refresh(options = {})
+    query_options = {
+      fields:      [],
+      start_at:    0,
+      max_results: MAX_ISSUES
+    }.update(options)
+    Origen.log.errpr 'Jironimo#refresh needs Jironimo.current_project to be set' if @current_project.nil?
+    Origen.log.error 'Jironimo#refresh needs to have Jironimo.client to be valid' if @client.nil?
+    @projects = create_projects_hash(@client.Project.all)
+    @issue_types = create_issue_types_hash(@client.Issuetype.all)
+    @issues = {}
+    @client.Issue.jql("project = #{@current_project.key}", query_options).each do |issue|
+      @issues[issue.key] = issue
+    end
+  end
+
+  # Set the current project, enables project specific accessors like @issues
+  def self.current_project=(id, options = {})
+    query_options = {
+      fields:      [],
+      start_at:    0,
+      max_results: MAX_ISSUES
+    }.update(options)
+    project_search = project(id)
+    if project_search.is_a? JIRA::Resource::Project
+      @current_project = project_search
+      # Find all of the issues for this project
+      @issues = {} unless @issues.empty?
+      @client.Issue.jql("project = #{id}", query_options).each do |issue|
+        @issues[issue.key] = issue
+      end
+      # This code only returns 50 results max
+      # @current_project.issues.each do |issue|
+      #  @issues[issue.key] = issue
+      # end
+    else
+      @current_project = nil
+    end
+  end
+
+  # Returns the curren project instance
+  def self.current_project
+    @current_project
+  end
+
+  # Returns a hash of JIRA issues assigned to the current user
+  # Defaults to 'Open' or 'In Progress' issue status
+  def self.my_issues(options = {})
+    query_options = {
+      verbose:     false,
+      assignee:    User.current.id,
+      project:     @current_project.key,
+      fields:      [],
+      start_at:    0,
+      max_results: MAX_ISSUES,
+      status:      nil
+    }.update(options)
+    my_issues = {}
+    console_print = query_options.delete(:verbose)
+    Origen.log.error 'User option must be a String, exiting...' unless query_options[:assignee].is_a? String
+    assignee = query_options.delete(:assignee)
+    jql_str = "assignee = #{assignee.upcase}"
+    if query_options[:project].nil?
+      # Cannot search every project for issues, takes too long
+      Origen.log.error('No project passed, cannot fetch your issues!')
+      fail
+    else
+      jql_str += " AND project = #{query_options[:project]}"
+    end
+    # Check which issue status types to retrieve
+    valid_status_types = current_status_types(query_options)
+    begin
+      case query_options[:status]
+      # This can and should be expanded over time
+      when 'All', nil
+        jql_str = jql_str # Don't change naything as status doesn't need to be filtered
+      end
+    ensure
+      query_options.delete(:status)
+    end
+    if @client.nil?
+      Origen.log.error 'No JIRA client instantiated, cannot check for your issues, exiting...'
+    else
+      @client.Issue.jql(jql_str, query_options).each do |issue|
+        my_issues[issue.key] = issue
+      end
+    end
+    show_issues(my_issues) if console_print
+    my_issues
+  end
+
+  # Get the latest issues
+  def self.latest_issues(time, options = {})
+    query_options = {
+      verbose:     false,
+      assignee:    User.current.id,
+      fields:      [],
+      start_at:    0,
+      max_results: MAX_ISSUES,
+      event:       'created'
+    }.update(options)
+    latest_issues = {}
+    console_print = query_options.delete(:verbose)
+    event = query_options.delete(:event)
+    assignee = query_options.delete(:assignee)
+    Origen.log.errpr 'Jironimo.current_project is not set, exiting...' if @current_project.nil?
+    Origen.log.error 'Jironimo.client is not set, exiting...' if @client.nil?
+    Origen.log.error "Event '#{event}' is not supported, choose from #{EVENT_TYPES.join(', ')}, exiting..." unless EVENT_TYPES.include? event
+    Origen.log.error "Could not get latest issues with argument '#{time}', exiting..." unless jql_time_ok?(time)
+    jql = "assignee = #{assignee} AND #{event} <= '#{time}'"
+    @client.Issue.jql(jql).each do |issue|
+      latest_issues[issue.key] = issue
+    end
+    latest_issues
+  end
+  # alias_method self(:latest, :latest_issues
+
+  # Allows filtering of @issues
+  def self.issues(id = nil)
+    if @current_project.nil?
+      return {}
+    elsif @current_project.is_a? JIRA::Resource::Project
+      if id.nil?
+        @issues
+      elsif @issues.include? id
+        @issues[id]
+      else
+        Origen.log.error("Jironimo: Issue '#{id}' is not found in project '#{@current_project.key}'!")
+        exit 0
+      end
+    else
+      Origen.log.error "Jironimo.current_project is of incorrect type '#{@current_project.class}', should be nil or JIRA::Resource::Project, exiting.."
+      exit 0
+    end
+  end
+
+  # Launches the JIRA interface client and initializes
+  # @projects and @issue_types
+  def self.launch(options = {})
+    options = {
+      username:     User.current.id,
+      password:     User.current.password,
+      site:         'http://jira.amd.com',
+      auth_type:    :basic,
+      use_ssl:      false,
+      context_path: ''
+    }.update(options)
+    initialize
+    @client = JIRA::Client.new(options)
+    @site = options[:site]
+    @projects = create_projects_hash(@client.Project.all)
+    @issue_types = create_issue_types_hash(@client.Issuetype.all)
+    @client
+  end
+
+  # Returns a hash of issue types with issue type name as key and
+  # issue type number as value
+  def self.issue_type_mapping
+    issue_type_names = {}
+    @issue_types.each do |type_name, issue_type|
+      issue_type_names[type_name] = issue_type.id
+    end
+    issue_type_names
+  end
+
+  def self.update_issue(issue_key)
+    options = {
+      type:        nil,
+      summary:     nil,
+      description: nil
+    }.merge(options)
+    Origen.log.error "Cannot update issue '#{issue_key}', please set the current project" if @issues.empty?
+    project_attr = 'key'
+    args_result, options = check_issue_args(options)
+    Origen.log.error "Updating JIRA issue '#{issue_key}' failed due to bad arguments, check previous log warnings, exiting..." unless args_result
+    issue = @issues[issue_key]
+    issue.save(assemble_issue_fields(options, project_attr))
+    issue
+  end
+
+  # Create anew JIRA issue for the current project or one passed as an argument
+  def self.new_issue(options = {})
+    options = {
+      project:     nil,
+      type:        nil,
+      summary:     nil,
+      description: nil
+    }.merge(options)
+    project_attr = ''
+    args_result, options = check_issue_args(options)
+    Origen.log.jironimo 'Creating a new JIRA issue failed due to bad arguments, check previous log warnings, exiting...' unless args_result
+    if options[:project].numeric?
+      project_attr = 'id'
+    elsif options[:project].is_a? String
+      project_attr = 'key'
+    else
+      Origen.log.error 'options[:project] must be String (use project key) or Integer (use project ID), exiting...'
+    end
+    issue = @client.Issue.build
+    issue.save(assemble_issue_fields(options, project_attr))
+    if issue.respond_to?(:errors)
+      Origen.log.error('Jironimo: Cannot create Jira issue, here is why:')
+      issue.errors.each do |err|
+        Origen.log.error("Jironimo: #{err}")
+      end
+      exit 0
+    else
+      # Successfully created an issue
+      Origen.log.jironimo "Created issue for #{issue.key}"
+    end
+    issue
+  end
+
+  # Delete a JIRA issue
+  def self.delete_issue(issue_key)
+    Origen.log.error "Could not delete issue '#{issue_key}', exiting..." unless @issues.include? issue_key
+    @issues[issue_key].delete
+  end
+
+  private
+
+  def self.jql_time_ok?(time)
+    result = true
+    time.split(/\s+/).each do |time_arg|
+      if time_arg[/^[-|+]?\d+[d|h|m|w|y]$/].nil?
+        Origen.log.warn "Could not parse jql time argument #{time_arg}"
+        result = false
+      end
+    end
+    result
+  end
+
+  def self.assemble_issue_fields(options, project_attr)
+    Hash.new { |h, k| h[k] = {} }.tap do |issues_hash|
+      options.each do |attr, value|
+        case attr
+        when :summary, :description
+          issues_hash['fields'][attr.to_s] = value unless value.nil?
+        when :project
+          issues_hash['fields'][attr.to_s] = Hash[project_attr.to_s, value] unless value.nil?
+        when :type
+          issues_hash['fields']['issuetype'] = Hash['name', value] unless value.nil?
+        when :assignee
+          issues_hash['fields'][attr.to_s] = Hash['name', value] unless value.nil?
+        when :priority
+          issues_hash['fields'][attr.to_s] = Hash['id', value.to_s] unless value.nil?
+        when :components
+          value = [value] unless value.is_a? Array
+          component_array = []
+          value.each do |component|
+            component_key = ''
+            if component.is_a? String
+              if component.numeric?
+                component_key = 'id'
+              else
+                component_key = 'name'
+              end
+            elsif component.is_a? Integer
+              component_key = 'id'
+            else
+              Origen.log.error "Component option '#{component}' is not the correct type, choose from String or Integer, exiting..."
+            end
+            component_array << Hash[component_key, component.to_s]
+          end
+          issues_hash['fields'][attr.to_s] = component_array
+        else
+          issues_hash['fields'][attr.to_s] = value unless value.nil?
+        end
+      end
+    end
+  end
+
+  def self.check_issue_args(options)
+    result = true
+    if options[:project].nil?
+      if @current_project.nil?
+        Origen.log.warn 'options[:project] must be supplied or a current project be set with Jironimo#current_product='
+        result = false
+      else
+        options[:project] = @current_project.id
+      end
+    elsif options[:project].is_a?(Numeric)
+      # Convert the number to a String as jira requires a String argument
+      options[:project] = options[:project].to_s
+    end
+    string_options = options.reject { |k, v| [:project, :priority, :labels].include? k }
+    string_options.each do |_key, value|
+      unless value.is_a? String
+        Origen.log.warn "JIRA issue creation argument '#{value}' must be a String"
+        result = false
+      end
+    end
+    unless @issue_types.include?(options[:type])
+      Origen.log.warn "JIRA issue type argument '#{options[:type]}' is not valid, choose from:\n#{@issue_types.keys.sort.join("\n")}"
+      result = false
+    end
+    [result, options]
+  end
+
+  def self.show_issues(issues)
+    whitespace_padding, table_issues, column_widths, header, project_header, table = 3, [], {}, '', '', []
+    # Create a hash with key being the issue key and the value being the issue summary
+    issues.each do |key, issue|
+      assignee = ''
+      issue.assignee.nil? ? assignee = '' : assignee = issue.assignee.name
+      table_issues << IssuesTableRow.new(key, assignee, issue.status.name, issue.summary)
+    end
+    %w(Key Assignee Status Summary).each do |column|
+      sym = column.downcase.to_sym
+      if column.length > table_issues.map(&sym).max_by(&:length).length
+        column_widths[column] = column.length + whitespace_padding
+      else
+        column_widths[column] = table_issues.map(&sym).max_by(&:length).length + whitespace_padding
+      end
+    end
+    column_widths.each do |attr_name, column_width|
+      header += "| #{attr_name}".ljust(column_width)
+    end
+    project_header += "| #{@current_project.key}: #{@current_project.name}".ljust(header.length)
+    header += '|'
+    table << '-' * header.length
+    table << project_header += '|'
+    table << '=' * header.length
+    table << header
+    table << '=' * header.length
+    table_issues.each do |issue|
+      row = ''
+      row = "| #{issue.key}".ljust(column_widths['Key']) + "| #{issue.assignee}".ljust(column_widths['Assignee']) + "| #{issue.status}".ljust(column_widths['Status']) + "| #{issue.summary}".ljust(column_widths['Summary']) + '|'
+      table << row
+    end
+    table << '-' * header.length
+    puts table.flatten.join("\n")
+  end
+
+  def self.create_issue_types_hash(arr)
+    issue_types_hash = {}.tap do |new_h|
+      arr.each do |issue_type|
+        new_h[issue_type.name] = issue_type
+      end
+    end
+  end
+
+  def self.create_status_types_hash(arr)
+    status_types_hash = {}.tap do |new_h|
+      arr.each do |status_type|
+        new_h[status_type.name] = status_type
+      end
+    end
+  end
+
+  def self.create_projects_hash(arr)
+    project_hash = {}.tap do |new_h|
+      arr.each do |project|
+        new_h[project.key] = project
+      end
+    end
+  end
+end

data/lib/tasks/isc.rake

@@ -0,0 +1,69 @@
+# 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
+
+namespace :isc do
+  desc 'Remove back-up files recursively from the project'
+  task :clean do
+    backup_files = Dir.glob("#{Origen.root}/**/*~")
+    unless backup_files.empty?
+      puts 'Backup files removed:'
+      puts backup_files.join("\n")
+      File.delete(*backup_files)
+    end
+  end
+
+  desc 'Find unmanaged files'
+  task :find_unman do
+    root_path = Origen.root.to_s.split('/').drop(1)
+    Origen.app.rc.unmanaged.each do |f|
+      next if f =~ /\~/
+      path = f.split('/').drop(1)
+      proj_sub_dir = (path - root_path).first
+      next if proj_sub_dir =~ /^\.|^web$|^lbin$|^log$/
+      puts f
+    end
+  end
+
+  desc 'Find unmanaged files and commit to revision control'
+  task :commit_unman do
+    root_path = Origen.root.to_s.split('/').drop(1)
+    files = []
+    Origen.app.rc.unmanaged.each do |f|
+      next if f =~ /\~/
+      path = f.split('/').drop(1)
+      proj_sub_dir = (path - root_path).first
+      next if proj_sub_dir =~ /^\.|^web$|^lbin$|^log$/
+      files << f
+    end
+    commit_results = {}
+    files.each do |file|
+      commit_results[file] = system("origen rc new #{file}")
+    end
+    commit_results.each do |file, result|
+      puts "File #{file} commit result is #{result}"
+    end
+  end
+
+  desc 'Find modified files'
+  task :find_mods do
+    puts Origen.app.rc.local_modifications.join("\n")
+  end
+
+  desc 'Commit modified files'
+  task :commit_mods, [:comment] do |t, args|
+    args.with_defaults(comment: 'Mass file commit, code re-factor/cleanup or lint most likely cause')
+    results = `origen rc mods`.split("\n").select! { |f| f =~ /dssc diff/ }
+    results.map! { |f| f[/-ver\s+\S+\s+(\S+)/, 1] }
+    commit_results = {}
+    results.each do |file|
+      commit_results[file] = system("dssc ci -keep #{file} -com '#{args[:comment]}'")
+    end
+    commit_results.each do |file, result|
+      puts "File #{file} commit result is #{result}"
+    end
+  end
+end

data/lib/tasks/jironimo.rake

@@ -0,0 +1,68 @@
+# 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
+namespace :jira do
+  desc 'Remove back-up files recursively from the project'
+  task :clean do
+    backup_files = Dir.glob("#{Origen.root}/**/*~")
+    unless backup_files.empty?
+      puts 'Backup files removed:'
+      puts backup_files.join("\n")
+      File.delete(*backup_files)
+    end
+  end
+
+  desc 'Find unmanaged files'
+  task :find_unman do
+    root_path = Origen.root.to_s.split('/').drop(1)
+    Origen.app.rc.unmanaged.each do |f|
+      next if f =~ /\~/
+      path = f.split('/').drop(1)
+      proj_sub_dir = (path - root_path).first
+      next if proj_sub_dir =~ /^\.|^web$|^lbin$|^log$/
+      puts f
+    end
+  end
+
+  desc 'Find unmanaged files and commit to revision control'
+  task :commit_unman do
+    root_path = Origen.root.to_s.split('/').drop(1)
+    files = []
+    Origen.app.rc.unmanaged.each do |f|
+      next if f =~ /\~/
+      path = f.split('/').drop(1)
+      proj_sub_dir = (path - root_path).first
+      next if proj_sub_dir =~ /^\.|^web$|^lbin$|^log$/
+      files << f
+    end
+    commit_results = {}
+    files.each do |file|
+      commit_results[file] = system("origen rc new #{file}")
+    end
+    commit_results.each do |file, result|
+      puts "File #{file} commit result is #{result}"
+    end
+  end
+
+  desc 'Find modified files'
+  task :find_mods do
+    puts Origen.app.rc.local_modifications.join("\n")
+  end
+
+  desc 'Commit modified files'
+  task :commit_mods, [:comment] do |t, args|
+    args.with_defaults(comment: 'Mass file commit, code re-factor/cleanup or lint most likely cause')
+    results = `origen rc mods`.split("\n").select! { |f| f =~ /dssc diff/ }
+    results.map! { |f| f[/-ver\s+\S+\s+(\S+)/, 1] }
+    commit_results = {}
+    results.each do |file|
+      commit_results[file] = system("dssc ci -keep #{file} -com '#{args[:comment]}'")
+    end
+    commit_results.each do |file, result|
+      puts "File #{file} commit result is #{result}"
+    end
+  end
+end

data/templates/web/index.md.erb

@@ -0,0 +1,95 @@
+% 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 provides interaction with the [JIRA issue tracking system](https://jira.atlassian.com/).
+It provides some helpful high level methods while using the ruby-jira gem to do the heavy lifting.
+If there isn't a canned method to do what you want do not despair, just go [here](https://github.com/sumoheavy/jira-ruby) and read up.
+
+### How To Import
+
+##### To use in an application:
+
+Add the following to your application's <code>Gemfile</code>:
+
+~~~ruby
+gem '<%= Origen.app.name %>', '<%= Origen.app.version %>'
+~~~
+
+##### To use in a plugin:
+
+Add the following to your plugin's gemspec:
+
+~~~ruby
+spec.add_runtime_dependency '<%= Origen.app.name %>', '~> <%= Origen.app.version.major %>', '>= <%= Origen.app.version %>'
+~~~
+
+and require the gem in your code:
+
+~~~ruby
+require '<%= Origen.app.name %>'
+~~~
+
+
+### How To Use
+
+Give some quick start description here on how to use your plugin, providing
+links to the API documents where necessary for further details.
+
+Here is an example integration:
+
+~~~ruby
+module MyJira
+  require 'jironimo'
+
+  my_jironimo_client = Jironimo.launch
+
+  # Set the current Jironimo project to 'ISC'
+  Jironimo.current_project = 'ISC'
+
+  unless Jironimo.issues['ISC-463'].assignee.nil?
+    Origen.log.info "Give him another issue!"
+    Origen.log.info "His email is #{Jironimo.issues['ISC-463'].assignee.emailAddress}"
+  end
+
+  # Print out current users issues to console
+  Jironimo.my_issues(verbose: true)
+
+  # Create a new ticket
+  project_issue_count = Jironimo.issues.size
+  new_issue = Jironimo.new_issue(type: 'Bug', summary: 'my summary', description: 'my description', priority: 1, assignee: 'B07507')
+
+  # Re-fresh the JIRA client database
+  Jironimo.refresh
+
+  new_project_issue_count = Jironimo.issues.size
+
+  # Make sure the database has one more ticket fo the current project
+  unless new_project_issue_count.should == (project_issue_count + 1)
+    Origen.log.error "Could not create new issue for project '#{@current_project.key}:#{@current_project.name}'"
+  end
+
+  # Delete the issue if needed
+  delete_issue(new_issue.key) # Method 1, useful when the user doesn't have an object instance
+  new_issue.delete            # Method 2, suited for when the user does have an object instance
+
+~~~
+
+### How To Setup a Development Environment
+
+~~~text
+mkdir <%= Origen.app.name %>
+cd <%= Origen.app.name %>
+dssc setvault <%= Origen.app.config.vault %> .
+dssc pop -rec -get .
+~~~
+
+Follow the instructions here if you want to make a 3rd party app
+workspace use your development copy of the <%= Origen.app.name %> plugin:
+[Setting up a Plugin Development Environment](http://origen-sdk.org/origen/guides/plugins/environment/)
+
+% end

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

@@ -0,0 +1,15 @@
+---
+title: <%= options[:title] || Origen.config.name %>
+---
+<%= render "templates/web/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 %>    
+
+<%= disqus_comments %>
+
+</div>
+</div>

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

@@ -0,0 +1,21 @@
+<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>
+        <li><a href="https://github.com/Origen-SDK/jironimo">Github</a></li>
+      </ul>
+      <%= import "origen/web/logo.html" %>
+    </div><!--/.nav-collapse -->
+  </div>
+</nav>

data/templates/web/release_notes.md.erb

@@ -0,0 +1,21 @@
+% render "layouts/basic.html", tab: :release do
+
+<%= render "#{Origen.root}/doc/history" %>
+
+### 0.5.0
+* [OSDK-505](http://jira.amd.com/browse/OSDK-505): Add issue creation error checks to jironimo gem
+
+### 0.4.0
+* [OSDK-491](http://jira.amd.com/browse/OSDK-491): Remove previous company-centric issue filters that prevented use across AMD Jira projects
+
+### 0.3.0
+* [OSDK-438](http://jira.amd.com/browse/OSDK-438): Wrap project issues in method vs direct access to the Hash
+* Moved to latest Github version of origen
+
+### 0.2.0
+* unit level spec tests working within AMD, using the OSDK and ATEOBR projects
+
+### 0.1.0
+* Initial release, not yet validated
+
+% end

data/templates/web/release_notes.md.erb~

@@ -0,0 +1,21 @@
+% render "layouts/basic.html", tab: :release do
+
+<%= render "#{Origen.root}/doc/history" %>
+
+### 0.5.0
+* [OSDK-505](http://jira.amd.com/browse/OSDK-505): Add issue creation error checks to jironimo gem
+
+### 0.4.0
+* [OSDK-491](http://jira.amd.com/browse/OSDK-491): Remove previous company-centric issue filters that prevented use across AMD Jira projects
+
+### 0.3.0
+* [OSDK-438](http://jira.amd.com/browse/OSDK-438): Wrap project issues in method vs direct access to the Hash
+* Moved to latest Github version of origen
+
+### 0.2.0
+* unit level spec tests working within AMD, using the OSDK and ATEOBR projects
+
+### 0.1.0
+* Initial release, not yet validated
+
+% end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: jironimo
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Brian Caquelin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: origen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.53.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.53.0
+- !ruby/object:Gem::Dependency
+  name: jira-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+description: 
+email:
+- b07507@freescale.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/application.rb
+- config/boot.rb
+- config/commands.rb
+- config/version.rb
+- lib/jironimo.rb
+- lib/tasks/isc.rake
+- lib/tasks/jironimo.rake
+- templates/web/index.md.erb
+- templates/web/layouts/_basic.html.erb
+- templates/web/partials/_navbar.html.erb
+- templates/web/release_notes.md.erb
+- templates/web/release_notes.md.erb~
+homepage: http://origen-sdk.org/jironimo
+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.12
+signing_key: 
+specification_version: 4
+summary: Top level wrapper for the gem jira-ruby that interacts with the JIRA issue
+  tracking system
+test_files: []