ffi-xattr 0.0.2 → 0.0.3

data/LICENSE

@@ -0,0 +1,201 @@
+                              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
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2011 Jari Bakken
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,50 @@
+ffi-xattr
+=========
+
+Ruby library to manage extended file attributes.
+
+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
+-----------------------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright 2011 Jari Bakken
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/lib/ffi-xattr/darwin_lib.rb

@@ -0,0 +1,40 @@
+class Xattr
+  module Lib
+    extend FFI::Library
+
+    ffi_lib "System"
+
+    attach_function :listxattr,   [:string, :pointer, :size_t, :int], :ssize_t
+    attach_function :getxattr,    [:string, :string, :pointer, :size_t, :uint, :int], :ssize_t
+    attach_function :setxattr,    [:string, :string, :pointer, :size_t, :uint, :int], :int
+    attach_function :removexattr, [:string, :string, :int], :int
+
+
+    def self.list(path)
+      size = listxattr(path, nil, 0, 0)
+      res_ptr = FFI::MemoryPointer.new(:pointer, size)
+      listxattr(path, res_ptr, size, 0)
+
+      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
+
+      str_ptr = FFI::MemoryPointer.new(:char, size);
+      getxattr(path, key, str_ptr, size, 0, 0)
+
+      str_ptr.read_string
+    end
+
+    def self.set(path, key, value)
+      Error.check setxattr(path, key, value, value.bytesize, 0, 0)
+    end
+
+    def self.remove(path, key)
+      Error.check removexattr(path, key, 0)
+    end
+
+  end
+end

data/lib/ffi-xattr/error.rb

@@ -0,0 +1,20 @@
+class Xattr
+  module Error
+    extend FFI::Library
+
+    ffi_lib "c"
+
+    attach_function :strerror_r, [:int, :pointer, :size_t], :int
+
+    def self.last
+      ptr = FFI::MemoryPointer.new(:char, 256)
+      strerrror_r(FFI.errno, ptr, 256)
+
+      ptr.read_string
+    end
+
+    def self.check(int)
+      raise last if int != 0
+    end
+  end
+end

data/lib/ffi-xattr/linux_lib.rb

@@ -0,0 +1,41 @@
+class Xattr
+  module Lib
+    extend FFI::Library
+
+    ffi_lib "c"
+
+    attach_function :strerror, [:int], :string
+
+    attach_function :listxattr,   [:string, :pointer, :size_t], :size_t
+    attach_function :setxattr,    [:string, :string, :pointer, :size_t, :int], :int
+    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)
+    end
+
+  end
+end

data/lib/ffi-xattr/version.rb

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

data/lib/ffi-xattr.rb

@@ -1,19 +1,18 @@
 require 'ffi'
 require 'ffi-xattr/version'
+require 'ffi-xattr/error'
+
+case RUBY_PLATFORM
+when /linux/
+  require 'ffi-xattr/linux_lib'
+when /darwin|bsd/
+  require 'ffi-xattr/darwin_lib'
+else
+  raise NotImplementedError, "ffi-xattr not supported on #{RUBY_PLATFORM}"
+end
 
 class Xattr
-  module Lib
-    extend FFI::Library
-
-    ffi_lib "c"
-
-    attach_function :strerror, [:int], :string
-
-    attach_function :listxattr,   [:string, :pointer, :size_t], :size_t
-    attach_function :setxattr,    [:string, :string, :pointer, :size_t, :int], :int
-    attach_function :getxattr,    [:string, :string, :pointer, :size_t], :int
-    attach_function :removexattr, [:string, :string], :int
-  end
+  include Enumerable
 
   def initialize(path)
     raise Errno::ENOENT, path unless File.exist?(path)
@@ -21,38 +20,36 @@ class Xattr
   end
 
   def list
-    size = Lib.listxattr(@path, nil, 0)
-    res_ptr = FFI::MemoryPointer.new(:pointer, size)
-    Lib.listxattr(@path, res_ptr, size)
-
-    res_ptr.read_string(size).split("\000")
+    Lib.list @path
   end
 
   def get(key)
-    size = Lib.getxattr(@path, key.to_s, nil, 0)
-    return unless size > 0
-
-    str_ptr = FFI::MemoryPointer.new(:char, size);
-    Lib.getxattr(@path, key.to_s, str_ptr, size)
-
-    str_ptr.read_string
+    Lib.get @path, key.to_s
   end
+  alias_method :[], :get
 
   def set(key, value)
-    key, value = key.to_s, value.to_s
-
-    check_error Lib.setxattr(@path, key, value, value.bytesize, 0)
+    Lib.set @path, key.to_s, value.to_s
   end
+  alias_method :[]=, :set
 
   def remove(key)
-    check_error Lib.removexattr(@path, key.to_s)
+    Lib.remove @path, key.to_s
   end
 
-  private
+  def each(&blk)
+    list.each do |key|
+      yield key, get(key)
+    end
+  end
+
+  def as_json(*args)
+    res = {}
+    each { |k,v| res[k] = v }
 
-  def check_error(int)
-    raise "unable to set xattr (#{Lib.strerror FFI.errno})" if int != 0
+    res
   end
+
 end
 
 

data/spec/xattr_spec.rb

@@ -16,12 +16,17 @@ describe Xattr do
     xattr.set "user.foo", "bar"
     xattr.set "user.bar", "boo"
 
-    xattr.list.should == ["user.foo", "user.bar"]
+    xattr.list.sort.should == ["user.bar", "user.foo"]
 
     xattr.get("user.foo").should == "bar"
     xattr.get("user.bar").should == "boo"
   end
 
+  it "can get and set with #[] and #[]=" do
+    xattr['user.foo'] = 'baz'
+    xattr['user.foo'].should == 'baz'
+  end
+
   it "can remove attributes" do
     xattr.set "user.foo", "bar"
     xattr.list.should == ["user.foo"]
@@ -34,6 +39,34 @@ describe Xattr do
     xattr.get("hello").should be_nil
   end
 
+  it "can iterate over all attributes" do
+    xattr.set("user.hello", "world")
+
+    called = false
+    xattr.each do |key, value|
+      called = true
+
+      key.should == "user.hello"
+      value.should == "world"
+    end
+
+    called.should be_true
+  end
+
+  it "is Enumerable" do
+    xattr.should be_kind_of(Enumerable)
+
+    xattr['user.foo'] = 'bar'
+    xattr.to_a.should == [['user.foo', 'bar']]
+  end
+
+  it "returns a Hash for #as_json" do
+    xattr['user.foo'] = 'bar'
+    xattr['user.bar'] = 'baz'
+
+    xattr.as_json.should == {'user.foo' => 'bar', 'user.bar' => 'baz'}
+  end
+
   it "raises Errno::ENOENT if the file doesn't exist" do
     lambda { Xattr.new("no-such-file") }.should raise_error(Errno::ENOENT)
   end

metadata

@@ -1,82 +1,80 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ffi-xattr
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.3
   prerelease: 
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Jari Bakken
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-23 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2164580140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.5"
+      - !ruby/object:Gem::Version
+        version: '2.5'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: ffi
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2164580140
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: &2164578540 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *2164578540
 description: Manipulate extended file attributes
-email: 
+email:
 - jari.bakken@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
+- LICENSE
+- README.md
 - Rakefile
 - ffi-xattr.gemspec
 - lib/ffi-xattr.rb
+- lib/ffi-xattr/darwin_lib.rb
+- lib/ffi-xattr/error.rb
+- lib/ffi-xattr/linux_lib.rb
 - lib/ffi-xattr/version.rb
 - 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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      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