fsattr 0.0.2

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Yannick Koechlin
+
+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,21 @@
+= fsattr
+
+fsattr helps to set, get and list extended file attributes on os X and Linux.
+
+Help on adding Windows compatibilty would be nice.
+
+Usage:  
+
+f = File.open "/tmp/blah", "w"
+
+f.fsattr_set "hello", "world"
+
+f.fsattr_get "hello"
+
+f.fsattr_list
+
+f.close
+
+== Copyright
+
+Copyright (c) 2010 Yannick Koechlin. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fsattr"
+    gem.summary = %Q{modify extended filesystem attributes on linux and os x}
+    gem.description = %Q{modify extended filesystem attributes on linux and os x}
+    gem.email = "yannick@koechlin.info"
+    gem.homepage = "http://github.com/yannick/fsattr"
+    gem.authors = ["Yannick Koechlin"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 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
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fsattr #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/fsattr.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fsattr}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Yannick Koechlin"]
+  s.date = %q{2010-04-30}
+  s.description = %q{modify extended filesystem attributes on linux and os x}
+  s.email = %q{yannick@koechlin.info}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "fsattr.gemspec",
+     "lib/fsattr.rb",
+     "lib/fsattr/fsattr-linux.rb",
+     "lib/fsattr/fsattr-osx.rb",
+     "test/helper.rb",
+     "test/test_fsattr.rb"
+  ]
+  s.homepage = %q{http://github.com/yannick/fsattr}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{modify extended filesystem attributes on linux and os x}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_fsattr.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/fsattr.rb

@@ -0,0 +1,58 @@
+require 'ffi'
+require 'sysinfo'
+
+
+
+File.class_eval do
+
+  if (SysInfo.new.impl == :osx)
+    require 'lib/fsattr/fsattr-osx'
+    include FSattrOSX 
+  end
+  if (SysInfo.new.impl == :linux)
+    require 'lib/fsattr/fsattr-linux'
+    include FSattrLinux 
+  end
+  alias_method :fsattr_get, :fsattr_fget
+  alias_method :fsattr_set, :fsattr_fset
+  alias_method :fsattr_list, :fsattr_flist
+
+end
+
+
+#todo: not complete
+class FSattr 
+
+  include Enumerable 
+  include FSattrOSX if (SysInfo.new.impl == :osx)
+  include FSattrLinux if (SysInfo.new.impl == :linux)
+
+  attr_accessor :path
+
+  alias_method :get, :fsattr_pget
+  alias_method :set, :fsattr_pset
+  alias_method :list, :fsattr_plist
+
+  def initialize(path)
+    @path = path
+  end
+
+  def each
+    list
+  end
+
+  def [](key)
+    get key
+  end
+
+  def []=(key, val)
+    set key, val
+  end
+
+
+
+end
+
+
+
+

data/lib/fsattr/fsattr-linux.rb

@@ -0,0 +1,78 @@
+#provides bindings for hfs+ filesystem attributes via FFI
+#TODO: difference between root and user attributes. currently only user attributes are supported
+
+module FSattrLinux
+
+  extend FFI::Library
+  ffi_lib 'attr'
+  
+  #ssize_t getxattr(const char *path, const char *name, void *value, size_t size, u_int32_t position, int options);
+  attach_function 'getxattr', [ :string, :string, :string, :size_t, :uint, :int ], :int
+
+  #ssize_t fgetxattr(int fd, const char *name, void *value, size_t size, u_int32_t position, int options);
+  attach_function 'fgetxattr', [ :int, :string, :string, :size_t, :uint, :int ], :int
+
+
+  # int setxattr(const char *@path, const char *name, void *value, size_t size, u_int32_t position, int options);
+  attach_function 'setxattr', [ :string, :string, :string, :size_t, :uint, :int ], :int
+  
+  # int fsetxattr(int fd, const char *name, void *value, size_t size, u_int32_t position, int options);
+  attach_function 'fsetxattr', [ :int, :string, :string, :size_t, :uint, :int ], :int
+
+
+  #ssize_t listxattr(const char *@path, char *namebuf, size_t size, int options);
+  attach_function 'listxattr', [:string, :string, :size_t, :int], :size_t
+  
+  #ssize_t flistxattr(int fd, char *namebuf, size_t size, int options);
+  attach_function 'flistxattr', [:int, :string, :size_t, :int], :size_t
+
+  #see man 2 getxattr
+  def fsattr_pget(attribut)
+    attribut = "user." + attribut
+    size = getxattr(@path, attribut, nil, 0,0,0)
+    return "" if size < 0
+    result = " " * size
+    size = getxattr(@path, attribut, result, size, 0,0)
+    return result
+  end
+
+  #see man 2 setxattr
+  def fsattr_pset(attribute, value)
+    value = "user."+ value
+    err = setxattr(@path, attribute, value, value.bytesize, 0,0)
+  end
+
+  #see man 2 listxattr
+  def fsattr_plist()
+    size = listxattr(@path, nil, 0,0)
+    result = " " * size
+    err = listxattr(@path, result, size, 0)
+    #hack. remove the user. and root. and empty string prefixes
+    return (result.split("\x00").map {|att| att.gsub(/(user\.)|(root\.)|^(\s)+?$/, "")}).compact.reject { |s| s.empty? }
+  end
+
+  #man 2 getxattr
+  def fsattr_fget(attribut)
+    attribut = "user." + attribut
+    size = fgetxattr(fileno.to_i, attribut, nil, 0,0,0)
+    return "" if size < 0
+    result = " " * size
+    size = fgetxattr(fileno.to_i, attribut, result, size, 0,0)
+    return result
+  end
+  
+  #see man 2 setxattr
+  def fsattr_fset(attribute, value)
+    value = "user."+ value
+    err = fsetxattr(fileno.to_i, attribute, value, value.bytesize, 0,0)
+  end
+
+  #see man 2 listxattr
+  def fsattr_flist()
+    size = flistxattr(fileno.to_i, nil, 0,0)
+    result = " " * size
+    err = flistxattr(fileno.to_i, result, size, 0)
+    return (result.split("\x00").map {|att| att.gsub(/(user\.)|(root\.)|^(\s)+?$/, "")}).compact.reject { |s| s.empty? }
+  end  
+
+end

data/lib/fsattr/fsattr-osx.rb

@@ -0,0 +1,71 @@
+#provides bindings for hfs+ filesystem attributes via FFI
+module FSattrOSX
+
+  extend FFI::Library
+  ffi_lib 'System'
+  
+  #ssize_t getxattr(const char *path, const char *name, void *value, size_t size, u_int32_t position, int options);
+  attach_function 'getxattr', [ :string, :string, :string, :size_t, :uint, :int ], :int
+
+  #ssize_t fgetxattr(int fd, const char *name, void *value, size_t size, u_int32_t position, int options);
+  attach_function 'fgetxattr', [ :int, :string, :string, :size_t, :uint, :int ], :int
+
+
+  # int setxattr(const char *@path, const char *name, void *value, size_t size, u_int32_t position, int options);
+  attach_function 'setxattr', [ :string, :string, :string, :size_t, :uint, :int ], :int
+  
+  # int fsetxattr(int fd, const char *name, void *value, size_t size, u_int32_t position, int options);
+  attach_function 'fsetxattr', [ :int, :string, :string, :size_t, :uint, :int ], :int
+
+
+  #ssize_t listxattr(const char *@path, char *namebuf, size_t size, int options);
+  attach_function 'listxattr', [:string, :string, :size_t, :int], :size_t
+  
+  #ssize_t flistxattr(int fd, char *namebuf, size_t size, int options);
+  attach_function 'flistxattr', [:int, :string, :size_t, :int], :size_t
+
+  #see man 2 getxattr
+  def fsattr_pget(attribut)
+    size = getxattr(@path, attribut, nil, 0,0,0)
+    return "" if size < 0
+    result = " " * size
+    size = getxattr(@path, attribut, result, size, 0,0)
+    return result
+  end
+
+  #see man 2 setxattr
+  def fsattr_pset(attribute, value)
+    err = setxattr(@path, attribute, value, value.bytesize, 0,0)
+  end
+
+  #see man 2 listxattr
+  def fsattr_plist()
+    size = listxattr(@path, nil, 0,0)
+    result = " " * size
+    err = listxattr(@path, result, size, 0)
+    return result.split("\x00")
+  end
+
+  #man 2 getxattr
+  def fsattr_fget(attribut)
+    size = fgetxattr(fileno.to_i, attribut, nil, 0,0,0)
+    return "" if size < 0
+    result = " " * size
+    size = fgetxattr(fileno.to_i, attribut, result, size, 0,0)
+    return result
+  end
+  
+  #see man 2 setxattr
+  def fsattr_fset(attribute, value)
+    err = fsetxattr(fileno.to_i, attribute, value, value.bytesize, 0,0)
+  end
+
+  #see man 2 listxattr
+  def fsattr_flist()
+    size = flistxattr(fileno.to_i, nil, 0,0)
+    result = " " * size
+    err = flistxattr(fileno.to_i, result, size, 0)
+    return result.split("\x00")
+  end  
+
+end

data/test/helper.rb

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

data/test/test_fsattr.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestFsattr < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: fsattr
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Yannick Koechlin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-30 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: modify extended filesystem attributes on linux and os x
+email: yannick@koechlin.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- fsattr.gemspec
+- lib/fsattr.rb
+- lib/fsattr/fsattr-linux.rb
+- lib/fsattr/fsattr-osx.rb
+- test/helper.rb
+- test/test_fsattr.rb
+has_rdoc: true
+homepage: http://github.com/yannick/fsattr
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: modify extended filesystem attributes on linux and os x
+test_files: 
+- test/helper.rb
+- test/test_fsattr.rb