strong_csv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a6324b338c8922470db715a4db9aac4d29a7e658313326df6b860a51eda09a5
+  data.tar.gz: '095654b19ea937ca862c91b98e4c59d29f8ddd148d0cb2feac594edf1ea54a1f'
+SHA512:
+  metadata.gz: 9d729e901fcbe7b6cecbe7b0470d5dffaa4c51f7a11269b1f0b2db188c633ee46fb569fab333343268d9f2235ce790508bc0070e6d716888bdfb8ae08c75011c
+  data.tar.gz: 3cfc376f86564afea311afae002488172c9b01ec4676791e7c78b3192495361ddc9f9531a57987c7235c7420acf04819c265c29213a9282c23a93c45af5aae4f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Yutaka Kamei
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+# strong_csv
+
+NOTE: This repository is still under development 🚧🚜🚧
+
+Type checker for a CSV file inspired by [strong_json](https://github.com/soutaro/strong_json).
+
+**Motivation**
+
+Some applications have a feature to receive a CSV file uploaded by a user,
+and in general, it needs to validate each cell of the CSV file.
+
+How should applications validate them?
+Of course, it depends, but there would be common validation logic for CSV files.
+For example, some columns may have to be integers because of database requirements.
+It would be cumbersome to write such validations always.
+
+strong_json helps you to mitigate such a drudgery by letting you declare desired types beforehand.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'strong_csv'
+```
+
+And then execute:
+
+```console
+bundle
+```
+
+Or install it yourself as:
+
+```console
+gem install strong_csv
+```
+
+## Usage
+
+TBD: This hasn't yet been implemented.
+
+```ruby
+strong_csv = StrongCSV.new do
+  let :stock, integer
+  let :tax_rate, float
+  let :name, string(255)
+  let :description, string?(1000)
+  let :active, boolean
+  let :started_at, time?
+  let :data, any?
+
+  # Literal declaration
+  let :status, 0..6
+  let :priority, 10 | 20 | 30 | 40 | 50
+  let :size, "S" | "M" | "L" do |value|
+    case value
+    when "S"
+      1
+    when "M"
+      2
+    when "L"
+      3
+    end
+  end
+
+  # Regular expressions
+  let :url, %r{\Ahttps://}
+
+  # Custom validation.
+  #
+  # This example sees the database to fetch exactly stored `User` IDs,
+  # and it checks the `:user_id` cell really exists in the `users` table.
+  # `pick` would be useful to avoid N+1 problems.
+  pick :user_id, as: :user_ids do |ids|
+    User.where(id: ids).ids
+  end
+  let :user_id, integer { |i| user_ids.include?(i) }
+end
+
+data = <<~CSV
+  stock,tax_rate,name,active,status,priority,size,url
+  12,0.8,special item,True,4,20,M,https://example.com
+CSV
+
+strong_csv.parse(data, field_size_limit: 2048) do |row|
+  if row.valid?
+    row[:tax_rate] # => 0.8
+    row[:active] # => true
+    # do something with row
+  else
+    row.errors # => [{ row: 2, column: :user_id, messages: ["must be present", "must be an Integer", "must satisfy the custom validation"] }]
+    # do something with row.errors
+  end
+end
+```
+
+## Available types
+
+| Type    | Description                         |
+| ------- | ----------------------------------- |
+| integer | The value must be casted to Integer |
+
+## Contributing
+
+Bug reports and pull requests are welcome on the [GitHub repository](https://github.com/yykamei/strong_csv).
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the
+[code of conduct](https://github.com/yykamei/strong_csv/blob/main/CODE_OF_CONDUCT.md).

data/lib/strong_csv/let.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class StrongCSV
+  # Let is a class that is used to define types for columns.
+  class Let
+    attr_reader :types, :headers
+
+    def initialize
+      @types = {}
+      @headers = false
+    end
+
+    # @param name [String, Symbol, Integer]
+    def let(name, type)
+      case name
+      when Integer
+        @types[name] = type
+      when String, Symbol
+        @types[name.to_sym] = type
+      else
+        raise TypeError, "Invalid type specified for `name`. `name` must be String, Symbol, or Integer: #{name.inspect}"
+      end
+      validate_columns
+    end
+
+    def integer
+      Types::Integer.new
+    end
+
+    private
+
+    def validate_columns
+      if @types.keys.all? { |k| k.is_a?(Integer) }
+        @headers = false
+      elsif @types.keys.all? { |k| k.is_a?(Symbol) }
+        @headers = true
+      else
+        raise ArgumentError, "`types` cannot be mixed with Integer and Symbol keys: #{@types.keys.inspect}"
+      end
+    end
+  end
+end

data/lib/strong_csv/row.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class StrongCSV
+  # Row is a representation of a row in a CSV file, which has casted values with specified types.
+  class Row
+    extend Forwardable
+
+    def_delegators :@values, :[], :fetch
+
+    # @return [Hash]
+    attr_reader :errors
+
+    # @return [Integer]
+    attr_reader :lineno
+
+    # @param row [Array<String>, CSV::Row]
+    # @param types [Hash]
+    # @param lineno [Integer]
+    def initialize(row:, types:, lineno:)
+      @values = {}
+      @errors = {}
+      @lineno = lineno
+      types.each do |key, type|
+        value_result = type.cast(row[key])
+        @values[key] = value_result.value
+        @errors[key] = value_result.error_message unless value_result.success?
+      end
+    end
+
+    def valid?
+      @errors.empty?
+    end
+  end
+end

data/lib/strong_csv/types/base.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class StrongCSV
+  module Types
+    # Base class for all types.
+    class Base
+      def cast(_value)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/strong_csv/types/integer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class StrongCSV
+  module Types
+    # Integer type
+    class Integer < Base
+      # @todo Use :exception for Integer after we drop the support of Ruby 2.5
+      def cast(value)
+        ValueResult.new(value: Integer(value), original_value: value)
+      rescue ArgumentError, TypeError
+        ValueResult.new(original_value: value, error_message: "`#{value.inspect}` can't be casted to Integer")
+      end
+    end
+  end
+end

data/lib/strong_csv/value_result.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class StrongCSV
+  # ValueResult represents a CSV field is valid or not and contains its casted value if it's valid.
+  class ValueResult
+    DEFAULT_VALUE = Object.new
+    private_constant :DEFAULT_VALUE
+
+    # @return [String, nil] The error message for the field.
+    attr_reader :error_message
+
+    def initialize(original_value:, value: DEFAULT_VALUE, error_message: nil)
+      @value = value
+      @original_value = original_value
+      @error_message = error_message
+    end
+
+    # @return [Object] The casted value if it's valid. Otherwise, returns the original value.
+    def value
+      success? ? @value : @original_value
+    end
+
+    # @return [Boolean]
+    def success?
+      @error_message.nil?
+    end
+  end
+end

data/lib/strong_csv/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class StrongCSV
+  VERSION = "0.1.0"
+end

data/lib/strong_csv.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "csv"
+require "forwardable"
+
+require_relative "strong_csv/version"
+require_relative "strong_csv/let"
+require_relative "strong_csv/value_result"
+require_relative "strong_csv/types/base"
+require_relative "strong_csv/types/integer"
+require_relative "strong_csv/row"
+
+# The top-level namespace for the strong_csv gem.
+class StrongCSV
+  class Error < StandardError; end
+
+  def initialize(&block)
+    @let = Let.new
+    @let.instance_eval(&block) if block_given?
+  end
+
+  # @param csv [String, IO]
+  # @param options [Hash] CSV options for parsing.
+  def parse(csv, **options)
+    options = options.merge(headers: @let.headers, header_converters: :symbol)
+    csv = CSV.new(csv, **options)
+    if block_given?
+      csv.each do |row|
+        yield Row.new(row: row, types: @let.types, lineno: csv.lineno)
+      end
+    else
+      csv.each.map { |row| Row.new(row: row, types: @let.types, lineno: csv.lineno) }
+    end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: strong_csv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yutaka Kamei
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-04-26 00:00:00.000000000 Z
+dependencies: []
+description: strong_csv is a type checker for a CSV file. It lets developers declare
+  types for each column to ensure all cells are satisfied with desired types.
+email:
+- kamei@yykamei.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/strong_csv.rb
+- lib/strong_csv/let.rb
+- lib/strong_csv/row.rb
+- lib/strong_csv/types/base.rb
+- lib/strong_csv/types/integer.rb
+- lib/strong_csv/value_result.rb
+- lib/strong_csv/version.rb
+homepage: https://github.com/yykamei/strong_csv
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yykamei/strong_csv
+  source_code_uri: https://github.com/yykamei/strong_csv
+  changelog_uri: https://github.com/yykamei/strong_csv/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Type check CSV objects
+test_files: []