ImporteerPlan

The sole purpose of this gem is to provide the boilerplate code necessary to import and proces data from files for my applications. This reduces duplication and eases maintenance.

Installation

Add this line to your application's Gemfile:

gem 'importeer_plan'

And then execute:

$ bundle

Or install it yourself as:

$ gem install importeer_plan

Usage

Importeer.new takes two options:

  • name (string)

  • an options-hash

    • size of batch_of_lines_to_import (size_batch, integer, optional, defaults to 1000)
    • type of separator for csv-files (sep, string, optional, defaults to ";")
    • method of import: initial or replacing (initial, false or true, optional, defaults to false)

My applications-classes for processing data from external files inherit from Importeer, depending the file-type:

  • xls: ImporteerPlan::MyXls
  • csv: ImporteerPlan::MyCsv
  • txt: ImporteerPlan::MyTxt (todo)
class ImporteerSomething < ImporteerPlan::MyXls
    attr_accessor :my_var, :another_var
    #call importeer("filename") to import the file in batches of 1000, optional importeer("filename", {size_batch: 1234})

    def initialize(*)
        super
        @my_var = MyVar.all
        @another_var = AnotherVar.all
    end
end

a very,very simple example: processing a file called 'example.xls'


e = ImporteerPlan::MyXls.new('example.xls')

e.importeer

this works, after you created a file like this:

#save this file as: importeer_example.rb

class ImporteerExample < ImporteerPlan::MyXls

    def importeer_batch(batch)
        batch.each do |row|
            handle_my_model row
        end
    end


    def handle_my_model ref
        r=MyModel.new
        r.attribute_one = ref[0] unless ref[0].blank?
        r.another_attribute = ref[1] unless ref[1].blank?

        r.save! if r.attributes.values.any? {|x| !x.blank?}
    end


end

configuration

Starting 0.3.0, i added some configuration-options. The most basic configuration is setting the path to find the files to import. The default is creating a folder in the 'public' folder, but you could so something like:


      ImporteerPlan.configure do |config|
        config.dir  = Rails.root.join('imports')
      end

methods

importeer

  • commaf(string) where string is a dutch amount, separated by ',' turning to a float

  • pointf(string) where string is a dutch amount, separated by '.' turning to a float

Test

ImporteerPlan uses minitest. Run rake to start the test-suite.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/importeer_plan/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Gem Version