strong_csv 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8078bf75d84307eb32f647a418d2cd2214d6891a78a25a73f7589b82fec0716c
-  data.tar.gz: 318af2a0c3a42ac7141819b06e729a5e98967c5106988bc4349b308f9c9d87f8
+  metadata.gz: b3e78f36b30b9033ba93a1295d6086f94c1da0aab0da2f9d06050c8d64f85a3c
+  data.tar.gz: c841993791e0cb0918852368c88b5cc19bb0ab021e9234f9f56150eb6d837f77
 SHA512:
-  metadata.gz: 63aa30f83182e0cab08f816124945d9da91149faaa82017ba0a80ca8b39ef57fed5eab521db1efd8404045aadba189550bd779f195434cef2294975dc30216f3
-  data.tar.gz: e4e74ea2446efcf32f6e67fe8be5df207ae8dbd66b392df4c2fb8895cd71aebf70894d062e64eee2814295aa00f29876afcb95b4c3a88ffffd7be0c8e9a9ba21
+  metadata.gz: c1ede33a7d67bb74f2d2f56704109d7ed5ba00d31b632a4c0c73a11ff95f5198cb9a63f7fa51dbc583b98adbde12e4cdebb86dcaa5d14775fde6ce3a3ee8aeca
+  data.tar.gz: 1cd0e73ee52d825dbc61acbdb45749b8c9fc66086006cbf81b5e2229e7e5736141c852ebb9e7a3ebbed91b22cfcf1857aef629874511cee5d02a36e544b61b46

data/README.md

@@ -2,8 +2,6 @@
 
 <a href="https://rubygems.org/gems/strong_csv"><img alt="strong_csv" src="https://img.shields.io/gem/v/strong_csv"></a>
 
-NOTE: This repository is still under development 🚧🚜🚧
-
 Type checker for a CSV file inspired by [strong_json](https://github.com/soutaro/strong_json).
 
 ## Motivation
@@ -81,8 +79,6 @@ strong_csv = StrongCSV.new do
   # Regular expressions
   let :url, %r{\Ahttps://}
 
-  # TODO: The followings are not implemented so far.
-
   # Custom validation
   #
   # This example sees the database to fetch exactly stored `User` IDs,
@@ -105,12 +101,30 @@ strong_csv.parse(data, field_size_limit: 2048) do |row|
     row[:active] # => true
     # do something with row
   else
-    row.errors # => { user_id: ["must be present", "must be an integer"] }
+    row.errors # => { user_id: ["`nil` can't be casted to Integer"] }
     # do something with row.errors
   end
 end
 ```
 
+You can also define types without CSV headers by specifying column numbers.
+Note the numbers must start from `0` (zero-based index).
+
+```ruby
+StrongCSV.new do
+  let 0, integer
+  let 1, string
+  let 2, 1..10
+end
+```
+
+This declaration expects a CSV has the contents like this:
+
+```csv
+123,abc,3
+830,mno,10
+```
+
 ## Available types
 
 <table>
@@ -171,7 +185,7 @@ end
 ### `integer` and `integer?`
 
 The value must be casted to Integer. `integer?` allows the value to be `nil`, so you can declare optional integer type
-for columns.
+for columns. It also lets you allow values that satisfy the specified limitation through `:constraint`.
 
 _Example_
 
@@ -179,25 +193,30 @@ _Example_
 strong_csv = StrongCSV.new do
   let :stock, integer
   let :state, integer?
+  let :user_id, integer(constraint: ->(v) { user_ids.include?(v)})
+  pick :user_id, as: :user_ids do |values|
+    User.where(id: values).ids
+  end
 end
 
 result = strong_csv.parse(<<~CSV)
-  stock,state
-  12,0
-  20,
-  non-integer,1
+  stock,state,user_id
+  12,0,1
+  20,,2
+  non-integer,1,4
 CSV
 
 result.map(&:valid?) # => [true, true, false]
-result[0].slice(:stock, :state) # => {:stock=>12, :state=>0}
-result[1].slice(:stock, :state) # => {:stock=>20, :state=>nil}
-result[2].slice(:stock, :state) # => {:stock=>"non-integer", :state=>1} ("non-integer" cannot be casted to Integer)
+result[0].slice(:stock, :state, :user_id) # => {:stock=>12, :state=>0, :user_id=>1}
+result[1].slice(:stock, :state, :user_id) # => {:stock=>20, :state=>nil, :user_id=>2}
+result[2].slice(:stock, :state, :user_id) # => {:stock=>"non-integer", :state=>1, :user_id=>"4"}
+result[2].errors.slice(:stock, :user_id) # => {:stock=>["`\"non-integer\"` can't be casted to Integer"], :user_id=>["`\"4\"` does not satisfy the specified constraint"]}
 ```
 
 ### `float` and `float?`
 
 The value must be casted to Float. `float?` allows the value to be `nil`, so you can declare optional float type for
-columns.
+columns. It also lets you allow values that satisfy the specified limitation through `:constraint`.
 
 _Example_
 
@@ -396,8 +415,10 @@ ja:
       cant_be_casted: "`%{value}`はBooleanに変換できません"
     float:
       cant_be_casted: "`%{value}`はFloatに変換できません"
+      constraint_error: "`%{value}`は指定された成約を満たしていません",
     integer:
       cant_be_casted: "`%{value}`はIntegerに変換できません"
+      constraint_error: "`%{value}`は指定された成約を満たしていません",
     literal:
       integer:
         unexpected: "`%{expected}`ではなく`%{value}`が入力されています"

data/lib/strong_csv/i18n.rb

@@ -8,9 +8,11 @@ I18n.backend.store_translations(
       },
       float: {
         cant_be_casted: "`%{value}` can't be casted to Float",
+        constraint_error: "`%{value}` does not satisfy the specified constraint",
       },
       integer: {
         cant_be_casted: "`%{value}` can't be casted to Integer",
+        constraint_error: "`%{value}` does not satisfy the specified constraint",
       },
       literal: {
         integer: {

data/lib/strong_csv/let.rb

@@ -9,9 +9,14 @@ class StrongCSV
     # @return [Boolean]
     attr_reader :headers
 
+    # @return [Hash]
+    attr_reader :pickers
+
     def initialize
       @types = {}
       @headers = false
+      @pickers = {}
+      @picked = {}
     end
 
     # @param name [String, Symbol, Integer]
@@ -30,12 +35,35 @@ class StrongCSV
       validate_columns
     end
 
-    def integer
-      Types::Integer.new
+    # #pick is intended for defining a singleton method with `:as`.
+    # This might be useful for the case where you want to receive IDs that are stored in a database,
+    # and you want to make sure the IDs actually exist.
+    #
+    # @example
+    #  pick :user_id, as: :user_ids do |user_ids|
+    #    User.where(id: user_ids).ids
+    #  end
+    #
+    # @param column [Symbol, Integer]
+    # @param as [Symbol]
+    # @yieldparam values [Array<String>] The values for the column. NOTE: This is an array of String, not casted values.
+    def pick(column, as:, &block)
+      define_singleton_method(as) do
+        @picked[as]
+      end
+      @pickers[as] = lambda do |csv|
+        @picked[as] = block.call(csv.map { |row| row[column] })
+      end
+    end
+
+    # @param options [Hash] See `Types::Integer#initialize` for more details.
+    def integer(**options)
+      Types::Integer.new(**options)
     end
 
