sys-filesystem 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f47e78baa2a2d0586d9dccbe36fc98a2683f0f0cc9828d70317ba7d2dc2aaa40
-  data.tar.gz: 8a887956f1a3c621057e93960e67871c646ae00f7cfe157d21ee0fd0f7d21bc7
+  metadata.gz: cf54720eed58f18d562942c0b1da0026bf0f814687de0fe5bab4cf49c90c39a3
+  data.tar.gz: 76baf71b511e2e36949d54b870f8f6d60d28fe0e735f4366cf69817e7359f09b
 SHA512:
-  metadata.gz: 66a048e0249d7147868c2a3a21468f5f292be47e82d19316d00d7dc5deab8a4c961bd363c55c55ac7e83d8992a0ecc71a3579ec4ca6e7a874308bd7f5e727aa7
-  data.tar.gz: 76ba77a00a187654367b01cacf2c282959fdbcaa3b2646075687a4f842ade1926bab0b38c51e60ac7b582f0633ce9ff27e32c349720788988a0e48cc5915c27a
+  metadata.gz: 3052ebcc1437f04d4e798856553f5567d016789e6936ac494ac3bf7b327bc0386a212e73e1664c58c48c6ee79aba76986a4130678e00f572d359bd75020e3e94
+  data.tar.gz: ad1b00477d3a8afef57768689120203356ec636a5bab122879a2fa764a5eec3ade92d10b105eea00a6807c7c41445a2f8dc25711564970a250a491bcf06d606e

data/{CHANGES → CHANGES.md}

@@ -1,8 +1,34 @@
-== 1.3.0 - 3-Oct-2019
+## 1.4.0 - 6-Sep-2020
+* The Sys::Filesystem.stat method now accepts a Pathname and Dir object as
+  an argument. On most platforms it will also accept a File object. Thanks
+  go to hirura for the patch.
+* Fixed the statvfs struct layout on i686 platforms. Thanks go to
+  Filipovici-Andrei for the patch.
+* Switched from test-unit to rspec, and updated the tests.
+
+## 1.3.4 - 17-Mar-2020
+* Properly include a LICENSE file as per the Apache-2.0 license.
+
+## 1.3.3 - 18-Feb-2020
+* Linux now uses statvfs64 under the hood. This fixes a potential issue with
+  32 bit systems. Thanks go to Tom Smyth for the spot.
+
+## 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.
+* Added specs to ensure that the FFI struct size matches the C struct size.
+  This required adding mkmf-lite as a development dependency.
+* Added a slightly more pessimistic version requirement for test-unit.
+
+## 1.3.0 - 3-Oct-2019
 * Added the mount and umount singleton methods.
 * Changed an internal class variable to a frozen constant.
 
-== 1.2.0 - 1-Jan-2019
+## 1.2.0 - 1-Jan-2019
 * Changed the license to Apache-2.0.
 * Added the case_sensitive? and case_insensitive? instance methods to the
   Filesystem::Stat class.
@@ -10,7 +36,7 @@
 * Fixed the deprecation warnings when running the tests on Windows.
 * Added metadata to the gemspec.
 
-== 1.1.9 - 26-Jan-2018
+## 1.1.9 - 26-Jan-2018
 * The bytes_free and bytes_total methods were updated to use the fragment size
   instead of the block size. This fixes Macs using APFS, as well as Solaris 10.
   Thanks go to Mikhail Vasin for the spot.
@@ -18,39 +44,39 @@
   to address the issue now resolved by the above change.
 * Updated the cert again.
 
-== 1.1.8 - 2-Sep-2017
+## 1.1.8 - 2-Sep-2017
 * The stat and mount_point methods now call to_s on the string argument
   explicitly so that Pathname objects will now work with String#wincode.
 * Updated some tests to avoid Fixnum warnings for Ruby 2.4.
 * Updated the cert.
 
-== 1.1.7 - 1-Aug-2016
+## 1.1.7 - 1-Aug-2016
 * Fixed an issue in the stat method for MS Windows where the blocks_avail
   value was not correct. Thanks go to Maxime Lapointe for the spot.
 
-== 1.1.6 - 17-May-2016
+## 1.1.6 - 17-May-2016
 * On versions that use setmntent or fopen, explicitly raise an error if
   either of those calls return a null value.
 
