ffi-xattr 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 03fc82a1353a14b6b48327682f8efb5327f8d4a6
-  data.tar.gz: dd6a2abd62dd605cb0aae1cb65551e69f4c2d00f
+SHA256:
+  metadata.gz: 4e89f2e515824d33bf4cfe74b95eea1526e35092c669bb5f4280c8d4c86071d4
+  data.tar.gz: 3369d3f39135d5176d1b24077eb380ff5140aa78498ccbd9f0b0291d2c36484c
 SHA512:
-  metadata.gz: f9cc1cbaab866ac3a6d89d7066b8621ba66eb36ac45032df2a59b0c92a7d57fc297d3db3ed02bed7d41c05aa00520690f84d182979feca7ec881f5eb0ad7200c
-  data.tar.gz: 73dc271860f7c541aac07195bdfe4cc3746bee9fa0755917967fe899f90ff91934b2f915230446f19bcbd947bda236a37cf372fb6aeb89d0d84840d02e68b244
+  metadata.gz: ea47fac5b6f82cf0c065724f3283bb72fe81f0636eb9613be1e7f89f42066e52cc038a8fa2d00ee12b8faa88f74dbb830f795eea1144ec7943f18bb40c134ef1
+  data.tar.gz: fd88cae5f42ca84e36214b76c82afedfd367c5e60e3767d786221ec62dbf95d9c9ea6ccf4e395ea55a2be9a66524bc015edad49b744505d7dcfca239b720145a

data/.gitignore

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

data/README.md

@@ -3,9 +3,6 @@ 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
 -------
 

data/lib/ffi-xattr/error.rb

@@ -16,7 +16,7 @@ class Xattr # :nodoc: all
       end
 
       def check(int)
-        raise SystemCallError.new(*last) if int != 0
+        raise SystemCallError.new(*last) if int < 0
       end
     end
   end

data/lib/ffi-xattr/extensions/file.rb

@@ -0,0 +1,9 @@
+require 'ffi-xattr'
+
+class File
+  
+  # Returns an Xattr object for the named file (see Xattr).
+  def self.xattr(file_name)
+    Xattr.new(file_name)
+  end
+end

data/lib/ffi-xattr/extensions/pathname.rb

@@ -0,0 +1,9 @@
+require 'ffi-xattr/extensions/file'
+
+class Pathname
+  # Returns an Xattr object.
+  # See File.xattr.
+  def xattr
+    File.xattr(self)
+  end
+end

data/lib/ffi-xattr/extensions.rb

@@ -0,0 +1,3 @@
+require 'ffi-xattr/extensions/file'
+require 'ffi-xattr/extensions/pathname'
+

data/lib/ffi-xattr/freebsd_lib.rb

@@ -0,0 +1,62 @@
+class Xattr # :nodoc: all
+  module Lib
+    extend FFI::Library
+
+    ffi_lib "c"
+
+    EXTATTR_NAMESPACE_USER = 1
+
+    attach_function :extattr_list_file,   [:string, :int, :pointer, :size_t], :ssize_t
+    attach_function :extattr_set_file,    [:string, :int, :string, :pointer, :size_t], :ssize_t
+    attach_function :extattr_get_file,    [:string, :int, :string, :pointer, :size_t], :ssize_t
+    attach_function :extattr_delete_file, [:string, :int, :string], :ssize_t
+
+    attach_function :extattr_list_link,   [:string, :int, :pointer, :size_t], :ssize_t
+    attach_function :extattr_set_link,    [:string, :int, :string, :pointer, :size_t], :ssize_t
+    attach_function :extattr_get_link,    [:string, :int, :string, :pointer, :size_t], :ssize_t
+    attach_function :extattr_delete_link, [:string, :int, :string], :ssize_t
+
+    class << self
+      def list(path, no_follow)
+        method = no_follow ? :extattr_list_link : :extattr_list_file
+        size = send(method, path, EXTATTR_NAMESPACE_USER, nil, 0)
+        res_ptr = FFI::MemoryPointer.new(:pointer, size)
+        send(method, path, EXTATTR_NAMESPACE_USER, res_ptr, size)
+
+        res = []
+        bytes = res_ptr.read_string(size).bytes
+        until bytes.empty?
+          size = bytes.shift
+          res << bytes.shift(size).map(&:chr).join
+        end
+
+        res
+      end
+
+      def get(path, no_follow, key)
+        method = no_follow ? :extattr_get_link : :extattr_get_file
+        size = send(method, path, EXTATTR_NAMESPACE_USER, key, nil, 0)
+        return unless size > 0
+
+        str_ptr = FFI::MemoryPointer.new(:char, size)
+        send(method, path, EXTATTR_NAMESPACE_USER, key, str_ptr, size)
+
+        str_ptr.read_string(size)
+      end
+
+      def set(path, no_follow, key, value)
+        method = no_follow ? :extattr_set_link : :extattr_set_file
+        #require 'byebug'
+        #byebug
+
+        Error.check send(method, path, EXTATTR_NAMESPACE_USER, key, value, value.bytesize)
+      end
+
+      def remove(path, no_follow, key)
+        method = no_follow ? :extattr_delete_link : :extattr_delete_file
+        Error.check send(method, path, EXTATTR_NAMESPACE_USER, key)
+      end
+    end
+
+  end
+end

data/lib/ffi-xattr/version.rb

@@ -1,3 +1,3 @@
 class Xattr
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/ffi-xattr.rb

@@ -5,6 +5,8 @@ require 'ffi-xattr/error'
 case RUBY_PLATFORM
 when /linux/
   require 'ffi-xattr/linux_lib'
+when /freebsd/
+  require 'ffi-xattr/freebsd_lib'
 when /darwin|bsd/
   require 'ffi-xattr/darwin_lib'
 when /mingw/
@@ -19,8 +21,16 @@ class Xattr
   # 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.to_str
+    @path =
+      if path.respond_to?(:to_path)
+        path.to_path
+      elsif path.respond_to?(:to_str)
+        path.to_str
+      else
+        path
+      end
+    raise Errno::ENOENT, @path unless File.exist?(@path)
+
     @no_follow = !!options[:no_follow]
   end
 
@@ -54,11 +64,17 @@ class Xattr
   end
 
   # Returns hash of extended attributes
-  def as_json(*args)
+
+  def to_hash
     res = {}
     each { |k,v| res[k] = v }
 
     res
   end
 
+  alias_method :to_h, :to_hash
+
+  def as_json(*args)
+    to_hash
+  end
 end

data/spec/extensions_spec.rb

@@ -0,0 +1,35 @@
+require 'ffi-xattr/extensions'
+
+describe "Xattr extensions" do
+  let(:path)  { "test.txt" }
+  let(:xattr) { Xattr.new(path) }
+
+  before { File.open(path, "w") { |io| io << "some content" } }
+  after  { File.delete(path) }
+
+  describe "File.xattr" do
+    it "should return an Xattr for the supplied path" do
+      x = File.xattr(path)
+
+      x.should be_kind_of(Xattr)
+
+      #and operate on the real path
+      x["user.file"] = "foo"
+      Xattr.new(path)["user.file"].should == "foo"
+    end
+  end
+
+  describe "Pathname#xattr" do
+    it "should return an Xattr for the underlying path" do
+      p = Pathname.new(path)
+      x = p.xattr
+
+      x.should be_kind_of(Xattr)
+      
+      #and operate on the real path
+      x["user.path"] = "foo"
+      Xattr.new(path)["user.path"].should == "foo"
+    end
+  end
+
+end

data/spec/xattr_spec.rb

@@ -57,7 +57,7 @@ describe Xattr do
       value.should == "world"
     end
 
-    called.should be_true
+    called.should == true
   end
 
   it "is Enumerable" do
@@ -67,11 +67,13 @@ describe Xattr do
     xattr.to_a.should == [['user.foo', 'bar']]
   end
 
-  it "returns a Hash for #as_json" do
+  it "returns a Hash for #to_hash, #to_h, #as_json" do
     xattr['user.foo'] = 'bar'
     xattr['user.bar'] = 'baz'
 
-    xattr.as_json.should == {'user.foo' => 'bar', 'user.bar' => 'baz'}
+    xattr.to_hash.should == {'user.foo' => 'bar', 'user.bar' => 'baz'}
+    xattr.to_h.should == {'user.foo' => 'bar', 'user.bar' => 'baz'}
+    xattr.as_json(foo: 1).should == {'user.foo' => 'bar', 'user.bar' => 'baz'}
   end
 
   it "raises Errno::ENOENT if the file doesn't exist" do
@@ -82,20 +84,22 @@ describe Xattr do
     lambda{ Xattr.new(1) }.should raise_error(TypeError)
   end
 
-  class SuperPath
-    def initialize(path)
-      @path = path
-    end
+  it "should work with object that can be converted to string" do
+    super_path = double("super_path")
+    super_path.should_receive(:to_str).and_return(path)
 
-    def to_str
-      @path.dup
-    end
+    Xattr.new(super_path).set('user.foo', 'bar')
+
+    Xattr.new(path).get('user.foo').should == 'bar'
   end
 
-  it "should work with object that can be directly converted to string" do
-    super_path = SuperPath.new(path)
-    Xattr.new(super_path).set('user.foo', 'bar')
-    Xattr.new(super_path).get('user.foo').should == 'bar'
+  it "should work with object that can be coerced to string with #to_path" do
+      to_path_obj = double("to_path")
+      to_path_obj.should_receive(:to_path).and_return(path)
+
+      Xattr.new(to_path_obj).set('user.to_path', 'bar')
+
+      Xattr.new(path).get('user.to_path').should == 'bar'
   end
 
   describe "respecting :no_follow option" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-xattr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jari Bakken
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-30 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -69,9 +69,14 @@ files:
 - lib/ffi-xattr.rb
 - lib/ffi-xattr/darwin_lib.rb
 - lib/ffi-xattr/error.rb
+- lib/ffi-xattr/extensions.rb
+- lib/ffi-xattr/extensions/file.rb
+- lib/ffi-xattr/extensions/pathname.rb
+- lib/ffi-xattr/freebsd_lib.rb
 - lib/ffi-xattr/linux_lib.rb
 - lib/ffi-xattr/version.rb
 - lib/ffi-xattr/windows_lib.rb
+- spec/extensions_spec.rb
 - spec/xattr_spec.rb
 homepage: http://github.com/jarib/ffi-xattr
 licenses: []
@@ -91,11 +96,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: ffi-xattr
-rubygems_version: 2.2.0
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Manipulate extended file attributes
 test_files:
+- spec/extensions_spec.rb
 - spec/xattr_spec.rb
-has_rdoc: