sys-filesystem 1.1.1 → 1.1.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZGE1OWI0MWYwNTQ0OTFmNWZlMWVjOWZjYzVlNjkwNjFjYmU5MzdkOQ==
-  data.tar.gz: !binary |-
-    MDU1NzgzNDY5YjEyODA5NWI1NDBhZGE1YjVmYTk4MDEzOGYwOGM5YQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NzQ1NmJhMThiZDY0YTg0NDJjOTFkNGNlNzMxYWU4YjI5MmNhOTQ5ZjQ1N2Iy
-    MjQ3NmZmNTllZDkzODk2YmZlYWZmYjA5YWNmNTMxOGZhOWJmOWZlZDUxNzcx
-    N2Q2YmM2NWM1YTBjNzFiOGY0ZTlmYzczNTI1ODNmNzU0ODk3ZjQ=
-  data.tar.gz: !binary |-
-    ZGQ0ZWIzNTc3MWQwZmQwMGNhYzJiNjdiNjU3MDk0MjYxZWI3NzcxZjI0NGM0
-    MGE3MTUzOTVmOTlkYzg3MmQxMTk0MTMxMmZlYzI1MDA3ZTA5N2EyMzNmOTk4
-    NTJkZGRhNThhZTJiNGY1ZjA4ZWQwYTVmNGUxOWViZmQ3ZWFkZmQ=
+SHA1:
+  metadata.gz: 34f3ac9a042ae4f81d584a6c32aec6bd0365c12c
+  data.tar.gz: a5fa1fd3b884a0e10249fd7583ed64536d4448cc
+SHA512:
+  metadata.gz: bf773f2a53550dfac708332522396932f9830d0721476d8d6abaee17ed11f70d919f4b0b9bdc058a1214678138b74a660712f59b982deb10dbf8f1f69d9de4be
+  data.tar.gz: 3defee7ad40391abe85802270fb353a036190df7ed8ed1828c357cb2804344f1d4c8e31bbf1e0b04d90bfc60106ba2a5d69ba9ba64924619569a0c738490683d

data/CHANGES

@@ -1,3 +1,12 @@
+== 1.1.2 - 9-May-2014
+* Added the percent_used, bytes_total, bytes_free and bytes_used methods
+  to the Filesystem::Stat class. Thanks go to xanview for the suggestion.
+* Changed File.exists? to File.exist? to avoid warnings in Ruby 2.1.x.
+* The convenience methods to_mb, to_gb, etc, are now defined in Numeric
+  instead of Fixnum.
+* Added the to_tb method for terabytes.
+* Minor updates to the gem:create and gem:install Rake tasks.
+
 == 1.1.1 - 3-Oct-2013
 * Solaris now always uses statvfs64 on Solaris for better 64-bit support.
   Thanks go to Jeff Shantz for the spot.

data/README

@@ -44,7 +44,7 @@
   is 'example_stat.rb' in the 'examples' directory. Modify it as you see fit.
 
 = Known Bugs
-  None that I'm aware of.  Please report bugs on the project page at
+  None that I'm aware of. Please report bugs on the project page at
   https://github.com/djberg96/sys-filesystem
 
 = Future Plans
@@ -52,8 +52,7 @@
   Other suggestions welcome.
 
 = Acknowledgements
-  Mike Hall, for ideas and code that I borrowed from his 'filesystem'
-  library.
+  Mike Hall, for ideas and code that I borrowed from his 'filesystem' library.
    
   Park Heesob, for implementation and API ideas for the MS Windows version.
    
@@ -69,7 +68,7 @@
   http://www.gittip.com/djberg96/
 
 = Copyright
-  (C) 2003-2013 Daniel J. Berger
+  (C) 2003-2014 Daniel J. Berger
   All Rights Reserved
 
 = Warranty

data/Rakefile

@@ -24,7 +24,7 @@ end
 
 namespace :gem do
   desc "Build the sys-filesystem gem"
-  task :create do |t|
+  task :create => [:clean] do |t|
     spec = eval(IO.read('sys-filesystem.gemspec'))
     if Gem::VERSION >= "2.0.0"
       require 'rubygems/package'
@@ -37,7 +37,7 @@ namespace :gem do
   desc "Install the sys-filesystem gem"
   task :install => [:create] do
     file = Dir['*.gem'].first
-    sh "gem install #{file}"
+    sh "gem install -l #{file}"
   end
 end
 

data/lib/unix/sys/filesystem.rb

@@ -10,7 +10,7 @@ module Sys
     ffi_lib FFI::Library::LIBC
 
     # The version of the sys-filesystem library.
-    VERSION = '1.1.1'
+    VERSION = '1.1.2'
 
     private
 
@@ -103,9 +103,9 @@ module Sys
     }
 
     # File used to read mount informtion from.
