honey_format 0.19.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf04ea671d5bdbe82a40c6c755e0f975a4326e3f803cc380cbfb513bcb7587d1
-  data.tar.gz: 14893ca65e6ecb420fac9e4a4783d2ab2267d2b63b492a70c297ca51e66bf711
+  metadata.gz: 54b1c442221f4921f054ba328b55f066166d27b27bd56aa8499bf195bac65847
+  data.tar.gz: 58977315c3fb95a54a0cbc7ab930a8ade04016865c589f4e6374ce113a080c1c
 SHA512:
-  metadata.gz: c9a89819d1d40b99af14bbc1c0b5df765d5c91ab7c1146f39f8b6dd04796d718251280b6b31b3dc61e14ba413f46d9edb9e7e8a1aa1c308531d20cfdb0c5bb9b
-  data.tar.gz: b23f67d3df21ca3a01d03c7054502aa0a60d2819717f770db3a30edccdf597b9a9943b7107515e1e454156625c5d1aa3efcd918772b0dcbc5b9b85298ed71fe8
+  metadata.gz: 1cbbc61c953422dea9de989ebe429b05325140868c54b2861dbaafac222425706d8af481d86c0a0f3a75bbc19bcabfb5d580d0261c0a3ba928c3a2d45390abf7
+  data.tar.gz: d07789988d8ad6f335fa517bc07954f0f9800c3dce3ab10a9295c6edae81994fd78ca9ed2e44c6ac6b8759593e0807edeb78457bbb54ce4e348db116f953374a

data/.travis.yml

@@ -9,11 +9,11 @@ matrix:
   include:
   - rvm: 2.3.0
     install:
-      - gem install bundler --no-ri --no-rdoc
+      - gem install bundler --no-document
       - bundle install
   - rvm: 2.5.1
     install:
-      - gem install bundler --no-ri --no-rdoc
+      - gem install bundler --no-document
       - bundle install
   - rvm: 2.6.0-preview3
     install:
@@ -21,7 +21,7 @@ matrix:
   - name: TruffleRuby
     rvm: system
     install:
-      - export TRUFFLERUBY_VERSION=1.0.0-rc3
+      - export TRUFFLERUBY_VERSION=1.0.0-rc10
       - curl -L https://github.com/oracle/truffleruby/releases/download/vm-$TRUFFLERUBY_VERSION/truffleruby-$TRUFFLERUBY_VERSION-linux-amd64.tar.gz | tar xz
       - export PATH="$PWD/truffleruby-$TRUFFLERUBY_VERSION-linux-amd64/bin:$PATH"
       - gem install bundler -v 1.16.6 --no-ri --no-rdoc

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # HEAD
 
+## v0.23.0
+
+* Add `Rows#columnns` 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.
+    ```ruby
+    converter = {
+      'First name' => :first_name,
+      'Last name' => -> { :surname }
+    }
+    csv = HoneyFormat::CSV.new(csv_string, header_converter: converter)
+    ```
+* Add `encoding` option to `CSV`
+
 ## v0.19.0
 
 * Add `method_name` as alias for `header_column` converter

data/README.md

@@ -27,8 +27,8 @@ Id,Username,Email
 2,jacob,jacob@example.com
 CSV
 csv = HoneyFormat::CSV.new(csv_string, type_map: { id: :integer })
-csv.columns     # => [:id, :username]
-csv.rows        # => [#<Row id=1, username="buren">]
+csv.columns     # => [:id, :username, :email]
+csv.rows        # => [#<Row id=1, username="buren", email="buren@example.com">, #<Row id=2, username="jacob", email="jacob@example.com">]
 user = csv.rows.first
 user.id         # => 1
 user.username   # => "buren"
@@ -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 }
@@ -139,7 +139,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__
 
@@ -248,21 +248,36 @@ csv.columns # => [:ID, :USERNAME]
 
 Pass your own header converter
 ```ruby
-map = { 'First^Name' => :first_name }
-converter = ->(column) { map.fetch(column, column.downcase) }
+# unmapped keys use the default header converter,
+# mix simple key => value mapping with key => proc
+converter = {
+  'First^Name' => :first_name,
+  'Username' => -> { :handle }
+}
 
-csv_string = "ID,First^Name\n1,Jacob"
+csv_string = "ID,Username,First^Name\n1,buren,Jacob"
 user = HoneyFormat::CSV.new(csv_string, header_converter: converter).rows.first
 user.first_name # => "Jacob"
+user.handle     # => "buren"
 user.id         # => "1"
+
+# you can also pass a proc or any callable object
+converter = Class.new do
+  define_singleton_method(:call) { |value, index| "#{value}#{index}" }
+end
+# or
+converter = ->(value, index) { "#{value}#{index}"  }
+user = HoneyFormat::CSV.new(csv_string, header_converter: converter)
 ```
 
-Missing header values
+Missing header values are automatically set and deduplicated
 ```ruby
-csv_string = "first,,third\nval0,val1,val2"
+csv_string = "first,,third,third\nval0,val1,val2,val3"
 csv = HoneyFormat::CSV.new(csv_string)
 user = csv.rows.first
 user.column1 # => "val1"
+user.third   # => "val2"
+user.third1  # => "val3"
 ```
 
 Duplicated header values
@@ -302,7 +317,7 @@ user['first^name'] # => "Jacob"
 
 __Errors__
 
-> When you need that some extra safety.
+> When you need to be extra safe.
 
 If you want to there are some errors you can rescue
 ```ruby

data/honey_format.gemspec

@@ -23,9 +23,9 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.3.0'
 
   spec.add_development_dependency 'benchmark-ips'
-  spec.add_development_dependency 'bundler', '~> 1.10'
+  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/converters.rb

@@ -9,4 +9,35 @@ 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,
+      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
+  end
 end

data/lib/honey_format/csv.rb

@@ -19,6 +19,7 @@ module HoneyFormat
     # @param header_deduplicator [#call] deduplicates header columns.
     # @param row_builder [#call] will be called for each parsed row.
     # @param type_map [Hash] map of column_name => type conversion to perform.
+    # @param encoding [String] CSV encoding (for example "BOM|UTF-16LE:UTF-8").
     # @param skip_lines [Regexp, String]
     #   Regexp for determining wheter a line is a comment. See CSV skip_lines option.
     # @raise [HeaderError] super class of errors raised when there is a CSV header error.
@@ -46,6 +47,8 @@ module HoneyFormat
     # @example Skip lines all lines starting with '#'
     #   csv = HoneyFormat::CSV.new("name,id\n# some comment\njacob,1", skip_lines: '#')
     #   csv.rows.length # => 1
+    # @example CSV encoding
+    #   csv = HoneyFormat::CSV.new(csv_string, encoding: "BOM|UTF-16LE:UTF-8")
     # @see Matrix#new
     def initialize(
       csv,
@@ -56,6 +59,7 @@ module HoneyFormat
       header_converter: HoneyFormat.header_converter,
       header_deduplicator: HoneyFormat.config.header_deduplicator,
       row_builder: nil,
+      encoding: nil,
       type_map: {},
       skip_lines: HoneyFormat.config.skip_lines
     )
@@ -65,7 +69,8 @@ module HoneyFormat
         row_sep: row_delimiter,
         quote_char: quote_character,
         skip_blanks: true,
-        skip_lines: skip_lines
+        skip_lines: skip_lines,
+        encoding: encoding
       )
       super(
         csv,

data/lib/honey_format/matrix/header.rb

@@ -10,10 +10,11 @@ module HoneyFormat
     # Instantiate a Header
     # @return [Header] a new instance of Header.
     # @param [Array<String>] header array of strings.
-    # @param converter [#call, Symbol]
+    # @param converter [#call, Symbol, Hash]
     #   header converter that implements a #call method
     #   that takes one column (string) argument OR symbol for a registered
-    #   converter registry.
+    #   converter registry OR a hash mapped to a symbol or something that responds
+    #   to #call.
     # @param deduplicator [#call, Symbol]
     #   header deduplicator that implements a #call method
     #   that takes columns Array<String> argument OR symbol for a registered
@@ -93,7 +94,7 @@ module HoneyFormat
     private
 
     # Set the header converter
-    # @param [Symbol, #call] symbol to known converter or object that responds to #call
+    # @param [Hash, Symbol, #call] symbol to known converter, object that responds to #call or Hash
     # @return [nil]
     def converter=(object)
       if object.is_a?(Symbol)
@@ -101,6 +102,11 @@ module HoneyFormat
         return
       end
 
+      if object.is_a?(Hash)
+        @converter = hash_converter(object)
+        return
+      end
+
       @converter = object
     end
 
@@ -134,21 +140,17 @@ module HoneyFormat
     # @param [Integer] index the CSV header column index
     # @return [Symbol] the converted column
     def convert_column(column, index)
-      value = if converter_arity == 1
-                @converter.call(column)
-              else
-                @converter.call(column, index)
-              end
-      value.to_sym
+      call_column_builder(@converter, column, index)&.to_sym
     end
 
-    # Returns the converter#call method arity
-    # @return [Integer] the converter#call method arity
-    def converter_arity
+    # Returns the callable object method arity
+    # @param [#arity, #call] callable thing that responds to #call and maybe #arity
+    # @return [Integer] the method arity
+    def callable_arity(callable)
       # procs and lambdas respond to #arity
-      return @converter.arity if @converter.respond_to?(:arity)
+      return callable.arity if callable.respond_to?(:arity)
 
-      @converter.method(:call).arity
+      callable.method(:call).arity
     end
 
     # Raises an error if header column is missing/empty
@@ -164,5 +166,29 @@ module HoneyFormat
       ]
       raise(Errors::MissingHeaderColumnError, parts.join(' '))
     end
+
+    def hash_converter(hash)
+      lambda { |value, index|
+        # support strings and symbol keys interchangeably
+        column = hash.fetch(value) do
+          key = value.respond_to?(:to_sym) ? value.to_sym : value
+          # if column is unmapped use the default header converter
+          hash.fetch(key) { HoneyFormat.header_converter.call(value, index) }
+        end
+
+        # The hash can contain mixed values, Symbol and procs
+        if column.respond_to?(:call)
+          column = call_column_builder(column, value, index)
+        end
+
+        column&.to_sym
+      }
+    end
+
+    def call_column_builder(callable, value, index)
+      return callable.call if callable_arity(callable).zero?
+      return callable.call(value) if callable_arity(callable) == 1
+      callable.call(value, index)
+    end
   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.rb

@@ -4,7 +4,7 @@ module HoneyFormat
   # Default row builder
   class Row < Struct
     # Create a row
-    # @return [Struct] returns an instantiated Struct representing a row
+    # @return [Row] returns an instantiated Row
     # @example
     #   row_klass = Row.new(:id, :username)
     #   row = row_klass.call('1', 'buren')

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 = 19,
+    MINOR_VERSION = 23,
     PATCH_VERSION = 0,
   ].join('.')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honey_format
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Jacob Burenstam
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-12-08 00:00:00.000000000 Z
+date: 2020-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -28,16 +28,22 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -58,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
@@ -147,7 +153,7 @@ homepage: https://github.com/buren/honey_format
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,9 +168,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Makes working with CSVs as smooth as honey.
 test_files: []