red-arrow 2.0.0 → 5.0.0

data/lib/arrow/scalar.rb

@@ -0,0 +1,32 @@
+# 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.
+
+module Arrow
+  class Scalar
+    # @param other [Arrow::Scalar] The scalar to be compared.
+    # @param options [Arrow::EqualOptions, Hash] (nil)
+    #   The options to custom how to compare.
+    #
+    # @return [Boolean]
+    #   `true` if both of them have the same data, `false` otherwise.
+    #
+    # @since 5.0.0
+    def equal_scalar?(other, options=nil)
+      equal_options(other, options)
+    end
+  end
+end

data/lib/arrow/sort-key.rb

@@ -0,0 +1,193 @@
+# 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.
+
+module Arrow
+  class SortKey
+    class << self
+      # Ensure returning suitable {Arrow::SortKey}.
+      #
+      # @overload resolve(sort_key)
+      #
+      #   Returns the given sort key itself. This is convenient to use
+      #   this method as {Arrow::SortKey} converter.
+      #
+      #   @param sort_key [Arrow::SortKey] The sort key.
+      #
+      #   @return [Arrow::SortKey] The given sort key itself.
+      #
+      # @overload resolve(name)
+      #
+      #   Creates a new suitable sort key from column name with
+      #   leading order mark. See {#initialize} for details about
+      #   order mark.
+      #
+      #   @return [Arrow::SortKey] A new suitable sort key.
+      #
+      # @overload resolve(name, order)
+      #
+      #   Creates a new suitable sort key from column name without
+      #   leading order mark and order. See {#initialize} for details.
+      #
+      #   @return [Arrow::SortKey] A new suitable sort key.
+      #
+      # @since 4.0.0
+      def resolve(name, order=nil)
+        return name if name.is_a?(self)
+        new(name, order)
+      end
+
+      # @api private
+      def try_convert(value)
+        case value
+        when Symbol, String
+          new(value.to_s, :ascending)
+        else
+          nil
+        end
+      end
+    end
+
+    alias_method :initialize_raw, :initialize
+    private :initialize_raw
+    # Creates a new {Arrow::SortKey}.
+    #
+    # @overload initialize(name)
+    #
+    #   @param name [Symbol, String] The name of the sort column.
+    #
+    #     If `name` is a String, the first character may be processed
+    #     as the "leading order mark". If the first character is `"+"`
+    #     or `"-"`, they are processed as a leading order mark. If the
+    #     first character is processed as a leading order mark, the
+    #     first character is removed from sort column name and
+    #     corresponding order is used. `"+"` uses ascending order and
+    #     `"-"` uses ascending order.
+    #
+    #     If `name` is not a String nor `name` doesn't start with the
+    #     leading order mark, sort column name is `name` as-is and
+    #     ascending order is used.
+    #
+    #   @example String without the leading order mark
+    #     key = Arrow::SortKey.new("count")
+    #     key.name  # => "count"
+    #     key.order # => Arrow::SortOrder::ASCENDING
+    #
+    #   @example String with the "+" leading order mark
+    #     key = Arrow::SortKey.new("+count")
+    #     key.name  # => "count"
+    #     key.order # => Arrow::SortOrder::ASCENDING
+    #
+    #   @example String with the "-" leading order mark
+    #     key = Arrow::SortKey.new("-count")
+    #     key.name  # => "count"
+    #     key.order # => Arrow::SortOrder::DESCENDING
+    #
+    #   @example Symbol that starts with "-"
+    #     key = Arrow::SortKey.new(:"-count")
+    #     key.name  # => "-count"
+    #     key.order # => Arrow::SortOrder::ASCENDING
+    #
+    # @overload initialize(name, order)
+    #
+    #   @param name [Symbol, String] The name of the sort column.
+    #
+    #     No leading order mark processing. The given `name` is used
+    #     as-is.
+    #
+    #   @param order [Symbol, String, Arrow::SortOrder] How to order
+    #     by this sort key.
+    #
+    #     If this is a Symbol or String, this must be `:ascending`,
+    #     `"ascending"`, `:asc`, `"asc"`, `:descending`,
+    #     `"descending"`, `:desc` or `"desc"`.
+    #
+    #   @example No leading order mark processing
+    #     key = Arrow::SortKey.new("-count", :ascending)
+    #     key.name  # => "-count"
+    #     key.order # => Arrow::SortOrder::ASCENDING
+    #
+    #   @example Order by abbreviated name with Symbol
+    #     key = Arrow::SortKey.new("count", :desc)
+    #     key.name  # => "count"
+    #     key.order # => Arrow::SortOrder::DESCENDING
+    #
+    #   @example Order by String
+    #     key = Arrow::SortKey.new("count", "descending")
+    #     key.name  # => "count"
+    #     key.order # => Arrow::SortOrder::DESCENDING
+    #
+    #   @example Order by Arrow::SortOrder
+    #     key = Arrow::SortKey.new("count", Arrow::SortOrder::DESCENDING)
+    #     key.name  # => "count"
+    #     key.order # => Arrow::SortOrder::DESCENDING
+    #
+    # @since 4.0.0
+    def initialize(name, order=nil)
+      name, order = normalize_name(name, order)
+      order = normalize_order(order) || :ascending
+      initialize_raw(name, order)
+    end
+
+    # @return [String] The string representation of this sort key. You
+    #   can use recreate {Arrow::SortKey} by
+    #   `Arrow::SortKey.new(key.to_s)`.
+    #
+    # @example Recreate Arrow::SortKey
+    #   key = Arrow::SortKey.new("-count")
+    #   key.to_s # => "-count"
+    #   key == Arrow::SortKey.new(key.to_s) # => true
+    #
+    # @since 4.0.0
+    def to_s
+      if order == SortOrder::ASCENDING
+        "+#{name}"
+      else
+        "-#{name}"
+      end
+    end
+
+    private
+    def normalize_name(name, order)
+      case name
+      when Symbol
+        return name.to_s, order
+      when String
+        return name, order if order
+        if name.start_with?("-")
+          return name[1..-1], order || :descending
+        elsif name.start_with?("+")
+          return name[1..-1], order || :ascending
+        else
+          return name, order
+        end
+      else
+        return name, order
+      end
+    end
+
+    def normalize_order(order)
+      case order
+      when :asc, "asc"
+        :ascending
+      when :desc, "desc"
+        :descending
+      else
+        order
+      end
+    end
+  end
+end

