sys-filesystem 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6334dc57daad97c3eaf9b0ce177abfa6792d13e106428e83646fbd1f6aa389d9
-  data.tar.gz: a9b0350667a8dfdb7afecd3acbc5604c5baabebea6674f2187810311e7e8bb1a
+  metadata.gz: baa1ca06971a27b95e31d7bd54db2b46f31b7e26169c4e69ed4044484db4d29b
+  data.tar.gz: 559a709c51890ffc12245eff51c5e42f3cb370b66bb0cc6642c71290b814f223
 SHA512:
-  metadata.gz: 7717c681b42ccd2be205d5d22f0f11be3a10ca70c6c91d95c87f8e104e0e4ada27725849bfdbef06a957af5c871affed1698aee553ce1dae50feca1236bff6e3
-  data.tar.gz: 88c377c758e9158a9980e3b9e9081e19f1c8c71d4613ea22e265b5d77510b81314b37a8a7a80f6466d2e8420cd1565169e58b9676a1281fcec0fee2fd4202bd0
+  metadata.gz: 9f7d98d8078417571438c1aa76afc5f0955ed08d8731a7afbb9f67b9590daaab8ba2226b3766ae850c4cece3aa1da8dd6cc21517bfeb727eb80249b5feb85469
+  data.tar.gz: c5b160edfc3988b9e6ab38ba0a3c2b551338a02006f181c3604446f17c6ad8771000c090f68adf28dbba467b22745ba86ad6bfebf85ad6b8d7af6ce1862a97bb

data/{CHANGES → CHANGES.rdoc}

@@ -1,3 +1,7 @@
+== 1.3.2 - 8-Dec-2019
+* Renamed various text files to include .rdoc extension so that github renders
+  them nicely.
+
 == 1.3.1 - 15-Oct-2019
 * Fixed a bug where the Statvfs and Statfs structs were not allocated properly
   on Linux, which could cause issues. Thanks go to Daniele Orlandi for the spot.

data/{MANIFEST → MANIFEST.rdoc}

@@ -1,7 +1,7 @@
-* MANIFEST
-* CHANGES
+* MANIFEST.rdoc
+* CHANGES.rdoc
 * Rakefile
-* README
+* README.rdoc
 * sys-fileystem.gemspec
 * certs/djberg96_pub.pem
 * examples/example_stat.rb

data/README.rdoc

@@ -0,0 +1,77 @@
+== Description
+A cross platform Ruby interface for getting file system information.
+
+== Installation
+  gem install sys-filesystem
+
+== Synopsis
+  require 'sys/filesystem'
+  include Sys
+   
+  # Display information about a particular filesystem.
+  p Filesystem.stat('/')
+
+  # Sample output
+
+  #<Sys::Filesystem::Stat:0x517440
+    @base_type = "ufs",
+    @flags = 4,
+    @files_available = 3817457,
+    @block_size = 8192,
+    @blocks_available = 19957633,
+    @blocks = 34349612,
+    @name_max = 255,
+    @path = "/",
+    @filesystem_id = 35651592,
+    @files = 4135040,
+    @fragment_size = 1024,
+    @files_free = 3817457,
+    @blocks_free = 20301129
+  >
+   
+  # Describe all mount points on the system
+  Filesystem.mounts{ |mount| p mount }
+   
+  # Find the mount point of any particular file
+  puts Filesystem.mount_point('/home/djberge/some_file.txt') => '/home'
+
+== Notes
+This is a pure Ruby implementation that uses FFI. This means it should work
+with JRuby, too.
+
+== Sample code
+Run 'rake example' if you want to see a basic sample run. The actual code
+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:
+
+  https://github.com/djberg96/sys-filesystem
+
+== Future Plans
+
+* Add better 64-bit support for Linux and BSD.
+* Other suggestions welcome.
+
+== Acknowledgements
+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.
+
+Nobuyoshi Miyokawa, for adding the original FreeBSD and OS X support.
+   
+== License
+Apache-2.0
+
+== Copyright
+(C) 2003-2019 Daniel J. Berger
+
+All Rights Reserved
+
+== Warranty
+This library is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantability and fitness for a particular purpose.
+
+== Author
+Daniel J. Berger

data/lib/sys/filesystem.rb

@@ -1,7 +1,7 @@
 module Sys
   class Filesystem
     # The version of the sys-filesystem library
-    VERSION = '1.3.1'.freeze
+    VERSION = '1.3.2'.freeze
   end
 end
 

data/sys-filesystem.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-filesystem'
-  spec.version    = '1.3.1'
+  spec.version    = '1.3.2'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'https://github.com/djberg96/sys-filesystem'
@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.cert_chain = Dir['certs/*']
    
-  spec.extra_rdoc_files  = ['CHANGES', 'README', 'MANIFEST']
+  spec.extra_rdoc_files = Dir['*.rdoc']
 
   spec.add_dependency('ffi')
   spec.add_development_dependency('rake')

data/test/test_sys_filesystem_unix.rb

@@ -27,7 +27,7 @@ class TC_Sys_Filesystem_Unix < Test::Unit::TestCase
   end
 
   test "version number is set to the expected value" do
