extattr 0.1 → 0.4

data/ext/extconf.rb

@@ -1,28 +1,32 @@
 #!ruby
-#vim: set fileencoding:utf-8
-
-raise "require ruby-1.9.3+" unless RUBY_VERSION >= "1.9.3"
 
 require "mkmf"
 
-#$CFLAGS << " -std=c99" 
+have_func("rb_ext_ractor_safe", "ruby.h")
 
 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")
+  if RbConfig::CONFIG["arch"] =~ /mingw/
+    $LDFLAGS << " -static-libgcc -static-libstdc++"
+  end
+
 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"
-
+ver = RUBY_VERSION.slice(/\d+\.\d+/)
+create_makefile File.join(ver, "extattr")

data/gemstub.rb

@@ -0,0 +1,22 @@
+unless version = File.read("README.md").scan(/^\s*[\*\-]\s*version:{1,2}\s*(.+)/i).flatten[-1]
+  raise "バージョン情報が README.md に見つかりません"
+end
+
+DOC << "QUICKREF.ja.md"
+
+GEMSTUB = Gem::Specification.new do |s|
+  s.name = "extattr"
+  s.version = version
+  s.summary = "extended file attribute manipurator"
+  s.description = <<-EOS
+"extattr" is extended file attribute manipurator for Ruby.
+Supported for FreeBSD (extattr), GNU/Linux (xattr) and Microsoft Windows (NTFS Alternative Data Stream (ADS) + NTFS Extended Attributes (EA)).
+  EOS
+  s.homepage = "https://github.com/dearblue/ruby-extattr"
+  s.license = "BSD-2-Clause"
+  s.author = "dearblue"
+  s.email = "dearblue@users.osdn.me"
+
+  s.add_development_dependency "rake", "~> 0"
+  s.add_development_dependency "test-unit", "~> 0"
+end

data/lib/extattr.rb

