honey_format 0.20.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c0136727f1cf1e473ac8a517105158a9c927c5988f525b1640ffced32c5a2fd
-  data.tar.gz: d26d86cd08edbc33f2f9b8399ef2f7c5aade4b35ca4ea7617dc6a21415b72c9a
+  metadata.gz: 4e7b05a5cbde9ef4df67f043ff78e75c545563faa02333c57c97f70f1adec0f9
+  data.tar.gz: 91275865eabfd283c22ef0507a76b0c433d64a36c2ab68d92501548b982a00c8
 SHA512:
-  metadata.gz: 6ec8850e11d3ae4039b748738641bacd19ea3ffe9f437e2d93eb407e9d7e7cb2dcc669116f04f2a175855fbc121bad62228dc6dbd022163d033a52e89af6e8e7
-  data.tar.gz: 9ec609fe969d26348c1be54458a79ea24a199085381e82c3bc79d58b5054bb02300759946f520c7b29eb0273e56db290375c791ee4fb2c5fecf10da65954e54b
+  metadata.gz: c5904b276f295163855c1d74f7afa27568572e50583ec54532e571f70eb59ce06648e60a0e0d29806289d7126b8d0a9351acdd746967c247db03004cec3c4356
+  data.tar.gz: e498be3c0e31e594cc42d2186404d367564111d70d2fffbe0011d0ea208e5f217ff8416061f12cbdff5137b3075e1f09d857b2dd189d785b865381d02c429d07

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # HEAD
 
+## v0.24.0
+
+* Add support for multiple/chained converters. [PR#69](https://github.com/buren/honey_format/pull/69)
+  ```ruby
+  csv_string = "Id,Username\n1,  BuRen  "
+  type_map = { username: [:strip, :downcase] }
+  csv = HoneyFormat::CSV.new(csv_string, type_map: type_map)
+  csv.rows.first.username # => "buren"
+  ```
+* Add `strip` and `strip!` converter
+
+## v0.23.0
+
+* Add `Rows#columns` method that returns header columns
+
+## v0.22.0
+
+* Add `Matrix#type_map` and ignore non-existing column in the type map. [PR#64](https://github.com/buren/honey_format/pull/64). Thank you [@prem-prakash](https://github.com/prem-prakash).
+
+## v0.21.1
+
+* Closes [issue #58](https://github.com/buren/honey_format/issues/58). [PR #62](https://github.com/buren/honey_format/pull/62)
+
+## v0.21.0
+
+* Add `Rows#[]` method
+
 ## v0.20.0
 
 * Support additional header variant, pass hash with `String => Symbol` and/or `String => #call` (callable object). Unmapped keys are converted using the default header converter.

data/README.md

@@ -91,7 +91,7 @@ __Type converters__
 
 > Type converters are great if you want to convert column values, like numbers and dates.
 
-There are a few default type converters
+There are a bunch of [default type converters](https://github.com/buren/honey_format/blob/master/lib/honey_format/converters/converters.rb)
 ```ruby
 csv_string = "Id,Username\n1,buren"
 type_map = { id: :integer }
@@ -107,6 +107,14 @@ csv = HoneyFormat::CSV.new(csv_string, type_map: type_map)
 csv.rows.first.username # => "BUREN"
 ```
 
+Combine multiple converters
+```ruby
+csv_string = "Id,Username\n1,  BuRen  "
+type_map = { username: [:strip, :downcase] }
+csv = HoneyFormat::CSV.new(csv_string, type_map: type_map)
+csv.rows.first.username # => "buren"
+```
+
 Register your own converter
 ```ruby
 HoneyFormat.configure do |config|
@@ -139,7 +147,7 @@ Default converter names
 HoneyFormat.config.default_converters.keys
 ```
 
-See [`Configuration#default_converters`](https://github.com/buren/honey_format/blob/master/lib/honey_format/configuration.rb#L99) for a complete list of the default ones.
+See [`Converters::DEFAULT`](https://github.com/buren/honey_format/blob/master/lib/honey_format/converters.rb) for a complete list of the default converter names.
 
 __Row builder__
 
@@ -376,6 +384,50 @@ matrix.to_csv    # => "name,id\nJACOB,1\n"
 
 If you want to see more usage examples check out the [`examples/`](https://github.com/buren/honey_format/tree/master/examples) and [`spec/`](https://github.com/buren/honey_format/tree/master/spec) directories and of course [on RubyDoc](https://www.rubydoc.info/gems/honey_format/).
 
+
+__SQL example__
+
+When you want the result as an object, with certain columns converted to objects.
+
+```ruby
+require 'mysql2'
+
+class DBClient
+  def initialize(host:, username:, password:, port: 3306)
+    @client = Mysql2::Client.new(
+      host: host,
+      username: username,
+      password: password,
+      port: port
+    )
+  end
+
+  def query(sql, type_map: {})
+    result = @client.query(sql)
+    return if result.first.nil?
+
+    matrix = HoneyFormat::Matrix.new(
+      result.map(&:values),
+      header: result.first.keys,
+      type_map: type_map
+    )
+    matrix.rows
+  end
+end
+```
+
+Usage example with a fictional "users" database table (schema: `name`, `created_at`)
+```ruby
+client = DbClient.new(host: '127.0.0.1', username: 'root', password: nil)
+users = client.query(
+  'SELECT * FROM users',
+  type_map: { created_at: :datetime! }
+)
+user = users.first
+user.name # => buren
+user.created_at.class # => Time
+```
+
 ## CLI
 
 > Perfect when you want to get something simple done quickly.

data/honey_format.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'benchmark-ips'
   spec.add_development_dependency 'bundler', '> 1.10', '< 3'
   spec.add_development_dependency 'byebug'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'simplecov'
 end

data/lib/honey_format/configuration.rb

@@ -97,34 +97,7 @@ module HoneyFormat
     # Default converter registry
     # @return [Hash] hash with default converters
     def default_converters
-      @default_converters ||= {
-        # strict variants
-        decimal!: StrictConvertDecimal,
-        integer!: StrictConvertInteger,
-        date!: StrictConvertDate,
-        datetime!: StrictConvertDatetime,
-        symbol!: StrictConvertSymbol,
-        downcase!: StrictConvertDowncase,
-        upcase!: StrictConvertUpcase,
-        boolean!: StrictConvertBoolean,
-        # safe variants
-        decimal: ConvertDecimal,
-        decimal_or_zero: ConvertDecimalOrZero,
-        integer: ConvertInteger,
-        integer_or_zero: ConvertIntegerOrZero,
-        date: ConvertDate,
-        datetime: ConvertDatetime,
-        symbol: ConvertSymbol,
-        downcase: ConvertDowncase,
-        upcase: ConvertUpcase,
-        boolean: ConvertBoolean,
-        md5: ConvertMD5,
-        hex: ConvertHex,
-        nil: ConvertNil,
-        blank: ConvertBlank,
-        header_column: ConvertHeaderColumn,
-        method_name: ConvertHeaderColumn,
-      }.freeze
+      @default_converters ||= Converters::DEFAULT
     end
   end
 end

data/lib/honey_format/converters/convert_boolean.rb

@@ -4,9 +4,9 @@ require 'set'
 
 module HoneyFormat
   # String values considered truthy
-  TRUTHY = Set.new(%w[t T 1 y Y true TRUE]).freeze
+  TRUTHY = Set.new(%w[t T 1 y Y true TRUE] + [true]).freeze
   # String values considered falsy
-  FALSY = Set.new(%w[f F 0 n N false FALSE]).freeze
+  FALSY = Set.new(%w[f F 0 n N false FALSE] + [false]).freeze
 
   # Tries to convert value boolean to, returns nil if it can't convert
   ConvertBoolean = proc do |v|

data/lib/honey_format/converters/convert_date_and_time.rb

@@ -23,8 +23,8 @@ module HoneyFormat
   end
 
   # Convert to date or raise error
-  StrictConvertDate = proc { |v| Date.parse(v) }
+  StrictConvertDate = proc { |v| v.is_a?(Date) ? v : Date.parse(v) }
 
   # Convert to datetime or raise error
-  StrictConvertDatetime = proc { |v| Time.parse(v) }
+  StrictConvertDatetime = proc { |v| v.is_a?(Time) ? v : Time.parse(v) }
 end

data/lib/honey_format/converters/convert_string.rb

@@ -10,6 +10,9 @@ module HoneyFormat
   # Convert to upcase or nil
   ConvertUpcase = proc { |v| v&.upcase }
 
+  # Convert to stripped string
+  ConvertStrip = proc { |v| v&.strip }
+
   # Convert to symbol or nil
   ConvertSymbol = proc { |v| v&.to_sym }
 
@@ -35,8 +38,13 @@ module HoneyFormat
     ConvertDowncase.call(v) || raise(ArgumentError, "can't convert nil to downcased string")
   end
 
+  # Convert to downcase or raise error
+  StrictConvertStrip = proc do |v|
+    ConvertStrip.call(v) || raise(ArgumentError, "can't convert nil to downcased string")
+  end
+
   # Convert to symbol or raise error
   StrictConvertSymbol = proc do |v|
-    ConvertSymbol.call(v) || raise(ArgumentError, "can't convert nil to symbol")
+    ConvertSymbol.call(v) || raise(ArgumentError, "can't convert nil to stripped string")
   end
 end

data/lib/honey_format/converters/converters.rb

@@ -9,4 +9,37 @@ require 'honey_format/converters/convert_string'
 module HoneyFormat
   # Convert to nil
   ConvertNil = proc {}
+
+  module Converters
+    DEFAULT = {
+      # strict variants
+      decimal!: StrictConvertDecimal,
+      integer!: StrictConvertInteger,
+      date!: StrictConvertDate,
+      datetime!: StrictConvertDatetime,
+      symbol!: StrictConvertSymbol,
+      downcase!: StrictConvertDowncase,
+      upcase!: StrictConvertUpcase,
+      strip!: StrictConvertStrip,
+      boolean!: StrictConvertBoolean,
+      # safe variants
+      decimal: ConvertDecimal,
+      decimal_or_zero: ConvertDecimalOrZero,
+      integer: ConvertInteger,
+      integer_or_zero: ConvertIntegerOrZero,
+      date: ConvertDate,
+      datetime: ConvertDatetime,
+      symbol: ConvertSymbol,
+      downcase: ConvertDowncase,
+      upcase: ConvertUpcase,
+      strip: ConvertStrip,
+      boolean: ConvertBoolean,
+      md5: ConvertMD5,
+      hex: ConvertHex,
+      nil: ConvertNil,
+      blank: ConvertBlank,
+      header_column: ConvertHeaderColumn,
+      method_name: ConvertHeaderColumn,
+    }.freeze
+  end
 end

data/lib/honey_format/matrix/matrix.rb

@@ -51,7 +51,8 @@ module HoneyFormat
         converter: header_converter,
         deduplicator: header_deduplicator
       )
-      @rows = Rows.new(matrix, columns, builder: row_builder, type_map: type_map)
+      @type_map = type_map.select { |key, _v| @header.columns.include?(key) }.to_h
+      @rows = Rows.new(matrix, columns, builder: row_builder, type_map: @type_map)
     end
 
     # Original matrix header
@@ -66,6 +67,12 @@ module HoneyFormat
       @header.to_a
     end
 
+    # Matrix type map used
+    # @return [Hash<Symbol, Symbol>] the type map used.
+    def type_map
+      @type_map
+    end
+
     # Return rows
     # @return [Rows] rows.
     def rows

data/lib/honey_format/matrix/row_builder.rb

@@ -57,7 +57,11 @@ module HoneyFormat
 
       # Convert values
       @type_map.each do |column, type|
-        row[column] = @converter.call(row[column], type)
+        types = type.respond_to?(:each) ? type : [type]
+        value = row[column]
+        types.each { |t| value = @converter.call(value, t) }
+
+        row[column] = value
       end
 
       return row unless @builder

data/lib/honey_format/matrix/rows.rb

@@ -16,10 +16,17 @@ module HoneyFormat
     # @raise [EmptyRowColumnsError] raised when there are no columns.
     # @raise [InvalidRowLengthError] raised when row has more columns than header columns.
     def initialize(rows, columns, builder: nil, type_map: {})
-      builder = RowBuilder.new(columns, builder: builder, type_map: type_map)
+      @columns = columns
+      builder = RowBuilder.new(@columns, builder: builder, type_map: type_map)
       @rows = prepare_rows(builder, rows)
     end
 
+    # Row columns
+    # @return [Array<Symbol>] of column identifiers.
+    def columns
+      @columns
+    end
+
     # Returns true if rows contains no elements.
     # @return [true, false] true if rows contains no elements.
     def empty?
@@ -40,6 +47,12 @@ module HoneyFormat
       @rows
     end
 
+    # Return element at given position.
+    # @return [Row] of rows.
+    def [](index)
+      @rows[index]
+    end
+
     # Return the number of rows
     # @return [Integer] the number of rows
     def length

data/lib/honey_format/version.rb

@@ -4,7 +4,7 @@ module HoneyFormat
   # Gem version
   VERSION = [
     MAJOR_VERSION = 0,
-    MINOR_VERSION = 20,
+    MINOR_VERSION = 24,
     PATCH_VERSION = 0,
   ].join('.')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honey_format
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Jacob Burenstam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2021-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -168,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Makes working with CSVs as smooth as honey.