abide_dev_utils 0.2.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9e993f8a435b4be58831bc98cf1658533c8c1084f14c96c1a12ecd73ff89da6
-  data.tar.gz: 1120b6cc91eac28ff8168e808f13c16cf6c6d844b5928f04f4f4bb6d7cda0bcb
+  metadata.gz: ecd985f39afeac37bf8f2305dc65c782f34722f95a655249d7219b975952012f
+  data.tar.gz: 9123b33054f39149ba2deb34464b56bcac404438ac161f64a02e93fc1d33b340
 SHA512:
-  metadata.gz: bcf0b6aa95f003e5402be98cc797202949368ceff62e6cdb778f4002e452716ef5ef833bc0bcd34bb797f628997e1c807d88f191048a5afec767bd8bcb7dc7a3
-  data.tar.gz: 2ca0b4fb33d0329f13e3ce04d317427b4ba67c9937b4df739d991a1692871d19c17d1eeb24d5035573a676560795ae466e6df65148693258718aeda115c9e1d8
+  metadata.gz: 595556633f91088d8b34ac1d17d5f012c9d84ca7c03d45ef31bd59ccc45278b008f967b5e096909fa625c8eac7911163584ac7d0d4cc46caa1bd062b14eb1f7c
+  data.tar.gz: 0dc612075817afeae37820a7c2d097a29af5ed3ee491b7ab2c61743e209b0345e5fd5fff6f5aab53b3d85b9f0e5b9c07cf16cefff5092ec981c679523fd141e2

data/.dockerignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Dockerfile

@@ -0,0 +1,23 @@
+FROM ruby:2.7.3-alpine
+
+ARG version
+
+RUN mkdir /extvol && \
+    apk update && \
+    apk add git build-base
+
+VOLUME /extvol
+
+WORKDIR /usr/src/app
+
+RUN mkdir -p ./lib/abide_dev_utils/
+COPY Gemfile abide_dev_utils.gemspec ./
+COPY lib/abide_dev_utils/version.rb lib/abide_dev_utils
+RUN bundle install
+
+COPY . .
+
+RUN bundle exec rake build && \
+    gem install pkg/abide_dev_utils-${version}.gem
+
+ENTRYPOINT [ "abide" ]

data/README.md

@@ -2,6 +2,8 @@
 
 Helper library and CLI app for Abide development.
 
+Issues and pull requests are welcome!
+
 ## Features
 
 ### CLI
@@ -125,7 +127,9 @@ Install the gem:
   * `--root-dir`, `-r` - Path to the root directory of your module. Defaults to the current working directory
   * `--absolute-template-dir`, `-A` - Allows you to specify an absolute path with `--template-dir`. This is useful if your template directory is not relative to your module's root directory
   * `--template-name`, `-n` - Allows you to specify a template name if it is different than the `TYPE` parameter
-  * `--vars`, `-v` - Comma-separated key=value pairs to pass in to the template renderer. This allows you to pass arbitrary values that can be used in your templates.
+  * `--vars`, `-V` - Comma-separated key=value pairs to pass in to the template renderer. This allows you to pass arbitrary values that can be used in your templates.
+  * `--spec-template`, `-S` - Path to an ERB template to use for rspec test generation instead of the default
+  * `--force`, `-f` - Skips any prompts and executes the command
 
 `abide puppet new` exposes a few variables for you to use in your templates by default:
 
@@ -177,8 +181,10 @@ $ ls manifests
 init.pp
 $ abide puppet new control_class 'test_module::controls::test_new_control'
 Created file /Users/the.dude/test_module/manifests/controls/test_new_control.pp
+Created file /Users/the.dude/test_module/spec/classes/controls/test_new_control_spec.rb
 $ abide puppet new util_class 'test_module::utils::test_new_util' -v 'testvar1=dude,testvar2=sweet'
 Created file /Users/the.dude/test_module/manifests/utils/test_new_util.pp
