RAliasFile 0.0.3 → 0.1.0

data/FILES

@@ -5,8 +5,8 @@ LICENSE
 ChangeLog
 ext/extconf.rb
 ext/raliasfile.c
-test/make_alias.scpt
-test/test_raliasfile.rb
+raliasfile.gemspec
 sample/make_alias.scpt
 sample/sample_raliasfile.rb
-raliasfile.gemspec
+test/make_alias.scpt
+test/test_raliasfile.rb

data/ext/raliasfile.c

@@ -13,14 +13,14 @@
  * Typical use from Ruby :
  *   raf=RAliasFile.new("/absolute/path/to/alias/file")
  *   
- *   raf.alias_path			# => returns the given input alias path
- *   raf.path_exists?		# => returns true if the alias path does exists on the file system, false otherwise
- *   raf.is_alias_file?		# => returns true if the alias is truly an alias file one, false otherwise
- *   raf.is_alias_broken?	# => returns true if alias is broken, false otherwise
- *   raf.resolved_path		# => returns the path of the alias target
- *   raf.was_aliased?		# => returns true if the alias is a correct alias file, false otherwise
- *   raf.is_folder_alias?	# => returns true if the target of the alias is a folder, false otherwise
- *   raf.is_file_alias?		# => returns true if the target of the alias is a file, false otherwise
+ *   raf.alias_path      # => returns the given input alias path
+ *   raf.path_exists?    # => returns true if the alias path does exists on the file system, false otherwise
+ *   raf.is_alias_file?    # => returns true if the alias is truly an alias file one, false otherwise
+ *   raf.is_alias_broken?  # => returns true if alias is broken, false otherwise
+ *   raf.resolved_path    # => returns the path of the alias target
+ *   raf.was_aliased?    # => returns true if the alias is a correct alias file, false otherwise
+ *   raf.is_folder_alias?  # => returns true if the target of the alias is a folder, false otherwise
+ *   raf.is_file_alias?    # => returns true if the target of the alias is a file, false otherwise
  */
 
 #include <CoreFoundation/CoreFoundation.h>
@@ -31,11 +31,17 @@
 VALUE cRAliasFile;
 
 /*
- * #initialize :
- *   Initialize all internal variables
+ * Initialize all internal variables
  */
