opendal 0.1.6.pre.rc.1

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/src/capability.rs

@@ -0,0 +1,146 @@
+// 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.
+
+use magnus::method;
+use magnus::prelude::*;
+use magnus::Error;
+use magnus::RModule;
+
+use crate::*;
+
+// This name follows `attr_accessor` in Ruby
+macro_rules! define_accessors {
+    ($struct:ty, { $( $field:ident : $type:ty ),+ $(,)? }) => {
+        impl $struct {
+            $(
+                pub fn $field(&self) -> $type {
+                    self.0.$field
+                }
+            )+
+        }
+    };
+}
+macro_rules! bind_methods_to_ruby {
+    ($ruby_class:ident, { $( $field:ident ),+ $(,)? }) => {
+        $(
+            $ruby_class.define_method(stringify!($field), method!(Capability::$field, 0))?;
+        )+
+    };
+}
+
+/// @yard
+/// Capability describes OpenDAL supported operations by current Operator.
+#[magnus::wrap(class = "OpenDal::Capability", free_immediately, size)]
+pub struct Capability(ocore::Capability);
+
+impl Capability {
+    pub fn new(capability: ocore::Capability) -> Self {
+        Self(capability)
+    }
+}
+
+define_accessors!(Capability, {
+    stat: bool,
+    stat_with_if_match: bool,
+    stat_with_if_none_match: bool,
+    stat_with_override_cache_control: bool,
+    stat_with_override_content_disposition: bool,
+    stat_with_override_content_type: bool,
+    stat_with_version: bool,
+    read: bool,
+    read_with_if_match: bool,
+    read_with_if_none_match: bool,
+    read_with_override_cache_control: bool,
+    read_with_override_content_disposition: bool,
+    read_with_override_content_type: bool,
+    read_with_version: bool,
+    write: bool,
+    write_can_multi: bool,
+    write_can_empty: bool,
+    write_can_append: bool,
+    write_with_content_type: bool,
+    write_with_content_disposition: bool,
+    write_with_cache_control: bool,
+    write_with_if_none_match: bool,
+    write_with_user_metadata: bool,
+    write_multi_max_size: Option<usize>,
+    write_multi_min_size: Option<usize>,
+    write_total_max_size: Option<usize>,
+    create_dir: bool,
+    delete: bool,
+    delete_with_version: bool,
+    copy: bool,
+    rename: bool,
+    list: bool,
+    list_with_limit: bool,
+    list_with_start_after: bool,
+    list_with_recursive: bool,
+    list_with_versions: bool,
+    presign: bool,
+    presign_read: bool,
+    presign_stat: bool,
+    presign_write: bool,
+});
+
+// includes class into the Ruby module
+pub fn include(ruby: &Ruby, gem_module: &RModule) -> Result<(), Error> {
+    let class = gem_module.define_class("Capability", ruby.class_object())?;
+    bind_methods_to_ruby!(class, {
+        stat,
+        stat_with_if_match,
+        stat_with_if_none_match,
+        stat_with_override_cache_control,
+        stat_with_override_content_disposition,
+        stat_with_override_content_type,
+        stat_with_version,
+        read,
+        read_with_if_match,
+        read_with_if_none_match,
+        read_with_override_cache_control,
+        read_with_override_content_disposition,
+        read_with_override_content_type,
+        read_with_version,
+        write,
+        write_can_multi,
+        write_can_empty,
+        write_can_append,
+        write_with_content_type,
+        write_with_content_disposition,
+        write_with_cache_control,
+        write_with_if_none_match,
+        write_with_user_metadata,
+        write_multi_max_size,
+        write_multi_min_size,
+        write_total_max_size,
+        create_dir,
+        delete,
+        delete_with_version,
+        copy,
+        rename,
+        list,
+        list_with_limit,
+        list_with_start_after,
+        list_with_recursive,
+        list_with_versions,
+        presign,
+        presign_read,
+        presign_stat,
+        presign_write,
+    });
+
+    Ok(())
+}