+Created file /Users/the.dude/test_module/spec/classes/utils/test_new_util_spec.rb
 $ cat manifests/controls/test_new_control.pp
 # @api private
 class test_module::controls::test_new_control (
@@ -202,10 +208,22 @@ class test_module::utils::test_new_util (
 
 ```
 
+**NOTE**: You can use two special prefixes on your template files to denote where the rspec test should be generated for that object.
+If the prefix `c-` is used, the test will be generated in the `spec/classes` directory. If the prefix `d-` is used, the test will be generated in the `spec/defines` directory. For example, to create a template for a defined type, name the template something like this: `d-my_defined_type.pp.erb`.
+
 ### XCCDF Command Reference
 
 #### to_hiera
 
+NOTE: When converting XCCDF files to Hiera, control names are sanitized. This means that some characters will be changed to ensure the resulting control names in the Hiera file are valid for both YAML and Puppet class names. Here's what gets changed:
+
+* All letters are coverted to lower case
+* The first and last characters of the control name is dropped if they are not letters (a-z)
+* If a control name has a prefix of `l1_`, `l2_`, or `ng_`, that prefix is dropped
+  * Differentiation between profile level occurs outside of control names
+* The characters `/` and `\` are deleted. This means that paths are smashed together
+* Whitespace and the characters `(`, `)`, `.`, and `-` are substituted with underscores (`_`)
+
 * Required positional parameters:
   * `XCCDF_FILE` - Path to an XCCDF XML file
 * Options:
@@ -213,6 +231,15 @@ class test_module::utils::test_new_util (
   * `--out-file`, `-o` - A path to a file where you would like to save the generated Hiera
   * `--parent-key-prefix`, `-p` - Allows you to append a prefix to all top-level Hiera keys
 
+## Docker
+
+A Dockerfile has been provided in this repo for convenience since Ruby environments can be painful to deal with. To abide_dev_utils with Docker:
+
+* Build the Dockerfile: `docker build . -t abide_dev_utils --build-arg version=<semver>`
+* Run the commands using the container: `docker run -it abide_dev_utils --help`
+* The container declares a volume for external resources such as files. To use the volume, add the following flag to your `docker run` commands: `-v /path/to/my/files:/extvol`
+  * When using the volume, all paths should be absolute based on the root directory `/extvol`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/abide_dev_utils.gemspec

@@ -41,6 +41,7 @@ Gem::Specification.new do |spec|
   # Dev dependencies
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'console'
   spec.add_development_dependency 'github_changelog_generator'
   spec.add_development_dependency 'gem-release'
   spec.add_development_dependency 'rspec', '~> 3.10'

data/lib/abide_dev_utils/cli.rb

@@ -20,6 +20,7 @@ module Abide
       parser.main_options.version = AbideDevUtils::VERSION
       parser.main_options.banner = ROOT_CMD_BANNER
       parser.add_command(CmdParse::HelpCommand.new, default: true)
+      parser.add_command(CmdParse::VersionCommand.new(add_switches: true))
       parser.add_command(PuppetCommand.new)
       parser.add_command(XccdfCommand.new)
       parser.add_command(TestCommand.new)

data/lib/abide_dev_utils/cli/puppet.rb

@@ -87,6 +87,16 @@ module Abide
           '--vars [VARNAME=VALUE]',
           'Allows you to specify comma-separated variable names and values that will be converted into a hash that is available for you to use in your templates'
         ) { |v| @data[:vars] = v }
+        options.on(
+          '-S [PATH]',
+          '--spec-template [PATH]',
+          'Path to an ERB template to use for rspec test generation instead of the default'
+        )
+        options.on(
+          '-f',
+          '--force',
+          'Skips any prompts and executes the command'
+        ) { |_| @data[:force] = true }
       end
 
       def execute(type, name)
@@ -97,8 +107,7 @@ module Abide
           opts: @data,
           vars: @data.fetch(:vars, '').split(',').map { |i| i.split('=') }.to_h # makes the str a hash
         )
-        result = builder.build
-        Abide::CLI::OUTPUT.simple(result)
+        builder.build
       end
     end
   end

data/lib/abide_dev_utils/cli/test.rb

@@ -35,10 +35,10 @@ module Abide
         @litmus_im = [CMD_LIT_BASE, "'litmus:install_module'"]
         @litmus_ap = [CMD_LIT_BASE, "'litmus:acceptance:parallel'"]
         @litmus_td = [CMD_LIT_BASE, "'litmus:tear_down'"]
-        validate_env_and_opts
       end
 
       def execute(suite)
+        validate_env_and_opts
         case suite.downcase
         when /^a[A-Za-z]*/
           run_command(@validate)

data/lib/abide_dev_utils/cli/xccdf.rb

@@ -27,7 +27,12 @@ module Abide
         long_desc(CMD_LONG)
         options.on('-b [TYPE]', '--benchmark-type [TYPE]', 'XCCDF Benchmark type') { |b| @data[:type] = b }
         options.on('-o [FILE]', '--out-file [FILE]', 'Path to save file') { |f| @data[:file] = f }
-        options.on('-p [PREFIX]', '--parent-key-prefix [PREFIX]', 'A prefix to append to the parent key') { |p| @data[:parent_key_prefix] = p }
+        options.on('-p [PREFIX]', '--parent-key-prefix [PREFIX]', 'A prefix to append to the parent key') do |p|
+          @data[:parent_key_prefix] = p
+        end
+        options.on('-N', '--number-fmt', 'Format Hiera control names based off of control number instead of name.') do
+          @data[:num] = true
+        end
       end
 
       def execute(xccdf_file)
@@ -40,8 +45,7 @@ module Abide
 
       def to_hiera(xccdf_file)
         xfile = AbideDevUtils::XCCDF.to_hiera(xccdf_file, @data)
-        console = @data[:file].nil? ? true : false
-        Abide::CLI::OUTPUT.yaml(xfile, console: console, file: @data[:file])
+        Abide::CLI::OUTPUT.yaml(xfile, console: @data[:file].nil?, file: @data[:file])
       end
     end
   end

data/lib/abide_dev_utils/errors/xccdf.rb

@@ -8,5 +8,9 @@ module AbideDevUtils
     class XPathSearchError < GenericError
       @default = 'XPath seach failed to find anything at:'
     end
+
+    class StrategyInvalidError < GenericError
+      @default = 'Invalid strategy selected. Should be either \'name\' or \'num\''
+    end
   end
 end

data/lib/abide_dev_utils/ppt.rb

@@ -9,7 +9,7 @@ module AbideDevUtils
     # the full namespace for all classes in that directory.
     # @param puppet_class_dir [String] path to a dir containing Puppet manifests
     # @return [String] The namespace for all classes in manifests in the dir
-    def find_class_namespace(puppet_class_dir)
+    def self.find_class_namespace(puppet_class_dir)
       path = Pathname.new(puppet_class_dir)
       mod_root = nil
       ns_parts = []
@@ -34,7 +34,7 @@ module AbideDevUtils
     # metadata.json, if it exists, or by using the parent directory name.
     # @param pathname [Pathname] A Pathname object of the module's manifests dir
     # @return [String] The module's namespace root
-    def find_mod_root(pathname)
+    def self.find_mod_root(pathname)
       metadata_file = nil
       pathname.entries.each do |e|
         metadata_file = "#{pathname}/metadata.json" if File.basename(e) == 'metadata.json'
@@ -52,7 +52,7 @@ module AbideDevUtils
 
     # @return [Array] An array of frozen arrays where each sub-array's
     #   index 0 is class_name and index 1 is the full path to the file.
-    def find_all_classes_and_paths(puppet_class_dir)
+    def self.find_all_classes_and_paths(puppet_class_dir)
       all_cap = []
       Dir.each_child(puppet_class_dir) do |c|
         path = "#{puppet_class_dir}/#{c}"

data/lib/abide_dev_utils/ppt/coverage.rb

@@ -13,12 +13,14 @@ module AbideDevUtils
       def self.generate(puppet_class_dir, hiera_path, profile = nil)
         coverage = {}
         coverage['classes'] = {}
-        all_cap = find_all_classes_and_paths(puppet_class_dir)
+        all_cap = AbideDevUtils::Ppt.find_all_classes_and_paths(puppet_class_dir)
         invalid_classes = find_invalid_classes(all_cap)
-        valid_classes = all_cap.dup.transpose[0] - invalid_classes
+        valid_classes = find_valid_classes(all_cap, invalid_classes)
         coverage['classes']['invalid'] = invalid_classes
         coverage['classes']['valid'] = valid_classes
         hiera = YAML.safe_load(File.open(hiera_path))
+        profile&.gsub!(/^profile_/, '') unless profile.nil?
+
         matcher = profile.nil? ? /^profile_/ : /^profile_#{profile}/
         hiera.each do |k, v|
           key_base = k.split('::')[-1]
@@ -50,9 +52,13 @@ module AbideDevUtils
         out_hash
       end
 
-      def self.find_valid_classes(all_cap)
+      def self.find_valid_classes(all_cap, invalid_classes)
         all_classes = all_cap.dup.transpose[0]
-        all_classes - find_invalid_classes(all_cap)
+        return [] if all_classes.nil?
+
+        return all_classes - invalid_classes unless invalid_classes.nil?
+
+        all_classes
       end
 
       def self.find_invalid_classes(all_cap)

data/lib/abide_dev_utils/ppt/new_obj.rb

@@ -2,6 +2,7 @@
 
 require 'erb'
 require 'pathname'
+require 'abide_dev_utils/output'
 require 'abide_dev_utils/prompt'
 require 'abide_dev_utils/errors/ppt'
 
@@ -9,6 +10,10 @@ module AbideDevUtils
   module Ppt
     class NewObjectBuilder
       DEFAULT_EXT = '.pp'
+      VALID_EXT = /(\.pp|\.rb)\.erb$/.freeze
+      TMPL_PATTERN = /^[a-zA-Z][^\s]*\.erb$/.freeze
+      OBJ_PREFIX = /^(c-|d-)/.freeze
+      PREFIX_TEST_PATH = { 'c-' => 'classes', 'd-' => 'defines' }.freeze
 
       def initialize(obj_type, obj_name, opts: {}, vars: {})
         @obj_type = obj_type
@@ -17,25 +22,17 @@ module AbideDevUtils
         @vars = vars
         class_vars
         validate_class_vars
+        @tmpl_data = template_data(@opts.fetch(:tmpl_name, @obj_type))
       end
 
-      attr_reader :obj_type, :obj_name, :tmpl_name, :root_dir, :tmpl_dir, :tmpl_path, :type_path_map, :obj_path, :vars
-
-      def render
-        ERB.new(File.read(@tmpl_path.to_s), 0, '<>-').result(binding)
-      end
+      attr_reader :obj_type, :obj_name, :root_dir, :tmpl_dir, :obj_path, :vars, :tmpl_data
 
       def build
-        continue = File.exist?(obj_path) ? AbideDevUtils::Prompt.yes_no('File exists, would you like to overwrite?') : true
-        return "Not overwriting file #{obj_path}" unless continue
-
-        dir, = Pathname.new(obj_path).split
-        Pathname.new(dir).mkpath unless Dir.exist?(dir)
-        content = render
-        File.open(obj_path, 'w') { |f| f.write(render) } unless content.empty?
-        raise AbideDevUtils::Errors::Ppt::FailedToCreateFileError, obj_path unless File.file?(obj_path)
-
-        "Created file #{obj_path}"
+        force = @opts.fetch(:force, false)
+        obj_cont = force ? true : continue?(obj_path)
+        spec_cont = force ? true : continue?(@tmpl_data[:spec_path])
+        write_file(obj_path, @tmpl_data[:path]) if obj_cont
+        write_file(@tmpl_data[:spec_path], @spec_tmpl) if spec_cont
       end
 
       # If a method gets called on the Hiera object which is not defined,
@@ -59,42 +56,98 @@ module AbideDevUtils
 
       private
 
+      def continue?(path)
+        continue = if File.exist?(path)
+                     AbideDevUtils::Prompt.yes_no('File exists, would you like to overwrite?')
+                   else
+                     true
+                   end
+        AbideDevUtils::Output.simple("Not overwriting file #{path}") unless continue
+
+        continue
+      end
+
+      def write_file(path, tmpl_path)
+        dir, = Pathname.new(path).split
+        Pathname.new(dir).mkpath unless Dir.exist?(dir)
+        content = render(tmpl_path)
+        File.open(path, 'w') { |f| f.write(content) } unless content.empty?
+        raise AbideDevUtils::Errors::Ppt::FailedToCreateFileError, path unless File.file?(path)
+
+        AbideDevUtils::Output.simple("Created file #{path}")
+      end
+
+      def build_obj; end
+
       def class_vars
-        @tmpl_name = @opts.fetch(:tmpl_name, "#{@obj_type}.erb")
         @root_dir = Pathname.new(@opts.fetch(:root_dir, Dir.pwd))
         @tmpl_dir = if @opts.fetch(:absolute_template_dir, false)
                       @opts.fetch(:tmpl_dir)
                     else
-                      "#{@opts.fetch(:root_dir, Dir.pwd)}/#{@opts.fetch(:tmpl_dir, 'object_templates')}"
+                      "#{@root_dir}/#{@opts.fetch(:tmpl_dir, 'object_templates')}"
                     end
-        @tmpl_path = Pathname.new("#{@tmpl_dir}/#{@opts.fetch(:tmpl_name, "#{@obj_type}.erb")}")
-        @type_path_map = @opts.fetch(:type_path_map, {})
         @obj_path = new_obj_path
+        @spec_tmpl = @opts.fetch(:spec_template, File.expand_path(File.join(__dir__, '../resources/generic_spec.erb')))
       end
 
       def validate_class_vars
         raise AbideDevUtils::Errors::PathNotDirectoryError, @root_dir unless Dir.exist? @root_dir
         raise AbideDevUtils::Errors::PathNotDirectoryError, @tmpl_dir unless Dir.exist? @tmpl_dir
-        raise AbideDevUtils::Errors::Ppt::TemplateNotFoundError, @tmpl_path.to_s unless @tmpl_path.file?
       end
 
       def basename(obj_name)
         obj_name.split('::')[-1]
       end
 
-      def new_obj_path
-        if obj_type == 'class'
-          obj_path_from_name
-        else
-          custom_obj_path
+      def prefix
+        pfx = basename.match(OBJ_PREFIX)
+        return pfx[1] unless pfx.empty?
+      end
+
+      def templates
+        return [] if Dir.entries(tmpl_dir).empty?
+
+        file_names = Dir.entries(tmpl_dir).select { |f| f.match?(TMPL_PATTERN) }
+        file_names.map { |i| File.join(tmpl_dir, i) }
+      end
+
+      def template_data(query)
+        raise AbideDevUtils::Errors::Ppt::TemplateNotFoundError, @tmpl_dir if Dir.entries(@tmpl_dir).empty?
+
+        data = {}
+        pattern = /#{Regexp.quote(query)}/
+        templates.each do |i|
+          pn = Pathname.new(i)
+          next unless pn.basename.to_s.match?(pattern)
+
+          data[:path] = pn.to_s
+          data[:fname] = pn.basename.to_s
         end
+        raise AbideDevUtils::Errors::Ppt::TemplateNotFoundError, @tmpl_dir unless data.key?(:fname)
+
+        data[:ext] = data[:fname].match?(VALID_EXT) ? data[:fname].match(VALID_EXT)[1] : '.pp'
+        data[:pfx] = data[:fname].match?(OBJ_PREFIX) ? data[:fname].match(OBJ_PREFIX)[1] : 'c-'
+        data[:spec_base] = PREFIX_TEST_PATH[data[:pfx]]
+        data[:obj_name] = normalize_obj_name(data.dup)
+        data[:spec_name] = "#{@obj_name.split('::')[-1]}_spec.rb"
+        data[:spec_path] = spec_path(data[:spec_base], data[:spec_name])
+        data
+      end
+
+      def normalize_obj_name(data)
+        new_name = data[:fname].slice(/^(?:#{Regexp.quote(data[:pfx])})?(?<name>[^\s.]+)(?:#{Regexp.quote(data[:ext])})?\.erb$/, 'name')
+        "#{new_name}#{data[:ext]}"
+      end
+
+      def render(path)
+        ERB.new(File.read(path), 0, '<>-').result(binding)
       end
 
       def namespace_format(name)
         name.split(':').reject(&:empty?).join('::')
       end
 
-      def obj_path_from_name
+      def new_obj_path
         parts = @obj_name.split('::')[1..-2]
         parts.insert(0, 'manifests')
         parts.insert(-1, "#{basename(@obj_name)}#{DEFAULT_EXT}")
@@ -102,27 +155,13 @@ module AbideDevUtils
         path.to_s
       end
 
-      def custom_obj_path
-        map_val = type_path_map.fetch(@obj_type.to_sym, nil)
-        return obj_path_from_name if map_val.nil?
-
-        if map_val.respond_to?(:key?)
-          custom_obj_path_from_hash(map_val, @obj_name)
-        else
-          abs_path = Pathname.new(map_val).absolute? ? map_val : "#{Dir.pwd}/#{map_val}"
-          "#{abs_path}/#{basename(@obj_name)}#{DEFAULT_EXT}"
-        end
-      end
-
-      def custom_obj_path_from_hash(map_val, obj_name)
-        raise AbideDevUtils::Errors::Ppt::CustomObjPathKeyError, map_val unless map_val.key?(:path)
-
-        abs_path = Pathname.new(map_val[:path]).absolute? ? map_val[:path] : "#{Dir.pwd}/#{map_val[:path]}"
-        if map_val.key?(:extension)
-          "#{abs_path}/#{basename(obj_name)}#{map_val[:extension]}"
-        else
-          "#{abs_path}/#{basename(obj_name)}#{DEFAULT_EXT}"
-        end
+      def spec_path(base_dir, spec_name)
+        parts = @obj_name.split('::')[1..-2]
+        parts.insert(0, 'spec')
+        parts.insert(1, base_dir)
+        parts.insert(-1, spec_name)
+        path = @root_dir + Pathname.new(parts.join('/'))
+        path.to_s
       end
     end
   end

data/lib/abide_dev_utils/resources/generic_spec.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '<%= @obj_name %>' do
+  on_supported_os.each do |os, os_facts|
+    context "on #{os}" do
+      let(:facts) { os_facts }
+
+      it { is_expected.to compile }
+    end
+  end
+end

data/lib/abide_dev_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AbideDevUtils
-  VERSION = "0.2.1"
+  VERSION = "0.4.1"
 end

data/lib/abide_dev_utils/xccdf.rb

@@ -15,7 +15,7 @@ module AbideDevUtils
       type = opts.fetch(:type, 'cis')
       case type.downcase
       when 'cis'
-        AbideDevUtils::XCCDF::CIS::Hiera.new(xccdf_file, parent_key_prefix: opts[:parent_key_prefix])
+        AbideDevUtils::XCCDF::CIS::Hiera.new(xccdf_file, parent_key_prefix: opts[:parent_key_prefix], num: opts[:num])
       else
         AbideDevUtils::Output.simple("XCCDF type #{type} is unsupported!")
       end

data/lib/abide_dev_utils/xccdf/cis/hiera.rb

@@ -13,6 +13,7 @@ module AbideDevUtils
       # @!attribute [r] yaml_title
       class Hiera
         CONTROL_PREFIX = /^[\d.]+_/.freeze
+        UNDERSCORED = /(\s|\(|\)|-|\.)/.freeze
         XPATHS = {
           benchmark: {
             all: 'xccdf:Benchmark',
@@ -34,13 +35,13 @@ module AbideDevUtils
         # @param parent_key_prefix [String] a string to be prepended to the
         #   top-level key in the Hiera structure. Useful for namespacing
         #   the top-level key.
-        def initialize(xccdf_file, parent_key_prefix: nil)
+        def initialize(xccdf_file, parent_key_prefix: nil, num: false)
           @doc = parse(xccdf_file)
           @title = xpath(XPATHS[:benchmark][:title]).children.to_s
           @version = xpath(XPATHS[:benchmark][:version]).children.to_s
           @profiles = xpath(XPATHS[:profiles][:all])
           @parent_key = make_parent_key(@doc, parent_key_prefix)
-          @hash = make_hash(@doc, @parent_key)
+          @hash = make_hash(@doc, @parent_key, num)
         end
 
         def yaml_title
@@ -89,15 +90,18 @@ module AbideDevUtils
 
         private
 
-        attr_accessor :doc, :parent_key, :hash, :profiles
+        attr_accessor :doc, :hash, :parent_key, :profiles
 
+        # Accepts a path to an xccdf xml file and returns a parsed Nokogiri object of the file
+        # @param xccdf_file [String] path to an xccdf xml file
+        # @return [Nokogiri::Node] A Nokogiri node object of the XML document
         def parse(xccdf_file)
           raise AbideDevUtils::Errors::FileNotFoundError, xccdf_file unless File.file?(xccdf_file)
 
           Nokogiri.XML(File.open(xccdf_file))
         end
 
-        def make_hash(doc, parent_key)
+        def make_hash(doc, parent_key, num)
           hash = { parent_key.to_sym => { title: @title, version: @version } }
           profiles = doc.xpath('xccdf:Benchmark/xccdf:Profile')
           profiles.each do |p|
@@ -105,7 +109,7 @@ module AbideDevUtils
             hash[parent_key.to_sym][title.to_sym] = []
             selects = p.xpath('./xccdf:select')
             selects.each do |s|
-              hash[parent_key.to_sym][title.to_sym] << normalize_ctrl_name(s['idref'].to_s)
+              hash[parent_key.to_sym][title.to_sym] << normalize_ctrl_name(s['idref'].to_s, num)
             end
           end
           hash
@@ -113,11 +117,11 @@ module AbideDevUtils
 
         def normalize_str(str)
           nstr = str.downcase
-          nstr.gsub!(/[^a-z]$/, '')
+          nstr.gsub!(/[^a-z0-9]$/, '')
           nstr.gsub!(/^[^a-z]/, '')
           nstr.gsub!(/^(l1_|l2_|ng_)/, '')
-          nstr.delete!('-')
-          nstr.gsub!(/(\s|\(|\))/, '_')
+          nstr.delete!('(/|\\)')
+          nstr.gsub!(UNDERSCORED, '_')
           nstr
         end
 
@@ -127,9 +131,21 @@ module AbideDevUtils
           prof_name
         end
 
-        def normalize_ctrl_name(ctrl)
-          new_ctrl = ctrl.split('_rule_')[-1].gsub(CONTROL_PREFIX, '')
-          normalize_str(new_ctrl.gsub(/\./, '_'))
+        def normalize_ctrl_name(ctrl, num)
+          return num_normalize_ctrl(ctrl) if num
+
+          name_normalize_ctrl(ctrl)
+        end
+
+        def name_normalize_ctrl(ctrl)
+          new_ctrl = ctrl.split('benchmarks_rule_')[-1].gsub(CONTROL_PREFIX, '')
+          normalize_str(new_ctrl)
+        end
+
+        def num_normalize_ctrl(ctrl)
+          part = ctrl.split('benchmarks_rule_')[-1]
+          numpart = CONTROL_PREFIX.match(part).to_s.chop.gsub(UNDERSCORED, '_')
+          "c#{numpart}"
         end
 
         def make_parent_key(doc, prefix)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Heston Snodgrass
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-23 00:00:00.000000000 Z
+date: 2021-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
@@ -242,11 +256,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -278,6 +294,7 @@ files:
 - lib/abide_dev_utils/ppt/coverage.rb
 - lib/abide_dev_utils/ppt/new_obj.rb
 - lib/abide_dev_utils/prompt.rb
+- lib/abide_dev_utils/resources/generic_spec.erb
 - lib/abide_dev_utils/utils/general.rb
 - lib/abide_dev_utils/validate.rb
 - lib/abide_dev_utils/version.rb