red-arrow 1.0.0 → 4.0.1

data/lib/arrow/decimal256-array-builder.rb

@@ -0,0 +1,61 @@
+# 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 Decimal256ArrayBuilder
+    class << self
+      # @since 3.0.0
+      def build(data_type, values)
+        builder = new(data_type)
+        builder.build(values)
+      end
+    end
+
+    alias_method :append_value_raw, :append_value
+    # @since 3.0.0
+    def append_value(value)
+      append_value_raw(normalize_value(value))
+    end
+
+    alias_method :append_values_raw, :append_values
+    # @since 3.0.0
+    def append_values(values, is_valids=nil)
+      if values.is_a?(::Array)
+        values = values.collect do |value|
+          normalize_value(value)
+        end
+        append_values_raw(values, is_valids)
+      else
+        append_values_packed(values, is_valids)
+      end
+    end
+
+    private
+    def normalize_value(value)
+      case value
+      when String
+        Decimal256.new(value)
+      when Float
+        Decimal256.new(value.to_s)
+      when BigDecimal
+        Decimal256.new(value.to_s)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/arrow/decimal256-array.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.
+
+module Arrow
+  class Decimal256Array
+    # @since 3.0.0
+    def get_value(i)
+      BigDecimal(format_value(i))
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# 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 Decimal256DataType
+    MAX_PRECISION = max_precision
+
+    alias_method :initialize_raw, :initialize
+    private :initialize_raw
+
+    # Creates a new {Arrow::Decimal256DataType}.
+    #
+    # @overload initialize(precision, scale)
+    #
+    #   @param precision [Integer] The precision of the decimal data
+    #     type. It's the number of digits including the number of
+    #     digits after the decimal point.
+    #
+    #   @param scale [Integer] The scale of the decimal data
+    #     type. It's the number of digits after the decimal point.
+    #
+    #   @example Create a decimal data type for "XXXXXX.YY" decimal
+    #     Arrow::Decimal256DataType.new(8, 2)
+    #
+    # @overload initialize(description)
+    #
+    #   @param description [Hash] The description of the decimal data
+    #     type. It must have `:precision` and `:scale` values.
+    #
+    #   @option description [Integer] :precision The precision of the
+    #     decimal data type. It's the number of digits including the
+    #     number of digits after the decimal point.
+    #
+    #   @option description [Integer] :scale The scale of the decimal
+    #     data type. It's the number of digits after the decimal
+    #     point.
+    #
+    #   @example Create a decimal data type for "XXXXXX.YY" decimal
+    #     Arrow::Decimal256DataType.new(precision: 8,
+    #                                   scale: 2)
+    #
+    # @since 3.0.0
+    def initialize(*args)
+      n_args = args.size
+      case n_args
+      when 1
+        description = args[0]
+        precision = description[:precision]
+        scale = description[:scale]
+      when 2
+        precision, scale = args
+      else
+        message = "wrong number of arguments (given, #{n_args}, expected 1..2)"
+        raise ArgumentError, message
+      end
+      initialize_raw(precision, scale)
+    end
+  end
+end

data/lib/arrow/decimal256.rb

@@ -0,0 +1,60 @@
+# 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 Decimal256
+    alias_method :to_s_raw, :to_s
+
+    # @overload to_s
+    #
+    #   @return [String]
+    #     The string representation of the decimal.
+    #
+    # @overload to_s(scale)
+    #
+    #   @param scale [Integer] The scale of the decimal.
+    #   @return [String]
+    #      The string representation of the decimal including the scale.
+    #
+    # @since 3.0.0
+    def to_s(scale=nil)
+      if scale
+        to_string_scale(scale)
+      else
+        to_s_raw
+      end
+    end
+
+    alias_method :abs!, :abs
+
+    # @since 3.0.0
+    def abs
+      copied = dup
+      copied.abs!
+      copied
+    end
+
+    alias_method :negate!, :negate
+
+    # @since 3.0.0
+    def negate
+      copied = dup
+      copied.negate!
+      copied
+    end
+  end
+end

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

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

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

@@ -50,7 +50,7 @@ module Arrow
     #   @param ordered [Boolean] Whether dictionary contents are
     #     ordered or not.
     #
-    #   @example Create a dictionary data type for {0: "Hello", 1: "World"}
+    #   @example Create a dictionary data type for `{0: "Hello", 1: "World"}`
     #     index_data_type = :int8
     #     value_data_type = :string
     #     ordered = true
@@ -91,7 +91,7 @@ module Arrow
     #   @option description [Boolean] :ordered Whether dictionary
     #     contents are ordered or not.
     #
-    #   @example Create a dictionary data type for {0: "Hello", 1: "World"}
+    #   @example Create a dictionary data type for `{0: "Hello", 1: "World"}`
     #     Arrow::DictionaryDataType.new(index_data_type: :int8,
     #                                   value_data_type: :string,
     #                                   ordered: true)

data/lib/arrow/fixed-size-binary-array-builder.rb

@@ -0,0 +1,38 @@
+# 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 FixedSizeBinaryArrayBuilder
+    class << self
+      # @since 3.0.0
+      def build(data_type, values)
+        builder = new(data_type)
+        builder.build(values)
+      end
+    end
+
+    alias_method :append_values_raw, :append_values
+    # @since 3.0.0
+    def append_values(values, is_valids=nil)
+      if values.is_a?(::Array)
+        append_values_raw(values, is_valids)
+      else
+        append_values_packed(values, is_valids)
+      end
+    end
+  end
+end

data/lib/arrow/fixed-size-binary-array.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.
+
+module Arrow
+  class FixedSizeBinaryArray
+    alias_method :get_value_raw, :get_value
+    # @since 3.0.0
+    def get_value(i)
+      get_value_raw(i).to_s
+    end
+  end
+end

data/lib/arrow/loader.rb

@@ -56,11 +56,17 @@ module Arrow
       require "arrow/decimal128-array"
       require "arrow/decimal128-array-builder"
       require "arrow/decimal128-data-type"
+      require "arrow/decimal256"
+      require "arrow/decimal256-array"
+      require "arrow/decimal256-array-builder"
+      require "arrow/decimal256-data-type"
       require "arrow/dense-union-data-type"
       require "arrow/dictionary-array"
       require "arrow/dictionary-data-type"
       require "arrow/field"
       require "arrow/file-output-stream"
+      require "arrow/fixed-size-binary-array"
+      require "arrow/fixed-size-binary-array-builder"
       require "arrow/group"
       require "arrow/list-array-builder"
       require "arrow/list-data-type"
@@ -76,6 +82,8 @@ module Arrow
       require "arrow/rolling-window"
       require "arrow/schema"
       require "arrow/slicer"
+      require "arrow/sort-key"
+      require "arrow/sort-options"
       require "arrow/sparse-union-data-type"
       require "arrow/struct-array"
       require "arrow/struct-array-builder"
@@ -141,6 +149,7 @@ module Arrow
       when "Arrow::Date32Array",
            "Arrow::Date64Array",
            "Arrow::Decimal128Array",
+           "Arrow::Decimal256Array",
            "Arrow::Time32Array",
            "Arrow::Time64Array",
            "Arrow::TimestampArray"
@@ -149,6 +158,12 @@ module Arrow
           method_name = "get_raw_value"
         end
         super(info, klass, method_name)
+      when "Arrow::Decimal128", "Arrow::Decimal256"
+        case method_name
+        when "copy"
+          method_name = "dup"
+        end
+        super(info, klass, method_name)
       else
         super
       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