-== 1.1.5 - 5-Dec-2015
+## 1.1.5 - 5-Dec-2015
 * This gem is now signed.
 * The gem related tasks in the Rakefile now assume Rubygems 2.x.
 * Updates to the gemspec, added cert_chain, removed rubyforge_project.
 * Internal reorganization, and use of relative_require as appropriate.
 * Added a sys-filesystem.rb file for convenience.
 
-== 1.1.4 - 15-Mar-2015
+## 1.1.4 - 15-Mar-2015
 * The File.mounts method no longer raises an error if a mount point
   is not accessible. Thanks go to Michael Pope for the patch.
 * Some internal code reorganization.
 
-== 1.1.3 - 1-Oct-2014
+## 1.1.3 - 1-Oct-2014
 * Now ignores EPERM errors when trying to find the mount point for a path.
   Thanks go to petersen for the patch.
 * The Filesystem.stat method now defaults to using the root path on Windows
   for volume information.
 
-== 1.1.2 - 9-May-2014
+## 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.
@@ -59,30 +85,30 @@
 * Added the to_tb method for terabytes.
 * Minor updates to the gem:create and gem:install Rake tasks.
 
-== 1.1.1 - 3-Oct-2013
+## 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.
 
-== 1.1.0 - 19-Jan-2013
+## 1.1.0 - 19-Jan-2013
 * Converted the Windows source code to use FFI. Consequently, there is now
   a single gem rather than separate gems for Windows and Unix.
 * Revamped the Windows tests.
 
-== 1.0.0 - 11-Jan-2012
+## 1.0.0 - 11-Jan-2012
 * Converted everything from C to FFI for the Unix flavors. The Windows
   source code remains untouched.
 
-== 0.3.4 - 19-Nov-2010
+## 0.3.4 - 19-Nov-2010
 * Fixed a bug where negative block counts were happening on very large
   hard drives. Thanks go to Jonas Pfenniger for the spot.
 * Refactored the clean task in the Rakefile.
 * Some cosmetic source code changes.
 
-== 0.3.3 - 21-May-2010
+## 0.3.3 - 21-May-2010
 * Added a workaround for the Sys::Filesystem#block_size member to deal with
   a bug in OS X. Thanks go to Josh Pasqualetto for the spot.
 
-== 0.3.2 - 29-Dec-2009
+## 0.3.2 - 29-Dec-2009
 * Source has been moved to github.
 * Added the 'gem' task and removed build logic from the gemspec.
 * Updated the install task.
@@ -90,23 +116,23 @@
 * Removed some junk build files that were inadvertently included in
   the last gem.
 
-== 0.3.1 - 5-Aug-2009
+## 0.3.1 - 5-Aug-2009
 * Now compatible with Ruby 1.9.x.
 * Changed license to Artistic 2.0
 * Updated the gemspec, including the explicit addition of a license and
   test-unit as a development dependency, as well as an updated description. 
 
-== 0.3.0 - 26-Feb-2009
+## 0.3.0 - 26-Feb-2009
 * Added support for OS X and FreeBSD thanks to an awesome patch by Nobuyoshi
   Miyokawa.
 * Added the Filesystem.mount_point method that takes a file and returns
   the mount point it's sitting on.
 
-== 0.2.0 - 30-Dec-2008
+## 0.2.0 - 30-Dec-2008
 * Added the Filesystem.mounts method for iterating over mount or volume
   information.
 
-== 0.1.1 - 28-Mar-2007
+## 0.1.1 - 28-Mar-2007
 * Bug fix for BSD flavors.  Thanks go to Jeremy Kemper and Ole Christian
   Rynning for the spot.
 * Bug fix for OS X (along the same lines as the BSD fix). Thanks go to
@@ -115,5 +141,5 @@
 * Tweaks to the gemspec.
 * Added synopsis to the README.
 
-== 0.1.0 - 17-Nov-2006
+## 0.1.0 - 17-Nov-2006
 * Initial release.  Alpha. Code is stable, but API is not.

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org' do
+  gem 'ffi', '~> 1.1'
+  group 'test' do
+    gem 'mkmf-lite', '~> 0.4'
+    gem 'rake'
+    gem 'rspec', '~> 3.9'
+    gem 'fakefs', '~> 1.2'
+  end
+end

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/{MANIFEST → MANIFEST.md}

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

data/README.md

@@ -0,0 +1,87 @@
+## 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-2020 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