opendal 0.1.6.pre.rc.1-aarch64-linux

data/test/io_test.rb

@@ -0,0 +1,172 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+require "test_helper"
+require "tmpdir"
+
+class IOTest < ActiveSupport::TestCase
+  setup do
+    @root = Dir.mktmpdir
+    File.write(
+      "#{@root}/sample",
+      <<~EOF
+        Sample data for testing
+        A line after title
+      EOF
+    )
+    @op = OpenDal::Operator.new("fs", {"root" => @root})
+    @io_read = @op.open("sample", "r")
+    @io_write = @op.open("sample_write", "w")
+  end
+
+  teardown do
+    @io_read.close
+    @io_write.close
+    FileUtils.remove_entry(@root) if File.exist?(@root)
+  end
+
+  test "#binmode? returns" do
+    assert_not @io_read.binmode?
+  end
+
+  test "#binmode returns" do
+    assert_nothing_raised do
+      @io_read.binmode
+    end
+  end
+
+  test "#close closes IO" do
+    assert_nothing_raised do
+      @io_read.close
+    end
+  end
+
+  test "#close_read closes reader" do
+    assert_nothing_raised do
+      @io_read.close_read
+    end
+  end
+
+  test "#close_write closes writer" do
+    assert_nothing_raised do
+      @io_read.close_write
+    end
+  end
+
+  test "#closed? returns" do
+    assert_not @io_read.closed?
+  end
+
+  test "#closed_read? returns" do
+    assert_not @io_read.closed_read?
+  end
+
+  test "#closed_write? returns" do
+    assert @io_read.closed_write?
+  end
+
+  test "#read reads" do
+    result = @io_read.read
+
+    assert_equal "Sample data for testing\nA line after title\n", result
+    # should be `assert_equal Encoding::UTF_8, result.encoding`
+  end
+
+  test "#read reads with nil" do
+    result = @io_read.read(nil)
+
+    assert_equal "Sample data for testing\nA line after title\n", result
+  end
+
+  test "#read reads with size" do
+    result = @io_read.read(6)
+
+    assert_equal "Sample", result
+  end
+
+  test "#read raises ArgumentError with -1" do
+    assert_raise(ArgumentError) do |err|
+      @io_read.read(-1)
+
+      assert_equal "negative length -1 given", err.message
+    end
+  end
+
+  test "#read reads to a buffer" do
+    buffer = +"hi " # unfreezes string literal
+    result = @io_read.read(6, buffer)
+
+    assert_equal "Sample", result
+    assert_equal "hi Sample", buffer
+  end
+
+  test "#write writes" do
+    @io_write.write("This is a sentence.")
+    @io_write.close
+    assert_equal "This is a sentence.", File.read("#{@root}/sample_write")
+  end
+
+  test "#readline reads a line" do
+    line = @io_read.readline
+
+    assert_equal "Sample data for testing\n", line
+    # should be `assert_equal Encoding::UTF_8, line.encoding`
+  end
+
+  test "#readlines reads all lines" do
+    lines = @io_read.readlines
+
+    assert_equal ["Sample data for testing\n", "A line after title\n"], lines
+    # should be `assert_equal Encoding::UTF_8, lines.first.encoding`
+  end
+
+  test "#tell returns position" do
+    assert_equal 0, @io_read.tell
+  end
+
+  test "#pos= moves position" do
+    @io_read.pos = 5
+
+    assert_equal 5, @io_read.pos
+  end
+
+  test "#rewind moves position to start" do
+    @io_read.pos = 5
+    @io_read.rewind
+
+    assert_equal 0, @io_read.pos
+  end
+
+  test "#eof returns" do
+    assert_not @io_read.eof
+  end
+
+  test "#eof? returns" do
+    @io_read.read
+    assert @io_read.eof?
+  end
+
+  test "#length returns" do
+    assert_equal 43, @io_read.length
+  end
+
+  test "#size returns" do
+    assert_equal 43, @io_read.size
+  end
+end

data/test/lister_test.rb

