linux_stat 1.0.3 → 1.2.2

data/lib/linux_stat/usb.rb

@@ -14,13 +14,13 @@ module LinuxStat
 			#
 			# It can have information like:
 			#
-			# id, vendor id, product id, manufacturer, serial, bus number, dev number,
+			# path, id, vendor id, product id, manufacturer, serial, bus number, dev number,
 			# b_max_power, b_max_packet_size, etc.
 			#
 			# An example of the returned sample from a test machine is:
 			#    LinuxStat::USB.devices_stat
 			#
-			#    [{:path=>"/sys/bus/usb/devices/1-1.2/", :id=>"04d9:1203", :vendor_id=>"04d9", :product_id=>"1203", :bus_num=>1, :dev_num=>4, :hwdata=>{:vendor=>"Holtek Semiconductor, Inc.", :product=>"Keyboard"}, :authorized=>true, :b_max_power=>"100mA", :b_max_packet_size0=>8}
+			#    => [{:path=>"/sys/bus/usb/devices/1-1.2/", :id=>"04d9:1203", :vendor_id=>"04d9", :product_id=>"1203", :bus_num=>1, :dev_num=>4, :hwdata=>{:vendor=>"Holtek Semiconductor, Inc.", :product=>"Keyboard"}, :authorized=>true, :b_max_power=>"100mA", :b_max_packet_size0=>8}
 			#
 			# Right, it's an array of Hashes.
 			#
