honey_format 0.21.1 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd0d06f453986109809c196cef032b5f60233e165a8d5e029162b26b6cc801b2
-  data.tar.gz: 8f5a15f42e9f2587bc80b7e88d5c929d74a04ef69bd6be272513ba8fc544a22a
+  metadata.gz: bba6cf8014cc6cfa59c8519bbb2448d22800e3f5c3699629fd74132f5b615b82
+  data.tar.gz: d1e7dc2ed46e061edd4d473a267c5c1a0296fd58f080e7fecd878341364cb90f
 SHA512:
-  metadata.gz: 563e6ba6a8ede49e13d15957c12c247b6e26c981afe25b150d6ae8c6c3dab58929c100341dcc0181790a03eabffca5ddd3ac127cf97fcdb4ac76ef04b01c9839
-  data.tar.gz: 93a08cb9b2683961e80f8f2bb79f763f05fb1401e112458a6188bf86530233e93f9d397b0ee415e4ce9c8b95ff644485e50dc6b52a2c8381aa4379b0bce0e65a
+  metadata.gz: d67aad924dd6d89a56a2e36b1eb84ae2a30e68f71d717fc11c8be960fbf154b0061311105d814b8458b794c6f0a6f93d078fa91efd9c3f3845afcf87c9abfaa4
+  data.tar.gz: 2981c007e997cad9e8c58e9cdb4b22654b8f0443ef82345355919068b1bd804d278780808ba361f9077cf1e03bad649060b4474fba99de02a999bc9aea3e7efc

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # HEAD
 
+## v0.25.0
+
+* Add support for adding multiple `Rows` together, `Rows#+`
+
+## 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)

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Jacob Burenstam Linder
+Copyright (c) 2021 Jacob Burenstam Linder
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -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|
@@ -315,6 +323,13 @@ user.public_send(:"first^name") # => "Jacob"
 user['first^name'] # => "Jacob"
 ```
 
+Emoji characters
+```ruby
+csv_string = "😎⛷\nEmoji characters"
+csv = HoneyFormat::CSV.new(csv_string)
+csv.rows.first.😎⛷ # => Emoji characters
+```
+
 __Errors__
 
 > When you need to be extra safe.
@@ -376,6 +391,74 @@ 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
+```
+
+## Configuration
+
+Configuration is optional
+```ruby
+HoneyFormat.configure do |config|
+  config.header_converter = proc { |column| column.downcase }
+  config.delimiter = ";"
+  config.row_delimiter = "|"
+  config.quote_character = "'"
+  config.skip_lines = %r{\A#} # Match all lines that start with "#"
+end
+```
+
+Default configuration values
+```ruby
+HoneyFormat.configure do |config|
+  config.header_converter = HoneyFormat::Registry.new(Converters::DEFAULT)[:header_column]
+  config.delimiter = ","
+  config.row_delimiter = :auto
+  config.quote_character = "\""
+  config.skip_lines = nil
+end
+```
+
 ## CLI
 
 > Perfect when you want to get something simple done quickly.

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

@@ -20,6 +20,7 @@ module HoneyFormat
       symbol!: StrictConvertSymbol,
       downcase!: StrictConvertDowncase,
       upcase!: StrictConvertUpcase,
+      strip!: StrictConvertStrip,
       boolean!: StrictConvertBoolean,
       # safe variants
       decimal: ConvertDecimal,
@@ -31,6 +32,7 @@ module HoneyFormat
       symbol: ConvertSymbol,
       downcase: ConvertDowncase,
       upcase: ConvertUpcase,
+      strip: ConvertStrip,
       boolean: ConvertBoolean,
       md5: ConvertMD5,
       hex: ConvertHex,

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

@@ -12,12 +12,24 @@ module HoneyFormat
     # @param [Array] rows the array of rows.
     # @param [Array<Symbol>] columns the array of column symbols.
     # @param type_map [Hash] map of column_name => type conversion to perform.
+    # @param pre_built_rows [boolean] whether the rows come pre-built
     # @raise [RowError] super class of errors raised when there is a row error.
     # @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)
-      @rows = prepare_rows(builder, rows)
+    def initialize(rows, columns, builder: nil, type_map: {}, pre_built_rows: false)
+      @columns = columns
+      if pre_built_rows
+        @rows = rows
+      else
+        builder = RowBuilder.new(@columns, builder: builder, type_map: type_map)
+        @rows = prepare_rows(builder, rows)
+      end
+    end
+
+    # Row columns
+    # @return [Array<Symbol>] of column identifiers.
+    def columns
+      @columns
     end
 
     # Returns true if rows contains no elements.
@@ -26,6 +38,18 @@ module HoneyFormat
       @rows.empty?
     end
 
+    # Returns the rows added together.
+    # @return [Rows] the two sets of Rows added together.
+    # @param [Rows] the other Rows object.
+    def +(other)
+      if columns != columns.union(other.columns)
+        raise ArgumentError, "can't added two sets of rows with different columns"
+      end
+
+      rows = @rows + other.rows_data
+      self.class.new(rows, columns, pre_built_rows: true)
+    end
+
     # @yield [row] The given block will be passed for every row.
     # @yieldparam [Row] a row in the CSV file.
     # @return [Enumerator]
@@ -42,6 +66,7 @@ module HoneyFormat
 
     # Return element at given position.
     # @return [Row] of rows.
+    # @param [Integer] the index to return.
     def [](index)
       @rows[index]
     end
@@ -77,6 +102,12 @@ module HoneyFormat
       csv_rows.join
     end
 
+    protected
+
+    def rows_data
+      @rows
+    end
+
     private
 
     def prepare_rows(builder, rows)

data/lib/honey_format/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honey_format
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.25.0
 platform: ruby
 authors:
 - Jacob Burenstam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2021-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -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.