@@ -0,0 +1,77 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+require "test_helper"
+require "tmpdir"
+
+class ListerTest < ActiveSupport::TestCase
+  setup do
+    @root = Dir.mktmpdir
+    File.write("#{@root}/sample", "Sample data for testing")
+    Dir.mkdir("#{@root}/sub")
+    File.write("#{@root}/sub/sample", "Sample data for testing")
+    @op = OpenDal::Operator.new("fs", {"root" => @root})
+  end
+
+  test "lists the directory" do
+    lister = @op.list("")
+
+    lists = lister.map(&:to_h).map { |e| e[:path] }.sort
+
+    assert_equal ["/", "sample", "sub/"], lists
+  end
+
+  test "list returns the entry" do
+    entry = @op.list("/").first
+
+    assert entry.is_a?(OpenDal::Entry)
+    assert entry.name.length > 0
+  end
+
+  test "entry has the metadata" do
+    metadata = @op.list("sample").first.metadata
+
+    assert metadata.file?
+    assert !metadata.dir?
+  end
+
+  test "lists the directory recursively" do
+    lister = @op.list("", recursive: true)
+
+    lists = lister.map(&:to_h).map { |e| e[:path] }.sort
+
+    assert_equal ["/", "sample", "sub/", "sub/sample"], lists
+  end
+
+  test "lists the directory with limit" do
+    lister = @op.list("", limit: 1)
+
+    lists = lister.map(&:to_h).map { |e| e[:path] }.sort
+
+    assert_equal ["/", "sample", "sub/"], lists
+  end
+
+  test "lists the directory with start_after" do
+    lister = @op.list("", start_after: "sub/")
+
+    lists = lister.map(&:to_h).map { |e| e[:path] }.sort
+
+    assert_equal ["/", "sample", "sub/"], lists # fs backend doesn't support start_after
+  end
+end

data/test/metadata_test.rb

@@ -0,0 +1,78 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+require "test_helper"
+
+class MetadataTest < ActiveSupport::TestCase
+  setup do
+    @op = OpenDal::Operator.new("memory", {})
+    @op.write("/file", "OpenDAL Ruby is ready.")
+  end
+
+  test "returns metadata" do
+    metadata = @op.stat("file")
+
+    assert_nothing_raised do
+      metadata.inspect
+    end
+  end
+
+  test "#file? works" do
+    metadata = @op.stat("file")
+
+    assert metadata.file?
+  end
+
+  test "#dir? works" do
+    metadata = @op.stat("/")
+    assert metadata.dir?
+
+    assert !@op.stat("file").dir?
+  end
+
+  test "#mode works" do
+    metadata = @op.stat("file")
+    assert_equal OpenDal::Metadata::FILE, metadata.mode
+  end
+
+  test "#content_disposition works" do
+    metadata = @op.stat("file")
+    assert_nil metadata.content_disposition
+  end
+
+  test "#content_length works" do
+    metadata = @op.stat("file")
+    assert_equal 22, metadata.content_length
+  end
+
+  test "#content_md5 works" do
+    metadata = @op.stat("file")
+    assert_nil metadata.content_md5
+  end
+
+  test "#content_type works" do
+    metadata = @op.stat("file")
+    assert_nil metadata.content_type
+  end
+
+  test "#etag works" do
+    metadata = @op.stat("file")
+    assert_nil metadata.etag
+  end
+end

data/test/middlewares_test.rb

@@ -0,0 +1,46 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+require "test_helper"
+
+class MiddlewaresTest < ActiveSupport::TestCase
+  test "builds a retry middleware" do
+    assert_nothing_raised do
+      OpenDal::Middleware::Retry.new
+    end
+  end
+
+  test "builds a concurrent limit middleware" do
+    assert_nothing_raised do
+      OpenDal::Middleware::ConcurrentLimit.new(10)
+    end
+  end
+
+  test "builds a throttle middleware" do
+    assert_nothing_raised do
+      OpenDal::Middleware::Throttle.new(100, 10)
+    end
+  end
+
+  test "builds a timeout middleware" do
+    assert_nothing_raised do
+      OpenDal::Middleware::Timeout.new(1.23, 1.0)
+    end
+  end
+end

data/test/operator_info_test.rb

