honey_format 0.16.0 → 0.17.0

data/lib/honey_format/matrix/matrix.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module HoneyFormat
+  # Represents Matrix.
+  class Matrix
+    # Instantiate Matrix.
+    # @return [Matrix] a new instance of Matrix.
+    # @param [Array<Array<String, nil>>] matrix
+    # @param header [Array<String>]
+    #   header optional argument that represents header, required if the matrix
+    #   lacks a header row.
+    # @param header_converter [#call] converts header columns.
+    # @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.
+    # @raise [HeaderError] super class of errors raised when there is a header error.
+    # @raise [MissingHeaderError] raised when header is missing (empty or nil).
+    # @raise [MissingHeaderColumnError] raised when header column is missing.
+    # @raise [RowError] super class of errors raised when there is a row error.
+    # @raise [EmptyRowColumnsError] raised when row columns are empty.
+    # @raise [InvalidRowLengthError] raised when row has more columns than header columns.
+    # @example
+    #   matrix = HoneyFormat::Matrix.new([%w[name id], %w[jacob 1]])
+    #   matrix.columns # => [:name, :id]
+    #   matrix.rows.to_a # => [#<Row name="jacob", id="1">]
+    # @example With custom header converter
+    #   converter = proc { |v| v == 'name' ? 'first_name' : v }
+    #   matrix = HoneyFormat::Matrix.new([%w[name id]], header_converter: converter)
+    #   matrix.columns # => [:first_name, :id]
+    # @example Handle errors
+    #   begin
+    #     matrix = HoneyFormat::Matrix.new([%w[name id]])
+    #   rescue HoneyFormat::HeaderError => e
+    #     puts "header error: #{e.class}, #{e.message}"
+    #   rescue HoneyFormat::RowError => e
+    #     puts "row error: #{e.class}, #{e.message}"
+    #   end
+    # @see Header#initialize
+    # @see Rows#initialize
+    def initialize(
+      matrix,
+      header: nil,
+      header_converter: HoneyFormat.header_converter,
+      header_deduplicator: HoneyFormat.config.header_deduplicator,
+      row_builder: nil,
+      type_map: {}
+    )
+      header_row = header || matrix.shift
+      @header = Header.new(
+        header_row,
+        converter: header_converter,
+        deduplicator: header_deduplicator
+      )
+      @rows = Rows.new(matrix, columns, builder: row_builder, type_map: type_map)
+    end
+
+    # Original matrix header
+    # @return [Header] object representing the matrix header.
+    def header
+      @header
+    end
+
+    # Matrix columns converted from the original Matrix header
+    # @return [Array<Symbol>] of column identifiers.
+    def columns
+      @header.to_a
+    end
+
+    # Return rows
+    # @return [Rows] rows.
+    def rows
+      @rows
+    end
+
+    # Itereate over each row
+    # @yield [row] The given block will be passed for every row.
+    # @yieldparam [Row] row in the matrix.
+    # @return [Enumerator] If no block is given, an enumerator object will be returned.
+    def each_row
+      return rows.each unless block_given?
+
+      rows.each { |row| yield(row) }
+    end
+
+    # Convert matrix to CSV-string.
+    # @param columns [Array<Symbol>, Set<Symbol>, NilClass]
+    #   the columns to output, nil means all columns (default: nil)
+    # @yield [row]
+    #   The given block will be passed for every row - return truthy if you want the
+    #   row to be included in the output
+    # @yieldparam [Row] row
+    # @return [String] CSV-string representation.
+    # @example with selected columns
+    #   matrix.to_csv(columns: [:id, :country])
+    # @example with selected rows
+    #   matrix.to_csv { |row| row.country == 'Sweden' }
+    # @example with both selected columns and rows
+    #   matrix.to_csv(columns: [:id, :country]) { |row| row.country == 'Sweden' }
+    def to_csv(columns: nil, &block)
+      columns = columns&.map(&:to_sym)
+      @header.to_csv(columns: columns) + @rows.to_csv(columns: columns, &block)
+    end
+  end
+end