-    if File.exists?('/etc/mtab')
+    if File.exist?('/etc/mtab')
       MOUNT_FILE = '/etc/mtab'
-    elsif File.exists?('/etc/mnttab')
+    elsif File.exist?('/etc/mnttab')
       MOUNT_FILE = '/etc/mnttab'
     else
       MOUNT_FILE = 'getmntinfo'
@@ -326,6 +326,26 @@ module Sys
         @name_max         = nil
         @base_type        = nil
       end
+
+      # Returns the total space on the partition.
+      def bytes_total
+        blocks * block_size
+      end
+
+      # Returns the total amount of free space on the partition.
+      def bytes_free
+        blocks_available * block_size
+      end
+
+      # Returns the total amount of used space on the partition.
+      def bytes_used
+        bytes_total - bytes_free
+      end
+
+      # Returns the percentage of the partition that has been used.
+      def percent_used
+        100 - (100.0 * bytes_free.to_f / bytes_total.to_f)
+      end
     end
 
     # Mount objects are returned by the Sys::Filesystem.mounts method.
@@ -548,7 +568,7 @@ module Sys
   end
 end
 
-class Fixnum
+class Numeric
   # Converts a number to kilobytes.
   def to_kb
     self / 1024
@@ -563,4 +583,9 @@ class Fixnum
   def to_gb
     self / 1073741824
   end
+
+  # Converts a number to terabytes.
+  def to_tb
+    self / 1099511627776
+  end
 end

data/lib/windows/sys/filesystem.rb

@@ -19,7 +19,7 @@ module Sys
     class Error < StandardError; end
 
     # The version of the sys-filesystem library.
-    VERSION = '1.1.1'
+    VERSION = '1.1.2'
 
     class Mount
       # The name of the volume. This is the device mapping.
@@ -55,7 +55,7 @@ module Sys
       # The path of the file system.
       attr_reader :path
 
-      # The file system block size.  MS Windows typically defaults to 4096.
+      # The file system block size. MS Windows typically defaults to 4096.
       attr_reader :block_size
 
       # Fragment size. Meaningless at the moment.
@@ -77,7 +77,7 @@ module Sys
       attr_reader :files
 
       # Total number of free files/inodes that can be created on the file
-      # system.  This attribute is always nil on MS Windows.
+      # system. This attribute is always nil on MS Windows.
       attr_reader :files_free
 
       # Total number of available files/inodes for unprivileged processes
@@ -97,9 +97,27 @@ module Sys
       # The file system type, e.g. NTFS, FAT, etc.
       attr_reader :base_type
 
+      # Returns the total amount of free space on the partition.
+      attr_reader :bytes_free
+
       alias inodes files
       alias inodes_free files_free
       alias inodes_available files_available
+
+      # Returns the total space on the partition.
+      def bytes_total
+        blocks * block_size
+      end
+
+      # Returns the total amount of used space on the partition.
+      def bytes_used
+        bytes_total - bytes_free
+      end
+
+      # Returns the percentage of the partition that has been used.
+      def percent_used
+        100 - (100.0 * bytes_free.to_f / bytes_total.to_f)
+      end
     end
 
     # Yields a Filesystem::Mount object for each volume on your system in
@@ -313,6 +331,7 @@ module Sys
       stat_obj.instance_variable_set(:@base_type, base_type)
       stat_obj.instance_variable_set(:@flags, flags)
       stat_obj.instance_variable_set(:@filesystem_id, vol_serial)
+      stat_obj.instance_variable_set(:@bytes_free, bytes_free)
 
       stat_obj.freeze # Read-only object
     end
@@ -367,28 +386,36 @@ end
 
 # Some convenient methods for converting bytes to kb, mb, and gb.
 #
-class Fixnum
+class Numeric
   # call-seq:
-  #  <tt>fix</tt>.to_kb
+  #  <tt>num</tt>.to_kb
   #
-  # Returns +fix+ in terms of kilobytes.
+  # Returns +num+ in terms of kilobytes.
   def to_kb
     self / 1024
   end
 
   # call-seq:
-  #  <tt>fix</tt>.to_mb
+  #  <tt>num</tt>.to_mb
   #
-  # Returns +fix+ in terms of megabytes.
+  # Returns +num+ in terms of megabytes.
   def to_mb
     self / 1048576
   end
 
   # call-seq:
-  #  <tt>fix</tt>.to_gb
+  #  <tt>num</tt>.to_gb
   #
-  # Returns +fix+ in terms of gigabytes.
+  # Returns +num+ in terms of gigabytes.
   def to_gb
     self / 1073741824
   end
+
+  # call-seq:
+  #  <tt>num</tt>.to_gb
+  #
+  # Returns +num+ in terms of terabytes.
+  def to_tb
+    self / 1099511627776
+  end
 end

