honey_format 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab1d4f7975362d7a1e5a63dc5d2709a8859fa8bc2563a616c42dbe181285de28
-  data.tar.gz: e582e7495778b83d6f1776bbc3048103b3df55ba79d6e6c0383a591e85d768c1
+  metadata.gz: cf04ea671d5bdbe82a40c6c755e0f975a4326e3f803cc380cbfb513bcb7587d1
+  data.tar.gz: 14893ca65e6ecb420fac9e4a4783d2ab2267d2b63b492a70c297ca51e66bf711
 SHA512:
-  metadata.gz: 97a9841215e292ce71e2288ee2d54b01a9befd9ad81fda41e8a0bcc3a34e0b2a045fd4a5b782ea97f6d77820a207e8f3a962a5d8f7c5282db0bff7e37a98c615
-  data.tar.gz: 00f215cfbee51d5b9f075b32a5e321754753c0f7292f985fccab51983bee6f084eef6409b2d753af37a2a18fcdc9ef71c348063fb0756b36de0122621934addd
+  metadata.gz: c9a89819d1d40b99af14bbc1c0b5df765d5c91ab7c1146f39f8b6dd04796d718251280b6b31b3dc61e14ba413f46d9edb9e7e8a1aa1c308531d20cfdb0c5bb9b
+  data.tar.gz: b23f67d3df21ca3a01d03c7054502aa0a60d2819717f770db3a30edccdf597b9a9943b7107515e1e454156625c5d1aa3efcd918772b0dcbc5b9b85298ed71fe8

data/.travis.yml

@@ -1,7 +1,28 @@
 language: ruby
-rvm:
-  - 2.3.0
-  - 2.4.0
-  - 2.5.0
-  - 2.6.0-preview1
-before_install: gem install bundler -v 1.16.1
+script:
+  - bundle exec rspec
+matrix:
+  fast_finish: true
+  allow_failures:
+  - name: TruffleRuby
+    rvm: system
+  include:
+  - rvm: 2.3.0
+    install:
+      - gem install bundler --no-ri --no-rdoc
+      - bundle install
+  - rvm: 2.5.1
+    install:
+      - gem install bundler --no-ri --no-rdoc
+      - bundle install
+  - rvm: 2.6.0-preview3
+    install:
+      - bundle install
+  - name: TruffleRuby
+    rvm: system
+    install:
+      - export TRUFFLERUBY_VERSION=1.0.0-rc3
+      - 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
+      - bundle install

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # HEAD
 
+## v0.19.0
+
+* Add `method_name` as alias for `header_column` converter
+* Freeze constants in `HeaderColumnConverter`
+* Add support for passing a callable object in `type_map` argument [PR#49](https://github.com/buren/honey_format/pull/49)
+* Remove non-printable & zero-width characters from header columns
+* Add `£` to header separator character list
+* Replace `@` with `_at_` in header converter
+* Replace all space like chars in Header converter. Closes [Issue#39]([PR#49](https://github.com/buren/honey_format/issues/39))
+* Improved CLI output when input path is missing
+
+## v0.18.0
 
 * Require `set` class in `ConvertBoolean` - fixes crash when set is already required in environment
 * Allow symbols to be passed to `HeaderColumnConverter`

data/README.md

@@ -28,7 +28,8 @@ Id,Username,Email
 CSV
 csv = HoneyFormat::CSV.new(csv_string, type_map: { id: :integer })
 csv.columns     # => [:id, :username]
-user = csv.rows # => [#<Row id=1, username="buren">]
+csv.rows        # => [#<Row id=1, username="buren">]
+user = csv.rows.first
 user.id         # => 1
 user.username   # => "buren"
 
@@ -98,7 +99,15 @@ csv = HoneyFormat::CSV.new(csv_string, type_map: type_map)
 csv.rows.first.id # => 1
 ```
 
-Add your own converter
+Pass your own
+```ruby
+csv_string = "Id,Username\n1,buren"
+type_map = { username: proc { |v| v.upcase } }
+csv = HoneyFormat::CSV.new(csv_string, type_map: type_map)
+csv.rows.first.username # => "BUREN"
+```
+
+Register your own converter
 ```ruby
 HoneyFormat.configure do |config|
   config.converter_registry.register :upcased, proc { |v| v.upcase }
@@ -125,7 +134,12 @@ decimal_converter = HoneyFormat.converter_registry[:decimal]
 decimal_converter.call('1.1') # => 1.1
 ```
 
-See [`Configuration#default_converters`](https://github.com/buren/honey_format/tree/master/lib/honey_format/configuration.rb#L38) for a complete list of the default ones.
+Default converter names
+```ruby
+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.
 
 __Row builder__
 
@@ -403,7 +417,7 @@ Usage: bin/benchmark [file.csv] [options]
         --[no-]verbose               Verbose output
         --lines-multipliers=[1,2,10] Multiply the rows in the CSV file (default: 1)
         --time=[30]                  Benchmark time (default: 30)
-        --warmup=[30]                Benchmark warmup (default: 30)
+        --warmup=[5]                 Benchmark warmup (default: 5)
     -h, --help                       How to use
 ```
 

data/exe/honey_format

@@ -10,7 +10,13 @@ require 'honey_format/cli/cli'
 cli = HoneyFormat::CLI.new
 options = cli.options
 
-input_path = options[:input_path] || raise(ArgumentError, 'input path required')
+input_path = options[:input_path]
+unless input_path
+  puts cli.usage
+  puts
+  puts '[ERROR] input path required'
+  exit 1
+end
 csv_input = File.read(input_path)
 csv = HoneyFormat::CSV.new(
   csv_input,

data/lib/honey_format/cli/cli.rb

@@ -12,9 +12,14 @@ module HoneyFormat
     # @return [CLI] the CLI
     def initialize(argv: ARGV, io: STDOUT)
       @io = io
+      @parser = nil
       @options = parse_options(argv: argv.dup)
     end
 
+    def usage
+      @parser.to_s
+    end
+
     private
 
     # Puts to configured IO
@@ -38,6 +43,8 @@ module HoneyFormat
       type_map = {}
 
       OptionParser.new do |parser|
+        @parser = parser
+
         parser.banner = 'Usage: honey_format [options] <file.csv>'
         parser.default_argv = argv
 
@@ -91,6 +98,7 @@ module HoneyFormat
       if input_path && argv.last
         raise(ArgumentError, "you can't provide both --csv and <path>")
       end
+
       input_path ||= argv.last
 
       {

data/lib/honey_format/configuration.rb

@@ -123,6 +123,7 @@ module HoneyFormat
         nil: ConvertNil,
         blank: ConvertBlank,
         header_column: ConvertHeaderColumn,
+        method_name: ConvertHeaderColumn,
       }.freeze
     end
   end

data/lib/honey_format/converters/header_column_converter.rb

@@ -4,32 +4,44 @@ module HoneyFormat
   # Header column converter
   module HeaderColumnConverter
     # Bracket character matcher
-    BRACKETS = /\(|\[|\{|\)|\]|\}/
+    BRACKETS = /\(|\[|\{|\)|\]|\}/.freeze
 
     # Separator characters
-    SEPS = /'|"|\||\*|\^|\&|%|\$|€|#/
+    SEPS = /'|"|\||\*|\^|\&|%|\$|€|£|#/.freeze
+
+    # Space characters
+    SPACES = /[[:space:]]+/.freeze
+
+    # Non-printable characters
+    NON_PRINT = /[^[:print:]]/.freeze
+
+    # zero-width characters - see https://stackoverflow.com/q/50647999
+    ZERO_WIDTH = /[\u200B-\u200D\uFEFF]/.freeze
 
     # Replace map
     REPLACE_MAP = [
-      [/\\/, '/'],     # replace "\" with "/"
-      [/ \(/, '('],    # replace " (" with "("
-      [/ \[/, '['],    # replace " [" with "["
-      [/ \{/, '{'],    # replace " {" with "{"
-      [/ \{/, '{'],    # replace " {" with "{"
-      [/\) /, ')'],    # replace ") " with ")"
-      [/\] /, ']'],    # replace "] " with "]"
-      [/\} /, '}'],    # replace "} " with "}"
-      [BRACKETS, '_'], # replace (, [, {, ), ] and } with "_"
-      [/ +/, '_'],     # replace one or more spaces with "_"
-      [/-/, '_'],      # replace "-" with "_"
-      [/\.|,/, '_'],   # replace "." and "," with "_"
-      [/::/, '_'],     # replace "::" with "_"
-      [%r{/}, '_'],    # replace "/" with "_"
-      [SEPS, '_'],     # replace separator chars with "_"
-      [/_+/, '_'],     # replace one or more "_" with single "_"
-      [/\A_+/, ''],    # remove leading "_"
-      [/_+\z/, ''],    # remove trailing "_"
-    ].map(&:freeze).freeze
+      [/\\/, '/'],       # replace "\" with "/"
+      [/ \(/, '('],      # replace " (" with "("
+      [/ \[/, '['],      # replace " [" with "["
+      [/ \{/, '{'],      # replace " {" with "{"
+      [/ \{/, '{'],      # replace " {" with "{"
+      [/\) /, ')'],      # replace ") " with ")"
+      [/\] /, ']'],      # replace "] " with "]"
+      [/\} /, '}'],      # replace "} " with "}"
+      [/@/, '_at_'],     # replace "@' with "_at_"
+      [BRACKETS, '_'],   # replace (, [, {, ), ] and } with "_"
+      [SPACES, '_'],     # replace one or more space chars with "_"
+      [/-/, '_'],        # replace "-" with "_"
+      [/\.|,/, '_'],     # replace "." and "," with "_"
+      [/::/, '_'],       # replace "::" with "_"
+      [%r{/}, '_'],      # replace "/" with "_"
+      [SEPS, '_'],       # replace separator chars with "_"
+      [/_+/, '_'],       # replace one or more "_" with single "_"
+      [NON_PRINT, ''],   # remove non-printable characters
+      [ZERO_WIDTH, ''],  # remove zero-width characters
+      [/\A_+/, ''],      # remove leading "_"
+      [/_+\z/, ''],      # remove trailing "_"
+    ].map { |e| e.map(&:freeze).freeze }.freeze
 
     # Returns converted value and mutates the argument.
     # @return [Symbol] the cleaned header column.
@@ -42,6 +54,7 @@ module HoneyFormat
     def self.call(column, index = nil)
       if column.nil? || column.empty?
         raise(ArgumentError, "column and column index can't be blank/nil") unless index
+
         return :"column#{index}"
       end
 

data/lib/honey_format/helpers/helpers.rb

@@ -15,6 +15,7 @@ module HoneyFormat
 
         values = Array.new(value) { |i| i }.map do |index|
           next key if index.zero?
+
           :"#{key}#{index}"
         end
         array.concat(values)

data/lib/honey_format/matrix/header.rb

@@ -147,6 +147,7 @@ module HoneyFormat
     def converter_arity
       # procs and lambdas respond to #arity
       return @converter.arity if @converter.respond_to?(:arity)
+
       @converter.method(:call).arity
     end
 

data/lib/honey_format/matrix/row_builder.rb

@@ -39,6 +39,7 @@ module HoneyFormat
       build_row!(row)
     rescue ArgumentError => e
       raise unless e.message == 'struct size differs'
+
       raise_invalid_row_length!(e, row)
     end
 
@@ -60,6 +61,7 @@ module HoneyFormat
       end
 
       return row unless @builder
+
       @builder.call(row)
     end
 

data/lib/honey_format/matrix/rows.rb

@@ -78,6 +78,7 @@ module HoneyFormat
       rows.each do |row|
         # ignore empty rows
         next if row.nil? || row.empty? || row == [nil]
+
         built_rows << builder.build(row)
       end
       built_rows

data/lib/honey_format/registry.rb

@@ -38,9 +38,11 @@ module HoneyFormat
     end
 
     # Call value type
-    # @param [Symbol, String] type the name of the type
+    # @param [Symbol, String, #call] type the name of the type
     # @param [Object] value to be converted
     def call(value, type)
+      return type.call(value) if type.respond_to?(:call)
+
       self[type].call(value)
     end
 
@@ -72,6 +74,7 @@ module HoneyFormat
     # @return [true, false] true if type exists, false otherwise
     def type?(type)
       return false unless keyable?(type)
+
       @callers.key?(to_key(type))
     end
 

data/lib/honey_format/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honey_format
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Jacob Burenstam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2018-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips