csv_factory 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1db58c82005a991de32cf94235a6fa248e0cd23da3fef4d78644329e1d2c7938
+  data.tar.gz: 9dd04b86df14b7bd738126effd61108508996c5632118c741ae0396cc8d471ab
+SHA512:
+  metadata.gz: d7b5f7651ed612c283c6a8b98074a471373c0af11582d1f02ed757d7bee60805f8b7503759d88563058d556584a14c8c12f21f3270756167bf619d8878c61cf3
+  data.tar.gz: 974e7ceb9c7d79fd625cc7af6e4427655029a86c171275fc15b484da4ea7df6c6c54a3ae5f837f60f57ff4035d4d95511d23800215d02119d36a39f799612465

data/README.md

@@ -0,0 +1,86 @@
+# CsvFactory
+
+Tool that lets you easily generate csv content given a predefined schema
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+gem 'csv_factory'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csv_factory
+
+## Usage
+Let's say you need to create a csv file that is pipe (`|`) delimeted and has the following structure:
+- The first row is a Header row with the following columns, in order:
+  - `Record Type`
+  - `FROM Job Application Name`
+  - `TO Job Application Name`
+- Then there's a `Detail` section that contains multiple rows, where each rows has the following columns in order:
+  - `Record Type`
+  - `Payment Amount`
+  - `Payee Name`
+- Lastly, there's a `Trailer` section that is a single row. This row has the following columns in order:
+  - `Record Type`
+  - `Payments Count`
+  - `Total Amount`
+
+An example of a file like this would look like this:
+```
+H|PaymentsApp|Bank
+D|100|Santiago
+D|100|John
+D|100|Phil
+T|3|300
+```
+
+To generate that content using this gem, do the following:
+```ruby
+csv = CsvFactory::Csv.new(
+  delimeter: '|',
+  sections: [
+    {
+      section_name: 'Header',
+      columns: [
+        { column_name: 'Record Type' },
+        { column_name: 'FROM Job Application Name' },
+        { column_name: 'TO Job Application Name' },
+      ]
+    },
+    {
+      section_name: 'Detail',
+      columns: [
+        { column_name: 'Record Type' },
+        { column_name: 'Payment Amount' },
+        { column_name: 'Payee Name' },
+      ]
+    },
+    {
+      section_name: 'Trailer',
+      columns: [
+        { column_name: 'Record Type' },
+        { column_name: 'Payments Count' },
+        { column_name: 'Total Amount' },
+      ]
+    }
+  ]
+)
+
+csv.add_rows_to_section('Header', { 'Record Type' => 'H', 'FROM Job Application Name' => 'PaymentsApp', 'TO Job Application Name' => 'Bank' })
+csv.add_rows_to_section('Detail', [
+  { 'Record Type' => 'D', 'Payment Amount' => 100, 'Payee Name' => 'Santiago' },
+  { 'Record Type' => 'D', 'Payment Amount' => 100, 'Payee Name' => 'John' },
+  { 'Record Type' => 'D', 'Payment Amount' => 100, 'Payee Name' => 'Phil' },
+])
+csv.add_rows_to_section('Trailer', { 'Record Type' => 'T', 'Payments Count' => 3, 'Total Amount' => 300 } )
+```
+
+And that's it. `csv.generate_content` will return the the csv content exactly as shown above as a string.

data/lib/csv_factory/csv.rb

@@ -0,0 +1,130 @@
+module CsvFactory
+  class Csv
+    # Instance variable: @sections
+    # Example:
+    # [
+    #   {
+    #     section_name: 'Header',
+    #     columns: [
+    #       { column_name: 'Record Type' },
+    #       { column_name: 'Environment Type' },
+    #     ]
+    #   },
+    #   {
+    #     section_name: 'Detail',
+    #     columns: [
+    #       { column_name: 'Record Type' },
+    #       { column_name: 'Business Unit' },
+    #       { column_name: 'Claim Number' },
+    #     ]
+    #   },
+    #   {
+    #     section_name: 'Trailer',
+    #     columns: [
+    #       { column_name: 'Record Type' },
+    #       { column_name: 'Total Batch File LineItem Count' },
+    #       { column_name: 'Total Batch File Amount Total' },
+    #     ]
+    #   }
+    # ]
+    #
+    # Instance variable: @column_positions
+    # A filter and transformation of the @sections information.
+    # Example:
+    # {
+    #   'Header': {
+    #     'Record Type': 0,
+    #     'Environment Type': 1
+    #   },
+    #   'Detail': {
+    #     'Record Type': 0,
+    #     'Business Unit': 1,
+    #     'Claim Number': 2,
+    #   },
+    #   'Trailer': {
+    #     'Record Type': 0,
+    #     'Total Batch File LineItem Count': 1,
+    #     'Total Batch File Amount Total': 2
+    #   }
+    # }
+    #
+    # Instance variable: @data
+    # Example:
+    # {
+    #   'Header': [['value', nil]],
+    #   'Detail': [['value', nil, 'value'], ['value', nil, 'value']]
+    #   'Trailer': [['value', nil, 'value']]
+    # }
+    def initialize(delimeter: ',', sections: [])
+      @delimeter = delimeter
+
+      @sections = sections
+
+      @column_positions = {}
+
+      # Note: since ruby 1.9, the insertion order is maintained
+      # https://www.igvita.com/2009/02/04/ruby-19-internals-ordered-hash
+      @data = {}
+
+      sections.each do |section|
+        if @data.key?(section[:section_name])
+          raise CsvFactory::Exception.new("The section `#{section[:section_name]}` is defined twice")
+        end
+
+        @column_positions[section[:section_name]] = {}
+        section[:columns].each_with_index do |column, idx|
+          if @column_positions[section[:section_name]].key?(column[:column_name])
+            # NOTE! this is a limitation: this library doesn't support 2 columns of the same name
+            # in the same section. Each column name within a section must be unique :(
+            raise CsvFactory::Exception.new("The column `#{column[:column_name]}` in the section `#{section[:section_name]}` is defined twice")
+          end
+
+          @column_positions[section[:section_name]][column[:column_name]] = idx
+        end
+
+        @data[section[:section_name]] = []
+      end
+    end
+
+    # Parameter: section_name
+    # Example: 'Trailer'
+    #
+    # Parameter: rows
+    # Example 1: { 'Record Type': 'T', 'Total Batch File LineItem Count': '21' }
+    # Example 2: [{ 'Record Type': 'T', 'Total Batch File LineItem Count': '21' }]
+    def add_rows_to_section(section_name, rows)
+      unless @data.key?(section_name)
+        raise CsvFactory::Exception.new(
+          "The section `#{section_name}` is not defined. " \
+          'Maybe it is a symbol/string incosistency with the definition?'
+        )
+      end
+
+      unless rows.kind_of?(Array)
+        rows = [rows]
+      end
+
+      rows.each do |row|
+        new_row = Array.new(@column_positions[section_name].length)
+
+        row.each do |column_name, value|
+          new_row[@column_positions[section_name][column_name]] = value
+        end
+
+        @data[section_name] << new_row
+      end
+    end
+
+    def generate_content
+      ret_array = []
+
+      @data.each do |_section_name, rows|
+        rows.each do |row|
+          ret_array << row.join(@delimeter)
+        end
+      end
+
+      ret_array.join("\n")
+    end
+  end
+end

data/lib/csv_factory/exceptions.rb

@@ -0,0 +1,7 @@
+module CsvFactory
+  class Exception < StandardError
+    def initialize(msg)
+      super(msg)
+    end
+  end
+end

data/lib/csv_factory/version.rb

@@ -0,0 +1,3 @@
+module CsvFactory
+  VERSION = '0.0.1'.freeze
+end

data/lib/csv_factory.rb

@@ -0,0 +1,3 @@
+require 'csv_factory/version'
+require 'csv_factory/csv'
+require 'csv_factory/exceptions'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: csv_factory
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Snapsheet, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: 
+email:
+- technotifications@snapsheet.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/csv_factory.rb
+- lib/csv_factory/csv.rb
+- lib/csv_factory/exceptions.rb
+- lib/csv_factory/version.rb
+homepage: https://github.com/snapsheet/csv_factory
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.2'
+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: Tool that builds CSV files
+test_files: []