data/sys-filesystem.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name      = 'sys-filesystem'
-  spec.version   = '1.1.1'
+  spec.version   = '1.1.2'
   spec.author    = 'Daniel J. Berger'
   spec.email     = 'djberg96@gmail.com'
   spec.homepage  = 'https://github.com/djberg96/sys-filesystem'

data/test/test_sys_filesystem_unix.rb

@@ -25,7 +25,7 @@ class TC_Sys_Filesystem_Unix < Test::Unit::TestCase
   end
 
   def test_version
-    assert_equal('1.1.1', Filesystem::VERSION)
+    assert_equal('1.1.2', Filesystem::VERSION)
   end
 
   def test_stat_path
@@ -124,14 +124,35 @@ class TC_Sys_Filesystem_Unix < Test::Unit::TestCase
     assert_not_nil(Filesystem::Stat::NOTRUNC)
   end
 
+  def test_stat_bytes_total
+    assert_respond_to(@stat, :bytes_total)
+    assert_kind_of(Numeric, @stat.bytes_total)
+  end
+
+  def test_stat_bytes_free
+    assert_respond_to(@stat, :bytes_free)
+    assert_kind_of(Numeric, @stat.bytes_free)
+  end
+
+  def test_stat_bytes_used
+    assert_respond_to(@stat, :bytes_used)
+    assert_kind_of(Numeric, @stat.bytes_used)
+  end
+
+  def test_stat_percent_used
+    assert_respond_to(@stat, :percent_used)
+    assert_kind_of(Float, @stat.percent_used)
+  end
+
   def test_stat_expected_errors
     assert_raises(ArgumentError){ Filesystem.stat }
   end
 
-  def test_fixnum_methods_basic
+  def test_numeric_methods_basic
     assert_respond_to(@size, :to_kb)
     assert_respond_to(@size, :to_mb)
     assert_respond_to(@size, :to_gb)
+    assert_respond_to(@size, :to_tb)
   end
 
   def test_to_kb

data/test/test_sys_filesystem_windows.rb

@@ -19,7 +19,7 @@ class TC_Sys_Filesystem_Windows < Test::Unit::TestCase
   end
 
   test "version number is set to the expected value" do
-    assert_equal('1.1.1', Filesystem::VERSION)
+    assert_equal('1.1.2', Filesystem::VERSION)
   end
 
   test "stat path works as expected" do
@@ -99,6 +99,26 @@ class TC_Sys_Filesystem_Windows < Test::Unit::TestCase
     assert_kind_of(String, @stat.base_type)
   end
 
+  test "stat bytes_total basic functionality" do
+    assert_respond_to(@stat, :bytes_total)
+    assert_kind_of(Numeric, @stat.bytes_total)
+  end
+
+  test "stat bytes_free basic functionality" do
+    assert_respond_to(@stat, :bytes_free)
+    assert_kind_of(Numeric, @stat.bytes_free)
+  end
+
+  test "stat bytes_used basic functionality" do
+    assert_respond_to(@stat, :bytes_used)
+    assert_kind_of(Numeric, @stat.bytes_used)
+  end
+
+  test "stat percent_used basic functionality" do
+    assert_respond_to(@stat, :percent_used)
+    assert_kind_of(Float, @stat.percent_used)
+  end
+
   test "mount_point singleton method basic functionality" do
     assert_respond_to(Filesystem, :mount_point)
     assert_nothing_raised{ Filesystem.mount_point(Dir.pwd) }

metadata

@@ -1,59 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: sys-filesystem
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-04 00:00:00.000000000 Z
+date: 2014-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   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: ! "    The sys-filesystem library provides an interface for gathering
-  filesystem\n    information, such as disk space and mount point data.\n"
+description: |2
+      The sys-filesystem library provides an interface for gathering filesystem
+      information, such as disk space and mount point data.
 email: djberg96@gmail.com
 executables: []
 extensions: []
@@ -63,17 +64,17 @@ extra_rdoc_files:
 - MANIFEST
 files:
 - CHANGES
+- MANIFEST
+- README
+- Rakefile
 - examples/example_stat.rb
 - lib/sys/filesystem.rb
 - lib/unix/sys/filesystem.rb
+- lib/windows/sys/filesystem.rb
 - lib/windows/sys/filesystem/constants.rb
 - lib/windows/sys/filesystem/functions.rb
 - lib/windows/sys/filesystem/helper.rb
 - lib/windows/sys/filesystem/structs.rb
-- lib/windows/sys/filesystem.rb
-- MANIFEST
-- Rakefile
-- README
 - sys-filesystem.gemspec
 - test/test_sys_filesystem.rb
 - test/test_sys_filesystem_unix.rb
@@ -88,17 +89,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: sysutils
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Ruby interface for getting file system information.