extattr 0.1.2 → 0.2

data/ext/extconf.rb

@@ -5,27 +5,29 @@ raise "require ruby-1.9.3+" unless RUBY_VERSION >= "1.9.3"
 
 require "mkmf"
 
-#$CFLAGS << " -std=c99" 
+#$CFLAGS << " -std=c99"
 
 case
 when have_header("sys/extattr.h")
+
+when have_header("attr/xattr.h")
+  $CPPFLAGS << " -DLINUX_XATTR_H=\\<attr/xattr.h\\>"
+
+when have_header("sys/xattr.h")
+  $CPPFLAGS << " -DLINUX_XATTR_H=\\<sys/xattr.h\\>"
+
 when have_header("winnt.h") && have_header("ntdef.h") && have_header("psapi.h") &&
      have_header("ddk/ntifs.h") && have_header("ddk/winddk.h") &&
      have_library("ntoskrnl") && have_library("ntdll") && have_library("psapi")
-when have_header("attr/xattr.h")
-    $CPPFLAGS << " -DLINUX_XATTR_H=\\<attr/xattr.h\\>"
-when have_header("sys/xattr.h")
-    $CPPFLAGS << " -DLINUX_XATTR_H=\\<sys/xattr.h\\>"
+
 else
-    $stderr.puts <<-EOS
+  $stderr.puts <<EOM
 #$0: not supported target.
 \tmust be available either ddk/ntifs.h, sys/extattr.h or attr/xattr.h on your system.
-    EOS
-    exit 1
+EOM
+  exit 1
 end
 
-create_makefile "extattr" or exit 2
-
-
-#$CPPFLAGS << " -Wall -DFUSE_USE_VERSION=26"
+#$CFLAGS << " -std=c99"
 
+create_makefile "extattr"

data/lib/extattr.rb

@@ -0,0 +1,57 @@
+#vim: set fileencoding:utf-8
+
+ver = RbConfig::CONFIG["ruby_version"]
+soname = File.basename(__FILE__, ".rb") << ".so"
+lib = File.join(File.dirname(__FILE__), ver, soname)
+if File.file?(lib)
+  require_relative File.join(ver, soname)
+else
+  require_relative soname
+end
+
+#
+# Add operation methods of extended file attribute to File.
+#
+# File クラスに拡張属性を操作するメソッドを追加します。
+#
+# 感嘆符 (『!』) のついたメソッドは、シンボリックリンクに対する操作となります。
+#
+# メソッドにキーワード引数として <code>namespace:</code> を与えることにより、拡張属性の名前空間を指定することが出来ます。
+#
+# 現在の実装においては <code>EXTATTR_NAMESPACE_USER</code> と <code>EXTATTR_NAMESPACE_SYSTEM</code> のみが利用可能です。
+#
+class File
+  #
+  # call-seq:
+  #   extattr_each(path, namespace: File::EXTATTR_NAMESPACE_USER) -> Enumerator
+  #   extattr_each(path, namespace: File::EXTATTR_NAMESPACE_USER) { |name, data| ... } -> File
+  #   extattr_each!(path, namespace: File::EXTATTR_NAMESPACE_USER) -> Enumerator
+  #   extattr_each!(path, namespace: File::EXTATTR_NAMESPACE_USER) { |name, data| ... } -> File
+  #
+  def self.extattr_each(path, *namespace)
+    return to_enum(:extattr_each, path, *namespace) unless block_given?
+
+    extattr_list(path, *namespace) do |name|
+      yield(name, extattr_get(path, name, *namespace))
+    end
+    self
+  end
+
+  def self.extattr_each!(path, *namespace)
+    return to_enum(:extattr_each!, path, *namespace) unless block_given?
+
+    extattr_list!(path, *namespace) do |name|
+      yield(name, extattr_get!(path, name, *namespace))
+    end
+    self
+  end
+
+  def extattr_each(*namespace)
+    return to_enum(:extattr_each, *namespace) unless block_given?
+
+    extattr_list(*namespace) do |name|
+      yield(name, extattr_get(name, *namespace))
+    end
+    self
+  end
+end

metadata

@@ -1,66 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: extattr
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: '0.2'
 platform: ruby
 authors:
 - dearblue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-22 00:00:00.000000000 Z
-dependencies: []
-description: ! 'extattr is extended attribute operation library for ruby.
-
-  Supported for FreeBSD, Gnu/Linux and Microsoft Windows.
-
-'
+date: 2014-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: |
+  extattr is extended file attribute operation library for ruby.
+  Supported for FreeBSD (extattr), GNU/Linux (xattr) and Microsoft Windows (NTFS ADS + Extended Attributes).
 email: dearblue@users.sourceforge.jp
 executables: []
 extensions:
 - ext/extconf.rb
-extra_rdoc_files:
-- README.txt
-- LICENSE.txt
-- ext/extattr.c
+extra_rdoc_files: []
 files:
-- README.txt
-- LICENSE.txt
-- ext/extconf.rb
+- LICENSE.md
+- README.md
+- Rakefile
+- ext/extattr-extattr.h
+- ext/extattr-windows.h
+- ext/extattr-xattr.h
 - ext/extattr.c
-- ext/extattr.bsd
-- ext/extattr.linux
-- ext/extattr.windows
-- rspecs/extattr.rb
+- ext/extconf.rb
+- lib/extattr.rb
+- spec/extattr_spec.rb
 homepage: http://sourceforge.jp/projects/rutsubo/
 licenses:
 - 2-clause BSD License
+metadata: {}
 post_install_message: 
 rdoc_options:
-- -e
+- "--charset"
 - UTF-8
-- -m
-- README.txt
+- "--main"
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: extended attribute operation library for ruby
 test_files: []
-has_rdoc: false
+has_rdoc: 

data/README.txt

@@ -1,73 +0,0 @@
-= extattr
-
-extattr is filesystem extended attributes operation library for FreeBSD, GNU/Linux and Microsoft Windows.
-
-----
-
-extattr はファイルシステムの拡張属性を操作するライブラリで、FreeBSD、GNU/Linux、Windows に対応しています。
-
-サポートされる環境で、統一的なメソッドを提供します。
-
-
-== test system
-
-- Microsoft Windows XP Professional SP3
-- PC-BSD/AMD64 9.0
-- lubuntu 12.04
-
-
-== 簡易リファレンスマニュアル
-
-クラスメソッドに『!』がついているものはシンボリックリンクに対する操作となります。
-
-キーワード引数の <code>namespace</code> を与えると、拡張属性の名前空間を指定できます。
-規定値は <code>EXTATTR_NAMESPACE_USER</code> で、ほかの値は <code>EXTATTR_NAMESPACE_SYSTEM</code> のみが指定できます
-(Windows 版では <code>EXTATTR_NAMESPACE_USER</code> のみが指定可能です)。
-
-拡張属性の属性名を取得:
-
-    File#extattr_list(namespace: File::EXTATTR_NAMESPACE_USER) -> array
-    File#extattr_list(namespace: File::EXTATTR_NAMESPACE_USER) { |name| ... } -> nil
-    File.extattr_list(path, namespace: File::EXTATTR_NAMESPACE_USER) -> array
-    File.extattr_list(path, namespace: File::EXTATTR_NAMESPACE_USER) { |name| ... } -> nil
-    File.extattr_list!(path, namespace: File::EXTATTR_NAMESPACE_USER) -> array
-    File.extattr_list!(path, namespace: File::EXTATTR_NAMESPACE_USER) { |name| ... } -> nil
-
-拡張属性の要素の大きさを取得:
-
-    File#extattr_size(name, namespace: File::EXTATTR_NAMESPACE_USER) -> size
-    File.extattr_size(path, name, namespace: File::EXTATTR_NAMESPACE_USER) -> size
-    File.extattr_size!(path, name, namespace: File::EXTATTR_NAMESPACE_USER) -> size
-
-拡張属性の要素を取得:
-
-    File#extattr_get(name, namespace: File::EXTATTR_NAMESPACE_USER) -> data (String)
-    File.extattr_get(path, name, namespace: File::EXTATTR_NAMESPACE_USER) -> data (String)
-    File.extattr_get!(path, name, namespace: File::EXTATTR_NAMESPACE_USER) -> data (String)
-
-拡張属性の要素を設定:
-
-    File#extattr_set(name, data, namespace: File::EXTATTR_NAMESPACE_USER) -> nil
-    File.extattr_set(path, name, data, namespace: File::EXTATTR_NAMESPACE_USER) -> nil
-    File.extattr_set!(path, name, data, namespace: File::EXTATTR_NAMESPACE_USER) -> nil
-
-拡張属性の要素を削除:
-
-    File#extattr_delete(name, namespace: File::EXTATTR_NAMESPACE_USER) -> nil
-    File.extattr_delete(path, name, namespace: File::EXTATTR_NAMESPACE_USER) -> nil
-    File.extattr_delete!(path, name, namespace: File::EXTATTR_NAMESPACE_USER) -> nil
-
-
-== Microsoft Windows における諸注意
-
-Windows 2000 以降でのみ動作します。Windows 9X シリーズでは <code>require "extattr"</code> の段階で例外が発生するでしょう。
-
-リパースポイント (ジャンクションやシンボリックリンク) に対する ADS は要素の取得や設定、削除は出来ません。
-必ずリンク先に対する操作となります。
-
-64 KiB を超える ADS は取得も設定も出来ません。
-これは『拡張属性』と捉えた場合、巨大なデータを扱えるべきではないという考えによるためです
-(本当のところは FreeBSD の拡張属性が最大 64KiB 弱であることが由来です)。
-巨大な ADS を扱いたい場合は、<code>File.open</code> でファイルとして扱えるので自由に読み書きできます
-(これは ruby に限ったことではなく、Windows による仕様です)。
-この場合の与えるファイル名は、<code>path + ":" + name</code> という形になります。

