abide_dev_utils 0.12.2 → 0.14.0

data/lib/abide_dev_utils/puppet_strings.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'puppet-strings'
+require 'puppet-strings/yard'
+
+module AbideDevUtils
+  # Puppet Strings reference object
+  class PuppetStrings
+    attr_reader :search_patterns
+
+    def initialize(search_patterns: nil, opts: {})
+      check_yardoc_dir
+      @search_patterns = search_patterns || ::PuppetStrings::DEFAULT_SEARCH_PATTERNS
+      @debug = opts[:debug]
+      @quiet = opts[:quiet]
+      PuppetStrings::Yard.setup!
+      YARD::CLI::Yardoc.run(*yard_args(@search_patterns, debug: @debug, quiet: @quiet))
+    end
+
+    def debug?
+      !!@debug
+    end
+
+    def quiet?
+      !!@quiet
+    end
+
+    def find_resource(resource_name)
+      to_h.each do |_, resources|
+        res = resources.find { |r| r[:name] == resource_name.to_sym }
+        return res if res
+      end
+    end
+
+    def puppet_classes
+      @puppet_classes ||= all_to_h YARD::Registry.all(:puppet_class)
+    end
+
+    def data_types
+      @data_types ||= all_to_h YARD::Registry.all(:puppet_data_types)
+    end
+
+    def data_type_aliases
+      @data_type_aliases ||= all_to_h YARD::Registry.all(:puppet_data_type_alias)
+    end
+
+    def defined_types
+      @defined_types ||= all_to_h YARD::Registry.all(:puppet_defined_type)
+    end
+
+    def resource_types
+      @resource_types ||= all_to_h YARD::Registry.all(:puppet_type)
+    end
+
+    def providers
+      @providers ||= all_to_h YARD::Registry.all(:puppet_provider)
+    end
+
+    def puppet_functions
+      @puppet_functions ||= all_to_h YARD::Registry.all(:puppet_function)
+    end
+
+    def puppet_tasks
+      @puppet_tasks ||= all_to_h YARD::Registry.all(:puppet_task)
+    end
+
+    def puppet_plans
+      @puppet_plans ||= all_to_h YARD::Registry.all(:puppet_plan)
+    end
+
+    def to_h
+      {
+        puppet_classes: puppet_classes,
+        data_types: data_types,
+        data_type_aliases: data_type_aliases,
+        defined_types: defined_types,
+        resource_types: resource_types,
+        providers: providers,
+        puppet_functions: puppet_functions,
+        puppet_tasks: puppet_tasks,
+        puppet_plans: puppet_plans,
+      }
+    end
+
+    private
+
+    def check_yardoc_dir
+      yardoc_dir = File.expand_path('./.yardoc')
+      return unless Dir.exist?(yardoc_dir) && !File.writable?(yardoc_dir)
+
+      raise "yardoc directory permissions error. Ensure #{yardoc_dir} is writable by current user."
+    end
+
+    def all_to_h(objects)
+      objects.sort_by(&:name).map(&:to_hash)
+    end
+
+    def yard_args(patterns, debug: false, quiet: false)
+      args = ['doc', '--no-progress', '-n']
+      args << '--debug' if debug && !quiet
+      args << '--backtrace' if debug && !quiet
+      args << '-q' if quiet
+      args << '--no-stats' if quiet
+      args += patterns
+      args
+    end
+  end
+end

data/lib/abide_dev_utils/validate.rb

@@ -27,6 +27,14 @@ module AbideDevUtils
       raise AbideDevUtils::Errors::PathNotDirectoryError, path unless File.directory?(path)
     end
 
+    def self.populated_string?(thing)
+      return false if thing.nil?
+      return false unless thing.instance_of?(String)
+      return false if thing.empty?
+
+      true
+    end
+
     def self.populated_string(thing)
       raise AbideDevUtils::Errors::NotPopulatedStringError, 'Object is nil' if thing.nil?
 

data/lib/abide_dev_utils/version.rb

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

data/lib/abide_dev_utils/xccdf/parser/objects.rb

@@ -456,7 +456,7 @@ module AbideDevUtils
 
           def new_implementation_groups(element)
             igroup = find_element.at_xpath(element, 'implementation_groups')
-            return if igroup.nil? || igroup.empty?
+            return if igroup.nil? || igroup.attributes.empty?
 
             add_child(ShortText, igroup['ig1']) if igroup['ig1']
             add_child(ShortText, igroup['ig2']) if igroup['ig2']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abide_dev_utils
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.14.0
 platform: ruby
 authors:
 - abide-team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-17 00:00:00.000000000 Z
+date: 2023-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.23'
+- !ruby/object:Gem::Dependency
+  name: puppet-strings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: jira-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +156,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: '1.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: '1.21'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -341,6 +355,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/mend_ruby.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -374,6 +389,11 @@ files:
 - lib/abide_dev_utils/cem/mapping/mapper.rb
 - lib/abide_dev_utils/cem/validate.rb
 - lib/abide_dev_utils/cem/validate/resource_data.rb
+- lib/abide_dev_utils/cem/validate/strings.rb
+- lib/abide_dev_utils/cem/validate/strings/base_validator.rb
+- lib/abide_dev_utils/cem/validate/strings/puppet_class_validator.rb
+- lib/abide_dev_utils/cem/validate/strings/puppet_defined_type_validator.rb
+- lib/abide_dev_utils/cem/validate/strings/validation_finding.rb
 - lib/abide_dev_utils/cli.rb
 - lib/abide_dev_utils/cli/abstract.rb
 - lib/abide_dev_utils/cli/cem.rb
@@ -420,7 +440,9 @@ files:
 - lib/abide_dev_utils/ppt/new_obj.rb
 - lib/abide_dev_utils/ppt/puppet_module.rb
 - lib/abide_dev_utils/ppt/score_module.rb
+- lib/abide_dev_utils/ppt/strings.rb
 - lib/abide_dev_utils/prompt.rb
+- lib/abide_dev_utils/puppet_strings.rb
 - lib/abide_dev_utils/resources/generic_spec.erb
 - lib/abide_dev_utils/validate.rb
 - lib/abide_dev_utils/version.rb