@@ -0,0 +1,35 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+require "test_helper"
+
+class OperatorInfoTest < ActiveSupport::TestCase
+  setup do
+    @op = OpenDal::Operator.new("memory", {})
+  end
+
+  test "returns meta information" do
+    info = @op.info
+
+    assert_equal "memory", info.scheme
+    assert_equal "/", info.root
+    assert info.name.length > 0
+    assert info.capability.stat
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,36 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+require "active_support"
+require "minitest/autorun"
+require "minitest/reporters"
+
+Minitest::Reporters.use!([Minitest::Reporters::DefaultReporter.new(color: true)])
+
+require "opendal"
+
+# Uses `ActiveSupport::TestCase` for additional features including:
+# - additional assertions
+# - file fixtures
+# - parallel worker
+#
+# Read more https://edgeapi.rubyonrails.org/classes/ActiveSupport/TestCase.html
+class ActiveSupport::TestCase
+  parallelize(workers: :number_of_processors)
+end

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification
+name: opendal
+version: !ruby/object:Gem::Version
+  version: 0.1.6.pre.rc.1
+platform: aarch64-linux
+authors:
+- OpenDAL Contributors
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-10-01 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- dev@opendal.apache.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./extconf.rb"
+- ".standard.yml"
+- ".tool-versions"
+- ".yardopts"
+- DEPENDENCIES.md
+- DEPENDENCIES.rust.tsv
+- Gemfile
+- README.md
+- Rakefile
+- core/CHANGELOG.md
+- core/CONTRIBUTING.md
+- core/DEPENDENCIES.md
+- core/DEPENDENCIES.rust.tsv
+- core/LICENSE
+- core/README.md
+- core/benches/README.md
+- core/benches/ops/README.md
+- core/benches/types/README.md
+- core/benches/vs_fs/README.md
+- core/benches/vs_s3/README.md
+- core/edge/README.md
+- core/edge/file_write_on_full_disk/README.md
+- core/edge/s3_aws_assume_role_with_web_identity/README.md
+- core/edge/s3_read_on_wasm/.gitignore
+- core/edge/s3_read_on_wasm/README.md
+- core/edge/s3_read_on_wasm/webdriver.json
+- core/examples/README.md
+- core/examples/basic/README.md
+- core/examples/concurrent-upload/README.md
+- core/examples/multipart-upload/README.md
+- core/fuzz/.gitignore
+- core/fuzz/README.md
+- core/src/docs/comparisons/vs_object_store.md
+- core/src/docs/performance/concurrent_write.md
+- core/src/docs/performance/http_optimization.md
+- core/src/docs/rfcs/0000_example.md
+- core/src/docs/rfcs/0000_foyer_integration.md
+- core/src/docs/rfcs/0041_object_native_api.md
+- core/src/docs/rfcs/0044_error_handle.md
+- core/src/docs/rfcs/0057_auto_region.md
+- core/src/docs/rfcs/0069_object_stream.md
+- core/src/docs/rfcs/0090_limited_reader.md
+- core/src/docs/rfcs/0112_path_normalization.md
+- core/src/docs/rfcs/0191_async_streaming_io.md
+- core/src/docs/rfcs/0203_remove_credential.md
+- core/src/docs/rfcs/0221_create_dir.md
+- core/src/docs/rfcs/0247_retryable_error.md
+- core/src/docs/rfcs/0293_object_id.md
+- core/src/docs/rfcs/0337_dir_entry.md
+- core/src/docs/rfcs/0409_accessor_capabilities.md
+- core/src/docs/rfcs/0413_presign.md
+- core/src/docs/rfcs/0423_command_line_interface.md
+- core/src/docs/rfcs/0429_init_from_iter.md
+- core/src/docs/rfcs/0438_multipart.md
+- core/src/docs/rfcs/0443_gateway.md
+- core/src/docs/rfcs/0501_new_builder.md
+- core/src/docs/rfcs/0554_write_refactor.md
+- core/src/docs/rfcs/0561_list_metadata_reuse.md
+- core/src/docs/rfcs/0599_blocking_api.md
+- core/src/docs/rfcs/0623_redis_service.md
+- core/src/docs/rfcs/0627_split_capabilities.md
+- core/src/docs/rfcs/0661_path_in_accessor.md
+- core/src/docs/rfcs/0793_generic_kv_services.md
+- core/src/docs/rfcs/0926_object_reader.md
+- core/src/docs/rfcs/0977_refactor_error.md
+- core/src/docs/rfcs/1085_object_handler.md
+- core/src/docs/rfcs/1391_object_metadataer.md
+- core/src/docs/rfcs/1398_query_based_metadata.md
+- core/src/docs/rfcs/1420_object_writer.md
+- core/src/docs/rfcs/1477_remove_object_concept.md
+- core/src/docs/rfcs/1735_operation_extension.md
+- core/src/docs/rfcs/2083_writer_sink_api.md
+- core/src/docs/rfcs/2133_append_api.md
+- core/src/docs/rfcs/2299_chain_based_operator_api.md
+- core/src/docs/rfcs/2602_object_versioning.md
+- core/src/docs/rfcs/2758_merge_append_into_write.md
+- core/src/docs/rfcs/2774_lister_api.md
+- core/src/docs/rfcs/2779_list_with_metakey.md
+- core/src/docs/rfcs/2852_native_capability.md
+- core/src/docs/rfcs/2884_merge_range_read_into_read.md
+- core/src/docs/rfcs/3017_remove_write_copy_from.md
+- core/src/docs/rfcs/3197_config.md
+- core/src/docs/rfcs/3232_align_list_api.md
+- core/src/docs/rfcs/3243_list_prefix.md
+- core/src/docs/rfcs/3356_lazy_reader.md
+- core/src/docs/rfcs/3526_list_recursive.md
+- core/src/docs/rfcs/3574_concurrent_stat_in_list.md
+- core/src/docs/rfcs/3734_buffered_reader.md
+- core/src/docs/rfcs/3898_concurrent_writer.md
+- core/src/docs/rfcs/3911_deleter_api.md
+- core/src/docs/rfcs/4382_range_based_read.md
+- core/src/docs/rfcs/4638_executor.md
+- core/src/docs/rfcs/5314_remove_metakey.md
+- core/src/docs/rfcs/5444_operator_from_uri.md
+- core/src/docs/rfcs/5479_context.md
+- core/src/docs/rfcs/5485_conditional_reader.md
+- core/src/docs/rfcs/5495_list_with_deleted.md
+- core/src/docs/rfcs/5556_write_returns_metadata.md
+- core/src/docs/rfcs/5871_read_returns_metadata.md
+- core/src/docs/rfcs/6189_remove_native_blocking.md
+- core/src/docs/rfcs/6209_glob_support.md
+- core/src/docs/rfcs/6213_options_api.md
+- core/src/docs/rfcs/README.md
+- core/src/docs/upgrade.md
+- core/src/services/aliyun_drive/docs.md
+- core/src/services/alluxio/docs.md
+- core/src/services/azblob/docs.md
+- core/src/services/azdls/docs.md
+- core/src/services/azfile/docs.md
+- core/src/services/b2/docs.md
+- core/src/services/cacache/docs.md
+- core/src/services/cloudflare_kv/docs.md
+- core/src/services/cos/docs.md
+- core/src/services/d1/docs.md
+- core/src/services/dashmap/docs.md
+- core/src/services/dbfs/docs.md
+- core/src/services/dropbox/docs.md
+- core/src/services/etcd/docs.md
+- core/src/services/foundationdb/docs.md
+- core/src/services/fs/docs.md
+- core/src/services/ftp/docs.md
+- core/src/services/gcs/docs.md
+- core/src/services/gdrive/docs.md
+- core/src/services/ghac/docs.md
+- core/src/services/github/docs.md
+- core/src/services/gridfs/docs.md
+- core/src/services/hdfs/docs.md
+- core/src/services/hdfs_native/docs.md
+- core/src/services/http/docs.md
+- core/src/services/huggingface/docs.md
+- core/src/services/ipfs/docs.md
+- core/src/services/ipmfs/docs.md
+- core/src/services/koofr/docs.md
+- core/src/services/lakefs/docs.md
+- core/src/services/memcached/docs.md
+- core/src/services/memory/docs.md
+- core/src/services/mini_moka/docs.md
+- core/src/services/moka/docs.md
+- core/src/services/mongodb/docs.md
+- core/src/services/monoiofs/docs.md
+- core/src/services/mysql/docs.md
+- core/src/services/obs/docs.md
+- core/src/services/onedrive/docs.md
+- core/src/services/opfs/docs.md
+- core/src/services/oss/docs.md
+- core/src/services/pcloud/docs.md
+- core/src/services/persy/docs.md
+- core/src/services/postgresql/docs.md
+- core/src/services/redb/docs.md
+- core/src/services/redis/docs.md
+- core/src/services/rocksdb/docs.md
+- core/src/services/s3/compatible_services.md
+- core/src/services/s3/docs.md
+- core/src/services/seafile/docs.md
+- core/src/services/sftp/docs.md
+- core/src/services/sled/docs.md
+- core/src/services/sqlite/docs.md
+- core/src/services/surrealdb/docs.md
+- core/src/services/swift/compatible_services.md
+- core/src/services/swift/docs.md
+- core/src/services/tikv/docs.md
+- core/src/services/upyun/docs.md
+- core/src/services/vercel_artifacts/docs.md
+- core/src/services/vercel_blob/docs.md
+- core/src/services/webdav/docs.md
+- core/src/services/webhdfs/docs.md
+- core/src/services/yandex_disk/docs.md
+- core/tests/behavior/README.md
+- core/tests/data/normal_dir/.gitkeep
+- core/tests/data/normal_file.txt
+- core/tests/data/special_dir  !@#$%^&()_+-=;',/.gitkeep
+- core/tests/data/special_file  !@#$%^&()_+-=;',.txt
+- core/users.md
+- lib/opendal.rb
+- lib/opendal_ruby/entry.rb
+- lib/opendal_ruby/io.rb
+- lib/opendal_ruby/metadata.rb
+- lib/opendal_ruby/opendal_ruby.so
+- lib/opendal_ruby/operator.rb
+- lib/opendal_ruby/operator_info.rb
+- opendal.gemspec
+- test/blocking_op_test.rb
+- test/capability_test.rb
+- test/io_test.rb
+- test/lister_test.rb
+- test/metadata_test.rb
+- test/middlewares_test.rb
+- test/operator_info_test.rb
+- test/test_helper.rb
+homepage: https://opendal.apache.org/
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://opendal.apache.org/
+  source_code_uri: https://github.com/apache/opendal
+  changelog_uri: https://github.com/apache/opendal/releases
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.5.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Rust >= 1.82
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: OpenDAL Ruby Binding
+test_files: []