-    def integer?
-      optional(integer)
+    # @param options [Hash] See `Types::Integer#initialize` for more details.
+    def integer?(**options)
+      optional(integer(**options))
     end
 
     def boolean
@@ -46,12 +74,14 @@ class StrongCSV
       optional(boolean)
     end
 
-    def float
-      Types::Float.new
+    # @param options [Hash] See `Types::Float#initialize` for more details.
+    def float(**options)
+      Types::Float.new(**options)
     end
 
-    def float?
-      optional(float)
+    # @param options [Hash] See `Types::Float#initialize` for more details.
+    def float?(**options)
+      optional(float(**options))
     end
 
     # @param options [Hash] See `Types::String#initialize` for more details.

data/lib/strong_csv/types/float.rb

@@ -4,11 +4,25 @@ class StrongCSV
   module Types
     # Float type
     class Float < Base
+      DEFAULT_CONSTRAINT = ->(_) { true }
+      private_constant :DEFAULT_CONSTRAINT
+
+      # @param constraint [Proc]
+      def initialize(constraint: DEFAULT_CONSTRAINT)
+        super()
+        @constraint = constraint
+      end
+
       # @todo Use :exception for Float after we drop the support of Ruby 2.5
       # @param value [Object] Value to be casted to Float
       # @return [ValueResult]
       def cast(value)
-        ValueResult.new(value: Float(value), original_value: value)
+        float = Float(value)
+        if @constraint.call(float)
+          ValueResult.new(value: float, original_value: value)
+        else
+          ValueResult.new(original_value: value, error_messages: [I18n.t("strong_csv.float.constraint_error", value: value.inspect, default: :"_strong_csv.float.constraint_error")])
+        end
       rescue ArgumentError, TypeError
         ValueResult.new(original_value: value, error_messages: [I18n.t("strong_csv.float.cant_be_casted", value: value.inspect, default: :"_strong_csv.float.cant_be_casted")])
       end

data/lib/strong_csv/types/integer.rb

@@ -4,11 +4,25 @@ class StrongCSV
   module Types
     # Integer type
     class Integer < Base
+      DEFAULT_CONSTRAINT = ->(_) { true }
+      private_constant :DEFAULT_CONSTRAINT
+
+      # @param constraint [Proc]
+      def initialize(constraint: DEFAULT_CONSTRAINT)
+        super()
+        @constraint = constraint
+      end
+
       # @todo Use :exception for Integer after we drop the support of Ruby 2.5
       # @param value [Object] Value to be casted to Integer
       # @return [ValueResult]
       def cast(value)
-        ValueResult.new(value: Integer(value), original_value: value)
+        int = Integer(value)
+        if @constraint.call(int)
+          ValueResult.new(value: int, original_value: value)
+        else
+          ValueResult.new(original_value: value, error_messages: [I18n.t("strong_csv.integer.constraint_error", value: value.inspect, default: :"_strong_csv.integer.constraint_error")])
+        end
       rescue ArgumentError, TypeError
         ValueResult.new(original_value: value, error_messages: [I18n.t("strong_csv.integer.cant_be_casted", value: value.inspect, default: :"_strong_csv.integer.cant_be_casted")])
       end

data/lib/strong_csv/version.rb

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

data/lib/strong_csv.rb

@@ -37,6 +37,12 @@ class StrongCSV
     options.delete(:nil_value)
     options = options.merge(headers: @let.headers, header_converters: :symbol)
     csv = CSV.new(csv, **options)
+
+    @let.pickers.each_value do |picker|
+      picker.call(csv)
+      csv.rewind
+    end
+
     if block_given?
       csv.each do |row|
         yield Row.new(row: row, types: @let.types, lineno: csv.lineno)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strong_csv
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Yutaka Kamei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-10 00:00:00.000000000 Z
+date: 2022-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n