data/lib/honey_format/{row.rb → matrix/row.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HoneyFormat
   # Default row builder
   class Row < Struct
@@ -12,7 +14,8 @@ module HoneyFormat
     end
 
     # Represent row as CSV
-    # @param columns [Array<Symbol>, Set<Symbol>, NilClass] the columns to output, nil means all columns (default: nil)
+    # @param columns [Array<Symbol>, Set<Symbol>, NilClass]
+    #   the columns to output, nil means all columns (default: nil)
     # @return [String] CSV-string representation.
     def to_csv(columns: nil)
       attributes = members
@@ -30,8 +33,8 @@ module HoneyFormat
         value = self[field]
         value = "\"#{value}\"" if value.is_a?(String)
 
-        [field, value].join("=")
-      end.join(", ")
+        [field, value].join('=')
+      end.join(', ')
 
       "#<Row #{attributes}>"
     end

data/lib/honey_format/{row_builder.rb → matrix/row_builder.rb}

@@ -1,4 +1,4 @@
-require 'honey_format/row'
+# frozen_string_literal: true
 
 module HoneyFormat
   # Holds data for a single row.
@@ -20,7 +20,7 @@ module HoneyFormat
       end
 
       @type_map = type_map
-      @converter = HoneyFormat.value_converter
+      @converter = HoneyFormat.converter_registry
 
       @row_klass = Row.new(*columns)
       @builder = builder
@@ -30,7 +30,8 @@ module HoneyFormat
     # Returns an object representing the row.
     # @return [Row, Object] a new instance of built row.
     # @param row [Array] the row array.
-    # @raise [InvalidRowLengthError] raised when there are more row elements longer than columns
+    # @raise [InvalidRowLengthError]
+    #   raised when there are more row elements longer than columns
     # @example Build new row
     #     r = RowBuilder.new([:id])
     #     r.build(['1']).id #=> '1'
@@ -71,7 +72,7 @@ module HoneyFormat
         "Row length #{row.length}",
         "column length #{@columns.length}",
         "row: #{row.inspect}",
-        "orignal message: '#{e.message}'"
+        "orignal message: '#{e.message}'",
       ].join(', ')
       raise(Errors::InvalidRowLengthError, err_msg)
     end

data/lib/honey_format/{rows.rb → matrix/rows.rb}

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 require 'set'
-require 'honey_format/row_builder'
 
 module HoneyFormat
   # Represents rows.
@@ -46,8 +47,10 @@ module HoneyFormat
     end
     alias_method :size, :length
 
-    # @param columns [Array<Symbol>, Set<Symbol>, NilClass] the columns to output, nil means all columns (default: nil)
-    # @yield [row] each row - return truthy if you want the row to be included in the output
+    # @param columns [Array<Symbol>, Set<Symbol>, NilClass]
+    #   the columns to output, nil means all columns (default: nil)
+    # @yield [row]
+    #   each row - return truthy if you want the row to be included in the output
     # @yieldparam [Row] row
     # @return [String] CSV-string representation.
     # @example with selected columns
@@ -61,7 +64,7 @@ module HoneyFormat
       columns = Set.new(columns.map(&:to_sym)) if columns
       csv_rows = []
       each do |row|
-        if !block || block.call(row)
+        if !block || yield(row)
           csv_rows << row.to_csv(columns: columns)
         end
       end

data/lib/honey_format/matrix.rb

@@ -1,90 +1,7 @@
-require 'csv'
+# frozen_string_literal: true
 
