xtendr 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+doc
+.yardoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Louis J. Scoras
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= xtendr
+
+Ruby FFI binding for accessing extended file attributes.
+
+== 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 (c) 2010 Louis J. Scoras. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "xtendr"
+    gem.summary = %Q{FFI binding for accessing extended file attributes.}
+    gem.description = %Q{Xtendr provides access to extended file system attributes. Ruby 1.9 compatible.}
+    gem.email = "louis.j.scoras@gmail.com"
+    gem.homepage = "http://github.com/ljsc/xtendr"
+    gem.authors = ["Louis J. Scoras"]
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |ydoc|
+    ydoc.options = %w[--no-private]
+  end
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/xtendr.rb

@@ -0,0 +1,136 @@
+require 'ffi'
+
+module Xtendr
+  # Module to contain attached foreign functions.
+  # @private
+  module FFI
+    extend ::FFI::Library
+    ffi_lib 'System'
+    attach_function 'setxattr', [:string, :string, :pointer, :int, :int, :int], :int
+    attach_function 'getxattr', [:string, :string, :pointer, :int, :int, :int], :int
+    attach_function 'listxattr', [:string, :pointer, :int, :int], :int
+    attach_function 'removexattr', [:string, :string, :int], :int
+  end
+
+  # Get the value of an extended attribute for the current object.  Calls
+  # `#to_s` on self to get the path to the file the attribute is set on.
+  #
+  # @param [String] attribute The extended attribute to retrieve.
+  # @return [String, nil] The value of the attribute, or nil if it is not set
+  #                       and no block is passed.
+  # @yield Block is run when the attribute is not found.
+  def getx(attribute, *opts)
+    getx! attribute, *opts
+  rescue Errno::ENOATTR
+    block_given? ? yield : nil
+  end
+
+  # Get the value of an extended attribute, raising an error if the attribute is
+  # not found.
+  #
+  # The bang version of getx works the the same way as `getx`, exept that when
+  # the attribute is not found. In that case, rather than returning `nil`, an
+  # ENOATTR error is raised.
+  # @raise [Errno::ENOATTR] Describes the attribute that couldn't be located.
+  # @param [String] attribute The extended attribute to retrieve.
+  # @return [String] The value of the requested attribute.
+  #
+  def getx!(attribute, *opts)
+    options = opts.include?(:no_follow) ? 1 : 0
+    len = FFI.getxattr(self.to_s, attribute, nil, 0, 0, options)
+    raise_error(attribute, ::FFI::LastError::error) if len < 0
+    buffer = ::FFI::Buffer.alloc_out(len)
+    FFI.getxattr(self.to_s, attribute, buffer, buffer.size, 0, options)
+    buffer.get_string(0, buffer.size)
+  end
+
+  # Set an extended attribute on a filesystem object.
+  # @param [String] attribute The extended attribute to retrieve.
+  # @param [String] value The value to set the extended attribute to.
+  # @param [Array<:create, :replace, :no_follow>] opts Optional flags which
+  #   influence how setting is done.
+  # @return [nil]
+  #
+  # *:create*:: Raises an error if the attribute already exists.
+  #
+  def setx(attribute, value, *opts)
+    retval = FFI.setxattr(self.to_s, attribute, value, value.size, 0, setx_options(*opts))
+    raise_error(nil, ::FFI::LastError::error) if retval < 0
+  end
+
+  private
+    # Set the correct bitfields on the options flag for setting operations
+    # @param [Array<:replace, :create, :no_follow>] syms
+    # @private
+    def setx_options(*syms)
+      options = 0x00
+      options |= 0x04 if syms.include?(:replace)
+      options |= 0x02 if syms.include?(:create)
+      options |= 0x01 if syms.include?(:no_follow)
+      options
+    end
+
+  public
+
+  # List all of the extended attribute for the object.
+  # @return [Array<String>] the list of all keys which have extended attributes
+  #   set.
+  def listx
+    len = FFI.listxattr(self.to_s, nil, 0, 0)
+    buffer = ::FFI::Buffer.alloc_out(len)
+    FFI.listxattr(self.to_s, buffer, buffer.size, 0)
+    buffer.get_bytes(0, buffer.size).split("\0")
+  end
+
+  # Removes the given extended attribute from the filesystem object.
+  # @param [String] attribute The attribute to remove the extended attribute
+  #   for.
+  # @return [nil]
+  def removex(attribute)
+    FFI.removexattr(self.to_s, attribute, 0)
+  end
+
+  # Remove all extended file attributes from the object
+  def remove_allx
+    listx.each do |attribute|
+      removex(attribute)
+    end
+  end
+
+  protected
+    def raise_error(msg, code)
+      if code == Errno::ENOATTR::Errno
+        raise Errno::ENOATTR.new(msg)
+      else
+        raise SystemCallError.new(msg, code)
+      end
+    end
+end
+
+class Errno::ENOATTR < SystemCallError
+  # FIXME: This works on Mac OS X (Snow Leopard), but this really shouldn't be
+  # hardcoded. Unfortunatly, we probably can't get the error number symbolically
+  # without a C extension, which defeats the purpose of using ffi.
+  Errno = 93
+
+  def initialize(msg=nil)
+    super(msg)
+  end
+end
+
+class XtendrProxy
+  def initialize(file)
+    @file = file
+  end
+
+  def to_s
+    @file
+  end
+
+  include Xtendr
+end
+
+def Xtendr(file)
+  XtendrProxy.new(file)
+end
+

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'xtendr'
+
+class Test::Unit::TestCase
+end

