total 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 298d4a200e57232fd0eeba31fe62700ca8d18e0d6a9cee8417f1446ab74cb08d
-  data.tar.gz: 77875dad56ad2430b08ba649cd22100ea74a459e0260e0071804803670cc4b7c
+  metadata.gz: c2b318e9f39a42e339f249d53d84c9b804b2ac326080c1a553b90bb494ef83f7
+  data.tar.gz: edc9529d3e40c40e255bf9f804a69fc685b4edb317579980fc39a0020bc9ef35
 SHA512:
-  metadata.gz: c572de46c7fb05c17e3accb9ad75cbfa7bb66aafbdeaf050aaaa81f8bb3f103be3f4a90cb8b9a201f2e8947b7adb475e6f751866195d5e198da17e90e8e5bd9b
-  data.tar.gz: df28c5fa8984abe8fc4e1cc824b49f4e1b9c72d80941892b473fe3565ed804327d0126c0f61d7b91454270bec019a746260864062bbc7bdfaaa2e27c0bef466a
+  metadata.gz: 4482f27558e0e9a77ec815adc729e8659e7213632a4580c8fe3cf27ccdd876afbd43895ddc608b6e41a4ea05687dd53fa06409d16708995245468421a570ead5
+  data.tar.gz: 841d05c4dcb2aa8541542a608a48dbb51ada7096dc11b96b5cd6ade136d38d4e179e39a2cb980d5f1b9aa400eed5174c3c33e48fdf46e38203e1773c3917213e

data/.rubocop.yml

@@ -1,6 +1,6 @@
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.3.3
+  TargetRubyVersion: 2.3
 
 Layout/EmptyLineAfterGuardClause:
   Enabled: false

data/Gemfile

@@ -21,4 +21,5 @@
 # SOFTWARE.
 
 source 'https://rubygems.org'
+ruby '2.6.0'
 gemspec

data/README.md

@@ -22,6 +22,27 @@ require 'total'
 puts Total::Mem.new.bytes
 ```
 
+The following platforms are supported:
+
+  * MacOSX
+  * Linux
+  * FreeBSD
+  * <del>Windows</del> (help needed)
+
+If the platform is not recognized or is not supported, `Total::CantDetect` exception
+will be raised. You should catch it and proceed accordingly, for example:
+
+```ruby
+def total_mb
+  Total::Mem.new.bytes / (1024 * 1024)
+rescue Total::CantDetect
+  512
+end
+```
+
+This code will return the actual memory size in Mb, if it can be detected,
+or 512 otherwise.
+
 That's it.
 
 # How to contribute

data/lib/total.rb

@@ -23,6 +23,7 @@
 # SOFTWARE.
 
 require_relative 'total/linux'
+require_relative 'total/freebsd'
 require_relative 'total/osx'
 
 # Total is a simple class to detect the total amount of memory in the system.
@@ -53,6 +54,7 @@ module Total
     def target
       return Total::OSX.new if RUBY_PLATFORM.include?('darwin')
       return Total::Linux.new if RUBY_PLATFORM.include?('linux')
+      return Total::FreeBSD.new if RUBY_PLATFORM.include?('freebsd')
       raise CantDetect, "Can\'t detect operating system: #{RUBY_PLATFORM}"
     end
   end

data/lib/total/freebsd.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# FreeBSD specific.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+module Total
+  # FreeBSD specifics.
+  class FreeBSD
+    # Get the total in bytes
+    def memory
+      begin
+        `sysctl -a`.split("\n").each do |t|
+          return t.split(' ')[1].to_i if t.start_with?('hw.physmem:')
+        end
+      rescue Errno::ENOENT => e
+        raise CantDetect, e.message
+      end
+      raise CantDetect, 'Can\'t detect memory size via sysctl'
+    end
+  end
+end

data/test/total/test_freebsd.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'minitest/autorun'
+require_relative '../../lib/total/freebsd'
+
+# FreeBSD test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+class FreeBSDTest < Minitest::Test
+  def test_fetch_memory_size
+    skip unless RUBY_PLATFORM.include?('freebsd')
+    freebsd = Total::FreeBSD.new
+    assert(!freebsd.memory.nil?)
+    assert(freebsd.memory > 1024 * 1024)
+  end
+
+  def test_crashes_when_cant_detect
+    skip if RUBY_PLATFORM.include?('freebsd')
+    assert_raises Total::CantDetect do
+      Total::FreeBSD.new.memory
+    end
+  end
+end

data/total.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '2.3.3'
   s.required_ruby_version = '>=2.3'
   s.name = 'total'
-  s.version = '0.2.0'
+  s.version = '0.3.0'
   s.license = 'MIT'
   s.summary = 'Total memory calculator in Ruby'
   s.description = 'Get total memory size of the system'
@@ -45,6 +45,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'minitest', '5.11.3'
   s.add_development_dependency 'rake', '12.3.1'
   s.add_development_dependency 'rdoc', '4.3.0'
-  s.add_development_dependency 'rubocop', '0.60.0'
-  s.add_development_dependency 'rubocop-rspec', '1.30.1'
+  s.add_development_dependency 'rubocop', '0.62.0'
+  s.add_development_dependency 'rubocop-rspec', '1.31.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: total
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-28 00:00:00.000000000 Z
+date: 2019-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: 0.62.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: 0.62.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.30.1
+        version: 1.31.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.30.1
+        version: 1.31.0
 description: Get total memory size of the system
 email: yegor256@gmail.com
 executables: []
@@ -97,9 +97,11 @@ files:
 - README.md
 - Rakefile
 - lib/total.rb
+- lib/total/freebsd.rb
 - lib/total/linux.rb
 - lib/total/osx.rb
 - test/test_total.rb
+- test/total/test_freebsd.rb
 - test/total/test_linux.rb
 - test/total/test_osx.rb
 - total.gemspec
@@ -123,12 +125,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 2
 summary: Total memory calculator in Ruby
 test_files:
 - test/test_total.rb
+- test/total/test_freebsd.rb
 - test/total/test_linux.rb
 - test/total/test_osx.rb