-require 'honey_format/rows'
-require 'honey_format/header'
-
-module HoneyFormat
-  # Represents CSV.
-  class Matrix
-    # Instantiate CSV.
-    # @return [CSV] a new instance of Matrix.
-    # @param [Array<Array<String, nil>>] matrix
-    # @param [Array<String>] header optional argument that represents header, required if the matrix lacks a header row.
-    # @param [#call] header_converter converts header columns.
-    # @param [#call] row_builder will be called for each parsed row.
-    # @param type_map [Hash] map of column_name => type conversion to perform.
-    # @raise [HeaderError] super class of errors raised when there is a header error.
-    # @raise [MissingHeaderError] raised when header is missing (empty or nil).
-    # @raise [MissingHeaderColumnError] raised when header column is missing.
-    # @raise [RowError] super class of errors raised when there is a row error.
-    # @raise [EmptyRowColumnsError] raised when row columns are empty.
-    # @raise [InvalidRowLengthError] raised when row has more columns than header columns.
-    # @example
-    #   matrix = HoneyFormat::Matrix.new([%w[name id]])
-    # @example With custom header converter
-    #   converter = proc { |v| v == 'name' ? 'first_name' : v }
-    #   matrix = HoneyFormat::Matrix.new([%w[name id]], header_converter: converter)
-    #   matrix.columns # => [:first_name, :id]
-    # @example Handle errors
-    #   begin
-    #     matrix = HoneyFormat::Matrix.new([%w[name id]])
-    #   rescue HoneyFormat::HeaderError => e
-    #     puts "header error: #{e.class}, #{e.message}"
-    #   rescue HoneyFormat::RowError => e
-    #     puts "row error: #{e.class}, #{e.message}"
-    #   end
-    def initialize(
-      matrix,
-      header: nil,
-      header_converter: HoneyFormat.header_converter,
-      row_builder: nil,
-      type_map: {}
-    )
-      header_row = header || matrix.shift
-      @header = Header.new(header_row, converter: header_converter)
-      @rows = Rows.new(matrix, columns, builder: row_builder, type_map: type_map)
-    end
-
-    # Original CSV header
-    # @return [Header] object representing the CSV header.
-    def header
-      @header
-    end
-
-    # CSV columns converted from the original CSV header
-    # @return [Array<Symbol>] of column identifiers.
-    def columns
-      @header.to_a
-    end
-
-    # @return [Rows] of rows.
-    def rows
-      @rows
-    end
-
-    # @yield [row] The given block will be passed for every row.
-    # @yieldparam [Row] row in the CSV.
-    # @return [Enumerator] If no block is given, an enumerator object will be returned.
-    def each_row
-      return rows.each unless block_given?
-
-      rows.each { |row| yield(row) }
-    end
-
-    # Convert matrix to CSV-string.
-    # @param columns [Array<Symbol>, Set<Symbol>, NilClass] the columns to output, nil means all columns (default: nil)
-    # @yield [row] The given block will be passed for every row - return truthy if you want the row to be included in the output
-    # @yieldparam [Row] row
-    # @return [String] CSV-string representation.
-    # @example with selected columns
-    #   matrix.to_csv(columns: [:id, :country])
-    # @example with selected rows
-    #   matrix.to_csv { |row| row.country == 'Sweden' }
-    # @example with both selected columns and rows
-    #   matrix.to_csv(columns: [:id, :country]) { |row| row.country == 'Sweden' }
-    def to_csv(columns: nil, &block)
-      columns = columns&.map(&:to_sym)
-      @header.to_csv(columns: columns) + @rows.to_csv(columns: columns, &block)
-    end
-  end
-end
+require 'honey_format/matrix/row_builder'
+require 'honey_format/matrix/rows'
+require 'honey_format/matrix/row'
+require 'honey_format/matrix/header'
+require 'honey_format/matrix/matrix'

data/lib/honey_format/registry.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module HoneyFormat
+  # Registry that holds value callers
+  class Registry
+    # Instantiate a caller registry
+    # @param [Hash] default hash of defaults
+    def initialize(default = {})
+      @callers = nil
+      @default = default.dup
+      reset!
+    end
+
+    # Returns list of registered types
+    # @return [Array<Symbol>] list of registered types
+    def types
+      @callers.keys
+    end
+
+    # Register a caller
+    # @param [Symbol, String] type the name of the type
+    # @param [#call] caller that responds to #call
+    # @return [Registry] returns self
+    # @raise [TypeExistsError] if type is already registered
+    def register(type, caller)
+      self[type] = caller
+      self
+    end
+
+    # Unregister a caller
+    # @param [Symbol, String] type the name of the type
+    # @return [Registry] returns self
+    # @raise [UnknownTypeError] if type is already registered
+    def unregister(type)
+      unknown_type_error!(type) unless type?(type)
+      @callers.delete(to_key(type))
+      self
+    end
+
+    # Call value type
+    # @param [Symbol, String] type the name of the type
+    # @param [Object] value to be converted
+    def call(value, type)
+      self[type].call(value)
+    end
+
+    # Register a caller
+    # @param [Symbol, String] type the name of the type
+    # @param [#call] caller that responds to #call
+    # @return [Object] returns the caller
+    # @raise [TypeExistsError] if type is already registered
+    def []=(type, caller)
+      type = to_key(type)
+
+      if type?(type)
+        raise(Errors::TypeExistsError, "type '#{type}' already exists")
+      end
+
+      @callers[type] = caller
+    end
+
+    # Returns the given type or raises error if type doesn't exist
+    # @param [Symbol, String] type the name of the type
+    # @return [Object] returns the caller
+    # @raise [UnknownTypeError] if type does not exist
+    def [](type)
+      @callers.fetch(to_key(type)) { unknown_type_error!(type) }
+    end
+
+    # Returns true if the type exists, false otherwise
+    # @param [Symbol, String] type the name of the type
+    # @return [true, false] true if type exists, false otherwise
+    def type?(type)
+      return false unless keyable?(type)
+      @callers.key?(to_key(type))
+    end
+
+    # Resets the caller registry to its default configuration
+    # @return [Registry] returns the caller registry
+    def reset!
+      @callers = @default.dup
+      self
+    end
+
+    private
+
+    def keyable?(key)
+      key.respond_to?(:to_sym)
+    end
+
+    def to_key(key)
+      key.to_sym
+    end
+
+    def unknown_type_error!(type)
+      raise(Errors::UnknownTypeError, "unknown type '#{type}'")
+    end
+  end
+end