data/test/test_xtendr.rb

@@ -0,0 +1,106 @@
+require 'helper'
+require 'fileutils'
+
+class TestXtendr < Test::Unit::TestCase
+  include FileUtils
+
+  def setup
+    @store = Xtendr(__FILE__)
+  end
+
+  def teardown
+    Xtendr(__FILE__).remove_allx
+  end
+
+  def test_module
+    test_file = __FILE__
+    test_file.extend(Xtendr)
+    test_file.setx('module', 'Foobar')
+    assert_equal 'Foobar', test_file.getx('module')
+  end
+
+  def test_proxy
+    @store.setx('proxy', 'Foobar')
+    assert_equal 'Foobar', @store.getx('proxy')
+  end
+
+  def test_failing
+    assert_nothing_raised do
+      @store.getx('missing')
+    end
+  end
+
+  def test_failing_bang
+    assert_raises Errno::ENOATTR do
+      @store.getx!('missing')
+    end
+  end
+
+  def test_get_default
+    assert_equal 'default', @store.getx('remove') { 'default' }
+  end
+
+  def test_listing
+    @store.setx('listme', 'true')
+    @store.setx('me_too', 'true')
+    assert @store.listx.include?('listme')
+    assert @store.listx.include?('me_too')
+  end
+
+  def test_removal
+    @store.setx('hide', 'true')
+    @store.setx('seek', 'true')
+    @store.removex('hide')
+    assert !@store.listx.include?('hide')
+    assert @store.listx.include?('seek')
+  end
+
+  def test_remove_all
+    @store.setx('hide', 'true')
+    @store.setx('seek', 'true')
+    @store.remove_allx
+    assert !@store.listx.include?('hide')
+    assert !@store.listx.include?('seek')
+  end
+
+  def test_create_option
+    assert_nothing_raised do
+      @store.setx('createme', 'done!', :create)
+    end
+    assert_raise Errno::EEXIST do
+      @store.setx('createme', 'done!', :create)
+    end
+  end
+
+  def test_replace_option
+    assert_raise Errno::ENOATTR do
+      @store.setx('replaceme', 'done!', :replace)
+    end
+    @store.setx('replaceme', 'done!')
+    assert_nothing_raised do
+      @store.setx('replaceme', 'done!', :replace)
+    end
+  end
+
+  def test_link_nofollow
+    link_file = File.expand_path('./test_link', File.dirname(__FILE__))
+    ln_s __FILE__, link_file
+    link_store = Xtendr(link_file)
+    link_store.setx('dontfollow', 'justdont', :create, :no_follow)
+    assert_nil @store.getx('dontfollow')
+    assert_equal 'justdont', link_store.getx('dontfollow', :no_follow)
+  ensure
+    rm link_file
+  end
+
+  def test_link_follow
+    link_file = File.expand_path('./test_link', File.dirname(__FILE__))
+    ln_s __FILE__, link_file
+    link_store = Xtendr(link_file)
+    link_store.setx('dontfollow', 'justdont', :create)
+    assert_equal 'justdont', @store.getx('dontfollow')
+    assert_nil link_store.getx('dontfollow', :no_follow)
+  ensure
+    rm link_file
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: xtendr
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Louis J. Scoras
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-22 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Xtendr provides access to extended file system attributes. Ruby 1.9 compatible.
+email: louis.j.scoras@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/xtendr.rb
+- test/helper.rb
+- test/test_xtendr.rb
+has_rdoc: true
+homepage: http://github.com/ljsc/xtendr
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: FFI binding for accessing extended file attributes.
+test_files: 
+- test/helper.rb
+- test/test_xtendr.rb