ffi-xattr 0.0.3 → 0.0.4

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+/doc/

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+before_script:
+  - sudo mount / -o remount,user_xattr

data/README.md

@@ -3,23 +3,21 @@ ffi-xattr
 
 Ruby library to manage extended file attributes.
 
+[![Build Status](https://secure.travis-ci.org/jarib/ffi-xattr.png)](http://travis-ci.org/jarib/ffi-xattr)
+
+
 Example
 -------
 
     xattr = Xattr.new("/path/to/file")
     xattr['user.foo'] = 'bar'
-    
+
     xattr['user.foo'] #=> 'bar'
     xattr.list        #=> ["user.foo"]
-    
+
     xattr.each { |key, value| ... }
     xattr.as_json     #=> {"user.foo" => "bar"}
 
-TODO
-----
-
-* Handle symlinks
-
 
 Note on Patches/Pull Requests
 -----------------------------

data/Rakefile

@@ -1,3 +1,5 @@
+include Rake::DSL
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 

data/ffi-xattr.gemspec

@@ -14,8 +14,10 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "ffi-xattr"
 
-  s.add_development_dependency "rspec", "~> 2.5"
+
   s.add_dependency "ffi"
+  s.add_development_dependency "rspec", "~> 2.5"
+  s.add_development_dependency "rake", "~> 0.9.2"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/ffi-xattr/darwin_lib.rb

@@ -1,4 +1,4 @@
-class Xattr
+class Xattr # :nodoc: all
   module Lib
     extend FFI::Library
 
@@ -9,32 +9,39 @@ class Xattr
     attach_function :setxattr,    [:string, :string, :pointer, :size_t, :uint, :int], :int
     attach_function :removexattr, [:string, :string, :int], :int
 
+    XATTR_NOFOLLOW = 0x0001
 
-    def self.list(path)
-      size = listxattr(path, nil, 0, 0)
-      res_ptr = FFI::MemoryPointer.new(:pointer, size)
-      listxattr(path, res_ptr, size, 0)
+    class << self
+      def list(path, no_follow)
+        options = no_follow ? XATTR_NOFOLLOW : 0
+        size = listxattr(path, nil, 0, options)
+        res_ptr = FFI::MemoryPointer.new(:pointer, size)
+        listxattr(path, res_ptr, size, options)
 
-      res_ptr.read_string(size).split("\000")
-    end
+        res_ptr.read_string(size).split("\000")
+      end
 
-    def self.get(path, key)
-      size = getxattr(path, key, nil, 0, 0, 0)
-      return unless size > 0
+      def get(path, no_follow, key)
+        options = no_follow ? XATTR_NOFOLLOW : 0
+        size = getxattr(path, key, nil, 0, 0, options)
+        return unless size > 0
 
-      str_ptr = FFI::MemoryPointer.new(:char, size);
-      getxattr(path, key, str_ptr, size, 0, 0)
+        str_ptr = FFI::MemoryPointer.new(:char, size)
+        getxattr(path, key, str_ptr, size, 0, options)
 
-      str_ptr.read_string
-    end
+        str_ptr.read_string
+      end
 
-    def self.set(path, key, value)
-      Error.check setxattr(path, key, value, value.bytesize, 0, 0)
-    end
+      def set(path, no_follow, key, value)
+        options = no_follow ? XATTR_NOFOLLOW : 0
+        Error.check setxattr(path, key, value, value.bytesize, 0, options)
+      end
 
-    def self.remove(path, key)
-      Error.check removexattr(path, key, 0)
+      def remove(path, no_follow, key)
+        options = no_follow ? XATTR_NOFOLLOW : 0
+        Error.check removexattr(path, key, options)
+      end
     end
 
   end
-end
+end

data/lib/ffi-xattr/error.rb

@@ -1,4 +1,4 @@
-class Xattr
+class Xattr # :nodoc: all
   module Error
     extend FFI::Library
 
@@ -6,15 +6,17 @@ class Xattr
 
     attach_function :strerror_r, [:int, :pointer, :size_t], :int
 
-    def self.last
-      ptr = FFI::MemoryPointer.new(:char, 256)
-      strerrror_r(FFI.errno, ptr, 256)
+    class << self
+      def last
+        ptr = FFI::MemoryPointer.new(:char, 256)
+        strerror_r(FFI.errno, ptr, 256)
 
-      ptr.read_string
-    end
+        ptr.read_string
+      end
 
-    def self.check(int)
-      raise last if int != 0
+      def check(int)
+        raise last if int != 0
+      end
     end
   end
-end
+end

data/lib/ffi-xattr/linux_lib.rb

@@ -1,4 +1,4 @@
-class Xattr
+class Xattr # :nodoc: all
   module Lib
     extend FFI::Library
 
@@ -11,31 +11,42 @@ class Xattr
     attach_function :getxattr,    [:string, :string, :pointer, :size_t], :int
     attach_function :removexattr, [:string, :string], :int
 
-    def self.list(path)
-      size = listxattr(path, nil, 0)
-      res_ptr = FFI::MemoryPointer.new(:pointer, size)
-      listxattr(path, res_ptr, size)
-
-      res_ptr.read_string(size).split("\000")
-    end
-
-    def self.get(path, key)
-      size = getxattr(path, key, nil, 0)
-      return unless size > 0
-
-      str_ptr = FFI::MemoryPointer.new(:char, size);
-      getxattr(path, key, str_ptr, size)
-
-      str_ptr.read_string
-    end
-
-    def self.set(path, key, value)
-      Error.check setxattr(path, key, value, value.bytesize, 0)
-    end
-
-    def self.remove(path, key)
-      Error.check removexattr(path, key.to_s)
+    attach_function :llistxattr,   [:string, :pointer, :size_t], :size_t
+    attach_function :lsetxattr,    [:string, :string, :pointer, :size_t, :int], :int
+    attach_function :lgetxattr,    [:string, :string, :pointer, :size_t], :int
+    attach_function :lremovexattr, [:string, :string], :int
+
+    class << self
+      def list(path, no_follow)
+        method = no_follow ? :llistxattr : :listxattr
+        size = send(method, path, nil, 0)
+        res_ptr = FFI::MemoryPointer.new(:pointer, size)
+        send(method, path, res_ptr, size)
+
+        res_ptr.read_string(size).split("\000")
+      end
+
+      def get(path, no_follow, key)
+        method = no_follow ? :lgetxattr : :getxattr
+        size = send(method, path, key, nil, 0)
+        return unless size > 0
+
+        str_ptr = FFI::MemoryPointer.new(:char, size)
+        send(method, path, key, str_ptr, size)
+
+        str_ptr.read_string
+      end
+
+      def set(path, no_follow, key, value)
+        method = no_follow ? :lsetxattr : :setxattr
+        Error.check send(method, path, key, value, value.bytesize, 0)
+      end
+
+      def remove(path, no_follow, key)
+        method = no_follow ? :lremovexattr : :removexattr
+        Error.check send(method, path, key)
+      end
     end
 
   end
-end
+end

data/lib/ffi-xattr/version.rb

@@ -1,5 +1,3 @@
 class Xattr
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end
-
-

data/lib/ffi-xattr.rb

@@ -14,35 +14,44 @@ end
 class Xattr
   include Enumerable
 
-  def initialize(path)
+  # Create a new Xattr instance with path.
+  # Use <tt>:no_follow => true</tt> in options to work on symlink itself instead of following it.
+  def initialize(path, options = {})
     raise Errno::ENOENT, path unless File.exist?(path)
     @path = path
+    @no_follow = !!options[:no_follow]
   end
 
+  # List extended attribute names
   def list
-    Lib.list @path
+    Lib.list @path, @no_follow
   end
 
+  # Get an extended attribute value
   def get(key)
-    Lib.get @path, key.to_s
+    Lib.get @path, @no_follow, key.to_s
   end
   alias_method :[], :get
 
+  # Set an extended attribute value
   def set(key, value)
-    Lib.set @path, key.to_s, value.to_s
+    Lib.set @path, @no_follow, key.to_s, value.to_s
   end
   alias_method :[]=, :set
 
+  # Remove an extended attribute value
   def remove(key)
-    Lib.remove @path, key.to_s
+    Lib.remove @path, @no_follow, key.to_s
   end
 
+  # Iterates over pairs of extended attribute names and values
   def each(&blk)
     list.each do |key|
       yield key, get(key)
     end
   end
 
+  # Returns hash of extended attributes
   def as_json(*args)
     res = {}
     each { |k,v| res[k] = v }
@@ -51,5 +60,3 @@ class Xattr
   end
 
 end
-
-

data/spec/xattr_spec.rb

@@ -35,6 +35,10 @@ describe Xattr do
     xattr.list.should == []
   end
 
+  it "raises error when tries to remove inexistent attribute" do
+    lambda { xattr.remove("inexisting") }.should raise_error
+  end
+
   it "returns nil if the attribute is not set" do
     xattr.get("hello").should be_nil
   end
@@ -71,4 +75,66 @@ describe Xattr do
     lambda { Xattr.new("no-such-file") }.should raise_error(Errno::ENOENT)
   end
 
+  describe "respecting :no_follow option" do
+    let(:link)   { "link.txt" }
+    let(:xattr_f) { Xattr.new(link, :no_follow => false) }
+    let(:xattr_n) { Xattr.new(link, :no_follow => true) }
+
+    before { File.symlink(path, link) }
+    after  { File.delete(link) }
+
+    case RUBY_PLATFORM
+    when /linux/
+      # http://linux.die.net/man/5/attr
+      it "should allow getting extended attributes on any type" do
+        xattr['user.a']
+        xattr_f['user.b']
+        xattr_n['user.c']
+      end
+
+      it "should fail setting extended attributes on symlink" do
+        lambda { xattr['user.a'] = 'foo' }.should_not raise_error
+        lambda { xattr_f['user.b'] = 'bar' }.should_not raise_error
+        lambda { xattr_n['user.c'] = 'baz' }.should raise_error
+      end
+    when /darwin|bsd/
+      it "should set and get attributes" do
+        xattr['user.a'] = 'foo'
+        xattr_f['user.b'] = 'bar'
+        xattr_n['user.c'] = 'baz'
+
+        xattr.list.sort.should == %w[user.a user.b]
+        xattr_f.list.sort.should == %w[user.a user.b]
+        xattr_n.list.sort.should == %w[user.c]
+
+        xattr['user.a'].should == 'foo'
+        xattr['user.b'].should == 'bar'
+        xattr['user.c'].should be_nil
+        xattr_f['user.a'].should == 'foo'
+        xattr_f['user.b'].should == 'bar'
+        xattr_f['user.c'].should be_nil
+        xattr_n['user.a'].should be_nil
+        xattr_n['user.b'].should be_nil
+        xattr_n['user.c'].should == 'baz'
+      end
+
+      it "should remove attributes" do
+        xattr['user.a'] = 'foo'
+        xattr_f['user.b'] = 'bar'
+        xattr_n['user.c'] = 'baz'
+        xattr_n['user.d'] = 'ban'
+
+        xattr.list.sort.should == %w[user.a user.b]
+        xattr_f.list.sort.should == %w[user.a user.b]
+        xattr_n.list.sort.should == %w[user.c user.d]
+
+        xattr_f.remove('user.a')
+        xattr_n.remove('user.c')
+
+        xattr.list.sort.should == %w[user.b]
+        xattr_f.list.sort.should == %w[user.b]
+        xattr_n.list.sort.should == %w[user.d]
+      end
+    end
+  end
 end

metadata

@@ -1,46 +1,79 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: ffi-xattr
-version: !ruby/object:Gem::Version
-  version: 0.0.3
+version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
 platform: ruby
-authors:
+authors: 
 - Jari Bakken
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-24 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &2164580140 !ruby/object:Gem::Requirement
+
+date: 2011-11-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :development
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: *2164580140
-- !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &2164578540 !ruby/object:Gem::Requirement
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 5
+        version: "2.5"
+  prerelease: false
+  name: rspec
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
   prerelease: false
-  version_requirements: *2164578540
+  name: rake
+  version_requirements: *id003
 description: Manipulate extended file attributes
-email:
+email: 
 - jari.bakken@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -54,27 +87,36 @@ files:
 - spec/xattr_spec.rb
 homepage: http://github.com/jarib/ffi-xattr
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: ffi-xattr
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Manipulate extended file attributes
-test_files:
+test_files: 
 - spec/xattr_spec.rb