@@ -0,0 +1,274 @@
+#!ruby
+
+ver = RUBY_VERSION.slice(/\d+\.\d+/)
+soname = File.basename(__FILE__, ".rb") << ".so"
+lib = File.join(ver, soname)
+begin
+  require_relative lib
+rescue LoadError
+  require lib
+end
+
+#
+# Add operation methods of filesystem extended attributes to File.
+#
+# === 名前空間の指定について
+#
+# 拡張属性の名前空間を指定する場合、以下の値が利用できます:
+#
+# * ExtAttr::USER, ExtAttr::SYSTEM
+# * 文字列又はシンボルで +user+、+system+ (大文字小文字を区別しません)
+#
+# これらの値は内部で変換、または処理が分岐されます。
+#
+# extattr::
+#   整数値に変換されて処理されます。
+#
+# xattr::
+#   拡張属性名に "user." または "system." を追加して処理されます。
+#
+# Windows::
+#   ExtAttr::USER の場合は NTFS Alternative Data Stream (ADS) として処理されます。
+#
+#   ExtAttr::SYSTEM の場合は NTFS Extended Attribute (EA) として処理されます。
+#
+module ExtAttr
+  ExtAttr = self
+
+  def self.open(path)
+    if path.kind_of?(File)
+      ea = ExtAttr::Accessor[path, path.to_path]
+      block_given? ? yield(ea) : ea
+    else
+      if block_given?
+        ::File.open(path) do |file|
+          return yield(ExtAttr::Accessor[file, path])
+        end
+      else
+        ExtAttr::Accessor[::File.open(path), path]
+      end
+    end
+  end
+
+  #
+  # call-seq:
+  #   each(path, namespace = ExtAttr::USER) -> Enumerator
+  #   each(path, namespace = ExtAttr::USER) { |name| ... } -> path
+  #
+  def self.each(path, namespace = ExtAttr::USER, &block)
+    return to_enum(:each, path, namespace) unless block
+
+    list(path, namespace, &block)
+
+    self
+  end
+
+  #
+  # call-seq:
+  #   each!(path, namespace = ExtAttr::USER) -> Enumerator
+  #   each!(path, namespace = ExtAttr::USER) { |name| ... } -> path
+  #
+  def self.each!(path, namespace = ExtAttr::USER, &block)
+    return to_enum(:each!, path, namespace) unless block
+
+    list!(path, namespace, &block)
+
+    self
+  end
+
+  #
+  # call-seq:
+  #   each_pair(path, namespace = ExtAttr::USER) -> Enumerator
+  #   each_pair(path, namespace = ExtAttr::USER) { |name, data| ... } -> path
+  #
+  def self.each_pair(path, namespace = ExtAttr::USER, &block)
+    return to_enum(:each_pair, path, namespace) unless block
+
+    list(path, namespace) { |name| yield(name, get(path, namespace, name)) }
+
+    self
+  end
+
+  #
+  # call-seq:
+  #   each_pair!(path, namespace = ExtAttr::USER) -> Enumerator
+  #   each_pair!(path, namespace = ExtAttr::USER) { |name, data| ... } -> path
+  #
+  def self.each_pair!(path, namespace = ExtAttr::USER, &block)
+    return to_enum(:each_pair!, path, namespace) unless block
+
+    list!(path, namespace) { |name| yield(name, get!(path, namespace, name)) }
+
+    self
+  end
+
+  class Accessor < Struct.new(:obj, :path)
+    BasicStruct = superclass
+    VIRT_ENOATTR = (ExtAttr::IMPLEMENT == "windows" ? Errno::ENOENT : Errno::ENOATTR)
+
+    def [](name, namespace = ExtAttr::USER)
+      begin
+        ExtAttr.get(obj, namespace, name)
+      rescue VIRT_ENOATTR
+        nil
+      end
+    end
+
+    def []=(name, namespace = ExtAttr::USER, data)
+      if data.nil?
+        ExtAttr.delete(obj, namespace, name)
+      else
+        ExtAttr.set(obj, namespace, name, data)
+      end
+    end
+
+    def each(namespace: ExtAttr::USER, &block)
+      ExtAttr.each(obj, namespace, &block)
+    end
+
+    def each_pair(namespace: ExtAttr::USER, &block)
+      ExtAttr.each_pair(obj, namespace, &block)
+    end
+
+    def list(namespace: ExtAttr::USER, &block)
+      ExtAttr.list(obj, namespace, &block)
+    end
+
+    def size(name, namespace: ExtAttr::USER)
+      ExtAttr.size(obj, namespace, name)
+    end
+
+    def get(name, namespace: ExtAttr::USER)
+      ExtAttr.get(obj, namespace, name)
+    end
+
+    def set(name, data, namespace: ExtAttr::USER)
+      ExtAttr.set(obj, namespace, name, data)
+    end
+
+    def delete(name, namespace: ExtAttr::USER)
+      ExtAttr.delete(obj, namespace, name)
+    end
+  end
+
+  refine File do
+    def extattr
+      ExtAttr::Accessor[self, to_path]
+    end
+
+    #
+    # Enumeration file extattr.
+    #
+    def extattr_each(namespace: ExtAttr::USER, &block)
+      ExtAttr.each(self, namespace, &block)
+    end
+
+    #
+    # Enumeration file extattr.
+    #
+    def extattr_each_pair(namespace: ExtAttr::USER, &block)
+      ExtAttr.each_pair(self, namespace, &block)
+    end
+
+    #
+    # call-seq:
+    #   extattr_list(namespace: ExtAttr::USER) -> array of strings
+    #   extattr_list(namespace: ExtAttr::USER) { |name| ... } -> enumerator
+    #
+    # Get file extattr list.
+    #
+    def extattr_list(namespace: ExtAttr::USER, &block)
+      ExtAttr.list(self, namespace, &block)
+    end
+
+    #
+    # Get file extattr data size.
+    #
+    def extattr_size(name, namespace: ExtAttr::USER)
+      ExtAttr.size(self, namespace, name)
+    end
+
+    #
+    # Get file extattr data.
+    #
+    def extattr_get(name, namespace: ExtAttr::USER)
+      ExtAttr.get(self, namespace, name)
+    end
+
+    #
+    # Set file extattr data.
+    #
+    def extattr_set(name, value, namespace: ExtAttr::USER)
+      ExtAttr.set(self, namespace, name, value)
+    end
+
+    #
+    # Delete file extattr.
+    #
+    def extattr_delete(name, namespace: ExtAttr::USER)
+      ExtAttr.delete(self, namespace, name)
+    end
+  end
+
+  refine File.singleton_class do
+    def extattr(path)
+      ExtAttr.open(path)
+    end
+
+    def extattr_each(path, namespace: ExtAttr::USER, &block)
+      ExtAttr.each(path, namespace, &block)
+    end
+
+    def extattr_each!(path, namespace: ExtAttr::USER, &block)
+      ExtAttr.each!(path, namespace, &block)
+    end
+
+    def extattr_each_pair(path, namespace: ExtAttr::USER, &block)
+      ExtAttr.each_pair(path, namespace, &block)
+    end
+
+    def extattr_each_pair!(path, namespace: ExtAttr::USER, &block)
+      ExtAttr.each_pair!(path, namespace, &block)
+    end
+
+    def extattr_list(path, namespace: ExtAttr::USER, &block)
+      ExtAttr.list(path, namespace, &block)
+    end
+
+    def extattr_list!(path, namespace: ExtAttr::USER, &block)
+      ExtAttr.list!(path, namespace, &block)
+    end
+
+    def extattr_get(path, name, namespace: ExtAttr::USER)
+      ExtAttr.get(path, namespace, name)
+    end
+
+    def extattr_get!(path, name, namespace: ExtAttr::USER)
+      ExtAttr.get(path, namespace, name)
+    end
+
+    def extattr_size(path, name, namespace: ExtAttr::USER)
+      ExtAttr.size(path, namespace, name)
+    end
+
+    def extattr_size!(path, name, namespace: ExtAttr::USER)
+      ExtAttr.size(path, namespace, name)
+    end
+
+    def extattr_set(path, name, value, namespace: ExtAttr::USER)
+      ExtAttr.set(path, namespace, name, value)
+    end
+
+    def extattr_set!(path, name, value, namespace: ExtAttr::USER)
+      ExtAttr.set(path, namespace, name, value)
+    end
+
+    def extattr_delete(path, name, namespace: ExtAttr::USER)
+      ExtAttr.delete(path, namespace, name)
+    end
+
+    def extattr_delete!(path, name, namespace: ExtAttr::USER)
+      ExtAttr.delete(path, namespace, name)
+    end
+  end
+end

data/test/test_extattr.rb

@@ -0,0 +1,75 @@
+#!ruby
+
+require "test/unit"
+require "fileutils"
+require "tmpdir"
+
+include FileUtils
+
+require "extattr"
+
+using ExtAttr
+
+class ExtAttr::Test < Test::Unit::TestCase
+  WORKDIR = Dir.mktmpdir(["", ".ruby-extattr.test-work"])
+  FILEPATH1 = File.join(WORKDIR, "file1")
+  FILEPATH2 = File.join(WORKDIR, "file2")
+
+  def self.startup
+    @@file = File.open(FILEPATH1, "a")
+  end
+
+  def self.shutdown
+    @@file.close
+    @@file = nil
+    Dir.chdir "/" rescue nil
+    rmtree WORKDIR, secure: true, verbose: true #, noop: true
+  end
+
+  def test_fd_extattr
+    extdata = "abcdefg"
+
+    assert_equal([], @@file.extattr_list)
+    assert_nil(@@file.extattr_set("ext1", extdata))
+    assert_equal(["ext1"], @@file.extattr_list())
+    assert_equal("ext1", `lsextattr -qq user #{@@file.to_path}`.chomp) if RUBY_PLATFORM =~ /freebsd/
+    assert_equal(extdata, @@file.extattr_get("ext1"))
+    assert_equal(extdata, `getextattr -qq user ext1 #{@@file.to_path}`) if RUBY_PLATFORM =~ /freebsd/
+    assert_nil(@@file.extattr_delete("ext1"))
+    assert_equal([], @@file.extattr_list())
+  end
+
+  def test_extattr
+    extdata = "abcdefg"
+    File.open(FILEPATH2, "ab") {}
+
+    assert_equal([], File.extattr_list(FILEPATH2))
+    assert_nil(File.extattr_set(FILEPATH2, "ext1", extdata))
+    assert_equal(["ext1"], File.extattr_list(FILEPATH2))
+    assert_equal(extdata, File.extattr_get(FILEPATH2, "ext1"))
+    assert_nil(File.extattr_delete(FILEPATH2, "ext1"))
+    assert_equal([], File.extattr_list(FILEPATH2))
+  end
+
+  def test_ractor_extattr
+    # Skip this test on Ruby < 3.0
+    return true unless defined?(Ractor)
+
+    # Ractor is still experimental in Ruby 3.0.x — suppress warning for this test.
+    old_warning_status = Warning[:experimental]
+    Warning[:experimental] = false
+
+    extdata = "abcdefg"
+    File.open(FILEPATH2, "ab") {}
+
+    assert_equal([], File.extattr_list(FILEPATH2))
+    assert_nil(File.extattr_set(FILEPATH2, "ext1", extdata))
+
+    assert_equal(["ext1"], Ractor.new(FILEPATH2) { |path| File.extattr_list(path) }.take)
+    assert_equal(extdata, Ractor.new(FILEPATH2) { |path| File.extattr_get(path, "ext1") }.take)
+
+    assert_nil(File.extattr_delete(FILEPATH2, "ext1"))
+    assert_equal([], File.extattr_list(FILEPATH2))
+    Warning[:experimental] = old_warning_status
+  end
+end

