sys-memory 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb58ad679007156871e4cc8b3906546c10a634a04537b69b6021c9b83a7be18b
-  data.tar.gz: 464f3d02c1e96915808772ac2d66652d62c956a05f03054e246af893e8316a64
+  metadata.gz: a0f9fcf7bd91e41d398ad63d7aa5d62bf34a14a377700cd380696b9ba7fa6a48
+  data.tar.gz: 95deeb86473d5350521df7149a2c5ccc6343d72cbac104e28d72e8cecfe7b850
 SHA512:
-  metadata.gz: d5125dcc2e250ba8d4e4e513901321b397fd473f1934e5c7d3155bdda00ee5c75cd51d2e90e2cd7b7797d97279699237a3b574004f00f63a4bb2bb2788ed9f3a
-  data.tar.gz: 472f13e448c5ce16c7750a88f93e65283b22fce862bbe2c010210fbca2be2b0465bdd7c82dae4c08457773f026da10ccd5ac3157cf4c5c334c1daeb8f77dca42
+  metadata.gz: 7d461e046325569a7f9c3ddd25a285ed192c28512a777f7e2f3d4e44db4e9eb2768275162b7db8b41af61fdece3e1049f75554362b43e0b85b47a9c3063d3a63
+  data.tar.gz: ec8e318290a6c405240269323f0f3a97a0e1c0a650041006d899f58fd4d0760871df32d02b9634b0288284d8579ef38003d706ae1290675f7a7c556a93f67639

data/CHANGES.md

@@ -0,0 +1,12 @@
+## 0.1.2 - 9-Apr-2023
+* Added rubocop and rubocop-rspec as development dependencies.
+* Minor updates based on rubocop suggestions.
+* Added metadata.
+
+## 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/MANIFEST.md

@@ -0,0 +1,14 @@
+* CHANGES.md
+* Gemfile
+* LICENSE
+* MANIFEST.md
+* README.md
+* Rakefile
+* sys-memory.gemspec
+* certs/djberg96_pub.pem
+* lib/sys-memory.rb
+* lib/sys/version.rb
+* lib/sys/linux/memory.rb
+* lib/sys/osx/memory.rb
+* lib/sys/windows/memory.rb
+* spec/sys_memory_spec.rb

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,13 +26,10 @@ 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
-that I saw debated online. In short, you can choose to include swap memory
+"available memory". I've tried to accomodate both of the common approaches to
+it that I saw debated online. In short, you can choose to include swap memory
 as part of memory calculations or not as you see fit via an optional argument.
 
 You can also just use `Sys::Memory.memory` and collate the various hash data
@@ -36,13 +38,13 @@ pieces as you see fit.
 ## Known Bugs
 None that I'm aware of. Please report bugs on the project page at:
 
-https://github.com/djberg96/sys-cpu
+https://github.com/djberg96/sys-memory
 
 ## License
 Apache-2.0
 
 ## Copyright
-(C) 2021 Daniel J. Berger, All Rights Reserved
+(C) 2021-2023 Daniel J. Berger, All Rights Reserved
 
 ## Warranty
 This package is provided "as is" and without any express or

data/Rakefile

@@ -1,6 +1,7 @@
 require 'rake'
 require 'rake/clean'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 CLEAN.include('**/*.gem', '**/*.rbc', '**/*.rbx', '**/*.lock')
 
@@ -22,4 +23,6 @@ namespace 'gem' do
   end
 end
 
+RuboCop::RakeTask.new
+
 task :default => :spec

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.2'
   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.2')
       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.2'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'
   spec.license    = 'Apache-2.0'
@@ -12,20 +12,22 @@ 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('rspec', "~> 3.9")
-  spec.add_development_dependency('rake', "~> 13.0")
+  spec.add_dependency('ffi', '~> 1.1')
+  spec.add_development_dependency('activesupport', '~> 6.0')
+  spec.add_development_dependency('rspec', '~> 3.9')
+  spec.add_development_dependency('rake', '~> 13.0')
+  spec.add_development_dependency('rubocop')
+  spec.add_development_dependency('rubocop-rspec')
 
   spec.metadata = {
-    'homepage_uri'      => 'https://github.com/djberg96/sys-memory',
-    'bug_tracker_uri'   => 'https://github.com/djberg96/sys-memory/issues',
-    'changelog_uri'     => 'https://github.com/djberg96/sys-memory/blob/main/CHANGES.md',
-    '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'
+    'homepage_uri'          => 'https://github.com/djberg96/sys-memory',
+    'bug_tracker_uri'       => 'https://github.com/djberg96/sys-memory/issues',
+    'changelog_uri'         => 'https://github.com/djberg96/sys-memory/blob/main/CHANGES.md',
+    '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',
+    'rubygems_mfa_required' => 'true',
+    'github_repo'           => 'https://github.com/djberg96/sys-memory'
   }
 
   spec.description = <<-EOF

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: sys-memory
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 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: 2023-04-10 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:
@@ -93,6 +93,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-rspec
+  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'
 description: |2
       The sys-memory library provides an interface for gathering information
       about your system's memory. Information includes total physical memory,
@@ -102,8 +130,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGES.md
 - Gemfile
 - LICENSE
+- MANIFEST.md
 - README.md
 - Rakefile
 - certs/djberg96_pub.pem
@@ -125,7 +155,9 @@ 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: 
+  rubygems_mfa_required: 'true'
+  github_repo: https://github.com/djberg96/sys-memory
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -140,8 +172,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.3.26
+signing_key:
 specification_version: 4
 summary: A Ruby interface for providing memory information
 test_files: