tabulard 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37d1717d37660df0f23595ffc330f02e879bfb1120d48e21ab2ef9618b70e4a0
+  data.tar.gz: 1cd3e6db0b7d53e8f9bf99256d70a41ba3be98672992ab0e50ea497215b1fea1
+SHA512:
+  metadata.gz: 6925cbea3514865542b508f1f125c7eb61090e6574440eb26a4be8a5a92cb84dbf942d59d0e6308b9bf7d774c7f42984102ef5ee359ae58f51778b493e6aaf2c
+  data.tar.gz: 9f4dcfd80596aa30d1875ca1755bf4f61b896d27eb37fa21de326ccda2bb73919a480ad807da7de418e4570549784a7809a1d946b0f46e63818b7167d50012a0

data/LICENSE

@@ -0,0 +1,202 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2022 Steeple
+Copyright 2024 Erwan Thomas
+
+Licensed 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.

data/README.md

@@ -0,0 +1,43 @@
+# Tabulard
+
+Tabulard is a library designed to process tabular data of any kind. It
+is able to handle anything that looks like a table, and currently
+provides dedicated adapters for CSV documents and XSLX sheets.
+
+It focuses on typed results and fine-grain error management, while being
+performant enough to handle (very) large documents and keep a low memory
+footprint.
+
+## Documentation
+
+The following resources document the latest valid state of the `master`
+branch:
+
+- [Ruby API](https://tabulard.github.io/tabulard/ruby)
+- [Coverage](https://tabulard.github.io/tabulard/coverage)
+
+## Usage
+
+Add the following to your Gemfile:
+
+```ruby
+gem "tabulard", require: "sheetah/frozen"
+```
+
+Then `bundle install`.
+
+For examples of common use cases, please have a look at `spec/sheetah_spec.rb`.
+
+## Project status
+
+Tabulard already works pretty well but is still under active
+development.
+
+It started as a fork of [Sheetah](https://github.com/steeple-org/sheetah),
+a library used in production at Steeple and originally authored by the
+now-maintainer of Tabulard.
+
+For now, Tabulard aims to stay mostly retrocompatible with Sheetah. That
+said, retrocompatibility is not a long-term goal of Tabulard, as its
+roadmap will eventually bring important changes that can't be compatible
+with Sheetah (such as renaming the top-level Ruby module, for example).

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/sheetah/attribute.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative "attribute_types"
+require_relative "column"
+
+module Sheetah
+  # The main building block of a {Template}.
+  class Attribute
+    # A smarter version of {#initialize}.
+    #
+    # - It automatically freezes the instance before returning it.
+    # - It instantiates and injects a type automatically by passing the arguments to
+    #   {AttributeTypes.build}.
+    #
+    # @return [Attribute] a frozen instance
+    def self.build(key:, type:)
+      type = AttributeTypes.build(type)
+
+      attribute = new(key: key, type: type)
+      attribute.freeze
+    end
+
+    # @param key [String, Symbol] The key in the resulting Hash after processing a row.
+    # @param type [AttributeType] The type of the value.
+    def initialize(key:, type:)
+      @key = key
+      @type = type
+    end
+
+    # @return [Symbol, String]
+    attr_reader :key
+
+    # An abstract specification of the type of a value in the resulting hash.
+    #
+    # It will be used to produce the {Types::Type concrete type} of a column (or a list of columns)
+    # when a {TemplateConfig} is {Template#apply applied} to the {Template} owning the attribtue.
+    #
+    # @return [AttributeType]
+    attr_reader :type
+
+    def each_column(config)
+      return enum_for(:each_column, config) unless block_given?
+
+      compiled_type = type.compile(config.types)
+
+      type.each_column do |index, required|
+        header, header_pattern = config.header(key, index)
+
+        yield Column.new(
+          key: key,
+          type: compiled_type,
+          index: index,
+          header: header,
+          header_pattern: header_pattern,
+          required: required
+        )
+      end
+    end
+  end
+end

data/lib/sheetah/attribute_types/composite.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "value"
+
+module Sheetah
+  module AttributeTypes
+    class Composite
+      # A smarter version of {#initialize}.
+      #
+      # - It automatically freezes the instance before returning it.
+      # - It instantiates, freezes and injects a list of values automatically by mapping the given
+      #   list of scalars to a list of {Value values} using {Value.build}.
+      #
+      # @return [Composite] a frozen instance
+      def self.build(composite:, scalars:)
+        scalars = scalars.map { |scalar| Value.build(scalar) }
+        scalars.freeze
+
+        composite = new(composite: composite, scalars: scalars)
+        composite.freeze
+      end
+
+      # @param composite [Symbol] The name used to refer to a composite type from a
+      #   {Types::Container}.
+      # @param scalars [Array<Value>] The list of values of the composite.
+      # @see .build
+      def initialize(composite:, scalars:)
+        @composite_type = composite
+        @values = scalars
+      end
+
+      def compile(container)
+        container.composite(composite_type, values.map(&:type))
+      end
+
+      def each_column
+        return enum_for(:each_column) { values.size } unless block_given?
+
+        values.each_with_index do |value, index|
+          yield index, value.required
+        end
+
+        self
+      end
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          composite_type == other.composite_type &&
+          values == other.values
+      end
+
+      protected
+
+      attr_reader :composite_type, :values
+    end
+  end
+end

data/lib/sheetah/attribute_types/scalar.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative "value"
+
+module Sheetah
+  module AttributeTypes
+    # @see AttributeType
+    class Scalar
+      # @!parse
+      #   include AttributeType
+
+      # A smarter version of {#initialize}.
+      #
+      # - It automatically freezes the instance before returning it.
+      # - It instantiates and injects a value automatically by passing the arguments to
+      #   {Value.build}.
+      #
+      # The method signature is identical to the one of {Value.build}.
+      #
+      # @return [Scalar] a frozen instance
+      def self.build(...)
+        value = Value.build(...)
+
+        scalar = new(value)
+        scalar.freeze
+      end
+
+      # @param value [Value] The value of the scalar.
+      # @see .build
+      def initialize(value)
+        @value = value
+      end
+
+      # @see AttributeType#compile
+      def compile(container)
+        container.scalar(value.type)
+      end
+
+      # @see AttributeType#each_column
+      def each_column
+        return enum_for(:each_column) { 1 } unless block_given?
+
+        yield nil, value.required
+
+        self
+      end
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          value == other.value
+      end
+
+      protected
+
+      attr_reader :value
+    end
+  end
+end

data/lib/sheetah/attribute_types/value.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Sheetah
+  module AttributeTypes
+    class Value
+      # A smarter version of {#initialize}.
+      #
+      # - It automatically freezes the instance before returning it.
+      # - It accepts two kinds of parameters: either those of {#initialize}, or a shortcut. See the
+      #   overloaded method signature for details.
+      #
+      # @overload def build(type:, required:)
+      #   @example
+      #     Value.build(type: :foo, required: true)
+      #   @see #initialize
+      #
+      # @overload def build(type)
+      #   @param type [Symbol] The name of the type, optionally suffixed with `!` to indicate that
+      #     the value is required.
+      #   @example
+      #     Value.build(:foo) #=> Value.build(type: :foo, required: false)
+      #     Value.build(:foo!) #=> Value.build(type: :foo, required: true)
+      #
+      # @return [Value] a frozen instance
+      def self.build(arg)
+        value = arg.is_a?(Hash) ? new(**arg) : from_type_name(arg)
+        value.freeze
+      end
+
+      def self.from_type_name(type)
+        type = type.to_s
+
+        optional = type.end_with?("?")
+        type = (optional ? type.slice(0..-2) : type).to_sym
+
+        new(type: type, required: !optional)
+      end
+
+      private_class_method :from_type_name
+
+      # @param type [Symbol] The name used to refer to a scalar type from a {Types::Container}.
+      # @param required [Boolean] Is the value required to be given in the input ?
+      # @see .build
+      def initialize(type:, required: true)
+        @type = type
+        @required = required
+      end
+
+      # @return [Symbol]
+      attr_reader :type
+
+      # @return [Boolean]
+      attr_reader :required
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          type == other.type &&
+          required == other.required
+      end
+    end
+  end
+end

data/lib/sheetah/attribute_types/value.rb.orig

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Sheetah
+  module AttributeTypes
+    class Value
+      # A smarter version of {#initialize}.
+      #
+      # - It automatically freezes the instance before returning it.
+      # - It accepts two kinds of parameters: either those of {#initialize}, or a shortcut. See the
+      #   overloaded method signature for details.
+      #
+      # @overload def build(type:, required:)
+      #   @example
+      #     Value.build(type: :foo, required: true)
+      #   @see #initialize
+      #
+      # @overload def build(type)
+      #   @param type [Symbol] The name of the type, optionally suffixed with `!` to indicate that
+      #     the value is required.
+      #   @example
+      #     Value.build(:foo) #=> Value.build(type: :foo, required: false)
+      #     Value.build(:foo!) #=> Value.build(type: :foo, required: true)
+      #
+      # @return [Value] a frozen instance
+      def self.build(arg)
+        value = arg.is_a?(Hash) ? new(**arg) : from_type_name(arg)
+        value.freeze
+      end
+
+      def self.from_type_name(type)
+        type = type.to_s
+
+        optional = type.end_with?("?")
+        type = (optional ? type.slice(0..-2) : type).to_sym
+
+        new(type: type, required: !optional)
+      end
+
+      private_class_method :from_type_name
+
+<<<<<<< HEAD
+      # @param type [Symbol] The name used to refer to a scalar type from a {Types::Container}.
+      # @param required [Boolean] Is the value required to be given in the input ?
+      # @see .build
+      def initialize(type:, required: false)
+||||||| parent of 98cec2b (Value required by default)
+      def initialize(type:, required: false)
+=======
+      def initialize(type:, required: true)
+>>>>>>> 98cec2b (Value required by default)
+        @type = type
+        @required = required
+      end
+
+      # @return [Symbol]
+      attr_reader :type
+
+      # @return [Boolean]
+      attr_reader :required
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          type == other.type &&
+          required == other.required
+      end
+    end
+  end
+end

data/lib/sheetah/attribute_types.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "attribute_types/scalar"
+require_relative "attribute_types/composite"
+
+module Sheetah
+  module AttributeTypes
+    # A factory for all {AttributeType}.
+    def self.build(type)
+      if type.is_a?(Hash) && type.key?(:composite)
+        Composite.build(**type)
+      elsif type.is_a?(Array)
+        Composite.build(composite: :array, scalars: type)
+      else
+        Scalar.build(type)
+      end
+    end
+  end
+
+  # @!parse
+  #  # The minimal interface of an {Attribute} type.
+  #  # @abstract It only exists to document the interface implemented by the different classes of
+  #  #   {AttributeTypes}.
+  #  module AttributeType
+  #    # A smarter version of `#initialize`, that will always return a frozen instance of the
+  #    # type, with optional syntactic sugar for its arguments compared to `#initialize`.
+  #    def self.build(*); end
+  #
+  #    # Given a type container, return the actual, usable type for the attribute.
+  #    # @param container [Types::Container]
+  #    # @return [Types::Type]
+  #    def compile(container); end
+  #
+  #    # Enumerate the columns (one or more) that may compose the attribute in the tabular
+  #    # document.
+  #    #
+  #    # @yieldparam index [Integer, nil]
+  #    #   If there is only one column involved, then `index` will be `nil`. Otherwise, `index`
+  #    #   will start at `0` and increase by `1` at each step.
+  #    # @yieldparam required [Boolean]
+  #    #   Whether the column must be present in the tabular document.
+  #    #
+  #    # @overload def each_column(&block)
+  #    #   @return [self]
+  #    # @overload def each_column
+  #    #   @return [Enumerator]
+  #    def each_column; end
+  #  end
+end