data/lib/arrow/sort-options.rb

@@ -0,0 +1,109 @@
+# 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.
+
+module Arrow
+  class SortOptions
+    class << self
+      # @api private
+      def try_convert(value)
+        case value
+        when Symbol, String
+          new(value)
+        when ::Array
+          new(*value)
+        else
+          nil
+        end
+      end
+    end
+
+    alias_method :initialize_raw, :initialize
+    private :initialize_raw
+    # @param sort_keys [::Array<String, Symbol, Arrow::SortKey>] The
+    #   sort keys to be used. See {Arrow::SortKey.resolve} how to
+    #   resolve each sort key in `sort_keys`.
+    #
+    #   You can add more sort keys by {#add_sort_key} later.
+    #
+    # @example No initial sort keys
+    #   options = Arrow::SortOptions.new
+    #   options.sort_keys # => []
+    #
+    # @example String sort keys
+    #   options = Arrow::SortOptions.new("count", "-age")
+    #   options.sort_keys.collect(&:to_s) # => ["+count", "-age"]
+    #
+    # @example Symbol sort keys
+    #   options = Arrow::SortOptions.new(:count, :age)
+    #   options.sort_keys.collect(&:to_s) # => ["+count", "+age"]
+    #
+    # @example Mixed sort keys
+    #   options = Arrow::SortOptions.new(:count, "-age")
+    #   options.sort_keys.collect(&:to_s) # => ["+count", "-age"]
+    #
+    # @since 4.0.0
+    def initialize(*sort_keys)
+      initialize_raw
+      sort_keys.each do |sort_key|
+        add_sort_key(sort_key)
+      end
+    end
+
+    # @api private
+    alias_method :add_sort_key_raw, :add_sort_key
+    # Add a sort key.
+    #
+    # @return [void]
+    #
+    # @overload add_sort_key(key)
+    #
+    #   @param key [Arrow::SortKey] The sort key to be added.
+    #
+    #   @example Add a key to sort by "price" column in descending order
+    #     options = Arrow::SortOptions.new
+    #     options.add_sort_key(Arrow::SortKey.new(:price, :descending))
+    #     options.sort_keys.collect(&:to_s) # => ["-price"]
+    #
+    # @overload add_sort_key(name)
+    #
+    #   @param name [Symbol, String] The sort key name to be
+    #     added. See also {Arrow::SortKey#initialize} for the leading
+    #     order mark for String name.
+    #
+    #   @example Add a key to sort by "price" column in descending order
+    #     options = Arrow::SortOptions.new
+    #     options.add_sort_key("-price")
+    #     options.sort_keys.collect(&:to_s) # => ["-price"]
+    #
+    # @overload add_sort_key(name, order)
+    #
+    #   @param name [Symbol, String] The sort key name.
+    #
+    #   @param order [Symbol, String, Arrow::SortOrder] The sort
+    #     order. See {Arrow::SortKey#initialize} for details.
+    #
+    #   @example Add a key to sort by "price" column in descending order
+    #     options = Arrow::SortOptions.new
+    #     options.add_sort_key("price", :desc)
+    #     options.sort_keys.collect(&:to_s) # => ["-price"]
+    #
+    # @since 4.0.0
+    def add_sort_key(name, order=nil)
+      add_sort_key_raw(SortKey.resolve(name, order))
+    end
+  end
+end

data/lib/arrow/sparse-union-data-type.rb

@@ -33,7 +33,7 @@ module Arrow
     #   @param type_codes [::Array<Integer>] The IDs that indicates
     #     corresponding fields.
     #