data/ext/extattr.bsd

@@ -1,186 +0,0 @@
-#include <sys/types.h>
-#include <sys/extattr.h>
-
-
-static void
-split_name(const char list[], size_t size, void (*func)(void *, VALUE), void *userdata)
-{
-    // Each list entry consists of a single byte containing the length of
-    // the attribute name, followed by the attribute name.
-    // The attribute name is not terminated by ASCII 0 (nul).
-    const char *ptr = list;
-    const char *end = list + size;
-
-    while (ptr < end) {
-        size_t len = (uint8_t)*ptr ++;
-        if (ptr + len > end) { return; }
-        func(userdata, rb_str_new(ptr, len));
-        ptr += len;
-    }
-}
-
-static int
-get_extattr_list_size(int (*extattr_list)(), intptr_t d, int namespace)
-{
-    int size = extattr_list(d, namespace, NULL, 0);
-    if (size < 0) { rb_sys_fail("extattr_list call error"); }
-    return size;
-}
-
-static VALUE
-extattr_list0(int (*extattr_list)(), intptr_t d, int namespace)
-{
-    size_t size = get_extattr_list_size(extattr_list, d, namespace);
-    VALUE buf = rb_str_buf_new(size);
-    char *ptr = RSTRING_PTR(buf);
-
-    ssize_t size1 = extattr_list(d, namespace, ptr, size);
-    if (size1 < 0) { rb_sys_fail("extattr_list call error"); }
-
-    VALUE list = Qnil;
-    if (rb_block_given_p()) {
-        split_name(ptr, size1, (void (*)(void *, VALUE))rb_yield_values, (void *)(1));
-    } else {
-        list = rb_ary_new();
-        split_name(ptr, size1, (void (*)(void *, VALUE))rb_ary_push, (void *)list);
-    }
-    rb_free_tmp_buffer(&buf);
-
-    return list;
-}
-
-static VALUE
-file_extattr_list0(VALUE file, int fd, int namespace)
-{
-    return extattr_list0(extattr_list_fd, fd, namespace);
-}
-
-static VALUE
-file_s_extattr_list0(VALUE path, int namespace)
-{
-    return extattr_list0(extattr_list_file, (intptr_t)StringValueCStr(path), namespace);
-}
-
-static VALUE
-file_s_extattr_list_link0(VALUE path, int namespace)
-{
-    return extattr_list0(extattr_list_link, (intptr_t)StringValueCStr(path), namespace);
-}
-
-
-static VALUE
-extattr_size0(int (*extattr_get)(), intptr_t d, int namespace, VALUE name)
-{
-    ssize_t size = extattr_get(d, namespace, RSTRING_PTR(name), NULL, 0);
-    if (size < 0) { rb_sys_fail("extattr_get call error"); }
-    return SIZET2NUM(size);
-}
-
-static VALUE
-file_extattr_size0(VALUE file, int fd, int namespace, VALUE name)
-{
-    return extattr_size0(extattr_get_fd, fd, namespace, name);
-}
-
-static VALUE
-file_s_extattr_size0(VALUE path, int namespace, VALUE name)
-{
-    return extattr_size0(extattr_get_file, (intptr_t)StringValueCStr(path), namespace, name);
-}
-
-static VALUE
-file_s_extattr_size_link0(VALUE path, int namespace, VALUE name)
-{
-    return extattr_size0(extattr_get_link, (intptr_t)StringValueCStr(path), namespace, name);
-}
-
-
-static VALUE
-extattr_get0(int (*extattr_get)(), intptr_t d, VALUE path, int namespace, VALUE name)
-{
-    ssize_t size = extattr_get(d, namespace, RSTRING_PTR(name), NULL, 0);
-    if (size < 0) { rb_sys_fail(StringValueCStr(path)); }
-    VALUE buf = rb_str_buf_new(size);
-    size = extattr_get(d, namespace, RSTRING_PTR(name), RSTRING_PTR(buf), size);
-    if (size < 0) { rb_sys_fail(StringValueCStr(path)); }
-    rb_str_set_len(buf, size);
-    return buf;
-}
-
-static VALUE
-file_extattr_get0(VALUE file, int fd, int namespace, VALUE name)
-{
-    return extattr_get0(extattr_get_fd, fd, RFILE(file)->fptr->pathv, namespace, name);
-}
-
-static VALUE
-file_s_extattr_get0(VALUE path, int namespace, VALUE name)
-{
-    return extattr_get0(extattr_get_file, (intptr_t)StringValueCStr(path), path, namespace, name);
-}
-
-static VALUE
-file_s_extattr_get_link0(VALUE path, int namespace, VALUE name)
-{
-    return extattr_get0(extattr_get_link, (intptr_t)StringValueCStr(path), path, namespace, name);
-}
-
-
-static VALUE
-extattr_set0(int (*extattr_set)(), intptr_t d, int namespace, VALUE name, VALUE data)
-{
-    int status = extattr_set(d, namespace, RSTRING_PTR(name), RSTRING_PTR(data), RSTRING_LEN(data));
-    if (status < 0) { rb_sys_fail("extattr_set call error"); }
-    return Qnil;
-}
-
-static VALUE
-file_extattr_set0(VALUE file, int fd, int namespace, VALUE name, VALUE data)
-{
-    return extattr_set0(extattr_set_fd, fd, namespace, name, data);
-}
-
-static VALUE
-file_s_extattr_set0(VALUE path, int namespace, VALUE name, VALUE data)
-{
-    return extattr_set0(extattr_set_file, (intptr_t)StringValueCStr(path), namespace, name, data);
-}
-
-static VALUE
-file_s_extattr_set_link0(VALUE path, int namespace, VALUE name, VALUE data)
-{
-    return extattr_set0(extattr_set_link, (intptr_t)StringValueCStr(path), namespace, name, data);
-}
-
-
-static VALUE
-extattr_delete0(int (*extattr_delete)(), intptr_t d, int namespace, VALUE name)
-{
-    int status = extattr_delete(d, namespace, RSTRING_PTR(name), NULL, 0);
-    if (status < 0) { rb_sys_fail("extattr_delete call error"); }
-    return Qnil;
-}
-
-static VALUE
-file_extattr_delete0(VALUE file, int fd, int namespace, VALUE name)
-{
-    return extattr_delete0(extattr_delete_fd, fd, namespace, name);
-}
-
-static VALUE
-file_s_extattr_delete0(VALUE path, int namespace, VALUE name)
-{
-    return extattr_delete0(extattr_delete_file, (intptr_t)StringValueCStr(path), namespace, name);
-}
-
-static VALUE
-file_s_extattr_delete_link0(VALUE path, int namespace, VALUE name)
-{
-    return extattr_delete0(extattr_delete_link, (intptr_t)StringValueCStr(path), namespace, name);
-}
-
-
-static void
-setup(void)
-{
-}