ohai 14.5.0 → 14.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a51cf17407e9d91624a5fa169e8057d15a75eac70805fc38a4fcbf928141121b
-  data.tar.gz: 69c101063af73a9b0aba3f0956e57ce9c488607e76f605d1425e0d40951bcb38
+  metadata.gz: 43d635401a670d3a17696baedc004962bbabb702055df16763a8814f920fa3ce
+  data.tar.gz: 75d091cb7e4d9e8993224ed95b2dd19212293afb925e7b202325cacac2157105
 SHA512:
-  metadata.gz: 354f6a0bd33873e3d8b124eeb23bfd111bd8b6cf46642fd119c3dd5cfd82666629ccff70fad44b08ac4a7fb2900a566cc0639558b0b5b2d10b95cec4d2e5a052
-  data.tar.gz: 67bdf1bfc49797e0f61d95c96e2ad769c124ea19dc682358ae5fc27042cd8cdc4e08ea3f831a05c5b5edf3e1dd495579e90e9ac1321d7d678db41f58f167b4b9
+  metadata.gz: 532516c9be86772a63d5cdd33b6f6533e99a4861cead69cf67c5f3fa4695635731de6511e009b08f2930390908a3ed63ab249c5f42c3d7ff5b457a73537301b1
+  data.tar.gz: 05c0a5ea12747b483379734911f40c18cd17fb7cc22ef1484bf6d8ff97f90127631d543e5051bd9debbc4970696ee44a47ea486a226c8dea4a6457c8d10405c2

data/lib/ohai/dsl/plugin.rb

@@ -43,6 +43,7 @@ module Ohai
     end
   end
 
+  # @param name [String]
   def self.plugin(name, &block)
     raise Ohai::Exceptions::InvalidPluginName, "#{name} is not a valid plugin name. A valid plugin name is a symbol which begins with a capital letter and contains no underscores" unless NamedPlugin.valid_name?(name)
 
@@ -61,6 +62,8 @@ module Ohai
   end
 
   # Cross platform /dev/null to support testability
+  #
+  # @return [String]
   def self.dev_null
     if RUBY_PLATFORM =~ /mswin|mingw|windows/
       "NUL"

data/lib/ohai/hints.rb

@@ -26,7 +26,7 @@ module Ohai
       @hints = {}
     end
 
-    # parse the JSON conents of a hint file. Return an empty hash if the file has
+    # parse the JSON contents of a hint file. Return an empty hash if the file has
     # no JSON content
     # @param filename [String] the hint file path
     def self.parse_hint_file(filename)

data/lib/ohai/loader.rb

@@ -62,12 +62,18 @@ module Ohai
 
     # Searches all plugin paths and returns an Array of PluginFile objects
     # representing each plugin file.
+    #
+    # @param dir [Array, String] directory/directories to load plugins from
+    # @return [Array<Ohai::Loader::PluginFile>]
     def plugin_files_by_dir(dir = Ohai.config[:plugin_path])
       Array(dir).inject([]) do |plugin_files, plugin_path|
         plugin_files + PluginFile.find_all_in(plugin_path)
       end
     end
 
+    # loads all plugin classes
+    #
+    # @return [Array<String>]
     def load_all
       plugin_files_by_dir.each do |plugin_file|
         load_plugin_class(plugin_file.path, plugin_file.plugin_root)
@@ -76,6 +82,8 @@ module Ohai
       collect_v7_plugins
     end
 
+    # load additional plugins classes from a given directory
+    # @param from [String] path to a directory with additional plugins to load
     def load_additional(from)
       from = [ Ohai.config[:plugin_path], from].flatten
       plugin_files_by_dir(from).collect do |plugin_file|
@@ -88,6 +96,9 @@ module Ohai
     # Load a specified file as an ohai plugin and creates an instance of it.
     # Not used by ohai itself, but can be used to load a plugin for testing
     # purposes.
+    #
+    # @param plugin_path [String]
+    # @param plugin_dir_path [String]
     def load_plugin(plugin_path, plugin_dir_path = nil)
       plugin_class = load_plugin_class(plugin_path, plugin_dir_path)
       return nil unless plugin_class.kind_of?(Class)

data/lib/ohai/log.rb

@@ -22,7 +22,7 @@ module Ohai
   class Log
     extend Mixlib::Log
 
-    # this class loading initalization is so that we don't lose early logger
+    # this class loading initialization is so that we don't lose early logger
     # messages when run from the CLI?
     init(STDERR)
     level = :info # rubocop:disable Lint/UselessAssignment

data/lib/ohai/system.rb

@@ -29,6 +29,7 @@ require "ohai/provides_map"
 require "ohai/hints"
 require "mixlib/shellout"
 require "ohai/config"
+require "ffi_yajl"
 
 module Ohai
   class System
@@ -53,6 +54,10 @@ module Ohai
       reset_system
     end
 
+    # clears the current collected data, clears the provides map for plugins,
+    # refreshes hints, and reconfigures ohai. In short this gets Ohai into a first run state
+    #
+    # @return [void]
     def reset_system
       @data = Mash.new
       @provides_map = ProvidesMap.new
@@ -73,6 +78,10 @@ module Ohai
       @data[key]
     end
 
+    # resets the system and loads then runs the plugins
+    #
+    # @param [Array<String>] attribute_filter
+    # @return [void]
     def all_plugins(attribute_filter = nil)
       # Reset the system when all_plugins is called since this function
       # can be run multiple times in order to pick up any changes in the

data/lib/ohai/version.rb

@@ -18,5 +18,5 @@
 
 module Ohai
   OHAI_ROOT = File.expand_path(File.dirname(__FILE__))
-  VERSION = "14.5.0".freeze
+  VERSION = "14.5.4".freeze
 end

data/ohai.gemspec

@@ -5,7 +5,6 @@ require "ohai/version"
 Gem::Specification.new do |s|
   s.name = "ohai"
   s.version = Ohai::VERSION
-  s.platform = Gem::Platform::RUBY
   s.summary = "Ohai profiles your system and emits JSON"
   s.description = s.summary
   s.license = "Apache-2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ohai
 version: !ruby/object:Gem::Version
-  version: 14.5.0
+  version: 14.5.4
 platform: ruby
 authors:
 - Adam Jacob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-14 00:00:00.000000000 Z
+date: 2018-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: systemu