get_process_mem 0.2.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06a96e8d978fd95bcf546a1e5e8bbc01cc10635d50b2f87639eb9c1f8c7f4f76
-  data.tar.gz: 6c941ae4f0301ff698b9be4ba75597537ed3ae5a11bf9295ab81144ef8435047
+  metadata.gz: '0497c51fa11f95206b380559a93991c3d22bc7b42c3c50e6c2455412bd518357'
+  data.tar.gz: 41f4d4dfce94cdabf6ec78a54665924867efd3c7b014693b75166793f8ae607b
 SHA512:
-  metadata.gz: 3cdb2baad08676298249f006b12f0c61bd0fdc1e13902211e2e0c3ea965c39fee2edb2ad3d2ceb617dcf450738e765c60c7e748830d85c52b044fa0ad8a3c8db
-  data.tar.gz: 35d717cc39f85a902adaa8ea6028d969b40b89465bcc0d1578de4e97308fe890e77ce9ff06b68855253030b3ab26fa130e2e44be06b041368a39a4cb4bc300f8
+  metadata.gz: 139c6ab3e913d199c8aa64fdfb4525f63e619e19f2410376bb0b19cf25930cfa849a3e1cd3f540363801bafa97c54cef75c720d7bdb5a701b5a732cf65797c13
+  data.tar.gz: 9d9c4d60f2fc78cfb2e3977857686286c6327cb32bf9e0ba7d4bafb4edb9fb76461ad11305d327aed2eacea437488622fff7a9a3b40ba55c14a0872832e55fb2

data/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.6
+          - 2.7
+          - 3.0
+          - 3.1
+          - 3.2
+          - 3.3
+          - head
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Ruby linting
+        run: bundle exec standardrb
+      - name: test
+        run: bundle exec rake test
+        continue-on-error: ${{ matrix.ruby == 'head' }}

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 2.6

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## HEAD (unreleased)
 
