sys-memory 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb58ad679007156871e4cc8b3906546c10a634a04537b69b6021c9b83a7be18b
-  data.tar.gz: 464f3d02c1e96915808772ac2d66652d62c956a05f03054e246af893e8316a64
+  metadata.gz: f6014e85718322e00ceadeef11991f2c92f131f0636d492d3cdb592a9beb284e
+  data.tar.gz: ab327c8145c1875e85152addbd497c01ca7a85838465410cb4cb2cdbd77043cb
 SHA512:
-  metadata.gz: d5125dcc2e250ba8d4e4e513901321b397fd473f1934e5c7d3155bdda00ee5c75cd51d2e90e2cd7b7797d97279699237a3b574004f00f63a4bb2bb2788ed9f3a
-  data.tar.gz: 472f13e448c5ce16c7750a88f93e65283b22fce862bbe2c010210fbca2be2b0465bdd7c82dae4c08457773f026da10ccd5ac3157cf4c5c334c1daeb8f77dca42
+  metadata.gz: dbc032f49449629c05cb0f8e8370b70f429c96a4e7dcbc082bfc18f16279fbedc8ef14766e98d3005ef49fc5694e6a0897b9741eac95e5dc5baeb934b1f1df41
+  data.tar.gz: f462319e9dec783d20c2f084b4c41e936c12f71948352582fe73e7de3fa26f69a639e18b850eab3dfdc0e35a30f1ba7d4a01b11bb0965b0c22118bf972df8899

data/CHANGES.md

@@ -0,0 +1,7 @@
+## 0.1.1 - 3-Nov-2021
+* Make activesupport a development dependency, not a regular dependency.
+  Thanks go to deberle for the spot.
+* Some rubocop updates.
+
+## 0.1.0 - 16-Aug-2021
+* Initial release.

data/README.md

@@ -1,3 +1,5 @@
+[![Ruby](https://github.com/djberg96/sys-memory/actions/workflows/ruby.yml/badge.svg)](https://github.com/djberg96/sys-memory/actions/workflows/ruby.yml)
+
 ## Description
 A Ruby interface for getting memory information.
 
@@ -9,8 +11,11 @@ A Ruby interface for getting memory information.
 ## Installation
 `gem install sys-memory`
 
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/sys-memory/main/certs/djberg96_pub.pem)`
+
 ## Synopsis
-```
+```ruby
 require 'sys-memory'
 
 p Sys::Memory.memory                # Hash of all information
@@ -21,9 +26,6 @@ p Sys::Memory.total(extended: true) # Total memory, include swap
 
 There's also the `free`, `used` and `load` module methods.
 
-## Adding the trusted cert
-`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/sys-memory/ffi/certs/djberg96_pub.pem)`
-
 ## Notes
 I realize there are some philosophical differences about what constitutes
 "available memory". I've tried to accomodate both of the approaches to it

data/lib/sys/linux/memory.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
+# The Sys module serves as a namespace only.
 module Sys
+  # The Memory module provides various functions that return information
+  # regarding the memory on your system.
   module Memory
     MEMORY_FILE = '/proc/meminfo'
     MEMINFO_REGEX = /(.*)?:\s+?(\d+)/.freeze
@@ -15,7 +18,7 @@ module Sys
     def memory
       hash = {}
 
-      IO.foreach(MEMORY_FILE) do |line|
+      File.foreach(MEMORY_FILE) do |line|
         key, value = MEMINFO_REGEX.match(line.chomp).captures
         hash[key] = value.to_i
       end
@@ -59,5 +62,5 @@ module Sys
     end
 
     module_function :memory, :total, :free, :used, :load
-  end
-end
+  end # Memory
+end # Sys

data/lib/sys/version.rb

@@ -3,6 +3,6 @@
 module Sys
   module Memory
     # The version of the sys-memory library.
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/lib/sys/windows/memory.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
+# The Sys module serves as a namespace only.
 module Sys
+  # The Memory module provides various functions that return information
+  # regarding the memory on your system.
   module Memory
     require 'ffi'
     extend FFI::Library
     ffi_lib 'kernel32'
 
-    private
-
     typedef :uint32, :dword
     typedef :uint64, :dwordlong
 
@@ -25,7 +26,10 @@ module Sys
       )
     end
 
+    private_constant :MemoryStatusEx
+
     attach_function :GlobalMemoryStatusEx, [MemoryStatusEx], :bool
+    private_class_method :GlobalMemoryStatusEx
 
     ffi_lib 'psapi'
 
@@ -48,9 +52,10 @@ module Sys
       )
     end
 
-    attach_function :GetPerformanceInfo, [PerformanceInformation, :dword], :bool
+    private_constant :PerformanceInformation
 
-    public
+    attach_function :GetPerformanceInfo, [PerformanceInformation, :dword], :bool
+    private_class_method :GetPerformanceInfo
 
     # Obtain detailed memory information about your host in the form of a hash.
     # Note that the exact nature of this hash is largely dependent on your
@@ -121,10 +126,10 @@ module Sys
     # A number between 0 and 100 that specifies the approximate percentage of
     # physical memory that is in use.
     #
-    # If the +extended+ option is set to true then swap memory is included in
-    # the calculation.
+    # On MS Windows the +extended+ option is ignored, but present for interface
+    # compatibility with other platforms.
     #
-    def load(extended: false)
+    def load(_extended: false)
       memory['MemoryLoad']
     end
 

data/spec/sys_memory_spec.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/numeric/bytes'
 require 'sys-memory'
 
 RSpec.describe Sys::Memory do
   context 'Sys::Memory::VERSION' do
     example 'the version constant is set to the expected value' do
-      expect(described_class::VERSION).to eq('0.1.0')
+      expect(described_class::VERSION).to eq('0.1.1')
       expect(described_class::VERSION).to be_frozen
     end
   end

data/sys-memory.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-memory'
-  spec.version    = '0.1.0'
+  spec.version    = '0.1.1'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'
   spec.license    = 'Apache-2.0'
@@ -12,10 +12,8 @@ Gem::Specification.new do |spec|
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.cert_chain = ['certs/djberg96_pub.pem']
 
-  spec.extra_rdoc_files = Dir['*.rdoc']
-
   spec.add_dependency('ffi', "~> 1.1")
-  spec.add_dependency('activesupport', "~> 6.0")
+  spec.add_development_dependency('activesupport', "~> 6.0")
   spec.add_development_dependency('rspec', "~> 3.9")
   spec.add_development_dependency('rake', "~> 13.0")
 

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: sys-memory
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Daniel J. Berger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2021-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -58,7 +58,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -102,6 +102,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGES.md
 - Gemfile
 - LICENSE
 - README.md
@@ -125,7 +126,7 @@ metadata:
   documentation_uri: https://github.com/djberg96/sys-memory/wiki
   source_code_uri: https://github.com/djberg96/sys-memory
   wiki_uri: https://github.com/djberg96/sys-memory/wiki
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -140,8 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.25
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: A Ruby interface for providing memory information
 test_files: