csv_converter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20286f21df3a885fb2b08dffcf7eb1ab51c79adbd3962042b8ee7cfcec5ffdf7
+  data.tar.gz: b3d6d7ffa1b284f14d3122d5cbf6cb407f829befda0496996f6a950c13414a2c
+SHA512:
+  metadata.gz: b929f7e217e5aa0d8d4d31828a31b35102a520824b172dd27a80e0b98275d2eb4765d8e94e04bb617de172b7ee8840c9c474e171191ac42ad8aecbaafe1b5512
+  data.tar.gz: c1c5decb31c6fdae2086400ff514709b8201ccdf526ff06502d48c86b963e25d382f1cd18ed9e05b256accc61f86b48d1a9bc850e1e99f5fdb8eb0488c765a28

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.history/
+.byebug_history
+.DS_Store
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in csv_converter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    csv_converter (0.1.0)
+      activesupport (~> 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    ast (2.4.0)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.3)
+    minitest (5.12.2)
+    parallel (1.18.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-readline (0.5.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.75.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    zeitwerk (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug (~> 11.0)
+  csv_converter!
+  rake (~> 10.0)
+  rb-readline (~> 0.5)
+  rspec (~> 3.0)
+  rubocop (~> 0.75)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2019] [Jose Francisco Rojas Soto]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,132 @@
+# csv_converter [![Build Status](https://travis-ci.org/francisco-rojas/basic_ruby.svg?branch=master)](https://travis-ci.org/francisco-rojas/basic_ruby)
+
+*csv_converter* is a library for facilitating the grouping and transformation of tabulated data contained in files such as csv or spreadsheets files. This is **not** a library for parsing files. There are already plenty of libraries out there for reading and parsing files in different formats.
+
+Instead, this library focuses on the conversion of the data provided in the files. Often times, it is required to cast the text data into a ruby object, perform validations on that data, and map it to the corresponding db tables/models and columns/attributes. This library aims to simplify that process.
+
+For example, given the following csv content:
+
+```
+First Name,Last Name,Make,Model,Year,Color,Purchase Date
+John,Smith,Ford,Mustang,2000,Black,25/01/99
+Julian,Moore,Toyota,Yaris,2005,Red,13/04/05
+Joe,Black,Volvo,V40,2015,Gold,03/02/16
+```
+
+| First Name  | Last Name | Make    | Model   | Year | Color | Purchase Date |
+| ----------- | --------- | ------- | ------- | ---- | ----- | ------------- |
+| John        | Smith     | Ford    | Mustang | 2000 | Black | 25/01/99      |
+| Julian      | Moore     | Toyota  | Yaris   | 2005 | Red   | 13/04/05      |
+| Joe         | Black     | Volvo   | V40     | 2015 | Gold  | 03/02/16      |
+
+
+you might want something like this:
+
+```ruby
+[
+  {
+    "owner" => {
+      "first_name" => "John",
+      "last_name" => "Smith"
+    },
+    "vehicle" => {
+      "make" => "Ford",
+      "model" => "Mustang",
+      "year" => 2000,
+      "color" => "Black",
+      "purchase_date" => #<Date: 1999-01-25 ((2451204j,0s,0n),+0s,2299161j)>
+    }
+  },
+  {
+    "owner" => {
+      "first_name" => "Julian",
+      "last_name" => "Moore"
+    },
+    "vehicle" => {
+      "make" => "Toyota",
+      "model" => "Yaris",
+      "year" => 2005,
+      "color" => "Red",
+      "purchase_date" => #<Date: 2005-04-15 ((2453476j,0s,0n),+0s,2299161j)>
+    }
+  },
+  {
+    "owner" => {
+      "first_name" => "Joe",
+      "last_name" => "Black"
+    },
+    "vehicle" => {
+      "make" => "Volvo",
+      "model" => "V40",
+      "year" => 2015,
+      "color" => "Gold",
+      "purchase_date" => #<Date: 2016-03-02 ((2457450j,0s,0n),+0s,2299161j)>
+    }
+  }
+]
+```
+
+In this example, each column from the csv has been grouped according to the configuration provided. Also, the data for each column has been converted to the expected data type.
+
+This is performed by *csv_converter* based on the configuration provided in a .yml file (or a ruby hash) that lookes like this:
+
+```
+owner:
+  first_name:
+    header: First Name
+  last_name:
+    header: Last Name
+vehicle:
+  make:
+    header: Make
+  model:
+    header: Model
+  year:
+    header: Year
+    converters:
+      integer:
+  color:
+    header: Color
+  purchase_date:
+    header: Purchase Date
+    converters:
+      date:
+        date_format: "%m/%d/%y"
+```
+
+## Usage
+
+*csv_converter* supports more advanced data conversions, processing data based on column position instead of headers and nested records within a column.
+
+Please refer to the [*wiki page*](https://github.com/francisco-rojas/csv_converter/wiki) for further instructions and more advanced examples.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'csv_converter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csv_converter
+
+## Development
+
+Currently, the library is stable. I believe it supports the most common use cases so most likely the code won't be updated very frequently. However, if you have any feature requests or find a bug feel free to open a github issue and I will reply as soon as I can.
+
+- for **feature requests** please use the **enhancement** label.
+- for **bugs** please use the **bugs** label.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/francisco-rojas/csv_converter
+
+## License
+
+MIT License. Copyright 2019 Francisco Rojas. https://github.com/francisco-rojas

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'csv_converter'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/csv_converter.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'csv_converter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'csv_converter'
+  spec.version       = CSVConverter::VERSION
+  spec.authors       = ['Francisco Rojas']
+  spec.email         = ['josefcorojas@gmail.com']
+
+  spec.summary       = 'Groups and converts tabulated data'
+  spec.description   = 'Groups and converts tabulated data based on the mappings provided'
+  spec.homepage      = 'https://github.com/francisco-rojas/csv_converter'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri']     = spec.homepage
+  spec.metadata['wiki_uri']         = 'https://github.com/francisco-rojas/csv_converter/wiki'
+  spec.metadata['source_code_uri']  = 'https://github.com/francisco-rojas/csv_converter'
+  spec.metadata['changelog_uri']    = 'https://github.com/francisco-rojas/csv_converter/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 6.0'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'byebug', '~> 11.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rb-readline', '~> 0.5'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.75'
+end

data/lib/csv_converter.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'date'
+
+require 'active_support'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/inflector'
+
+require 'csv_converter/version'
+require 'csv_converter/converters/base_converter'
+require 'csv_converter/converters/array_converter'
+require 'csv_converter/converters/hash_converter'
+require 'csv_converter/converters/big_decimal_converter'
+require 'csv_converter/converters/boolean_converter'
+require 'csv_converter/converters/date_converter'
+require 'csv_converter/converters/float_converter'
+require 'csv_converter/converters/integer_converter'
+require 'csv_converter/converters/string_converter'
+require 'csv_converter/converters/uppercase_converter'
+require 'csv_converter/converters/lowercase_converter'
+require 'csv_converter/file_processor'
+require 'csv_converter/entity_processor'
+require 'csv_converter/attribute_processor'
+
+# CSVConverter groups and transforms tabulated data contained in files such as csv or spreadsheets.
+module CSVConverter
+  # Error holds error messages as well as details of the data being processed.
+  class Error < StandardError
+    # Details of the data being processed when the error happened. By default this includes:
+    #   filename: the name of the file being processed
+    #   row_num: number of the row being processed
+    #   entity: the name of the entity being processed as provided in the mappings
+    #   row: the raw data of the row being processed
+    #   attr: the name of the attribute being processed as provided in the mappings
+    # Additionally it contains all the options provided to the converter in the mappings.
+    # @return [Hash]
+    attr_reader :details
+
+    # A new instance of Error.
+    # @param message [String] the error description
+    # @param details [Hash] info about the data being proccesed at the time of the error
+    def initialize(message, details = {})
+      @details = details
+      super("#{message} on: #{details}")
+    end
+  end
+
+  ALIASES = {
+    array: 'CSVConverter::Converters::ArrayConverter',
+    boolean: 'CSVConverter::Converters::BooleanConverter',
+    date: 'CSVConverter::Converters::DateConverter',
+    decimal: 'CSVConverter::Converters::BigDecimalConverter',
+    float: 'CSVConverter::Converters::FloatConverter',
+    hash: 'CSVConverter::Converters::HashConverter',
+    integer: 'CSVConverter::Converters::IntegerConverter',
+    lowercase: 'CSVConverter::Converters::LowercaseConverter',
+    string: 'CSVConverter::Converters::StringConverter',
+    uppercase: 'CSVConverter::Converters::UppercaseConverter'
+  }.with_indifferent_access
+
+  # When no custom aliases are included it returns CSVConverter::ALIASES.
+  # When custom converter alises are included it returns the whole list of aliases.
+  # @return [Hash] list of aliases for each converter class.
+  def self.aliases
+    @aliases || ALIASES
+  end
+
+  # Adds an alias to the list of aliases
+  # @param new_alias [Symbol, String] the name of the alias
+  # @param klass [Symbol, String] class name of the converter
+  # @return (@see #aliases)
+  def self.add_alias(new_alias, klass)
+    @aliases = aliases.merge(new_alias.to_sym => klass.to_s)
+  end
+
+  # Adds one or more alieases to the list of aliases
+  # @param new_aliases [Hash] list of aliases to append to the list,
+  #   where the key is the name of the alias and the value is the class name of the converter
+  # @return (@see #aliases)
+  def self.add_aliases(new_aliases)
+    @aliases = aliases.merge(new_aliases)
+  end
+end

data/lib/csv_converter/attribute_processor.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module CSVConverter
+  # Extracts the value for a column from the csv row and applies conversions to it.
+  class AttributeProcessor
+    # The row being processed.
+    # @return [Array, Hash]
+    attr_reader :row
+
+    # The column being processed.
+    # @return [String]
+    attr_reader :data
+
+    # Attribute mappings.
+    # @return [Hash] configuration used to process the data.
+    attr_reader :attr_mappings
+
+    # Details of the data being processed. By default this includes:
+    #   filename: the name of the file being processed.
+    #   row_num: number of the row being processed.
+    #   entity: the name of the entity being processed as provided in the mappings.
+    #   row: the raw data of the row being processed.
+    #   attr: the name of the attribute being processed as provided in the mappings.
+    # Additionally it will contain all the options provided to the converter in the mappings.
+    # @return [Hash]
+    attr_reader :options
+
+    # A new instance of AttributeProcessor.
+    # @param row (@see #row)
+    # @param attr_mappings (@see #attr_mappings)
+    # @param options (@see #options)
+    def initialize(row, attr_mappings, options = {})
+      @row            = row
+      @attr_mappings  = attr_mappings
+      @options        = options
+      @data           = row[attr_mappings[:header]]
+    end
+
+    # Converts the data of the attribute into the type provided in the mappings by invoking the converters.
+    # @return [Object] an object of the expected type.
+    #   If an error occurs during conversion the nullable value for the attributes is returned.
+    def call
+      convert_attr(&:call)
+    end
+
+    # Converts the data of the attribute into the type provided in the mappings by invoking the converters.
+    # @return [Object] an object of the expected type.
+    #   If an error occurs during conversion an error is raised.
+    def call!
+      convert_attr(&:call!)
+    end
+
+    private
+
+    def convert_attr(&block)
+      return data if attr_mappings.dig(:converters).blank?
+
+      attr_mappings.dig(:converters).inject(data) do |d, (converter, opts)|
+        opts = (opts || {}).merge(options)
+        invoke_converter(converter, d, opts, &block)
+      end
+    end
+
+    def invoke_converter(converter, data, opts)
+      return converter.call(data, opts) if converter.is_a?(Proc)
+
+      converter = converter.to_s
+      converter = CSVConverter::ALIASES[converter] if CSVConverter::ALIASES.keys.include?(converter)
+      converter = converter.constantize.new(data, opts)
+
+      yield(converter)
+    end
+  end
+end

data/lib/csv_converter/converters/array_converter.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module CSVConverter
+  module Converters
+    # Converts a string separated by a given char into an array of strings.
+    class ArrayConverter < BaseConverter
+      # A new instance of ArrayConverter.
+      # @param raw_data [String] the raw data of the attribute being processed.
+      # @param options [Hash] the options for the converter provided in the mappings.
+      #   Additionally, contains the details of the data being processed. See BaseConverter#option.
+      #   The *separator* key is required. If *separator* is nil then an error is raised.
+      def initialize(raw_data, options = { separator: ',' })
+        super(raw_data, options)
+
+        validate_options
+      end
+
+      # Converts *data* into an array by splitting the string on the *separator* provided in the mappings.
+      # @return [Array] if an error occurs during conversion an empty array is returned.
+      def call
+        call!
+      rescue CSVConverter::Error
+        nullable_object
+      end
+
+      # Converts *data* into an array by splitting the string on the *separator* provided in the mappings.
+      # @return [Array] if an error occurs during conversion an error is raised.
+      def call!
+        data.split(options[:separator]).map(&:strip)
+      rescue StandardError => e
+        raise CSVConverter::Error.new(e.message, options)
+      end
+
+      private
+
+      def validate_options
+        return if options && !options[:separator].nil?
+
+        raise CSVConverter::Error.new('no `key_value_separator` provided', options)
+      end
+
+      def nullable_object
+        []
+      end
+    end
+  end
+end

data/lib/csv_converter/converters/base_converter.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module CSVConverter
+  module Converters
+    # Defines the interface that all converters must implement
+    class BaseConverter
+      # @return [String] the raw data of the attribute being processed.
+      attr_reader :raw_data
+      # Details of the data being processed. By default this includes:
+      #   filename: the name of the file being processed
+      #   row_num: number of the row being processed
+      #   entity: the name of the entity being processed as provided in the mappings
+      #   row: the raw data of the row being processed
+      #   attr: the name of the attribute being processed as provided in the mappings
+      # Additionally it contains all the options provided to the converter in the mappings.
+      # @return [Hash]
+      attr_reader :options
+
+      # A new instance of BaseConverter.
+      # @param raw_data [String] the raw data of the attribute being processed.
+      # @param options [Hash] the options for the converter provided in the mappings.
+      #   Additionally, contains the details of the data being processed.
+      def initialize(raw_data, options = {})
+        @raw_data   = raw_data.to_s.strip
+        @options    = options || {}
+      end
+
+      # Converts raw_data into the type specified in the mappings.
+      # Must be implemented by children
+      def call
+        raise NotImplementedError
+      end
+
+      # Converts raw_data into the type specified in the mappings.
+      # Must be implemented by children
+      def call!
+        raise NotImplementedError
+      end
+
+      # Evaluates raw_data and returns the proper value for it.
+      # @return [String]
+      #   If raw_data is not empty returns raw_data.
+      #   If raw_data is empty and no default value is provided in the mappings returns the nullable object.
+      #   If raw_data is empty and a default value is provided in the mappings returns the default value.
+      def data
+        @data ||= begin
+          return raw_data if raw_data.present? && !empty_value?
+
+          return nullable_object if options.dig(:default).blank?
+
+          options.dig(:default)
+        end
+      end
+
+      # Checks if raw_data is contained in the list of *empty_values* provided in the mapping.
+      # @return [Boolean]
+      def empty_value?
+        return false unless options.dig(:empty_values)
+
+        options.dig(:empty_values).include?(raw_data)
+      end
+
+      private
+
+      def nullable_object
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/csv_converter/converters/big_decimal_converter.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+
+module CSVConverter
+  module Converters
+    # Converts a string into a decimal number
+    class BigDecimalConverter < BaseConverter
+      # Converts *data* into a BigDecimal.
+      # If the decimal separator is a comma it is replaced by a period before parsing.
+      # @return [BigDecimal] if an error occurs during conversion nil is returned.
+      def call
+        call!
+      rescue CSVConverter::Error
+        nullable_object
+      end
+
+      # Converts *data* into a BigDecimal.
+      # If the decimal separator is a comma it is replaced by a period before parsing.
+      # @return [BigDecimal] if an error occurs during conversion an error is raised.
+      def call!
+        BigDecimal(data.sub(',', '.'))
+      rescue StandardError => e
+        raise CSVConverter::Error.new(e.message, options)
+      end
+
+      private
+
+      def nullable_object
+        nil
+      end
+    end
+  end
+end

data/lib/csv_converter/converters/boolean_converter.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module CSVConverter
+  module Converters
+    # Converts a string into a boolean
+    class BooleanConverter < BaseConverter
+      # A new instance of BooleanConverter.
+      # @param raw_data [String] the raw data of the attribute being processed.
+      # @param options [Hash] the options for the converter provided in the mappings.
+      #   Additionally, contains the details of the data being processed. See BaseConverter#option.
+      #   The *truthy_values* key is required. If *truthy_values* is blank then an error is raised.
+      def initialize(raw_data, options = { truthy_values: %w[true false] })
+        super(raw_data, options)
+
+        validate_options
+      end
+
+      # Converts *data* into a Boolean by checking if *data*
+      # is contained in the list of *truthy_values* provided in the mappings.
+      # @return [Boolean] if an error occurs during conversion `false` is returned.
+      def call
+        call!
+      rescue CSVConverter::Error
+        nullable_object
+      end
+
+      # Converts *data* into a Boolean by checking if *data*
+      # is contained in the list of *truthy_values* provided in the mappings.
+      # @return [Boolean] if an error occurs during conversion an error is raised.
+      def call!
+        options[:truthy_values].include?(data)
+      rescue StandardError => e
+        raise CSVConverter::Error.new(e.message, options)
+      end
+
+      private
+
+      def validate_options
+        return if options && options[:truthy_values].present?
+
+        raise CSVConverter::Error.new('no `truthy_values` provided', options)
+      end
+
+      def nullable_object
+        false
+      end
+    end
+  end
+end

data/lib/csv_converter/converters/date_converter.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module CSVConverter
+  module Converters
+    # Converts a string into a date
+    class DateConverter < BaseConverter
+      # A new instance of DateConverter.
+      # @param raw_data [String] the raw data of the attribute being processed.
+      # @param options [Hash] the options for the converter provided in the mappings.
+      #   Additionally, contains the details of the data being processed. See BaseConverter#option.
+      #   The *date_format* key is required. If *date_format* is blank then an error is raised.
+      def initialize(raw_data, options = { date_format: '%m/%d/%y' })
+        super(raw_data, options)
+
+        validate_options
+      end
+
+      # Converts *data* into a Date using the format provided in the mappings.
+      # @return [Date] if an error occurs during conversion `nil` is returned.
+      def call
+        call!
+      rescue CSVConverter::Error
+        nullable_object
+      end
+
+      # Converts *data* into a Date using the format provided in the mappings.
+      # @return [Date] if an error occurs during conversion an error is raised.
+      def call!
+        Date.strptime(data, options[:date_format])
+      rescue StandardError => e
+        raise CSVConverter::Error.new(e.message, options)
+      end
+
+      private
+
+      def validate_options
+        return if options && options[:date_format].present?
+
+        raise CSVConverter::Error.new('no `date_format` provided', options)
+      end
+
+      def nullable_object
+        nil
+      end
+    end
+  end
+end

data/lib/csv_converter/converters/float_converter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module CSVConverter
+  module Converters
+    # Converts a string into a float
+    class FloatConverter < BaseConverter
+      # Converts *data* into a Float.
+      # If the decimal separator is a comma it is replaced by a period before parsing.
+      # @return [Float] if an error occurs during conversion nil is returned.
+      def call
+        call!
+      rescue CSVConverter::Error
+        nullable_object
+      end
+
+      # Converts *data* into a Float.
+      # If the decimal separator is a comma it is replaced by a period before parsing.
+      # @return [Float] if an error occurs during conversion an error is raised.
+      def call!
+        Float(data.sub(',', '.'))
+      rescue StandardError => e
+        raise CSVConverter::Error.new(e.message, options)
+      end
+
+      private
+
+      def nullable_object
+        nil
+      end
+    end
+  end
+end

data/lib/csv_converter/converters/hash_converter.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module CSVConverter
+  module Converters
+    # Converts a string with key pair values into ruby hashes
+    class HashConverter < BaseConverter
+      # A new instance of HashConverter.
+      # @param raw_data [String] the raw data of the attribute being processed.
+      # @param options [Hash] the options for the converter provided in the mappings.
+      #   Additionally, contains the details of the data being processed. See BaseConverter#option.
+      #   The *item_separator* key is required. If *item_separator* is nil then an error is raised.
+      #   The *key_value_separator* key is required. If *key_value_separator* is nil then an error is raised.
+      def initialize(raw_data, options = {})
+        super(raw_data, options)
+
+        validate_options
+      end
+
+      # Converts *data* into a hash by splitting the string on the *item_separator* to get the items
+      # and then by spliting the items on *key_value_separator* to get the key/value.
+      # @return [Hash] if an error occurs during conversion an empty hash is returned.
+      def call
+        call!
+      rescue CSVConverter::Error
+        nullable_object
+      end
+
+      # Converts *data* into a hash by splitting the string on the *item_separator* to get the items
+      # and then by spliting the items on *key_value_separator* to get the key/value.
+      # @return [Hash] if an error occurs during conversion an error is raised.
+      def call!
+        data.split(options[:item_separator]).map do |items|
+          items.split(options[:key_value_separator]).map(&:strip)
+        end.to_h
+      rescue StandardError => e
+        raise CSVConverter::Error.new(e.message, options)
+      end
+
+      private
+
+      def validate_options
+        validate_separator
+        validate_key_value_separator
+      end
+
+      def validate_separator
+        return unless options[:item_separator].nil?
+
+        raise CSVConverter::Error.new('no `item_separator` provided', options)
+      end
+
+      def validate_key_value_separator
+        return unless options[:key_value_separator].nil?
+
+        raise CSVConverter::Error.new('no `key_value_separator` provided', options)
+      end
+
+      def nullable_object
+        {}
+      end
+    end
+  end
+end

data/lib/csv_converter/converters/integer_converter.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module CSVConverter
+  module Converters
+    # Converts a string into an integer
+    class IntegerConverter < BaseConverter
+      # Converts *data* into an Integer.
+      # @return [Integer] if an error occurs during conversion nil is returned.
+      def call
+        call!
+      rescue CSVConverter::Error
+        nullable_object
+      end
+
+      # Converts *data* into an Integer.
+      # @return [Integer] if an error occurs during conversion an error is raised.
+      def call!
+        Integer(data)
+      rescue StandardError => e
+        raise CSVConverter::Error.new(e.message, options)
+      end
+
+      private
+
+      def nullable_object
+        nil
+      end
+    end
+  end
+end

data/lib/csv_converter/converters/lowercase_converter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module CSVConverter
+  module Converters
+    # Converts a string to lowercase
+    class LowercaseConverter < BaseConverter
+      # Converts a string to lowercase
+      # @return [String] if *data* is empty returns an empty string.
+      def call
+        call!
+      rescue CSVConverter::Error
+        nullable_object
+      end
+
+      # Converts a string to lowercase
+      # @return [String] if *data* is empty an error is raised.
+      def call!
+        raise ArgumentError, 'no data provided' if data.blank?
+
+        data.downcase
+      rescue StandardError => e
+        raise CSVConverter::Error.new(e.message, options)
+      end
+
+      private
+
+      def nullable_object
+        ''
+      end
+    end
+  end
+end

data/lib/csv_converter/converters/string_converter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module CSVConverter
+  module Converters
+    # Cleans up a string
+    class StringConverter < BaseConverter
+      # Cleans up the *data* string.
+      # @return [String] if *data* is empty returns an empty string.
+      def call
+        call!
+      rescue CSVConverter::Error
+        nullable_object
+      end
+
+      # Cleans up the *data* string.
+      # @return [String] if *data* is empty an error is raised.
+      def call!
+        raise ArgumentError, 'no data provided' if data.blank?
+
+        data
+      rescue StandardError => e
+        raise CSVConverter::Error.new(e.message, options)
+      end
+
+      private
+
+      def nullable_object
+        ''
+      end
+    end
+  end
+end

data/lib/csv_converter/converters/uppercase_converter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module CSVConverter
+  module Converters
+    # Converts a string to uppercase
+    class UppercaseConverter < BaseConverter
+      # Converts a string to uppercase
+      # @return [String] if *data* is empty returns an empty string.
+      def call
+        call!
+      rescue CSVConverter::Error
+        nullable_object
+      end
+
+      # Converts a string to uppercase
+      # @return [String] if *data* is empty an error is raised.
+      def call!
+        raise ArgumentError, 'no data provided' if data.blank?
+
+        data.upcase
+      rescue StandardError => e
+        raise CSVConverter::Error.new(e.message, options)
+      end
+
+      private
+
+      def nullable_object
+        ''
+      end
+    end
+  end
+end

data/lib/csv_converter/entity_processor.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module CSVConverter
+  # Iterates over the columns of a row and processes the data accordingly.
+  class EntityProcessor
+    # The row being processed.
+    # @return [Array, Hash]
+    attr_reader :row
+
+    # Entity mappings.
+    # @return [Hash] configuration used to process the data.
+    attr_reader :entity_mappings
+
+    # Details of the data being processed. By default this includes:
+    #   filename: the name of the file being processed.
+    #   row_num: number of the row being processed.
+    #   entity: the name of the entity being processed as provided in the mappings.
+    #   row: the raw data of the row being processed.
+    #   attr: the name of the attribute being processed as provided in the mappings.
+    # Additionally it will contain all the options provided to the converter in the mappings.
+    # @return [Hash]
+    attr_reader :options
+
+    # A new instance of EntityProcessor.
+    # @param row (@see #row)
+    # @param entity_mappings (@see #entity_mappings)
+    # @param options (@see #options)
+    def initialize(row, entity_mappings, options = {})
+      @row              = row
+      @entity_mappings  = entity_mappings
+      @options          = options
+    end
+
+    # Iterates over the attributes of each entity converting the data into the format expected by the mappings.
+    # @return [Hash] the attributes for each entity.
+    #   If an error occurs while processing the error is rescued and nullable values returned for the
+    #   attributes that caused the error.
+    def call
+      entity_attrs(&:call)
+    end
+
+    # Iterates over the attributes of each entity converting the data into the format expected by the mappings.
+    # @return [Hash] the attributes for each entity.
+    #   If an error occurs while processing the an error is raised.
+    def call!
+      entity_attrs(&:call!)
+    end
+
+    private
+
+    def entity_attrs(&block)
+      return nested_entity(&block) if entity_mappings[:nested]
+
+      entity_mappings.each_with_object({}) do |(attr, attr_mappings), hash|
+        processor = CSVConverter::AttributeProcessor.new(row, attr_mappings, options.merge(attr: attr))
+        hash[attr] = block.call(processor)
+      end
+    end
+
+    def nested_entity
+      separator  = entity_mappings[:separator] || ','
+      nested_row = row[entity_mappings[:header]].split(separator)
+      processor = self.class.new(nested_row, entity_mappings[:mappings], options)
+      yield(processor)
+    end
+  end
+end

data/lib/csv_converter/file_processor.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module CSVConverter
+  # Iterates over a collection and processes the data accordingly.
+  class FileProcessor
+    # Name of the file being processed.
+    # @return [String] the name of the file.
+    attr_reader :filename
+
+    # Collection being processed.
+    # @return [Array] collection of rows being processed.
+    attr_reader :rows
+
+    # File mappings.
+    # @return [Hash] configuration used to process the data.
+    attr_reader :file_mappings
+
+    # A new instance of FileProcessor.
+    # @param filename (@see #filename)
+    # @param rows (@see #rows)
+    # @param file_mappings (@see #file_mappings)
+    def initialize(filename, rows, file_mappings)
+      @filename       = filename
+      @rows           = rows
+      @file_mappings  = file_mappings.with_indifferent_access
+    end
+
+    # Iterates over the rows grouping and converting the data as expected based on the mappings.
+    # @return [Array] Collection of hashes containing the entities obtained after processing the rows.
+    #   If an error occurs while processing the error is rescued and nullable values returned for the
+    #   attributes that caused the error.
+    def call
+      rows.map.with_index do |row, row_num|
+        process_entities(row, row_num, &:call)
+      end
+    end
+
+    # Iterates over the rows grouping and converting the data as expected based on the mappings.
+    # @return [Array] Collection of hashes containing the entities obtained after processing the rows.
+    #   If an error occurs while processing the rows an error is raised.
+    def call!
+      rows.map.with_index do |row, row_num|
+        process_entities(row, row_num, &:call!)
+      end
+    end
+
+    private
+
+    def process_entities(row, row_num)
+      file_mappings.each_with_object({}) do |(entity, entity_mappings), hash|
+        hash[entity] = {} unless hash.key?(entity)
+        options = { filename: filename, row_num: row_num, entity: entity, row: row }
+        processor = CSVConverter::EntityProcessor.new(row, entity_mappings, options)
+        hash[entity] = yield(processor)
+      end.with_indifferent_access
+    end
+  end
+end

data/lib/csv_converter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CSVConverter
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: csv_converter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Francisco Rojas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.75'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.75'
+description: Groups and converts tabulated data based on the mappings provided
+email:
+- josefcorojas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- csv_converter.gemspec
+- lib/csv_converter.rb
+- lib/csv_converter/attribute_processor.rb
+- lib/csv_converter/converters/array_converter.rb
+- lib/csv_converter/converters/base_converter.rb
+- lib/csv_converter/converters/big_decimal_converter.rb
+- lib/csv_converter/converters/boolean_converter.rb
+- lib/csv_converter/converters/date_converter.rb
+- lib/csv_converter/converters/float_converter.rb
+- lib/csv_converter/converters/hash_converter.rb
+- lib/csv_converter/converters/integer_converter.rb
+- lib/csv_converter/converters/lowercase_converter.rb
+- lib/csv_converter/converters/string_converter.rb
+- lib/csv_converter/converters/uppercase_converter.rb
+- lib/csv_converter/entity_processor.rb
+- lib/csv_converter/file_processor.rb
+- lib/csv_converter/version.rb
+homepage: https://github.com/francisco-rojas/csv_converter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/francisco-rojas/csv_converter
+  wiki_uri: https://github.com/francisco-rojas/csv_converter/wiki
+  source_code_uri: https://github.com/francisco-rojas/csv_converter
+  changelog_uri: https://github.com/francisco-rojas/csv_converter/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Groups and converts tabulated data
+test_files: []