-VALUE m_raliasfile_init(VALUE self, VALUE alias_path)
+VALUE m_raliasfile_init(int argc, VALUE* argv, VALUE self)
 {
+  VALUE alias_path, resolve_alias_chains;
+  Boolean resolveAliasChains;
+  resolveAliasChains = true;
+  rb_scan_args(argc, argv, "11", &alias_path, &resolve_alias_chains);
+  if (argc == 1) resolve_alias_chains=Qtrue;
+  if ((argc == 2) && (resolve_alias_chains == 0)) resolveAliasChains = false;
+
   char  resolved_path[512] = "";
   VALUE is_alias_file=Qfalse;
   VALUE path_exists=Qfalse;
@@ -58,7 +64,8 @@ VALUE m_raliasfile_init(VALUE self, VALUE alias_path)
       if(aliasFileFlag) {
         is_alias_file=Qtrue;
       }
-      FSResolveAliasFile(&theRef, true /*resolveAliasChains*/, &targetIsFolder, &wasAliased);
+
+      FSResolveAliasFile(&theRef, resolveAliasChains, &targetIsFolder, &wasAliased);
       CFURLRef resolvedUrl = CFURLCreateFromFSRef(NULL, &theRef);
       if (resolvedUrl != NULL) {
         CFStringRef theResolvedAliasPath = CFURLCopyFileSystemPath(resolvedUrl, kCFURLPOSIXPathStyle);
@@ -86,6 +93,7 @@ VALUE m_raliasfile_init(VALUE self, VALUE alias_path)
   rb_iv_set(self, "@path_exists", path_exists);
   rb_iv_set(self, "@is_alias_file", is_alias_file);
   rb_iv_set(self, "@is_alias_broken", broken);
+  rb_iv_set(self, "@is_resolve_alias_chains", resolve_alias_chains);
   rb_iv_set(self, "@was_aliased",  was_aliased);
   rb_iv_set(self, "@resolved_path", rb_str_new2(resolved_path));
   rb_iv_set(self, "@folder", folder);
@@ -96,83 +104,92 @@ VALUE m_raliasfile_init(VALUE self, VALUE alias_path)
 }
 
 /*
- * #alias_path= :
- *   set alias path to _alias_path
+ * Sets alias path to alias_path
  */
 VALUE m_set_alias_path(VALUE self,  VALUE alias_path) {
   rb_iv_set(self, "@alias_path", alias_path);
 }
 
 /*
- * #path_exists? :
- *   returns true if the path given for the alias file is on the file system, false otherwise
+ * returns true if the path given for the alias file is on the file system, false otherwise
  */
 VALUE m_path_exists(VALUE self) {
   return rb_iv_get(self, "@path_exists");
 }
 
 /*
- * #alias_path :
- *   returns the input path given for the alias file
+ * returns the input path given for the alias file
  */
 VALUE m_alias_path(VALUE self) {
   return rb_iv_get(self, "@alias_path");
 }
 
 /*
- * #is_alias_file? :
- *   returns true if the alias file is truly an alias file, false otherwise
+ * returns true if the alias file is truly an alias file, false otherwise
  */
 VALUE m_alias_file(VALUE self) {
   return rb_iv_get(self, "@is_alias_file");
 }
 
 /*
- * #is_alias_broken? :
- *   returns true if the alias file is broken (dead target), false otherwise
+ * returns true if the alias file is broken (dead target), false otherwise
  */
 VALUE m_alias_broken(VALUE self) {
   return rb_iv_get(self, "@is_alias_broken");
 }
 
 /*
- * #resolved_path :
- *   returns the path of the alias target
+ *   returns true by default or return the value passed as "resolve_alias_chains" arg
+ */
+VALUE m_resolve_alias_chains(VALUE self) {
+  return rb_iv_get(self, "@is_resolve_alias_chains");
+}
+
+/*
+ * Sets resolve_alias_chains to the given parameter.
+ *   NOTICE :
+ *       - this parameter is set to true by default when using :
+ *           -- raf=RAliasFile.new(mypath)
+ *       - this parameter is set to the given parameter "resolve_alias_chains" when using :
+ *           -- raf=RAliasFile.new(mypath, resolve_alias_chains)
+ */
+VALUE m_set_resolve_alias_chains(VALUE self) {
+  return rb_iv_get(self, "@is_resolve_alias_chains");
+}
+
+/*
+ * returns the path of the alias target
  */
 VALUE m_resolved_path(VALUE self) {
   return rb_iv_get(self, "@resolved_path");
 }
 
 /*
- * #was_aliased? :
- *   returns true if the alias file was aliased, false otherwise
+ * returns true if the alias file was aliased, false otherwise
  */
 VALUE m_was_aliased(VALUE self) {
   return rb_iv_get(self, "@was_aliased");
 }
 
 /*
- * #is_folder_alias? :
- *   returns true if the alias file points to a folder target, false otherwise
+ * returns true if the alias file points to a folder target, false otherwise
  */
 VALUE m_is_folder(VALUE self) {
   return rb_iv_get(self, "@folder");
 }
 
 /*
- * #is_file_alias? :
- *   returns true if the alias file points to a file target, false otherwise
+ * returns true if the alias file points to a file target, false otherwise
  */
 VALUE m_is_file(VALUE self) {
   return rb_iv_get(self, "@data_file");
 }
 
 /*
- * #version :
- *   returns the version of this class
+ * returns the version of this class
  */
 VALUE m_version(VALUE self) {
-  char *version = "0.0.3";
+  char *version = "0.1.0";
   return rb_str_new2(version);
 }
 
@@ -182,15 +199,17 @@ VALUE m_version(VALUE self) {
  */
 void Init_raliasfile() {
   cRAliasFile = rb_define_class("RAliasFile", rb_cObject);
-  rb_define_method(cRAliasFile, "initialize",            m_raliasfile_init, 1);
-  rb_define_method(cRAliasFile, "path_exists?",          m_path_exists, 0);
-  rb_define_method(cRAliasFile, "is_alias_file?",        m_alias_file, 0);
-  rb_define_method(cRAliasFile, "is_alias_broken?",      m_alias_broken, 0);
-  rb_define_method(cRAliasFile, "alias_path=",           m_set_alias_path, 1);
-  rb_define_method(cRAliasFile, "alias_path",            m_alias_path, 0);
-  rb_define_method(cRAliasFile, "resolved_path",         m_resolved_path, 0);
-  rb_define_method(cRAliasFile, "was_aliased?",          m_was_aliased, 0);
-  rb_define_method(cRAliasFile, "is_folder_alias?",      m_is_folder, 0);
-  rb_define_method(cRAliasFile, "is_file_alias?",        m_is_file, 0);
-  rb_define_singleton_method(cRAliasFile, "version",      m_version, 0);
+  rb_define_method(cRAliasFile, "initialize",                m_raliasfile_init, -1);
+  rb_define_method(cRAliasFile, "path_exists?",              m_path_exists, 0);
+  rb_define_method(cRAliasFile, "is_alias_file?",            m_alias_file, 0);
+  rb_define_method(cRAliasFile, "is_alias_broken?",          m_alias_broken, 0);
+  rb_define_method(cRAliasFile, "is_resolve_alias_chains?",  m_resolve_alias_chains, 0);
+  rb_define_method(cRAliasFile, "resolve_alias_chains=",     m_set_resolve_alias_chains, 0);
+  rb_define_method(cRAliasFile, "alias_path=",               m_set_alias_path, 1);
+  rb_define_method(cRAliasFile, "alias_path",                m_alias_path, 0);
+  rb_define_method(cRAliasFile, "resolved_path",             m_resolved_path, 0);
+  rb_define_method(cRAliasFile, "was_aliased?",              m_was_aliased, 0);
+  rb_define_method(cRAliasFile, "is_folder_alias?",          m_is_folder, 0);
+  rb_define_method(cRAliasFile, "is_file_alias?",            m_is_file, 0);
+  rb_define_singleton_method(cRAliasFile, "version",         m_version, 0);
 }

data/raliasfile.gemspec

@@ -1,3 +1,4 @@
+#!/usr/bin/env ruby
 #
 # raliasfile.gemspec
 #
@@ -6,15 +7,15 @@ require 'rubygems'
 
 spec = Gem::Specification.new do |s|
   s.name = 'RAliasFile'
-  s.version = "0.0.3"
+  s.version = "0.1.0"
 #  s.platform = Gem::Platform::RUBY::OSX
 #  s.platform = Gem::Platform::OSX
-  s.summary = "C ext to Ruby aimed to resolve alias file on Mac OS X 10.4+"
+  s.summary = "C ext to Ruby aimed to resolve alias file on Mac OS X 10.+"
   s.requirements << 'MacOS X 10.+'
-  s.files = File.read( 'FILES').split( $/)
+  s.files = File.read('FILES').split( $/)
   s.test_files = Dir.glob('test/test_*.rb') + Dir.glob('test/*.scpt')
   s.extensions << 'ext/extconf.rb'
-  s.has_rdoc = false
+  s.has_rdoc = true
   s.author = "Yvon Thoraval"
   s.email = "yvon_thoraval@mac.com"
   s.rubyforge_project = "RAliasFile"

data/sample/sample_raliasfile.rb

@@ -5,18 +5,39 @@
 
 require 'raliasfile'
 
+=begin
+HOW TO create an alias of alias :
+from Patrick Stadelmann <Patrick.Stadelmann-98E312.09302204092006@individual.net>
+Create a file "test" (e.g. with the "touch" command). Create an alias 
+"test alias" pointing to "test" then delete "test". Create an alias to 
+"my file alias" pointing to "my file". Rename "my file alias" to "test".
+
+You now have "test alias" pointing to "test", which is an alias pointing 
+to "my file". Indeed, if you delete "test" then "test alias" cannot be 
+resolved anymore".
+=end
+
 DESKTOP=ENV['HOME']+"/Desktop"
 TEST_DIR="#{DESKTOP}/raliasfile_tests"
-ORG_DIR="#{TEST_DIR}/alias/orig"
-BRK_DIR="#{TEST_DIR}/alias/orig/broken"
-ALS_DIR="#{TEST_DIR}/alias"
+ORG_DIR="#{TEST_DIR}/orig"
+BRK_DIR="#{TEST_DIR}/orig/broken"
 
 if(!FileTest.exists?("#{ORG_DIR}/good.txt"))
+
+  # build folders and files
   `mkdir -p "#{BRK_DIR}/broken"`
   `touch "#{BRK_DIR}/broken.txt"`
 
   `mkdir -p "#{ORG_DIR}/good"`
   `touch "#{ORG_DIR}/good.txt"`
+  `touch "#{ORG_DIR}/good/target"`
+
+  # build "true" alias of alias using Finder
+  `touch "#{ORG_DIR}/alias_chains_test"`
+  `osascript make_alias.scpt "#{ORG_DIR}/alias_chains_test" "alias_of_alias" "#{TEST_DIR}"`
+  `rm -f "#{ORG_DIR}/alias_chains_test"`
+  `touch "#{ORG_DIR}/a_target_file"`
+  `osascript make_alias.scpt "#{ORG_DIR}/a_target_file" "alias_chains_test" "#{ORG_DIR}"`
 
   # build array of "true" aliases
   to_alias=[]
@@ -26,7 +47,7 @@ if(!FileTest.exists?("#{ORG_DIR}/good.txt"))
   to_alias << "#{ORG_DIR}/good.txt"
 
   # build "true" aliases using Finder
-  to_alias.each {|a| `osascript make_alias.scpt "#{a}" "#{File.basename(a)}" "#{ALS_DIR}"`}
+  to_alias.each {|a| `osascript make_alias.scpt "#{a}" "#{File.basename(a)}" "#{TEST_DIR}"`}
 
   # remove "broken" dir to simulate broken aliases
   `rm -rf "#{BRK_DIR}"`
@@ -34,31 +55,37 @@ if(!FileTest.exists?("#{ORG_DIR}/good.txt"))
 end
 
 # array of sample pathes
-aliases=[["#{ALS_DIR}/broken"      , "*broken* alias file from target folder"],
-         ["#{ALS_DIR}/broken.txt"  , "*broken* alias file from target file"],
-         ["#{ALS_DIR}/good"        , "alias file from target folder"],
-         ["#{ALS_DIR}/good.txt"    , "alias file from target file"],
-         ["#{ORG_DIR}/good"        , "*wrong* alias file being a folder"],
-         ["#{ORG_DIR}/good.txt"    , "*wrong* alias file being a file"],
-         ["#{ALS_DIR}/bid/good"    , "*wrong* path to alias file being a *non-existing* folder"],
-         ["#{ALS_DIR}/bid/good.txt", "*wrong* path to alias file being a *non-existing* file"]
+aliases=[["#{TEST_DIR}/good"            , "path to alias file (from target folder)"],
+         ["#{TEST_DIR}/good.txt"        , "path to alias file (from target file)"],
+         ["#{TEST_DIR}/alias_of_alias"  , "path to alias file (from target alias file) resolve_alias_chains=true (by default)"],
+         ["#{TEST_DIR}/alias_of_alias"  , "path to alias file (from target alias file) resolve_alias_chains=false"],
+         ["#{TEST_DIR}/broken"          , "path to *broken* alias file (from target folder)"],
+         ["#{TEST_DIR}/broken.txt"      , "path to *broken* alias file (from target file)"],
+         ["#{ORG_DIR}/good"             , "path to *wrong* alias file being a folder"],
+         ["#{ORG_DIR}/good.txt"         , "path to *wrong* alias file being a file"],
+         ["#{TEST_DIR}/bid/good"        , "path to *wrong* alias file being a *non-existing* folder"],
+         ["#{TEST_DIR}/bid/good.txt"    , "path to *wrong* alias file being a *non-existing* file"]
          ]
 
 # "resolve" every sample pathes exploring all the methods
 puts "RAliasFile.version="+RAliasFile.version.to_s
+i=0
 aliases.each {|as|
   al,txt=as[0],as[1]
   puts "\n"
   puts "#{txt} : #{al}"
-  a=RAliasFile.new(al)
+  a=RAliasFile.new(al) if (i != 3)
+  a=RAliasFile.new(al, false) if (i == 3)
   puts "a.alias_path="+a.alias_path
   puts "a.path_exists?="+a.path_exists?.to_s
   puts "a.is_alias_file?="+a.is_alias_file?.to_s
   puts "a.is_alias_broken?="+a.is_alias_broken?.to_s
+  puts "a.is_resolve_alias_chains?="+a.is_resolve_alias_chains?.to_s
   puts "a.resolved_path="+a.resolved_path
   puts "a.was_aliased?="+a.was_aliased?.to_s
   puts "a.is_folder_alias?="+a.is_folder_alias?.to_s
   puts "a.is_file_alias?="+a.is_file_alias?.to_s
+  i+=1
 }
 
 # uncomment following line if you won't leave anything on your Desktop

data/test/test_raliasfile.rb

@@ -4,16 +4,15 @@
 #
 
 require 'rubyunit'
-require File.dirname(Dir.pwd)+"/osx/raliasfile/raliasfile"
+require "raliasfile"
 
 class RAliasFileTest < RUNIT::TestCase
 
   def setup
     # setup used dirs
     @test_dir="/private/tmp/raliasfile_tests"
-    @org_dir="#{@test_dir}/alias/orig"
-    @brk_dir="#{@test_dir}/alias/orig/broken"
-    @als_dir="#{@test_dir}/alias"
+    @org_dir="#{@test_dir}/orig"
+    @brk_dir="#{@test_dir}/orig/broken"
 
     # buid folder ans files to alias
     `mkdir -p "#{@brk_dir}/broken"`
@@ -21,6 +20,13 @@ class RAliasFileTest < RUNIT::TestCase
     `mkdir -p "#{@org_dir}/good"`
     `touch "#{@org_dir}/good.txt"`
 
+    # build "true" alias of alias using Finder
+    `touch "#{@org_dir}/alias_chains_test"`
+    `osascript make_alias.scpt "#{@org_dir}/alias_chains_test" "alias_of_alias" "#{@test_dir}"`
+    `rm -f "#{@org_dir}/alias_chains_test"`
+    `touch "#{@org_dir}/a_target_file"`
+    `osascript make_alias.scpt "#{@org_dir}/a_target_file" "alias_chains_test" "#{@org_dir}"`
+
     # build array of "true" aliases
     to_alias=[]
     to_alias << "#{@brk_dir}/broken"
@@ -29,53 +35,61 @@ class RAliasFileTest < RUNIT::TestCase
     to_alias << "#{@org_dir}/good.txt"
 
     # build "true" aliases using Finder
-    to_alias.each {|a| `osascript make_alias.scpt "#{a}" "#{File.basename(a)}" "#{@als_dir}"`}
+    to_alias.each {|a| `osascript make_alias.scpt "#{a}" "#{File.basename(a)}" "#{@test_dir}"`}
 
     # remove "broken" dir to simulate broken aliases
     `rm -rf "#{@brk_dir}"`
 
     # array of sample aliases path
     @aliases=[]
-    @aliases << "#{@als_dir}/broken"
-    @aliases << "#{@als_dir}/broken.txt"
-    @aliases << "#{@als_dir}/good"
-    @aliases << "#{@als_dir}/good.txt"
+    @aliases << "#{@test_dir}/good"
+    @aliases << "#{@test_dir}/good.txt"
+    @aliases << "#{@test_dir}/alias_of_alias"
+    @aliases << "#{@test_dir}/alias_of_alias"
+    @aliases << "#{@test_dir}/broken"
+    @aliases << "#{@test_dir}/broken.txt"
     @aliases << "#{@org_dir}/good"
     @aliases << "#{@org_dir}/good.txt"
-    @aliases << "#{@als_dir}/bid/good"
-    @aliases << "#{@als_dir}/bid/good.txt"
+    @aliases << "#{@test_dir}/bid/good"
+    @aliases << "#{@test_dir}/bid/good.txt"
   end
 
   def test_alias
     # "resolve" every sample aliases path exploring all the methods
+    found=false
     @aliases.each {|al|
-      a=RAliasFile.new(al)
+      i=1 if found
+      i=0 if !found
+      found=(/.*alias_of_alias$/ === al)
+      a=RAliasFile.new(al) if (i == 0)
+      a=RAliasFile.new(al, false) if (i == 1)
+      stest=(i == 1)
       fil=(/.*\.txt$/ === al)
       brk=(/.*broken.*/ === al)
       org=(/.*\/orig\/.*/ === al)
       bid=(/.*\/bid\/.*/ === al)
-      orig=(brk)? "#{@brk_dir}/broken" : ((org)? "#{@org_dir}/good" : ((bid)? "#{@als_dir}/bid/good" : "#{@org_dir}/good"))
+      orig=(brk)? "#{@brk_dir}/broken" : ((org)? "#{@org_dir}/good" : ((bid)? "#{@test_dir}/bid/good" : ((found && !stest)? "#{@org_dir}/a_target_file" : ((found && stest)? "#{@org_dir}/alias_chains_test" : "#{@org_dir}/good"))))
       orig=orig+((fil)? ".txt" : "")
       path_exists=(bid)? false : true
       alias_file=(org || bid)? false : true
       broken=(brk || org || bid)? true : false
       was_aliased=(brk || org || bid)? false : true
-      file_alias=(fil && was_aliased)? true : false
-      folder_alias=(!fil && was_aliased)? true : false
+      file_alias=((fil && was_aliased) || found)? true : false
+      folder_alias=((!fil && was_aliased) && !found)? true : false
       assert al === a.alias_path
       assert path_exists === a.path_exists?
       assert alias_file === a.is_alias_file?
       assert broken === a.is_alias_broken?
       assert (orig === a.resolved_path) || (brk || org || bid)
       assert was_aliased === a.was_aliased?
-      assert folder_alias === a.is_folder_alias?
       assert file_alias === a.is_file_alias?
+      assert folder_alias === a.is_folder_alias?
     }
   end
   
   def teardown
     # clean up temp dir
-    `rm -rf "#{@test_dir}"`
+    #`rm -rf "#{@test_dir}"`
     STDERR.puts "\n"
     STDERR.puts "----- Now Finish RAliasFileTest -----"
   end

metadata

@@ -3,9 +3,9 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: RAliasFile
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2006-09-01 00:00:00 +02:00
-summary: C ext to Ruby aimed to resolve alias file on Mac OS X 10.4+
+  version: 0.1.0
+date: 2006-09-04 00:00:00 +02:00
+summary: C ext to Ruby aimed to resolve alias file on Mac OS X 10.+
 require_paths: 
 - lib
 email: yvon_thoraval@mac.com
@@ -15,7 +15,7 @@ description: RAliasFile is a C extension to Ruby aimed to resolve alias file on
 autorequire: 
 default_executable: 
 bindir: bin
-has_rdoc: false
+has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
   - - ">="
@@ -36,11 +36,11 @@ files:
 - ChangeLog
 - ext/extconf.rb
 - ext/raliasfile.c
-- test/make_alias.scpt
-- test/test_raliasfile.rb
+- raliasfile.gemspec
 - sample/make_alias.scpt
 - sample/sample_raliasfile.rb
-- raliasfile.gemspec
+- test/make_alias.scpt
+- test/test_raliasfile.rb
 test_files: 
 - test/test_raliasfile.rb
 - test/make_alias.scpt