extattr 0.2 → 0.4

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

@@ -1,57 +1,274 @@
-#vim: set fileencoding:utf-8
+#!ruby
 
-ver = RbConfig::CONFIG["ruby_version"]
+ver = RUBY_VERSION.slice(/\d+\.\d+/)
 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
+lib = File.join(ver, soname)
+begin
+  require_relative lib
+rescue LoadError
+  require lib
 end
 
 #
-# Add operation methods of extended file attribute to File.
+# Add operation methods of filesystem extended attributes to File.
 #
-# File クラスに拡張属性を操作するメソッドを追加します。
+# === 名前空間の指定について
 #
-# 感嘆符 (『!』) のついたメソッドは、シンボリックリンクに対する操作となります。
+# 拡張属性の名前空間を指定する場合、以下の値が利用できます:
 #
-# メソッドにキーワード引数として <code>namespace:</code> を与えることにより、拡張属性の名前空間を指定することが出来ます。
+# * ExtAttr::USER, ExtAttr::SYSTEM
+# * 文字列又はシンボルで +user+、+system+ (大文字小文字を区別しません)
 #
-# 現在の実装においては <code>EXTATTR_NAMESPACE_USER</code> と <code>EXTATTR_NAMESPACE_SYSTEM</code> のみが利用可能です。
+# これらの値は内部で変換、または処理が分岐されます。
 #
-class File
+# 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:
-  #   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
+  #   each(path, namespace = ExtAttr::USER) -> Enumerator
+  #   each(path, namespace = ExtAttr::USER) { |name| ... } -> path
   #
-  def self.extattr_each(path, *namespace)
-    return to_enum(:extattr_each, path, *namespace) unless block_given?
+  def self.each(path, namespace = ExtAttr::USER, &block)
+    return to_enum(:each, path, namespace) unless block
+
+    list(path, namespace, &block)
 
-    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?
+  #
+  # 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)
 
-    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?
+  #
+  # 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)) }
 
-    extattr_list(*namespace) do |name|
-      yield(name, extattr_get(name, *namespace))
-    end
     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,53 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: extattr
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.4'
 platform: ruby
 authors:
 - dearblue
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-03-16 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '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
+  "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: []
+extra_rdoc_files:
+- 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:
+- HISTORY.ja.md
 - LICENSE.md
+- QUICKREF.ja.md
 - README.md
 - Rakefile
 - ext/extattr-extattr.h
@@ -55,17 +66,18 @@ files:
 - ext/extattr-xattr.h
 - ext/extattr.c
 - ext/extconf.rb
+- gemstub.rb
 - lib/extattr.rb
-- spec/extattr_spec.rb
-homepage: http://sourceforge.jp/projects/rutsubo/
+- test/test_extattr.rb
+homepage: https://github.com/dearblue/ruby-extattr
 licenses:
-- 2-clause BSD License
+- BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset"
 - UTF-8
-- "--main"
+- "-m"
 - README.md
 require_paths:
 - lib
@@ -73,17 +85,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.2.14
+signing_key:
 specification_version: 4
-summary: extended attribute operation library for ruby
+summary: extended file attribute manipurator
 test_files: []
-has_rdoc: 

data/spec/extattr_spec.rb

@@ -1,62 +0,0 @@
-#vim: set fileencoding:utf-8
-
-require "tmpdir"
-basedir = File.join(Dir.tmpdir, "ruby-extattr.test-work")
-Dir.mkdir basedir unless File.directory? basedir
-filepath = File.join(basedir, "file1")
-
-require "extattr"
-
-extdata = "abcdefg"
-
-Dir.chdir basedir do
-  describe "file" do
-    file = nil
-    before(:all) do
-      file = File.open(filepath, "a")
-    end
-
-    it ".extattr_list" do
-      file.extattr_list.should eq([])
-    end
-
-    after(:all) do
-      file.close
-      file = nil
-    end
-  end
-
-  describe File do
-    before(:all) do
-      File.open(filepath, "a") {}
-    end
-
-    it ".extattr_list" do
-      File.extattr_list(filepath).should eq([])
-    end
-
-    it ".extattr_set" do
-      File.extattr_set(filepath, "ext1", extdata).should nil
-    end
-
-    it ".extattr_list ((2))" do
-      File.extattr_list(filepath).should eq(["ext1"])
-    end
-
-    it ".extattr_get" do
-      File.extattr_get(filepath, "ext1").should eq(extdata)
-    end
-
-    it ".extattr_delete" do
-      File.extattr_delete(filepath, "ext1").should nil
-    end
-
-    it ".extattr_list ((3))" do
-      File.extattr_list(filepath).should eq([])
-    end
-
-    after(:all) do
-      File.unlink filepath
-    end
-  end
-end