solaris-file 0.3.1 → 0.3.2

data/CHANGES

@@ -1,3 +1,9 @@
+== 0.3.2 - 24-Jul-2007
+* Added a Rakefile with tasks for testing and installation.
+* Fixed an internal function name that conflicted with one in the acl.h file.
+  (I'm guessing this was a recent development for me not to notice until now).
+* Internal layout changes that don't affect you. 
+
 == 0.3.1 - 11-Jul-2006
 * Fixed a potential 64 bit bug in a struct declaration.
 * Minor RDoc updates, changes and internal cosmetic changes.
@@ -16,4 +22,4 @@
 * Added a gemspec.
 
 == 0.1.0 - 27-Jan-2005
-* Initial release.
+* Initial release.

data/MANIFEST

@@ -1,14 +1,11 @@
-extconf.rb
-MANIFEST
-README
-CHANGES
-solaris-file.gemspec
-
-examples/bar.txt
-examples/foo.txt
-examples/test.rb
-
-lib/solaris/sfile.c
-lib/solaris/sfile.h
-
-test/tc_solaris_file.rb
+* CHANGES
+* MANIFEST
+* README
+* Rakefile
+* solaris-file.gemspec
+* examples/bar.txt
+* examples/foo.txt
+* examples/test.rb
+* ext/solaris/sfile.c
+* ext/solaris/sfile.h
+* test/tc_solaris_file.rb

data/README

@@ -5,10 +5,13 @@
    Ruby 1.8.x
 
 == Installation
-   ruby extconf.rb
-   make
-   ruby test/tc_solaris_file.rb
-   make site-install
+=== Manual Installation
+   rake test (optional)
+   rake install
+
+=== Gem Install
+   rake test (optional)
+   rake install_gem
 
 == Synopsis
    require "solaris/file"
@@ -26,26 +29,26 @@
 
 == Class Methods
 File.acl_count(file_name)
-   Returns the number of ACL entries for the file.  Returns 0 if it's a
+   Returns the number of ACL entries for the file. Returns 0 if it's a
    trivial file.
 
 File.acl_read(file_name)
    Returns an Array of ACLStruct's or nil if file_name is a trivial file.
 
 Fiel.acl_read_text(file_name)
-   Returns a String form of the ACL entries for the file.  Returns nil if
+   Returns a String form of the ACL entries for the file. Returns nil if
    it's a trivial ACL.
 
 File.acl_write_text(file_name, acl_string)
-   Accepts a formatted ACL string that set the ACL for the file.  If the
+   Accepts a formatted ACL string that set the ACL for the file. If the
    string is badly formed, a File::SolarisError is raised.
    
 File.realpath(path)
-   Resolves all symbolic links in +path+.  Resolves to an absolute pathname
+   Resolves all symbolic links in +path+. Resolves to an absolute pathname
    where possible.
    
 File.resolvepath(path)
-   Resolves all symbolic links in +path+.  All "." components are removed, as
+   Resolves all symbolic links in +path+. All "." components are removed, as
    well as all nonleading ".." components and their preceding directory
    component.  If leading ".." components resolve to the root directory, they
    are replaced by "/".
@@ -56,14 +59,14 @@ File.trivial?(file_name)
    
 = Instance Methods
 File#acl_count
-   Returns the number of ACL entries for the file.  Returns 0 if it's a
+   Returns the number of ACL entries for the file. Returns 0 if it's a
    trivial file.
    
 File#acl_read
    Returns an Array of ACLStruct's.
    
 File#acl_read_text
-   Returns a String form of the ACL entries for the file.  Returns nil if
+   Returns a String form of the ACL entries for the file. Returns nil if
    it's a trivial ACL.
 
 File#acl_write_text(acl_string)
@@ -83,7 +86,7 @@ File::SolarisError < StandardError
    Raised if anything goes wrong with any of the above methods.
    
 == Known Bugs
-   None that I am aware of.  Please report any bugs using the tracker on the
+   None that I am aware of. Please report any bugs using the tracker on the
    project page at http://www.rubyforge.org/projects/solarisutils
    
 == Future Plans
@@ -92,21 +95,21 @@ File::SolarisError < StandardError
    Add support for extended file attributes.
    
 == Developer's Notes
-   This is a BETA release.  I have not totally settled on the API.
+   This is a BETA release. The code is stable, the API is not.
    
 == Copyright
-    (C) 2005, 2006 Daniel J. Berger
-    All Rights Reserved
+   (C) 2005-2007 Daniel J. Berger
+   All Rights Reserved
     
 == Warranty
-	This package 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.
+   This package 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.
 	
 == License
    Ruby's
     
 == Author
    Daniel J. Berger
-   djberg96 [at gmail dot com]
+   djberg96 [at nospam at gmail dot com]
    imperator on IRC (irc.freenode.net)

data/ext/extconf.rb

@@ -0,0 +1,10 @@
+require 'mkmf'
+require 'fileutils'
+
+dir_config('file')
+
+FileUtils.cp('solaris/sfile.c', '.')
+FileUtils.cp('solaris/sfile.h', '.')
+
+have_library('sec')
+create_makefile('solaris/file')

data/{lib → ext}/solaris/sfile.c

@@ -9,7 +9,7 @@
  * call-seq:
  *    File.acl_count(file_name)
  *
- * Returns the number of ACL entries for +file_name+.  Returns 0 if +file_name+
+ * Returns the number of ACL entries for +file_name+. Returns 0 if +file_name+
  * is a trivial file.
  */
 static VALUE acl_count(VALUE klass, VALUE v_path){
@@ -34,7 +34,7 @@ static VALUE acl_count(VALUE klass, VALUE v_path){
  * call-seq:
  *    File#acl_count
  *
- * Returns the number of ACL entries for the current handle.  Returns 0 if
+ * Returns the number of ACL entries for the current handle. Returns 0 if
  * the file is a trivial file.
  */
 static VALUE acl_icount(VALUE self){
@@ -115,10 +115,10 @@ static VALUE acl_read(VALUE klass, VALUE v_path){
  * Returns nil if the file is a trivial file.
  */
 static VALUE acl_iread(VALUE self){
+   int i;
    int num_acls = 0;
-   int fildes = FIX2INT(rb_funcall(self,rb_intern("fileno"),0,0));
+   int fildes = FIX2INT(rb_funcall(self, rb_intern("fileno"), 0, 0));
    VALUE v_array = Qnil;
-   int i;
 
    if( (num_acls = facl(fildes, GETACLCNT, 0, NULL)) == -1)
       rb_sys_fail(0);
@@ -152,7 +152,7 @@ static VALUE acl_iread(VALUE self){
  * call-seq:
  *    File.acl_read_text(file_name)
  * 
- * Returns a textual representation of the ACL for +file_name+.  If +file_name+
+ * Returns a textual representation of the ACL for +file_name+. If +file_name+
  * is a trivial file, nil is returned.
  */
 static VALUE acl_read_text(VALUE klass, VALUE v_path){
@@ -190,10 +190,10 @@ static VALUE acl_read_text(VALUE klass, VALUE v_path){
  * call-seq:
  *    File.acl_write_text(file_name, acl_text)
  *
- * Sets the ACL for +file_name+ using +acl_text+.  The +acl_text+ argument is a
+ * Sets the ACL for +file_name+ using +acl_text+. The +acl_text+ argument is a
  * human readable ACL text String.
  *
- * If +acl_text+ is invalid then a Solaris::FileError is raised, and in most
+ * If +acl_text+ is invalid then a Solaris::File::Error is raised, and in most
  * cases the offending entry number will be identified.
  */
 static VALUE acl_write_text(VALUE klass, VALUE v_path, VALUE v_text){
@@ -348,7 +348,7 @@ static VALUE acl_iread_text(VALUE self){
  * Returns true if +file_name+ is a trivial file, i.e. has no additional ACL
  * entries.  Otherwise, it returns false.
  */
-static VALUE acl_trivial(VALUE klass, VALUE v_path){
+static VALUE acl_is_trivial(VALUE klass, VALUE v_path){
    char pathp[PATH_MAX];
    int num_acls = 0;
    VALUE v_bool = Qfalse;
@@ -392,7 +392,7 @@ static VALUE acl_itrivial(VALUE self){
  * Adds ACL support for the File class on Solaris
  */
 void Init_file(){
-   /* Error Classes */
+   /* Error raised if an error occurs when reading or writing ACL properties */
    cSolarisFileError = rb_define_class_under(rb_cFile, "SolarisError",
       rb_eStandardError
    );
@@ -402,7 +402,7 @@ void Init_file(){
    rb_define_singleton_method(rb_cFile, "acl_read", acl_read, 1);
    rb_define_singleton_method(rb_cFile, "acl_read_text", acl_read_text, 1);
    rb_define_singleton_method(rb_cFile, "acl_write_text", acl_write_text, 2);
-   rb_define_singleton_method(rb_cFile, "trivial?", acl_trivial, 1);
+   rb_define_singleton_method(rb_cFile, "trivial?", acl_is_trivial, 1);
    rb_define_singleton_method(rb_cFile, "realpath", solaris_realpath, 1);
    rb_define_singleton_method(rb_cFile, "resolvepath", solaris_resolvepath, 1);
 
@@ -418,6 +418,6 @@ void Init_file(){
       "acl_type", "acl_id", "acl_perm", NULL
    );
 
-   /* Constants */
+   /* 0.3.2: The version of this library, returned as a String */
    rb_define_const(rb_cFile, "SOLARIS_VERSION", rb_str_new2(SOLARIS_VERSION));
 }

data/{lib → ext}/solaris/sfile.h

@@ -1,4 +1,4 @@
-#define SOLARIS_VERSION "0.3.1"
+#define SOLARIS_VERSION "0.3.2"
 #define MAX_STRING 512
 
 VALUE cSolarisFileError;

data/test/tc_solaris_file.rb

@@ -1,25 +1,15 @@
 ###############################################################################
 # tc_solaris_file.rb
 #
-# Test suite for the solaris-file package.
+# Test suite for the solaris-file package. You should run this test case
+# via the 'rake test' task.
 ###############################################################################
-base = File.basename(Dir.pwd)
-
-if base == "test" || base =~ /solaris-file.*/
-   require "ftools"
-   Dir.chdir("..") if base == "test"
-   Dir.mkdir("solaris") unless File.exists?("solaris")
-   File.copy("file.so","solaris")
-   $LOAD_PATH.unshift(Dir.pwd)
-   Dir.chdir("test") rescue nil
-end
-
-require "test/unit"
-require "solaris/file"
-require "open3"
+require 'test/unit'
+require 'solaris/file'
 
 class TC_Solaris_File < Test::Unit::TestCase
    def setup
+      Dir.chdir('test') unless File.basename(Dir.pwd) == 'test'
       @dir   = Dir.pwd
       @file  = "foo.txt" # trivial
       @file2 = "bar.txt" # non-trivial
@@ -37,7 +27,7 @@ class TC_Solaris_File < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal("0.3.1", File::SOLARIS_VERSION)
+      assert_equal("0.3.2", File::SOLARIS_VERSION)
    end
 
    # CLASS METHODS
@@ -148,9 +138,11 @@ class TC_Solaris_File < Test::Unit::TestCase
 
    def teardown
       @dir = nil
-      @file = nil
-      @file2 = nil
       @fh.close
       @fh2.close
+      File.delete(@file) if File.exists?(@file)
+      File.delete(@file2) if File.exists?(@file2)
+      @file = nil
+      @file2 = nil
    end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.4
 specification_version: 1
 name: solaris-file
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
-date: 2006-07-11 00:00:00 -06:00
+  version: 0.3.2
+date: 2007-07-24 00:00:00 -06:00
 summary: ACL and other methods for the File class on Solaris
 require_paths: 
 - lib
 email: djberg96@gmail.com
-homepage: http://www.rubyforge.org/projects/sysutils
-rubyforge_project: 
+homepage: http://www.rubyforge.org/projects/solarisutils
+rubyforge_project: solarisutils
 description: ACL and other methods for the File class on Solaris
 autorequire: 
 default_executable: 
@@ -18,35 +18,39 @@ bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      version: 0.0.0
+      version: 1.8.0
   version: 
 platform: ruby
 signing_key: 
 cert_chain: 
 post_install_message: 
 authors: 
-- Daniel Berger
+- Daniel J. Berger
 files: 
+- ext/extconf.rb
+- ext/solaris
+- ext/solaris/sfile.c
+- ext/solaris/sfile.h
+- test/tc_solaris_file.rb
+- examples/test.rb
+- README
 - CHANGES
 - MANIFEST
-- README
-- extconf.rb
-- lib/solaris/sfile.c
-- lib/solaris/sfile.h
-- examples/test.rb
 test_files: 
 - test/tc_solaris_file.rb
 rdoc_options: []
 
 extra_rdoc_files: 
-- CHANGES
 - README
+- CHANGES
+- MANIFEST
+- ext/solaris/sfile.c
 executables: []
 
 extensions: 
-- extconf.rb
+- ext/extconf.rb
 requirements: []
 
 dependencies: []

data/extconf.rb

@@ -1,8 +0,0 @@
-require "mkmf"
-require "ftools"
-
-File.copy("lib/solaris/sfile.c",".")
-File.copy("lib/solaris/sfile.h",".")
-
-have_library("sec")
-create_makefile("solaris/file")