+## 1.0.0
+
+- Ensure PID is an integer (https://github.com/schneems/get_process_mem/pull/46)
+- Minimum Ruby version is now Ruby 2.6
+- Add `bigdecimal` as a dependency.
+
 ## 0.2.7
 
 - Native (faster) support for returning memory from different PIDs on mac (https://github.com/schneems/get_process_mem/pull/42)

data/Gemfile

@@ -1,4 +1,6 @@
 source "https://rubygems.org"
-gem 'sys-proctable'
+gem "sys-proctable"
 
 gemspec
+
+gem "standard"

data/README.md

@@ -1,7 +1,7 @@
 # Get Process Memory
 
-[![Build Status](https://travis-ci.org/schneems/get_process_mem.svg?branch=master)](https://travis-ci.org/schneems/get_process_mem)
-[![Help Contribute to Open Source](https://www.codetriage.com/schneems/get_process_mem/badges/users.svg)](https://www.codetriage.com/schneems/get_process_mem)
+[![CI](https://github.com/zombocom/get_process_mem/actions/workflows/ci.yml/badge.svg)](https://github.com/zombocom/get_process_mem/actions/workflows/ci.yml)
+[![Help Contribute to Open Source](https://www.codetriage.com/zombocom/get_process_mem/badges/users.svg)](https://www.codetriage.com/zombocom/get_process_mem)
 
 Do you need to get the memory usage of a process? Great because this library does that.
 

data/Rakefile

@@ -1,15 +1,13 @@
-# encoding: UTF-8
+require "bundler/gem_tasks"
 
-require 'bundler/gem_tasks'
+require "rake"
+require "rake/testtask"
 
-require 'rake'
-require 'rake/testtask'
+task default: [:test]
 
-task :default => [:test]
-
-test_task = Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end

data/get_process_mem.gemspec

@@ -1,24 +1,25 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'get_process_mem/version'
+require "get_process_mem/version"
 
 Gem::Specification.new do |gem|
-  gem.name          = "get_process_mem"
-  gem.version       = GetProcessMem::VERSION
-  gem.authors       = ["Richard Schneeman"]
-  gem.email         = ["richard.schneeman+rubygems@gmail.com"]
-  gem.description   = %q{ Get memory usage of a process in Ruby }
-  gem.summary       = %q{ Use GetProcessMem to find out the amount of RAM used by any process }
-  gem.homepage      = "https://github.com/schneems/get_process_mem"
-  gem.license       = "MIT"
+  gem.name = "get_process_mem"
+  gem.version = GetProcessMem::VERSION
+  gem.authors = ["Richard Schneeman"]
+  gem.email = ["richard.schneeman+rubygems@gmail.com"]
+  gem.description = " Get memory usage of a process in Ruby "
+  gem.summary = " Use GetProcessMem to find out the amount of RAM used by any process "
+  gem.homepage = "https://github.com/schneems/get_process_mem"
+  gem.license = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.require_paths = ["lib"]
 
+  gem.required_ruby_version = ">= 2.6"
+
   gem.add_dependency "ffi", "~> 1.0"
+  gem.add_dependency "bigdecimal", ">= 2.0"
 
   gem.add_development_dependency "sys-proctable", "~> 1.2"
   gem.add_development_dependency "rake", "~> 12"

data/lib/get_process_mem/darwin.rb

@@ -1,46 +1,42 @@
-require 'ffi'
+require "ffi"
 
 class GetProcessMem
   class Darwin
     extend FFI::Library
-    ffi_lib 'proc'
-
+    ffi_lib "proc"
 
     class TaskInfo < FFI::Struct
       layout :pti_virtual_size, :uint64,
-             :pti_resident_size, :uint64,
-             :pti_total_user, :uint64,
-             :pti_total_system, :uint64,
-             :pti_threads_user, :uint64,
-             :pti_threads_system, :uint64,
-             :pti_policy, :int32,
-             :pti_faults, :int32,
-             :pti_pageins, :int32,
-             :pti_cow_faults, :int32,
-             :pti_messages_sent, :int32,
-             :pti_messages_received, :int32,
-             :pti_syscalls_mach, :int32,
-             :pti_syscalls_unix, :int32,
-             :pti_csw, :int32,
-             :pti_threadnum, :int32,
-             :pti_numrunning, :int32,
-             :pti_priority, :int32
-
+        :pti_resident_size, :uint64,
+        :pti_total_user, :uint64,
+        :pti_total_system, :uint64,
+        :pti_threads_user, :uint64,
+        :pti_threads_system, :uint64,
+        :pti_policy, :int32,
+        :pti_faults, :int32,
+        :pti_pageins, :int32,
+        :pti_cow_faults, :int32,
+        :pti_messages_sent, :int32,
+        :pti_messages_received, :int32,
+        :pti_syscalls_mach, :int32,
+        :pti_syscalls_unix, :int32,
+        :pti_csw, :int32,
+        :pti_threadnum, :int32,
+        :pti_numrunning, :int32,
+        :pti_priority, :int32
     end
 
-
     attach_function :proc_pidinfo,
-                    [
-                      :int, #pid
-                      :int, # flavour
-                      :uint64, #arg, not needed for this selector
-                      TaskInfo.by_ref, #output buffer
-                      :int, #size of buffer
-                    ],
-                    :int
-
+      [
+        :int, # pid
+        :int, # flavour
+        :uint64, # arg, not needed for this selector
+        TaskInfo.by_ref, # output buffer
+        :int # size of buffer
+      ],
+      :int
 
-    PROC_PIDTASKINFO = 4 #from sys/proc_info.h
+    PROC_PIDTASKINFO = 4 # from sys/proc_info.h
 
     class << self
       def resident_size(pid)
@@ -55,7 +51,7 @@ class GetProcessMem
         if result == TaskInfo.size
           data
         else
-          raise SystemCallError.new("proc_pidinfo returned #{result}", FFI.errno);
+          raise SystemCallError.new("proc_pidinfo returned #{result}", FFI.errno)
         end
       end
     end

data/lib/get_process_mem/version.rb

@@ -1,3 +1,3 @@
 class GetProcessMem
-  VERSION = "0.2.7"
+  VERSION = "1.0.0"
 end

data/lib/get_process_mem.rb

@@ -1,5 +1,5 @@
-require 'pathname'
-require 'bigdecimal'
+require "pathname"
+require "bigdecimal"
 
 # Cribbed from Unicorn Worker Killer, thanks!
 class GetProcessMem
@@ -14,15 +14,15 @@ class GetProcessMem
   KB_TO_BYTE = number_to_bigdecimal 1024          # 2**10   = 1024
   MB_TO_BYTE = number_to_bigdecimal 1_048_576     # 1024**2 = 1_048_576
   GB_TO_BYTE = number_to_bigdecimal 1_073_741_824 # 1024**3 = 1_073_741_824
-  CONVERSION = { "kb" => KB_TO_BYTE, "mb" => MB_TO_BYTE, "gb" => GB_TO_BYTE }
-  ROUND_UP   = number_to_bigdecimal "0.5"
+  CONVERSION = {"kb" => KB_TO_BYTE, "mb" => MB_TO_BYTE, "gb" => GB_TO_BYTE}
+  ROUND_UP = number_to_bigdecimal "0.5"
   attr_reader :pid
 
   RUNS_ON_WINDOWS = Gem.win_platform?
 
   if RUNS_ON_WINDOWS
     begin
-      require 'sys/proctable'
+      require "sys/proctable"
     rescue LoadError => e
       message = "Please add `sys-proctable` to your Gemfile for windows machines\n"
       message << e.message
@@ -31,13 +31,13 @@ class GetProcessMem
     include Sys
   end
 
-  RUNS_ON_DARWIN =  Gem.platforms.detect do |p|
-                      p.is_a?(Gem::Platform) && p.os == 'darwin'
-                    end
+  RUNS_ON_DARWIN = Gem.platforms.detect do |p|
+    p.is_a?(Gem::Platform) && p.os == "darwin"
+  end
 
   if RUNS_ON_DARWIN
     begin
-      require 'get_process_mem/darwin'
+      require "get_process_mem/darwin"
     rescue LoadError => e
       message = "Please add `ffi` to your Gemfile for darwin (macos) machines\n"
       message << e.message
@@ -46,10 +46,10 @@ class GetProcessMem
   end
 
   def initialize(pid = Process.pid)
-    @status_file  = Pathname.new "/proc/#{pid}/status"
+    @status_file = Pathname.new "/proc/#{pid}/status"
     @process_file = Pathname.new "/proc/#{pid}/smaps"
-    @pid          = pid
-    @linux        = @status_file.exist?
+    @pid = Integer(pid)
+    @linux = @status_file.exist?
   end
 
   def linux?
@@ -57,32 +57,33 @@ class GetProcessMem
   end
 
   def bytes
-    memory =   linux_status_memory if linux?
+    memory = linux_status_memory if linux?
     memory ||= darwin_memory if RUNS_ON_DARWIN
     memory ||= ps_memory
+    memory
   end
 
   def kb(b = bytes)
-    (b/KB_TO_BYTE).to_f
+    (b / KB_TO_BYTE).to_f
   end
 
   def mb(b = bytes)
-    (b/MB_TO_BYTE).to_f
+    (b / MB_TO_BYTE).to_f
   end
 
   def gb(b = bytes)
-    (b/GB_TO_BYTE).to_f
+    (b / GB_TO_BYTE).to_f
   end
 
   def inspect
     b = bytes
-    "#<#{self.class}:0x%08x @mb=#{ mb b } @gb=#{ gb b } @kb=#{ kb b } @bytes=#{b}>" % (object_id * 2)
+    "#<#{self.class}:0x%08x @mb=#{mb b} @gb=#{gb b} @kb=#{kb b} @bytes=#{b}>" % (object_id * 2)
   end
 
   # linux stores memory info in a file "/proc/#{pid}/status"
   # If it's available it uses less resources than shelling out to ps
   def linux_status_memory(file = @status_file)
-    line = file.each_line.detect {|line| line.start_with? 'VmRSS'.freeze }
+    line = file.each_line.detect { |line| line.start_with? "VmRSS".freeze }
     return unless line
     return unless (_name, value, unit = line.split(nil)).length == 3
     CONVERSION[unit.downcase!] * value.to_i
@@ -92,13 +93,13 @@ class GetProcessMem
 
   # linux stores detailed memory info in a file "/proc/#{pid}/smaps"
   def linux_memory(file = @process_file)
-    lines = file.each_line.select {|line| line.match(/^Rss/) }
+    lines = file.each_line.select { |line| line.match(/^Rss/) }
     return if lines.empty?
     lines.reduce(0) do |sum, line|
-      line.match(/(?<value>(\d*\.{0,1}\d+))\s+(?<unit>\w\w)/) do |m|
+      line.match(/(?<value>\d*\.{0,1}\d+)\s+(?<unit>\w\w)/) do |m|
         value = number_to_bigdecimal(m[:value]) + ROUND_UP
-        unit  = m[:unit].downcase
-        sum  += CONVERSION[unit] * value
+        unit = m[:unit].downcase
+        sum += CONVERSION[unit] * value
       end
       sum
     end
@@ -114,7 +115,7 @@ class GetProcessMem
       number_to_bigdecimal(size)
     else
       mem = `ps -o rss= -p #{pid}`
-      KB_TO_BYTE * number_to_bigdecimal(mem == "" ? 0 : mem)
+      KB_TO_BYTE * number_to_bigdecimal((mem == "") ? 0 : mem)
     end
   end
 

data/test/get_process_mem_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require "test_helper"
 
 class GetProcessMemTest < Test::Unit::TestCase
   def setup
@@ -11,14 +11,23 @@ class GetProcessMemTest < Test::Unit::TestCase
     other_mem = GetProcessMem.new(pid)
     assert @mem.kb > other_mem.kb
   ensure
-    Process.kill('TERM', pid) if pid
+    Process.kill("TERM", pid) if pid
     Process.wait(pid) if pid
   end
 
+  def test_invalid_pid
+    raised_exception = false
+    GetProcessMem.new("ls")
+  rescue ArgumentError
+    raised_exception = true
+  ensure
+    assert raised_exception
+  end
+
   def test_seems_to_work
-    assert @mem.kb    > 0
-    assert @mem.mb    > 0
-    assert @mem.gb    > 0
+    assert @mem.kb > 0
+    assert @mem.mb > 0
+    assert @mem.gb > 0
     assert @mem.bytes > 0
   end
 
@@ -36,26 +45,26 @@ class GetProcessMemTest < Test::Unit::TestCase
   def test_conversions
     bytes = 0
     delta = BigDecimal("0.0000001")
-    assert_in_delta  0.0, @mem.kb(bytes), delta
-    assert_in_delta  0.0, @mem.mb(bytes), delta
-    assert_in_delta  0.0, @mem.gb(bytes), delta
+    assert_in_delta 0.0, @mem.kb(bytes), delta
+    assert_in_delta 0.0, @mem.mb(bytes), delta
+    assert_in_delta 0.0, @mem.gb(bytes), delta
 
     # kb
     bytes = 1024
-    assert_in_delta  1.0,                 @mem.kb(bytes), delta
-    assert_in_delta  0.0009765625,        @mem.mb(bytes), delta
-    assert_in_delta  9.5367431640625e-07, @mem.gb(bytes), delta
+    assert_in_delta 1.0, @mem.kb(bytes), delta
+    assert_in_delta 0.0009765625, @mem.mb(bytes), delta
+    assert_in_delta 9.5367431640625e-07, @mem.gb(bytes), delta
 
     # mb
     bytes = 1_048_576
-    assert_in_delta  1024.0,              @mem.kb(bytes), delta
-    assert_in_delta  1.0,                 @mem.mb(bytes), delta
-    assert_in_delta  0.0009765625,        @mem.gb(bytes), delta
+    assert_in_delta 1024.0, @mem.kb(bytes), delta
+    assert_in_delta 1.0, @mem.mb(bytes), delta
+    assert_in_delta 0.0009765625, @mem.gb(bytes), delta
 
     # gb
     bytes = 1_073_741_824
-    assert_in_delta  1048576.0,           @mem.kb(bytes), delta
-    assert_in_delta  1024.0,              @mem.mb(bytes), delta
-    assert_in_delta  1.0,                 @mem.gb(bytes), delta
+    assert_in_delta 1048576.0, @mem.kb(bytes), delta
+    assert_in_delta 1024.0, @mem.mb(bytes), delta
+    assert_in_delta 1.0, @mem.gb(bytes), delta
   end
 end

data/test/test_helper.rb

@@ -1,10 +1,10 @@
 Bundler.require
 
-require 'get_process_mem'
-require 'test/unit'
+require "get_process_mem"
+require "test/unit"
 
 def fixture_path(name = nil)
   path = Pathname.new(File.expand_path("../fixtures", __FILE__))
   return path.join(name) if name
   path
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: get_process_mem
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-27 00:00:00.000000000 Z
+date: 2024-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: sys-proctable
   requirement: !ruby/object:Gem::Requirement
@@ -74,7 +88,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/check_changelog.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".standard.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -101,19 +117,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Use GetProcessMem to find out the amount of RAM used by any process
-test_files:
-- test/fixtures/heroku-bash-smap
-- test/fixtures/heroku-bash-status
-- test/get_process_mem_test.rb
-- test/test_helper.rb
+test_files: []