@@ -49,71 +49,75 @@ module LinuxStat
 				return [] unless @@sys_usb_readable
 
 				Dir['/sys/bus/usb/devices/*/'.freeze].sort!.map! { |x|
-					id_vendor_file = File.join(x, 'idVendor'.freeze)
-					next unless File.readable?(id_vendor_file)
-					id_vendor = IO.read(id_vendor_file).strip
+					begin
+						id_vendor_file = File.join(x, 'idVendor'.freeze)
+						next unless File.readable?(id_vendor_file)
+						id_vendor = IO.read(id_vendor_file).strip
 
-					id_product_file = File.join(x, 'idProduct'.freeze)
-					next unless File.readable?(id_vendor_file)
-					id_product = IO.read(id_product_file).strip
+						id_product_file = File.join(x, 'idProduct'.freeze)
+						next unless File.readable?(id_vendor_file)
+						id_product = IO.read(id_product_file).strip
 
-					bus_num_file = File.join(x, 'busnum'.freeze)
-					bus_num = File.readable?(bus_num_file) ? IO.read(bus_num_file).strip : ''.freeze
+						bus_num_file = File.join(x, 'busnum'.freeze)
+						bus_num = File.readable?(bus_num_file) ? IO.read(bus_num_file).strip : ''.freeze
 
-					dev_num_file = File.join(x, 'devnum'.freeze)
-					dev_num = File.readable?(dev_num_file) ? IO.read(dev_num_file).strip : ''.freeze
+						dev_num_file = File.join(x, 'devnum'.freeze)
+						dev_num = File.readable?(dev_num_file) ? IO.read(dev_num_file).strip : ''.freeze
 
-					serial_file = File.join(x, 'serial'.freeze)
-					serial = File.readable?(serial_file) ? IO.read(serial_file).strip : ''.freeze
+						serial_file = File.join(x, 'serial'.freeze)
+						serial = File.readable?(serial_file) ? IO.read(serial_file).strip : ''.freeze
 
-					product_file = File.join(x, 'product'.freeze)
-					product = File.readable?(product_file) ? IO.read(product_file).strip : ''.freeze
+						product_file = File.join(x, 'product'.freeze)
+						product = File.readable?(product_file) ? IO.read(product_file).strip : ''.freeze
 
-					manufacturer_file = File.join(x, 'manufacturer'.freeze)
-					manufacturer = File.readable?(manufacturer_file) ? IO.read(manufacturer_file).strip : ''.freeze
+						manufacturer_file = File.join(x, 'manufacturer'.freeze)
+						manufacturer = File.readable?(manufacturer_file) ? IO.read(manufacturer_file).strip : ''.freeze
 
-					removable_file = File.join(x, 'removable'.freeze)
-					removable = File.readable?(removable_file) ? IO.read(removable_file).strip : ''.freeze
+						removable_file = File.join(x, 'removable'.freeze)
+						removable = File.readable?(removable_file) ? IO.read(removable_file).strip.downcase : ''.freeze
 
-					authorized_file = File.join(x, 'authorized'.freeze)
-					authorized = File.readable?(authorized_file) ? IO.read(authorized_file).to_i : ''.freeze
+						authorized_file = File.join(x, 'authorized'.freeze)
+						authorized = File.readable?(authorized_file) ? IO.read(authorized_file).to_i : ''.freeze
 
-					b_max_power_file = File.join(x, 'bMaxPower'.freeze)
-					b_max_power = File.readable?(b_max_power_file) ? IO.read(b_max_power_file).strip : ''.freeze
+						b_max_power_file = File.join(x, 'bMaxPower'.freeze)
+						b_max_power = File.readable?(b_max_power_file) ? IO.read(b_max_power_file).strip : ''.freeze
 
-					b_max_packet_size0_file = File.join(x, 'bMaxPacketSize0'.freeze)
-					b_max_packet_size0 = File.readable?(b_max_packet_size0_file) ? IO.read(b_max_packet_size0_file).to_i : ''.freeze
+						b_max_packet_size0_file = File.join(x, 'bMaxPacketSize0'.freeze)
+						b_max_packet_size0 = File.readable?(b_max_packet_size0_file) ? IO.read(b_max_packet_size0_file).to_i : ''.freeze
 
-					query = hwdata ? query_hwdata(id_vendor, id_product) : {}
+						query = hwdata ? query_hwdata(id_vendor, id_product) : {}
 
-					removable.downcase!
-					is_removable = if removable == 'removable'.freeze
-						true
-					elsif removable == 'unknown'.freeze
-						nil
-					else
-						false
-					end
+						is_removable = if removable == 'removable'.freeze
+							true
+						elsif removable == 'unknown'.freeze
+							nil
+						else
+							false
+						end
+
+						ret = {
+							path: x, id: "#{id_vendor}:#{id_product}",
+							vendor_id: id_vendor, product_id: id_product
+						}
 
-					ret = {
-						path: x, id: "#{id_vendor}:#{id_product}",
-						vendor_id: id_vendor, product_id: id_product
-					}
+						ret.merge!(bus_num: bus_num.to_i) unless bus_num.empty?
+						ret.merge!(dev_num: dev_num.to_i) unless dev_num.empty?
 
-					ret.merge!(bus_num: bus_num.to_i) unless bus_num.empty?
-					ret.merge!(dev_num: dev_num.to_i) unless dev_num.empty?
+						ret.merge!(serial: serial) unless serial.empty?
 
-					ret.merge!(serial: serial) unless serial.empty?
+						ret.merge!(hwdata: query) unless query.empty?
+						ret.merge!(product: product) unless product.empty?
+						ret.merge!(manufacturer: manufacturer) unless manufacturer.empty?
 
-					ret.merge!(hwdata: query) unless query.empty?
-					ret.merge!(product: product) unless product.empty?
-					ret.merge!(manufacturer: manufacturer) unless manufacturer.empty?
+						ret.merge!(removable: is_removable) unless is_removable.nil?
+						ret.merge!(authorized: authorized == 1)
 
-					ret.merge!(removable: is_removable) unless is_removable.nil?
-					ret.merge!(authorized: authorized == 1)
+						ret.merge!(b_max_power: b_max_power) unless b_max_power.empty?
+						ret.merge!(b_max_packet_size0: b_max_packet_size0) if b_max_packet_size0
 
-					ret.merge!(b_max_power: b_max_power) unless b_max_power.empty?
-					ret.merge!(b_max_packet_size0: b_max_packet_size0) if b_max_packet_size0
+						ret
+					rescue StandardError
+					end
 				}.tap(&:compact!)
 			end
 
@@ -141,11 +145,63 @@ module LinuxStat
 				}
 			end
 
+			##
+			# hwdata_file = file
+			#
+			# Lets you set the hwdata_file about usb.ids.
+			#
+			# The hwdata file about usb.ids contains vendor name and product name information about
+			# devices. This is then mapped by the other methods that utilizes hwdata/usb.ids.
+			#
+			# Do note that this method is intended to run only once, at the beginning.
+			# If you use any other method that utilizes hwdata/usb.ids, before
+			# calling this method, this method will not work.
+			def hwdata_file=(file)
+				@@hwdata_file ||= file.freeze
+			end
+
+			##
+			# Checks if hwdata_file is already initialized or not.
+			# Once it's initialized, calling hwdata_file = 'something/usb.ids' is futile.
+			def hwdata_file_set?
+				@@hwdata_file ||= nil
+				!!@@hwdata_file
+			end
+
+			##
+			# Returns the hwdata_file as string.
+			#
+			# If hwdata_file isn't set, it will return an empty frozen string.
+			#
+			# Once it's set, it can't be changed.
+			def hwdata_file
+				@@hwdata_file ||= nil
+				@@hwdata_file ? @@hwdata_file : ''.freeze
+			end
+
+			##
+			# Initializes hwdata
+			#
+			# hwdata can take upto 0.1 to 0.2 seconds to get initialized.
+			#
+			# Calling this method will load hwdata for future use.
+			#
+			# Once it's initialized, hwdata_file can't be changed.
+			#
+			# If this method initializes hwdata, it will return true
+			# Othewise this method will return false.
+			def initialize_hwdata
+				@@hwdata ||= nil
+				init = !@@hwdata
+				hwdata
+				init
+			end
+
 			alias count_devices count
 
 			private
 			def hwdata
-				@@hwdata_file ||= "/usr/share/hwdata/usb.ids"
+				@@hwdata_file ||= "/usr/share/hwdata/usb.ids".freeze
 
 				@@hwdata ||= if File.readable?(@@hwdata_file)
 					file_data = IO.readlines(@@hwdata_file, encoding: 'ASCII-8BIT')
@@ -163,19 +219,19 @@ module LinuxStat
 						if x[0] == ?\t.freeze
 							next unless vendor_id
 
-							data = x.tap(&:strip!)
-							device_id = data[/\A.*?\s/].to_s.strip
-							device = data[device_id.length..-1].to_s.strip
+							x.strip!
+							device_id = x[/\A.*?\s/].to_s.strip
+							device = x[device_id.length..-1].to_s.strip
 							ret[vendor_id][1][device_id] = device
 						else
-							data = x
-							vendor_id = data[/\A.*?\s/].to_s.strip
-							vendor = data[vendor_id.length..-1].to_s.strip
+							x.strip!
+							vendor_id = x[/\A.*?\s/].to_s.strip
+							vendor = x[vendor_id.length..-1].to_s.strip
 							ret[vendor_id] = [vendor, {}]
 						end
 					end
 
-					ret
+					ret.freeze
 				else
 					{}
 				end

data/lib/linux_stat/version.rb

@@ -1,3 +1,3 @@
 module LinuxStat
-	VERSION ||= "1.0.3"
+	VERSION ||= "1.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linux_stat
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.2.2
 platform: ruby
 authors:
 - Sourav Goswami
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-25 00:00:00.000000000 Z
+date: 2020-12-28 00:00:00.000000000 Z
 dependencies: []
 description: Linux only, efficient linux system utilization reporting and system monitoring
   gem
@@ -47,6 +47,7 @@ files:
 - lib/linux_stat/mounts.rb
 - lib/linux_stat/net.rb
 - lib/linux_stat/os.rb
+- lib/linux_stat/pci.rb
 - lib/linux_stat/prettify_bytes.rb
 - lib/linux_stat/process.rb
 - lib/linux_stat/process_info.rb