data/lib/honey_format/version.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module HoneyFormat
   # Gem version
   VERSION = [
     MAJOR_VERSION = 0,
-    MINOR_VERSION = 16,
-    PATCH_VERSION = 0
+    MINOR_VERSION = 17,
+    PATCH_VERSION = 0,
   ].join('.')
 end

data/lib/honey_format.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'honey_format/version'
 require 'honey_format/configuration'
 require 'honey_format/errors'
-require 'honey_format/value_converter'
+require 'honey_format/registry'
+require 'honey_format/converters/converters'
 require 'honey_format/csv'
 
-
 # Main module for HoneyFormat
 module HoneyFormat
   # CSV alias
@@ -32,9 +34,15 @@ module HoneyFormat
     config.header_converter
   end
 
-  # Returns the configured value converter
-  # @return [#call] the current value converter
-  def self.value_converter
-    config.converter
+  # Returns the configured converter registry
+  # @return [Registry] the current converter registry
+  def self.converter_registry
+    config.converter_registry
+  end
+
+  # Returns the configured deduplicator registry
+  # @return [Registry] the current deduplicator registry
+  def self.header_deduplicator_registry
+    config.header_deduplicator_registry
   end
 end

metadata

@@ -1,45 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: honey_format
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Jacob Burenstam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-30 00:00:00.000000000 Z
+date: 2018-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,21 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -105,7 +105,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-style-guide.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -123,15 +126,22 @@ files:
 - lib/honey_format/cli/cli.rb
 - lib/honey_format/cli/result_writer.rb
 - lib/honey_format/configuration.rb
+- lib/honey_format/converters/convert_boolean.rb
+- lib/honey_format/converters/convert_date_and_time.rb
+- lib/honey_format/converters/convert_number.rb
+- lib/honey_format/converters/convert_string.rb
+- lib/honey_format/converters/converters.rb
+- lib/honey_format/converters/header_column_converter.rb
 - lib/honey_format/csv.rb
 - lib/honey_format/errors.rb
-- lib/honey_format/header.rb
-- lib/honey_format/header_column_converter.rb
+- lib/honey_format/helpers/helpers.rb
 - lib/honey_format/matrix.rb
-- lib/honey_format/row.rb
-- lib/honey_format/row_builder.rb
-- lib/honey_format/rows.rb
-- lib/honey_format/value_converter.rb
+- lib/honey_format/matrix/header.rb
+- lib/honey_format/matrix/matrix.rb
+- lib/honey_format/matrix/row.rb
+- lib/honey_format/matrix/row_builder.rb
+- lib/honey_format/matrix/rows.rb
+- lib/honey_format/registry.rb
 - lib/honey_format/version.rb
 homepage: https://github.com/buren/honey_format
 licenses:

data/lib/honey_format/header_column_converter.rb

@@ -1,40 +0,0 @@
-module HoneyFormat
-  # Header column converter
-  module HeaderColumnConverter
-    # Replace map
-    REPLACE_MAP = [
-      [/ \(/, '('],
-      [/ \[/, '['],
-      [/ \{/, '{'],
-      [/\) /, ')'],
-      [/\] /, ']'],
-      [/\} /, '}'],
-      [/ /, '_'],
-      [/-/, '_']
-    ].map { |array| array.freeze }.freeze
-
-    # Returns converted value and mutates the argument.
-    # @return [Symbol] the cleaned header column.
-    # @param [String] column the string to be cleaned.
-    # @param [Integer] index the column index.
-    # @example Convert simple header
-    #     HeaderColumnConverter.call("  User name ") #=> "user_name"
-    # @example Convert complex header
-    #     HeaderColumnConverter.call(" First name (user)") #=> :'first_name(user)'
-    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
-
-      column = column.dup
-      column.strip!
-      column.downcase!
-      REPLACE_MAP.each do |data|
-        from, to = data
-        column.gsub!(from, to)
-      end
-      column.to_sym
-    end
-  end
-end