csvbuilder-importer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 39d99815d9abc078be2c260b184249698061567e187610a592dff015fd0b8689
+  data.tar.gz: 9986a911e0afcfd82910e69c275b3f9082d10c2cf59d0597335310e491d2004a
+SHA512:
+  metadata.gz: 1b6f735481aa24e1f06e2fb34dd6f9c7be5f09b31f9571d5542a2ac7eb1040d22144969fd2ac4fae5b3e3b0033546d49efac75fc0e514a056303653aa20c76bc
+  data.tar.gz: e43129b44151125b09f64d7aa6f14ae67c430e456a88a8858874f058a4f0b93af134c2bc05ded31d000e134caa4bbc23b9655ab718d4e4046c8880043d61d2f9

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,21 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.rubocop_todo.yml

@@ -0,0 +1,92 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-12-16 12:50:16 UTC using RuboCop version 1.39.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 5
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 189
+  Exclude:
+    - 'lib/csvbuilder/importer/internal/import/csv.rb'
+    - 'lib/csvbuilder/importer/public/import/file.rb'
+    - 'spec/csvbuilder/importer/public/import/file_spec.rb'
+
+# Offense count: 1
+Lint/RescueException:
+  Exclude:
+    - 'lib/csvbuilder/importer/internal/import/csv.rb'
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 22
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods, inherit_mode.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 29
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 15
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ModuleLength:
+  Max: 242
+
+# Offense count: 7
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 15
+
+# Offense count: 24
+RSpec/MultipleExpectations:
+  Max: 13
+
+# Offense count: 4
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 7
+
+# Offense count: 4
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 5
+
+# Offense count: 1
+# Configuration parameters: AllowedPatterns.
+# AllowedPatterns: ^expect_, ^assert_
+RSpec/NoExpectationExample:
+  Exclude:
+    - 'spec/support/shared_examples/methods/define_attribute_method.rb'
+
+# Offense count: 5
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/csvbuilder/importer/concerns/import/attributes.rb'
+    - 'lib/csvbuilder/importer/concerns/import/base.rb'
+    - 'lib/csvbuilder/importer/internal/import/attribute.rb'
+    - 'lib/csvbuilder/importer/public/import/file_model.rb'
+
+# Offense count: 3
+Style/OpenStructUse:
+  Exclude:
+    - 'spec/csvbuilder/importer/public/import/file_spec.rb'
+    - 'spec/support/fixtures/concerns/basic_attributes.rb'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-16
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at joel.azemar@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in csvbuilder-importer.gemspec
+gemspec
+
+gem "rake"
+
+gem "rspec"
+
+gem "rubocop"
+
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+
+gem "csvbuilder-core", path: "../csvbuilder-core"

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: ../csvbuilder-core
+  specs:
+    csvbuilder-core (0.1.1)
+      activesupport (~> 6.1)
+
+PATH
+  remote: .
+  specs:
+    csvbuilder-importer (0.1.0)
+      activemodel (~> 6.1)
+      activesupport (~> 6.1)
+      csvbuilder-core (= 0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.7)
+      activesupport (= 6.1.7)
+    activesupport (6.1.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.40.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.15.0)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  csvbuilder-core!
+  csvbuilder-importer!
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.3.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Joel Azemar
+
+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,37 @@
+# Csvbuilder::Importer
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/csvbuilder/importer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add csvbuilder-importer
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install csvbuilder-importer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/csvbuilder-importer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/csvbuilder-importer/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Csvbuilder::Importer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/csvbuilder-importer/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options = ["-A"]
+end
+
+task default: %i[spec rubocop]

data/gemfiles/Gemfile.5.2._gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Runtime dependencies
+gem "activesupport", "~> 5.2"
+gem "activemodel", "~> 5.2"
+gem "csvbuilder-core", "0.1.1"
+
+# Development dependencies
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/gemfiles/Gemfile.6.1._gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Runtime dependencies
+gem "activesupport", "~> 6.1"
+gem "activemodel", "~> 6.1"
+gem "csvbuilder-core", "0.1.1"
+
+# Development dependencies
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/gemfiles/Gemfile.7.0._gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Runtime dependencies
+gem "activesupport", "~> 7.0"
+gem "activemodel", "~> 7.0"
+gem "csvbuilder-core", "0.1.1"
+
+# Development dependencies
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/lib/csvbuilder/importer/concerns/import/attributes.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "csvbuilder/core/concerns/attributes_base"
+
+require "csvbuilder/importer/internal/import/attribute"
+
+module Csvbuilder
+  module Import
+    module Attributes
+      extend ActiveSupport::Concern
+      include AttributesBase
+
+      included do
+        ensure_attribute_method
+      end
+
+      def valid?(*args)
+        is_valid = super
+
+        # The method attribute_objects was called by the valid? method through
+        # the attribute getters. The memoization must be cleared now to propagate
+        # the errors into the Attribute(s).
+        instance_variable_set(:@attribute_objects, nil) unless is_valid
+
+        is_valid
+      end
+
+      def attribute_objects
+        @attribute_objects ||= _attribute_objects(errors)
+      end
+
+      protected
+
+      def _attribute_objects(attributes_errors = {})
+        index = -1
+
+        array_to_block_hash(self.class.column_names) do |column_name|
+          Attribute.new(column_name, source_row[index += 1], attributes_errors[column_name], self)
+        end
+      end
+
+      class_methods do
+        def define_attribute_method(column_name)
+          # return if super { original_attribute(column_name) }.nil?
+          super do
+            return unless @attribute_objects
+
+            @attribute_objects[column_name].try(:value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/csvbuilder/importer/concerns/import/base.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Csvbuilder
+  module Import
+    module Base
+      extend ActiveSupport::Concern
+
+      included do
+        attr_reader :source_headers, :source_row, :line_number, :index, :previous
+
+        validate { errors.add(:csv, "has #{@csv_exception.message}") if @csv_exception }
+      end
+
+      # @param [Array] source_row_or_exception the csv row
+      # @param options [Hash]
+      # @option options [Integer] :index 1st row_model is 0, 2nd is 1, 3rd is 2, etc.
+      # @option options [Integer] :line_number line_number in the CSV file
+      # @option options [Array] :source_headers the csv header row
+      # @option options [Csvbuilder::Import] :previous the previous row model
+      # @option options [Csvbuilder::Import] :parent if the instance is a child, pass the parent
+      def initialize(source_row_or_exception = [], options = {})
+        @source_row     = source_row_or_exception
+        @csv_exception  = source_row if source_row.is_a? Exception
+        @source_row     = [] if source_row_or_exception.class != Array
+
+        @line_number    = options[:line_number]
+        @index          = options[:index]
+        @source_headers = options[:source_headers]
+
+        @previous       = options[:previous].try(:dup)
+
+        previous.try(:free_previous)
+
+        super(options)
+      end
+
+      # Free `previous` from memory to avoid making a linked list
+      def free_previous
+        attributes
+        @previous = nil
+      end
+
+      # Safe to override.
+      #
+      # @return [Boolean] returns true, if this instance should be skipped
+      def skip?
+        !valid?
+      end
+
+      # Safe to override.
+      #
+      # @return [Boolean] returns true, if the entire csv file should stop reading
+      def abort?
+        false
+      end
+
+      class_methods do
+        #
+        # Move to Import::File once FileModel is removed.
+        #
+        # @param [Import::File] file to read from
+        # @param [Hash] context extra data you want to work with the model
+        # @param [Import] prevuous the previous row model
+        # @return [Import] the next model instance from the csv
+        def next(file, context = {})
+          csv = file.csv
+
+          csv.skip_headers
+          csv.read_row
+
+          new(csv.current_row,
+              line_number: csv.line_number,
+              index: file.index,
+              source_headers: csv.headers,
+              context: context,
+              previous: file.previous_row_model)
+        end
+      end
+    end
+  end
+end

data/lib/csvbuilder/importer/internal/import/attribute.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "csvbuilder/core/internal/attribute_base"
+
+module Csvbuilder
+  module Import
+    class Attribute < Csvbuilder::AttributeBase
+      attr_reader :source_value, :attribute_errors
+
+      def initialize(column_name, source_value, attribute_errors, row_model)
+        @source_value     = source_value
+        @attribute_errors = attribute_errors
+
+        super(column_name, row_model)
+      end
+
+      def value
+        @value ||= if attribute_errors.present?
+                     nil
+                   else
+                     formatted_value
+                   end
+      end
+
+      def parsed_value
+        @parsed_value ||= formatted_value
+      end
+    end
+  end
+end

data/lib/csvbuilder/importer/internal/import/csv.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Csvbuilder
+  module Import
+    # Abstraction of Ruby's CSV library. Keeps current row and line_number, skips empty rows, handles errors.
+    class Csv
+      # @return [String] the file path of the CSV
+      attr_reader :file_path
+      # @return [Integer, nil] return `0` at start of file, `1 to infinity` is line_number of row_model, `nil` is end of file (row is also `nil`)
+      attr_reader :line_number
+      # @return [Array, nil] the current row, or nil at the beginning or end of file
+      attr_reader :current_row
+
+      include ActiveModel::Validations
+
+      validate { begin; _ruby_csv; rescue StandardError => e; errors.add(:csv, e.message) end }
+
+      def initialize(file_path)
+        @file_path = file_path
+        reset
+      end
+
+      # http://stackoverflow.com/questions/2650517/count-the-number-of-lines-in-a-file-without-reading-entire-file-into-memory
+      # @return [Integer] the number of rows in the file, including empty new lines
+      def size
+        @size ||= `wc -l #{file_path}`.split[0].to_i + 1
+      end
+
+      # If the current position is at the headers, skip it and return it. Otherwise, only return false.
+      # @return [Boolean, Array] returns false, if header is already skipped, otherwise returns the header
+      def skip_headers
+        start_of_file? ? (@headers = read_row) : false
+      end
+
+      # Returns the header __without__ changing the position of the CSV
+      # @return [Array, nil] the header
+      def headers
+        @headers ||= next_row
+      end
+
+      # Resets the file to the start of file
+      def reset
+        return false unless valid?
+
+        @line_number = 0
+        @headers = @current_row = @next_row = @skipped_rows = @next_skipped_rows = nil
+
+        @ruby_csv.try(:close)
+        @ruby_csv = _ruby_csv
+
+        true
+      end
+
+      # @return [Boolean] true, if the current position is at the start of the file
+      def start_of_file?
+        line_number.zero?
+      end
+
+      # @return [Boolean] true, if the current position is at the end of the file
+      def end_of_file?
+        line_number.nil?
+      end
+
+      # Returns the next row __without__ changing the position of the CSV
+      # @return [Array, nil] the next row, or `nil` at the end of file
+      def next_row
+        @next_row ||= _read_row
+      end
+
+      # Returns the next row, while changing the position of the CSV
+      # @return [Array, nil] the changed current row, or `nil` at the end of file
+      def read_row
+        return if end_of_file?
+
+        @current_row = @next_row || _read_row
+        @line_number = current_row.nil? ? nil : @line_number + 1
+        @next_row = nil
+
+        current_row
+      end
+
+      protected
+
+      def _ruby_csv
+        CSV.open(file_path)
+      end
+
+      def _read_row
+        return unless valid?
+
+        @ruby_csv.readline.tap { |row| @headers ||= row }
+      rescue Exception => e
+        changed = e.exception(e.message.gsub(/line \d+\.?/, "line #{line_number + 1}.")) # line numbers are usually off
+        changed.set_backtrace(e.backtrace)
+        changed
+      end
+    end
+  end
+end

data/lib/csvbuilder/importer/public/import/file.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require "csvbuilder/importer/internal/import/csv"
+
+module Csvbuilder
+  module Import
+    # Represents a csv file and handles parsing to return `Import`
+    class File
+      extend ActiveModel::Callbacks
+      include ActiveModel::Validations
+
+      attr_reader :csv, :row_model_class, :index, :current_row_model, :previous_row_model, :context # -1 = start of file, 0 to infinity = index of row_model, nil = end of file, no row_model
+
+      delegate :size, :end_of_file?, :line_number, to: :csv
+
+      define_model_callbacks :each_iteration
+      define_model_callbacks :next
+      define_model_callbacks :abort, :skip, only: :before
+
+      validate { errors.merge!(csv.errors) unless csv.valid? }
+
+      # @param [String] file_path path of csv file
+      # @param [Import] row_model_class model class returned for importing
+      # @param context [Hash] context passed to the {Import}
+      def initialize(file_path, row_model_class, context = {})
+        @csv             = ::Csvbuilder::Import::Csv.new(file_path) # Full namespace provided to avoid confusion with Ruby CSV class.
+        @row_model_class = row_model_class
+        @context         = context.to_h.symbolize_keys
+        reset
+      end
+
+      def headers
+        h = csv.headers
+        h.instance_of?(Array) ? h : []
+      end
+
+      # Resets the file back to the top
+      def reset
+        csv.reset
+        @index = -1
+        @current_row_model = nil
+      end
+
+      # Gets the next row model based on the context
+      def next(context = {})
+        return if end_of_file?
+
+        run_callbacks :next do
+          context = context.to_h.reverse_merge(self.context)
+          @previous_row_model = current_row_model
+          @index += 1
+          @current_row_model = row_model_class.next(self, context)
+          @current_row_model = @index = nil if end_of_file?
+        end
+
+        current_row_model
+      end
+
+      # Iterates through the entire csv file and provides the `current_row_model` in a block, while handing aborts and skips
+      # via. calling {Model#abort?} and {Model#skip?}
+      def each(context = {})
+        return to_enum(__callee__, context) unless block_given?
+        return false if _abort?
+
+        while self.next(context)
+          run_callbacks :each_iteration do
+            return false if _abort?
+            next if _skip?
+
+            yield current_row_model
+          end
+        end
+      end
+
+      # @return [Boolean] returns true, if the file should abort reading
+      def abort?
+        !valid? || !!current_row_model.try(:abort?)
+      end
+
+      # @return [Boolean] returns true, if the file should skip `current_row_model`
+      def skip?
+        !!current_row_model.try(:skip?)
+      end
+
+      protected
+
+      def _abort?
+        abort = abort?
+        run_callbacks(:abort) if abort
+        abort
+      end
+
+      def _skip?
+        skip = skip?
+        run_callbacks(:skip) if skip
+        skip
+      end
+
+      #
+      # Validations
+      #
+      def headers_invalid_row
+        errors.add(:csv, "has header with #{csv.headers.message}") if csv.headers.class < Exception
+      end
+
+      def headers_count
+        return if headers_invalid_row || !csv.valid?
+        return if row_model_class.try(:row_names) # FileModel check
+
+        size_until_blank = ((headers || []).map { |h| h.try(:strip) }.rindex(&:present?) || -1) + 1
+        column_names = row_model_class.column_names
+
+        return if size_until_blank == column_names.size
+
+        expected_headers_size = column_names.size
+
+        message = [
+          "count does not match.",
+          " Given headers (#{size_until_blank}).",
+          " Expected headers (#{expected_headers_size}): #{column_names.join(", ")}"
+        ]
+
+        errors.add(:headers, message.join)
+      end
+    end
+  end
+end

data/lib/csvbuilder/importer/public/import.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "csvbuilder/core/public/model"
+require "csvbuilder/importer/concerns/import/base"
+require "csvbuilder/importer/concerns/import/attributes"
+
+module Csvbuilder
+  # Include this to with {Model} to have a RowModel for importing csvs.
+  module Import
+    extend ActiveSupport::Concern
+
+    include Csvbuilder::Model
+
+    include ActiveModel::Validations
+
+    include Base
+    include Attributes
+  end
+end

data/lib/csvbuilder/importer/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Csvbuilder
+  module Importer
+    VERSION = "0.1.0"
+  end
+end

data/lib/csvbuilder/importer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "csvbuilder/importer/version"
+
+require "csv"
+require "ostruct"
+require "active_model"
+
+require "active_support"
+require "active_support/dependencies/autoload"
+require "active_support/core_ext/object"
+require "active_support/core_ext/string"
+
+require "csvbuilder/core"
+
+require "csvbuilder/importer/public/import"
+require "csvbuilder/importer/public/import/file"

data/sig/csvbuilder/importer.rbs

@@ -0,0 +1,6 @@
+module Csvbuilder
+  module Importer
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: csvbuilder-importer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Azemar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: csvbuilder-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+description: Help handle CSVs in a more efficient way
+email:
+- joel.azemar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/Gemfile.5.2._gemfile
+- gemfiles/Gemfile.6.1._gemfile
+- gemfiles/Gemfile.7.0._gemfile
+- lib/csvbuilder/importer.rb
+- lib/csvbuilder/importer/concerns/import/attributes.rb
+- lib/csvbuilder/importer/concerns/import/base.rb
+- lib/csvbuilder/importer/internal/import/attribute.rb
+- lib/csvbuilder/importer/internal/import/csv.rb
+- lib/csvbuilder/importer/public/import.rb
+- lib/csvbuilder/importer/public/import/file.rb
+- lib/csvbuilder/importer/version.rb
+- sig/csvbuilder/importer.rbs
+homepage: https://github.com/joel/csvbuilder-importer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/joel/csvbuilder-importer
+  source_code_uri: https://github.com/joel/csvbuilder-importer
+  changelog_uri: https://github.com/joel/csvbuilder-importer/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.12
+signing_key: 
+specification_version: 4
+summary: Csvbuilder Importer contain the components to handle CSV importing
+test_files: []