-    #   @example Create a sparse union data type for {2: visible, 9: count}
+    #   @example Create a sparse union data type for `{2: visible, 9: count}`
     #     fields = [
     #       Arrow::Field.new("visible", :boolean),
     #       {
@@ -57,7 +57,7 @@ module Arrow
     #   @option description [::Array<Integer>] :type_codes The IDs
     #     that indicates corresponding fields.
     #
-    #   @example Create a sparse union data type for {2: visible, 9: count}
+    #   @example Create a sparse union data type for `{2: visible, 9: count}`
     #     fields = [
     #       Arrow::Field.new("visible", :boolean),
     #       {

data/lib/arrow/table.rb

@@ -442,8 +442,8 @@ module Arrow
       RollingWindow.new(self, size)
     end
 
-    def save(path, options={})
-      saver = TableSaver.new(self, path, options)
+    def save(output, options={})
+      saver = TableSaver.new(self, output, options)
       saver.save
     end
 

data/lib/arrow/time32-data-type.rb

@@ -29,7 +29,7 @@ module Arrow
     #
     #     The unit must be second or millisecond.
     #
-    #   @example Create a time32 data type with {Arrow::TimeUnit}
+    #   @example Create a time32 data type with Arrow::TimeUnit
     #     Arrow::Time32DataType.new(Arrow::TimeUnit::MILLI)
     #
     #   @example Create a time32 data type with Symbol
@@ -45,7 +45,7 @@ module Arrow
     #
     #     The unit must be second or millisecond.
     #
-    #   @example Create a time32 data type with {Arrow::TimeUnit}
+    #   @example Create a time32 data type with Arrow::TimeUnit
     #     Arrow::Time32DataType.new(unit: Arrow::TimeUnit::MILLI)
     #
     #   @example Create a time32 data type with Symbol

data/lib/arrow/time64-data-type.rb

@@ -29,7 +29,7 @@ module Arrow
     #
     #     The unit must be microsecond or nanosecond.
     #
-    #   @example Create a time64 data type with {Arrow::TimeUnit}
+    #   @example Create a time64 data type with Arrow::TimeUnit
     #     Arrow::Time64DataType.new(Arrow::TimeUnit::NANO)
     #
     #   @example Create a time64 data type with Symbol
@@ -45,7 +45,7 @@ module Arrow
     #
     #     The unit must be microsecond or nanosecond.
     #
-    #   @example Create a time64 data type with {Arrow::TimeUnit}
+    #   @example Create a time64 data type with Arrow::TimeUnit
     #     Arrow::Time64DataType.new(unit: Arrow::TimeUnit::NANO)
     #
     #   @example Create a time64 data type with Symbol

data/lib/arrow/timestamp-data-type.rb

@@ -27,7 +27,7 @@ module Arrow
     #   @param unit [Arrow::TimeUnit, Symbol] The unit of the
     #     timestamp data type.
     #
-    #   @example Create a timestamp data type with {Arrow::TimeUnit}
+    #   @example Create a timestamp data type with Arrow::TimeUnit
     #     Arrow::TimestampDataType.new(Arrow::TimeUnit::MILLI)
     #
     #   @example Create a timestamp data type with Symbol
@@ -41,7 +41,7 @@ module Arrow
     #   @option description [Arrow::TimeUnit, Symbol] :unit The unit of
     #     the timestamp data type.
     #
-    #   @example Create a timestamp data type with {Arrow::TimeUnit}
+    #   @example Create a timestamp data type with Arrow::TimeUnit
     #     Arrow::TimestampDataType.new(unit: Arrow::TimeUnit::MILLI)
     #
     #   @example Create a timestamp data type with Symbol

data/lib/arrow/version.rb

@@ -16,7 +16,7 @@
 # under the License.
 
 module Arrow
-  VERSION = "2.0.0"
+  VERSION = "5.0.0"
 
   module Version
     numbers, TAG = VERSION.split("-")

data/red-arrow.gemspec

@@ -46,14 +46,16 @@ Gem::Specification.new do |spec|
   spec.test_files += Dir.glob("test/**/*")
   spec.extensions = ["ext/arrow/extconf.rb"]
 
+  spec.add_runtime_dependency("bigdecimal", ">= 2.0.3")
   spec.add_runtime_dependency("extpp", ">= 0.0.7")
-  spec.add_runtime_dependency("gio2", ">= 3.3.6")
+  spec.add_runtime_dependency("gio2", ">= 3.4.5")
   spec.add_runtime_dependency("native-package-installer")
   spec.add_runtime_dependency("pkg-config")
 
   spec.add_development_dependency("benchmark-driver")
   spec.add_development_dependency("bundler")
   spec.add_development_dependency("faker")
+  spec.add_development_dependency("fiddle", ">= 1.0.9")
   spec.add_development_dependency("rake")
   spec.add_development_dependency("redcarpet")
   spec.add_development_dependency("test-unit")