strong_csv 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3e78f36b30b9033ba93a1295d6086f94c1da0aab0da2f9d06050c8d64f85a3c
-  data.tar.gz: c841993791e0cb0918852368c88b5cc19bb0ab021e9234f9f56150eb6d837f77
+  metadata.gz: 109d3d3c31812aedff005dc2003a8066d20a551513f0d287c0ba761a9469ac04
+  data.tar.gz: 11a3cd4890a60b27231276d09bcdc05fb29487c100fdbc6afff8cc7febf58694
 SHA512:
-  metadata.gz: c1ede33a7d67bb74f2d2f56704109d7ed5ba00d31b632a4c0c73a11ff95f5198cb9a63f7fa51dbc583b98adbde12e4cdebb86dcaa5d14775fde6ce3a3ee8aeca
-  data.tar.gz: 1cd0e73ee52d825dbc61acbdb45749b8c9fc66086006cbf81b5e2229e7e5736141c852ebb9e7a3ebbed91b22cfcf1857aef629874511cee5d02a36e544b61b46
+  metadata.gz: 6dd9abc5eb9a9b30f655ed13eae0e699c0471b09196ba5bc8ef265e06056ecf9bce526308f6a1edb28ff7d57ae9e5023e52b9e6bc827021cf186a8a62108026a
+  data.tar.gz: 3e9d411ab432f498639c8532b46be1d52e734188c48089b565a32398b690e8ceed1255b40adcc80ebc3d21256782f186576d7dd5cf8346f88b43fa6c2489ebfd

data/lib/strong_csv/let.rb

@@ -89,6 +89,7 @@ class StrongCSV
       Types::String.new(**options)
     end
 
+    # @param options [Hash] See `Types::String#initialize` for more details.
     def string?(**options)
       optional(string(**options))
     end
@@ -98,6 +99,7 @@ class StrongCSV
       Types::Time.new(**options)
     end
 
+    # @param options [Hash] See `Types::Time#initialize` for more details.
     def time?(**options)
       optional(time(**options))
     end

data/lib/strong_csv/row.rb

@@ -28,6 +28,9 @@ class StrongCSV
       end
     end
 
+    # It returns true if the row has no errors.
+    #
+    # @return [Boolean]
     def valid?
       @errors.empty?
     end

data/lib/strong_csv/value_result.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class StrongCSV
-  # ValueResult represents a CSV field is valid or not and contains its casted value if it's valid.
+  # ValueResult represents whether 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
@@ -15,11 +15,13 @@ class StrongCSV
       @error_messages = error_messages
     end
 
-    # @return [Object] The casted value if it's valid. Otherwise, returns the original value.
+    # @return [::Float, ::Integer, ::Object, ::String, ::Range, Boolean, ::Time, nil] The casted value if it's valid. Otherwise, returns the original value.
     def value
       success? ? @value : @original_value
     end
 
+    # It returns true if the value is successfully casted.
+    #
     # @return [Boolean]
     def success?
       @error_messages.nil?

data/lib/strong_csv/version.rb

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

data/lib/strong_csv.rb

@@ -21,7 +21,7 @@ require_relative "strong_csv/types/union"
 require_relative "strong_csv/let"
 require_relative "strong_csv/row"
 
-# The top-level namespace for the strong_csv gem.
+# StrongCSV is a library for parsing CSV contents with type checking.
 class StrongCSV
   class Error < StandardError; end
 

data/sig/strong_csv.rbs

@@ -0,0 +1,163 @@
+# TypeProf 0.21.2
+
+type literals = ::Integer | ::Float | ::Range[untyped] | ::String | ::Regexp
+type declarable = StrongCSV::Types::Base | literals
+type casted = bool | ::Float | ::Integer | ::Range[untyped] | ::String | ::Regexp | ::Time
+type column = ::Integer | ::Symbol
+
+# Classes
+class StrongCSV
+  VERSION: String
+
+  @let: Let
+
+  def initialize: -> void
+
+  def parse: (String | IO, **untyped) -> Array[Row]
+    | (String | IO, **untyped) { (Row) -> void } -> untyped
+
+  class ValueResult
+    DEFAULT_VALUE: Object
+
+    @value: (casted)?
+    @original_value: untyped
+
+    attr_reader error_messages: [::String]?
+
+    def initialize: (original_value: ::String | nil, ?value: (casted | ::Object)?, ?error_messages: [::String]?) -> void
+
+    def value: -> ((casted | ::Object | nil)?)
+
+    def success?: -> bool
+  end
+
+  module Types
+    class Base
+      def cast: (untyped _value) -> bot
+    end
+
+    class Boolean < Base
+      TRUE_VALUES: Set[::String]
+      FALSE_VALUES: Set[::String]
+
+      def cast: (::String | nil) -> ValueResult
+    end
+
+    class Float < Base
+      DEFAULT_CONSTRAINT: ^(::Float) -> true
+
+      @constraint: ^(::Float) -> boolish
+
+      def initialize: (?constraint: ^(::Float) -> boolish) -> void
+
+      def cast: (::String | nil) -> ValueResult
+    end
+
+    class Integer < Base
+      DEFAULT_CONSTRAINT: ^(::Integer) -> true
+
+      @constraint: ^(::Integer) -> boolish
+
+      def initialize: (?constraint: ^(::Integer) -> boolish) -> void
+
+      def cast: (::String | nil) -> ValueResult
+    end
+
+    module Literal
+      def cast: (untyped value) -> ValueResult
+        | (untyped value) -> ValueResult
+        | (untyped value) -> ValueResult
+        | (untyped value) -> ValueResult
+        | (untyped value) -> ValueResult
+    end
+
+    class Optional < Base
+      @type: Boolean | Float | Integer | String | Time | Literal
+
+      def initialize: (declarable) -> void
+
+      def cast: (::String | nil) -> ValueResult
+    end
+
+    class String < Base
+      @within: Range[untyped] | nil
+
+      def initialize: (?within: Range[untyped] | nil) -> void
+
+      def cast: (::String | nil) -> ValueResult
+    end
+
+    class Time < Base
+      @format: ::String
+
+      def initialize: (?format: ::String) -> void
+
+      def cast: (::String | nil) -> ValueResult
+    end
+
+    class Union < Base
+      @types: Array[untyped]
+
+      def initialize: (untyped `type`, *untyped types) -> void
+
+      def cast: (::String | nil) -> untyped
+    end
+  end
+
+  class Let
+    @picked: Hash[untyped, untyped]
+
+    attr_reader types: Hash[column, [declarable, ^(casted) -> untyped | nil]]
+    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 pick: (column, as: ::Symbol) { (Array[::String]) -> untyped } -> void
+
+    def integer: (**untyped) -> Types::Integer
+
+    def integer?: (**untyped) -> Types::Optional
+
+    def boolean: -> Types::Boolean
+
+    def boolean?: -> Types::Optional
+
+    def float: (**untyped) -> Types::Float
+
+    def float?: (**untyped) -> Types::Optional
+
+    def string: (**untyped) -> Types::String
+
+    def string?: (**untyped) -> Types::Optional
+
+    def time: (**untyped) -> Types::Time
+
+    def time?: (**untyped) -> Types::Optional
+
+    def optional: (*declarable) -> Types::Optional
+
+    private
+
+    def validate_columns: -> bool
+  end
+
+  class Row
+    extend Forwardable
+
+    @values: Hash[column, casted | ::Object | nil]
+
+    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 valid?: -> bool
+  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.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Yutaka Kamei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2022-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -55,6 +55,7 @@ files:
 - lib/strong_csv/types/union.rb
 - lib/strong_csv/value_result.rb
 - lib/strong_csv/version.rb
+- sig/strong_csv.rbs
 homepage: https://github.com/yykamei/strong_csv
 licenses:
 - MIT