strong_csv 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c242c3b580ec02d431ae78bb7b8f370ef21248dae5fb89ea7ee158b0c9c04c6
-  data.tar.gz: 2d880a823b44c1da78eeb6b79196c56ff46e937efe86ac17e8a522ea8b97f4a0
+  metadata.gz: 558e352db4ff9f2f719b9bb9f6217c007ff679133e2b02449858af679289281d
+  data.tar.gz: ff9881d662a6301fbdfe30bab16f02e440fc6939d0b4e89482216d1fe8902450
 SHA512:
-  metadata.gz: 81bcf7718f3b792f6ecc394cccc5eb610b32ecb89b9dd492d3f39ab5dadebb633b1c9f4bd804de355902632fd1790fb3bb7b5789a7bb79a6eff6ee1860078491
-  data.tar.gz: 39d417143c5262d1ac781bdd5414d5021e5018b5791a0d6ed6df7c0954b008154c8bc6542ce5cdc184b00b3c4c40a5bcfc4366872610a123feb3af93c991901d
+  metadata.gz: 2dfc2c45143b4e4b435cb72627ce4a82311a5506e7fbe35449179684b2fb8ac048d509a23e1f8e08442c35d4188cdc5abc3cdd285165b1b8f1e69763b1993cf6
+  data.tar.gz: df17d984643c7830729a49c1284b60dafab1ddc14445d414d631bc87a135943cc9988cfb200f934c744d0b38cf8872a9d597ad422766cc89d08840c140f5dec4

data/README.md

@@ -14,7 +14,7 @@ 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.
+strong_csv helps you to mitigate such a drudgery by letting you declare desired types beforehand.
 
 ## Installation
 
@@ -61,6 +61,7 @@ strong_csv = StrongCSV.new do
   let :description, string?(within: 1..1000)
   let :active, boolean
   let :started_at, time?(format: "%Y-%m-%dT%H:%M:%S")
+  let :price, integer, error_message: "This should be Integer"
 
   # Literal declaration
   let :status, 0..6
@@ -91,8 +92,8 @@ strong_csv = StrongCSV.new do
 end
 
 data = <<~CSV
-  stock,tax_rate,name,active,status,priority,size,url
-  12,0.8,special item,True,4,20,M,https://example.com
+  stock,tax_rate,name,active,status,priority,size,url,price
+  12,0.8,special item,True,4,20,M,https://example.com,PRICE
 CSV
 
 strong_csv.parse(data, field_size_limit: 2048) do |row|
@@ -101,7 +102,7 @@ strong_csv.parse(data, field_size_limit: 2048) do |row|
     row[:active] # => true
     # do something with row
   else
-    row.errors # => { user_id: ["`nil` can't be casted to Integer"] }
+    row.errors # => {:price=>["This should be Integer"], :user_id=>["`nil` can't be casted to Integer"]}
     # do something with row.errors
   end
 end

data/lib/strong_csv/let.rb

@@ -13,7 +13,7 @@ class StrongCSV
     attr_reader :pickers
 
     def initialize
-      @types = {}
+      @types = []
       @headers = false
       @pickers = {}
       @picked = {}
@@ -22,13 +22,13 @@ class StrongCSV
     # @param name [String, Symbol, Integer]
     # @param type [StrongCSV::Type::Base]
     # @param types [Array<StrongCSV::Type::Base>]
-    def let(name, type, *types, &block)
+    def let(name, type, *types, error_message: nil, &block)
       type = types.empty? ? type : Types::Union.new(type, *types)
       case name
       when ::Integer
-        @types[name] = [type, block]
+        @types << TypeWrapper.new(name: name, type: type, block: block, error_message: error_message)
       when ::String, ::Symbol
-        @types[name.to_sym] = [type, block]
+        @types << TypeWrapper.new(name: name.to_sym, type: type, block: block, error_message: error_message)
       else
         raise TypeError, "Invalid type specified for `name`. `name` must be String, Symbol, or Integer: #{name.inspect}"
       end
@@ -112,12 +112,12 @@ class StrongCSV
     private
 
     def validate_columns
-      if @types.keys.all? { |k| k.is_a?(Integer) }
+      if @types.all? { |t| t.name.is_a?(Integer) }
         @headers = false
-      elsif @types.keys.all? { |k| k.is_a?(Symbol) }
+      elsif @types.all? { |k| k.name.is_a?(Symbol) }
         @headers = true
       else
-        raise ArgumentError, "`types` cannot be mixed with Integer and Symbol keys: #{@types.keys.inspect}"
+        raise ArgumentError, "`types` cannot be mixed with Integer and Symbol keys: #{@types.map(&:name).inspect}"
       end
     end
   end

data/lib/strong_csv/row.rb

@@ -4,7 +4,6 @@ class StrongCSV
   # Row is a representation of a row in a CSV file, which has casted values with specified types.
   class Row
     extend Forwardable
-    using Types::Literal
 
     def_delegators :@values, :[], :fetch, :slice
 
@@ -21,10 +20,10 @@ class StrongCSV
       @values = {}
       @errors = {}
       @lineno = lineno
-      types.each do |key, (type, block)|
-        value_result = type.cast(row[key])
-        @values[key] = block && value_result.success? ? block.call(value_result.value) : value_result.value
-        @errors[key] = value_result.error_messages unless value_result.success?
+      types.each do |wrapper|
+        cell = row[wrapper.name]
+        @values[wrapper.name], error = wrapper.cast(cell)
+        @errors[wrapper.name] = error if error
       end
     end
 

data/lib/strong_csv/type_wrapper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class StrongCSV # rubocop:disable Style/Documentation
+  using Types::Literal
+
+  # TypeWrapper holds the `type` along with `name` and `block`. It might be useful to store metadata for the type,
+  # such as `error_message`.
+  #
+  # @!attribute name
+  #   @return [Symbol, Integer] The name for the type. This is the CSV header name. If the CSV does not have its header, Integer should be set.
+  # @!attribute type
+  #   @return [StrongCSV::Type::Base]
+  # @!attribute error_message
+  #   @return [String, nil] The error message returned if #cast fails. If omitted, the default error message will be used.
+  # @!attribute block
+  #   @return [Proc]
+  TypeWrapper = Struct.new(:name, :type, :error_message, :block, keyword_init: true) do
+    def cast(value)
+      value_result = type.cast(value)
+      casted = block && value_result.success? ? block.call(value_result.value) : value_result.value
+      error = if value_result.success?
+                nil
+              else
+                error_message ? [error_message] : value_result.error_messages
+              end
+
+      [casted, error]
+    end
+  end
+end

data/lib/strong_csv/version.rb

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

data/lib/strong_csv.rb

@@ -16,6 +16,7 @@ require_relative "strong_csv/types/optional"
 require_relative "strong_csv/types/string"
 require_relative "strong_csv/types/time"
 require_relative "strong_csv/types/union"
+require_relative "strong_csv/type_wrapper"
 require_relative "strong_csv/let"
 require_relative "strong_csv/row"
 

data/sig/strong_csv.rbs

@@ -107,14 +107,13 @@ class StrongCSV
   class Let
     @picked: Hash[untyped, untyped]
 
-    attr_reader types: Hash[column, [declarable, ^(casted) -> untyped | nil]]
+    attr_reader types: Array[TypeWrapper]
     attr_reader headers: bool
     attr_reader pickers: Hash[untyped, Proc]
 
     def initialize: -> void
 
-    def let: (::String | column, declarable, *declarable) -> void
-      | (::String | column, declarable, *declarable) { (casted) -> untyped } -> void
+    def let: (::String | column, declarable, *declarable, ?error_message: ::String?) ?{ (casted) -> untyped } -> void
 
     def pick: (column, as: ::Symbol) { (Array[::String]) -> untyped } -> void
 
@@ -153,11 +152,20 @@ class StrongCSV
     attr_reader errors: Hash[column, Array[::String]]
     attr_reader lineno: ::Integer
 
-    def initialize: (row: Array[::String] | CSV::Row, types: Hash[column, [declarable, (^(casted | ::Object | nil) -> untyped | nil)]], lineno: ::Integer) -> void
+    def initialize: (row: Array[::String] | CSV::Row, types: Array[TypeWrapper], lineno: ::Integer) -> void
 
     def valid?: -> bool
   end
 
+  class TypeWrapper
+    attr_accessor name: (::Symbol | ::Integer)
+    attr_accessor type: declarable
+    attr_accessor error_message: (::String | nil)
+    attr_accessor block: (^(casted | ::Object | nil) -> untyped | nil)
+
+    def cast: (::String | nil) -> [(casted | ::Object | nil), (::String | nil)]
+  end
+
   class Error < StandardError
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strong_csv
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Yutaka Kamei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-20 00:00:00.000000000 Z
+date: 2023-03-20 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.
@@ -23,6 +23,7 @@ files:
 - lib/strong_csv.rb
 - lib/strong_csv/let.rb
 - lib/strong_csv/row.rb
+- lib/strong_csv/type_wrapper.rb
 - lib/strong_csv/types/base.rb
 - lib/strong_csv/types/boolean.rb
 - lib/strong_csv/types/float.rb
@@ -58,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Type check CSV objects