-    assert_equal('1.3.1', Filesystem::VERSION)
+    assert_equal('1.3.2', Filesystem::VERSION)
     assert_true(Filesystem::VERSION.frozen?)
   end
 

data/test/test_sys_filesystem_windows.rb

@@ -20,7 +20,7 @@ class TC_Sys_Filesystem_Windows < Test::Unit::TestCase
   end
 
   test "version number is set to the expected value" do
-    assert_equal('1.3.1', Filesystem::VERSION)
+    assert_equal('1.3.2', Filesystem::VERSION)
     assert_true(Filesystem::VERSION.frozen?)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sys-filesystem
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -100,41 +100,41 @@ email: djberg96@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- CHANGES
-- README
-- MANIFEST
+- CHANGES.rdoc
+- MANIFEST.rdoc
+- README.rdoc
 files:
 - test
-- test/test_sys_filesystem_windows.rb
-- test/test_sys_filesystem_unix.rb
 - test/test_sys_filesystem.rb
-- CHANGES
-- MANIFEST
-- README
-- Rakefile
-- sys-filesystem.gemspec
-- certs
-- certs/djberg96_pub.pem
+- test/test_sys_filesystem_unix.rb
+- test/test_sys_filesystem_windows.rb
 - examples
 - examples/example_stat.rb
 - lib
-- lib/sys-filesystem.rb
 - lib/sys
 - lib/sys/unix
 - lib/sys/unix/sys
+- lib/sys/unix/sys/filesystem.rb
 - lib/sys/unix/sys/filesystem
-- lib/sys/unix/sys/filesystem/structs.rb
 - lib/sys/unix/sys/filesystem/constants.rb
 - lib/sys/unix/sys/filesystem/functions.rb
-- lib/sys/unix/sys/filesystem.rb
-- lib/sys/filesystem.rb
+- lib/sys/unix/sys/filesystem/structs.rb
 - lib/sys/windows
 - lib/sys/windows/sys
+- lib/sys/windows/sys/filesystem.rb
 - lib/sys/windows/sys/filesystem
-- lib/sys/windows/sys/filesystem/helper.rb
 - lib/sys/windows/sys/filesystem/constants.rb
 - lib/sys/windows/sys/filesystem/functions.rb
-- lib/sys/windows/sys/filesystem.rb
+- lib/sys/windows/sys/filesystem/helper.rb
+- lib/sys/filesystem.rb
+- lib/sys-filesystem.rb
+- Rakefile
+- certs
+- certs/djberg96_pub.pem
+- CHANGES.rdoc
+- MANIFEST.rdoc
+- README.rdoc
+- sys-filesystem.gemspec
 homepage: https://github.com/djberg96/sys-filesystem
 licenses:
 - Apache-2.0
@@ -165,6 +165,6 @@ signing_key:
 specification_version: 4
 summary: A Ruby interface for getting file system information.
 test_files:
-- test/test_sys_filesystem_windows.rb
-- test/test_sys_filesystem_unix.rb
 - test/test_sys_filesystem.rb
+- test/test_sys_filesystem_unix.rb
+- test/test_sys_filesystem_windows.rb

data/README

@@ -1,74 +0,0 @@
-= Description
-  A Ruby interface for getting file system information.
-
-= Installation
-  gem install sys-filesystem
-
-= Synopsis
-  require 'sys/filesystem'
-  include Sys
-   
-  # Display information about a particular filesystem.
-  p Filesystem.stat('/')
-
-  # Sample output
-
-  #<Sys::Filesystem::Stat:0x517440
-    @base_type = "ufs",
-    @flags = 4,
-    @files_available = 3817457,
-    @block_size = 8192,
-    @blocks_available = 19957633,
-    @blocks = 34349612,
-    @name_max = 255,
-    @path = "/",
-    @filesystem_id = 35651592,
-    @files = 4135040,
-    @fragment_size = 1024,
-    @files_free = 3817457,
-    @blocks_free = 20301129
-  >
-   
-  # Describe all mount points on the system
-  Filesystem.mounts{ |mount| p mount }
-   
-  # Find the mount point of any particular file
-  puts Filesystem.mount_point('/home/djberge/some_file.txt') => '/home'
-
-= Notes
-  This is a pure Ruby implementation that uses FFI. This means it should work
-  with JRuby, too.
-
-= Sample code
-  Run 'rake example' if you want to see a basic sample run. The actual code
-  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
-  https://github.com/djberg96/sys-filesystem
-
-= Future Plans
-  Add better 64-bit support for Linux and BSD.
-  Other suggestions welcome.
-
-= Acknowledgements
-  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.
-   
-  Nobuyoshi Miyokawa, for adding the original FreeBSD and OS X support.
-   
-= License
-  Apache-2.0
-
-= Copyright
-  (C) 2003-2019 Daniel J. Berger
-  All Rights Reserved
-
-= Warranty
-  This library is provided "as is" and without any express or
-  implied warranties, including, without limitation, the implied
-  warranties of merchantability and fitness for a particular purpose.
-
-= Author
-  Daniel J. Berger