metadata

@@ -1,66 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: extattr
 version: !ruby/object:Gem::Version
-  version: '0.1'
-  prerelease: 
+  version: '0.4'
 platform: ruby
 authors:
 - dearblue
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-10-02 00:00:00.000000000 Z
-dependencies: []
-description: ! 'extattr is extended attribute operation library for ruby.
-
-  Supported for Microsoft Windows and FreeBSD.
-
-'
-email: dearblue@users.sourceforge.jp
+date: 2021-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  "extattr" is extended file attribute manipurator for Ruby.
+  Supported for FreeBSD (extattr), GNU/Linux (xattr) and Microsoft Windows (NTFS Alternative Data Stream (ADS) + NTFS Extended Attributes (EA)).
+email: dearblue@users.osdn.me
 executables: []
 extensions:
 - ext/extconf.rb
 extra_rdoc_files:
-- README.txt
-- LICENSE.txt
+- HISTORY.ja.md
+- LICENSE.md
+- QUICKREF.ja.md
+- README.md
+- ext/extattr-extattr.h
+- ext/extattr-windows.h
+- ext/extattr-xattr.h
 - ext/extattr.c
+- lib/extattr.rb
 files:
-- README.txt
-- LICENSE.txt
-- ext/extconf.rb
+- HISTORY.ja.md
+- LICENSE.md
+- QUICKREF.ja.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
-homepage: http://sourceforge.jp/projects/rutsubo/
+- ext/extconf.rb
+- gemstub.rb
+- lib/extattr.rb
+- test/test_extattr.rb
+homepage: https://github.com/dearblue/ruby-extattr
 licenses:
-- 2-clause BSD License
-post_install_message: 
+- BSD-2-Clause
+metadata: {}
+post_install_message:
 rdoc_options:
-- -e
+- "--charset"
 - UTF-8
-- -m
-- README.txt
+- "-m"
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
-signing_key: 
-specification_version: 3
-summary: extended attribute operation library for ruby
+rubygems_version: 3.2.14
+signing_key:
+specification_version: 4
+summary: extended file attribute manipurator
 test_files: []
-has_rdoc: false

data/README.txt

@@ -1,53 +0,0 @@
-= extattr
-
-extattr is extended attribute operation library for Windows and FreeBSD.
-
-----
-
-extattr は拡張属性を操作するライブラリで、Windows、FreeBSD に対応しています (GNU/Linux はコードを書いてみただけで、試験がまったくされていません)。
-
-サポートされる環境で、統一的なメソッドを提供します。
-
-クラスメソッドに『!』がついているものはシンボリックリンクに対する操作となります。
-
-キーワード引数の <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(path, namespace: File::EXTATTR_NAMESPACE_USER) -> array
-- File.extattr_list!(path, namespace: File::EXTATTR_NAMESPACE_USER) -> array
-
-== 拡張属性の要素の大きさを取得:
-
-- 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 は要素の取得や設定、削除は出来ません。必ずリンク先に対する操作となります。
-
-128 KiB を超える ADS は取得も設定も出来ません。これは『拡張属性』と捉えた場合、巨大なデータを扱えるべきではないという考えによるためです (本当のところは FreeBSD の拡張属性が最大 64KiB 弱であることが由来です)。巨大な ADS を扱いたい場合は、File.open で自由に読み書きできます (これは ruby に限ったことではなく、Windows による仕様です)。この場合の与えるファイル名は、path + ":" + name という形になります。