opendal 0.1.6.pre.rc.1-arm64-darwin-23

data/core/users.md

@@ -0,0 +1,13 @@
+# Users
+
+- [apache/iceberg-rust](https://github.com/apache/iceberg-rust/): Native Rust implementation of [Apache Iceberg](https://iceberg.apache.org/), the open table format for analytic datasets.
+- [Databend](https://github.com/datafuselabs/databend/): A modern Elasticity and Performance cloud data warehouse.
+- [deepeth/mars](https://github.com/deepeth/mars): The powerful analysis platform to explore and visualize data from blockchain.
+- [GreptimeDB](https://github.com/GreptimeTeam/greptimedb): An open-source, cloud-native, distributed time-series database.
+- [mozilla/sccache](https://github.com/mozilla/sccache/): `sccache` is [`ccache`](https://github.com/ccache/ccache) with cloud storage
+- [OctoBase](https://github.com/toeverything/OctoBase): the open-source database behind [AFFiNE](https://github.com/toeverything/affine), local-first, yet collaborative.
+- [Pants](https://github.com/pantsbuild/pants): A fast, scalable, user-friendly build system for codebases of all sizes.
+- [QuestDB](https://github.com/questdb/questdb): An open-source time-series database for high throughput ingestion and fast SQL queries with operational simplicity.
+- [RisingWave](https://github.com/risingwavelabs/risingwave): A Distributed SQL Database for Stream Processing
+- [Vector](https://github.com/vectordotdev/vector): A high-performance observability data pipeline.
+- [rustic](https://github.com/rustic-rs/rustic): Fast, encrypted, and deduplicated backups powered by Rust

data/extconf.rb

@@ -0,0 +1,24 @@
+# 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.
+
+require "mkmf"
+# We use rb_sys for makefile generation only.
+# We can use `RB_SYS_CARGO_PROFILE` to choose Cargo profile
+# Read more https://github.com/oxidize-rb/rb-sys/blob/main/gem/README.md
+require "rb_sys/mkmf"
+
+create_rust_makefile("opendal_ruby/opendal_ruby")

data/lib/opendal.rb

@@ -0,0 +1,25 @@
+# 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_relative "opendal_ruby/opendal_ruby"
+require_relative "opendal_ruby/io"
+require_relative "opendal_ruby/entry"
+require_relative "opendal_ruby/metadata"
+require_relative "opendal_ruby/operator"
+require_relative "opendal_ruby/operator_info"

data/lib/opendal_ruby/entry.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
+
+module OpenDal
+  class Entry
+    # Returns the canonical data about an entry
+    # @return [Hash]
+    def to_h
+      {
+        path: path,
+        metadata: metadata
+      }
+    end
+
+    def inspect
+      "#<#{self.class.name} path: \"#{path}\", metadata: #{metadata.inspect}>"
+    end
+  end
+end

data/lib/opendal_ruby/io.rb

@@ -0,0 +1,70 @@
+# 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
+
+module OpenDal
+  class IO
+    # Reads all lines from the stream into an array.
+    # @raise [EOFError] when the end of the file is reached.
+    # @return [Array<String>]
+    def readlines
+      results = []
+
+      loop do
+        results << readline
+      rescue EOFError
+        break
+      end
+
+      results
+    end
+
+    # Rewinds the stream to the beginning.
+    def rewind
+      seek(0, ::IO::SEEK_SET)
+    end
+
+    # Sets the file position to `new_position`.
+    # @param new_position [Integer]
+    def pos=(new_position)
+      seek(new_position, ::IO::SEEK_SET)
+    end
+
+    alias_method :pos, :tell
+
+    # Checks if the stream is at the end of the file.
+    # @return [Boolean]
+    def eof
+      position = tell
+      seek(0, ::IO::SEEK_END)
+      tell == position
+    end
+
+    alias_method :eof?, :eof
+
+    # Returns the total length of the stream.
+    # @return [Integer]
+    def length
+      current_position = tell
+      seek(0, ::IO::SEEK_END)
+      tell.tap { self.pos = current_position }
+    end
+
+    alias_method :size, :length
+  end
+end

data/lib/opendal_ruby/metadata.rb

@@ -0,0 +1,44 @@
+# 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
+
+module OpenDal
+  class Metadata
+    FILE = "File"
+    DIRECTORY = "Directory"
+
+    # Returns `True` if this is a file.
+    # @return [Boolean]
+    def file?
+      mode == FILE
+    end
+
+    # Returns `True` if this is a directory.
+    # @return [Boolean]
+    def dir?
+      mode == DIRECTORY
+    end
+
+    def inspect
+      # Be concise to keep a few attributes
+      "#<#{self.class.name} mode: #{mode}, \
+        content_type: #{content_type}, \
+        content_length: #{content_length}>"
+    end
+  end
+end

data/lib/opendal_ruby/operator.rb

@@ -0,0 +1,29 @@
+# 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
+
+module OpenDal
+  class Operator
+    # Applies a middleware to the operator.
+    # @param middleware [Middleware]
+    # @return [Operator]
+    def middleware(middleware)
+      middleware.apply_to(self) # duck typing, expects a middleware to implement `#apply_to`
+    end
+  end
+end

data/lib/opendal_ruby/operator_info.rb

@@ -0,0 +1,26 @@
+# 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
+
+module OpenDal
+  class OperatorInfo
+    def inspect
+      "#<#{self.class.name} scheme: \"#{scheme}\", root: \"#{root}\">"
+    end
+  end
+end

data/opendal.gemspec

@@ -0,0 +1,91 @@
+# 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 "json"
+
+Gem::Specification.new do |spec|
+  spec.name = "opendal"
+  # RubyGems integrates and expects `cargo`.
+  # Read more about [Gem::Ext::CargoBuilder](https://github.com/rubygems/rubygems/blob/v3.5.23/lib/rubygems/ext/cargo_builder.rb)
+  #
+  # OpenDAL relies on "version" in `Cargo.toml` for the release process. You can read this gem spec with:
+  # `bundle exec ruby -e 'puts Gem::Specification.load("opendal.gemspec")'`
+  #
+  # keep in sync the key "opendal-ruby" with `Rakefile`.
+  #
+  # uses `cargo` to extract the version.
+  spec.version = JSON.parse(`cargo metadata --format-version 1`.strip)
+    .fetch("packages")
+    .find { |p| p["name"] == "opendal-ruby" }
+    .fetch("version")
+  spec.authors = ["OpenDAL Contributors"]
+  spec.email = ["dev@opendal.apache.org"]
+
+  spec.summary = "OpenDAL Ruby Binding"
+  spec.homepage = "https://opendal.apache.org/"
+  spec.license = "Apache-2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/apache/opendal"
+  spec.metadata["changelog_uri"] = "https://github.com/apache/opendal/releases"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to a source release gem when we release OpenDAL Ruby gem.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    git_files = `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[gems/ pkg/ target/ tmp/ .git]) || f == "core"
+    end
+
+    # Include core directory files, excluding symlinks
+    core_files = Dir.chdir("./core") do
+      `git ls-files -z`.split("\x0").reject do |f|
+        File.symlink?(File.join("./core", f))
+      end.map { |f| "core/#{f}" }
+    end
+
+    # Resolve symlinks: copy actual files from their target locations
+    # This handles recursive symbol link cases. e.g., core/CHANGELOG.md -> ../CHANGELOG.md
+    symlink_targets = Dir.chdir("./core") do
+      `git ls-files -z`.split("\x0").select do |f|
+        File.symlink?(File.join("./core", f))
+      end.filter_map do |f|
+        link_target = File.readlink(File.join("./core", f))
+        resolved_path = File.expand_path(link_target, File.join(__dir__, "core"))
+        File.exist?(resolved_path) ? "core/#{f}" : nil
+      end
+    end
+
+    git_files + core_files + symlink_targets
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.extensions = ["./extconf.rb"]
+
+  spec.requirements = ["Rust >= 1.82"]
+  # use a Ruby version which:
+  # - supports Rubygems with the ability of compilation of Rust gem
+  # - not end of life
+  #
+  # keep in sync with `Rakefile`.
+  spec.required_ruby_version = ">= 3.2"
+
+  # intentionally skipping rb_sys gem because newer Rubygems will be present
+end

data/test/blocking_op_test.rb

@@ -0,0 +1,112 @@
+# 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 OpenDalTest < ActiveSupport::TestCase
+  setup do
+    @root = Dir.mktmpdir
+    File.write("#{@root}/sample", "Sample data for testing")
+    @op = OpenDal::Operator.new("fs", {"root" => @root})
+  end
+
+  teardown do
+    FileUtils.remove_entry(@root) if File.exist?(@root)
+  end
+
+  test "write writes to a file" do
+    @op.write("/file", "OpenDAL Ruby is ready.")
+
+    assert_equal "OpenDAL Ruby is ready.", File.read("/#{@root}/file")
+  end
+
+  test "write writes binary" do
+    # writes 32-bit signed integers
+    @op.write("/file", [67305985, -50462977].pack("l*"))
+
+    assert_equal [67305985, -50462977], File.binread("/#{@root}/file").unpack("l*")
+  end
+
+  test "read reads file data" do
+    data = @op.read("/sample")
+
+    assert_equal "Sample data for testing", data
+  end
+
+  test "stat returns file metadata" do
+    stat = @op.stat("sample")
+
+    assert stat.is_a?(OpenDal::Metadata)
+    assert_equal 23, stat.content_length
+    assert stat.file?
+  end
+
+  test "create_dir creates directory" do
+    @op.create_dir("/new/directory/")
+    assert File.directory?("#{@root}/new/directory/")
+  end
+
+  test "exists returns existence" do
+    assert @op.exist?("sample")
+  end
+
+  test "delete removes file" do
+    @op.delete("/sample")
+
+    assert_not File.exist?("#{@root}/sample")
+  end
+
+  test "rename renames file" do
+    @op.rename("/sample", "/new_name")
+
+    assert_not File.exist?("#{@root}/sample")
+    assert File.exist?("#{@root}/new_name")
+  end
+
+  test "remove_all removes files" do
+    @op.create_dir("/nested/directory/")
+    @op.write("/nested/directory/text", "content")
+
+    @op.remove_all("/")
+
+    assert_not File.exist?(@root)
+  end
+
+  test "copy copies file" do
+    @op.copy("/sample", "/new_name")
+
+    assert File.exist?("#{@root}/sample")
+    assert File.exist?("#{@root}/new_name")
+  end
+
+  test "opens an IO" do
+    io = @op.open("/sample", "rb")
+
+    assert_not io.closed?
+
+    io.close
+  end
+
+  test "middleware applies a middleware" do
+    @op.middleware(OpenDal::Middleware::Retry.new)
+
+    assert @op.is_a?(OpenDal::Operator)
+  end
+end

data/test/capability_test.rb

@@ -0,0 +1,42 @@
+# 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 CapabilityTest < ActiveSupport::TestCase
+  setup do
+    @op = OpenDal::Operator.new("memory", nil)
+  end
+
+  test "has read capability" do
+    capability = @op.capability
+
+    assert_not capability.nil?
+    assert capability.read
+  end
+
+  test "doesn't respond to undefined capability" do
+    capability = @op.capability
+
+    assert_not capability.nil?
+    assert_raises(NoMethodError) do
+      capability.not_exist
+    end
+  end
+end